lsst.meas.base.diaCalculationPlugins.MinMaxDiaPsfFlux Class Reference

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

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

Static Public Attributes
	ConfigClass = MinMaxDiaPsfFluxConfig
list	outputCols = ["psfFluxMin", "psfFluxMax"]
str	plugType = "multi"
bool	needsFilter = True

Detailed Description

Compute min/max of diaSource fluxes.

Definition at line 619 of file diaCalculationPlugins.py.

Member Function Documentation

calculate()

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

Compute min/max 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 ``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 635 of file diaCalculationPlugins.py.

                  **kwargs):
        """Compute min/max 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 ``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.
        """
        minName = "{}_psfFluxMin".format(band)
        if minName not in diaObjects.columns:
            diaObjects[minName] = np.nan
        maxName = "{}_psfFluxMax".format(band)
        if maxName not in diaObjects.columns:
            diaObjects[maxName] = np.nan
 
        diaObjects.loc[:, minName] = filterDiaSources.psfFlux.min()
        diaObjects.loc[:, maxName] = filterDiaSources.psfFlux.max()
 
 

getExecutionOrder()

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

    def getExecutionOrder(cls):
        return cls.DEFAULT_CATALOGCALCULATION
 

Member Data Documentation

ConfigClass

lsst.meas.base.diaCalculationPlugins.MinMaxDiaPsfFlux.ConfigClass = MinMaxDiaPsfFluxConfig

static

Definition at line 623 of file diaCalculationPlugins.py.

needsFilter

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

static

Definition at line 629 of file diaCalculationPlugins.py.

outputCols

list lsst.meas.base.diaCalculationPlugins.MinMaxDiaPsfFlux.outputCols = ["psfFluxMin", "psfFluxMax"]

static

Definition at line 627 of file diaCalculationPlugins.py.

plugType

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

static

Definition at line 628 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/g212a7c68fe+04a9158687/python/lsst/meas/base/diaCalculationPlugins.py