lsst.pipe.tasks  21.0.0-144-g164d2715+d0f8c65ef8
Public Member Functions | Public Attributes | List of all members
lsst.pipe.tasks.functors.Mag Class Reference
Inheritance diagram for lsst.pipe.tasks.functors.Mag:
lsst.pipe.tasks.functors.Functor lsst.pipe.tasks.functors.MagErr lsst.pipe.tasks.functors.NanoMaggie

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
 

Detailed Description

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 757 of file functors.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.pipe.tasks.functors.Mag.__init__ (   self,
  col,
  calib = None,
**  kwargs 
)

Definition at line 783 of file functors.py.

Member Function Documentation

◆ __call__()

def lsst.pipe.tasks.functors.Functor.__call__ (   self,
  data,
  dropna = False 
)
inherited

Definition at line 340 of file functors.py.

◆ columns()

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 795 of file functors.py.

◆ difference()

def lsst.pipe.tasks.functors.Functor.difference (   self,
  data1,
  data2,
**  kwargs 
)
inherited
Computes difference between functor called on two different ParquetTable objects

Definition at line 351 of file functors.py.

◆ fail()

def lsst.pipe.tasks.functors.Functor.fail (   self,
  df 
)
inherited

Definition at line 356 of file functors.py.

◆ multilevelColumns()

def lsst.pipe.tasks.functors.Functor.multilevelColumns (   self,
  data,
  columnIndex = None,
  returnTuple = False 
)
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.

◆ name()

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 805 of file functors.py.

◆ noDup()

def lsst.pipe.tasks.functors.Functor.noDup (   self)
inherited

Definition at line 148 of file functors.py.

◆ shortname()

def lsst.pipe.tasks.functors.Functor.shortname (   self)
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.

Member Data Documentation

◆ calib

lsst.pipe.tasks.functors.Mag.calib

Definition at line 785 of file functors.py.

◆ col

lsst.pipe.tasks.functors.Mag.col

Definition at line 784 of file functors.py.

◆ dataset

lsst.pipe.tasks.functors.Functor.dataset
inherited

Definition at line 144 of file functors.py.

◆ filt

lsst.pipe.tasks.functors.Functor.filt
inherited

Definition at line 143 of file functors.py.

◆ fluxMag0

lsst.pipe.tasks.functors.Mag.fluxMag0

Definition at line 787 of file functors.py.


The documentation for this class was generated from the following file: