LSST Applications g0265f82a02+c6dfa2ddaf,g1162b98a3f+b2075782a9,g2079a07aa2+1b2e822518,g2bbee38e9b+c6dfa2ddaf,g337abbeb29+c6dfa2ddaf,g3ddfee87b4+a60788ef87,g50ff169b8f+2eb0e556e8,g52b1c1532d+90ebb246c7,g555ede804d+a60788ef87,g591dd9f2cf+ba8caea58f,g5ec818987f+864ee9cddb,g858d7b2824+9ee1ab4172,g876c692160+a40945ebb7,g8a8a8dda67+90ebb246c7,g8cdfe0ae6a+4fd9e222a8,g99cad8db69+5e309b7bc6,g9ddcbc5298+a1346535a5,ga1e77700b3+df8f93165b,ga8c6da7877+aa12a14d27,gae46bcf261+c6dfa2ddaf,gb0e22166c9+8634eb87fb,gb3f2274832+d0da15e3be,gba4ed39666+1ac82b564f,gbb8dafda3b+5dfd9c994b,gbeb006f7da+97157f9740,gc28159a63d+c6dfa2ddaf,gc86a011abf+9ee1ab4172,gcf0d15dbbd+a60788ef87,gdaeeff99f8+1cafcb7cd4,gdc0c513512+9ee1ab4172,ge79ae78c31+c6dfa2ddaf,geb67518f79+ba1859f325,geb961e4c1e+f9439d1e6f,gee10cc3b42+90ebb246c7,gf1cff7945b+9ee1ab4172,w.2024.12
LSST Data Management Base Package
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
lsst.pipe.tasks.functors.ReferenceBand Class Reference
Inheritance diagram for lsst.pipe.tasks.functors.ReferenceBand:
lsst.pipe.tasks.functors.Functor

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.

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

◆ 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.

1425 def columns(self):
1426 return ["merge_measurement_i",
1427 "merge_measurement_r",
1428 "merge_measurement_z",
1429 "merge_measurement_y",
1430 "merge_measurement_g",
1431 "merge_measurement_u"]
1432

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: