HtmIndex20¶
- class lsst.pipe.tasks.functors.HtmIndex20(ra, dec, **kwargs)¶
Bases:
Functor
Compute the level 20 HtmIndex for the catalog.
Notes
This functor was implemented to satisfy requirements of old APDB interface which required the
pixelId
column in DiaObject with HTM20 index. The APDB interface had migrated to not need that information, but we keep this class in case it may be useful for something else.Attributes Summary
Columns required to perform calculation.
Do not explode by band if used on object table.
Short name of functor (suitable for column name/dict key).
Methods Summary
__call__
(data[, dropna])Call self as a function.
difference
(data1, data2, **kwargs)Computes difference between functor called on two different DataFrame/Handle objects.
fail
(df)multilevelColumns
(data[, columnIndex, ...])Returns columns needed by functor from multilevel dataset.
Attributes Documentation
- columns¶
Columns required to perform calculation.
- htmLevel = 20¶
- name = 'Htm20'¶
- noDup¶
Do not explode by band if used on object table.
- shortname¶
Short name of functor (suitable for column name/dict key).
Methods Documentation
- __call__(data, dropna=False)¶
Call self as a function.
- difference(data1, data2, **kwargs)¶
Computes difference between functor called on two different DataFrame/Handle objects.
- fail(df)¶
- multilevelColumns(data, columnIndex=None, returnTuple=False)¶
Returns columns needed by functor from multilevel dataset.
To access tables with multilevel column structure, the
DeferredDatasetHandle
orInMemoryDatasetHandle
needs to be passed either a list of tuples or a dictionary.- Parameters:
- datavarious
The data as either
DeferredDatasetHandle
, orInMemoryDatasetHandle
.- columnIndex (optional): pandas `~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
byCompositeFunctor
in order to be able to combine columns from the various component functors.