Inheritance diagram for lsst.meas.extensions.trailedSources.NaivePlugin.SingleFrameNaiveTrailPlugin:

Public Member Functions
def	getExecutionOrder (cls)

def	__init__ (self, config, name, schema, metadata)

def	measure (self, measRecord, exposure)

def	fail (self, measRecord, error=None)

def	findLength (self, Ixx, Iyy)

def	computeRaDec (self, exposure, x, y)

def	measureN (self, measCat, exposure)

def	getLogName (self)

Static Public Member Functions
def	getTransformClass ()

Public Attributes
	keyRa

	keyDec

	keyX0

	keyY0

	keyX1

	keyY1

	keyFlux

	keyL

	keyAngle

	keyX0Err

	keyY0Err

	keyX1Err

	keyY1Err

	NO_FLUX

	NO_CONVERGE

	NO_SIGMA

	flagHandler

	centriodExtractor

	config

	name

	logName

Static Public Attributes
	ConfigClass = SingleFrameNaiveTrailConfig

	registry = PluginRegistry(SingleFramePluginConfig)

float	CENTROID_ORDER = 0.0

float	SHAPE_ORDER = 1.0

float	FLUX_ORDER = 2.0

float	APCORR_ORDER = 3.0

float	DEFAULT_CATALOGCALCULATION = 4.0

Detailed Description

Naive trailed source measurement plugin

Measures the length, angle from +x-axis, and end points of an extended
source using the second moments.

Parameters
----------
config: `SingleFrameNaiveTrailConfig`
    Plugin configuration.
name: `str`
    Plugin name.
schema: `lsst.afw.table.Schema`
    Schema for the output catalog.
metadata: `lsst.daf.base.PropertySet`
    Metadata to be attached to output catalog.

Notes
-----
This measurement plugin aims to utilize the already measured adaptive
second moments to naively estimate the length and angle, and thus
end-points, of a fast-moving, trailed source. The length is solved for via
finding the root of the difference between the numerical (stack computed)
and the analytic adaptive second moments. The angle, theta, from the x-axis
is also computed via adaptive moments: theta = arctan(2*Ixy/(Ixx - Iyy))/2.
The end points of the trail are then given by (xc +/- (L/2)*cos(theta),
yc +/- (L/2)*sin(theta)), with xc and yc being the centroid coordinates.

See also
--------
lsst.meas.base.SingleFramePlugin

Definition at line 45 of file NaivePlugin.py.

Constructor & Destructor Documentation

◆ init()

def lsst.meas.extensions.trailedSources.NaivePlugin.SingleFrameNaiveTrailPlugin.__init__	(	self,
		config,
		name,
		schema,
		metadata
	)

Definition at line 86 of file NaivePlugin.py.

     def __init__(self, config, name, schema, metadata):
         super().__init__(config, name, schema, metadata)
  
         # Measurement Keys
         self.keyRa = schema.addField(name + "_ra", type="D", doc="Trail centroid right ascension.")
         self.keyDec = schema.addField(name + "_dec", type="D", doc="Trail centroid declination.")
         self.keyX0 = schema.addField(name + "_x0", type="D", doc="Trail head X coordinate.", units="pixel")
         self.keyY0 = schema.addField(name + "_y0", type="D", doc="Trail head Y coordinate.", units="pixel")
         self.keyX1 = schema.addField(name + "_x1", type="D", doc="Trail tail X coordinate.", units="pixel")
         self.keyY1 = schema.addField(name + "_y1", type="D", doc="Trail tail Y coordinate.", units="pixel")
         self.keyFlux = schema.addField(name + "_flux", type="D", doc="Trailed source flux.", units="count")
         self.keyL = schema.addField(name + "_length", type="D", doc="Trail length.", units="pixel")
         self.keyAngle = schema.addField(name + "_angle", type="D", doc="Angle measured from +x-axis.")
  
         # Measurement Error Keys
         self.keyX0Err = schema.addField(name + "_x0Err", type="D",
                                         doc="Trail head X coordinate error.", units="pixel")
         self.keyY0Err = schema.addField(name + "_y0Err", type="D",
                                         doc="Trail head Y coordinate error.", units="pixel")
         self.keyX1Err = schema.addField(name + "_x1Err", type="D",
                                         doc="Trail tail X coordinate error.", units="pixel")
         self.keyY1Err = schema.addField(name + "_y1Err", type="D",
                                         doc="Trail tail Y coordinate error.", units="pixel")
  
         flagDefs = FlagDefinitionList()
         flagDefs.addFailureFlag("No trailed-source measured")
         self.NO_FLUX = flagDefs.add("flag_noFlux", "No suitable prior flux measurement")
         self.NO_CONVERGE = flagDefs.add("flag_noConverge", "The root finder did not converge")
         self.NO_SIGMA = flagDefs.add("flag_noSigma", "No PSF width (sigma)")
         self.flagHandler = FlagHandler.addFields(schema, name, flagDefs)
  
         self.centriodExtractor = SafeCentroidExtractor(schema, name)
  

