lsst.pipe.tasks  21.0.0-149-gc9d3f519+8896b19c6a
Public Member Functions | Static Public Attributes | List of all members
lsst.pipe.tasks.scaleZeroPoint.SpatialScaleZeroPointTask Class Reference
Inheritance diagram for lsst.pipe.tasks.scaleZeroPoint.SpatialScaleZeroPointTask:
lsst.pipe.tasks.scaleZeroPoint.ScaleZeroPointTask

Public Member Functions

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

Static Public Attributes

 ConfigClass = SpatialScaleZeroPointConfig
 

Detailed Description

Compute spatially varying scale factor to scale exposures to a desired photometric zero point

Definition at line 215 of file scaleZeroPoint.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.pipe.tasks.scaleZeroPoint.SpatialScaleZeroPointTask.__init__ (   self,
args,
**  kwargs 
)
Construct a ScaleZeroPointTask

Reimplemented from lsst.pipe.tasks.scaleZeroPoint.ScaleZeroPointTask.

Definition at line 221 of file scaleZeroPoint.py.

Member Function Documentation

◆ computeImageScaler()

def lsst.pipe.tasks.scaleZeroPoint.SpatialScaleZeroPointTask.computeImageScaler (   self,
  exposure,
  dataRef 
)
Compute image scaling object for a given exposure.

@param[in] exposure: exposure for which scaling is desired. Only wcs and bbox are used.
@param[in] dataRef: dataRef of exposure
                    dataRef.dataId used to retrieve all applicable fluxMag0's from a database.
@return a SpatialImageScaler

Reimplemented from lsst.pipe.tasks.scaleZeroPoint.ScaleZeroPointTask.

Definition at line 241 of file scaleZeroPoint.py.

◆ getPhotoCalib()

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

@return calibration (lsst.afw.image.PhotoCalib) with fluxMag0 set appropriately for config.zeroPoint

Definition at line 177 of file scaleZeroPoint.py.

◆ run()

def lsst.pipe.tasks.scaleZeroPoint.SpatialScaleZeroPointTask.run (   self,
  exposure,
  dataRef 
)
Scale the specified exposure to the desired photometric zeropoint

@param[in,out] exposure: exposure to scale; masked image is scaled in place
@param[in] dataRef: dataRef for exposure

@return a pipeBase.Struct containing:
- imageScaler: the image scaling object used to scale exposure

Reimplemented from lsst.pipe.tasks.scaleZeroPoint.ScaleZeroPointTask.

Definition at line 225 of file scaleZeroPoint.py.

◆ scaleFromFluxMag0()

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

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

@param[in] fluxMag0
@return a pipeBase.Struct containing:
- scale, as described in scaleFromPhotoCalib.

Definition at line 202 of file scaleZeroPoint.py.

◆ scaleFromPhotoCalib()

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

Compute 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

@return a pipeBase.Struct containing:
- scale, as described above.

@note: returns a struct to leave room for scaleErr in a future implementation.

Definition at line 184 of file scaleZeroPoint.py.

Member Data Documentation

◆ ConfigClass

lsst.pipe.tasks.scaleZeroPoint.SpatialScaleZeroPointTask.ConfigClass = SpatialScaleZeroPointConfig
static

Definition at line 218 of file scaleZeroPoint.py.


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