lsst.jointcal gf6ad1f1eeb+ca45fbde06
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, initInputs=None, **kwargs)
 
def runQuantum (self, butlerQC, inputRefs, outputRefs)
 
def run (self, inputSourceTableVisit, inputVisitSummary, inputCamera, tract=None)
 
def loadData (self, dataRefs, associations, jointcalControl)
 
def runDataRef (self, dataRefs)
 

Public Attributes

 astrometryRefObjLoader
 
 photometryRefObjLoader
 
 job
 
 focalPlaneBBox
 

Static Public Attributes

 ConfigClass = JointcalConfig
 
 RunnerClass = JointcalRunner
 

Detailed Description

Astrometricly and photometricly calibrate across multiple visits of the
same field.

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.
initInputs : `dict`, optional
    Dictionary used to initialize PipelineTasks (empty for jointcal).

Definition at line 599 of file jointcal.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.jointcal.jointcal.JointcalTask.__init__ (   self,
  butler = None,
  initInputs = None,
**  kwargs 
)

Definition at line 617 of file jointcal.py.

Member Function Documentation

◆ loadData()

def lsst.jointcal.jointcal.JointcalTask.loadData (   self,
  dataRefs,
  associations,
  jointcalControl 
)
Read the data that jointcal needs to run. (Gen2 version)

Definition at line 1063 of file jointcal.py.

◆ run()

def lsst.jointcal.jointcal.JointcalTask.run (   self,
  inputSourceTableVisit,
  inputVisitSummary,
  inputCamera,
  tract = None 
)

Definition at line 725 of file jointcal.py.

◆ runDataRef()

def lsst.jointcal.jointcal.JointcalTask.runDataRef (   self,
  dataRefs 
)
Jointly calibrate the astrometry and photometry across a set of images.

NOTE: this is for gen2 middleware only.

Parameters
----------
dataRefs : `list` of `lsst.daf.persistence.ButlerDataRef`
    List of data references to the exposures to be fit.

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 1115 of file jointcal.py.

◆ runQuantum()

def lsst.jointcal.jointcal.JointcalTask.runQuantum (   self,
  butlerQC,
  inputRefs,
  outputRefs 
)

Definition at line 638 of file jointcal.py.

Member Data Documentation

◆ astrometryRefObjLoader

lsst.jointcal.jointcal.JointcalTask.astrometryRefObjLoader

Definition at line 626 of file jointcal.py.

◆ ConfigClass

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

Definition at line 613 of file jointcal.py.

◆ focalPlaneBBox

lsst.jointcal.jointcal.JointcalTask.focalPlaneBBox

Definition at line 734 of file jointcal.py.

◆ job

lsst.jointcal.jointcal.JointcalTask.job

Definition at line 636 of file jointcal.py.

◆ photometryRefObjLoader

lsst.jointcal.jointcal.JointcalTask.photometryRefObjLoader

Definition at line 633 of file jointcal.py.

◆ RunnerClass

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

Definition at line 614 of file jointcal.py.


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