lsst.pipe.tasks.scaleZeroPoint.SpatialScaleZeroPointTask Class Reference

Inheritance diagram for lsst.pipe.tasks.scaleZeroPoint.SpatialScaleZeroPointTask:

Public Member Functions
	__init__ (self, *args, **kwargs)
	run (self, exposure, dataRef)
	computeImageScaler (self, exposure, dataRef)
	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 spatially varying scale factor to scale exposures to a desired photometric zero point.

Definition at line 297 of file scaleZeroPoint.py.

Constructor & Destructor Documentation

__init__()

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

Definition at line 304 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 333 of file scaleZeroPoint.py.

getPhotoCalib()

lsst.pipe.tasks.scaleZeroPoint.ScaleZeroPointTask.getPhotoCalib ( self )

inherited

Get desired PhotoCalib.

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

Definition at line 231 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 308 of file scaleZeroPoint.py.

scaleFromFluxMag0()

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.

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 270 of file scaleZeroPoint.py.

scaleFromPhotoCalib()

lsst.pipe.tasks.scaleZeroPoint.ScaleZeroPointTask.scaleFromPhotoCalib ( self, calib )

inherited

Compute the scale for the specified PhotoCalib.

Parameter
---------
calib : `lsst.afw.image.PhotoCalib`
    PhotoCalib object to compute the scale from.

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 241 of file scaleZeroPoint.py.

Member Data Documentation

_DefaultName

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

staticprotectedinherited

Definition at line 180 of file scaleZeroPoint.py.

_photoCalib

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

protectedinherited

Definition at line 187 of file scaleZeroPoint.py.

ConfigClass

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

staticinherited

Definition at line 179 of file scaleZeroPoint.py.

---

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

• python/lsst/pipe/tasks/scaleZeroPoint.py