lsst.pipe.tasks.functors.Color Class Reference

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

Public Member Functions
def	__init__ (self, col, filt2, filt1, kwargs)
def	filt (self)
def	filt (self, filt)
def	columns (self)
def	multilevelColumns (self, parq)
def	name (self)
def	shortname (self)
def	noDup (self)
def	__call__ (self, parq, dropna=False)
def	fail (self, df)

Public Attributes
	col
	filt2
	filt1
	mag2
	mag1
	filt
	dataset

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` expecting a dataframe with a
multilevel column index, with both `'filter'` 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 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 629 of file functors.py.

Constructor & Destructor Documentation

__init__()

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

Definition at line 658 of file functors.py.

Member Function Documentation

__call__()

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

inherited

Definition at line 177 of file functors.py.

columns()

def lsst.pipe.tasks.functors.Color.columns

(

self

)

Definition at line 684 of file functors.py.

fail()

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

inherited

Definition at line 188 of file functors.py.

filt() [1/2]

def lsst.pipe.tasks.functors.Color.filt

(

self

)

Definition at line 671 of file functors.py.

filt() [2/2]

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

Definition at line 675 of file functors.py.

multilevelColumns()

def lsst.pipe.tasks.functors.Color.multilevelColumns	(		self,
			parq
	)

Definition at line 687 of file functors.py.

name()

def lsst.pipe.tasks.functors.Color.name

(

self

)

Definition at line 692 of file functors.py.

noDup()

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

inherited

Definition at line 115 of file functors.py.

shortname()

def lsst.pipe.tasks.functors.Color.shortname

(

self

)

Definition at line 696 of file functors.py.

Member Data Documentation

col

lsst.pipe.tasks.functors.Color.col

Definition at line 659 of file functors.py.

dataset

lsst.pipe.tasks.functors.Functor.dataset

inherited

Definition at line 111 of file functors.py.

filt

lsst.pipe.tasks.functors.Functor.filt

inherited

Definition at line 110 of file functors.py.

filt1

lsst.pipe.tasks.functors.Color.filt1

Definition at line 663 of file functors.py.

filt2

lsst.pipe.tasks.functors.Color.filt2

Definition at line 662 of file functors.py.

mag1

lsst.pipe.tasks.functors.Color.mag1

Definition at line 666 of file functors.py.

mag2

lsst.pipe.tasks.functors.Color.mag2

Definition at line 665 of file functors.py.

---

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

• python/lsst/pipe/tasks/functors.py