|
lsst.pipe.tasks gfb5511b3f7+6fc9c088ec
|
Public Member Functions | |
| __init__ (self, col, filt2, filt1, **kwargs) | |
| filt (self) | |
| filt (self, filt) | |
| columns (self) | |
| multilevelColumns (self, parq, **kwargs) | |
| name (self) | |
| shortname (self) | |
Public Attributes | |
| col | |
| filt2 | |
| filt1 | |
| mag2 | |
| mag1 | |
| dataset | |
Protected Member Functions | |
| _func (self, df) | |
Static Protected Attributes | |
| str | _defaultDataset = 'forced_src' |
| tuple | _dfLevels = ('band', 'column') |
| bool | _defaultNoDup = True |
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 903 of file functors.py.
| lsst.pipe.tasks.functors.Color.__init__ | ( | self, | |
| col, | |||
| filt2, | |||
| filt1, | |||
| ** | kwargs ) |
Reimplemented from lsst.pipe.tasks.functors.Functor.
Definition at line 931 of file functors.py.
|
protected |
Reimplemented from lsst.pipe.tasks.functors.Functor.
Definition at line 951 of file functors.py.
| lsst.pipe.tasks.functors.Color.columns | ( | self | ) |
Columns required to perform calculation.
Reimplemented from lsst.pipe.tasks.functors.Functor.
Definition at line 957 of file functors.py.
| lsst.pipe.tasks.functors.Color.filt | ( | self | ) |
Reimplemented from lsst.pipe.tasks.functors.Functor.
Definition at line 944 of file functors.py.
| lsst.pipe.tasks.functors.Color.filt | ( | self, | |
| filt ) |
Reimplemented from lsst.pipe.tasks.functors.Functor.
Definition at line 948 of file functors.py.
| 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 960 of file functors.py.
| lsst.pipe.tasks.functors.Color.name | ( | self | ) |
Reimplemented from lsst.pipe.tasks.functors.Functor.
Definition at line 964 of file functors.py.
| 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 968 of file functors.py.
|
staticprotected |
Definition at line 927 of file functors.py.
|
staticprotected |
Definition at line 929 of file functors.py.
|
staticprotected |
Definition at line 928 of file functors.py.
| lsst.pipe.tasks.functors.Color.col |
Definition at line 932 of file functors.py.
| lsst.pipe.tasks.functors.Color.dataset |
Definition at line 961 of file functors.py.
| lsst.pipe.tasks.functors.Color.filt1 |
Definition at line 936 of file functors.py.
| lsst.pipe.tasks.functors.Color.filt2 |
Definition at line 935 of file functors.py.
| lsst.pipe.tasks.functors.Color.mag1 |
Definition at line 939 of file functors.py.
| lsst.pipe.tasks.functors.Color.mag2 |
Definition at line 938 of file functors.py.