lsst.meas.base  14.0-19-ga9fd870
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.meas.base.footprintArea.CatalogCalculationFootprintAreaPlugin Class Reference
Inheritance diagram for lsst.meas.base.footprintArea.CatalogCalculationFootprintAreaPlugin:
lsst.meas.base.catalogCalculation.CatalogCalculationPlugin lsst.meas.base.pluginsBase.BasePlugin

Public Member Functions

def getExecutionOrder (cls)
 
def __init__ (self, config, name, schema, metadata)
 
def calculate (self, measRecord)
 
def fail (self, measRecord, error=None)
 
def calculate (self, cat, kwargs)
 Process either a single catalog enter or the whole catalog and produce output defined by the plugin. More...
 
def getLogName (self)
 

Static Public Member Functions

def getTransformClass ()
 Get the measurement transformation appropriate to this plugin. More...
 

Public Attributes

 key
 
 config
 
 name
 
 logName
 

Static Public Attributes

 ConfigClass = CatalogCalculationFootprintAreaConfig
 
 registry = PluginRegistry(CatalogCalculationPluginConfig)
 
string plugType = 'single'
 
float CENTROID_ORDER = 0.0
 
float SHAPE_ORDER = 1.0
 
float FLUX_ORDER = 2.0
 
float APCORR_ORDER = 3.0
 
float DEFAULT_CATALOGCALCULATION = 4.0
 

Detailed Description

A catalog calcluation plugin  that simply records the area of the
source's detection Footprint.

Definition at line 41 of file footprintArea.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.meas.base.footprintArea.CatalogCalculationFootprintAreaPlugin.__init__ (   self,
  config,
  name,
  schema,
  metadata 
)

Definition at line 52 of file footprintArea.py.

Member Function Documentation

◆ calculate() [1/2]

def lsst.meas.base.footprintArea.CatalogCalculationFootprintAreaPlugin.calculate (   self,
  measRecord 
)

Definition at line 61 of file footprintArea.py.

◆ calculate() [2/2]

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

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.

◆ fail()

def lsst.meas.base.footprintArea.CatalogCalculationFootprintAreaPlugin.fail (   self,
  measRecord,
  error = None 
)

Definition at line 64 of file footprintArea.py.

◆ getExecutionOrder()

def lsst.meas.base.footprintArea.CatalogCalculationFootprintAreaPlugin.getExecutionOrder (   cls)

Definition at line 49 of file footprintArea.py.

◆ getLogName()

def lsst.meas.base.pluginsBase.BasePlugin.getLogName (   self)
inherited

Definition at line 92 of file pluginsBase.py.

◆ getTransformClass()

def lsst.meas.base.pluginsBase.BasePlugin.getTransformClass ( )
staticinherited

Get the measurement transformation appropriate to this plugin.

This returns a subclass of MeasurementTransform, which may be instantiated with details of the algorithm configuration and then called with information about calibration and WCS to convert from raw measurement quantities to calibrated units. Calibrated data is then provided in a separate output table.

By default, we copy everything from the input to the output without transformation.

Definition at line 117 of file pluginsBase.py.

Member Data Documentation

◆ APCORR_ORDER

float lsst.meas.base.pluginsBase.BasePlugin.APCORR_ORDER = 3.0
staticinherited

Definition at line 53 of file pluginsBase.py.

◆ CENTROID_ORDER

float lsst.meas.base.pluginsBase.BasePlugin.CENTROID_ORDER = 0.0
staticinherited

Definition at line 50 of file pluginsBase.py.

◆ config

lsst.meas.base.pluginsBase.BasePlugin.config
inherited

Definition at line 88 of file pluginsBase.py.

◆ ConfigClass

lsst.meas.base.footprintArea.CatalogCalculationFootprintAreaPlugin.ConfigClass = CatalogCalculationFootprintAreaConfig
static

Definition at line 46 of file footprintArea.py.

◆ DEFAULT_CATALOGCALCULATION

float lsst.meas.base.pluginsBase.BasePlugin.DEFAULT_CATALOGCALCULATION = 4.0
staticinherited

Definition at line 54 of file pluginsBase.py.

◆ FLUX_ORDER

float lsst.meas.base.pluginsBase.BasePlugin.FLUX_ORDER = 2.0
staticinherited

Definition at line 52 of file pluginsBase.py.

◆ key

lsst.meas.base.footprintArea.CatalogCalculationFootprintAreaPlugin.key

Definition at line 54 of file footprintArea.py.

◆ logName

lsst.meas.base.pluginsBase.BasePlugin.logName
inherited

Definition at line 90 of file pluginsBase.py.

◆ name

lsst.meas.base.pluginsBase.BasePlugin.name
inherited

Definition at line 89 of file pluginsBase.py.

◆ plugType

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

Definition at line 38 of file catalogCalculation.py.

◆ registry

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

Definition at line 31 of file catalogCalculation.py.

◆ SHAPE_ORDER

float lsst.meas.base.pluginsBase.BasePlugin.SHAPE_ORDER = 1.0
staticinherited

Definition at line 51 of file pluginsBase.py.


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