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

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

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	measureN (self, measCat, exposure)
def	getLogName (self)

Static Public Member Functions
def	getTransformClass ()

Public Attributes
	keyXC
	keyYC
	keyX0
	keyY0
	keyX1
	keyY1
	keyL
	keyTheta
	keyFlux
	keyRChiSq
	NON_CONVERGE
	NO_NAIVE
	flagHandler
	centroidExtractor
	config
	name
	logName

Static Public Attributes
	ConfigClass = SingleFrameVeresTrailConfig
	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

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__()

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

Definition at line 97 of file VeresPlugin.py.

    def __init__(self, config, name, schema, metadata):
        super().__init__(config, name, schema, metadata)
 
        self.keyXC = schema.addField(
            name + "_centroid_x", type="D", doc="Trail centroid X coordinate.", units="pixel")
        self.keyYC = schema.addField(
            name + "_centroid_y", type="D", doc="Trail centroid Y coordinate.", units="pixel")
        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.keyL = schema.addField(name + "_length", type="D", doc="Length of trail.", units="pixel")
        self.keyTheta = schema.addField(name + "_angle", type="D", doc="Angle of trail from +x-axis.")
        self.keyFlux = schema.addField(name + "_flux", type="D", doc="Trailed source flux.", units="count")
        self.keyRChiSq = schema.addField(name + "_rChiSq", type="D", doc="Reduced chi-squared of fit")
 
        flagDefs = FlagDefinitionList()
        flagDefs.addFailureFlag("No trailed-sources measured")
        self.NON_CONVERGE = flagDefs.add("flag_nonConvergence", "Optimizer did not converge")
        self.NO_NAIVE = flagDefs.add("flag_noNaive", "Naive measurement contains NaNs")
        self.flagHandler = FlagHandler.addFields(schema, name, flagDefs)
 
        self.centroidExtractor = SafeCentroidExtractor(schema, name)
 

Member Function Documentation

fail()

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

Record failure

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

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

Definition at line 178 of file VeresPlugin.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)

getExecutionOrder()

def lsst.meas.extensions.trailedSources.VeresPlugin.SingleFrameVeresTrailPlugin.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 92 of file VeresPlugin.py.

    def getExecutionOrder(cls):
        # Needs centroids, shape, flux, and NaivePlugin measurements.
        # Make sure this always runs after NaivePlugin.
        return SingleFrameNaiveTrailPlugin.getExecutionOrder() + 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.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

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

Definition at line 121 of file VeresPlugin.py.

    def 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
        """
        xc, yc = self.centroidExtractor(measRecord, self.flagHandler)
 
        # Look at measRecord for Naive measurements
        # ASSUMES NAIVE ALREADY RAN
        F = measRecord.get("ext_trailedSources_Naive_flux")
        L = measRecord.get("ext_trailedSources_Naive_length")
        theta = measRecord.get("ext_trailedSources_Naive_angle")
        if not np.isfinite(F) or not np.isfinite(L) or not np.isfinite(theta):
            raise MeasurementError(self.NO_NAIVE.doc, self.NO_NAIVE.number)
 
        # Make VeresModel
        model = VeresModel(exposure)
 
        # Do optimization with scipy
        params = np.array([xc, yc, F, L, theta])
        results = sciOpt.minimize(
            model, params, method=self.config.optimizerMethod, jac=model.gradient)
 
        # Check if optimizer converged
        if not results.success:
            raise MeasurementError(self.NON_CONVERGE.doc, self.NON_CONVERGE.number)
 
        # Calculate end points and reduced chi-squared
        xc_fit, yc_fit, F_fit, L_fit, theta_fit = results.x
        a = L_fit/2
        x0_fit = xc_fit - a * np.cos(theta_fit)
        y0_fit = yc_fit - a * np.sin(theta_fit)
        x1_fit = xc_fit + a * np.cos(theta_fit)
        y1_fit = yc_fit + a * np.sin(theta_fit)
        rChiSq = results.fun / (exposure.image.array.size - 6)
 
        # Set keys
        measRecord.set(self.keyXC, xc_fit)
        measRecord.set(self.keyYC, yc_fit)
        measRecord.set(self.keyX0, x0_fit)
        measRecord.set(self.keyY0, y0_fit)
        measRecord.set(self.keyX1, x1_fit)
        measRecord.set(self.keyY1, y1_fit)
        measRecord.set(self.keyFlux, F_fit)
        measRecord.set(self.keyL, L_fit)
        measRecord.set(self.keyTheta, theta_fit)
        measRecord.set(self.keyRChiSq, rChiSq)
 

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.

CENTROID_ORDER

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

staticinherited

Definition at line 72 of file pluginsBase.py.

centroidExtractor

lsst.meas.extensions.trailedSources.VeresPlugin.SingleFrameVeresTrailPlugin.centroidExtractor

Definition at line 119 of file VeresPlugin.py.

config

lsst.meas.base.pluginsBase.BasePlugin.config

inherited

Definition at line 130 of file pluginsBase.py.

ConfigClass

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

static

Definition at line 89 of file VeresPlugin.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.VeresPlugin.SingleFrameVeresTrailPlugin.flagHandler

Definition at line 117 of file VeresPlugin.py.

FLUX_ORDER

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

staticinherited

Definition at line 89 of file pluginsBase.py.

keyFlux

lsst.meas.extensions.trailedSources.VeresPlugin.SingleFrameVeresTrailPlugin.keyFlux

Definition at line 110 of file VeresPlugin.py.

keyL

lsst.meas.extensions.trailedSources.VeresPlugin.SingleFrameVeresTrailPlugin.keyL

Definition at line 108 of file VeresPlugin.py.

keyRChiSq

lsst.meas.extensions.trailedSources.VeresPlugin.SingleFrameVeresTrailPlugin.keyRChiSq

Definition at line 111 of file VeresPlugin.py.

keyTheta

lsst.meas.extensions.trailedSources.VeresPlugin.SingleFrameVeresTrailPlugin.keyTheta

Definition at line 109 of file VeresPlugin.py.

keyX0

lsst.meas.extensions.trailedSources.VeresPlugin.SingleFrameVeresTrailPlugin.keyX0

Definition at line 104 of file VeresPlugin.py.

keyX1

lsst.meas.extensions.trailedSources.VeresPlugin.SingleFrameVeresTrailPlugin.keyX1

Definition at line 106 of file VeresPlugin.py.

keyXC

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

Definition at line 100 of file VeresPlugin.py.

keyY0

lsst.meas.extensions.trailedSources.VeresPlugin.SingleFrameVeresTrailPlugin.keyY0

Definition at line 105 of file VeresPlugin.py.

keyY1

lsst.meas.extensions.trailedSources.VeresPlugin.SingleFrameVeresTrailPlugin.keyY1

Definition at line 107 of file VeresPlugin.py.

keyYC

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

Definition at line 102 of file VeresPlugin.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_NAIVE

lsst.meas.extensions.trailedSources.VeresPlugin.SingleFrameVeresTrailPlugin.NO_NAIVE

Definition at line 116 of file VeresPlugin.py.

NON_CONVERGE

lsst.meas.extensions.trailedSources.VeresPlugin.SingleFrameVeresTrailPlugin.NON_CONVERGE

Definition at line 115 of file VeresPlugin.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/VeresPlugin.py