lsst.pipe.tasks g14a832a312+ff425fae3c
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | Static Protected 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

 __init__ (self, *args, **kwargs)
 
 run (self, exposure, dataRef)
 
 computeImageScaler (self, exposure, dataRef)
 

Static Public Attributes

 ConfigClass = SpatialScaleZeroPointConfig
 

Static Protected Attributes

str _DefaultName = "scaleZeroPoint"
 

Detailed Description

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

Definition at line 274 of file scaleZeroPoint.py.

Constructor & Destructor Documentation

◆ __init__()

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

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

Definition at line 281 of file scaleZeroPoint.py.

Member Function Documentation

◆ computeImageScaler()

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

Parameters
----------
exposure : `lsst.afw.image.Exposure`
    Exposure for which scaling is desired. Only wcs and bbox are used.
dataRef : `Unknown`
    Data reference of exposure.
    dataRef.dataId used to retrieve all applicable fluxMag0's from a database.

Returns
-------
result : `SpatialImageScaler`

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

Definition at line 310 of file scaleZeroPoint.py.

◆ run()

lsst.pipe.tasks.scaleZeroPoint.SpatialScaleZeroPointTask.run ( self,
exposure,
dataRef )
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.

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

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

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

Definition at line 285 of file scaleZeroPoint.py.

Member Data Documentation

◆ _DefaultName

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

Definition at line 279 of file scaleZeroPoint.py.

◆ ConfigClass

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

Definition at line 278 of file scaleZeroPoint.py.


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