Member Function Documentation

◆ computeRaDec()

def lsst.meas.extensions.trailedSources.NaivePlugin.SingleFrameNaiveTrailPlugin.computeRaDec	(	self,
		exposure,
		x,
		y
	)

Convert pixel coordinates to RA and Dec.

Parameters
----------
exposure : `lsst.afw.image.ExposureF`
    Exposure object containing the WCS.
x : `float`
    x coordinate of the trail centroid
y : `float`
    y coodinate of the trail centroid

Returns
-------
ra : `float`
    Right ascension.
dec : `float`
    Declination.

Definition at line 287 of file NaivePlugin.py.

     def computeRaDec(self, exposure, x, y):
         """Convert pixel coordinates to RA and Dec.
  
         Parameters
         ----------
         exposure : `lsst.afw.image.ExposureF`
             Exposure object containing the WCS.
         x : `float`
             x coordinate of the trail centroid
         y : `float`
             y coodinate of the trail centroid
  
         Returns
         -------
         ra : `float`
             Right ascension.
         dec : `float`
             Declination.
         """
  
         wcs = exposure.getWcs()
         center = wcs.pixelToSky(Point2D(x, y))
         ra = center.getRa().asDegrees()
         dec = center.getDec().asDegrees()
         return ra, dec

◆ fail()

def lsst.meas.extensions.trailedSources.NaivePlugin.SingleFrameNaiveTrailPlugin.fail	(	self,
		measRecord,
		error = `None`
	)

Record failure

See also
--------
lsst.meas.base.SingleFramePlugin.fail

Reimplemented from lsst.meas.base.pluginsBase.BasePlugin.

Definition at line 212 of file NaivePlugin.py.

     def fail(self, measRecord, error=None):
         """Record failure
  
         See also
         --------
         lsst.meas.base.SingleFramePlugin.fail
         """
         if error is None:
             self.flagHandler.handleFailure(measRecord)
         else:
             self.flagHandler.handleFailure(measRecord, error.cpp)
  

◆ findLength()

def lsst.meas.extensions.trailedSources.NaivePlugin.SingleFrameNaiveTrailPlugin.findLength	(	self,
		Ixx,
		Iyy
	)

Find the length of a trail, given adaptive second-moments.

Uses a root finder to compute the length of a trail corresponding to
the adaptive second-moments computed by previous measurements
(ie. SdssShape).

Parameters
----------
Ixx : `float`
    Adaptive second-moment along x-axis.
Iyy : `float`
    Adaptive second-moment along y-axis.

Returns
-------
length : `float`
    Length of the trail.
results : `scipy.optimize.RootResults`
    Contains messages about convergence from the root finder.

