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

Public Member Functions
	__init__ (self, scale=1.0)

	scaleMaskedImage (self, maskedImage)

Protected Attributes
	_scale

Detailed Description

A class that scales an image.

This version uses a single scalar. Fancier versions may use a spatially varying scale.

Parameters
----------
scale : `float`, optional
    Scale correction to apply (see ``scaleMaskedImage``).

Definition at line 32 of file scaleZeroPoint.py.

Constructor & Destructor Documentation

◆ init()

lsst.pipe.tasks.scaleZeroPoint.ImageScaler.__init__	(		self,
			scale = 1.0 )

Reimplemented in lsst.pipe.tasks.scaleZeroPoint.SpatialImageScaler.

Definition at line 43 of file scaleZeroPoint.py.

    def __init__(self, scale=1.0):
        self._scale = scale
 

Member Function Documentation

◆ scaleMaskedImage()

lsst.pipe.tasks.scaleZeroPoint.ImageScaler.scaleMaskedImage	(		self,
			maskedImage )

Scale the specified image or masked image in place.

Parameters
----------
maskedImage : `lsst.afw.image.MaskedImage`
    Masked image to scale.

Reimplemented in lsst.pipe.tasks.scaleZeroPoint.SpatialImageScaler.

Definition at line 46 of file scaleZeroPoint.py.

    def scaleMaskedImage(self, maskedImage):
        """Scale the specified image or masked image in place.
 
        Parameters
        ----------
        maskedImage : `lsst.afw.image.MaskedImage`
            Masked image to scale.
        """
        maskedImage *= self._scale
 
 

Member Data Documentation

◆ _scale

lsst.pipe.tasks.scaleZeroPoint.ImageScaler._scale

protected

Definition at line 44 of file scaleZeroPoint.py.

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

/j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/pipe_tasks/gc07e1c2157+a98bf949bb/python/lsst/pipe/tasks/scaleZeroPoint.py

Public Member Functions

Protected Attributes