lsst.meas.base g876c692160+1d7ac31cb0
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
lsst.meas.base.diaCalculationPlugins.StetsonJDiaPsfFlux Class Reference
Inheritance diagram for lsst.meas.base.diaCalculationPlugins.StetsonJDiaPsfFlux:
lsst.meas.base.diaCalculation.DiaObjectCalculationPlugin lsst.meas.base.catalogCalculation.CatalogCalculationPlugin lsst.meas.base.pluginsBase.BasePlugin

Public Member Functions

 getExecutionOrder (cls)
 
 calculate (self, diaObjects, diaSources, filterDiaSources, band, **kwargs)
 

Static Public Attributes

 ConfigClass = LinearFitDiaPsfFluxConfig
 
list inputCols = ["psfFluxMean"]
 
list outputCols = ["psfFluxStetsonJ"]
 
str plugType = "multi"
 
bool needsFilter = True
 

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 851 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 909 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 939 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 868 of file diaCalculationPlugins.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 865 of file diaCalculationPlugins.py.

Member Data Documentation

◆ ConfigClass

lsst.meas.base.diaCalculationPlugins.StetsonJDiaPsfFlux.ConfigClass = LinearFitDiaPsfFluxConfig
static

Definition at line 855 of file diaCalculationPlugins.py.

◆ inputCols

list lsst.meas.base.diaCalculationPlugins.StetsonJDiaPsfFlux.inputCols = ["psfFluxMean"]
static

Definition at line 858 of file diaCalculationPlugins.py.

◆ needsFilter

bool lsst.meas.base.diaCalculationPlugins.StetsonJDiaPsfFlux.needsFilter = True
static

Definition at line 862 of file diaCalculationPlugins.py.

◆ outputCols

list lsst.meas.base.diaCalculationPlugins.StetsonJDiaPsfFlux.outputCols = ["psfFluxStetsonJ"]
static

Definition at line 860 of file diaCalculationPlugins.py.

◆ plugType

str lsst.meas.base.diaCalculationPlugins.StetsonJDiaPsfFlux.plugType = "multi"
static

Definition at line 861 of file diaCalculationPlugins.py.


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