Definition at line 252 of file NaivePlugin.py.

     def findLength(self, Ixx, Iyy):
         """Find the length of a trail, given adaptive second-moments.
  
         Uses a root finder to compute the length of a trail corresponding to
         the adaptive second-moments computed by previous measurements
         (ie. SdssShape).
  
         Parameters
         ----------
         Ixx : `float`
             Adaptive second-moment along x-axis.
         Iyy : `float`
             Adaptive second-moment along y-axis.
  
         Returns
         -------
         length : `float`
             Length of the trail.
         results : `scipy.optimize.RootResults`
             Contains messages about convergence from the root finder.
         """
  
         xpy = Ixx + Iyy
         c = 4.0*Ixx/(xpy*np.sqrt(np.pi))
  
         # Given a 'c' in (c_min, c_max], the root is contained in (0,1].
         # c_min is given by the case: Ixx == Iyy, ie. a point source.
         # c_max is given by the limit Ixx >> Iyy.
         # Emperically, 0.001 is a suitable lower bound, assuming Ixx > Iyy.
         z, results = sciOpt.brentq(lambda z: self._computeSecondMomentDiff(z, c),
                                    0.001, 1.0, full_output=True)
  
         length = 2.0*z*np.sqrt(2.0*xpy)
         return length, results
  

◆ getExecutionOrder()

def lsst.meas.extensions.trailedSources.NaivePlugin.SingleFrameNaiveTrailPlugin.getExecutionOrder ( cls )

Get the relative execution order of this plugin.

Must be reimplemented as a class method by concrete derived classes.

Reimplemented from lsst.meas.base.pluginsBase.BasePlugin.

Definition at line 81 of file NaivePlugin.py.

     def getExecutionOrder(cls):
         # Needs centroids, shape, and flux measurements.
         # VeresPlugin is run after, which requires image data.
         return cls.APCORR_ORDER + 0.1
  

◆ getLogName()

def lsst.meas.base.pluginsBase.BasePlugin.getLogName ( self )

inherited

Definition at line 134 of file pluginsBase.py.

     def getLogName(self):
         return self.logName
  

◆ getTransformClass()

def lsst.meas.base.pluginsBase.BasePlugin.getTransformClass ( )

staticinherited

Get the measurement transformation appropriate to this plugin.

This returns a subclass of `transforms.MeasurementTransform`, which
may be instantiated with details of the algorithm configuration and
then called with information about calibration and WCS to convert from
raw measurement quantities to calibrated units. Calibrated data is
then provided in a separate output table.

Notes
-----
By default, we copy everything from the input to the output without
transformation.

Reimplemented in lsst.meas.base.plugins.ForcedPeakCentroidPlugin, and lsst.meas.base.plugins.SingleFramePeakCentroidPlugin.

Definition at line 169 of file pluginsBase.py.

     def getTransformClass():
         """Get the measurement transformation appropriate to this plugin.
  
         This returns a subclass of `transforms.MeasurementTransform`, which
         may be instantiated with details of the algorithm configuration and
         then called with information about calibration and WCS to convert from
         raw measurement quantities to calibrated units. Calibrated data is
         then provided in a separate output table.
  
         Notes
         -----
         By default, we copy everything from the input to the output without
         transformation.
         """
         return PassThroughTransform

◆ measure()

def lsst.meas.extensions.trailedSources.NaivePlugin.SingleFrameNaiveTrailPlugin.measure	(	self,
		measRecord,
		exposure
	)

Run the Naive trailed source measurement algorithm.

Parameters
----------
measRecord : `lsst.afw.table.SourceRecord`
    Record describing the object being measured.
exposure : `lsst.afw.image.Exposure`
    Pixel data to be measured.

See also
--------
lsst.meas.base.SingleFramePlugin.measure

Reimplemented from lsst.meas.base.sfm.SingleFramePlugin.

