lsst.pipe.tasks.functors.Mag Class Reference

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

Public Member Functions
	__init__ (self, col, **kwargs)
	columns (self)
	name (self)

Public Attributes
	col
	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,
		**	kwargs )

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

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

Definition at line 820 of file functors.py.

    def __init__(self, col, **kwargs):
        self.col = fluxName(col)
        # TO DO: DM-21955 Replace hard coded photometic calibration values.
        self.fluxMag0 = 63095734448.0194
 
        super().__init__(**kwargs)
 

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

    def _func(self, df):
        with warnings.catch_warnings():
            warnings.filterwarnings('ignore', r'invalid value encountered')
            warnings.filterwarnings('ignore', r'divide by zero')
            return -2.5*np.log10(df[self.col] / self.fluxMag0)
 

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

    def columns(self):
        return [self.col]
 

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

    def name(self):
        return f'mag_{self.col}'
 
 

Member Data Documentation

_defaultDataset

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

staticprotected

Definition at line 818 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 823 of file functors.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/pipe_tasks/g2a9a014e59+6f9be1b9cd/python/lsst/pipe/tasks/functors.py