lsst.meas.base.baseMeasurement.SimpleBaseMeasurementTask Class Reference

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

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

Public Attributes
	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.

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 was created after `BaseMeasurementTask` already existed
to add a common base class for `SimpleForcedMeasurementTask`,
`SingleFrameMeasurementTask`, and `ForcedMeasurementTask` without
breaking downstream code. It is not intended to be used directly,
but rather to be subclassed by those tasks.

Definition at line 237 of file baseMeasurement.py.

Constructor & Destructor Documentation

__init__()

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

Definition at line 275 of file baseMeasurement.py.

Member Function Documentation

addInvalidPsfFlag()

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

Definition at line 326 of file baseMeasurement.py.

callMeasure()

lsst.meas.base.baseMeasurement.SimpleBaseMeasurementTask.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 337 of file baseMeasurement.py.

doMeasurement()

lsst.meas.base.baseMeasurement.SimpleBaseMeasurementTask.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 381 of file baseMeasurement.py.

initializePlugins()

lsst.meas.base.baseMeasurement.SimpleBaseMeasurementTask.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 in lsst.meas.base.baseMeasurement.BaseMeasurementTask.

Definition at line 282 of file baseMeasurement.py.

Member Data Documentation

_DefaultName

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

staticprotected

Definition at line 259 of file baseMeasurement.py.

algMetadata

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

static

Definition at line 268 of file baseMeasurement.py.

ConfigClass

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

static

Definition at line 258 of file baseMeasurement.py.

keyInvalidPsf

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

Definition at line 329 of file baseMeasurement.py.

plugins

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

static

Definition at line 261 of file baseMeasurement.py.

---

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

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