lsst.meas.base.diaCalculationPlugins.PercentileDiaPsFlux Class Reference

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

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

Public Attributes
	outputCols

Static Public Attributes
	ConfigClass = PercentileDiaPsFluxConfig
list	outputCols = []
string	plugType = "multi"
bool	needsFilter = True

Detailed Description

Compute percentiles of diaSource fluxes.

Definition at line 347 of file diaCalculationPlugins.py.

Constructor & Destructor Documentation

__init__()

def lsst.meas.base.diaCalculationPlugins.PercentileDiaPsFlux.__init__	(		self,
			config,
			name,
			metadata,
		**	kwargs
	)

Reimplemented from lsst.meas.base.diaCalculation.DiaObjectCalculationPlugin.

Definition at line 357 of file diaCalculationPlugins.py.

    def __init__(self, config, name, metadata, **kwargs):
        DiaObjectCalculationPlugin.__init__(self,
                                            config,
                                            name,
                                            metadata,
                                            **kwargs)
        self.outputCols = ["PSFluxPercentile{:02d}".format(percent)
                           for percent in self.config.percentiles]
 

Member Function Documentation

calculate()

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

Compute the percentile fluxes 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 ``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 371 of file diaCalculationPlugins.py.

                  **kwargs):
        """Compute the percentile fluxes 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 ``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.
        """
        pTileNames = []
        for tilePercent in self.config.percentiles:
            pTileName = "{}PSFluxPercentile{:02d}".format(filterName,
                                                          tilePercent)
            pTileNames.append(pTileName)
            if pTileName not in diaObjects.columns:
                diaObjects[pTileName] = np.nan
 
        def _fluxPercentiles(df):
            pTiles = np.nanpercentile(df["psFlux"], self.config.percentiles)
            return pd.Series(
                dict((tileName, pTile)
                     for tileName, pTile in zip(pTileNames, pTiles)))
 
        diaObjects.loc[:, pTileNames] = filterDiaSources.apply(_fluxPercentiles)
 
 

getExecutionOrder()

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

    def getExecutionOrder(cls):
        return cls.DEFAULT_CATALOGCALCULATION
 

Member Data Documentation

ConfigClass

lsst.meas.base.diaCalculationPlugins.PercentileDiaPsFlux.ConfigClass = PercentileDiaPsFluxConfig

static

Definition at line 351 of file diaCalculationPlugins.py.

needsFilter

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

static

Definition at line 355 of file diaCalculationPlugins.py.

outputCols [1/2]

list lsst.meas.base.diaCalculationPlugins.PercentileDiaPsFlux.outputCols = []

static

Definition at line 353 of file diaCalculationPlugins.py.

outputCols [2/2]

lsst.meas.base.diaCalculationPlugins.PercentileDiaPsFlux.outputCols

Definition at line 363 of file diaCalculationPlugins.py.

plugType

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

static

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