|
def | __init__ (self, config, name, schema, metadata, logName=None) |
|
def | measure (self, measRecord, exposure) |
|
def | measureN (self, measCat, exposure) |
|
def | fail (self, measRecord, error=None) |
|
def | getExecutionOrder (cls) |
|
def | getLogName (self) |
|
Definition at line 33 of file wrappers.py.
◆ __init__()
def lsst.meas.base.wrappers.WrappedSingleFramePlugin.__init__ |
( |
|
self, |
|
|
|
config, |
|
|
|
name, |
|
|
|
schema, |
|
|
|
metadata, |
|
|
|
logName = None |
|
) |
| |
◆ fail()
def lsst.meas.base.wrappers.WrappedSingleFramePlugin.fail |
( |
|
self, |
|
|
|
measRecord, |
|
|
|
error = None |
|
) |
| |
Record a failure of the `measure` or `measureN` method.
Parameters
----------
measRecord : `lsst.afw.table.SourceRecord`
Table record describing the source being measured.
error : `MeasurementError`, optional
Only provided if the measurement failed due to a
`MeasurementError` being raised; otherwise, will be `None`.
Notes
-----
When the plugin raises an exception, framework will call
`BasePlugin.fail` to allow the plugin to set its failure flag
field(s). When `BasePlugin.measureN` raises an exception,
`BasePlugin.fail` will be called repeatedly with all the records that
were being measured.
If the exception is an `MeasurementError`, it will be passed as the
error argument; in all other cases the error argument will be `None`,
and the failure will be logged by the measurement framework as a
warning.
Reimplemented from lsst.meas.base.pluginsBase.BasePlugin.
Definition at line 48 of file wrappers.py.
◆ getExecutionOrder()
def lsst.meas.base.pluginsBase.BasePlugin.getExecutionOrder |
( |
|
cls | ) |
|
|
inherited |
Get the relative execution order of this plugin.
Must be reimplemented as a class method by concrete derived classes.
Reimplemented in lsst.meas.base.wrappers.GenericPlugin, lsst.meas.base.plugins.ForcedTransformedShapePlugin, lsst.meas.base.plugins.ForcedTransformedCentroidPlugin, lsst.meas.base.plugins.ForcedPeakCentroidPlugin, lsst.meas.base.plugins.SingleFrameSkyCoordPlugin, lsst.meas.base.plugins.SingleFramePeakCentroidPlugin, lsst.meas.base.plugins.EvaluateLocalWcsPlugin, lsst.meas.base.plugins.EvaluateLocalPhotoCalibPlugin, lsst.meas.base.plugins.InputCountPlugin, lsst.meas.base.plugins.VariancePlugin, lsst.meas.base.plugins.SingleFrameJacobianPlugin, lsst.meas.base.plugins.SingleFrameFPPositionPlugin, lsst.meas.base.footprintArea.CatalogCalculationFootprintAreaPlugin, lsst.meas.base.diaCalculationPlugins.SigmaDiaTotFlux, lsst.meas.base.diaCalculationPlugins.WeightedMeanDiaTotFlux, lsst.meas.base.diaCalculationPlugins.StetsonJDiaPsFlux, lsst.meas.base.diaCalculationPlugins.LinearFitDiaPsFlux, lsst.meas.base.diaCalculationPlugins.ErrMeanDiaPsFlux, lsst.meas.base.diaCalculationPlugins.MaxSlopeDiaPsFlux, lsst.meas.base.diaCalculationPlugins.MinMaxDiaPsFlux, lsst.meas.base.diaCalculationPlugins.SkewDiaPsFlux, lsst.meas.base.diaCalculationPlugins.MadDiaPsFlux, lsst.meas.base.diaCalculationPlugins.Chi2DiaPsFlux, lsst.meas.base.diaCalculationPlugins.SigmaDiaPsFlux, lsst.meas.base.diaCalculationPlugins.PercentileDiaPsFlux, lsst.meas.base.diaCalculationPlugins.WeightedMeanDiaPsFlux, lsst.meas.base.diaCalculationPlugins.SimpleSourceFlagDiaPlugin, lsst.meas.base.diaCalculationPlugins.NumDiaSourcesDiaPlugin, lsst.meas.base.diaCalculationPlugins.HTMIndexDiaPosition, lsst.meas.base.diaCalculationPlugins.MeanDiaPosition, lsst.meas.base.classification.CatalogCalculationClassificationPlugin, and lsst.meas.base.catalogCalculation.CatalogCalculationPlugin.
Definition at line 121 of file pluginsBase.py.
◆ getLogName()
def lsst.meas.base.pluginsBase.BasePlugin.getLogName |
( |
|
self | ) |
|
|
inherited |
◆ 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.
◆ measure()
def lsst.meas.base.wrappers.WrappedSingleFramePlugin.measure |
( |
|
self, |
|
|
|
measRecord, |
|
|
|
exposure |
|
) |
| |
Measure the properties of a source on a single image.
The image may be from a single epoch, or it may be a coadd.
Parameters
----------
measRecord : `lsst.afw.table.SourceRecord`
Record describing the object being measured. Previously-measured
quantities may be retrieved from here, and it will be updated
in-place tih 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.
Reimplemented from lsst.meas.base.sfm.SingleFramePlugin.
Definition at line 42 of file wrappers.py.
◆ measureN()
def lsst.meas.base.wrappers.WrappedSingleFramePlugin.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.
Reimplemented from lsst.meas.base.sfm.SingleFramePlugin.
Definition at line 45 of file wrappers.py.
◆ APCORR_ORDER
float lsst.meas.base.pluginsBase.BasePlugin.APCORR_ORDER = 3.0 |
|
staticinherited |
◆ CENTROID_ORDER
float lsst.meas.base.pluginsBase.BasePlugin.CENTROID_ORDER = 0.0 |
|
staticinherited |
◆ config
lsst.meas.base.pluginsBase.BasePlugin.config |
|
inherited |
◆ ConfigClass
◆ cpp
lsst.meas.base.wrappers.WrappedSingleFramePlugin.cpp |
◆ DEFAULT_CATALOGCALCULATION
float lsst.meas.base.pluginsBase.BasePlugin.DEFAULT_CATALOGCALCULATION = 4.0 |
|
staticinherited |
◆ FLUX_ORDER
float lsst.meas.base.pluginsBase.BasePlugin.FLUX_ORDER = 2.0 |
|
staticinherited |
◆ logName
lsst.meas.base.pluginsBase.BasePlugin.logName |
|
inherited |
◆ name
lsst.meas.base.pluginsBase.BasePlugin.name |
|
inherited |
◆ registry
◆ SHAPE_ORDER
float lsst.meas.base.pluginsBase.BasePlugin.SHAPE_ORDER = 1.0 |
|
staticinherited |
The documentation for this class was generated from the following file: