lsst.meas.algorithms  14.0-21-ge7d40960+1
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
lsst.meas.algorithms.htmIndexer.HtmIndexer Class Reference
Inheritance diagram for lsst.meas.algorithms.htmIndexer.HtmIndexer:

Public Member Functions

def __init__ (self, depth=8)
 Construct the indexer object. More...
 
def get_pixel_ids (self, ctrCoord, radius)
 Get all shards that touch a circular aperture. More...
 
def index_points (self, ra_list, dec_list)
 Generate trixel ids for each row in an input file. More...
 

Static Public Member Functions

def make_data_id (pixel_id, dataset_name)
 Make a data id. More...
 

Public Attributes

 htm
 

Detailed Description

Definition at line 28 of file htmIndexer.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.meas.algorithms.htmIndexer.HtmIndexer.__init__ (   self,
  depth = 8 
)

Construct the indexer object.

Parameters
[in]depthdepth of the hierarchy to construct

Definition at line 30 of file htmIndexer.py.

Member Function Documentation

◆ get_pixel_ids()

def lsst.meas.algorithms.htmIndexer.HtmIndexer.get_pixel_ids (   self,
  ctrCoord,
  radius 
)

Get all shards that touch a circular aperture.

Parameters
[in]ctrCoordafwGeom.SpherePoint ICRS center of the aperture
[in]radiusafwGeom.Angle object of the aperture radius
[out]ApipeBase.Struct with the list of shards, shards, and a boolean arry, boundary_mask, indicating whether the shard touches the boundary (True) or is fully contained (False).

Definition at line 37 of file htmIndexer.py.

◆ index_points()

def lsst.meas.algorithms.htmIndexer.HtmIndexer.index_points (   self,
  ra_list,
  dec_list 
)

Generate trixel ids for each row in an input file.

Parameters
[in]ra_listList of RA coordinate in degrees
[in]dec_listList of Dec coordinate in degrees
[out]Alist of pixel ids

Definition at line 54 of file htmIndexer.py.

◆ make_data_id()

def lsst.meas.algorithms.htmIndexer.HtmIndexer.make_data_id (   pixel_id,
  dataset_name 
)
static

Make a data id.

Meant to be overridden.

Parameters
[in]pixel_idAn identifier for the pixel in question.
[in]dataset_nameName of the dataset to use.
[out]dataId(dictionary)

Definition at line 64 of file htmIndexer.py.

Member Data Documentation

◆ htm

lsst.meas.algorithms.htmIndexer.HtmIndexer.htm

Definition at line 35 of file htmIndexer.py.


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