lsst.meas.base.diaCalculationPlugins.SigmaDiaTotFlux Class Reference

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

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

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

Detailed Description

Compute scatter of diaSource fluxes.

Definition at line 1076 of file diaCalculationPlugins.py.

Member Function Documentation

calculate()

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

Compute the sigma fluxes of the point source flux measured on the
calibrated image.

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

                  **kwargs):
        """Compute the sigma fluxes of the point source flux measured on the
        calibrated image.
 
        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.
        """
        # Set "delta degrees of freedom (ddf)" to 1 to calculate the unbiased
        # estimator of scatter (i.e. 'N - 1' instead of 'N').
        diaObjects.loc[:, "{}_scienceFluxSigma".format(band)] = \
            filterDiaSources.scienceFlux.std()

getExecutionOrder()

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

    def getExecutionOrder(cls):
        return cls.DEFAULT_CATALOGCALCULATION
 

Member Data Documentation

ConfigClass

lsst.meas.base.diaCalculationPlugins.SigmaDiaTotFlux.ConfigClass = SigmaDiaPsfFluxConfig

static

Definition at line 1080 of file diaCalculationPlugins.py.

needsFilter

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

static

Definition at line 1084 of file diaCalculationPlugins.py.

outputCols

list lsst.meas.base.diaCalculationPlugins.SigmaDiaTotFlux.outputCols = ["scienceFluxSigma"]

static

Definition at line 1082 of file diaCalculationPlugins.py.

plugType

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

static

Definition at line 1083 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+8d59551888/python/lsst/meas/base/diaCalculationPlugins.py