lsst.pipe.tasks  21.0.0-152-g8411cc38+e959eeed31
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.pipe.tasks.functors.HtmIndex20 Class Reference
Inheritance diagram for lsst.pipe.tasks.functors.HtmIndex20:
lsst.pipe.tasks.functors.Functor

Public Member Functions

def __init__ (self, ra, decl, **kwargs)
 
def noDup (self)
 
def columns (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

 pixelator
 
 ra
 
 decl
 
 filt
 
 dataset
 

Static Public Attributes

string name = "Htm20"
 
int htmLevel = 20
 

Detailed Description

Compute the level 20 HtmIndex for the catalog.

Notes
-----
This functor was implemented to satisfy requirements of old APDB interface
which required ``pixelId`` column in DiaObject with HTM20 index. APDB
interface had migrated to not need that information, but we keep this
class in case it may be useful for something else.

Definition at line 715 of file functors.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.pipe.tasks.functors.HtmIndex20.__init__ (   self,
  ra,
  decl,
**  kwargs 
)

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

◆ 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.

◆ fail()

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

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

◆ 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

◆ dataset

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

Definition at line 144 of file functors.py.

◆ decl

lsst.pipe.tasks.functors.HtmIndex20.decl

Definition at line 732 of file functors.py.

◆ filt

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

Definition at line 143 of file functors.py.

◆ htmLevel

int lsst.pipe.tasks.functors.HtmIndex20.htmLevel = 20
static

Definition at line 726 of file functors.py.

◆ name

string lsst.pipe.tasks.functors.HtmIndex20.name = "Htm20"
static

Definition at line 725 of file functors.py.

◆ pixelator

lsst.pipe.tasks.functors.HtmIndex20.pixelator

Definition at line 730 of file functors.py.

◆ ra

lsst.pipe.tasks.functors.HtmIndex20.ra

Definition at line 731 of file functors.py.


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