lsst.meas.base gdd7ff8183c+77dc2338e9
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | List of all members
lsst.meas.base.diaCalculationPlugins.WeightedMeanDiaTotFlux Class Reference
Inheritance diagram for lsst.meas.base.diaCalculationPlugins.WeightedMeanDiaTotFlux:
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 = WeightedMeanDiaPsFluxConfig
 
list outputCols = ["TOTFluxMean", "TOTFluxMeanErr"]
 
string plugType = "multi"
 
bool needsFilter = True
 

Detailed Description

Compute the weighted mean and mean error on the point source fluxes
forced photometered at the DiaSource location in the calibrated image.

Additionally store number of usable data points.

Definition at line 1007 of file diaCalculationPlugins.py.

Member Function Documentation

◆ calculate()

def lsst.meas.base.diaCalculationPlugins.WeightedMeanDiaTotFlux.calculate (   self,
  diaObjects,
  diaSources,
  filterDiaSources,
  filterName,
**  kwargs 
)
Compute the weighted mean and mean error 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 1025 of file diaCalculationPlugins.py.

◆ getExecutionOrder()

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

Member Data Documentation

◆ ConfigClass

lsst.meas.base.diaCalculationPlugins.WeightedMeanDiaTotFlux.ConfigClass = WeightedMeanDiaPsFluxConfig
static

Definition at line 1014 of file diaCalculationPlugins.py.

◆ needsFilter

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

Definition at line 1017 of file diaCalculationPlugins.py.

◆ outputCols

list lsst.meas.base.diaCalculationPlugins.WeightedMeanDiaTotFlux.outputCols = ["TOTFluxMean", "TOTFluxMeanErr"]
static

Definition at line 1015 of file diaCalculationPlugins.py.

◆ plugType

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

Definition at line 1016 of file diaCalculationPlugins.py.


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