lsst.meas.base gf28afc6cbd+dab77e5b88
Public Member Functions | Static Public Attributes | List of all members
lsst.meas.base.diaCalculationPlugins.MinMaxDiaPsFlux Class Reference
Inheritance diagram for lsst.meas.base.diaCalculationPlugins.MinMaxDiaPsFlux:
lsst.meas.base.diaCalculation.DiaObjectCalculationPlugin lsst.meas.base.catalogCalculation.CatalogCalculationPlugin lsst.meas.base.pluginsBase.BasePlugin

Public Member Functions

def getExecutionOrder (cls)
 
def calculate (self, diaObjects, diaSources, filterDiaSources, filterName, **kwargs)
 

Static Public Attributes

 ConfigClass = MinMaxDiaPsFluxConfig
 
list outputCols = ["PSFluxMin", "PSFluxMax"]
 
string 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()

def lsst.meas.base.diaCalculationPlugins.MinMaxDiaPsFlux.calculate (   self,
  diaObjects,
  diaSources,
  filterDiaSources,
  filterName,
**  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 ``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 635 of file diaCalculationPlugins.py.

◆ getExecutionOrder()

def lsst.meas.base.diaCalculationPlugins.MinMaxDiaPsFlux.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.

Member Data Documentation

◆ ConfigClass

lsst.meas.base.diaCalculationPlugins.MinMaxDiaPsFlux.ConfigClass = MinMaxDiaPsFluxConfig
static

Definition at line 623 of file diaCalculationPlugins.py.

◆ needsFilter

bool lsst.meas.base.diaCalculationPlugins.MinMaxDiaPsFlux.needsFilter = True
static

Definition at line 629 of file diaCalculationPlugins.py.

◆ outputCols

list lsst.meas.base.diaCalculationPlugins.MinMaxDiaPsFlux.outputCols = ["PSFluxMin", "PSFluxMax"]
static

Definition at line 627 of file diaCalculationPlugins.py.

◆ plugType

string lsst.meas.base.diaCalculationPlugins.MinMaxDiaPsFlux.plugType = "multi"
static

Definition at line 628 of file diaCalculationPlugins.py.


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