lsst.pipe.tasks.functors.Mag Class Reference

Inheritance diagram for lsst.pipe.tasks.functors.Mag:

Public Member Functions
def	__init__ (self, col, calib=None, kwargs)
def	columns (self)
def	name (self)
def	noDup (self)
def	multilevelColumns (self, parq)
def	__call__ (self, parq, dropna=False)
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 502 of file functors.py.

Constructor & Destructor Documentation

__init__()

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

Definition at line 528 of file functors.py.

Member Function Documentation

__call__()

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

inherited

Definition at line 177 of file functors.py.

columns()

def lsst.pipe.tasks.functors.Mag.columns

(

self

)

Definition at line 540 of file functors.py.

fail()

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

inherited

Definition at line 188 of file functors.py.

multilevelColumns()

def lsst.pipe.tasks.functors.Functor.multilevelColumns (   self,   parq  )

inherited

Definition at line 129 of file functors.py.

name()

def lsst.pipe.tasks.functors.Mag.name

(

self

)

Definition at line 550 of file functors.py.

noDup()

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

inherited

Definition at line 115 of file functors.py.

shortname()

def lsst.pipe.tasks.functors.Functor.shortname (   self )

inherited

Short name of functor (suitable for column name/dict key)

Definition at line 198 of file functors.py.

Member Data Documentation

calib

lsst.pipe.tasks.functors.Mag.calib

Definition at line 530 of file functors.py.

col

lsst.pipe.tasks.functors.Mag.col

Definition at line 529 of file functors.py.

dataset

lsst.pipe.tasks.functors.Functor.dataset

inherited

Definition at line 111 of file functors.py.

filt

lsst.pipe.tasks.functors.Functor.filt

inherited

Definition at line 110 of file functors.py.

fluxMag0

lsst.pipe.tasks.functors.Mag.fluxMag0

Definition at line 532 of file functors.py.

---

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

• python/lsst/pipe/tasks/functors.py