lsst.pipe.tasks  21.0.0-139-g4e3796b1+cd1a46c8e4
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.pipe.tasks.functors.LocalDipoleMeanFlux Class Reference
Inheritance diagram for lsst.pipe.tasks.functors.LocalDipoleMeanFlux:
lsst.pipe.tasks.functors.LocalPhotometry lsst.pipe.tasks.functors.Functor lsst.pipe.tasks.functors.LocalDipoleDiffFlux lsst.pipe.tasks.functors.LocalDipoleDiffFluxErr lsst.pipe.tasks.functors.LocalDipoleMeanFluxErr

Public Member Functions

def __init__ (self, instFluxPosCol, instFluxNegCol, instFluxPosErrCol, instFluxNegErrCol, photoCalibCol, photoCalibErrCol, **kwargs)
 
def columns (self)
 
def name (self)
 
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 multilevelColumns (self, data, columnIndex=None, returnTuple=False)
 
def __call__ (self, data, dropna=False)
 
def difference (self, data1, data2, **kwargs)
 
def fail (self, df)
 
def shortname (self)
 

Public Attributes

 instFluxNegCol
 
 instFluxPosCol
 
 instFluxNegErrCol
 
 instFluxPosErrCol
 
 photoCalibCol
 
 photoCalibErrCol
 
 instFluxCol
 
 instFluxErrCol
 
 filt
 
 dataset
 

Static Public Attributes

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

Detailed Description

Compute absolute mean of dipole fluxes.

See also
--------
LocalNanojansky
LocalNanojanskyErr
LocalMagnitude
LocalMagnitudeErr
LocalDipoleMeanFlux
LocalDipoleMeanFluxErr
LocalDipoleDiffFlux
LocalDipoleDiffFluxErr

Definition at line 1667 of file functors.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.pipe.tasks.functors.LocalDipoleMeanFlux.__init__ (   self,
  instFluxPosCol,
  instFluxNegCol,
  instFluxPosErrCol,
  instFluxNegErrCol,
  photoCalibCol,
  photoCalibErrCol,
**  kwargs 
)

Definition at line 1681 of file functors.py.

Member Function Documentation

◆ __call__()

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

Definition at line 344 of file functors.py.

◆ columns()

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

◆ difference()

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

Definition at line 355 of file functors.py.

◆ fail()

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

Definition at line 360 of file functors.py.

◆ instFluxErrToMagnitudeErr()

def lsst.pipe.tasks.functors.LocalPhotometry.instFluxErrToMagnitudeErr (   self,
  instFlux,
  instFluxErr,
  localCalib,
  localCalibErr 
)
inherited
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 1545 of file functors.py.

◆ instFluxErrToNanojanskyErr()

def lsst.pipe.tasks.functors.LocalPhotometry.instFluxErrToNanojanskyErr (   self,
  instFlux,
  instFluxErr,
  localCalib,
  localCalibErr 
)
inherited
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 1507 of file functors.py.

◆ instFluxToMagnitude()

def lsst.pipe.tasks.functors.LocalPhotometry.instFluxToMagnitude (   self,
  instFlux,
  localCalib 
)
inherited
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 1528 of file functors.py.

◆ instFluxToNanojansky()

def lsst.pipe.tasks.functors.LocalPhotometry.instFluxToNanojansky (   self,
  instFlux,
  localCalib 
)
inherited
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 1490 of file functors.py.

◆ multilevelColumns()

def 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 `MultilevelParquetTable`
or `DeferredDatasetHandle` need to be passed either a list of tuples or a
dictionary.

Parameters
----------
data : `MultilevelParquetTable` or `DeferredDatasetHandle`

columnIndex (optional): pandas `Index` object
    either passed or read in from `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.

Definition at line 227 of file functors.py.

◆ name()

def lsst.pipe.tasks.functors.LocalDipoleMeanFlux.name (   self)
Full name of functor (suitable for figure labels)

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

Reimplemented in lsst.pipe.tasks.functors.LocalDipoleDiffFluxErr, lsst.pipe.tasks.functors.LocalDipoleDiffFlux, and lsst.pipe.tasks.functors.LocalDipoleMeanFluxErr.

Definition at line 1708 of file functors.py.

◆ noDup()

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

Definition at line 146 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 370 of file functors.py.

Member Data Documentation

◆ dataset

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

Definition at line 142 of file functors.py.

◆ filt

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

Definition at line 141 of file functors.py.

◆ instFluxCol

lsst.pipe.tasks.functors.LocalPhotometry.instFluxCol
inherited

Definition at line 1484 of file functors.py.

◆ instFluxErrCol

lsst.pipe.tasks.functors.LocalPhotometry.instFluxErrCol
inherited

Definition at line 1485 of file functors.py.

◆ instFluxNegCol

lsst.pipe.tasks.functors.LocalDipoleMeanFlux.instFluxNegCol

Definition at line 1689 of file functors.py.

◆ instFluxNegErrCol

lsst.pipe.tasks.functors.LocalDipoleMeanFlux.instFluxNegErrCol

Definition at line 1691 of file functors.py.

◆ instFluxPosCol

lsst.pipe.tasks.functors.LocalDipoleMeanFlux.instFluxPosCol

Definition at line 1690 of file functors.py.

◆ instFluxPosErrCol

lsst.pipe.tasks.functors.LocalDipoleMeanFlux.instFluxPosErrCol

Definition at line 1692 of file functors.py.

◆ logNJanskyToAB

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

Definition at line 1476 of file functors.py.

◆ photoCalibCol

lsst.pipe.tasks.functors.LocalDipoleMeanFlux.photoCalibCol

Definition at line 1693 of file functors.py.

◆ photoCalibErrCol

lsst.pipe.tasks.functors.LocalDipoleMeanFlux.photoCalibErrCol

Definition at line 1694 of file functors.py.


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