SingleFrameVeresTrailPlugin¶
- class lsst.meas.extensions.trailedSources.SingleFrameVeresTrailPlugin(config, name, schema, metadata, logName=None)¶
Bases:
SingleFramePlugin
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.
See also
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
Attributes Summary
Order for algorithms which require shape, centroid and flux (
float
).Order for algorithms which require only Footprint and Peaks (
float
).Order for catalog calculation plugins.
Order for algorithms which require a shape and a centroid (
float
).Order for algorithms which require a centroid (
float
).Registry of subclasses of
SingleFramePlugin
(PluginRegistry
).Methods Summary
fail
(measRecord[, error])Record failure
Get the relative execution order of this plugin.
Get the measurement transformation appropriate to this plugin.
measure
(measRecord, exposure)Run the Veres trailed source measurement plugin.
measureN
(measCat, exposure)Measure the properties of blended sources on a single image.
Attributes Documentation
- APCORR_ORDER = 3.0¶
Order for algorithms which require shape, centroid and flux (
float
).Notes
These algorithms may assume that
getCentroid
andgetShape
will return good values, that flux has been measured, and that and that a Footprint and its Peaks are available.
- CENTROID_ORDER = 0.0¶
Order for algorithms which require only Footprint and Peaks (
float
).Notes
Algorithms with this execution order include centroids.
- DEFAULT_CATALOGCALCULATION = 4.0¶
Order for catalog calculation plugins.
Notes
These plugins only operate on catalogs; they may not access pixel values.
- FLUX_ORDER = 2.0¶
Order for algorithms which require a shape and a centroid (
float
).Notes
These algorithms may assume that both
getCentroid
andgetShape
will return good values, and that a Footprint and its Peaks are available.
- SHAPE_ORDER = 1.0¶
Order for algorithms which require a centroid (
float
).Notes
These algorithms may refer assume that
getCentroid
will return a good centroid, and that a Footprint and its Peaks are available.
- registry = <lsst.meas.base.pluginRegistry.PluginRegistry object>¶
Registry of subclasses of
SingleFramePlugin
(PluginRegistry
).
Methods Documentation
- fail(measRecord, error=None)¶
Record failure
- classmethod getExecutionOrder()¶
Get the relative execution order of this plugin.
Must be reimplemented as a class method by concrete derived classes.
- getLogName()¶
- static 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.
- measure(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.
- measRecord
- measureN(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.
- measCat
Notes
Derived classes that do not implement
measureN
should just inherit this disabled version. Derived classes that do implementmeasureN
should additionally add a bool doMeasureN config field to their config class to signal that measureN-mode is available.