lsst.meas.base.diaCalculationPlugins.ErrMeanDiaPsfFlux Class Reference

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

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

Static Public Attributes
	ConfigClass = ErrMeanDiaPsfFluxConfig
list	outputCols = ["psfFluxErrMean"]
str	plugType = "multi"
bool	needsFilter = True

Detailed Description

Compute the mean of the dia source errors.

Definition at line 734 of file diaCalculationPlugins.py.

Member Function Documentation

calculate()

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

Compute the mean of the dia source errors.

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

                  **kwargs):
        """Compute the mean of the dia source errors.
 
        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.
        """
        diaObjects.loc[:, "{}_psfFluxErrMean".format(band)] = \
            filterDiaSources.psfFluxErr.mean()
 
 

getExecutionOrder()

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

    def getExecutionOrder(cls):
        return cls.DEFAULT_CATALOGCALCULATION
 

Member Data Documentation

ConfigClass

lsst.meas.base.diaCalculationPlugins.ErrMeanDiaPsfFlux.ConfigClass = ErrMeanDiaPsfFluxConfig

static

Definition at line 738 of file diaCalculationPlugins.py.

needsFilter

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

static

Definition at line 744 of file diaCalculationPlugins.py.

outputCols

list lsst.meas.base.diaCalculationPlugins.ErrMeanDiaPsfFlux.outputCols = ["psfFluxErrMean"]

static

Definition at line 742 of file diaCalculationPlugins.py.

plugType

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

static

Definition at line 743 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/g48712c4677+3bf1020dcb/python/lsst/meas/base/diaCalculationPlugins.py