lsst.pipe.tasks.functors.MagErr Class Reference

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

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

Public Attributes
	fluxMag0Err
	col

Protected Member Functions
	_func (self, df)

Detailed Description

Compute calibrated magnitude uncertainty.

Parameters
----------
col : `str`
    Name of the flux column.

Definition at line 842 of file functors.py.

Constructor & Destructor Documentation

__init__()

lsst.pipe.tasks.functors.MagErr.__init__	(		self,
		*	args,
		**	kwargs )

Reimplemented from lsst.pipe.tasks.functors.Mag.

Definition at line 851 of file functors.py.

    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        # TO DO: DM-21955 Replace hard coded photometic calibration values.
        self.fluxMag0Err = 0.
 

Member Function Documentation

_func()

lsst.pipe.tasks.functors.MagErr._func ( self, df )

protected

Reimplemented from lsst.pipe.tasks.functors.Mag.

Definition at line 860 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')
            fluxCol, fluxErrCol = self.columns
            x = df[fluxErrCol] / df[fluxCol]
            y = self.fluxMag0Err / self.fluxMag0
            magErr = (2.5 / np.log(10.)) * np.sqrt(x*x + y*y)
            return magErr
 

columns()

lsst.pipe.tasks.functors.MagErr.columns

(

self

)

Columns required to perform calculation.

Reimplemented from lsst.pipe.tasks.functors.Mag.

Definition at line 857 of file functors.py.

    def columns(self):
        return [self.col, self.col + 'Err']
 

name()

lsst.pipe.tasks.functors.MagErr.name

(

self

)

Reimplemented from lsst.pipe.tasks.functors.Mag.

Definition at line 871 of file functors.py.

    def name(self):
        return super().name + '_err'
 
 

Member Data Documentation

col

lsst.pipe.tasks.functors.MagErr.col

Definition at line 858 of file functors.py.

fluxMag0Err

lsst.pipe.tasks.functors.MagErr.fluxMag0Err

Definition at line 854 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/gc07e1c2157+a98bf949bb/python/lsst/pipe/tasks/functors.py