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

Public Member Functions
	getExecutionOrder (cls)
	calculate (self, diaObjects, diaSources, filterDiaSources, band, **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

Protected Member Functions
	_stetson_J (self, fluxes, errors, mean=None)
	_stetson_mean (self, values, errors, mean=None, alpha=2., beta=2., n_iter=20, tol=1e-6)

Detailed Description

Compute the StetsonJ statistic on the DIA point source fluxes.

Definition at line 1465 of file diaCalculationPlugins.py.

Member Function Documentation

◆ _stetson_J()

lsst.meas.base.diaCalculationPlugins.StetsonJDiaPsfFlux._stetson_J	(	self,
		fluxes,
		errors,
		mean = None )

protected

Compute the single band stetsonJ statistic.

Parameters
----------
fluxes : `numpy.ndarray` (N,)
    Calibrated lightcurve flux values.
errors : `numpy.ndarray` (N,)
    Errors on the calibrated lightcurve fluxes.
mean : `float`
    Starting mean from previous plugin.

Returns
-------
stetsonJ : `float`
    stetsonJ statistic for the input fluxes and errors.

References
----------
.. [1] Stetson, P. B., "On the Automatic Determination of Light-Curve
   Parameters for Cepheid Variables", PASP, 108, 851S, 1996

Definition at line 1527 of file diaCalculationPlugins.py.

◆ _stetson_mean()

lsst.meas.base.diaCalculationPlugins.StetsonJDiaPsfFlux._stetson_mean	(	self,
		values,
		errors,
		mean = None,
		alpha = 2.,
		beta = 2.,
		n_iter = 20,
		tol = 1e-6 )

protected

Compute the stetson mean of the fluxes which down-weights outliers.

Weighted biased on an error weighted difference scaled by a constant
(1/``a``) and raised to the power beta. Higher betas more harshly
penalize outliers and ``a`` sets the number of sigma where a weighted
difference of 1 occurs.

Parameters
----------
values : `numpy.dnarray`, (N,)
    Input values to compute the mean of.
errors : `numpy.ndarray`, (N,)
    Errors on the input values.
mean : `float`
    Starting mean value or None.
alpha : `float`
    Scalar down-weighting of the fractional difference. lower->more
    clipping. (Default value is 2.)
beta : `float`
    Power law slope of the used to down-weight outliers. higher->more
    clipping. (Default value is 2.)
n_iter : `int`
    Number of iterations of clipping.
tol : `float`
    Fractional and absolute tolerance goal on the change in the mean
    before exiting early. (Default value is 1e-6)

Returns
-------
mean : `float`
    Weighted stetson mean result.

References
----------
.. [1] Stetson, P. B., "On the Automatic Determination of Light-Curve
   Parameters for Cepheid Variables", PASP, 108, 851S, 1996

Definition at line 1557 of file diaCalculationPlugins.py.

◆ calculate()

lsst.meas.base.diaCalculationPlugins.StetsonJDiaPsfFlux.calculate	(		self,
			diaObjects,
			diaSources,
			filterDiaSources,
			band,
		**	kwargs )

Compute the StetsonJ statistic on the DIA point source fluxes.

Parameters
----------
diaObject : `dict`
    Summary object to store values in.
diaSources : `pandas.DataFrame`
    DataFrame representing all diaSources associated with this
    diaObject.
filterDiaSources : `pandas.DataFrame`
    DataFrame representing diaSources associated with this
    diaObject that are observed in the band pass ``band``.
band : `str`
    Simple, string 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.diaCalculation.DiaObjectCalculationPlugin.

Definition at line 1482 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.StetsonJDiaPsfFlux.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 1479 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

Protected Member Functions

Detailed Description

Member Function Documentation

◆ _stetson_J()

◆ _stetson_mean()

◆ 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