LSST Applications 27.0.0,g0265f82a02+469cd937ee,g02d81e74bb+21ad69e7e1,g1470d8bcf6+cbe83ee85a,g2079a07aa2+e67c6346a6,g212a7c68fe+04a9158687,g2305ad1205+94392ce272,g295015adf3+81dd352a9d,g2bbee38e9b+469cd937ee,g337abbeb29+469cd937ee,g3939d97d7f+72a9f7b576,g487adcacf7+71499e7cba,g50ff169b8f+5929b3527e,g52b1c1532d+a6fc98d2e7,g591dd9f2cf+df404f777f,g5a732f18d5+be83d3ecdb,g64a986408d+21ad69e7e1,g858d7b2824+21ad69e7e1,g8a8a8dda67+a6fc98d2e7,g99cad8db69+f62e5b0af5,g9ddcbc5298+d4bad12328,ga1e77700b3+9c366c4306,ga8c6da7877+71e4819109,gb0e22166c9+25ba2f69a1,gb6a65358fc+469cd937ee,gbb8dafda3b+69d3c0e320,gc07e1c2157+a98bf949bb,gc120e1dc64+615ec43309,gc28159a63d+469cd937ee,gcf0d15dbbd+72a9f7b576,gdaeeff99f8+a38ce5ea23,ge6526c86ff+3a7c1ac5f1,ge79ae78c31+469cd937ee,gee10cc3b42+a6fc98d2e7,gf1cff7945b+21ad69e7e1,gfbcc870c63+9a11dc8c8f
LSST Data Management Base Package
|
Public Member Functions | |
__init__ (self, funcs, **kwargs) | |
filt (self) | |
filt (self, filt) | |
update (self, new) | |
columns (self) | |
multilevelColumns (self, data, **kwargs) | |
__call__ (self, data, **kwargs) | |
renameCol (cls, col, renameRules) | |
from_file (cls, filename, **kwargs) | |
from_yaml (cls, translationDefinition, **kwargs) | |
Public Attributes | |
funcDict | |
filt | |
name | |
Static Public Attributes | |
dataset = None | |
str | name = "CompositeFunctor" |
Protected Attributes | |
_filt | |
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 an 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 377 of file functors.py.
lsst.pipe.tasks.functors.CompositeFunctor.__init__ | ( | self, | |
funcs, | |||
** | kwargs ) |
Reimplemented from lsst.pipe.tasks.functors.Functor.
Definition at line 410 of file functors.py.
lsst.pipe.tasks.functors.CompositeFunctor.__call__ | ( | self, | |
data, | |||
** | kwargs ) |
Apply the functor to the data table. Parameters ---------- data : various The data represented as `~lsst.daf.butler.DeferredDatasetHandle`, `~lsst.pipe.base.InMemoryDatasetHandle`, or `~pandas.DataFrame`. The table or a pointer to a table on disk from which columns can be accessed.
Reimplemented from lsst.pipe.tasks.functors.Functor.
Definition at line 464 of file functors.py.
lsst.pipe.tasks.functors.CompositeFunctor.columns | ( | self | ) |
Columns required to perform calculation.
Reimplemented from lsst.pipe.tasks.functors.Functor.
Definition at line 446 of file functors.py.
lsst.pipe.tasks.functors.CompositeFunctor.filt | ( | self | ) |
Reimplemented from lsst.pipe.tasks.functors.Functor.
Definition at line 422 of file functors.py.
lsst.pipe.tasks.functors.CompositeFunctor.filt | ( | self, | |
filt ) |
Reimplemented from lsst.pipe.tasks.functors.Functor.
Definition at line 426 of file functors.py.
lsst.pipe.tasks.functors.CompositeFunctor.from_file | ( | cls, | |
filename, | |||
** | kwargs ) |
Definition at line 539 of file functors.py.
lsst.pipe.tasks.functors.CompositeFunctor.from_yaml | ( | cls, | |
translationDefinition, | |||
** | kwargs ) |
Definition at line 548 of file functors.py.
lsst.pipe.tasks.functors.CompositeFunctor.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 449 of file functors.py.
lsst.pipe.tasks.functors.CompositeFunctor.renameCol | ( | cls, | |
col, | |||
renameRules ) |
Definition at line 530 of file functors.py.
lsst.pipe.tasks.functors.CompositeFunctor.update | ( | self, | |
new ) |
Update the functor with new functors.
Definition at line 432 of file functors.py.
|
protected |
Definition at line 417 of file functors.py.
|
static |
Definition at line 407 of file functors.py.
lsst.pipe.tasks.functors.CompositeFunctor.filt |
Definition at line 443 of file functors.py.
lsst.pipe.tasks.functors.CompositeFunctor.funcDict |
Definition at line 413 of file functors.py.
|
static |
Definition at line 408 of file functors.py.
lsst.pipe.tasks.functors.CompositeFunctor.name |
Definition at line 498 of file functors.py.