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.

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

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.

    def 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)?
        """
        shardIdList = self.htm.intersect(ctrCoord.getLongitude().asDegrees(),
                                         ctrCoord.getLatitude().asDegrees(),
                                         radius.asDegrees(), inclusive=True)
        coveredShardIdList = self.htm.intersect(ctrCoord.getLongitude().asDegrees(),
                                                ctrCoord.getLatitude().asDegrees(),
                                                radius.asDegrees(), inclusive=False)
        isOnBoundary = (shardId not in coveredShardIdList for shardId in shardIdList)
        return shardIdList, isOnBoundary
 

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.

    def 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
        """
        return self.htm.lookup_id(raList, decList)
 

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.

    def makeDataId(shardId, datasetName):
        """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.
        """
        if shardId is None:
            # NoneType doesn't format, so make dummy pixel
            shardId = 0
        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:

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/meas_algorithms/g8f1c07a47a+de51c9b0a5/python/lsst/meas/algorithms/htmIndexer.py