Inheritance diagram for lsst.afw.image.exposure._exposureContinued.Exposure:
Public Member Functions | |
| def | __reduce__ (self) |
| def | convertF (self) |
| def | convertD (self) |
| def | getImage (self) |
| def | setImage (self, image) |
| def | getMask (self) |
| def | setMask (self, mask) |
| def | getVariance (self) |
| def | setVariance (self, variance) |
| def | getConvexPolygon (self, padding=10) |
| def | containsSkyCoords (self, ra, dec, padding=10) |
Static Public Attributes | |
| readFitsWithOptions = classmethod(imageReadFitsWithOptions) | |
| writeFitsWithOptions = exposureWriteFitsWithOptions | |
Properties | |
| image = property(getImage, setImage) | |
| mask = property(getMask, setMask) | |
| variance = property(getVariance, setVariance) | |
| convex_polygon = property(getConvexPolygon) | |
Detailed Description
Definition at line 35 of file _exposureContinued.py.
Member Function Documentation
◆ __reduce__()
| def lsst.afw.image.exposure._exposureContinued.Exposure.__reduce__ | ( | self | ) |
Definition at line 63 of file _exposureContinued.py.
◆ containsSkyCoords()
| def lsst.afw.image.exposure._exposureContinued.Exposure.containsSkyCoords | ( | self, | |
| ra, | |||
| dec, | |||
padding = 10 |
|||
| ) |
Check if a set of sky positions is in the pixel bounding box.
The default padding size was chosen to be sufficient for the
most warped detectors at the edges of the HyperSuprimeCam focal plane.
Parameters
----------
ra : `astropy.Quantity`, (N,)
Array of Right Ascension, angular units.
dec : `astropy.Quantity`, (N,)
Array of Declination, angular units.
padding : `int`, optional
Pixel padding to ensure that bounding box is entirely contained
within the sky polygon (see ``getConvexPolygon()``).
Returns
-------
contained : `np.ndarray`, (N,)
Boolean array indicating which points are contained in the
bounding box.
Raises
------
ValueError if exposure does not have a valid wcs.
Definition at line 125 of file _exposureContinued.py.
125 def containsSkyCoords(self, ra, dec, padding=10):
126 """Check if a set of sky positions is in the pixel bounding box.
127
128 The default padding size was chosen to be sufficient for the
129 most warped detectors at the edges of the HyperSuprimeCam focal plane.
130
131 Parameters
132 ----------
133 ra : `astropy.Quantity`, (N,)
134 Array of Right Ascension, angular units.
135 dec : `astropy.Quantity`, (N,)
136 Array of Declination, angular units.
137 padding : `int`, optional
138 Pixel padding to ensure that bounding box is entirely contained
139 within the sky polygon (see ``getConvexPolygon()``).
140
141 Returns
142 -------
143 contained : `np.ndarray`, (N,)
144 Boolean array indicating which points are contained in the
145 bounding box.
146
147 Raises
148 ------
149 ValueError if exposure does not have a valid wcs.
150 """
151 if self.wcs is None:
152 raise ValueError("Exposure does not have a valid WCS.")
153
154 return bbox_contains_sky_coords(
155 self.getBBox(),
156 self.wcs,
157 ra,
158 dec,
159 padding=padding)
160
◆ convertD()
| def lsst.afw.image.exposure._exposureContinued.Exposure.convertD | ( | self | ) |
Definition at line 70 of file _exposureContinued.py.
70 def convertD(self):
71 return ExposureD(self, deep=True)
72
◆ convertF()
| def lsst.afw.image.exposure._exposureContinued.Exposure.convertF | ( | self | ) |
Definition at line 67 of file _exposureContinued.py.
67 def convertF(self):
68 return ExposureF(self, deep=True)
69
◆ getConvexPolygon()
| def lsst.afw.image.exposure._exposureContinued.Exposure.getConvexPolygon | ( | self, | |
padding = 10 |
|||
| ) |
Get the convex polygon associated with the bounding box corners.
The returned polygon has additional padding to ensure that the
bounding box is entirely contained within it. To ensure a set
of coordinates are entirely contained within an exposure, run
``exposure.containsSkyCoords()``. The default padding
size was chosen to be sufficient for the most warped detectors at
the edges of the HyperSuprimeCam focal plane.
Parameters
----------
padding : `int`
Pixel padding to ensure that bounding box is entirely contained
within the resulting polygon.
Returns
-------
convexPolygon : `lsst.sphgeom.ConvexPolygon`
Returns `None` if exposure does not have a valid WCS.
Definition at line 97 of file _exposureContinued.py.
97 def getConvexPolygon(self, padding=10):
98 """Get the convex polygon associated with the bounding box corners.
99
100 The returned polygon has additional padding to ensure that the
101 bounding box is entirely contained within it. To ensure a set
102 of coordinates are entirely contained within an exposure, run
103 ``exposure.containsSkyCoords()``. The default padding
104 size was chosen to be sufficient for the most warped detectors at
105 the edges of the HyperSuprimeCam focal plane.
106
107 Parameters
108 ----------
109 padding : `int`
110 Pixel padding to ensure that bounding box is entirely contained
111 within the resulting polygon.
112
113 Returns
114 -------
115 convexPolygon : `lsst.sphgeom.ConvexPolygon`
116 Returns `None` if exposure does not have a valid WCS.
117 """
118 if self.wcs is None:
119 return None
120
121 return bbox_to_convex_polygon(self.getBBox(), self.wcs, padding=padding)
122
ConvexPolygon is a closed convex polygon on the unit sphere.
Definition: ConvexPolygon.h:57
◆ getImage()
| def lsst.afw.image.exposure._exposureContinued.Exposure.getImage | ( | self | ) |
Definition at line 73 of file _exposureContinued.py.
73 def getImage(self):
74 return self.maskedImage.image
75
◆ getMask()
| def lsst.afw.image.exposure._exposureContinued.Exposure.getMask | ( | self | ) |
Definition at line 81 of file _exposureContinued.py.
81 def getMask(self):
82 return self.maskedImage.mask
83
◆ getVariance()
| def lsst.afw.image.exposure._exposureContinued.Exposure.getVariance | ( | self | ) |
Definition at line 89 of file _exposureContinued.py.
89 def getVariance(self):
90 return self.maskedImage.variance
91
◆ setImage()
| def lsst.afw.image.exposure._exposureContinued.Exposure.setImage | ( | self, | |
| image | |||
| ) |
Definition at line 76 of file _exposureContinued.py.
76 def setImage(self, image):
77 self.maskedImage.image = image
78
◆ setMask()
| def lsst.afw.image.exposure._exposureContinued.Exposure.setMask | ( | self, | |
| mask | |||
| ) |
Definition at line 84 of file _exposureContinued.py.
84 def setMask(self, mask):
85 self.maskedImage.mask = mask
86
◆ setVariance()
| def lsst.afw.image.exposure._exposureContinued.Exposure.setVariance | ( | self, | |
| variance | |||
| ) |
Definition at line 92 of file _exposureContinued.py.
92 def setVariance(self, variance):
93 self.maskedImage.variance = variance
94
Member Data Documentation
◆ readFitsWithOptions
|
static |
Definition at line 161 of file _exposureContinued.py.
◆ writeFitsWithOptions
|
static |
Definition at line 163 of file _exposureContinued.py.
Property Documentation
◆ convex_polygon
|
static |
Definition at line 123 of file _exposureContinued.py.
◆ image
Definition at line 79 of file _exposureContinued.py.
◆ mask
Definition at line 87 of file _exposureContinued.py.
◆ variance
|
static |
Definition at line 95 of file _exposureContinued.py.
The documentation for this class was generated from the following file:
- /j/snowflake/release/lsstsw/stack/lsst-scipipe-5.0.1/Linux64/afw/gf46e8334de+81c9a61069/python/lsst/afw/image/exposure/_exposureContinued.py
