lsst.meas.base.diaCalculationPlugins.MeanDiaPosition Class Reference

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

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

Static Public Attributes
	ConfigClass = MeanDiaPositionConfig
str	plugType = 'multi'
list	outputCols = ["ra", "dec", "radecMjdTai"]
bool	needsFilter = False

Detailed Description

Compute the mean position of a DiaObject given a set of DiaSources.

Definition at line 87 of file diaCalculationPlugins.py.

Member Function Documentation

calculate()

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

Compute the mean ra/dec position of the diaObject given the
diaSource locations.

Parameters
----------
diaObjects : `pandas.DataFrame`
    Summary objects to store values in.
diaSources : `pandas.DataFrame` or `pandas.DataFrameGroupBy`
    Catalog of DiaSources summarized by this DiaObject.
**kwargs
    Any additional keyword arguments that may be passed to the plugin.

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

Definition at line 102 of file diaCalculationPlugins.py.

    def calculate(self, diaObjects, diaSources, **kwargs):
        """Compute the mean ra/dec position of the diaObject given the
        diaSource locations.
 
        Parameters
        ----------
        diaObjects : `pandas.DataFrame`
            Summary objects to store values in.
        diaSources : `pandas.DataFrame` or `pandas.DataFrameGroupBy`
            Catalog of DiaSources summarized by this DiaObject.
        **kwargs
            Any additional keyword arguments that may be passed to the plugin.
        """
        for outCol in self.outputCols:
            if outCol not in diaObjects.columns:
                diaObjects[outCol] = np.nan
 
        def _computeMeanPos(df):
            aveCoord = geom.averageSpherePoint(
                list(geom.SpherePoint(src["ra"], src["dec"], geom.degrees)
                     for idx, src in df.iterrows()))
            ra = aveCoord.getRa().asDegrees()
            dec = aveCoord.getDec().asDegrees()
            if np.isnan(ra) or np.isnan(dec):
                radecMjdTai = np.nan
            else:
                radecMjdTai = df["midpointMjdTai"].max()
 
            return pd.Series({"ra": aveCoord.getRa().asDegrees(),
                              "dec": aveCoord.getDec().asDegrees(),
                              "radecMjdTai": radecMjdTai})
 
        ans = diaSources.apply(_computeMeanPos)
        diaObjects.loc[:, ["ra", "dec", "radecMjdTai"]] = ans
 
 

getExecutionOrder()

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

    def getExecutionOrder(cls):
        return cls.DEFAULT_CATALOGCALCULATION
 

Member Data Documentation

ConfigClass

lsst.meas.base.diaCalculationPlugins.MeanDiaPosition.ConfigClass = MeanDiaPositionConfig

static

Definition at line 91 of file diaCalculationPlugins.py.

needsFilter

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

static

Definition at line 96 of file diaCalculationPlugins.py.

outputCols

list lsst.meas.base.diaCalculationPlugins.MeanDiaPosition.outputCols = ["ra", "dec", "radecMjdTai"]

static

Definition at line 95 of file diaCalculationPlugins.py.

plugType

str lsst.meas.base.diaCalculationPlugins.MeanDiaPosition.plugType = 'multi'

static

Definition at line 93 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/g6c1bc301e9+51106c2951/python/lsst/meas/base/diaCalculationPlugins.py