LSST Applications 24.1.5,g02d81e74bb+fa3a7a026e,g180d380827+a53a32eff8,g2079a07aa2+86d27d4dc4,g2305ad1205+c0501b3732,g295015adf3+7d3e92f0ec,g2bbee38e9b+0e5473021a,g337abbeb29+0e5473021a,g33d1c0ed96+0e5473021a,g3a166c0a6a+0e5473021a,g3ddfee87b4+5dd1654d75,g48712c4677+3bf1020dcb,g487adcacf7+065c13d9cf,g50ff169b8f+96c6868917,g52b1c1532d+585e252eca,g591dd9f2cf+d7ac436cfb,g5a732f18d5+53520f316c,g64a986408d+fa3a7a026e,g858d7b2824+fa3a7a026e,g8a8a8dda67+585e252eca,g99cad8db69+a5a909b84f,g9ddcbc5298+9a081db1e4,ga1e77700b3+15fc3df1f7,ga8c6da7877+4cf350ccb2,gb0e22166c9+60f28cb32d,gba4ed39666+c2a2e4ac27,gbb8dafda3b+f991a0b59f,gc120e1dc64+9ccbfdb8be,gc28159a63d+0e5473021a,gcf0d15dbbd+5dd1654d75,gd96a1ce819+42fd0ee607,gdaeeff99f8+f9a426f77a,ge6526c86ff+0d71447b4b,ge79ae78c31+0e5473021a,gee10cc3b42+585e252eca,gff1a9f87cc+fa3a7a026e
LSST Data Management Base Package
|
Public Member Functions | |
__init__ (self, filt=None, dataset=None, noDup=None) | |
noDup (self) | |
columns (self) | |
multilevelColumns (self, data, columnIndex=None, returnTuple=False) | |
__call__ (self, data, dropna=False) | |
difference (self, data1, data2, **kwargs) | |
fail (self, df) | |
name (self) | |
shortname (self) | |
Public Attributes | |
filt | |
dataset | |
log | |
name | |
Protected Member Functions | |
_get_data_columnLevels (self, data, columnIndex=None) | |
_get_data_columnLevelNames (self, data, columnIndex=None) | |
_colsFromDict (self, colDict, columnIndex=None) | |
_func (self, df, dropna=True) | |
_get_columnIndex (self, data) | |
_get_data (self, data) | |
_setLevels (self, df) | |
_dropna (self, vals) | |
Protected Attributes | |
_noDup | |
Static Protected Attributes | |
str | _defaultDataset = 'ref' |
tuple | _dfLevels = ('column',) |
bool | _defaultNoDup = False |
Define and execute a calculation on a DataFrame or Handle holding a DataFrame. The `__call__` method accepts either a `~pandas.DataFrame` object or a `~lsst.daf.butler.DeferredDatasetHandle` or `~lsst.pipe.base.InMemoryDatasetHandle`, and returns the result of the calculation as a single column. Each functor defines what columns are needed for the calculation, and only these columns are read from the dataset handle. The action of `__call__` consists of two steps: first, loading the necessary columns from disk into memory as a `~pandas.DataFrame` object; and second, performing the computation on this DataFrame and returning the result. To define a new `Functor`, a subclass must define a `_func` method, that takes a `~pandas.DataFrame` and returns result in a `~pandas.Series`. In addition, it must define the following attributes: * `_columns`: The columns necessary to perform the calculation * `name`: A name appropriate for a figure axis label * `shortname`: A name appropriate for use as a dictionary key On initialization, a `Functor` should declare what band (``filt`` kwarg) and dataset (e.g. ``'ref'``, ``'meas'``, ``'forced_src'``) it is intended to be applied to. This enables the `_get_data` method to extract the proper columns from the underlying data. If not specified, the dataset will fall back on the `_defaultDataset` attribute. If band is not specified and ``dataset`` is anything other than ``'ref'``, then an error will be raised when trying to perform the calculation. Originally, `Functor` was set up to expect datasets formatted like the ``deepCoadd_obj`` dataset; that is, a DataFrame with a multi-level column index, with the levels of the column index being ``band``, ``dataset``, and ``column``. It has since been generalized to apply to DataFrames without multi-level indices and multi-level indices with just ``dataset`` and ``column`` levels. In addition, the `_get_data` method that reads the columns from the underlying data will return a DataFrame with column index levels defined by the `_dfLevels` attribute; by default, this is ``column``. The `_dfLevels` attributes should generally not need to be changed, unless `_func` needs columns from multiple filters or datasets to do the calculation. An example of this is the `~lsst.pipe.tasks.functors.Color` functor, for which `_dfLevels = ('band', 'column')`, and `_func` expects the DataFrame it gets to have those levels in the column index. Parameters ---------- filt : str Band upon which to do the calculation. dataset : str Dataset upon which to do the calculation (e.g., 'ref', 'meas', 'forced_src').
Definition at line 94 of file functors.py.
lsst.pipe.tasks.functors.Functor.__init__ | ( | self, | |
filt = None, | |||
dataset = None, | |||
noDup = None ) |
Reimplemented in lsst.pipe.tasks.functors.RAColumn, lsst.pipe.tasks.functors.DecColumn, lsst.pipe.tasks.functors.RAErrColumn, lsst.pipe.tasks.functors.DecErrColumn, lsst.pipe.tasks.functors.RADecCovColumn, lsst.pipe.tasks.functors.Ebv, lsst.pipe.tasks.functors.MagErr, lsst.pipe.tasks.functors.Column, lsst.pipe.tasks.functors.CoordColumn, lsst.pipe.tasks.functors.Mag, lsst.pipe.tasks.functors.ConvertPixelToArcseconds, lsst.pipe.tasks.functors.ConvertPixelSqToArcsecondsSq, lsst.pipe.tasks.functors.Color, lsst.pipe.tasks.functors.MagDiff, lsst.pipe.tasks.functors.LocalWcs, lsst.pipe.tasks.functors.Photometry, lsst.pipe.tasks.functors.E1, lsst.pipe.tasks.functors.E2, lsst.pipe.tasks.functors.RadiusFromQuadrupole, lsst.pipe.tasks.functors.CustomFunctor, lsst.pipe.tasks.functors.CompositeFunctor, lsst.pipe.tasks.functors.LocalPhotometry, lsst.pipe.tasks.functors.LocalDipoleMeanFlux, and lsst.pipe.tasks.functors.HtmIndex20.
Definition at line 160 of file functors.py.
lsst.pipe.tasks.functors.Functor.__call__ | ( | self, | |
data, | |||
dropna = False ) |
Reimplemented in lsst.pipe.tasks.functors.RAColumn, lsst.pipe.tasks.functors.DecColumn, and lsst.pipe.tasks.functors.CompositeFunctor.
Definition at line 345 of file functors.py.
|
protected |
Converts dictionary column specficiation to a list of columns.
Definition at line 215 of file functors.py.
|
protected |
Definition at line 342 of file functors.py.
|
protected |
Reimplemented in lsst.pipe.tasks.functors.CustomFunctor, lsst.pipe.tasks.functors.Column, lsst.pipe.tasks.functors.Index, lsst.pipe.tasks.functors.CoordColumn, lsst.pipe.tasks.functors.RADecCovColumn, lsst.pipe.tasks.functors.HtmIndex20, lsst.pipe.tasks.functors.Mag, lsst.pipe.tasks.functors.MagErr, lsst.pipe.tasks.functors.MagDiff, lsst.pipe.tasks.functors.Color, lsst.pipe.tasks.functors.DeconvolvedMoments, lsst.pipe.tasks.functors.SdssTraceSize, lsst.pipe.tasks.functors.PsfSdssTraceSizeDiff, lsst.pipe.tasks.functors.HsmTraceSize, lsst.pipe.tasks.functors.PsfHsmTraceSizeDiff, lsst.pipe.tasks.functors.HsmFwhm, lsst.pipe.tasks.functors.E1, lsst.pipe.tasks.functors.E2, lsst.pipe.tasks.functors.RadiusFromQuadrupole, lsst.pipe.tasks.functors.ComputePixelScale, lsst.pipe.tasks.functors.ConvertPixelToArcseconds, lsst.pipe.tasks.functors.ConvertPixelSqToArcsecondsSq, lsst.pipe.tasks.functors.NanoJansky, lsst.pipe.tasks.functors.NanoJanskyErr, lsst.pipe.tasks.functors.LocalNanojansky, lsst.pipe.tasks.functors.LocalNanojanskyErr, lsst.pipe.tasks.functors.LocalDipoleMeanFlux, lsst.pipe.tasks.functors.LocalDipoleMeanFluxErr, lsst.pipe.tasks.functors.LocalDipoleDiffFlux, lsst.pipe.tasks.functors.LocalDipoleDiffFluxErr, lsst.pipe.tasks.functors.Ebv, and lsst.pipe.tasks.functors.ReferenceBand.
Definition at line 288 of file functors.py.
|
protected |
Return columnIndex.
Definition at line 291 of file functors.py.
|
protected |
Retrieve DataFrame necessary for calculation. The data argument can be a `~pandas.DataFrame`, a `~lsst.daf.butler.DeferredDatasetHandle`, or an `~lsst.pipe.base.InMemoryDatasetHandle`. Returns a DataFrame upon which `self._func` can act.
Definition at line 299 of file functors.py.
|
protected |
Gets the content of each of the column levels for a multilevel table.
Definition at line 201 of file functors.py.
|
protected |
Gets the names of the column index levels. This should only be called in the context of a multilevel table. Parameters ---------- data : various The data to be read, can be a `~lsst.daf.butler.DeferredDatasetHandle` or `~lsst.pipe.base.InMemoryDatasetHandle`. columnIndex (optional): pandas `~pandas.Index` object If not passed, then it is read from the `~lsst.daf.butler.DeferredDatasetHandle` for `~lsst.pipe.base.InMemoryDatasetHandle`.
Definition at line 181 of file functors.py.
|
protected |
Definition at line 337 of file functors.py.
lsst.pipe.tasks.functors.Functor.columns | ( | self | ) |
Columns required to perform calculation.
Reimplemented in lsst.pipe.tasks.functors.CompositeFunctor, lsst.pipe.tasks.functors.CustomFunctor, lsst.pipe.tasks.functors.Column, lsst.pipe.tasks.functors.Mag, lsst.pipe.tasks.functors.MagErr, lsst.pipe.tasks.functors.MagDiff, lsst.pipe.tasks.functors.Color, lsst.pipe.tasks.functors.E1, lsst.pipe.tasks.functors.E2, lsst.pipe.tasks.functors.RadiusFromQuadrupole, lsst.pipe.tasks.functors.ComputePixelScale, lsst.pipe.tasks.functors.ConvertPixelToArcseconds, lsst.pipe.tasks.functors.ConvertPixelSqToArcsecondsSq, lsst.pipe.tasks.functors.ReferenceBand, lsst.pipe.tasks.functors.Photometry, lsst.pipe.tasks.functors.NanoJanskyErr, lsst.pipe.tasks.functors.LocalNanojansky, lsst.pipe.tasks.functors.LocalNanojanskyErr, lsst.pipe.tasks.functors.LocalDipoleMeanFlux, lsst.pipe.tasks.functors.LocalDipoleMeanFluxErr, lsst.pipe.tasks.functors.LocalDipoleDiffFlux, and lsst.pipe.tasks.functors.LocalDipoleDiffFluxErr.
Definition at line 175 of file functors.py.
lsst.pipe.tasks.functors.Functor.difference | ( | self, | |
data1, | |||
data2, | |||
** | kwargs ) |
Computes difference between functor called on two different DataFrame/Handle objects.
Definition at line 357 of file functors.py.
lsst.pipe.tasks.functors.Functor.fail | ( | self, | |
df ) |
Definition at line 363 of file functors.py.
lsst.pipe.tasks.functors.Functor.multilevelColumns | ( | self, | |
data, | |||
columnIndex = None, | |||
returnTuple = False ) |
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 in lsst.pipe.tasks.functors.CompositeFunctor, and lsst.pipe.tasks.functors.Color.
Definition at line 234 of file functors.py.
lsst.pipe.tasks.functors.Functor.name | ( | self | ) |
Full name of functor (suitable for figure labels).
Reimplemented in lsst.pipe.tasks.functors.CustomFunctor, lsst.pipe.tasks.functors.Column, lsst.pipe.tasks.functors.Mag, lsst.pipe.tasks.functors.MagErr, lsst.pipe.tasks.functors.MagDiff, lsst.pipe.tasks.functors.Color, lsst.pipe.tasks.functors.ConvertPixelToArcseconds, lsst.pipe.tasks.functors.ConvertPixelSqToArcsecondsSq, lsst.pipe.tasks.functors.Photometry, lsst.pipe.tasks.functors.LocalNanojansky, lsst.pipe.tasks.functors.LocalNanojanskyErr, lsst.pipe.tasks.functors.LocalDipoleMeanFlux, lsst.pipe.tasks.functors.LocalDipoleMeanFluxErr, lsst.pipe.tasks.functors.LocalDipoleDiffFlux, and lsst.pipe.tasks.functors.LocalDipoleDiffFluxErr.
Definition at line 367 of file functors.py.
lsst.pipe.tasks.functors.Functor.noDup | ( | self | ) |
Do not explode by band if used on object table.
Definition at line 167 of file functors.py.
lsst.pipe.tasks.functors.Functor.shortname | ( | self | ) |
Short name of functor (suitable for column name/dict key).
Reimplemented in lsst.pipe.tasks.functors.MagDiff, and lsst.pipe.tasks.functors.Color.
Definition at line 372 of file functors.py.
|
staticprotected |
Definition at line 156 of file functors.py.
|
staticprotected |
Definition at line 158 of file functors.py.
|
staticprotected |
Definition at line 157 of file functors.py.
|
protected |
Definition at line 163 of file functors.py.
lsst.pipe.tasks.functors.Functor.dataset |
Definition at line 162 of file functors.py.
lsst.pipe.tasks.functors.Functor.filt |
Reimplemented in lsst.pipe.tasks.functors.CompositeFunctor, lsst.pipe.tasks.functors.Color, lsst.pipe.tasks.functors.CompositeFunctor, and lsst.pipe.tasks.functors.Color.
Definition at line 161 of file functors.py.
lsst.pipe.tasks.functors.Functor.log |
Definition at line 164 of file functors.py.
lsst.pipe.tasks.functors.Functor.name |
Reimplemented in lsst.pipe.tasks.functors.CustomFunctor, lsst.pipe.tasks.functors.Column, lsst.pipe.tasks.functors.Mag, lsst.pipe.tasks.functors.MagErr, lsst.pipe.tasks.functors.MagDiff, lsst.pipe.tasks.functors.Color, lsst.pipe.tasks.functors.ConvertPixelToArcseconds, lsst.pipe.tasks.functors.ConvertPixelSqToArcsecondsSq, lsst.pipe.tasks.functors.Photometry, lsst.pipe.tasks.functors.LocalNanojansky, lsst.pipe.tasks.functors.LocalNanojanskyErr, lsst.pipe.tasks.functors.LocalDipoleMeanFlux, lsst.pipe.tasks.functors.LocalDipoleMeanFluxErr, lsst.pipe.tasks.functors.LocalDipoleDiffFlux, and lsst.pipe.tasks.functors.LocalDipoleDiffFluxErr.
Definition at line 350 of file functors.py.