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)
	noDup (self)
	multilevelColumns (self, data, columnIndex=None, returnTuple=False)
	__call__ (self, data, dropna=False)
	difference (self, data1, data2, **kwargs)
	fail (self, df)
	shortname (self)

Public Attributes
int	fluxMag0Err = 0.
	col = fluxName(col)
float	fluxMag0 = 63095734448.0194
	filt = filt
str	dataset = dataset if dataset is not None else self._defaultDataset
	log = logging.getLogger(type(self).__name__)

Protected Member Functions
	_func (self, df)
	_get_data_columnLevels (self, data, columnIndex=None)
	_get_data_columnLevelNames (self, data, columnIndex=None)
	_colsFromDict (self, colDict, columnIndex=None)
	_get_columnIndex (self, data)
	_get_data (self, data)
	_setLevels (self, df)
	_dropna (self, vals)

Protected Attributes
	_noDup = noDup

Static Protected Attributes
str	_defaultDataset = 'ref'
tuple	_dfLevels = ('column',)
bool	_defaultNoDup = False

Detailed Description

Compute calibrated magnitude uncertainty.

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

Definition at line 874 of file functors.py.

Constructor & Destructor Documentation

__init__()

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

Definition at line 883 of file functors.py.

Member Function Documentation

__call__()

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

inherited

Definition at line 353 of file functors.py.

_colsFromDict()

lsst.pipe.tasks.functors.Functor._colsFromDict ( self, colDict, columnIndex = None )

protectedinherited

Converts dictionary column specficiation to a list of columns.

Definition at line 223 of file functors.py.

_dropna()

lsst.pipe.tasks.functors.Functor._dropna ( self, vals )

protectedinherited

Definition at line 350 of file functors.py.

_func()

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

protected

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

Definition at line 892 of file functors.py.

_get_columnIndex()

lsst.pipe.tasks.functors.Functor._get_columnIndex ( self, data )

protectedinherited

Return columnIndex.

Definition at line 299 of file functors.py.

_get_data()

lsst.pipe.tasks.functors.Functor._get_data ( self, data )

protectedinherited

Retrieve DataFrame necessary for calculation.

The data argument can be a `~pandas.DataFrame`, a
`~lsst.daf.butler.DeferredDatasetHandle`, or
an `~lsst.pipe.base.InMemoryDatasetHandle`.

Returns a DataFrame upon which `self._func` can act.

Definition at line 307 of file functors.py.

_get_data_columnLevelNames()

lsst.pipe.tasks.functors.Functor._get_data_columnLevelNames ( self, data, columnIndex = None )

protectedinherited

Gets the content of each of the column levels for a multilevel
table.

Definition at line 209 of file functors.py.

_get_data_columnLevels()

lsst.pipe.tasks.functors.Functor._get_data_columnLevels ( self, data, columnIndex = None )

protectedinherited

Gets the names of the column index levels.

This should only be called in the context of a multilevel table.

Parameters
----------
data : various
    The data to be read, can be a
    `~lsst.daf.butler.DeferredDatasetHandle` or
    `~lsst.pipe.base.InMemoryDatasetHandle`.
columnIndex (optional): pandas `~pandas.Index` object
    If not passed, then it is read from the
    `~lsst.daf.butler.DeferredDatasetHandle`
    for `~lsst.pipe.base.InMemoryDatasetHandle`.

Definition at line 189 of file functors.py.

_setLevels()

lsst.pipe.tasks.functors.Functor._setLevels ( self, df )

protectedinherited

Definition at line 345 of file functors.py.

columns()

lsst.pipe.tasks.functors.MagErr.columns

(

self

)

Columns required to perform calculation.

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

Definition at line 889 of file functors.py.

difference()

lsst.pipe.tasks.functors.Functor.difference ( self, data1, data2, ** kwargs )

inherited

Computes difference between functor called on two different
DataFrame/Handle objects.

Definition at line 365 of file functors.py.

fail()

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

inherited

Definition at line 371 of file functors.py.

multilevelColumns()

lsst.pipe.tasks.functors.Functor.multilevelColumns ( self, data, columnIndex = None, returnTuple = False )

inherited

Returns columns needed by functor from multilevel dataset.

To access tables with multilevel column structure, the
`~lsst.daf.butler.DeferredDatasetHandle` or
`~lsst.pipe.base.InMemoryDatasetHandle` needs to be passed
either a list of tuples or a dictionary.

Parameters
----------
data : various
    The data as either `~lsst.daf.butler.DeferredDatasetHandle`, or
    `~lsst.pipe.base.InMemoryDatasetHandle`.
columnIndex (optional): pandas `~pandas.Index` object
    Either passed or read in from
    `~lsst.daf.butler.DeferredDatasetHandle`.
`returnTuple` : `bool`
    If true, then return a list of tuples rather than the column
    dictionary specification.
    This is set to `True` by `CompositeFunctor` in order to be able to
    combine columns from the various component functors.

Reimplemented in lsst.pipe.tasks.functors.Color, and lsst.pipe.tasks.functors.CompositeFunctor.

Definition at line 242 of file functors.py.

name()

lsst.pipe.tasks.functors.MagErr.name

(

self

)

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

Definition at line 903 of file functors.py.

noDup()

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

inherited

Do not explode by band if used on object table.

Definition at line 175 of file functors.py.

shortname()

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

inherited

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

Reimplemented in lsst.pipe.tasks.functors.Color, and lsst.pipe.tasks.functors.MagDiff.

Definition at line 380 of file functors.py.

Member Data Documentation

_defaultDataset

str lsst.pipe.tasks.functors.Functor._defaultDataset = 'ref'

staticprotectedinherited

Definition at line 164 of file functors.py.

_defaultNoDup

bool lsst.pipe.tasks.functors.Functor._defaultNoDup = False

staticprotectedinherited

Definition at line 166 of file functors.py.

_dfLevels

tuple lsst.pipe.tasks.functors.Functor._dfLevels = ('column',)

staticprotectedinherited

Definition at line 165 of file functors.py.

_noDup

lsst.pipe.tasks.functors.Functor._noDup = noDup

protectedinherited

Definition at line 171 of file functors.py.

col

lsst.pipe.tasks.functors.Mag.col = fluxName(col)

inherited

Definition at line 853 of file functors.py.

dataset

str lsst.pipe.tasks.functors.Functor.dataset = dataset if dataset is not None else self._defaultDataset

inherited

Definition at line 170 of file functors.py.

filt

lsst.pipe.tasks.functors.Functor.filt = filt

inherited

Reimplemented in lsst.pipe.tasks.functors.Color, lsst.pipe.tasks.functors.Color, lsst.pipe.tasks.functors.CompositeFunctor, and lsst.pipe.tasks.functors.CompositeFunctor.

Definition at line 169 of file functors.py.

fluxMag0

lsst.pipe.tasks.functors.Mag.fluxMag0 = 63095734448.0194

inherited

Definition at line 855 of file functors.py.

fluxMag0Err

int lsst.pipe.tasks.functors.MagErr.fluxMag0Err = 0.

Definition at line 886 of file functors.py.

log

lsst.pipe.tasks.functors.Functor.log = logging.getLogger(type(self).__name__)

inherited

Definition at line 172 of file functors.py.

---

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

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