LSST Applications g0265f82a02+0e5473021a,g02d81e74bb+0dd8ce4237,g1470d8bcf6+3ea6592b6f,g2079a07aa2+86d27d4dc4,g2305ad1205+5ca4c0b359,g295015adf3+d10818ec9d,g2a9a014e59+6f9be1b9cd,g2bbee38e9b+0e5473021a,g337abbeb29+0e5473021a,g3ddfee87b4+703ba97ebf,g487adcacf7+4fa16da234,g50ff169b8f+96c6868917,g52b1c1532d+585e252eca,g591dd9f2cf+ffa42b374e,g5a732f18d5+53520f316c,g64a986408d+0dd8ce4237,g858d7b2824+0dd8ce4237,g8a8a8dda67+585e252eca,g99cad8db69+d39438377f,g9ddcbc5298+9a081db1e4,ga1e77700b3+15fc3df1f7,ga8c6da7877+f1d96605c8,gb0e22166c9+60f28cb32d,gb6a65358fc+0e5473021a,gba4ed39666+c2a2e4ac27,gbb8dafda3b+e5339d463f,gc120e1dc64+da31e9920e,gc28159a63d+0e5473021a,gcf0d15dbbd+703ba97ebf,gdaeeff99f8+f9a426f77a,ge6526c86ff+889fc9d533,ge79ae78c31+0e5473021a,gee10cc3b42+585e252eca,gf18bd8381d+7268b93478,gff1a9f87cc+0dd8ce4237,w.2024.16
LSST Data Management Base Package
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

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

Static Public Member Functions

 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__()

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

Definition at line 38 of file htmIndexer.py.

38 def __init__(self, depth=7):
39 self.htm = esutil.htm.HTM(depth)
40

Member Function Documentation

◆ getShardIds()

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.

41 def getShardIds(self, ctrCoord, radius):
42 """Get the IDs of all shards that touch a circular aperture.
43
44 Parameters
45 ----------
46 ctrCoord : `lsst.geom.SpherePoint`
47 ICRS center of search region.
48 radius : `lsst.geom.Angle`
49 Radius of search region.
50
51 Returns
52 -------
53 results : `tuple`
54 A tuple containing:
55
56 - shardIdList : `list` of `int`
57 List of shard IDs
58 - isOnBoundary : `list` of `bool`
59 For each shard in ``shardIdList`` is the shard on the
60 boundary (not fully enclosed by the search region)?
61 """
62 shardIdList = self.htm.intersect(ctrCoord.getLongitude().asDegrees(),
63 ctrCoord.getLatitude().asDegrees(),
64 radius.asDegrees(), inclusive=True)
65 coveredShardIdList = self.htm.intersect(ctrCoord.getLongitude().asDegrees(),
66 ctrCoord.getLatitude().asDegrees(),
67 radius.asDegrees(), inclusive=False)
68 isOnBoundary = (shardId not in coveredShardIdList for shardId in shardIdList)
69 return shardIdList, isOnBoundary
70

◆ indexPoints()

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.

71 def indexPoints(self, raList, decList):
72 """Generate shard IDs for sky positions.
73
74 Parameters
75 ----------
76 raList : `list` of `float`
77 List of right ascensions, in degrees.
78 decList : `list` of `float`
79 List of declinations, in degrees.
80
81 Returns
82 -------
83 shardIds : `list` of `int`
84 List of shard IDs
85 """
86 return self.htm.lookup_id(raList, decList)
87

◆ makeDataId()

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.

89 def makeDataId(shardId, datasetName):
90 """Make a data id from a shard ID.
91
92 Parameters
93 ----------
94 shardId : `int`
95 ID of shard in question.
96 datasetName : `str`
97 Name of dataset to use.
98
99 Returns
100 -------
101 dataId : `dict`
102 Data ID for shard.
103 """
104 if shardId is None:
105 # NoneType doesn't format, so make dummy pixel
106 shardId = 0
107 return {'pixel_id': shardId, 'name': datasetName}

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: