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

Public Member Functions
	__init__ (self, col, filt2, filt1, **kwargs)

	filt (self)

	filt (self, filt)

	columns (self)

	multilevelColumns (self, parq, **kwargs)

	name (self)

	shortname (self)

	noDup (self)

	__call__ (self, data, dropna=False)

	difference (self, data1, data2, **kwargs)

	fail (self, df)

Public Attributes
	col = fluxName(col)

	filt2 = filt2

	filt1 = filt1

	mag2 = Mag(col, filt=filt2, **kwargs)

	mag1 = Mag(col, filt=filt1, **kwargs)

str	dataset = dataset if dataset is not None else self._defaultDataset

	log = logging.getLogger(type(self).__name__)

Protected Member Functions
	_func (self, df)

	_get_data_columnLevels (self, data, columnIndex=None)

	_get_data_columnLevelNames (self, data, columnIndex=None)

	_colsFromDict (self, colDict, columnIndex=None)

	_get_columnIndex (self, data)

	_get_data (self, data)

	_setLevels (self, df)

	_dropna (self, vals)

Protected Attributes
	_noDup = noDup

Static Protected Attributes
str	_defaultDataset = 'ref'

tuple	_dfLevels = ('column',)

bool	_defaultNoDup = False

Detailed Description

Compute the color between two filters.

Computes color by initializing two different `Mag` functors based on the
``col`` and filters provided, and then returning the difference.

This is enabled by the `_func` method expecting a DataFrame with a
multilevel column index, with both ``'band'`` and ``'column'``, instead of
just ``'column'``, which is the `Functor` default.
This is controlled by the `_dfLevels` attribute.

Also of note, the default dataset for `Color` is ``forced_src'``, whereas
for `Mag` it is ``'meas'``.

Parameters
----------
col : str
    Name of the flux column from which to compute; same as would be passed
    to `~lsst.pipe.tasks.functors.Mag`.

filt2, filt1 : str
    Filters from which to compute magnitude difference.
    Color computed is ``Mag(filt2) - Mag(filt1)``.

Definition at line 935 of file functors.py.

Constructor & Destructor Documentation

◆ init()

lsst.pipe.tasks.functors.Color.__init__	(		self,
			col,
			filt2,
			filt1,
		**	kwargs )

Definition at line 963 of file functors.py.

Member Function Documentation

◆ call()

lsst.pipe.tasks.functors.Functor.__call__	(	self,
		data,
		dropna = False )

inherited

Definition at line 353 of file functors.py.

◆ _colsFromDict()

lsst.pipe.tasks.functors.Functor._colsFromDict	(	self,
		colDict,
		columnIndex = None )

protectedinherited

Converts dictionary column specficiation to a list of columns.

Definition at line 223 of file functors.py.

◆ _dropna()

lsst.pipe.tasks.functors.Functor._dropna	(		self,
			vals )

protectedinherited

Definition at line 350 of file functors.py.

◆ _func()

lsst.pipe.tasks.functors.Color._func	(		self,
			df )

protected

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

Definition at line 983 of file functors.py.

◆ _get_columnIndex()

lsst.pipe.tasks.functors.Functor._get_columnIndex	(		self,
			data )

protectedinherited

Return columnIndex.

Definition at line 299 of file functors.py.

◆ _get_data()

lsst.pipe.tasks.functors.Functor._get_data	(		self,
			data )

protectedinherited

Retrieve DataFrame necessary for calculation.

The data argument can be a `~pandas.DataFrame`, a
`~lsst.daf.butler.DeferredDatasetHandle`, or
an `~lsst.pipe.base.InMemoryDatasetHandle`.

Returns a DataFrame upon which `self._func` can act.

Definition at line 307 of file functors.py.

◆ _get_data_columnLevelNames()

lsst.pipe.tasks.functors.Functor._get_data_columnLevelNames	(	self,
		data,
		columnIndex = None )

protectedinherited

Gets the content of each of the column levels for a multilevel
table.

Definition at line 209 of file functors.py.

◆ _get_data_columnLevels()

lsst.pipe.tasks.functors.Functor._get_data_columnLevels	(	self,
		data,
		columnIndex = None )

protectedinherited

Gets the names of the column index levels.

This should only be called in the context of a multilevel table.

Parameters
----------
data : various
    The data to be read, can be a
    `~lsst.daf.butler.DeferredDatasetHandle` or
    `~lsst.pipe.base.InMemoryDatasetHandle`.
columnIndex (optional): pandas `~pandas.Index` object
    If not passed, then it is read from the
    `~lsst.daf.butler.DeferredDatasetHandle`
    for `~lsst.pipe.base.InMemoryDatasetHandle`.

