lsst.pipe.tasks 21.0.0-175-g7497abfa+2a6ce44392
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)
 

Public Attributes

 numerator
 
 denominator
 

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

Constructor & Destructor Documentation

◆ __init__()

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

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

Definition at line 1881 of file functors.py.

Member Function Documentation

◆ columns()

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

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

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

Member Data Documentation

◆ denominator

lsst.pipe.tasks.functors.Ratio.denominator

Definition at line 1886 of file functors.py.

◆ numerator

lsst.pipe.tasks.functors.Ratio.numerator

Definition at line 1885 of file functors.py.


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