Inheritance diagram for lsst.pipe.tasks.functors.ReferenceBand:

Public Member Functions
	columns (self)

Static Public Attributes
str	name = 'Reference Band'

str	shortname = 'refBand'

Protected Member Functions
pd.Series	_func (self, pd.DataFrame df)

Detailed Description

Return the band used to seed multiband forced photometry.

This functor is to be used on Object tables.
It converts the boolean merge_measurements_{band} columns into a single
string representing the first band for which merge_measurements_{band}
is True.

Assumes the default priority order of i, r, z, y, g, u.

Definition at line 1411 of file functors.py.

Member Function Documentation

◆ _func()

pd.Series lsst.pipe.tasks.functors.ReferenceBand._func	(		self,
		pd.DataFrame	df )

protected

Reimplemented from lsst.pipe.tasks.functors.Functor.

Definition at line 1433 of file functors.py.

    def _func(self, df: pd.DataFrame) -> pd.Series:
        def getFilterAliasName(row):
            # Get column name with the max value (True > False).
            colName = row.idxmax()
            return colName.replace('merge_measurement_', '')
 
        # Skip columns that are unavailable, because this functor requests the
        # superset of bands that could be included in the object table.
        columns = [col for col in self.columns if col in df.columns]
        # Makes a Series of dtype object if df is empty.
        return df[columns].apply(getFilterAliasName, axis=1,
                                 result_type='reduce').astype('object')
 
 

◆ columns()

lsst.pipe.tasks.functors.ReferenceBand.columns ( self )

Columns required to perform calculation.

Reimplemented from lsst.pipe.tasks.functors.Functor.

Definition at line 1425 of file functors.py.

    def columns(self):
        return ["merge_measurement_i",
                "merge_measurement_r",
                "merge_measurement_z",
                "merge_measurement_y",
                "merge_measurement_g",
                "merge_measurement_u"]
 

Member Data Documentation

◆ name

str lsst.pipe.tasks.functors.ReferenceBand.name = 'Reference Band'

static

Definition at line 1421 of file functors.py.

◆ shortname

str lsst.pipe.tasks.functors.ReferenceBand.shortname = 'refBand'

static

Definition at line 1422 of file functors.py.

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

/j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/pipe_tasks/gc07e1c2157+a98bf949bb/python/lsst/pipe/tasks/functors.py

Public Member Functions

Static Public Attributes