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)
	callMeasure (self, measRecord, *args, **kwds)
	doMeasurement (self, plugin, measRecord, *args, **kwds)
	callMeasureN (self, measCat, *args, **kwds)
	doMeasurementN (self, plugin, measCat, *args, **kwds)

Static Public Member Functions
	getFootprintsFromCatalog (catalog)

Public Attributes
	undeblendedPlugins
	keyInvalidPsf

Static Public Attributes
	ConfigClass = BaseMeasurementConfig
	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 for `SingleFrameMeasurementTask` and
`ForcedMeasurementTask` mostly exists to share code between the two, and
generally should not be used directly.

Definition at line 230 of file baseMeasurement.py.

Constructor & Destructor Documentation

__init__()

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

    def __init__(self, algMetadata=None, **kwds):
        super(BaseMeasurementTask, self).__init__(**kwds)
        self.plugins = PluginMap()
        self.undeblendedPlugins = PluginMap()
        if algMetadata is None:
            algMetadata = lsst.daf.base.PropertyList()
        self.algMetadata = algMetadata
 

Member Function Documentation

callMeasure()

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

    def 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.
        """
        beginOrder = kwds.pop("beginOrder", None)
        endOrder = kwds.pop("endOrder", None)
        for plugin in self.plugins.iter():
            if beginOrder is not None and plugin.getExecutionOrder() < beginOrder:
                continue
            if endOrder is not None and plugin.getExecutionOrder() >= endOrder:
                break
            self.doMeasurement(plugin, measRecord, *args, **kwds)
 

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

    def 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.
        """
        beginOrder = kwds.pop("beginOrder", None)
        endOrder = kwds.pop("endOrder", None)
        for plugin in self.plugins.iterN():
            if beginOrder is not None and plugin.getExecutionOrder() < beginOrder:
                continue
            if endOrder is not None and plugin.getExecutionOrder() >= endOrder:
                break
            self.doMeasurementN(plugin, measCat, *args, **kwds)
 

doMeasurement()

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

    def 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.
        """
        try:
            plugin.measure(measRecord, *args, **kwds)
        except FATAL_EXCEPTIONS:
            raise
        except MeasurementError as error:
            self.log.getChild(plugin.name).debug(
                "MeasurementError in %s.measure on record %s: %s",
                plugin.name, measRecord.getId(), error)
            plugin.fail(measRecord, error)
        except InvalidPsfError as error:
            self.log.getChild(plugin.name).debug(
                "InvalidPsfError in %s.measure on record %s: %s",
                plugin.name, measRecord.getId(), error)
            measRecord.set(self.keyInvalidPsf, True)
            plugin.fail(measRecord)
        except Exception as error:
            self.log.getChild(plugin.name).warning(
                "Exception in %s.measure on record %s: %s",
                plugin.name, measRecord.getId(), error)
            plugin.fail(measRecord)
 

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

    def 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.
        """
        try:
            plugin.measureN(measCat, *args, **kwds)
        except FATAL_EXCEPTIONS:
            raise
 
        except MeasurementError as error:
            self.log.getChild(plugin.name).debug(
                "MeasurementError in %s.measureN on records %s-%s: %s",
                plugin.name, measCat[0].getId(), measCat[-1].getId(), error)
            for measRecord in measCat:
                plugin.fail(measRecord, error)
        except InvalidPsfError as error:
            self.log.getChild(plugin.name).debug(
                "InvalidPsfError in %s.measureN on records %s-%s: %s",
                plugin.name, measCat[0].getId(), measCat[-1].getId(), error)
            for measRecord in measCat:
                measRecord.set(self.keyInvalidPsf, True)
                plugin.fail(measRecord, error)
        except Exception as error:
            self.log.getChild(plugin.name).warning(
                "Exception in %s.measureN on records %s-%s: %s",
                plugin.name, measCat[0].getId(), measCat[-1].getId(), error)
            for measRecord in measCat:
                plugin.fail(measRecord)
 

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

    def getFootprintsFromCatalog(catalog):
        """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.
        """
        return {measRecord.getId(): (measRecord.getParent(), measRecord.getFootprint())
                for measRecord in catalog}

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.

Definition at line 274 of file baseMeasurement.py.

    def 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.
        """
        # Make a place at the beginning for the centroid plugin to run first
        # (because it's an OrderedDict, adding an empty element in advance
        # means it will get run first when it's reassigned to the actual
        # Plugin).
        if self.config.slots.centroid is not None:
            self.plugins[self.config.slots.centroid] = None
        # Init the plugins, sorted by execution order.  At the same time add to
        # the schema
        for executionOrder, name, config, PluginClass in sorted(self.config.plugins.apply()):
            #   Pass logName to the plugin if the plugin is marked as using it
            #   The task will use this name to log plugin errors, regardless.
            if getattr(PluginClass, "hasLogName", False):
                self.plugins[name] = PluginClass(config, name, metadata=self.algMetadata,
                                                 logName=self.log.getChild(name).name, **kwds)
            else:
                self.plugins[name] = PluginClass(config, name, metadata=self.algMetadata, **kwds)
 
        # In rare circumstances (usually tests), the centroid slot not be
        # coming from an algorithm, which means we'll have added something we
        # don't want to the plugins map, and we should remove it.
        if self.config.slots.centroid is not None and self.plugins[self.config.slots.centroid] is None:
            del self.plugins[self.config.slots.centroid]
        # Initialize the plugins to run on the undeblended image
        for executionOrder, name, config, PluginClass in sorted(self.config.undeblended.apply()):
            undeblendedName = self.config.undeblendedPrefix + name
            if getattr(PluginClass, "hasLogName", False):
                self.undeblendedPlugins[name] = PluginClass(config, undeblendedName,
                                                            metadata=self.algMetadata,
                                                            logName=self.log.getChild(undeblendedName).name,
                                                            **kwds)
            else:
                self.undeblendedPlugins[name] = PluginClass(config, undeblendedName,
                                                            metadata=self.algMetadata, **kwds)
 
        if "schemaMapper" in kwds:
            schema = kwds["schemaMapper"].editOutputSchema()
        else:
            schema = kwds["schema"]
 
        invalidPsfName = "base_InvalidPsf_flag"
        if invalidPsfName in schema:
            self.keyInvalidPsf = schema.find(invalidPsfName).key
        else:
            self.keyInvalidPsf = schema.addField(
                invalidPsfName,
                type="Flag",
                doc="Invalid PSF at this location.",
            )
 

Member Data Documentation

_DefaultName

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

staticprotected

Definition at line 250 of file baseMeasurement.py.

algMetadata

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

static

Definition at line 259 of file baseMeasurement.py.

ConfigClass

lsst.meas.base.baseMeasurement.BaseMeasurementTask.ConfigClass = BaseMeasurementConfig

static

Definition at line 249 of file baseMeasurement.py.

keyInvalidPsf

lsst.meas.base.baseMeasurement.BaseMeasurementTask.keyInvalidPsf

Definition at line 336 of file baseMeasurement.py.

plugins

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

static

Definition at line 252 of file baseMeasurement.py.

undeblendedPlugins

lsst.meas.base.baseMeasurement.BaseMeasurementTask.undeblendedPlugins

Definition at line 269 of file baseMeasurement.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/meas_base/g9a9baf55bd+f1bd1a7c26/python/lsst/meas/base/baseMeasurement.py