LSST Applications 29.0.1,g0fba68d861+132dd21e0a,g107a963962+1bb9f809a9,g1fd858c14a+005be21cae,g21d47ad084+8a07b29876,g325378336f+5d73323c8f,g330003fc43+40b4eaffc6,g35bb328faa+fcb1d3bbc8,g36ff55ed5b+9c28a42a87,g4e0f332c67+5fbd1e3e73,g53246c7159+fcb1d3bbc8,g60b5630c4e+9c28a42a87,g67b6fd64d1+a38b34ea13,g78460c75b0+2f9a1b4bcd,g786e29fd12+cf7ec2a62a,g7b71ed6315+fcb1d3bbc8,g86c591e316+6b2b2d0295,g8852436030+bf14db0e33,g89139ef638+a38b34ea13,g8b8da53e10+e3777245af,g9125e01d80+fcb1d3bbc8,g989de1cb63+a38b34ea13,g9f1445be69+9c28a42a87,g9f33ca652e+52c8f07962,ga9baa6287d+9c28a42a87,ga9e4eb89a6+9f84bd6575,gabe3b4be73+1e0a283bba,gb037a4e798+f3cbcd26c0,gb1101e3267+e7be8da0f8,gb58c049af0+f03b321e39,gb89ab40317+a38b34ea13,gcf25f946ba+bf14db0e33,gd6cbbdb0b4+bce7f7457e,gd9a9a58781+fcb1d3bbc8,gde0f65d7ad+53d424b1ae,ge278dab8ac+222406d50a,ge410e46f29+a38b34ea13,ge80e9994a3+664d6357dc,gf67bdafdda+a38b34ea13
LSST Data Management Base Package
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | Protected Attributes | Static Protected Attributes | List of all members
lsst.pipe.tasks.scaleZeroPoint.ScaleZeroPointTask Class Reference
Inheritance diagram for lsst.pipe.tasks.scaleZeroPoint.ScaleZeroPointTask:
lsst.pipe.tasks.scaleZeroPoint.SpatialScaleZeroPointTask

Public Member Functions

 __init__ (self, *args, **kwargs)
 
 run (self, exposure, dataRef=None)
 
 computeImageScaler (self, exposure, dataRef=None)
 
 getPhotoCalib (self)
 
 scaleFromPhotoCalib (self, calib)
 
 scaleFromFluxMag0 (self, fluxMag0)
 

Static Public Attributes

 ConfigClass = ScaleZeroPointConfig
 

Protected Attributes

 _photoCalib = afwImage.makePhotoCalibFromCalibZeroPoint(fluxMag0, 0.0)
 

Static Protected Attributes

str _DefaultName = "scaleZeroPoint"
 

Detailed Description

Compute scale factor to scale exposures to a desired photometric zero point.

This simple version assumes that the zero point is spatially invariant.

Definition at line 155 of file scaleZeroPoint.py.

Constructor & Destructor Documentation

◆ __init__()

lsst.pipe.tasks.scaleZeroPoint.ScaleZeroPointTask.__init__ ( self,
* args,
** kwargs )

Definition at line 164 of file scaleZeroPoint.py.

164 def __init__(self, *args, **kwargs):
165 pipeBase.Task.__init__(self, *args, **kwargs)
166
167 # flux at mag=0 is 10^(zeroPoint/2.5) because m = -2.5*log10(F/F0)
168 fluxMag0 = 10**(0.4 * self.config.zeroPoint)
169 self._photoCalib = afwImage.makePhotoCalibFromCalibZeroPoint(fluxMag0, 0.0)
170
lsst::afw::image::makePhotoCalibFromCalibZeroPoint
std::shared_ptr< PhotoCalib > makePhotoCalibFromCalibZeroPoint(double instFluxMag0, double instFluxMag0Err)
Construct a PhotoCalib from the deprecated Calib-style instFluxMag0/instFluxMag0Err values.
Definition PhotoCalib.cc:600

