ForcedPlugin

class lsst.meas.base.ForcedPlugin(config, name, schemaMapper, metadata, logName=None)

Bases: BaseMeasurementPlugin

Base class for forced measurement plugins.

Parameters

configForcedPlugin.ConfigClass

Configuration for this plugin.

namestr

The string with which the plugin was registered.

schemaMapperlsst.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.

metadatalsst.daf.base.PropertySet

Plugin metadata that will be attached to the output catalog.

logNamestr, optional

Name to use when logging errors.

Attributes Summary

registry

Subclasses of ForcedPlugin must be registered here (PluginRegistry).

Methods Summary

measure(measRecord, exposure, refRecord, refWcs)	Measure the properties of a source given an image and a reference.
measureN(measCat, exposure, refCat, refWcs)	Measure the properties of blended sources from image & reference.

Attributes Documentation

registry = <lsst.meas.base.pluginRegistry.PluginRegistry object>

Subclasses of ForcedPlugin must be registered here (PluginRegistry).

Methods Documentation

measure(measRecord, exposure, refRecord, refWcs)

Measure the properties of a source given an image and a reference.

Parameters

exposurelsst.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.

measRecordlsst.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.

refRecordlsst.afw.table.SimpleRecord

Additional parameters to define the fit, as measured elsewhere.

refWcslsst.afw.geom.SkyWcs or lsst.afw.geom.Angle

The coordinate system for the reference catalog values. An 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.

measureN(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

exposurelsst.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.

measCatlsst.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.

refCatlsst.afw.table.SimpleCatalog

Additional parameters to define the fit, as measured elsewhere. Ordered such that zip(measCat, refcat) may be used.

refWcslsst.afw.geom.SkyWcs or lsst.afw.geom.Angle

The coordinate system for the reference catalog values. An 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.