lsst.meas.extensions.trailedSources.VeresPlugin.SingleFrameVeresTrailPlugin Class Reference

Inheritance diagram for lsst.meas.extensions.trailedSources.VeresPlugin.SingleFrameVeresTrailPlugin:

Public Member Functions
	getExecutionOrder (cls)
	__init__ (self, config, name, schema, metadata, logName=None)
	measure (self, measRecord, exposure)
	fail (self, measRecord, error=None)

Public Attributes
	keyXC
	keyYC
	keyX0 = schema.addField(name + "_x0", type="D", doc="Trail head X coordinate.", units="pixel")
	keyY0 = schema.addField(name + "_y0", type="D", doc="Trail head Y coordinate.", units="pixel")
	keyX1 = schema.addField(name + "_x1", type="D", doc="Trail tail X coordinate.", units="pixel")
	keyY1 = schema.addField(name + "_y1", type="D", doc="Trail tail Y coordinate.", units="pixel")
	keyLength = schema.addField(name + "_length", type="D", doc="Length of trail.", units="pixel")
	keyTheta = schema.addField(name + "_angle", type="D", doc="Angle of trail from +x-axis.")
	keyFlux = schema.addField(name + "_flux", type="D", doc="Trailed source flux.", units="count")
	keyRChiSq = schema.addField(name + "_rChiSq", type="D", doc="Reduced chi-squared of fit")
	FAILURE = flagDefs.addFailureFlag("No trailed-sources measured")
	NON_CONVERGE = flagDefs.add("flag_nonConvergence", "Optimizer did not converge")
	NO_NAIVE = flagDefs.add("flag_noNaive", "Naive measurement contains NaNs")
	flagHandler = FlagHandler.addFields(schema, name, flagDefs)
	centroidExtractor = SafeCentroidExtractor(schema, name)

Static Public Attributes
	ConfigClass = SingleFrameVeresTrailConfig

Detailed Description

Veres trailed source characterization plugin.

Measures the length, angle, flux, centroid, and end points of a trailed
source using the Veres et al. 2012 model [1]_.

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 plugin is designed to refine the measurements of trail length,
angle, and end points from `NaivePlugin`, and of flux and centroid from
previous measurement algorithms. Vereš et al. 2012 [1]_ derive a model for
the flux in a given image pixel by convolving an axisymmetric Gaussian with
a line. The model is parameterized by the total flux, trail length, angle
from the x-axis, and the centroid. The best estimates are computed using a
chi-squared minimization.

References
----------
.. [1] Vereš, P., et al. "Improved Asteroid Astrometry and Photometry with
   Trail Fitting" PASP, vol. 124, 2012.

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

Definition at line 52 of file VeresPlugin.py.

Constructor & Destructor Documentation

__init__()

lsst.meas.extensions.trailedSources.VeresPlugin.SingleFrameVeresTrailPlugin.__init__	(		self,
			config,
			name,
			schema,
			metadata,
			logName = None )

Definition at line 97 of file VeresPlugin.py.

Member Function Documentation

fail()

lsst.meas.extensions.trailedSources.VeresPlugin.SingleFrameVeresTrailPlugin.fail	(		self,
			measRecord,
			error = None )

Record failure

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

Definition at line 187 of file VeresPlugin.py.

getExecutionOrder()

lsst.meas.extensions.trailedSources.VeresPlugin.SingleFrameVeresTrailPlugin.getExecutionOrder

(

cls

)

Definition at line 92 of file VeresPlugin.py.

measure()

lsst.meas.extensions.trailedSources.VeresPlugin.SingleFrameVeresTrailPlugin.measure	(		self,
			measRecord,
			exposure )

Run the Veres trailed source measurement plugin.

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

Definition at line 121 of file VeresPlugin.py.

Member Data Documentation

centroidExtractor

lsst.meas.extensions.trailedSources.VeresPlugin.SingleFrameVeresTrailPlugin.centroidExtractor = SafeCentroidExtractor(schema, name)

Definition at line 119 of file VeresPlugin.py.

ConfigClass

lsst.meas.extensions.trailedSources.VeresPlugin.SingleFrameVeresTrailPlugin.ConfigClass = SingleFrameVeresTrailConfig

