lsst.pipe.tasks gdc3b911723+afe335b0f3
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
lsst.pipe.tasks.functors.Color Class Reference
Inheritance diagram for lsst.pipe.tasks.functors.Color:
lsst.pipe.tasks.functors.Functor

Public Member Functions

def __init__ (self, col, filt2, filt1, **kwargs)
 
def filt (self)
 
def filt (self, filt)
 
def columns (self)
 
def multilevelColumns (self, parq, **kwargs)
 
def name (self)
 
def shortname (self)
 

Public Attributes

 col
 
 filt2
 
 filt1
 
 mag2
 
 mag1
 

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 `'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 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 917 of file functors.py.

Constructor & Destructor Documentation

◆ __init__()

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

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

Definition at line 946 of file functors.py.

Member Function Documentation

◆ columns()

def lsst.pipe.tasks.functors.Color.columns (   self)
Columns required to perform calculation

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

Definition at line 972 of file functors.py.

◆ filt() [1/2]

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

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

Definition at line 959 of file functors.py.

◆ filt() [2/2]

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

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

Definition at line 963 of file functors.py.

◆ multilevelColumns()

def 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 `MultilevelParquetTable`
or `DeferredDatasetHandle` need to be passed either a list of tuples or a
dictionary.

Parameters
----------
data : `MultilevelParquetTable` or `DeferredDatasetHandle`

columnIndex (optional): 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.

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

Definition at line 975 of file functors.py.

◆ name()

def lsst.pipe.tasks.functors.Color.name (   self)
Full name of functor (suitable for figure labels)

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

Definition at line 979 of file functors.py.

◆ shortname()

def 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 983 of file functors.py.

Member Data Documentation

◆ col

lsst.pipe.tasks.functors.Color.col

Definition at line 947 of file functors.py.

◆ filt1

lsst.pipe.tasks.functors.Color.filt1

Definition at line 951 of file functors.py.

◆ filt2

lsst.pipe.tasks.functors.Color.filt2

Definition at line 950 of file functors.py.

◆ mag1

lsst.pipe.tasks.functors.Color.mag1

Definition at line 954 of file functors.py.

◆ mag2

lsst.pipe.tasks.functors.Color.mag2

Definition at line 953 of file functors.py.


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