lsst.meas.base  14.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Macros Groups Pages
Public Member Functions | Static Public Attributes | List of all members
lsst.meas.base.catalogCalculation.CatalogCalculationPlugin Class Reference
Inheritance diagram for lsst.meas.base.catalogCalculation.CatalogCalculationPlugin:

Public Member Functions

def __init__
 Initialize the catalogCalculation plugin. More...
 
def getExecutionOrder
 
def calculate
 Process either a single catalog enter or the whole catalog and produce output defined by the plugin. More...
 

Static Public Attributes

tuple registry = PluginRegistry(CatalogCalculationPluginConfig)
 
 ConfigClass = CatalogCalculationPluginConfig
 
string plugType = 'single'
 

Detailed Description

Base class for after CatalogCalculation plugin

Definition at line 27 of file catalogCalculation.py.

Constructor & Destructor Documentation

def lsst.meas.base.catalogCalculation.CatalogCalculationPlugin.__init__ (   self,
  config,
  name,
  schema,
  metadata 
)

Initialize the catalogCalculation plugin.

Parameters
[in]configAn instance of catalogCalculation config class.
[in]nameThe string the plugin was registered with.
[in,out]schemaThe source schema, New fields should be added here to hold output produced by this plugin.
[in]metadataPlugin metadata that will be attached to the output catalog

Definition at line 40 of file catalogCalculation.py.

Member Function Documentation

def lsst.meas.base.catalogCalculation.CatalogCalculationPlugin.calculate (   self,
  cat,
  kwargs 
)

Process either a single catalog enter or the whole catalog and produce output defined by the plugin.

Parameters
[in,out]catEither a lsst source catalog or a catalog entery depending on the plug type specified in the classes configuration. Results may be added to new columns, or existing entries altered.
[in]kwargsAny additional kwargs that may be passed through the CatalogCalculationPlugin.

Definition at line 62 of file catalogCalculation.py.

def lsst.meas.base.catalogCalculation.CatalogCalculationPlugin.getExecutionOrder (   cls)
Sets the relative order of plugins (smaller numbers run first).

CatalogCalculation plugins must run with BasePlugin.DEFAULT_CATALOGCALCULATION or higher

All plugins must implement this method with an appropriate run level

Definition at line 53 of file catalogCalculation.py.

Member Data Documentation

lsst.meas.base.catalogCalculation.CatalogCalculationPlugin.ConfigClass = CatalogCalculationPluginConfig
static

Definition at line 32 of file catalogCalculation.py.

string lsst.meas.base.catalogCalculation.CatalogCalculationPlugin.plugType = 'single'
static

Definition at line 38 of file catalogCalculation.py.

tuple lsst.meas.base.catalogCalculation.CatalogCalculationPlugin.registry = PluginRegistry(CatalogCalculationPluginConfig)
static

Definition at line 31 of file catalogCalculation.py.


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