lsst.meas.base.diaCalculationPlugins.SimpleSourceFlagDiaPlugin Class Reference

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

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

Static Public Attributes
	ConfigClass = NumDiaSourcesDiaPluginConfig
list	outputCols = ["flags"]
str	plugType = "multi"
bool	needsFilter = False

Detailed Description

Find if any DiaSource is flagged.

Set the DiaObject flag if any DiaSource is flagged.

Definition at line 229 of file diaCalculationPlugins.py.

Member Function Documentation

calculate()

lsst.meas.base.diaCalculationPlugins.SimpleSourceFlagDiaPlugin.calculate	(		self,
			diaObjects,
			diaSources,
		**	kwargs )

Find if any DiaSource is flagged.

Set the DiaObject flag if any DiaSource is flagged.

Parameters
----------
diaObject : `dict`
    Summary object to store values in and read ra/dec from.
**kwargs
    Any additional keyword arguments that may be passed to the plugin.

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

Definition at line 244 of file diaCalculationPlugins.py.

    def calculate(self, diaObjects, diaSources, **kwargs):
        """Find if any DiaSource is flagged.
 
        Set the DiaObject flag if any DiaSource is flagged.
 
        Parameters
        ----------
        diaObject : `dict`
            Summary object to store values in and read ra/dec from.
        **kwargs
            Any additional keyword arguments that may be passed to the plugin.
        """
        diaObjects.loc[:, "flags"] = diaSources.flags.any().astype(np.uint64)
 
 

getExecutionOrder()

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

    def getExecutionOrder(cls):
        return cls.DEFAULT_CATALOGCALCULATION
 

Member Data Documentation

ConfigClass

lsst.meas.base.diaCalculationPlugins.SimpleSourceFlagDiaPlugin.ConfigClass = NumDiaSourcesDiaPluginConfig

static

Definition at line 235 of file diaCalculationPlugins.py.

needsFilter

bool lsst.meas.base.diaCalculationPlugins.SimpleSourceFlagDiaPlugin.needsFilter = False

static

Definition at line 238 of file diaCalculationPlugins.py.

outputCols

list lsst.meas.base.diaCalculationPlugins.SimpleSourceFlagDiaPlugin.outputCols = ["flags"]

static

Definition at line 236 of file diaCalculationPlugins.py.

plugType

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

static

Definition at line 237 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/g48712c4677+3bf1020dcb/python/lsst/meas/base/diaCalculationPlugins.py