lsst.pipe.tasks  21.0.0-153-gd15f111f+620bfe6b9b
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.pipe.tasks.functors.Magnitude Class Reference
Inheritance diagram for lsst.pipe.tasks.functors.Magnitude:
lsst.pipe.tasks.functors.Photometry lsst.pipe.tasks.functors.Functor

Public Member Functions

def columns (self)
 
def name (self)
 
def hypot (cls, a, b)
 
def dn2flux (self, dn, fluxMag0)
 
def dn2mag (self, dn, fluxMag0)
 
def dn2fluxErr (self, dn, dnErr, fluxMag0, fluxMag0Err)
 
def dn2MagErr (self, dn, dnErr, fluxMag0, fluxMag0Err)
 
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

 vhypot
 
 col
 
 colFluxErr
 
 calib
 
 fluxMag0Err
 
 fluxMag0
 
 filt
 
 dataset
 

Static Public Attributes

tuple AB_FLUX_SCALE = (0 * u.ABmag).to_value(u.nJy)
 
float LOG_AB_FLUX_SCALE = 12.56
 
float FIVE_OVER_2LOG10 = 1.085736204758129569
 
int COADD_ZP = 27
 

Detailed Description

Definition at line 1478 of file functors.py.

Member Function Documentation

◆ __call__()

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

Definition at line 340 of file functors.py.

◆ columns()

def lsst.pipe.tasks.functors.Photometry.columns (   self)
inherited
Columns required to perform calculation

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

Reimplemented in lsst.pipe.tasks.functors.MagnitudeErr, and lsst.pipe.tasks.functors.NanoJanskyErr.

Definition at line 1428 of file functors.py.

◆ 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 351 of file functors.py.

◆ dn2flux()

def lsst.pipe.tasks.functors.Photometry.dn2flux (   self,
  dn,
  fluxMag0 
)
inherited

Definition at line 1444 of file functors.py.

◆ dn2fluxErr()

def lsst.pipe.tasks.functors.Photometry.dn2fluxErr (   self,
  dn,
  dnErr,
  fluxMag0,
  fluxMag0Err 
)
inherited

Definition at line 1453 of file functors.py.

◆ dn2mag()

def lsst.pipe.tasks.functors.Photometry.dn2mag (   self,
  dn,
  fluxMag0 
)
inherited

Definition at line 1447 of file functors.py.

◆ dn2MagErr()

def lsst.pipe.tasks.functors.Photometry.dn2MagErr (   self,
  dn,
  dnErr,
  fluxMag0,
  fluxMag0Err 
)
inherited

Definition at line 1458 of file functors.py.

◆ fail()

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

Definition at line 356 of file functors.py.

◆ hypot()

def lsst.pipe.tasks.functors.Photometry.hypot (   cls,
  a,
  b 
)
inherited

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

◆ name()

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

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

Definition at line 1432 of file functors.py.

◆ noDup()

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

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

Member Data Documentation

◆ AB_FLUX_SCALE

tuple lsst.pipe.tasks.functors.Photometry.AB_FLUX_SCALE = (0 * u.ABmag).to_value(u.nJy)
staticinherited

Definition at line 1407 of file functors.py.

◆ calib

lsst.pipe.tasks.functors.Photometry.calib
inherited

Definition at line 1418 of file functors.py.

◆ COADD_ZP

int lsst.pipe.tasks.functors.Photometry.COADD_ZP = 27
staticinherited

Definition at line 1411 of file functors.py.

◆ col

lsst.pipe.tasks.functors.Photometry.col
inherited

Definition at line 1415 of file functors.py.

◆ colFluxErr

lsst.pipe.tasks.functors.Photometry.colFluxErr
inherited

Definition at line 1416 of file functors.py.

◆ dataset

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

Definition at line 144 of file functors.py.

◆ filt

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

Definition at line 143 of file functors.py.

◆ FIVE_OVER_2LOG10

float lsst.pipe.tasks.functors.Photometry.FIVE_OVER_2LOG10 = 1.085736204758129569
staticinherited

Definition at line 1409 of file functors.py.

◆ fluxMag0

lsst.pipe.tasks.functors.Photometry.fluxMag0
inherited

Definition at line 1422 of file functors.py.

◆ fluxMag0Err

lsst.pipe.tasks.functors.Photometry.fluxMag0Err
inherited

Definition at line 1420 of file functors.py.

◆ LOG_AB_FLUX_SCALE

float lsst.pipe.tasks.functors.Photometry.LOG_AB_FLUX_SCALE = 12.56
staticinherited

Definition at line 1408 of file functors.py.

◆ vhypot

lsst.pipe.tasks.functors.Photometry.vhypot
inherited

Definition at line 1414 of file functors.py.


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