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

Public Member Functions
def	__init__ (self, config, name, schema, metadata)

def	getExecutionOrder (cls)

def	calculate (self, cat, **kwargs)

def	getLogName (self)

def	fail (self, measRecord, error=None)

Static Public Member Functions
def	getTransformClass ()

Public Attributes
	config

	name

	logName

Static Public Attributes
	ConfigClass = CatalogCalculationPluginConfig

	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

Base class for catalog calculation plugins.

Parameters
----------
config : `CatalogCalculationPlugin.ConfigClass`
    Plugin configuration.
name : `str`
    The string the plugin was registered with.
schema : `lsst.afw.table.Schema`
    The source schema, New fields should be added here to
    hold output produced by this plugin.
metadata : `lsst.daf.base.PropertySet`
    Plugin metadata that will be attached to the output catalog

Definition at line 47 of file catalogCalculation.py.

Constructor & Destructor Documentation

◆ init()

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

Reimplemented in lsst.meas.base.footprintArea.CatalogCalculationFootprintAreaPlugin, and lsst.meas.base.classification.CatalogCalculationClassificationPlugin.

Definition at line 79 of file catalogCalculation.py.

     def __init__(self, config, name, schema, metadata):
         BasePlugin.__init__(self, config, name)
  

Member Function Documentation

◆ calculate()

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

Perform the calculation specified by this plugin.

This method can either be used to operate on a single catalog record
or a whole catalog, populating it with the output defined by this
plugin.

Note that results may be added to catalog records as new columns, or
may result in changes to existing values.

Parameters
----------
cat : `lsst.afw.table.SourceCatalog` or `lsst.afw.table.SourceRecord`
    May either be a `~lsst.afw.table.SourceCatalog` or a single
    `~lsst.afw.table.SourceRecord`, depending on the plugin type. Will
    be updated in place to contain the results of plugin execution.
**kwargs
    Any additional keyword arguments that may be passed to the plugin.

Definition at line 98 of file catalogCalculation.py.

     def calculate(self, cat, **kwargs):
         """Perform the calculation specified by this plugin.
  
         This method can either be used to operate on a single catalog record
         or a whole catalog, populating it with the output defined by this
         plugin.
  
         Note that results may be added to catalog records as new columns, or
         may result in changes to existing values.
  
         Parameters
         ----------
         cat : `lsst.afw.table.SourceCatalog` or `lsst.afw.table.SourceRecord`
             May either be a `~lsst.afw.table.SourceCatalog` or a single
             `~lsst.afw.table.SourceRecord`, depending on the plugin type. Will
             be updated in place to contain the results of plugin execution.
         **kwargs
             Any additional keyword arguments that may be passed to the plugin.
         """
         raise NotImplementedError()
  
  

◆ fail()

def lsst.meas.base.pluginsBase.BasePlugin.fail	(	self,
		measRecord,
		error = `None`
	)

inherited

Record a failure of the `measure` or `measureN` method.

Parameters
----------
measRecord : `lsst.afw.table.SourceRecord`
    Table record describing the source being measured.
error : `MeasurementError`, optional
    Only provided if the measurement failed due to a
    `MeasurementError` being raised; otherwise, will be `None`.

Notes
-----
When the plugin raises an exception, framework will call
`BasePlugin.fail` to allow the plugin to set its failure flag
field(s).  When `BasePlugin.measureN` raises an exception,
`BasePlugin.fail` will be called repeatedly with all the records that
were being measured.

If the exception is an `MeasurementError`, it will be passed as the
error argument; in all other cases the error argument will be `None`,
and the failure will be logged by the measurement framework as a
warning.

