lsst.pipe.tasks  21.0.0+44ca056b81
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.pipe.tasks.functors.LocalPhotometry Class Reference
Inheritance diagram for lsst.pipe.tasks.functors.LocalPhotometry:
lsst.pipe.tasks.functors.Functor lsst.pipe.tasks.functors.LocalMagnitude lsst.pipe.tasks.functors.LocalMagnitudeErr lsst.pipe.tasks.functors.LocalNanojansky lsst.pipe.tasks.functors.LocalNanojanskyErr

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 difference (self, parq1, parq2, **kwargs)
 
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 1203 of file functors.py.

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 1228 of file functors.py.

Member Function Documentation

◆ __call__()

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

Definition at line 182 of file functors.py.

◆ columns()

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

◆ difference()

def lsst.pipe.tasks.functors.Functor.difference (   self,
  parq1,
  parq2,
**  kwargs 
)
inherited
Computes difference between functor called on two different ParquetTable objects

Definition at line 193 of file functors.py.

◆ fail()

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

Definition at line 198 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 1295 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 1257 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 1278 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 1240 of file functors.py.

◆ multilevelColumns()

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

◆ name()

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

◆ noDup()

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

Definition at line 120 of file functors.py.

◆ shortname()

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

Member Data Documentation

◆ dataset

lsst.pipe.tasks.functors.Functor.dataset
inherited

Definition at line 116 of file functors.py.

◆ filt

lsst.pipe.tasks.functors.Functor.filt
inherited

Definition at line 115 of file functors.py.

◆ instFluxCol

lsst.pipe.tasks.functors.LocalPhotometry.instFluxCol

Definition at line 1229 of file functors.py.

◆ instFluxErrCol

lsst.pipe.tasks.functors.LocalPhotometry.instFluxErrCol

Definition at line 1230 of file functors.py.

◆ logNJanskyToAB

lsst.pipe.tasks.functors.LocalPhotometry.logNJanskyToAB
static

Definition at line 1226 of file functors.py.

◆ photoCalibCol

lsst.pipe.tasks.functors.LocalPhotometry.photoCalibCol

Definition at line 1231 of file functors.py.

◆ photoCalibErrCol

lsst.pipe.tasks.functors.LocalPhotometry.photoCalibErrCol

Definition at line 1232 of file functors.py.


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