Base class for forced measurement plugins.
Parameters
----------
config : `ForcedPlugin.ConfigClass`
Configuration for this plugin.
name : `str`
The string with which the plugin was registered.
schemaMapper : `lsst.afw.table.SchemaMapper`
A mapping from reference catalog fields to output catalog fields.
Output fields should be added to the output schema. While most plugins
will not need to map fields from the reference schema, if they do so,
those fields will be transferred before any plugins are run.
metadata : `lsst.daf.base.PropertySet`
Plugin metadata that will be attached to the output catalog.
logName : `str`, optional
Name to use when logging errors.
Definition at line 76 of file forcedMeasurement.py.
def lsst.meas.base.pluginsBase.BasePlugin.fail |
( |
|
self, |
|
|
|
measRecord, |
|
|
|
error = None |
|
) |
| |
|
inherited |
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 in lsst.meas.base.wrappers.GenericPlugin, lsst.meas.base.wrappers.WrappedForcedPlugin, lsst.meas.base.wrappers.WrappedSingleFramePlugin, lsst.meas.base.plugins.SingleFrameSkyCoordPlugin, lsst.meas.base.plugins.SingleFramePeakCentroidPlugin, 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, and lsst.meas.base.classification.CatalogCalculationClassificationPlugin.
Definition at line 137 of file pluginsBase.py.
def lsst.meas.base.forcedMeasurement.ForcedPlugin.measure |
( |
|
self, |
|
|
|
measRecord, |
|
|
|
exposure, |
|
|
|
refRecord, |
|
|
|
refWcs |
|
) |
| |
Measure the properties of a source given an image and a reference.
Parameters
----------
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.
measRecord : `lsst.afw.table.SourceRecord`
Record describing the object being measured. Previously-measured
quantities will be retrieved from here, and it will be updated
in-place with the outputs of this plugin.
refRecord : `lsst.afw.table.SimpleRecord`
Additional parameters to define the fit, as measured elsewhere.
refWcs : `lsst.afw.geom.SkyWcs` or `lsst.afw.geom.Angle`
The coordinate system for the reference catalog values. An
`~lsst.geom.Angle` may be passed, indicating that a local tangent
WCS should be created for each object using the given angle as a
pixel scale.
Notes
-----
In the normal mode of operation, the source centroid will be set to
the WCS-transformed position of the reference object, so plugins that
only require a reference position should not have to access the
reference object at all.
Reimplemented in lsst.meas.base.wrappers.WrappedForcedPlugin, lsst.meas.base.plugins.ForcedTransformedShapePlugin, lsst.meas.base.plugins.ForcedTransformedCentroidPlugin, and lsst.meas.base.plugins.ForcedPeakCentroidPlugin.
Definition at line 105 of file forcedMeasurement.py.
def lsst.meas.base.forcedMeasurement.ForcedPlugin.measureN |
( |
|
self, |
|
|
|
measCat, |
|
|
|
exposure, |
|
|
|
refCat, |
|
|
|
refWcs |
|
) |
| |
Measure the properties of blended sources from image & reference.
This operates on all members of a blend family at once.
Parameters
----------
exposure : `lsst.afw.image.ExposureF`
The pixel data to be measured, together with the associated PSF,
WCS, etc. Sources not in the blended hierarchy to be measured
should have been replaced with noise using deblender outputs.
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.
refCat : `lsst.afw.table.SimpleCatalog`
Additional parameters to define the fit, as measured elsewhere.
Ordered such that ``zip(measCat, refcat)`` may be used.
refWcs : `lsst.afw.geom.SkyWcs` or `lsst.afw.geom.Angle`
The coordinate system for the reference catalog values. An
`~lsst.geom.Angle` may be passed, indicating that a local tangent
WCS should be created for each object using the given angle as a
pixel scale.
Notes
-----
In the normal mode of operation, the source centroids will be set to
the WCS-transformed position of the reference object, so plugins that
only require a reference position should not have to access the
reference object at all.
Reimplemented in lsst.meas.base.wrappers.WrappedForcedPlugin.
Definition at line 135 of file forcedMeasurement.py.