lsst.meas.base.baseMeasurement.BaseMeasurementTask Class Reference

Inheritance diagram for lsst.meas.base.baseMeasurement.BaseMeasurementTask:

Public Member Functions
	__init__ (self, algMetadata=None, **kwds)
	initializePlugins (self, **kwds)
	callMeasureN (self, measCat, *args, **kwds)
	doMeasurementN (self, plugin, measCat, *args, **kwds)
	addInvalidPsfFlag (self, schema)
	callMeasure (self, measRecord, *args, **kwds)
	doMeasurement (self, plugin, measRecord, *args, **kwds)

Static Public Member Functions
	getFootprintsFromCatalog (catalog)

Public Attributes
	undeblendedPlugins = PluginMap()
	keyInvalidPsf = schema.find(invalidPsfName).key

Static Public Attributes
	ConfigClass = SimpleBaseMeasurementConfig
	plugins = None
	algMetadata = None

Static Protected Attributes
str	_DefaultName = "measurement"

Detailed Description

Ultimate base class for all measurement tasks
other than SimpleForcedMeasurementTask.

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 430 of file baseMeasurement.py.

Constructor & Destructor Documentation

__init__()

lsst.meas.base.baseMeasurement.BaseMeasurementTask.__init__	(		self,
			algMetadata = None,
		**	kwds )

Definition at line 452 of file baseMeasurement.py.

Member Function Documentation

addInvalidPsfFlag()

lsst.meas.base.baseMeasurement.SimpleBaseMeasurementTask.addInvalidPsfFlag ( self, schema )

inherited

Definition at line 326 of file baseMeasurement.py.

callMeasure()

lsst.meas.base.baseMeasurement.SimpleBaseMeasurementTask.callMeasure ( self, measRecord, * args, ** kwds )

inherited

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 337 of file baseMeasurement.py.

callMeasureN()

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 470 of file baseMeasurement.py.

doMeasurement()

lsst.meas.base.baseMeasurement.SimpleBaseMeasurementTask.doMeasurement ( self, plugin, measRecord, * args, ** kwds )

inherited

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 381 of file baseMeasurement.py.

doMeasurementN()

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 513 of file baseMeasurement.py.

getFootprintsFromCatalog()

lsst.meas.base.baseMeasurement.BaseMeasurementTask.getFootprintsFromCatalog ( catalog )

static

Get a set of footprints from a catalog, keyed by id.

Parameters
----------
catalog : `lsst.afw.table.SourceCatalog`
    Catalog with `lsst.afw.detection.Footprint`s attached.

Returns
-------
footprints : `dict` [`int`: (`int`, `lsst.afw.detection.Footprint`)]
    Dictionary of footprint, keyed by id number, with a tuple of
    the parent id and footprint.

Definition at line 566 of file baseMeasurement.py.

initializePlugins()

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.

Reimplemented from lsst.meas.base.baseMeasurement.SimpleBaseMeasurementTask.

Definition at line 456 of file baseMeasurement.py.

Member Data Documentation

_DefaultName

str lsst.meas.base.baseMeasurement.SimpleBaseMeasurementTask._DefaultName = "measurement"

staticprotectedinherited

Definition at line 259 of file baseMeasurement.py.

algMetadata

lsst.meas.base.baseMeasurement.SimpleBaseMeasurementTask.algMetadata = None

staticinherited

Definition at line 268 of file baseMeasurement.py.

ConfigClass

lsst.meas.base.baseMeasurement.SimpleBaseMeasurementTask.ConfigClass = SimpleBaseMeasurementConfig

staticinherited

Definition at line 258 of file baseMeasurement.py.

keyInvalidPsf

lsst.meas.base.baseMeasurement.SimpleBaseMeasurementTask.keyInvalidPsf = schema.find(invalidPsfName).key

inherited

Definition at line 329 of file baseMeasurement.py.

plugins

lsst.meas.base.baseMeasurement.SimpleBaseMeasurementTask.plugins = None

staticinherited

Definition at line 261 of file baseMeasurement.py.

undeblendedPlugins

lsst.meas.base.baseMeasurement.BaseMeasurementTask.undeblendedPlugins = PluginMap()

Definition at line 454 of file baseMeasurement.py.

---

The documentation for this class was generated from the following file:

• python/lsst/meas/base/baseMeasurement.py