lsst.meas.base.diaCalculationPlugins.Chi2DiaPsFlux Class Reference

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

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

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

Detailed Description

Compute chi2 of diaSource fluxes.

Definition at line 464 of file diaCalculationPlugins.py.

Member Function Documentation

calculate()

def lsst.meas.base.diaCalculationPlugins.Chi2DiaPsFlux.calculate	(		self,
			diaObjects,
			diaSources,
			filterDiaSources,
			filterName,
		**	kwargs
	)

Compute the chi2 of the 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 482 of file diaCalculationPlugins.py.

                  **kwargs):
        """Compute the chi2 of the 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 _chi2(df):
            delta = (df["psFlux"]
                     - diaObjects.at[df.diaObjectId.iat[0], meanName])
            return np.nansum((delta / df["psFluxErr"]) ** 2)
 
        diaObjects.loc[:, "{}PSFluxChi2".format(filterName)] = \
            filterDiaSources.apply(_chi2)
 
 

getExecutionOrder()

def lsst.meas.base.diaCalculationPlugins.Chi2DiaPsFlux.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 478 of file diaCalculationPlugins.py.

    def getExecutionOrder(cls):
        return cls.FLUX_MOMENTS_CALCULATED
 

Member Data Documentation

ConfigClass

lsst.meas.base.diaCalculationPlugins.Chi2DiaPsFlux.ConfigClass = Chi2DiaPsFluxConfig

static

Definition at line 468 of file diaCalculationPlugins.py.

inputCols

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

static

Definition at line 471 of file diaCalculationPlugins.py.

needsFilter

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

static

Definition at line 475 of file diaCalculationPlugins.py.

outputCols

list lsst.meas.base.diaCalculationPlugins.Chi2DiaPsFlux.outputCols = ["PSFluxChi2"]

static

Definition at line 473 of file diaCalculationPlugins.py.

plugType

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

static

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