Definition at line 119 of file NaivePlugin.py.

     def measure(self, measRecord, exposure):
         """Run the Naive trailed source measurement algorithm.
  
         Parameters
         ----------
         measRecord : `lsst.afw.table.SourceRecord`
             Record describing the object being measured.
         exposure : `lsst.afw.image.Exposure`
             Pixel data to be measured.
  
         See also
         --------
         lsst.meas.base.SingleFramePlugin.measure
         """
  
         # Get the SdssShape centroid or fall back to slot
         xc = measRecord.get("base_SdssShape_x")
         yc = measRecord.get("base_SdssShape_y")
         if not np.isfinite(xc) or not np.isfinite(yc):
             xc, yc = self.centriodExtractor(measRecord, self.flagHandler)
  
         ra, dec = self.computeRaDec(exposure, xc, yc)
  
         Ixx, Iyy, Ixy = measRecord.getShape().getParameterVector()
         xmy = Ixx - Iyy
         xpy = Ixx + Iyy
         xmy2 = xmy*xmy
         xy2 = Ixy*Ixy
         a2 = 0.5 * (xpy + np.sqrt(xmy2 + 4.0*xy2))
  
         # Get the width of the PSF at the center of the trail
         center = Point2D(xc, yc)
         sigma = exposure.getPsf().computeShape(center).getTraceRadius()
         if not np.isfinite(sigma):
             raise MeasurementError(self.NO_SIGMA, self.NO_SIGMA.number)
  
         length, results = self.findLength(a2, sigma*sigma)
         if not results.converged:
             lsst.log.info(results.flag)
             raise MeasurementError(self.NO_CONVERGE.doc, self.NO_CONVERGE.number)
  
         theta = 0.5 * np.arctan2(2.0 * Ixy, xmy)
         a = length/2.0
         dydt = a*np.cos(theta)
         dxdt = a*np.sin(theta)
         x0 = xc - dydt
         y0 = yc - dxdt
         x1 = xc + dydt
         y1 = yc + dxdt
  
         # For now, use the shape flux.
         flux = measRecord.get("base_SdssShape_instFlux")
  
         # Fall back to aperture flux
         if not np.isfinite(flux):
             if np.isfinite(measRecord.getApInstFlux()):
                 flux = measRecord.getApInstFlux()
             else:
                 raise MeasurementError(self.NO_FLUX.doc, self.NO_FLUX.number)
  
         # Propagate errors from second moments
         xcErr2, ycErr2 = np.diag(measRecord.getCentroidErr())
         IxxErr2, IyyErr2, IxyErr2 = np.diag(measRecord.getShapeErr())
         desc = np.sqrt(xmy2 + 4.0*xy2)  # Descriminant^1/2 of EV equation
         denom = 2*np.sqrt(2.0*(Ixx + np.sqrt(4.0*xy2 + xmy2 + Iyy)))  # Denominator for dadIxx and dadIyy
         dadIxx = (1.0 + (xmy/desc)) / denom
         dadIyy = (1.0 - (xmy/desc)) / denom
         dadIxy = (4.0*Ixy) / (desc * denom)
         aErr2 = IxxErr2*dadIxx*dadIxx + IyyErr2*dadIyy*dadIyy + IxyErr2*dadIxy*dadIxy
         thetaErr2 = ((IxxErr2 + IyyErr2)*xy2 + xmy2*IxyErr2) / (desc*desc*desc*desc)
  
         dxda = np.cos(theta)
         dyda = np.sin(theta)
         xErr2 = aErr2*dxda*dxda + thetaErr2*dxdt*dxdt
         yErr2 = aErr2*dyda*dyda + thetaErr2*dydt*dydt
         x0Err = np.sqrt(xErr2 + xcErr2)  # Same for x1
         y0Err = np.sqrt(yErr2 + ycErr2)  # Same for y1
  
         # Set flags
         measRecord.set(self.keyRa, ra)
         measRecord.set(self.keyDec, dec)
         measRecord.set(self.keyX0, x0)
         measRecord.set(self.keyY0, y0)
         measRecord.set(self.keyX1, x1)
         measRecord.set(self.keyY1, y1)
         measRecord.set(self.keyFlux, flux)
         measRecord.set(self.keyL, length)
         measRecord.set(self.keyAngle, theta)
         measRecord.set(self.keyX0Err, x0Err)
         measRecord.set(self.keyY0Err, y0Err)
         measRecord.set(self.keyX1Err, x0Err)
         measRecord.set(self.keyY1Err, y0Err)
  

◆ measureN()

def lsst.meas.base.sfm.SingleFramePlugin.measureN	(	self,
		measCat,
		exposure
	)

inherited

Measure the properties of blended sources on a single image.

This operates on all members of a blend family at once. The image may
be from a single epoch, or it may be a coadd.

Parameters
----------
measCat : `lsst.afw.table.SourceCatalog`
    Catalog describing the objects (and only those objects) being
    measured. Previously-measured quantities will be retrieved from
    here, and it will be updated in-place with the outputs of this
    plugin.
