lsst.meas.base  16.0-8-g2ce35ff
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.meas.base.catalogCalculation.CatalogCalculationTask Class Reference
Inheritance diagram for lsst.meas.base.catalogCalculation.CatalogCalculationTask:

Public Member Functions

def __init__ (self, schema, plugMetadata=None, kwargs)
 
def initializePlugins (self)
 
def run (self, measCat)
 
def callCompute (self, catalog)
 

Public Attributes

 schema
 
 plugMetadata
 
 plugins
 
 executionDict
 

Static Public Attributes

 ConfigClass = CatalogCalculationConfig
 

Detailed Description

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.

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

Definition at line 116 of file catalogCalculation.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.meas.base.catalogCalculation.CatalogCalculationTask.__init__ (   self,
  schema,
  plugMetadata = None,
  kwargs 
)
Constructor; only called by derived classes

@param[in] plugMetaData     An lsst.daf.base.PropertyList that will be filled with metadata
                    about the plugins being run. If None, an empty empty PropertyList
                    will be created.
@param[in] **kwargs         Additional arguments passed to lsst.pipe.base.Task.__init__.

Definition at line 126 of file catalogCalculation.py.

Member Function Documentation

◆ callCompute()

def lsst.meas.base.catalogCalculation.CatalogCalculationTask.callCompute (   self,
  catalog 
)
Run each of the plugins on the catalog
@param[in] catalog  The catalog on which the plugins will operate

Definition at line 179 of file catalogCalculation.py.

◆ initializePlugins()

def lsst.meas.base.catalogCalculation.CatalogCalculationTask.initializePlugins (   self)
Initialize the plugins according to the configuration.

Definition at line 144 of file catalogCalculation.py.

◆ run()

def lsst.meas.base.catalogCalculation.CatalogCalculationTask.run (   self,
  measCat 
)
The entry point for the catalogCalculation task. This method should be called with a reference to a
measurement catalog.

Definition at line 172 of file catalogCalculation.py.

Member Data Documentation

◆ ConfigClass

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

Definition at line 123 of file catalogCalculation.py.

◆ executionDict

lsst.meas.base.catalogCalculation.CatalogCalculationTask.executionDict

Definition at line 150 of file catalogCalculation.py.

◆ plugins

lsst.meas.base.catalogCalculation.CatalogCalculationTask.plugins

Definition at line 140 of file catalogCalculation.py.

◆ plugMetadata

lsst.meas.base.catalogCalculation.CatalogCalculationTask.plugMetadata

Definition at line 139 of file catalogCalculation.py.

◆ schema

lsst.meas.base.catalogCalculation.CatalogCalculationTask.schema

Definition at line 136 of file catalogCalculation.py.


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