lsst.meas.base.catalogCalculation.CatalogCalculationTask Class Reference

Inheritance diagram for lsst.meas.base.catalogCalculation.CatalogCalculationTask:

Public Member Functions
	__init__ (self, schema, plugMetadata=None, **kwargs)
	initializePlugins (self)
	run (self, measCat)
	callCompute (self, catalog)

Public Attributes
	schema
	plugMetadata
	plugins
	executionDict
	log

Static Public Attributes
	ConfigClass = CatalogCalculationConfig

Static Protected Attributes
str	_DefaultName = "catalogCalculation"

Detailed Description

Run plugins which operate on a catalog of sources.

This task facilitates running plugins which will operate on a source
catalog. These plugins may do things such as classifying an object based
on source record entries inserted during a measurement task.

Parameters
----------
plugMetaData : `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.
**kwargs
    Additional arguments passed to the superclass constructor.

Notes
-----
Plugins may either take an entire catalog to work on at a time, or work on
individual records.

Definition at line 170 of file catalogCalculation.py.

Constructor & Destructor Documentation

__init__()

lsst.meas.base.catalogCalculation.CatalogCalculationTask.__init__	(		self,
			schema,
			plugMetadata = None,
		**	kwargs )

Reimplemented in lsst.meas.base.diaCalculation.DiaObjectCalculationTask.

Definition at line 194 of file catalogCalculation.py.

    def __init__(self, schema, plugMetadata=None, **kwargs):
        lsst.pipe.base.Task.__init__(self, **kwargs)
        self.schema = schema
        if plugMetadata is None:
            plugMetadata = lsst.daf.base.PropertyList()
        self.plugMetadata = plugMetadata
        self.plugins = PluginMap()
 
        self.initializePlugins()
 

Member Function Documentation

callCompute()

lsst.meas.base.catalogCalculation.CatalogCalculationTask.callCompute	(		self,
			catalog )

Run each of the plugins on the catalog.

Parameters
----------
catalog : `lsst.afw.table.SourceCatalog`
    The catalog on which the plugins will operate.

Reimplemented in lsst.meas.base.diaCalculation.DiaObjectCalculationTask.

Definition at line 241 of file catalogCalculation.py.

    def callCompute(self, catalog):
        """Run each of the plugins on the catalog.
 
        Parameters
        ----------
        catalog : `lsst.afw.table.SourceCatalog`
            The catalog on which the plugins will operate.
        """
        for runlevel in sorted(self.executionDict):
            # Run all of the plugins which take a whole catalog first
            for plug in self.executionDict[runlevel].multi:
                with CCContext(plug, catalog, self.log):
                    plug.calculate(catalog)
            # Run all the plugins which take single catalog entries
            for measRecord in catalog:
                for plug in self.executionDict[runlevel].single:
                    with CCContext(plug, measRecord, self.log):
                        plug.calculate(measRecord)

initializePlugins()

lsst.meas.base.catalogCalculation.CatalogCalculationTask.initializePlugins

(

self

)

Initialize the plugins according to the configuration.

Reimplemented in lsst.meas.base.diaCalculation.DiaObjectCalculationTask.

Definition at line 204 of file catalogCalculation.py.

    def initializePlugins(self):
        """Initialize the plugins according to the configuration.
        """
 
        pluginType = namedtuple('pluginType', 'single multi')
        self.executionDict = {}
        # Read the properties for each plugin. Allocate a dictionary entry for each run level. Verify that
        # the plugins are above the minimum run level for an catalogCalculation plugin. For each run level,
        # the plugins are sorted into either single record, or multi record groups to later be run
        # appropriately
        for executionOrder, name, config, PluginClass in sorted(self.config.plugins.apply()):
            if executionOrder not in self.executionDict:
                self.executionDict[executionOrder] = pluginType(single=[], multi=[])
            if PluginClass.getExecutionOrder() >= BasePlugin.DEFAULT_CATALOGCALCULATION:
                plug = PluginClass(config, name, self.schema, metadata=self.plugMetadata)
                self.plugins[name] = plug
                if plug.plugType == 'single':
                    self.executionDict[executionOrder].single.append(plug)
                elif plug.plugType == 'multi':
                    self.executionDict[executionOrder].multi.append(plug)
            else:
                errorTuple = (PluginClass, PluginClass.getExecutionOrder(),
                              BasePlugin.DEFAULT_CATALOGCALCULATION)
                raise ValueError("{} has an execution order less than the minimum for an catalogCalculation "
                                 "plugin. Value {} : Minimum {}".format(*errorTuple))
 

run()

lsst.meas.base.catalogCalculation.CatalogCalculationTask.run	(		self,
			measCat )

The entry point for the catalog calculation task.

Parameters
----------
meascat : `lsst.afw.table.SourceCatalog`
    Catalog for measurement.

Reimplemented in lsst.meas.base.diaCalculation.DiaObjectCalculationTask.

Definition at line 231 of file catalogCalculation.py.

    def run(self, measCat):
        """The entry point for the catalog calculation task.
 
        Parameters
        ----------
        meascat : `lsst.afw.table.SourceCatalog`
            Catalog for measurement.
        """
        self.callCompute(measCat)
 

Member Data Documentation

_DefaultName

str lsst.meas.base.catalogCalculation.CatalogCalculationTask._DefaultName = "catalogCalculation"

staticprotected

Definition at line 192 of file catalogCalculation.py.

ConfigClass

lsst.meas.base.catalogCalculation.CatalogCalculationTask.ConfigClass = CatalogCalculationConfig

static

Definition at line 191 of file catalogCalculation.py.

executionDict

lsst.meas.base.catalogCalculation.CatalogCalculationTask.executionDict

Definition at line 209 of file catalogCalculation.py.

log

lsst.meas.base.catalogCalculation.CatalogCalculationTask.log

Definition at line 252 of file catalogCalculation.py.

plugins

lsst.meas.base.catalogCalculation.CatalogCalculationTask.plugins

Definition at line 200 of file catalogCalculation.py.

plugMetadata

lsst.meas.base.catalogCalculation.CatalogCalculationTask.plugMetadata

Definition at line 199 of file catalogCalculation.py.

schema

lsst.meas.base.catalogCalculation.CatalogCalculationTask.schema

Definition at line 196 of file catalogCalculation.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/meas_base/g48712c4677+3bf1020dcb/python/lsst/meas/base/catalogCalculation.py