Inheritance diagram for lsst.pipe.tasks.matchBackgrounds.ChooseReferenceVisitTask:

Public Member Functions
	__init__ (self, args, *kwargs)

Public Attributes
	statsFlag = stringToStatisticsProperty(self.config.gridStatistic)

	statsCtrl = StatisticsControl()

	stringToInterpStyle = stringToInterpStyle(self.config.interpStyle)

	undersampleStyle = stringToUndersampleStyle(self.config.undersampleStyle)

Static Public Attributes
	ConfigClass = ChooseReferenceVisitConfig

Protected Member Functions
	_makeTractBackgrounds (self, warps, skyMap)

	_defineWarps (self, visitTractBackgrounds)

Detailed Description

Select a reference visit from a list of visits by minimizing a cost
function

Notes
-----
The reference exposure is chosen from the list of science exposures by
minimizing a cost function that penalizes high background complexity
(divergence from a plane), high variance, and low global coverage.
The cost function is a weighted sum of these three metrics.
The weights are set by the config parameters:

- ``bestRefWeightChi2``
- ``bestRefWeightVariance``
- ``bestRefWeightGlobalCoverage``

Definition at line 123 of file matchBackgrounds.py.

Constructor & Destructor Documentation

◆ init()

lsst.pipe.tasks.matchBackgrounds.ChooseReferenceVisitTask.__init__	(		self,
		*	args,
		**	kwargs )

Definition at line 145 of file matchBackgrounds.py.

Member Function Documentation

◆ _defineWarps()

lsst.pipe.tasks.matchBackgrounds.ChooseReferenceVisitTask._defineWarps	(		self,
			visitTractBackgrounds )

protected

Define the reference visit

This method calculates an appropriate reference visit from the
supplied full tract visit backgrounds by minimizing a cost function
that penalizes high background complexity (divergence from a plane),
high variance within the warps comprising the visit, and low global
coverage.

Parameters
----------
visitTractBackrounds : `dict` [`int`, `TractBackground`]
    Models of full tract backgrounds for all visits, in nanojanskies.
    Accessed by visit ID.
Returns
-------
refVisId : `int`
    ID of the reference visit.

Definition at line 220 of file matchBackgrounds.py.

◆ _makeTractBackgrounds()

lsst.pipe.tasks.matchBackgrounds.ChooseReferenceVisitTask._makeTractBackgrounds	(	self,
		warps,
		skyMap )

protected

Create full tract models of all visit backgrounds

Parameters
----------
warps : `list`[`~lsst.daf.butler.DeferredDatasetHandle`]
    List of warped exposures (of type `~lsst.afw.image.ExposureF`).
    This is ordered by patch ID, then by visit ID
skyMap : `lsst.skyMap.SkyMap`
   SkyMap for deriving the patch/tract dimensions

Returns
-------
visitTractBackrounds : `dict` [`int`, `TractBackground`]
    Models of full tract backgrounds for all visits, in nanojanskies.
    Accessed by visit ID.

Definition at line 157 of file matchBackgrounds.py.

Member Data Documentation

◆ ConfigClass

lsst.pipe.tasks.matchBackgrounds.ChooseReferenceVisitTask.ConfigClass = ChooseReferenceVisitConfig

static

Definition at line 142 of file matchBackgrounds.py.

◆ statsCtrl

lsst.pipe.tasks.matchBackgrounds.ChooseReferenceVisitTask.statsCtrl = StatisticsControl()

Definition at line 149 of file matchBackgrounds.py.

◆ statsFlag

lsst.pipe.tasks.matchBackgrounds.ChooseReferenceVisitTask.statsFlag = stringToStatisticsProperty(self.config.gridStatistic)

Definition at line 148 of file matchBackgrounds.py.

◆ stringToInterpStyle

lsst.pipe.tasks.matchBackgrounds.ChooseReferenceVisitTask.stringToInterpStyle = stringToInterpStyle(self.config.interpStyle)

Definition at line 153 of file matchBackgrounds.py.

◆ undersampleStyle

lsst.pipe.tasks.matchBackgrounds.ChooseReferenceVisitTask.undersampleStyle = stringToUndersampleStyle(self.config.undersampleStyle)

Definition at line 154 of file matchBackgrounds.py.

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

python/lsst/pipe/tasks/matchBackgrounds.py

Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions