lsst.meas.base.diaCalculationPlugins.StetsonJDiaPsFlux Class Reference

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

Public Member Functions
def	getExecutionOrder (cls)
def	calculate (self, diaObjects, diaSources, filterDiaSources, filterName, **kwargs)

Static Public Attributes
	ConfigClass = LinearFitDiaPsFluxConfig
list	inputCols = ["PSFluxMean"]
list	outputCols = ["PSFluxStetsonJ"]
string	plugType = "multi"
bool	needsFilter = True

Detailed Description

Compute the StetsonJ statistic on the DIA point source fluxes.

Definition at line 851 of file diaCalculationPlugins.py.

Member Function Documentation

calculate()

def lsst.meas.base.diaCalculationPlugins.StetsonJDiaPsFlux.calculate	(		self,
			diaObjects,
			diaSources,
			filterDiaSources,
			filterName,
		**	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 ``filterName``.
filterName : `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.

                  **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 ``filterName``.
        filterName : `str`
            Simple, string name of the filter for the flux being calculated.
        **kwargs
            Any additional keyword arguments that may be passed to the plugin.
        """
        meanName = "{}PSFluxMean".format(filterName)
 
        def _stetsonJ(df):
            tmpDf = df[~np.logical_or(np.isnan(df["psFlux"]),
                                      np.isnan(df["psFluxErr"]))]
            if len(tmpDf) < 2:
                return np.nan
            fluxes = tmpDf["psFlux"].to_numpy()
            errors = tmpDf["psFluxErr"].to_numpy()
 
            return self._stetson_J(
                fluxes,
                errors,
                diaObjects.at[tmpDf.diaObjectId.iat[0], meanName])
 
        diaObjects.loc[:, "{}PSFluxStetsonJ".format(filterName)] = \
            filterDiaSources.apply(_stetsonJ)
 

getExecutionOrder()

def lsst.meas.base.diaCalculationPlugins.StetsonJDiaPsFlux.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.

    def getExecutionOrder(cls):
        return cls.FLUX_MOMENTS_CALCULATED
 

Member Data Documentation

ConfigClass

lsst.meas.base.diaCalculationPlugins.StetsonJDiaPsFlux.ConfigClass = LinearFitDiaPsFluxConfig

static

Definition at line 855 of file diaCalculationPlugins.py.

inputCols

list lsst.meas.base.diaCalculationPlugins.StetsonJDiaPsFlux.inputCols = ["PSFluxMean"]

static

Definition at line 858 of file diaCalculationPlugins.py.

needsFilter

bool lsst.meas.base.diaCalculationPlugins.StetsonJDiaPsFlux.needsFilter = True

static

Definition at line 862 of file diaCalculationPlugins.py.

outputCols

list lsst.meas.base.diaCalculationPlugins.StetsonJDiaPsFlux.outputCols = ["PSFluxStetsonJ"]

static

Definition at line 860 of file diaCalculationPlugins.py.

plugType

string lsst.meas.base.diaCalculationPlugins.StetsonJDiaPsFlux.plugType = "multi"

static

Definition at line 861 of file diaCalculationPlugins.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-5.0.1/Linux64/meas_base/gd59336e7c4+c7bb92e648/python/lsst/meas/base/diaCalculationPlugins.py