LSST Applications 27.0.0,g0265f82a02+469cd937ee,g02d81e74bb+21ad69e7e1,g1470d8bcf6+cbe83ee85a,g2079a07aa2+e67c6346a6,g212a7c68fe+04a9158687,g2305ad1205+94392ce272,g295015adf3+81dd352a9d,g2bbee38e9b+469cd937ee,g337abbeb29+469cd937ee,g3939d97d7f+72a9f7b576,g487adcacf7+71499e7cba,g50ff169b8f+5929b3527e,g52b1c1532d+a6fc98d2e7,g591dd9f2cf+df404f777f,g5a732f18d5+be83d3ecdb,g64a986408d+21ad69e7e1,g858d7b2824+21ad69e7e1,g8a8a8dda67+a6fc98d2e7,g99cad8db69+f62e5b0af5,g9ddcbc5298+d4bad12328,ga1e77700b3+9c366c4306,ga8c6da7877+71e4819109,gb0e22166c9+25ba2f69a1,gb6a65358fc+469cd937ee,gbb8dafda3b+69d3c0e320,gc07e1c2157+a98bf949bb,gc120e1dc64+615ec43309,gc28159a63d+469cd937ee,gcf0d15dbbd+72a9f7b576,gdaeeff99f8+a38ce5ea23,ge6526c86ff+3a7c1ac5f1,ge79ae78c31+469cd937ee,gee10cc3b42+a6fc98d2e7,gf1cff7945b+21ad69e7e1,gfbcc870c63+9a11dc8c8f
LSST Data Management Base Package
|
Public Member Functions | |
getExecutionOrder (cls) | |
__init__ (self, config, name, schema, metadata, logName=None) | |
measure (self, measRecord, exposure, center) | |
measureN (self, measCat, exposure, refCat, refWcs) | |
fail (self, measRecord, error=None) | |
makeSingleFramePlugin (cls, name) | |
makeForcedPlugin (cls, name) | |
Static Public Attributes | |
ConfigClass = None | |
Protected Attributes | |
_failKey | |
_generic | |
Abstract base class for a generic plugin. Parameters ---------- config : `lsst.pex.config.Config` An instance of this class' ``ConfigClass``. name : `str` Name of this measurement plguin, for registering. schema : `lsst.afw.table.Schema` The catalog schema. New fields should be added here to hold measurements produced by this plugin. metadata : `lsst.daf.base.PropertySet` Metadata that will be attached to the output catalog. logName : `str`, optional Name of log component. Notes ----- A generic plugin can be used with the `singleFramePluginFromGeneric` and/or `forcedPluginFromGeneric` wrappers to create classes that can be used for single frame measurement and/or forced measurement (as appropriate). The only real difference between `SingleFramePlugin` and `ForcedPlugin` is the ``measure`` method; this class introduces a shared signature for `measure` that, in combination with the aforementioned wrappers, allows both plugin styles to share a single implementation. This doesn't use `abc.ABCMeta` because I couldn't get it to work with a superclass. Sub-classes should set `ConfigClass` and implement the `measure` and `measureN` methods. They may optionally provide alternative implementations for the `__init__`, `fail` and `getExecutionOrder` methods. This default implementation simply adds a field for recording a fatal failure of the measurement plugin.
Definition at line 501 of file wrappers.py.
lsst.meas.base.wrappers.GenericPlugin.__init__ | ( | self, | |
config, | |||
name, | |||
schema, | |||
metadata, | |||
logName = None ) |
Reimplemented from lsst.meas.base.pluginsBase.BasePlugin.
Reimplemented in lsst.meas.base.plugins.VariancePlugin, lsst.meas.base.plugins.InputCountPlugin, lsst.meas.base.plugins.EvaluateLocalPhotoCalibPlugin, and lsst.meas.base.plugins.EvaluateLocalWcsPlugin.
Definition at line 545 of file wrappers.py.
lsst.meas.base.wrappers.GenericPlugin.fail | ( | self, | |
measRecord, | |||
error = None ) |
Record a measurement failure. This default implementation simply records the failure in the source record. Parameters ---------- measRecord : `lsst.afw.table.SourceRecord` Catalog record for the source being measured. error : `Exception` Error causing failure, or `None`.
Reimplemented from lsst.meas.base.pluginsBase.BasePlugin.
Reimplemented in lsst.meas.base.plugins.VariancePlugin, and lsst.meas.base.plugins.InputCountPlugin.
Definition at line 595 of file wrappers.py.
lsst.meas.base.wrappers.GenericPlugin.getExecutionOrder | ( | cls | ) |
Get the relative execution order of this plugin. Must be reimplemented as a class method by concrete derived classes.
Reimplemented from lsst.meas.base.pluginsBase.BasePlugin.
Reimplemented in lsst.meas.base.plugins.VariancePlugin, lsst.meas.base.plugins.InputCountPlugin, lsst.meas.base.plugins.EvaluateLocalPhotoCalibPlugin, and lsst.meas.base.plugins.EvaluateLocalWcsPlugin.
Definition at line 542 of file wrappers.py.
lsst.meas.base.wrappers.GenericPlugin.makeForcedPlugin | ( | cls, | |
name ) |
Produce a ForcedPlugin subclass from this GenericPlugin class. The class is also registered. Parameters ---------- name : `str` Name of plugin to register.
Definition at line 652 of file wrappers.py.
lsst.meas.base.wrappers.GenericPlugin.makeSingleFramePlugin | ( | cls, | |
name ) |
Produce a SingleFramePlugin subclass from this GenericPlugin class. The class is also registered. Parameters ---------- name : `str` Name of plugin to register.
Definition at line 611 of file wrappers.py.
lsst.meas.base.wrappers.GenericPlugin.measure | ( | self, | |
measRecord, | |||
exposure, | |||
center ) |
Measure a single source. It is the responsibility of this method to perform the desired measurement and record the result in the `measRecord`. Parameters ---------- measRecord : `lsst.afw.table.SourceRecord` Catalog record for the source being measured. exposure : `lsst.afw.image.Exposure` Exposure on which the source is being measured. center : `lsst.geom.Point2D` Pixel coordinates of the object. Raises ------ MeasurementError Raised if the measurement fails for a known/justifiable reason.
Reimplemented in lsst.meas.base.plugins.VariancePlugin, lsst.meas.base.plugins.InputCountPlugin, lsst.meas.base.plugins.EvaluateLocalPhotoCalibPlugin, and lsst.meas.base.plugins.EvaluateLocalWcsPlugin.
Definition at line 549 of file wrappers.py.
lsst.meas.base.wrappers.GenericPlugin.measureN | ( | self, | |
measCat, | |||
exposure, | |||
refCat, | |||
refWcs ) |
Measure multiple sources. It is the responsibility of this method to perform the desired measurement and record the result in the `measCat`. Parameters ---------- measCat : `lsst.afw.table.SourceCatalog` Catalog for the sources being measured. exposure : `lsst.afw.image.Exposure` Exposure on which the source is being measured. refCat : `lsst.afw.table.SourceCatalog` Reference catalog. refWcs : `lsst.afw.image.Wcs` Astrometric solution for the reference image. Raises ------ MeasurementError Raised if the measurement fails for a known/justifiable reason.
Definition at line 571 of file wrappers.py.
|
protected |
Definition at line 547 of file wrappers.py.
|
protected |
Definition at line 630 of file wrappers.py.
|
static |
Definition at line 539 of file wrappers.py.