lsst.pipe.tasks.functors.LocalPhotometry Class Reference

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

Public Member Functions
def	__init__ (self, instFluxCol, instFluxErrCol, photoCalibCol, photoCalibErrCol, kwargs)
def	instFluxToNanojansky (self, instFlux, localCalib)
def	instFluxErrToNanojanskyErr (self, instFlux, instFluxErr, localCalib, localCalibErr)
def	instFluxToMagnitude (self, instFlux, localCalib)
def	instFluxErrToMagnitudeErr (self, instFlux, instFluxErr, localCalib, localCalibErr)
def	noDup (self)
def	columns (self)
def	multilevelColumns (self, parq)
def	__call__ (self, parq, dropna=False)
def	fail (self, df)
def	name (self)
def	shortname (self)

Public Attributes
	instFluxCol
	instFluxErrCol
	photoCalibCol
	photoCalibErrCol
	filt
	dataset

Static Public Attributes
	logNJanskyToAB

Detailed Description

Base class for calibrating the specified instrument flux column using
the local photometric calibration.

Parameters
----------
instFluxCol : `str`
    Name of the instrument flux column.
instFluxErrCol : `str`
    Name of the assocated error columns for ``instFluxCol``.
photoCalibCol : `str`
    Name of local calibration column.
photoCalibErrCol : `str`
    Error associated with ``photoCalibCol``

See also
--------
LocalPhotometry
LocalNanojansky
LocalNanojanskyErr
LocalMagnitude
LocalMagnitudeErr

Definition at line 1086 of file functors.py.

Constructor & Destructor Documentation

__init__()

def lsst.pipe.tasks.functors.LocalPhotometry.__init__	(		self,
			instFluxCol,
			instFluxErrCol,
			photoCalibCol,
			photoCalibErrCol,
			kwargs
	)

Definition at line 1116 of file functors.py.

Member Function Documentation

__call__()

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

inherited

Definition at line 177 of file functors.py.

columns()

def lsst.pipe.tasks.functors.Functor.columns (   self )

inherited

Columns required to perform calculation

Definition at line 122 of file functors.py.

fail()

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

inherited

Definition at line 188 of file functors.py.

instFluxErrToMagnitudeErr()

def lsst.pipe.tasks.functors.LocalPhotometry.instFluxErrToMagnitudeErr	(		self,
			instFlux,
			instFluxErr,
			localCalib,
			localCalibErr
	)

Convert instrument flux err to nanojanskys.

Parameters
----------
instFlux : `numpy.ndarray` or `pandas.Series`
    Array of instrument flux measurements
instFluxErr : `numpy.ndarray` or `pandas.Series`
    Errors on associated ``instFlux`` values
localCalib : `numpy.ndarray` or `pandas.Series`
    Array of local photometric calibration estimates.
localCalibErr : `numpy.ndarray` or `pandas.Series`
   Errors on associated ``localCalib`` values

Returns
-------
calibMagErr: `numpy.ndarray` or `pandas.Series`
    Error on calibrated AB magnitudes.

Definition at line 1178 of file functors.py.

instFluxErrToNanojanskyErr()

def lsst.pipe.tasks.functors.LocalPhotometry.instFluxErrToNanojanskyErr	(		self,
			instFlux,
			instFluxErr,
			localCalib,
			localCalibErr
	)

Convert instrument flux to nanojanskys.

Parameters
----------
instFlux : `numpy.ndarray` or `pandas.Series`
    Array of instrument flux measurements
instFluxErr : `numpy.ndarray` or `pandas.Series`
    Errors on associated ``instFlux`` values
localCalib : `numpy.ndarray` or `pandas.Series`
    Array of local photometric calibration estimates.
localCalibErr : `numpy.ndarray` or `pandas.Series`
   Errors on associated ``localCalib`` values

Returns
-------
calibFluxErr : `numpy.ndarray` or `pandas.Series`
    Errors on calibrated flux measurements.

Definition at line 1140 of file functors.py.

instFluxToMagnitude()

def lsst.pipe.tasks.functors.LocalPhotometry.instFluxToMagnitude	(		self,
			instFlux,
			localCalib
	)

Convert instrument flux to nanojanskys.

Parameters
----------
instFlux : `numpy.ndarray` or `pandas.Series`
    Array of instrument flux measurements
localCalib : `numpy.ndarray` or `pandas.Series`
    Array of local photometric calibration estimates.

Returns
-------
calibMag : `numpy.ndarray` or `pandas.Series`
    Array of calibrated AB magnitudes.

Definition at line 1161 of file functors.py.

instFluxToNanojansky()

def lsst.pipe.tasks.functors.LocalPhotometry.instFluxToNanojansky	(		self,
			instFlux,
			localCalib
	)

Convert instrument flux to nanojanskys.

Parameters
----------
instFlux : `numpy.ndarray` or `pandas.Series`
    Array of instrument flux measurements
localCalib : `numpy.ndarray` or `pandas.Series`
    Array of local photometric calibration estimates.

Returns
-------
calibFlux : `numpy.ndarray` or `pandas.Series`
    Array of calibrated flux measurements.

Definition at line 1123 of file functors.py.

multilevelColumns()

def lsst.pipe.tasks.functors.Functor.multilevelColumns (   self,   parq  )

inherited

Definition at line 129 of file functors.py.

name()

def lsst.pipe.tasks.functors.Functor.name (   self )

inherited

Full name of functor (suitable for figure labels)

Definition at line 192 of file functors.py.

noDup()

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

inherited

Definition at line 115 of file functors.py.

shortname()

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

inherited

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

Definition at line 198 of file functors.py.

Member Data Documentation

dataset

lsst.pipe.tasks.functors.Functor.dataset

inherited

Definition at line 111 of file functors.py.

filt

lsst.pipe.tasks.functors.Functor.filt

inherited

Definition at line 110 of file functors.py.

instFluxCol

lsst.pipe.tasks.functors.LocalPhotometry.instFluxCol

Definition at line 1117 of file functors.py.

instFluxErrCol

lsst.pipe.tasks.functors.LocalPhotometry.instFluxErrCol

Definition at line 1118 of file functors.py.

logNJanskyToAB

lsst.pipe.tasks.functors.LocalPhotometry.logNJanskyToAB

static

Definition at line 1109 of file functors.py.

photoCalibCol

lsst.pipe.tasks.functors.LocalPhotometry.photoCalibCol

Definition at line 1119 of file functors.py.

photoCalibErrCol

lsst.pipe.tasks.functors.LocalPhotometry.photoCalibErrCol

Definition at line 1120 of file functors.py.

---

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

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