lsst.pipe.tasks  21.0.0-20-g55224fe4+fb58a89680
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.pipe.tasks.functors.ReferenceBand Class Reference
Inheritance diagram for lsst.pipe.tasks.functors.ReferenceBand:
lsst.pipe.tasks.functors.Functor

Public Member Functions

def columns (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 name (self)
 
def shortname (self)
 

Public Attributes

 filt
 
 dataset
 

Static Public Attributes

 name
 
 shortname
 

Detailed Description

Definition at line 1262 of file functors.py.

Member Function Documentation

◆ __call__()

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

Definition at line 318 of file functors.py.

◆ columns()

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

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

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

◆ fail()

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

Definition at line 334 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.Functor.name (   self)
inherited

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

Member Data Documentation

◆ dataset

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

Definition at line 120 of file functors.py.

◆ filt

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

Definition at line 119 of file functors.py.

◆ name

lsst.pipe.tasks.functors.ReferenceBand.name
static

Definition at line 1263 of file functors.py.

◆ shortname

lsst.pipe.tasks.functors.ReferenceBand.shortname
static

Definition at line 1264 of file functors.py.


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