lsst.pipe.tasks
21.0.0-22-gf0532904+afb8e7912b
|
Public Member Functions | |
def | __init__ (self, funcs, **kwargs) |
def | filt (self) |
def | filt (self, filt) |
def | update (self, new) |
def | columns (self) |
def | multilevelColumns (self, data, **kwargs) |
def | __call__ (self, data, **kwargs) |
def | renameCol (cls, col, renameRules) |
def | from_file (cls, filename, **kwargs) |
def | from_yaml (cls, translationDefinition, **kwargs) |
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) |
def | name (self) |
def | shortname (self) |
Public Attributes | |
funcDict | |
filt | |
Static Public Attributes | |
dataset = None | |
Perform multiple calculations at once on a catalog The role of a `CompositeFunctor` is to group together computations from multiple functors. Instead of returning `pandas.Series` a `CompositeFunctor` returns a `pandas.Dataframe`, with the column names being the keys of `funcDict`. The `columns` attribute of a `CompositeFunctor` is the union of all columns in all the component functors. A `CompositeFunctor` does not use a `_func` method itself; rather, when a `CompositeFunctor` is called, all its columns are loaded at once, and the resulting dataframe is passed to the `_func` method of each component functor. This has the advantage of only doing I/O (reading from parquet file) once, and works because each individual `_func` method of each component functor does not care if there are *extra* columns in the dataframe being passed; only that it must contain *at least* the `columns` it expects. An important and useful class method is `from_yaml`, which takes as argument the path to a YAML file specifying a collection of functors. Parameters ---------- funcs : `dict` or `list` Dictionary or list of functors. If a list, then it will be converted into a dictonary according to the `.shortname` attribute of each functor.
Definition at line 350 of file functors.py.
def lsst.pipe.tasks.functors.CompositeFunctor.__init__ | ( | self, | |
funcs, | |||
** | kwargs | ||
) |
Definition at line 381 of file functors.py.
def lsst.pipe.tasks.functors.CompositeFunctor.__call__ | ( | self, | |
data, | |||
** | kwargs | ||
) |
Definition at line 433 of file functors.py.
|
inherited |
Definition at line 318 of file functors.py.
def lsst.pipe.tasks.functors.CompositeFunctor.columns | ( | self | ) |
Columns required to perform calculation
Reimplemented from lsst.pipe.tasks.functors.Functor.
Definition at line 416 of file functors.py.
|
inherited |
Computes difference between functor called on two different ParquetTable objects
Definition at line 329 of file functors.py.
|
inherited |
Definition at line 334 of file functors.py.
def lsst.pipe.tasks.functors.CompositeFunctor.filt | ( | self | ) |
Definition at line 393 of file functors.py.
def lsst.pipe.tasks.functors.CompositeFunctor.filt | ( | self, | |
filt | |||
) |
Definition at line 397 of file functors.py.
def lsst.pipe.tasks.functors.CompositeFunctor.from_file | ( | cls, | |
filename, | |||
** | kwargs | ||
) |
Definition at line 493 of file functors.py.
def lsst.pipe.tasks.functors.CompositeFunctor.from_yaml | ( | cls, | |
translationDefinition, | |||
** | kwargs | ||
) |
Definition at line 500 of file functors.py.
def lsst.pipe.tasks.functors.CompositeFunctor.multilevelColumns | ( | self, | |
data, | |||
** | kwargs | ||
) |
Definition at line 419 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 205 of file functors.py.
|
inherited |
Full name of functor (suitable for figure labels)
Reimplemented in lsst.pipe.tasks.functors.LocalMagnitudeErr, lsst.pipe.tasks.functors.LocalMagnitude, lsst.pipe.tasks.functors.LocalNanojanskyErr, lsst.pipe.tasks.functors.LocalNanojansky, lsst.pipe.tasks.functors.Photometry, lsst.pipe.tasks.functors.ConvertPixelToArcseconds, lsst.pipe.tasks.functors.Color, lsst.pipe.tasks.functors.MagDiff, lsst.pipe.tasks.functors.MagErr, lsst.pipe.tasks.functors.Mag, lsst.pipe.tasks.functors.Column, and lsst.pipe.tasks.functors.CustomFunctor.
Definition at line 338 of file functors.py.
|
inherited |
Definition at line 124 of file functors.py.
def lsst.pipe.tasks.functors.CompositeFunctor.renameCol | ( | cls, | |
col, | |||
renameRules | |||
) |
Definition at line 484 of file functors.py.
|
inherited |
Short name of functor (suitable for column name/dict key)
Reimplemented in lsst.pipe.tasks.functors.Color, and lsst.pipe.tasks.functors.MagDiff.
Definition at line 344 of file functors.py.
def lsst.pipe.tasks.functors.CompositeFunctor.update | ( | self, | |
new | |||
) |
Definition at line 403 of file functors.py.
|
static |
Definition at line 379 of file functors.py.
lsst.pipe.tasks.functors.CompositeFunctor.filt |
Definition at line 413 of file functors.py.
lsst.pipe.tasks.functors.CompositeFunctor.funcDict |
Definition at line 384 of file functors.py.