lsst.pipe.tasks  21.0.0-72-gffa78901+203d280ace
Public Member Functions | Public Attributes | List of all members
lsst.pipe.tasks.functors.Ratio Class Reference
Inheritance diagram for lsst.pipe.tasks.functors.Ratio:
lsst.pipe.tasks.functors.Functor

Public Member Functions

def __init__ (self, numerator, denominator, **kwargs)
 
def columns (self)
 
def name (self)
 
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

 numerator
 
 denominator
 
 filt
 
 dataset
 

Detailed Description

Base class for returning the ratio of 2 columns.

Can be used to compute a Signal to Noise ratio for any input flux.

Parameters
----------
numerator : `str`
    Name of the column to use at the numerator in the ratio
denominator : `str`
    Name of the column to use as the denominator in the ratio.

Definition at line 1792 of file functors.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.pipe.tasks.functors.Ratio.__init__ (   self,
  numerator,
  denominator,
**  kwargs 
)

Definition at line 1804 of file functors.py.

Member Function Documentation

◆ __call__()

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

Definition at line 322 of file functors.py.

◆ columns()

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

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

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

◆ fail()

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

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

◆ name()

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

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

Definition at line 1817 of file functors.py.

◆ noDup()

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

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

Member Data Documentation

◆ dataset

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

Definition at line 120 of file functors.py.

◆ denominator

lsst.pipe.tasks.functors.Ratio.denominator

Definition at line 1809 of file functors.py.

◆ filt

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

Definition at line 119 of file functors.py.

◆ numerator

lsst.pipe.tasks.functors.Ratio.numerator

Definition at line 1808 of file functors.py.


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