lsst.pipe.tasks.functors.Ratio Class Reference

Inheritance diagram for lsst.pipe.tasks.functors.Ratio:

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

                 **kwargs):
        self.numerator = numerator
        self.denominator = denominator
        super().__init__(**kwargs)
 

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

    def columns(self):
        return [self.numerator, self.denominator]
 

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

    def name(self):
        return f'ratio_{self.numerator}_{self.denominator}'
 

Member Data Documentation

denominator

lsst.pipe.tasks.functors.Ratio.denominator

Definition at line 1910 of file functors.py.

numerator

lsst.pipe.tasks.functors.Ratio.numerator

Definition at line 1909 of file functors.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-5.0.1/Linux64/pipe_tasks/g91fc1fa0cf+82a115f028/python/lsst/pipe/tasks/functors.py