lsst.meas.base.diaCalculationPlugins.WeightedMeanDiaTotFlux Class Reference

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

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

Static Public Attributes
	ConfigClass = WeightedMeanDiaPsfFluxConfig
list	outputCols = ["scienceFluxMean", "scienceFluxMeanErr"]
str	plugType = "multi"
bool	needsFilter = True

Detailed Description

Compute the weighted mean and mean error on the point source fluxes
forced photometered at the DiaSource location in the calibrated image.

Additionally store number of usable data points.

Definition at line 1007 of file diaCalculationPlugins.py.

Member Function Documentation

calculate()

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

Compute the weighted mean and mean error of the point source flux.

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 1025 of file diaCalculationPlugins.py.

                  **kwargs):
        """Compute the weighted mean and mean error of the point source flux.
 
        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.
        """
        totMeanName = "{}_scienceFluxMean".format(band)
        if totMeanName not in diaObjects.columns:
            diaObjects[totMeanName] = np.nan
        totErrName = "{}_scienceFluxMeanErr".format(band)
        if totErrName not in diaObjects.columns:
            diaObjects[totErrName] = np.nan
 
        def _meanFlux(df):
            tmpDf = df[~np.logical_or(np.isnan(df["scienceFlux"]),
                                      np.isnan(df["scienceFluxErr"]))]
            tot_weight = np.nansum(1 / tmpDf["scienceFluxErr"] ** 2)
            fluxMean = np.nansum(tmpDf["scienceFlux"]
                                 / tmpDf["scienceFluxErr"] ** 2)
            fluxMean /= tot_weight
            fluxMeanErr = np.sqrt(1 / tot_weight)
 
            return pd.Series({totMeanName: fluxMean,
                              totErrName: fluxMeanErr})
 
        diaObjects.loc[:, [totMeanName, totErrName]] = \
            filterDiaSources.apply(_meanFlux)
 
 

getExecutionOrder()

lsst.meas.base.diaCalculationPlugins.WeightedMeanDiaTotFlux.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 1020 of file diaCalculationPlugins.py.

    def getExecutionOrder(cls):
        return cls.DEFAULT_CATALOGCALCULATION
 

Member Data Documentation

ConfigClass

lsst.meas.base.diaCalculationPlugins.WeightedMeanDiaTotFlux.ConfigClass = WeightedMeanDiaPsfFluxConfig

static

Definition at line 1014 of file diaCalculationPlugins.py.

needsFilter

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

static

Definition at line 1017 of file diaCalculationPlugins.py.

outputCols

list lsst.meas.base.diaCalculationPlugins.WeightedMeanDiaTotFlux.outputCols = ["scienceFluxMean", "scienceFluxMeanErr"]

static

Definition at line 1015 of file diaCalculationPlugins.py.

plugType

str lsst.meas.base.diaCalculationPlugins.WeightedMeanDiaTotFlux.plugType = "multi"

static

Definition at line 1016 of file diaCalculationPlugins.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/meas_base/gf18bd8381d+7268b93478/python/lsst/meas/base/diaCalculationPlugins.py