Inheritance diagram for lsst.meas.base.diaCalculation.DiaObjectCalculationPlugin:

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

def	calculate (self, diaObject, diaSources, filterDiaFluxes=None, filterName=None, **kwargs)

def	fail (self, diaObject, columns, error=None)

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 = DiaObjectCalculationPluginConfig

	registry = PluginRegistry(DiaObjectCalculationPluginConfig)

float	FLUX_MOMENTS_CALCULATED = 5.0

string	plugType = 'single'

list	inputCols = []

list	outputCols = []

bool	needsFilter = True

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 DIA catalog calculation plugins.

Task follows CatalogCalculationPlugin with modifications for use in AP.

Parameters
----------
config : `DiaObjectCalculationPlugin.ConfigClass`
    Plugin configuration.
name : `str`
    The string the plugin was registered with.
metadata : `lsst.daf.base.PropertySet`
    Plugin metadata that will be attached to the output catalog

Definition at line 48 of file diaCalculation.py.

Constructor & Destructor Documentation

◆ init()

def lsst.meas.base.diaCalculation.DiaObjectCalculationPlugin.__init__	(	self,
		config,
		name,
		metadata
	)

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

Reimplemented in lsst.meas.base.diaCalculationPlugins.HTMIndexDiaPosition.

Definition at line 105 of file diaCalculation.py.

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

Member Function Documentation

◆ calculate() [1/2]

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

inherited

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 97 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()
  
  

◆ calculate() [2/2]

def lsst.meas.base.diaCalculation.DiaObjectCalculationPlugin.calculate	(		self,
			diaObject,
			diaSources,
			filterDiaFluxes = `None`,
			filterName = `None`,
		**	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
----------
diaObject : `dict`
    Summary object to store values in.
diaSources : `pandas.DataFrame`
    DataFrame representing all diaSources associated with this
    diaObject.
filterDiaFluxes : `pandas.DataFrame`
    DataFrame representing diaSources associated with this
    diaObject that are observed in the band pass ``filterName``.
filterName : `str`
    Simple name of the filter for the flux being calculated.
**kwargs
    Any additional keyword arguments that may be passed to the plugin.

Definition at line 108 of file diaCalculation.py.

                   **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
         ----------
         diaObject : `dict`
             Summary object to store values in.
         diaSources : `pandas.DataFrame`
             DataFrame representing all diaSources associated with this
             diaObject.
         filterDiaFluxes : `pandas.DataFrame`
             DataFrame representing diaSources associated with this
             diaObject that are observed in the band pass ``filterName``.
         filterName : `str`
             Simple name of the filter for the flux being calculated.
         **kwargs
             Any additional keyword arguments that may be passed to the plugin.
         """
         raise NotImplementedError()
  

◆ fail() [1/2]

def lsst.meas.base.diaCalculation.DiaObjectCalculationPlugin.fail	(	self,
		diaObject,
		columns,
		error = `None`
	)

Set diaObject position values to nan.

Parameters
----------
diaObject : `dict`
    Summary object to store values in.
columns : `list` of `str`
    List of string names of columns to write a the failed value.
error : `BaseException` or `None`
    Error to pass. Kept for consistency with CatologCalculationPlugin.
    Unused.

Definition at line 140 of file diaCalculation.py.

     def fail(self, diaObject, columns, error=None):
         """Set diaObject position values to nan.
  
         Parameters
         ----------
         diaObject : `dict`
             Summary object to store values in.
         columns : `list` of `str`
             List of string names of columns to write a the failed value.
         error : `BaseException` or `None`
             Error to pass. Kept for consistency with CatologCalculationPlugin.
             Unused.
         """
         for colName in columns:
             diaObject[colName] = np.nan
  
  

◆ fail() [2/2]

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 )

inherited

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 82 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.diaCalculation.DiaObjectCalculationPlugin.ConfigClass = DiaObjectCalculationPluginConfig

static

Definition at line 63 of file diaCalculation.py.

◆ DEFAULT_CATALOGCALCULATION

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

staticinherited

Definition at line 108 of file pluginsBase.py.

◆ FLUX_MOMENTS_CALCULATED

float lsst.meas.base.diaCalculation.DiaObjectCalculationPlugin.FLUX_MOMENTS_CALCULATED = 5.0

static

Definition at line 69 of file diaCalculation.py.

◆ FLUX_ORDER

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

staticinherited

Definition at line 89 of file pluginsBase.py.

◆ inputCols

list lsst.meas.base.diaCalculation.DiaObjectCalculationPlugin.inputCols = []

static

Definition at line 82 of file diaCalculation.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.

◆ needsFilter

bool lsst.meas.base.diaCalculation.DiaObjectCalculationPlugin.needsFilter = True

static

Definition at line 98 of file diaCalculation.py.

◆ outputCols

list lsst.meas.base.diaCalculation.DiaObjectCalculationPlugin.outputCols = []

static

Definition at line 90 of file diaCalculation.py.

◆ plugType

string lsst.meas.base.diaCalculation.DiaObjectCalculationPlugin.plugType = 'single'

static

Definition at line 73 of file diaCalculation.py.

◆ registry

lsst.meas.base.diaCalculation.DiaObjectCalculationPlugin.registry = PluginRegistry(DiaObjectCalculationPluginConfig)

static

Definition at line 65 of file diaCalculation.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-19-g93a5c75+d23f2fb6d8/python/lsst/meas/base/diaCalculation.py

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ calculate() [1/2]

◆ calculate() [2/2]

◆ fail() [1/2]

◆ fail() [2/2]

◆ getExecutionOrder()

◆ getLogName()

◆ getTransformClass()

Member Data Documentation

◆ APCORR_ORDER

◆ CENTROID_ORDER

◆ config

◆ ConfigClass

◆ DEFAULT_CATALOGCALCULATION

◆ FLUX_MOMENTS_CALCULATED

◆ FLUX_ORDER

◆ inputCols

◆ logName

◆ name

◆ needsFilter

◆ outputCols

◆ plugType

◆ registry

◆ SHAPE_ORDER

◆ init()