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

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

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

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

Static Public Attributes
	ConfigClass = DiaObjectCalculationPluginConfig

	registry = PluginRegistry(DiaObjectCalculationPluginConfig)

float	FLUX_MOMENTS_CALCULATED = 5.0

str	plugType = 'single'

list	inputCols = []

list	outputCols = []

bool	needsFilter = True

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 49 of file diaCalculation.py.

Constructor & Destructor Documentation

◆ init()

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

Reimplemented from lsst.meas.base.catalogCalculation.CatalogCalculationPlugin.

Reimplemented in lsst.meas.base.diaCalculationPlugins.HTMIndexDiaPosition, and lsst.meas.base.diaCalculationPlugins.PercentileDiaPsfFlux.

Definition at line 106 of file diaCalculation.py.

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

Member Function Documentation

◆ calculate()

lsst.meas.base.diaCalculation.DiaObjectCalculationPlugin.calculate	(		self,
			diaObject,
			diaSources,
			filterDiaFluxes = None,
			band = 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 ``band``.
band : `str`
    Simple name of the filter for the flux being calculated.
**kwargs
    Any additional keyword arguments that may be passed to the plugin.

Reimplemented from lsst.meas.base.catalogCalculation.CatalogCalculationPlugin.

Definition at line 109 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 ``band``.
        band : `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()

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.

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

Definition at line 141 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
 
 

Member Data Documentation

◆ ConfigClass

lsst.meas.base.diaCalculation.DiaObjectCalculationPlugin.ConfigClass = DiaObjectCalculationPluginConfig

static

Definition at line 64 of file diaCalculation.py.

◆ FLUX_MOMENTS_CALCULATED

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

static

Definition at line 70 of file diaCalculation.py.

◆ inputCols

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

static

Definition at line 83 of file diaCalculation.py.

◆ needsFilter

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

static

Definition at line 99 of file diaCalculation.py.

◆ outputCols

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

static

Definition at line 91 of file diaCalculation.py.

◆ plugType

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

static

Definition at line 74 of file diaCalculation.py.

◆ registry

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

static

Definition at line 66 of file diaCalculation.py.

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

/j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/meas_base/gf18bd8381d+7268b93478/python/lsst/meas/base/diaCalculation.py

Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ calculate()

◆ fail()

Member Data Documentation

◆ ConfigClass

◆ FLUX_MOMENTS_CALCULATED

◆ inputCols

◆ needsFilter

◆ outputCols

◆ plugType

◆ registry

◆ init()