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)

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.

    def __init__(self, *args, **kwargs):
        ScaleZeroPointTask.__init__(self, *args, **kwargs)
        self.makeSubtask("selectFluxMag0")
 

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.

    def 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`
        """
        wcs = exposure.getWcs()
 
        fluxMagInfoList = self.selectFluxMag0.run(dataRef.dataId).fluxMagInfoList
 
        xList = []
        yList = []
        scaleList = []
 
        for fluxMagInfo in fluxMagInfoList:
            # find center of field in tract coordinates
            if not fluxMagInfo.coordList:
                raise RuntimeError("no x,y data for fluxMagInfo")
            ctr = geom.Extent2D()
            for coord in fluxMagInfo.coordList:
                # accumulate x, y
                ctr += geom.Extent2D(wcs.skyToPixel(coord))
            # and find average x, y as the center of the chip
            ctr = geom.Point2D(ctr / len(fluxMagInfo.coordList))
            xList.append(ctr.getX())
            yList.append(ctr.getY())
            scaleList.append(self.scaleFromFluxMag0(fluxMagInfo.fluxMag0).scale)
 
        self.log.info("Found %d flux scales for interpolation: %s",
                      len(scaleList), [f"{s:%0.4f}" for s in scaleList])
        return SpatialImageScaler(
            interpStyle=self.config.interpStyle,
            xList=xList,
            yList=yList,
            scaleList=scaleList,
        )

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.

    def 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.
        """
        imageScaler = self.computeImageScaler(exposure=exposure, dataRef=dataRef)
        mi = exposure.getMaskedImage()
        imageScaler.scaleMaskedImage(mi)
        return pipeBase.Struct(
            imageScaler=imageScaler,
        )
 

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:

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