ReferenceBand

class lsst.pipe.tasks.functors.ReferenceBand(filt=None, dataset=None, noDup=None)

Bases: Functor

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.

Attributes Summary

columns	Columns required to perform calculation.
name
noDup	Do not explode by band if used on object table.
shortname

Methods Summary

__call__(data[, dropna])	Call self as a function.
difference(data1, data2, **kwargs)	Computes difference between functor called on two different DataFrame/Handle objects.
fail(df)
multilevelColumns(data[, columnIndex, ...])	Returns columns needed by functor from multilevel dataset.

Attributes Documentation

columns

name = 'Reference Band'

noDup

Do not explode by band if used on object table.

shortname = 'refBand'

Methods Documentation

__call__(data, dropna=False)

Call self as a function.

difference(data1, data2, **kwargs)

Computes difference between functor called on two different DataFrame/Handle objects.

fail(df)

multilevelColumns(data, columnIndex=None, returnTuple=False)

Returns columns needed by functor from multilevel dataset.

To access tables with multilevel column structure, the DeferredDatasetHandle or InMemoryDatasetHandle needs to be passed either a list of tuples or a dictionary.

Parameters:

datavarious

The data as either DeferredDatasetHandle, or InMemoryDatasetHandle.

columnIndex (optional): pandas `~pandas.Index` object

Either passed or read in from DeferredDatasetHandle.

`returnTuple`bool

If true, then return a list of tuples rather than the column dictionary specification. This is set to True by CompositeFunctor in order to be able to combine columns from the various component functors.