lsst.pipe.tasks
22.0.1+611137eacc
|
Public Member Functions | |
def | __init__ (self, col, calib=None, **kwargs) |
def | columns (self) |
def | name (self) |
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 | shortname (self) |
Public Attributes | |
col | |
calib | |
fluxMag0 | |
filt | |
dataset | |
Compute calibrated magnitude Takes a `calib` argument, which returns the flux at mag=0 as `calib.getFluxMag0()`. If not provided, then the default `fluxMag0` is 63095734448.0194, which is default for HSC. This default should be removed in DM-21955 This calculation hides warnings about invalid values and dividing by zero. As for all functors, a `dataset` and `filt` kwarg should be provided upon initialization. Unlike the default `Functor`, however, the default dataset for a `Mag` is `'meas'`, rather than `'ref'`. Parameters ---------- col : `str` Name of flux column from which to compute magnitude. Can be parseable by `lsst.pipe.tasks.functors.fluxName` function---that is, you can pass `'modelfit_CModel'` instead of `'modelfit_CModel_instFlux'`) and it will understand. calib : `lsst.afw.image.calib.Calib` (optional) Object that knows zero point.
Definition at line 696 of file functors.py.
def lsst.pipe.tasks.functors.Mag.__init__ | ( | self, | |
col, | |||
calib = None , |
|||
** | kwargs | ||
) |
Definition at line 722 of file functors.py.
|
inherited |
Definition at line 322 of file functors.py.
def lsst.pipe.tasks.functors.Mag.columns | ( | self | ) |
Columns required to perform calculation
Reimplemented from lsst.pipe.tasks.functors.Functor.
Reimplemented in lsst.pipe.tasks.functors.MagErr.
Definition at line 734 of file functors.py.
|
inherited |
Computes difference between functor called on two different ParquetTable objects
Definition at line 333 of file functors.py.
|
inherited |
Definition at line 338 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.
def lsst.pipe.tasks.functors.Mag.name | ( | self | ) |
Full name of functor (suitable for figure labels)
Reimplemented from lsst.pipe.tasks.functors.Functor.
Reimplemented in lsst.pipe.tasks.functors.MagErr.
Definition at line 744 of file functors.py.
|
inherited |
Definition at line 124 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 348 of file functors.py.
lsst.pipe.tasks.functors.Mag.calib |
Definition at line 724 of file functors.py.
lsst.pipe.tasks.functors.Mag.col |
Definition at line 723 of file functors.py.
|
inherited |
Definition at line 120 of file functors.py.
|
inherited |
Definition at line 119 of file functors.py.
lsst.pipe.tasks.functors.Mag.fluxMag0 |
Definition at line 726 of file functors.py.