exposure : `lsst.afw.image.ExposureF`
    The pixel data to be measured, together with the associated PSF,
    WCS, etc. All other sources in the image should have been replaced
    by noise according to deblender outputs.

Notes
-----
Derived classes that do not implement ``measureN`` should just inherit
this disabled version.  Derived classes that do implement ``measureN``
should additionally add a bool doMeasureN config field to their config
class to signal that measureN-mode is available.

Reimplemented in lsst.meas.base.wrappers.WrappedSingleFramePlugin.

Definition at line 105 of file sfm.py.

     def measureN(self, measCat, exposure):
         """Measure the properties of blended sources on a single image.
  
         This operates on all members of a blend family at once. The image may
         be from a single epoch, or it may be a coadd.
  
         Parameters
         ----------
         measCat : `lsst.afw.table.SourceCatalog`
             Catalog describing the objects (and only those objects) being
             measured. Previously-measured quantities will be retrieved from
             here, and it will be updated in-place with the outputs of this
             plugin.
         exposure : `lsst.afw.image.ExposureF`
             The pixel data to be measured, together with the associated PSF,
             WCS, etc. All other sources in the image should have been replaced
             by noise according to deblender outputs.
  
         Notes
         -----
         Derived classes that do not implement ``measureN`` should just inherit
         this disabled version.  Derived classes that do implement ``measureN``
         should additionally add a bool doMeasureN config field to their config
         class to signal that measureN-mode is available.
         """
         raise NotImplementedError()
  
  

Member Data Documentation

◆ APCORR_ORDER

float lsst.meas.base.pluginsBase.BasePlugin.APCORR_ORDER = 3.0

staticinherited

Definition at line 98 of file pluginsBase.py.

◆ centriodExtractor

lsst.meas.extensions.trailedSources.NaivePlugin.SingleFrameNaiveTrailPlugin.centriodExtractor

Definition at line 117 of file NaivePlugin.py.

◆ CENTROID_ORDER

float lsst.meas.base.pluginsBase.BasePlugin.CENTROID_ORDER = 0.0

staticinherited

Definition at line 72 of file pluginsBase.py.

◆ config

lsst.meas.base.pluginsBase.BasePlugin.config

inherited

Definition at line 130 of file pluginsBase.py.

◆ ConfigClass

lsst.meas.extensions.trailedSources.NaivePlugin.SingleFrameNaiveTrailPlugin.ConfigClass = SingleFrameNaiveTrailConfig

static

Definition at line 78 of file NaivePlugin.py.

◆ DEFAULT_CATALOGCALCULATION

float lsst.meas.base.pluginsBase.BasePlugin.DEFAULT_CATALOGCALCULATION = 4.0

staticinherited

Definition at line 108 of file pluginsBase.py.

◆ flagHandler

lsst.meas.extensions.trailedSources.NaivePlugin.SingleFrameNaiveTrailPlugin.flagHandler

Definition at line 115 of file NaivePlugin.py.

◆ FLUX_ORDER

float lsst.meas.base.pluginsBase.BasePlugin.FLUX_ORDER = 2.0

staticinherited

Definition at line 89 of file pluginsBase.py.

◆ keyAngle

lsst.meas.extensions.trailedSources.NaivePlugin.SingleFrameNaiveTrailPlugin.keyAngle

Definition at line 98 of file NaivePlugin.py.

◆ keyDec

lsst.meas.extensions.trailedSources.NaivePlugin.SingleFrameNaiveTrailPlugin.keyDec

Definition at line 91 of file NaivePlugin.py.

◆ keyFlux

lsst.meas.extensions.trailedSources.NaivePlugin.SingleFrameNaiveTrailPlugin.keyFlux

Definition at line 96 of file NaivePlugin.py.

◆ keyL

lsst.meas.extensions.trailedSources.NaivePlugin.SingleFrameNaiveTrailPlugin.keyL

Definition at line 97 of file NaivePlugin.py.

◆ keyRa

lsst.meas.extensions.trailedSources.NaivePlugin.SingleFrameNaiveTrailPlugin.keyRa

