Inheritance diagram for lsst.jointcal.jointcal.JointcalTask:

Public Member Functions
def	__init__ (self, butler=None, profile_jointcal=False, kwargs)

def	run (self, dataRefs, profile_jointcal=False)

Public Attributes
	profile_jointcal

	job

	focalPlaneBBox

Static Public Attributes
	ConfigClass = JointcalConfig

	RunnerClass = JointcalRunner

Detailed Description

Jointly astrometrically and photometrically calibrate a group of images.

Definition at line 260 of file jointcal.py.

Constructor & Destructor Documentation

◆ init()

def lsst.jointcal.jointcal.JointcalTask.__init__	(	self,
		butler = `None`,
		profile_jointcal = `False`,
		kwargs
	)

Instantiate a JointcalTask.

Parameters
----------
butler : lsst.daf.persistence.Butler
    The butler is passed to the refObjLoader constructor in case it is
    needed. Ignored if the refObjLoader argument provides a loader directly.
    Used to initialize the astrometry and photometry refObjLoaders.
profile_jointcal : bool
    set to True to profile different stages of this jointcal run.

Definition at line 267 of file jointcal.py.

Member Function Documentation

◆ run()

def lsst.jointcal.jointcal.JointcalTask.run	(	self,
		dataRefs,
		profile_jointcal = `False`
	)

Jointly calibrate the astrometry and photometry across a set of images.

Parameters
----------
dataRefs : list of lsst.daf.persistence.ButlerDataRef
    List of data references to the exposures to be fit.
profile_jointcal : bool
    Profile the individual steps of jointcal.

Returns
-------
pipe.base.Struct
    struct containing:
    * dataRefs: the provided data references that were fit (with updated WCSs)
    * oldWcsList: the original WCS from each dataRef
    * metrics: dictionary of internally-computed metrics for testing/validation.

Definition at line 372 of file jointcal.py.

Member Data Documentation

◆ ConfigClass

lsst.jointcal.jointcal.JointcalTask.ConfigClass = JointcalConfig

static

Definition at line 263 of file jointcal.py.

◆ focalPlaneBBox

lsst.jointcal.jointcal.JointcalTask.focalPlaneBBox

Definition at line 408 of file jointcal.py.

◆ job

lsst.jointcal.jointcal.JointcalTask.job

Definition at line 289 of file jointcal.py.

◆ profile_jointcal

lsst.jointcal.jointcal.JointcalTask.profile_jointcal

Definition at line 281 of file jointcal.py.

◆ RunnerClass

lsst.jointcal.jointcal.JointcalTask.RunnerClass = JointcalRunner

static

Definition at line 264 of file jointcal.py.

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

python/lsst/jointcal/jointcal.py

Public Member Functions

Public Attributes

Static Public Attributes