Member Function Documentation

◆ computeImageScaler()

lsst.pipe.tasks.scaleZeroPoint.ScaleZeroPointTask.computeImageScaler ( self,
exposure,
dataRef = None ) 
Compute image scaling object for a given exposure.

Parameters
----------
exposure : `lsst.afw.image.Exposure`
    Exposure for which scaling is desired.
dataRef : `Unknown`, optional
    Data reference for exposure.
    Not used, but in API so that users can switch between spatially variant
    and invariant tasks.

Reimplemented in lsst.pipe.tasks.scaleZeroPoint.SpatialScaleZeroPointTask.

Definition at line 198 of file scaleZeroPoint.py.

198 def computeImageScaler(self, exposure, dataRef=None):
199 """Compute image scaling object for a given exposure.
200
201 Parameters
202 ----------
203 exposure : `lsst.afw.image.Exposure`
204 Exposure for which scaling is desired.
205 dataRef : `Unknown`, optional
206 Data reference for exposure.
207 Not used, but in API so that users can switch between spatially variant
208 and invariant tasks.
209 """
210 scale = self.scaleFromPhotoCalib(exposure.getPhotoCalib()).scale
211 return ImageScaler(scale)
212

◆ getPhotoCalib()

lsst.pipe.tasks.scaleZeroPoint.ScaleZeroPointTask.getPhotoCalib ( self) 
Get desired PhotoCalib.

Returns
-------
calibration : `lsst.afw.image.PhotoCalib`
    Calibration with ``fluxMag0`` set appropriately for config.zeroPoint.

Definition at line 213 of file scaleZeroPoint.py.

213 def getPhotoCalib(self):
214 """Get desired PhotoCalib.
215
216 Returns
217 -------
218 calibration : `lsst.afw.image.PhotoCalib`
219 Calibration with ``fluxMag0`` set appropriately for config.zeroPoint.
220 """
221 return self._photoCalib
222

◆ run()

lsst.pipe.tasks.scaleZeroPoint.ScaleZeroPointTask.run ( self,
exposure,
dataRef = None ) 
Scale the specified exposure to the desired photometric zeropoint.

Parameters
----------
exposure : `lsst.afw.image.Exposure`
    Exposure to scale; masked image is scaled in place.
dataRef : `Unknown`
    Data reference for exposure.
    Not used, but in API so that users can switch between spatially variant
    and invariant tasks.

Returns
-------
result : `lsst.pipe.base.Struct`
    Results as a struct with attributes:

    ``imageScaler``
        The image scaling object used to scale exposure.

Reimplemented in lsst.pipe.tasks.scaleZeroPoint.SpatialScaleZeroPointTask.

Definition at line 171 of file scaleZeroPoint.py.

171 def run(self, exposure, dataRef=None):
172 """Scale the specified exposure to the desired photometric zeropoint.
173
174 Parameters
175 ----------
176 exposure : `lsst.afw.image.Exposure`
177 Exposure to scale; masked image is scaled in place.
178 dataRef : `Unknown`
179 Data reference for exposure.
180 Not used, but in API so that users can switch between spatially variant
181 and invariant tasks.
182
183 Returns
184 -------
185 result : `lsst.pipe.base.Struct`
186 Results as a struct with attributes:
187
188 ``imageScaler``
189 The image scaling object used to scale exposure.
190 """
191 imageScaler = self.computeImageScaler(exposure=exposure, dataRef=dataRef)
192 mi = exposure.getMaskedImage()
193 imageScaler.scaleMaskedImage(mi)
194 return pipeBase.Struct(
195 imageScaler=imageScaler,
196 )
197

◆ scaleFromFluxMag0()

lsst.pipe.tasks.scaleZeroPoint.ScaleZeroPointTask.scaleFromFluxMag0 ( self,
fluxMag0 ) 
Compute the scale for the specified fluxMag0.

