Base class for single-frame measurement plugin.
Parameters
----------
config : `SingleFramePlugin.ConfigClass`
Configuration for this plugin.
name : `str`
The string with which the plugin was registered.
schema : `lsst.afw.table.Schema`
The schema for the source table . New fields are added here to
hold measurements produced by this plugin.
metadata : `lsst.daf.base.PropertySet`
Plugin metadata that will be attached to the output catalog
logName : `str`, optional
Name to use when logging errors.
Notes
-----
New plugins can be created in Python by inheriting directly from this
class and implementing the `measure`, `fail` (from `BasePlugin`), and
optionally `__init__` and `measureN` methods. Plugins can also be defined
in C++ via the `WrappedSingleFramePlugin` class.
Definition at line 52 of file sfm.py.
def lsst.meas.base.sfm.SingleFramePlugin.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 in lsst.meas.base.compensatedGaussian._compensatedGaussian.SingleFrameCompensatedGaussianFluxPlugin, lsst.meas.base.plugins.SingleFrameFPPositionPlugin, lsst.meas.base.plugins.SingleFrameJacobianPlugin, lsst.meas.base.plugins.SingleFramePeakCentroidPlugin, lsst.meas.base.plugins.SingleFrameSkyCoordPlugin, and lsst.meas.base.wrappers.WrappedSingleFramePlugin.
Definition at line 86 of file sfm.py.
def lsst.meas.base.sfm.SingleFramePlugin.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 in lsst.meas.base.wrappers.WrappedSingleFramePlugin.
Definition at line 104 of file sfm.py.