static

Definition at line 89 of file VeresPlugin.py.

FAILURE

lsst.meas.extensions.trailedSources.VeresPlugin.SingleFrameVeresTrailPlugin.FAILURE = flagDefs.addFailureFlag("No trailed-sources measured")

Definition at line 114 of file VeresPlugin.py.

flagHandler

lsst.meas.extensions.trailedSources.VeresPlugin.SingleFrameVeresTrailPlugin.flagHandler = FlagHandler.addFields(schema, name, flagDefs)

Definition at line 117 of file VeresPlugin.py.

keyFlux

lsst.meas.extensions.trailedSources.VeresPlugin.SingleFrameVeresTrailPlugin.keyFlux = schema.addField(name + "_flux", type="D", doc="Trailed source flux.", units="count")

Definition at line 110 of file VeresPlugin.py.

keyLength

lsst.meas.extensions.trailedSources.VeresPlugin.SingleFrameVeresTrailPlugin.keyLength = schema.addField(name + "_length", type="D", doc="Length of trail.", units="pixel")

Definition at line 108 of file VeresPlugin.py.

keyRChiSq

lsst.meas.extensions.trailedSources.VeresPlugin.SingleFrameVeresTrailPlugin.keyRChiSq = schema.addField(name + "_rChiSq", type="D", doc="Reduced chi-squared of fit")

Definition at line 111 of file VeresPlugin.py.

keyTheta

lsst.meas.extensions.trailedSources.VeresPlugin.SingleFrameVeresTrailPlugin.keyTheta = schema.addField(name + "_angle", type="D", doc="Angle of trail from +x-axis.")

Definition at line 109 of file VeresPlugin.py.

keyX0

lsst.meas.extensions.trailedSources.VeresPlugin.SingleFrameVeresTrailPlugin.keyX0 = schema.addField(name + "_x0", type="D", doc="Trail head X coordinate.", units="pixel")

Definition at line 104 of file VeresPlugin.py.

keyX1

lsst.meas.extensions.trailedSources.VeresPlugin.SingleFrameVeresTrailPlugin.keyX1 = schema.addField(name + "_x1", type="D", doc="Trail tail X coordinate.", units="pixel")

Definition at line 106 of file VeresPlugin.py.

keyXC

lsst.meas.extensions.trailedSources.VeresPlugin.SingleFrameVeresTrailPlugin.keyXC

Initial value:

=  schema.addField(
            name + "_centroid_x", type="D", doc="Trail centroid X coordinate.", units="pixel")

Definition at line 100 of file VeresPlugin.py.

keyY0

lsst.meas.extensions.trailedSources.VeresPlugin.SingleFrameVeresTrailPlugin.keyY0 = schema.addField(name + "_y0", type="D", doc="Trail head Y coordinate.", units="pixel")

Definition at line 105 of file VeresPlugin.py.

keyY1

lsst.meas.extensions.trailedSources.VeresPlugin.SingleFrameVeresTrailPlugin.keyY1 = schema.addField(name + "_y1", type="D", doc="Trail tail Y coordinate.", units="pixel")

Definition at line 107 of file VeresPlugin.py.

keyYC

lsst.meas.extensions.trailedSources.VeresPlugin.SingleFrameVeresTrailPlugin.keyYC

Initial value:

=  schema.addField(
            name + "_centroid_y", type="D", doc="Trail centroid Y coordinate.", units="pixel")

Definition at line 102 of file VeresPlugin.py.

NO_NAIVE

lsst.meas.extensions.trailedSources.VeresPlugin.SingleFrameVeresTrailPlugin.NO_NAIVE = flagDefs.add("flag_noNaive", "Naive measurement contains NaNs")

Definition at line 116 of file VeresPlugin.py.

NON_CONVERGE

lsst.meas.extensions.trailedSources.VeresPlugin.SingleFrameVeresTrailPlugin.NON_CONVERGE = flagDefs.add("flag_nonConvergence", "Optimizer did not converge")

Definition at line 115 of file VeresPlugin.py.

---

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

• python/lsst/meas/extensions/trailedSources/VeresPlugin.py