lsst.pipe.tasks g476e09dbfb+03fbf6579f
Loading...
Searching...
No Matches
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.LocalDipoleMeanFlux lsst.pipe.tasks.functors.LocalNanojansky lsst.pipe.tasks.functors.LocalNanojanskyErr lsst.pipe.tasks.functors.LocalDipoleDiffFlux lsst.pipe.tasks.functors.LocalDipoleDiffFluxErr lsst.pipe.tasks.functors.LocalDipoleMeanFluxErr

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)
 

Public Attributes

 instFluxCol
 
 instFluxErrCol
 
 photoCalibCol
 
 photoCalibErrCol
 

Static Public Attributes

tuple logNJanskyToAB = (1 * u.nJy).to_value(u.ABmag)
 

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
--------
LocalNanojansky
LocalNanojanskyErr

Definition at line 1408 of file functors.py.

Constructor & Destructor Documentation

◆ __init__()

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

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

Reimplemented in lsst.pipe.tasks.functors.LocalDipoleMeanFlux.

Definition at line 1430 of file functors.py.

Member Function Documentation

◆ 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 1497 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 1459 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 1480 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 1442 of file functors.py.

Member Data Documentation

◆ instFluxCol

lsst.pipe.tasks.functors.LocalPhotometry.instFluxCol

Definition at line 1436 of file functors.py.

◆ instFluxErrCol

lsst.pipe.tasks.functors.LocalPhotometry.instFluxErrCol

Definition at line 1437 of file functors.py.

◆ logNJanskyToAB

tuple lsst.pipe.tasks.functors.LocalPhotometry.logNJanskyToAB = (1 * u.nJy).to_value(u.ABmag)
static

Definition at line 1428 of file functors.py.

◆ photoCalibCol

lsst.pipe.tasks.functors.LocalPhotometry.photoCalibCol

Definition at line 1438 of file functors.py.

◆ photoCalibErrCol

lsst.pipe.tasks.functors.LocalPhotometry.photoCalibErrCol

Definition at line 1439 of file functors.py.


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