|
lsst.meas.base gdcad512fc6+6ea5d77ecf
|
Public Member Functions | |
| def | __init__ (self, algMetadata=None, **kwds) |
| def | initializePlugins (self, **kwds) |
| def | callMeasure (self, measRecord, *args, **kwds) |
| def | doMeasurement (self, plugin, measRecord, *args, **kwds) |
| def | callMeasureN (self, measCat, *args, **kwds) |
| def | doMeasurementN (self, plugin, measCat, *args, **kwds) |
Public Attributes | |
| undeblendedPlugins | |
Static Public Attributes | |
| ConfigClass = BaseMeasurementConfig | |
| plugins = None | |
| algMetadata = None | |
Ultimate base class for all measurement tasks.
Parameters
----------
algMetadata : `lsst.daf.base.PropertyList` or `None`
Will be modified in-place to contain metadata about the plugins being
run. If `None`, an empty `~lsst.daf.base.PropertyList` will be
created.
**kwds
Additional arguments passed to `lsst.pipe.base.Task.__init__`.
Notes
-----
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 216 of file baseMeasurement.py.
| def lsst.meas.base.baseMeasurement.BaseMeasurementTask.__init__ | ( | self, | |
algMetadata = None, |
|||
| ** | kwds | ||
| ) |
Reimplemented in lsst.meas.base.forcedMeasurement.ForcedMeasurementTask, and lsst.meas.base.sfm.SingleFrameMeasurementTask.
Definition at line 252 of file baseMeasurement.py.
| def lsst.meas.base.baseMeasurement.BaseMeasurementTask.callMeasure | ( | self, | |
| measRecord, | |||
| * | args, | ||
| ** | kwds | ||
| ) |
Call ``measure`` on all plugins and consistently handle exceptions.
Parameters
----------
measRecord : `lsst.afw.table.SourceRecord`
The record corresponding to the object being measured. Will be
updated in-place with the results of measurement.
*args
Positional arguments forwarded to ``plugin.measure``
**kwds
Keyword arguments. Two are handled locally:
beginOrder : `int`
Beginning execution order (inclusive). Measurements with
``executionOrder`` < ``beginOrder`` are not executed. `None`
for no limit.
endOrder : `int`
Ending execution order (exclusive). Measurements with
``executionOrder`` >= ``endOrder`` are not executed. `None`
for no limit.
Others are forwarded to ``plugin.measure()``.
Notes
-----
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.callMeasureN | ( | self, | |
| measCat, | |||
| * | args, | ||
| ** | kwds | ||
| ) |
Call ``measureN`` on all plugins and consistently handle exceptions.
Parameters
----------
measCat : `lsst.afw.table.SourceCatalog`
Catalog containing only the records for the source family to be
measured, and where outputs should be written.
*args
Positional arguments forwarded to ``plugin.measure()``
**kwds
Keyword arguments. Two are handled locally:
beginOrder:
Beginning execution order (inclusive): Measurements with
``executionOrder`` < ``beginOrder`` are not executed. `None`
for no limit.
endOrder:
Ending execution order (exclusive): measurements with
``executionOrder`` >= ``endOrder`` are not executed. `None` for
no ``limit``.
Others are are forwarded to ``plugin.measure()``.
Notes
-----
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 401 of file baseMeasurement.py.
| def lsst.meas.base.baseMeasurement.BaseMeasurementTask.doMeasurement | ( | self, | |
| plugin, | |||
| measRecord, | |||
| * | args, | ||
| ** | kwds | ||
| ) |
Call ``measure`` on the specified plugin.
Exceptions are handled in a consistent way.
Parameters
----------
plugin : subclass of `BasePlugin`
Plugin that will be executed.
measRecord : `lsst.afw.table.SourceRecord`
The record corresponding to the object being measured. Will be
updated in-place with the results of measurement.
*args
Positional arguments forwarded to ``plugin.measure()``.
**kwds
Keyword arguments forwarded to ``plugin.measure()``.
Notes
-----
This method can be used with plugins that have different signatures;
the only requirement is that ``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 359 of file baseMeasurement.py.
| def lsst.meas.base.baseMeasurement.BaseMeasurementTask.doMeasurementN | ( | self, | |
| plugin, | |||
| measCat, | |||
| * | args, | ||
| ** | kwds | ||
| ) |
Call ``measureN`` on the specified plugin.
Exceptions are handled in a consistent way.
Parameters
----------
plugin : subclass of `BasePlugin`
Plugin that will be executed.
measCat : `lsst.afw.table.SourceCatalog`
Catalog containing only the records for the source family to be
measured, and where outputs should be written.
*args
Positional arguments forwarded to ``plugin.measureN()``.
**kwds
Keyword arguments forwarded to ``plugin.measureN()``.
Notes
-----
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 444 of file baseMeasurement.py.
| def lsst.meas.base.baseMeasurement.BaseMeasurementTask.initializePlugins | ( | self, | |
| ** | kwds | ||
| ) |
Initialize plugins (and slots) according to configuration.
Parameters
----------
**kwds
Keyword arguments forwarded directly to plugin constructors.
Notes
-----
Derived class constructors should call this method to fill the
`plugins` attribute and add corresponding output fields and slot
aliases to the output schema.
In addition to the attributes added by `BaseMeasurementTask.__init__`,
a ``schema``` attribute holding the output schema must 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 260 of file baseMeasurement.py.
|
static |
Definition at line 245 of file baseMeasurement.py.
|
static |
Definition at line 235 of file baseMeasurement.py.
|
static |
Definition at line 238 of file baseMeasurement.py.
| lsst.meas.base.baseMeasurement.BaseMeasurementTask.undeblendedPlugins |
Definition at line 255 of file baseMeasurement.py.