Inheritance diagram for lsst.meas.base.diaCalculationPlugins.MeanDiaPosition:

Public Member Functions
	getExecutionOrder (cls)
	calculate (self, diaObjects, diaSources, **kwargs)
	fail (self, diaObject, columns, error=None)
	getLogName (self)

Static Public Member Functions
	getTransformClass ()

Public Attributes
	config = config
	name = name
	logName = logName

Static Public Attributes
float	FLUX_MOMENTS_CALCULATED = 5.0
list	inputCols = []
list	outputCols = []
bool	needsFilter = True
	registry = PluginRegistry(CatalogCalculationPluginConfig)
str	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
	ConfigClass = BasePluginConfig

Detailed Description

Compute the mean position and position uncertainty of a DiaObject
from its associated DiaSources.

The reported (ra, dec) is the inverse-variance weighted spherical
mean of the per-source positions, using only the DiaSources whose
per-source coordinate errors are finite.  The reported covariance
is the covariance of that weighted-mean estimator,

    C_formal = (sum_i inv(C_i))^-1,

where ``C_i`` is the per-source 2x2 covariance, multiplied by a
*chi-squared scale factor* that inflates the result when the
empirical scatter is larger than the per-source errors predict:

    chi2  = sum_i r_i^T inv(C_i) r_i      (r_i = tangent-plane
                                           residual from the mean)
    dof   = 2 * (N - 1)
    C_obj = max(1, chi2 / dof) * C_formal

When the data agree with the per-source errors (chi2 ~ dof) the
scale factor is unity and ``C_obj == C_formal``.  When the residuals
exceed what the errors predict, the covariance is inflated.

Definition at line 517 of file diaCalculationPlugins.py.

Member Function Documentation

◆ calculate()

lsst.meas.base.diaCalculationPlugins.MeanDiaPosition.calculate	(		self,
			diaObjects,
			diaSources,
		**	kwargs )

Compute the mean ra/dec position and its uncertainty for each
DiaObject.

Parameters
----------
diaObjects : `pandas.DataFrame`
    Summary objects to store values in.
diaSources : `pandas.DataFrame` or `pandas.DataFrameGroupBy`
    Catalog of DiaSources summarized by this DiaObject.
**kwargs
    Any additional keyword arguments that may be passed to the plugin.

Reimplemented from lsst.meas.base.diaCalculation.DiaObjectCalculationPlugin.

Definition at line 553 of file diaCalculationPlugins.py.

◆ fail()

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

inherited

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.

◆ getExecutionOrder()

lsst.meas.base.diaCalculationPlugins.MeanDiaPosition.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.catalogCalculation.CatalogCalculationPlugin.

Definition at line 550 of file diaCalculationPlugins.py.

◆ getLogName()

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

inherited

Definition at line 134 of file pluginsBase.py.

◆ getTransformClass()

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.

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

inherited

Definition at line 130 of file pluginsBase.py.

◆ ConfigClass

lsst.meas.base.pluginsBase.BasePlugin.ConfigClass = BasePluginConfig

staticinherited

Definition at line 116 of file pluginsBase.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

staticinherited

Definition at line 70 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 = []

staticinherited

Definition at line 83 of file diaCalculation.py.

◆ logName

lsst.meas.base.pluginsBase.BasePlugin.logName = logName

inherited

Definition at line 132 of file pluginsBase.py.

◆ name

lsst.meas.base.pluginsBase.BasePlugin.name = name

inherited

Definition at line 131 of file pluginsBase.py.

◆ needsFilter

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

staticinherited

Definition at line 99 of file diaCalculation.py.

◆ outputCols

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

staticinherited

Definition at line 91 of file diaCalculation.py.

◆ plugType

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

staticinherited

Definition at line 69 of file catalogCalculation.py.

◆ registry

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

staticinherited

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:

python/lsst/meas/base/diaCalculationPlugins.py

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Member Function Documentation

◆ calculate()

◆ fail()

◆ 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