lsst.pipe.tasks.functors.MagDiff Class Reference

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

Public Member Functions
	__init__ (self, col1, col2, **kwargs)
	columns (self)
	name (self)
	shortname (self)

Public Attributes
	col1
	col2

Protected Member Functions
	_func (self, df)

Static Protected Attributes
str	_defaultDataset = 'meas'

Detailed Description

Functor to calculate magnitude difference.

Definition at line 875 of file functors.py.

Constructor & Destructor Documentation

__init__()

lsst.pipe.tasks.functors.MagDiff.__init__	(		self,
			col1,
			col2,
		**	kwargs )

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

Definition at line 879 of file functors.py.

    def __init__(self, col1, col2, **kwargs):
        self.col1 = fluxName(col1)
        self.col2 = fluxName(col2)
        super().__init__(**kwargs)
 

Member Function Documentation

_func()

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

protected

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

Definition at line 888 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.col1]/df[self.col2])
 

columns()

lsst.pipe.tasks.functors.MagDiff.columns

(

self

)

Columns required to perform calculation.

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

Definition at line 885 of file functors.py.

    def columns(self):
        return [self.col1, self.col2]
 

name()

lsst.pipe.tasks.functors.MagDiff.name

(

self

)

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

Definition at line 895 of file functors.py.

    def name(self):
        return f'(mag_{self.col1} - mag_{self.col2})'
 

shortname()

lsst.pipe.tasks.functors.MagDiff.shortname

(

self

)

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

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

Definition at line 899 of file functors.py.

    def shortname(self):
        return f'magDiff_{self.col1}_{self.col2}'
 
 

Member Data Documentation

_defaultDataset

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

staticprotected

Definition at line 877 of file functors.py.

col1

lsst.pipe.tasks.functors.MagDiff.col1

Definition at line 880 of file functors.py.

col2

lsst.pipe.tasks.functors.MagDiff.col2

Definition at line 881 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/g14a832a312+9d12ad093c/python/lsst/pipe/tasks/functors.py