Definition at line 189 of file functors.py.

◆ _setLevels()

lsst.pipe.tasks.functors.Functor._setLevels	(		self,
			df )

protectedinherited

Definition at line 345 of file functors.py.

◆ columns()

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

Columns required to perform calculation.

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

Definition at line 989 of file functors.py.

◆ difference()

lsst.pipe.tasks.functors.Functor.difference	(		self,
			data1,
			data2,
		**	kwargs )

inherited

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

Definition at line 365 of file functors.py.

◆ fail()

lsst.pipe.tasks.functors.Functor.fail	(		self,
			df )

inherited

Definition at line 371 of file functors.py.

◆ filt() [1/2]

lsst.pipe.tasks.functors.Color.filt ( self )

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

Definition at line 976 of file functors.py.

◆ filt() [2/2]

lsst.pipe.tasks.functors.Color.filt	(		self,
			filt )

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

Definition at line 980 of file functors.py.

◆ multilevelColumns()

lsst.pipe.tasks.functors.Color.multilevelColumns	(		self,
			data,
		**	columnIndex )

Returns columns needed by functor from multilevel dataset.

To access tables with multilevel column structure, the
`~lsst.daf.butler.DeferredDatasetHandle` or
`~lsst.pipe.base.InMemoryDatasetHandle` needs to be passed
either a list of tuples or a dictionary.

Parameters
----------
data : various
    The data as either `~lsst.daf.butler.DeferredDatasetHandle`, or
    `~lsst.pipe.base.InMemoryDatasetHandle`.
columnIndex (optional): pandas `~pandas.Index` object
    Either passed or read in from
    `~lsst.daf.butler.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.

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

Definition at line 992 of file functors.py.

◆ name()

lsst.pipe.tasks.functors.Color.name ( self )

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

Definition at line 996 of file functors.py.

◆ noDup()

lsst.pipe.tasks.functors.Functor.noDup ( self )

inherited

Do not explode by band if used on object table.

Definition at line 175 of file functors.py.

◆ shortname()

lsst.pipe.tasks.functors.Color.shortname ( self )

Short name of functor (suitable for column name/dict key).

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

Definition at line 1000 of file functors.py.

Member Data Documentation

◆ _defaultDataset

str lsst.pipe.tasks.functors.Functor._defaultDataset = 'ref'

staticprotectedinherited

Definition at line 164 of file functors.py.

◆ _defaultNoDup

bool lsst.pipe.tasks.functors.Functor._defaultNoDup = False

staticprotectedinherited

Definition at line 166 of file functors.py.

◆ _dfLevels

tuple lsst.pipe.tasks.functors.Functor._dfLevels = ('column',)

staticprotectedinherited

Definition at line 165 of file functors.py.

◆ _noDup

lsst.pipe.tasks.functors.Functor._noDup = noDup

protectedinherited

Definition at line 171 of file functors.py.

◆ col

lsst.pipe.tasks.functors.Color.col = fluxName(col)

Definition at line 964 of file functors.py.

◆ dataset

str lsst.pipe.tasks.functors.Functor.dataset = dataset if dataset is not None else self._defaultDataset

inherited

Definition at line 170 of file functors.py.

◆ filt1

lsst.pipe.tasks.functors.Color.filt1 = filt1

Definition at line 968 of file functors.py.

◆ filt2

lsst.pipe.tasks.functors.Color.filt2 = filt2

Definition at line 967 of file functors.py.

◆ log

lsst.pipe.tasks.functors.Functor.log = logging.getLogger(type(self).__name__)

inherited

Definition at line 172 of file functors.py.

◆ mag1

lsst.pipe.tasks.functors.Color.mag1 = Mag(col, filt=filt1, **kwargs)

Definition at line 971 of file functors.py.

◆ mag2

lsst.pipe.tasks.functors.Color.mag2 = Mag(col, filt=filt2, **kwargs)

Definition at line 970 of file functors.py.

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

python/lsst/pipe/tasks/functors.py

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ __call__()

◆ _colsFromDict()

◆ _dropna()

◆ _func()

◆ _get_columnIndex()

◆ _get_data()

◆ _get_data_columnLevelNames()

◆ _get_data_columnLevels()

◆ _setLevels()

◆ columns()

◆ difference()

◆ fail()

◆ filt() [1/2]

◆ filt() [2/2]

◆ multilevelColumns()

◆ name()

◆ noDup()

◆ shortname()

Member Data Documentation

◆ _defaultDataset

◆ _defaultNoDup

◆ _dfLevels

◆ _noDup

◆ col

◆ dataset

◆ filt1

◆ filt2

◆ log

◆ mag1

◆ mag2

◆ init()

◆ call()