This is a wrapper around scaleFromPhotoCalib, which see for more information.

Parameters
----------
fluxMag0 : `float`
    Flux at magnitude zero.

Returns
-------
result : `lsst.pipe.base.Struct`
    Results as a struct with attributes:

    `scale`

    Scale, such that if pixelCalib describes the photometric zeropoint
    of a pixel then the following scales that pixel to the photometric
    zeropoint specified by config.zeroPoint:
        ``scale = computeScale(pixelCalib)``
        ``pixel *= scale``

Definition at line 247 of file scaleZeroPoint.py.

247 def scaleFromFluxMag0(self, fluxMag0):
248 """Compute the scale for the specified fluxMag0.
249
250 This is a wrapper around scaleFromPhotoCalib, which see for more information.
251
252 Parameters
253 ----------
254 fluxMag0 : `float`
255 Flux at magnitude zero.
256
257 Returns
258 -------
259 result : `lsst.pipe.base.Struct`
260 Results as a struct with attributes:
261
262 `scale`
263
264 Scale, such that if pixelCalib describes the photometric zeropoint
265 of a pixel then the following scales that pixel to the photometric
266 zeropoint specified by config.zeroPoint:
267 ``scale = computeScale(pixelCalib)``
268 ``pixel *= scale``
269 """
270 calib = afwImage.makePhotoCalibFromCalibZeroPoint(fluxMag0, 0.0)
271 return self.scaleFromPhotoCalib(calib)
272
273

◆ scaleFromPhotoCalib()

lsst.pipe.tasks.scaleZeroPoint.ScaleZeroPointTask.scaleFromPhotoCalib ( self,
calib ) 
Compute the scale for the specified PhotoCalib.

Returns
-------
result : `lsst.pipe.base.Struct`
    Results as a struct with attributes:

    `scale`

        Scale, such that if pixelCalib describes the photometric
        zeropoint of a pixel then the following scales that pixel to
        the photometric zeropoint specified by config.zeroPoint:
            ``scale = computeScale(pixelCalib) pixel *= scale``

Notes
-----
Returns a struct to leave room for scaleErr in a future implementation.

Definition at line 223 of file scaleZeroPoint.py.

223 def scaleFromPhotoCalib(self, calib):
224 """Compute the scale for the specified PhotoCalib.
225
226 Returns
227 -------
228 result : `lsst.pipe.base.Struct`
229 Results as a struct with attributes:
230
231 `scale`
232
233 Scale, such that if pixelCalib describes the photometric
234 zeropoint of a pixel then the following scales that pixel to
235 the photometric zeropoint specified by config.zeroPoint:
236 ``scale = computeScale(pixelCalib) pixel *= scale``
237
238 Notes
239 -----
240 Returns a struct to leave room for scaleErr in a future implementation.
241 """
242 fluxAtZeroPoint = calib.magnitudeToInstFlux(self.config.zeroPoint)
243 return pipeBase.Struct(
244 scale=1.0 / fluxAtZeroPoint,
245 )
246

Member Data Documentation

◆ _DefaultName

str lsst.pipe.tasks.scaleZeroPoint.ScaleZeroPointTask._DefaultName = "scaleZeroPoint"
staticprotected

Definition at line 162 of file scaleZeroPoint.py.

◆ _photoCalib

lsst.pipe.tasks.scaleZeroPoint.ScaleZeroPointTask._photoCalib = afwImage.makePhotoCalibFromCalibZeroPoint(fluxMag0, 0.0)
protected

Definition at line 169 of file scaleZeroPoint.py.

◆ ConfigClass

lsst.pipe.tasks.scaleZeroPoint.ScaleZeroPointTask.ConfigClass = ScaleZeroPointConfig
static

Definition at line 161 of file scaleZeroPoint.py.

The documentation for this class was generated from the following file:
Generated on Thu Apr 17 2025 04:50:35 for LSST Applications by doxygen 1.13.2