LSST Applications
21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
|
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 372 of file functors.py.
def lsst.pipe.tasks.functors.CompositeFunctor.__init__ | ( | self, | |
funcs, | |||
** | kwargs | ||
) |
Definition at line 403 of file functors.py.
def lsst.pipe.tasks.functors.CompositeFunctor.__call__ | ( | self, | |
data, | |||
** | kwargs | ||
) |
Apply the functor to the data table Parameters ---------- data : `lsst.daf.butler.DeferredDatasetHandle`, `lsst.pipe.tasks.parquetTable.MultilevelParquetTable`, `lsst.pipe.tasks.parquetTable.ParquetTable`, or `pandas.DataFrame`. The table or a pointer to a table on disk from which columns can be accessed
Definition at line 455 of file functors.py.
|
inherited |
Definition at line 340 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 438 of file functors.py.
|
inherited |
Computes difference between functor called on two different ParquetTable objects
Definition at line 351 of file functors.py.
|
inherited |
Definition at line 356 of file functors.py.
def lsst.pipe.tasks.functors.CompositeFunctor.filt | ( | self | ) |
Definition at line 415 of file functors.py.
def lsst.pipe.tasks.functors.CompositeFunctor.filt | ( | self, | |
filt | |||
) |
Definition at line 419 of file functors.py.
def lsst.pipe.tasks.functors.CompositeFunctor.from_file | ( | cls, | |
filename, | |||
** | kwargs | ||
) |
Definition at line 536 of file functors.py.
def lsst.pipe.tasks.functors.CompositeFunctor.from_yaml | ( | cls, | |
translationDefinition, | |||
** | kwargs | ||
) |
Definition at line 545 of file functors.py.
def lsst.pipe.tasks.functors.CompositeFunctor.multilevelColumns | ( | self, | |
data, | |||
** | kwargs | ||
) |
Definition at line 441 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 229 of file functors.py.
|
inherited |
Full name of functor (suitable for figure labels)
Reimplemented in lsst.pipe.tasks.functors.Ratio, lsst.pipe.tasks.functors.LocalDipoleDiffFluxErr, lsst.pipe.tasks.functors.LocalDipoleDiffFlux, lsst.pipe.tasks.functors.LocalDipoleMeanFluxErr, lsst.pipe.tasks.functors.LocalDipoleMeanFlux, 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.ConvertPixelSqToArcsecondsSq, 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 360 of file functors.py.
|
inherited |
Definition at line 148 of file functors.py.
def lsst.pipe.tasks.functors.CompositeFunctor.renameCol | ( | cls, | |
col, | |||
renameRules | |||
) |
Definition at line 527 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 366 of file functors.py.
def lsst.pipe.tasks.functors.CompositeFunctor.update | ( | self, | |
new | |||
) |
Definition at line 425 of file functors.py.
|
static |
Definition at line 401 of file functors.py.
lsst.pipe.tasks.functors.CompositeFunctor.filt |
Definition at line 435 of file functors.py.
lsst.pipe.tasks.functors.CompositeFunctor.funcDict |
Definition at line 406 of file functors.py.