lsst.meas.algorithms gf82c78fb6f+7a01b0dd38
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
lsst.meas.algorithms.htmIndexer.HtmIndexer Class Reference

Public Member Functions

def __init__ (self, depth=7)
 
def getShardIds (self, ctrCoord, radius)
 
def indexPoints (self, raList, decList)
 

Static Public Member Functions

def makeDataId (shardId, datasetName)
 

Public Attributes

 htm
 

Detailed Description

Manage a spatial index of hierarchical triangular mesh (HTM)
shards.

Parameters
----------
depth : `int`
    Depth of the HTM hierarchy to construct.

Definition at line 29 of file htmIndexer.py.

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 38 of file htmIndexer.py.

Member Function Documentation

◆ getShardIds()

def lsst.meas.algorithms.htmIndexer.HtmIndexer.getShardIds (   self,
  ctrCoord,
  radius 
)
Get the IDs of all shards that touch a circular aperture.

Parameters
----------
ctrCoord : `lsst.geom.SpherePoint`
    ICRS center of search region.
radius : `lsst.geom.Angle`
    Radius of search region.

Returns
-------
results : `tuple`
    A tuple containing:

    - shardIdList : `list` of `int`
        List of shard IDs
    - isOnBoundary : `list` of `bool`
        For each shard in ``shardIdList`` is the shard on the
        boundary (not fully enclosed by the search region)?

Definition at line 41 of file htmIndexer.py.

◆ indexPoints()

def lsst.meas.algorithms.htmIndexer.HtmIndexer.indexPoints (   self,
  raList,
  decList 
)
Generate shard IDs for sky positions.

Parameters
----------
raList : `list` of `float`
    List of right ascensions, in degrees.
decList : `list` of `float`
    List of declinations, in degrees.

Returns
-------
shardIds : `list` of `int`
    List of shard IDs

Definition at line 71 of file htmIndexer.py.

◆ makeDataId()

def lsst.meas.algorithms.htmIndexer.HtmIndexer.makeDataId (   shardId,
  datasetName 
)
static
Make a data id from a shard ID.

Parameters
----------
shardId : `int`
    ID of shard in question.
datasetName : `str`
    Name of dataset to use.

Returns
-------
dataId : `dict`
    Data ID for shard.

Definition at line 89 of file htmIndexer.py.

Member Data Documentation

◆ htm

lsst.meas.algorithms.htmIndexer.HtmIndexer.htm

Definition at line 39 of file htmIndexer.py.


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