Definition at line 90 of file NaivePlugin.py.

◆ keyX0

lsst.meas.extensions.trailedSources.NaivePlugin.SingleFrameNaiveTrailPlugin.keyX0

Definition at line 92 of file NaivePlugin.py.

◆ keyX0Err

lsst.meas.extensions.trailedSources.NaivePlugin.SingleFrameNaiveTrailPlugin.keyX0Err

Definition at line 101 of file NaivePlugin.py.

◆ keyX1

lsst.meas.extensions.trailedSources.NaivePlugin.SingleFrameNaiveTrailPlugin.keyX1

Definition at line 94 of file NaivePlugin.py.

◆ keyX1Err

lsst.meas.extensions.trailedSources.NaivePlugin.SingleFrameNaiveTrailPlugin.keyX1Err

Definition at line 105 of file NaivePlugin.py.

◆ keyY0

lsst.meas.extensions.trailedSources.NaivePlugin.SingleFrameNaiveTrailPlugin.keyY0

Definition at line 93 of file NaivePlugin.py.

◆ keyY0Err

lsst.meas.extensions.trailedSources.NaivePlugin.SingleFrameNaiveTrailPlugin.keyY0Err

Definition at line 103 of file NaivePlugin.py.

◆ keyY1

lsst.meas.extensions.trailedSources.NaivePlugin.SingleFrameNaiveTrailPlugin.keyY1

Definition at line 95 of file NaivePlugin.py.

◆ keyY1Err

lsst.meas.extensions.trailedSources.NaivePlugin.SingleFrameNaiveTrailPlugin.keyY1Err

Definition at line 107 of file NaivePlugin.py.

◆ logName

lsst.meas.base.pluginsBase.BasePlugin.logName

inherited

Definition at line 132 of file pluginsBase.py.

◆ name

lsst.meas.base.pluginsBase.BasePlugin.name

inherited

Definition at line 131 of file pluginsBase.py.

◆ NO_CONVERGE

lsst.meas.extensions.trailedSources.NaivePlugin.SingleFrameNaiveTrailPlugin.NO_CONVERGE

Definition at line 113 of file NaivePlugin.py.

◆ NO_FLUX

lsst.meas.extensions.trailedSources.NaivePlugin.SingleFrameNaiveTrailPlugin.NO_FLUX

Definition at line 112 of file NaivePlugin.py.

◆ NO_SIGMA

lsst.meas.extensions.trailedSources.NaivePlugin.SingleFrameNaiveTrailPlugin.NO_SIGMA

Definition at line 114 of file NaivePlugin.py.

◆ registry

lsst.meas.base.sfm.SingleFramePlugin.registry = PluginRegistry(SingleFramePluginConfig)

staticinherited

Definition at line 78 of file sfm.py.

◆ SHAPE_ORDER

float lsst.meas.base.pluginsBase.BasePlugin.SHAPE_ORDER = 1.0

staticinherited

Definition at line 80 of file pluginsBase.py.

The documentation for this class was generated from the following file:

/j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/meas_extensions_trailedSources/master-g99da0e417a+8d77f4f51a/python/lsst/meas/extensions/trailedSources/NaivePlugin.py

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ computeRaDec()

◆ fail()

◆ findLength()

◆ getExecutionOrder()

◆ getLogName()

◆ getTransformClass()

◆ measure()

◆ measureN()

Member Data Documentation

◆ APCORR_ORDER

◆ centriodExtractor

◆ CENTROID_ORDER

◆ config

◆ ConfigClass

◆ DEFAULT_CATALOGCALCULATION

◆ flagHandler

◆ FLUX_ORDER

◆ keyAngle

◆ keyDec

◆ keyFlux

◆ keyL

◆ keyRa

◆ keyX0

◆ keyX0Err

◆ keyX1

◆ keyX1Err

◆ keyY0

◆ keyY0Err

◆ keyY1

◆ keyY1Err

◆ logName

◆ name

◆ NO_CONVERGE

◆ NO_FLUX

◆ NO_SIGMA

◆ registry

◆ SHAPE_ORDER

◆ init()