LSST Applications g013ef56533+63812263fb,g083dd6704c+a047e97985,g199a45376c+0ba108daf9,g1fd858c14a+fde7a7a78c,g210f2d0738+db0c280453,g262e1987ae+abed931625,g29ae962dfc+058d1915d8,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+64337f1634,g47891489e3+f459a6810c,g53246c7159+8c5ae1fdc5,g54cd7ddccb+890c8e1e5d,g5a60e81ecd+d9e514a434,g64539dfbff+db0c280453,g67b6fd64d1+f459a6810c,g6ebf1fc0d4+8c5ae1fdc5,g7382096ae9+36d16ea71a,g74acd417e5+c70e70fbf6,g786e29fd12+668abc6043,g87389fa792+8856018cbb,g89139ef638+f459a6810c,g8d7436a09f+1b779678e3,g8ea07a8fe4+81eaaadc04,g90f42f885a+34c0557caf,g97be763408+9583a964dd,g98a1a72a9c+028271c396,g98df359435+530b675b85,gb8cb2b794d+4e54f68785,gbf99507273+8c5ae1fdc5,gc2a301910b+db0c280453,gca7fc764a6+f459a6810c,gd7ef33dd92+f459a6810c,gdab6d2f7ff+c70e70fbf6,ge410e46f29+f459a6810c,ge41e95a9f2+db0c280453,geaed405ab2+e3b4b2a692,gf9a733ac38+8c5ae1fdc5,w.2025.43
LSST Data Management Base Package
Loading...
Searching...
No Matches
lsst.dax.apdb.pixelization.Pixelization Class Reference

Public Member Functions

 __init__ (self, str pixelization, int pix_level, int pix_max_ranges)
 
list[int] pixels (self, sphgeom.Region region)
 
int pixel (self, sphgeom.UnitVector3d direction)
 
sphgeom.Region region (self, int pixel)
 
list[tuple[int, int]] envelope (self, sphgeom.Region region)
 

Public Attributes

 pixelator = sphgeom.HtmPixelization(pix_level)
 

Protected Attributes

int _pix_max_ranges = pix_max_ranges
 
bool _is_healpix = False
 

Detailed Description

Wrapper for pixelization classes from `sphgeom` with configurable
pixelization type and parameters.

Parameters
----------
pixelization : `str`
    Name of a pixelization type, one of ""htm", "q3c", "mq3c", or
    "healpix".
pix_level : `int`
    Pixelization level.
pix_max_ranges : `int`
    Maximum number of ranges returned from `envelope()` method.

Definition at line 33 of file pixelization.py.

Constructor & Destructor Documentation

◆ __init__()

lsst.dax.apdb.pixelization.Pixelization.__init__ ( self,
str pixelization,
int pix_level,
int pix_max_ranges )

Definition at line 48 of file pixelization.py.

48 def __init__(self, pixelization: str, pix_level: int, pix_max_ranges: int):
49 self._pix_max_ranges = pix_max_ranges
50 self._is_healpix = False
51
52 if pixelization == "htm":
53 self.pixelator = sphgeom.HtmPixelization(pix_level)
54 elif pixelization == "q3c":
55 self.pixelator = sphgeom.Q3cPixelization(pix_level)
56 elif pixelization == "mq3c":
57 self.pixelator = sphgeom.Mq3cPixelization(pix_level)
58 elif pixelization == "healpix":
59 # Healpix does not support maxRanges.
60 self._pix_max_ranges = 0
61 self._is_healpix = True
62 self.pixelator = sphgeom.HealpixPixelization(pix_level)
63 else:
64 raise ValueError(f"unknown pixelization: {pixelization}")
65

Member Function Documentation

◆ envelope()

list[tuple[int, int]] lsst.dax.apdb.pixelization.Pixelization.envelope ( self,
sphgeom.Region region )
Generate a set of HTM indices covering specified region.

Parameters
----------
region: `sphgeom.Region`
    Region that needs to be indexed.

Returns
-------
ranges : `list` of `tuple`
    Sequence of ranges, range is a tuple (minHtmID, maxHtmID).

Definition at line 107 of file pixelization.py.

107 def envelope(self, region: sphgeom.Region) -> list[tuple[int, int]]:
108 """Generate a set of HTM indices covering specified region.
109
110 Parameters
111 ----------
112 region: `sphgeom.Region`
113 Region that needs to be indexed.
114
115 Returns
116 -------
117 ranges : `list` of `tuple`
118 Sequence of ranges, range is a tuple (minHtmID, maxHtmID).
119 """
120 _LOG.debug("region: %s", region)
121 indices = self.pixelator.envelope(region, self._pix_max_ranges)
122
123 if _LOG.isEnabledFor(logging.DEBUG):
124 for irange in indices.ranges():
125 _LOG.debug(
126 "range: %s %s",
127 self.pixelator.toString(irange[0]),
128 self.pixelator.toString(irange[1]),
129 )
130
131 return indices.ranges()

◆ pixel()

int lsst.dax.apdb.pixelization.Pixelization.pixel ( self,
sphgeom.UnitVector3d direction )
Compute the index of the pixel for given direction.

Parameters
----------
direction : `lsst.sphgeom.UnitVector3d`

Definition at line 81 of file pixelization.py.

81 def pixel(self, direction: sphgeom.UnitVector3d) -> int:
82 """Compute the index of the pixel for given direction.
83
84 Parameters
85 ----------
86 direction : `lsst.sphgeom.UnitVector3d`
87 """
88 index = self.pixelator.index(direction)
89 return index
90

◆ pixels()

list[int] lsst.dax.apdb.pixelization.Pixelization.pixels ( self,
sphgeom.Region region )
Compute set of the pixel indices for given region.

Parameters
----------
region : `lsst.sphgeom.Region`

Definition at line 66 of file pixelization.py.

66 def pixels(self, region: sphgeom.Region) -> list[int]:
67 """Compute set of the pixel indices for given region.
68
69 Parameters
70 ----------
71 region : `lsst.sphgeom.Region`
72 """
73 # We want finest set of pixels, so ask as many pixel as reasonable, but
74 # healpix does not support non-zero maxRanges.
75 ranges = self.pixelator.envelope(region, 0 if self._is_healpix else 1_000_000)
76 indices = []
77 for lower, upper in ranges:
78 indices += list(range(lower, upper))
79 return indices
80

◆ region()

sphgeom.Region lsst.dax.apdb.pixelization.Pixelization.region ( self,
int pixel )
Return region corresponding to a pixel index.

Parameters
----------
pixel : `int`
    Pixel index.

Returns
-------
region : `lsst.sphgeom.Region`
    Region for a given pixel index.

Definition at line 91 of file pixelization.py.

91 def region(self, pixel: int) -> sphgeom.Region:
92 """Return region corresponding to a pixel index.
93
94 Parameters
95 ----------
96 pixel : `int`
97 Pixel index.
98
99 Returns
100 -------
101 region : `lsst.sphgeom.Region`
102 Region for a given pixel index.
103 """
104 region = self.pixelator.pixel(pixel)
105 return region
106

Member Data Documentation

◆ _is_healpix

bool lsst.dax.apdb.pixelization.Pixelization._is_healpix = False
protected

Definition at line 50 of file pixelization.py.

◆ _pix_max_ranges

int lsst.dax.apdb.pixelization.Pixelization._pix_max_ranges = pix_max_ranges
protected

Definition at line 49 of file pixelization.py.

◆ pixelator

lsst.dax.apdb.pixelization.Pixelization.pixelator = sphgeom.HtmPixelization(pix_level)

Definition at line 53 of file pixelization.py.


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