lsst.meas.base
16.0-12-g5ad1ebf+4
|
Ultimate base class for all measurement tasks. More...
Public Member Functions | |
def | __init__ (self, algMetadata=None, kwds) |
Constructor; only called by derived classes. More... | |
def | getPluginLogName (self, pluginName) |
def | initializePlugins (self, kwds) |
def | callMeasure (self, measRecord, args, kwds) |
Call the measure() method on all plugins, handling exceptions in a consistent way. More... | |
def | doMeasurement (self, plugin, measRecord, args, kwds) |
Call the measure() method on the nominated plugin, handling exceptions in a consistent way. More... | |
def | callMeasureN (self, measCat, args, kwds) |
Call the measureN() method on all plugins, handling exceptions in a consistent way. More... | |
def | doMeasurementN (self, plugin, measCat, args, kwds) |
Call the measureN() method on the nominated plugin, handling exceptions in a consistent way. More... | |
Public Attributes | |
plugins | |
undeblendedPlugins | |
algMetadata | |
Static Public Attributes | |
ConfigClass = BaseMeasurementConfig | |
Ultimate base class for all measurement tasks.
This base class for SingleFrameMeasurementTask and ForcedMeasurementTask mostly exists to share code between the two, and generally should not be used directly.
Definition at line 181 of file baseMeasurement.py.
def lsst.meas.base.baseMeasurement.BaseMeasurementTask.__init__ | ( | self, | |
algMetadata = None , |
|||
kwds | |||
) |
Constructor; only called by derived classes.
[in] | algMetadata | An lsst.daf.base.PropertyList that will be filled with metadata about the plugins being run. If None, an empty PropertyList will be created. |
[in] | **kwds | Additional arguments passed to lsst.pipe.base.Task.__init__. |
This attaches two public attributes to the class for use by derived classes and parent tasks:
Definition at line 192 of file baseMeasurement.py.
def lsst.meas.base.baseMeasurement.BaseMeasurementTask.callMeasure | ( | self, | |
measRecord, | |||
args, | |||
kwds | |||
) |
Call the measure() method on all plugins, handling exceptions in a consistent way.
[in,out] | measRecord | lsst.afw.table.SourceRecord that corresponds to the object being measured, and where outputs should be written. |
[in] | *args | Positional arguments forwarded to Plugin.measure() |
[in] | **kwds | Keyword arguments. Two are handled locally:
|
This method can be used with plugins that have different signatures; the only requirement is that 'measRecord' be the first argument. Subsequent positional arguments and keyword arguments are forwarded directly to the plugin.
This method should be considered "protected"; it is intended for use by derived classes, not users.
Definition at line 255 of file baseMeasurement.py.
def lsst.meas.base.baseMeasurement.BaseMeasurementTask.callMeasureN | ( | self, | |
measCat, | |||
args, | |||
kwds | |||
) |
Call the measureN() method on all plugins, handling exceptions in a consistent way.
[in,out] | measCat | lsst.afw.table.SourceCatalog containing records for just the source family to be measured, and where outputs should be written. |
[in] | beginOrder | beginning execution order (inclusive): measurements with executionOrder < beginOrder are not executed. None for no limit. |
[in] | endOrder | ending execution order (exclusive): measurements with executionOrder >= endOrder are not executed. None for no limit. |
[in] | *args | Positional arguments forwarded to Plugin.measure() |
[in] | **kwds | Keyword arguments. Two are handled locally:
|
This method can be used with plugins that have different signatures; the only requirement is that 'measRecord' be the first argument. Subsequent positional arguments and keyword arguments are forwarded directly to the plugin.
This method should be considered "protected"; it is intended for use by derived classes, not users.
Definition at line 315 of file baseMeasurement.py.
def lsst.meas.base.baseMeasurement.BaseMeasurementTask.doMeasurement | ( | self, | |
plugin, | |||
measRecord, | |||
args, | |||
kwds | |||
) |
Call the measure() method on the nominated plugin, handling exceptions in a consistent way.
[in] | plugin | Plugin that will measure |
[in,out] | measRecord | lsst.afw.table.SourceRecord that corresponds to the object being measured, and where outputs should be written. |
[in] | *args | Positional arguments forwarded to plugin.measure() |
[in] | **kwds | Keyword arguments forwarded to plugin.measure() |
This method can be used with plugins that have different signatures; the only requirement is that the 'plugin' and 'measRecord' be the first two arguments. Subsequent positional arguments and keyword arguments are forwarded directly to the plugin.
This method should be considered "protected"; it is intended for use by derived classes, not users.
Definition at line 284 of file baseMeasurement.py.
def lsst.meas.base.baseMeasurement.BaseMeasurementTask.doMeasurementN | ( | self, | |
plugin, | |||
measCat, | |||
args, | |||
kwds | |||
) |
Call the measureN() method on the nominated plugin, handling exceptions in a consistent way.
[in] | plugin | Plugin that will measure |
[in,out] | measCat | lsst.afw.table.SourceCatalog containing records for just the source family to be measured, and where outputs should be written. |
[in] | *args | Positional arguments forwarded to plugin.measureN() |
[in] | **kwds | Keyword arguments forwarded to plugin.measureN() |
This method can be used with plugins that have different signatures; the only requirement is that the 'plugin' and 'measCat' be the first two arguments. Subsequent positional arguments and keyword arguments are forwarded directly to the plugin.
This method should be considered "protected"; it is intended for use by derived classes, not users.
Definition at line 349 of file baseMeasurement.py.
def lsst.meas.base.baseMeasurement.BaseMeasurementTask.getPluginLogName | ( | self, | |
pluginName | |||
) |
Definition at line 214 of file baseMeasurement.py.
def lsst.meas.base.baseMeasurement.BaseMeasurementTask.initializePlugins | ( | self, | |
kwds | |||
) |
Initialize the plugins (and slots) according to the configuration. Derived class constructors should call this method to fill the self.plugins attribute and add correspond output fields and slot aliases to the output schema. In addition to the attributes added by BaseMeasurementTask.__init__, a self.schema attribute holding the output schema must also be present before this method is called, . Keyword arguments are forwarded directly to plugin constructors, allowing derived classes to use plugins with different signatures.
Definition at line 217 of file baseMeasurement.py.
lsst.meas.base.baseMeasurement.BaseMeasurementTask.algMetadata |
Definition at line 212 of file baseMeasurement.py.
|
static |
Definition at line 189 of file baseMeasurement.py.
lsst.meas.base.baseMeasurement.BaseMeasurementTask.plugins |
Definition at line 208 of file baseMeasurement.py.
lsst.meas.base.baseMeasurement.BaseMeasurementTask.undeblendedPlugins |
Definition at line 209 of file baseMeasurement.py.