lsst.pipe.tasks g59f6dce098+83b7f37e51
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

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

Static Public Attributes

ScaleZeroPointConfig ConfigClass = ScaleZeroPointConfig
 

Protected Attributes

 _photoCalib
 

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__()

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

Member Function Documentation

◆ computeImageScaler()

def 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.

◆ getPhotoCalib()

def 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.

◆ run()

def 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.

◆ scaleFromFluxMag0()

def 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.

◆ scaleFromPhotoCalib()

def 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.

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
protected

Definition at line 169 of file scaleZeroPoint.py.

◆ ConfigClass

ScaleZeroPointConfig 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: