lsst.jointcal  19.0.0-14-gb0260a2+c9e5832d26
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.jointcal.jointcal.JointcalTask Class Reference
Inheritance diagram for lsst.jointcal.jointcal.JointcalTask:

Public Member Functions

def __init__ (self, butler=None, profile_jointcal=False, **kwargs)
 
def runDataRef (self, dataRefs, profile_jointcal=False)
 

Public Attributes

 profile_jointcal
 
 astrometryRefObjLoader
 
 photometryRefObjLoader
 
 job
 
 focalPlaneBBox
 

Static Public Attributes

 ConfigClass = JointcalConfig
 
 RunnerClass = JointcalRunner
 

Detailed Description

Jointly astrometrically and photometrically calibrate a group of images.

Definition at line 389 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 396 of file jointcal.py.

Member Function Documentation

◆ runDataRef()

def lsst.jointcal.jointcal.JointcalTask.runDataRef (   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
-------
result : `lsst.pipe.base.Struct`
    Struct of metadata from the fit, 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 510 of file jointcal.py.

Member Data Documentation

◆ astrometryRefObjLoader

lsst.jointcal.jointcal.JointcalTask.astrometryRefObjLoader

Definition at line 416 of file jointcal.py.

◆ ConfigClass

lsst.jointcal.jointcal.JointcalTask.ConfigClass = JointcalConfig
static

Definition at line 392 of file jointcal.py.

◆ focalPlaneBBox

lsst.jointcal.jointcal.JointcalTask.focalPlaneBBox

Definition at line 550 of file jointcal.py.

◆ job

lsst.jointcal.jointcal.JointcalTask.job

Definition at line 424 of file jointcal.py.

◆ photometryRefObjLoader

lsst.jointcal.jointcal.JointcalTask.photometryRefObjLoader

Definition at line 421 of file jointcal.py.

◆ profile_jointcal

lsst.jointcal.jointcal.JointcalTask.profile_jointcal

Definition at line 410 of file jointcal.py.

◆ RunnerClass

lsst.jointcal.jointcal.JointcalTask.RunnerClass = JointcalRunner
static

Definition at line 393 of file jointcal.py.


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