lsst.pipe.tasks
21.0.0-131-g8cabc107+528f53ee53
|
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) |
def | noDup (self) |
def | multilevelColumns (self, data, columnIndex=None, returnTuple=False) |
def | __call__ (self, data, dropna=False) |
def | difference (self, data1, data2, **kwargs) |
def | fail (self, df) |
Public Attributes | |
col | |
filt2 | |
filt1 | |
mag2 | |
mag1 | |
filt | |
dataset | |
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 851 of file functors.py.
def lsst.pipe.tasks.functors.Color.__init__ | ( | self, | |
col, | |||
filt2, | |||
filt1, | |||
** | kwargs | ||
) |
Definition at line 880 of file functors.py.
|
inherited |
Definition at line 344 of file functors.py.
def lsst.pipe.tasks.functors.Color.columns | ( | self | ) |
Columns required to perform calculation
Reimplemented from lsst.pipe.tasks.functors.Functor.
Definition at line 906 of file functors.py.
|
inherited |
Computes difference between functor called on two different ParquetTable objects
Definition at line 355 of file functors.py.
|
inherited |
Definition at line 360 of file functors.py.
def lsst.pipe.tasks.functors.Color.filt | ( | self | ) |
Definition at line 893 of file functors.py.
def lsst.pipe.tasks.functors.Color.filt | ( | self, | |
filt | |||
) |
Definition at line 897 of file functors.py.
|
inherited |
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.
Definition at line 227 of file functors.py.
def lsst.pipe.tasks.functors.Color.multilevelColumns | ( | self, | |
parq, | |||
** | kwargs | ||
) |
Definition at line 909 of file functors.py.
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 913 of file functors.py.
|
inherited |
Definition at line 146 of file functors.py.
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 917 of file functors.py.
lsst.pipe.tasks.functors.Color.col |
Definition at line 881 of file functors.py.
|
inherited |
Definition at line 142 of file functors.py.
|
inherited |
Definition at line 141 of file functors.py.
lsst.pipe.tasks.functors.Color.filt1 |
Definition at line 885 of file functors.py.
lsst.pipe.tasks.functors.Color.filt2 |
Definition at line 884 of file functors.py.
lsst.pipe.tasks.functors.Color.mag1 |
Definition at line 888 of file functors.py.
lsst.pipe.tasks.functors.Color.mag2 |
Definition at line 887 of file functors.py.