lsst.pipe.tasks ge5253750de+2524c5b224
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Protected Member Functions | Static Protected 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

Public Member Functions

 __init__ (self, col, calib=None, **kwargs)
 
 columns (self)
 
 name (self)
 

Public Attributes

 col
 
 calib
 
 fluxMag0
 

Protected Member Functions

 _func (self, df)
 

Static Protected Attributes

str _defaultDataset = 'meas'
 

Detailed Description

Compute calibrated magnitude.

Returns the flux at mag=0.
The default ``fluxMag0`` is 63095734448.0194, which is default for HSC.
TO DO: This default should be made configurable in DM-21955.

This calculation hides warnings about invalid values and dividing by zero.

As with 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 the `~lsst.pipe.tasks.functors.fluxName` function;
    that is, you can pass ``'modelfit_CModel'`` instead of
    ``'modelfit_CModel_instFlux'``, and it will understand.

Definition at line 796 of file functors.py.

Constructor & Destructor Documentation

◆ __init__()

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

Reimplemented from lsst.pipe.tasks.functors.Functor.

Reimplemented in lsst.pipe.tasks.functors.MagErr.

Definition at line 820 of file functors.py.

Member Function Documentation

◆ _func()

lsst.pipe.tasks.functors.Mag._func (   self,
  df 
)
protected

Reimplemented from lsst.pipe.tasks.functors.Functor.

Reimplemented in lsst.pipe.tasks.functors.MagErr.

Definition at line 841 of file functors.py.

◆ columns()

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

◆ name()

lsst.pipe.tasks.functors.Mag.name (   self)

Reimplemented from lsst.pipe.tasks.functors.Functor.

Reimplemented in lsst.pipe.tasks.functors.MagErr.

Definition at line 848 of file functors.py.

Member Data Documentation

◆ _defaultDataset

str lsst.pipe.tasks.functors.Mag._defaultDataset = 'meas'
staticprotected

Definition at line 818 of file functors.py.

◆ calib

lsst.pipe.tasks.functors.Mag.calib

Definition at line 822 of file functors.py.

◆ col

lsst.pipe.tasks.functors.Mag.col

Definition at line 821 of file functors.py.

◆ fluxMag0

lsst.pipe.tasks.functors.Mag.fluxMag0

Definition at line 830 of file functors.py.


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