Definition at line 137 of file pluginsBase.py.

     def fail(self, measRecord, error=None):
         """Record a failure of the `measure` or `measureN` method.
  
         Parameters
         ----------
         measRecord : `lsst.afw.table.SourceRecord`
             Table record describing the source being measured.
         error : `MeasurementError`, optional
             Only provided if the measurement failed due to a
             `MeasurementError` being raised; otherwise, will be `None`.
  
         Notes
         -----
         When the plugin raises an exception, framework will call
         `BasePlugin.fail` to allow the plugin to set its failure flag
         field(s).  When `BasePlugin.measureN` raises an exception,
         `BasePlugin.fail` will be called repeatedly with all the records that
         were being measured.
  
         If the exception is an `MeasurementError`, it will be passed as the
         error argument; in all other cases the error argument will be `None`,
         and the failure will be logged by the measurement framework as a
         warning.
  
         """
         traceback.print_exc()
         message = ("The algorithm '%s' thinks it cannot fail, but it did; "
                    "please report this as a bug (the full traceback is above)."
                    % (self.__class__.__name__,))
         raise NotImplementedError(message)
  

◆ getExecutionOrder()

def lsst.meas.base.catalogCalculation.CatalogCalculationPlugin.getExecutionOrder ( cls )

Used to set the relative order of plugin execution.

The values returned by `getExecutionOrder` are compared across all
plugins, and smaller numbers run first.

Notes
-----
`CatalogCalculationPlugin`\s must run with
`BasePlugin.DEFAULT_CATALOGCALCULATION` or higher.

All plugins must implement this method with an appropriate run level

Reimplemented from lsst.meas.base.pluginsBase.BasePlugin.

Definition at line 83 of file catalogCalculation.py.

     def getExecutionOrder(cls):
         r"""Used to set the relative order of plugin execution.
  
         The values returned by `getExecutionOrder` are compared across all
         plugins, and smaller numbers run first.
  
         Notes
         -----
         `CatalogCalculationPlugin`\s must run with
         `BasePlugin.DEFAULT_CATALOGCALCULATION` or higher.
  
         All plugins must implement this method with an appropriate run level
         """
         raise NotImplementedError()
  

◆ getLogName()

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

inherited

Definition at line 134 of file pluginsBase.py.

     def getLogName(self):
         return self.logName
  

◆ getTransformClass()

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

staticinherited

Get the measurement transformation appropriate to this plugin.

This returns a subclass of `transforms.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.

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

Reimplemented in lsst.meas.base.plugins.ForcedPeakCentroidPlugin, and lsst.meas.base.plugins.SingleFramePeakCentroidPlugin.

Definition at line 169 of file pluginsBase.py.

     def getTransformClass():
         """Get the measurement transformation appropriate to this plugin.
  
         This returns a subclass of `transforms.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.
  
         Notes
         -----
         By default, we copy everything from the input to the output without
         transformation.
         """
         return PassThroughTransform

Member Data Documentation

◆ APCORR_ORDER

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

staticinherited

Definition at line 98 of file pluginsBase.py.

◆ CENTROID_ORDER

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

staticinherited

Definition at line 72 of file pluginsBase.py.

◆ config

lsst.meas.base.pluginsBase.BasePlugin.config

inherited

Definition at line 130 of file pluginsBase.py.

◆ ConfigClass

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

static

Definition at line 63 of file catalogCalculation.py.

◆ DEFAULT_CATALOGCALCULATION

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

staticinherited

Definition at line 108 of file pluginsBase.py.

◆ FLUX_ORDER

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

staticinherited

Definition at line 89 of file pluginsBase.py.

◆ logName

lsst.meas.base.pluginsBase.BasePlugin.logName

inherited

Definition at line 132 of file pluginsBase.py.

◆ name

lsst.meas.base.pluginsBase.BasePlugin.name

inherited

Definition at line 131 of file pluginsBase.py.

◆ plugType

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

static

Definition at line 69 of file catalogCalculation.py.

◆ registry

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

static

Definition at line 65 of file catalogCalculation.py.

◆ SHAPE_ORDER

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

staticinherited

Definition at line 80 of file pluginsBase.py.

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

/j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/meas_base/22.0.1-25-gb120d7b+8b5510f75f/python/lsst/meas/base/catalogCalculation.py

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ calculate()

◆ fail()

◆ getExecutionOrder()

◆ getLogName()

◆ getTransformClass()

Member Data Documentation

◆ APCORR_ORDER

◆ CENTROID_ORDER

◆ config

◆ ConfigClass

◆ DEFAULT_CATALOGCALCULATION

◆ FLUX_ORDER

◆ logName

◆ name

◆ plugType

◆ registry

◆ SHAPE_ORDER

◆ init()