lsst.pipe.tasks gc750389ca5+5b520963fe
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.pipe.tasks.coaddInputRecorder.CoaddInputRecorderTask Class Reference
Inheritance diagram for lsst.pipe.tasks.coaddInputRecorder.CoaddInputRecorderTask:

Public Member Functions

def __init__ (self, *args, **kwargs)
 
def makeCoaddTempExpRecorder (self, visitId, num=0)
 
def makeCoaddInputs (self)
 
def addVisitToCoadd (self, coaddInputs, coaddTempExp, weight)
 

Public Attributes

 visitSchema
 
 visitGoodPixKey
 
 visitWeightKey
 
 ccdSchema
 
 ccdCcdKey
 
 ccdVisitKey
 
 ccdGoodPixKey
 
 ccdWeightKey
 
 visitFilterKey
 
 ccdFilterKey
 

Static Public Attributes

 ConfigClass = CoaddInputRecorderConfig
 

Detailed Description

Subtask that handles filling a CoaddInputs object for a coadd exposure, tracking the CCDs and
visits that went into a coadd.

The interface here is a little messy, but I think this is at least partly a product of a bit of
messiness in the coadd code it's plugged into.  I hope #2590 might result in a better design.

Definition at line 162 of file coaddInputRecorder.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.pipe.tasks.coaddInputRecorder.CoaddInputRecorderTask.__init__ (   self,
args,
**  kwargs 
)

Definition at line 172 of file coaddInputRecorder.py.

Member Function Documentation

◆ addVisitToCoadd()

def lsst.pipe.tasks.coaddInputRecorder.CoaddInputRecorderTask.addVisitToCoadd (   self,
  coaddInputs,
  coaddTempExp,
  weight 
)
Called by AssembleCoaddTask when adding (a subset of) a coaddTempExp to a coadd.  The
base class impementation extracts the CoaddInputs from the coaddTempExp and appends
them to the given coaddInputs, filling in the weight column(s).

Parameters
----------
coaddInputs : `lsst.afw.Image.CoaddInputs`
    A record of the observations that are included in the coadd.
coaddTempExp : `lsst.afw.image.Exposure`
    Exposure object from which to obtain the PSF, WCS, and bounding
    box for the entry in the 'visits' table.  On return, the completed
    CoaddInputs object will be attached to it.
weight : `Unknown`

Returns
-------
inputVisitRecord : `Unknown`
    The record for the visit to allow subclasses to fill in additional fields or
    None if the inputRecorder catalogs for the coaddTempExp are not usable.

Notes
-----
Note that the passed coaddTempExp may be a subimage, but that this method will only be
called for the first subimage.

Definition at line 214 of file coaddInputRecorder.py.

◆ makeCoaddInputs()

def lsst.pipe.tasks.coaddInputRecorder.CoaddInputRecorderTask.makeCoaddInputs (   self)
Create a CoaddInputs object with schemas defined by the task configuration.

Definition at line 210 of file coaddInputRecorder.py.

◆ makeCoaddTempExpRecorder()

def lsst.pipe.tasks.coaddInputRecorder.CoaddInputRecorderTask.makeCoaddTempExpRecorder (   self,
  visitId,
  num = 0 
)
Return a CoaddTempExpInputRecorder instance to help with saving a CoaddTempExp's inputs.

Parameters
----------
visitId : `Unknown`
num : `int`, optional
    Number of CCDs for this visit that overlap this patch (for reserving memory).

Notes
-----
The visitId may be any number that is unique for each :that goes into a coadd,
but ideally should be something more meaningful that can be used to reconstruct a data ID.

Definition at line 194 of file coaddInputRecorder.py.

Member Data Documentation

◆ ccdCcdKey

lsst.pipe.tasks.coaddInputRecorder.CoaddInputRecorderTask.ccdCcdKey

Definition at line 181 of file coaddInputRecorder.py.

◆ ccdFilterKey

lsst.pipe.tasks.coaddInputRecorder.CoaddInputRecorderTask.ccdFilterKey

Definition at line 191 of file coaddInputRecorder.py.

◆ ccdGoodPixKey

lsst.pipe.tasks.coaddInputRecorder.CoaddInputRecorderTask.ccdGoodPixKey

Definition at line 184 of file coaddInputRecorder.py.

◆ ccdSchema

lsst.pipe.tasks.coaddInputRecorder.CoaddInputRecorderTask.ccdSchema

Definition at line 180 of file coaddInputRecorder.py.

◆ ccdVisitKey

lsst.pipe.tasks.coaddInputRecorder.CoaddInputRecorderTask.ccdVisitKey

Definition at line 182 of file coaddInputRecorder.py.

◆ ccdWeightKey

lsst.pipe.tasks.coaddInputRecorder.CoaddInputRecorderTask.ccdWeightKey

Definition at line 187 of file coaddInputRecorder.py.

◆ ConfigClass

lsst.pipe.tasks.coaddInputRecorder.CoaddInputRecorderTask.ConfigClass = CoaddInputRecorderConfig
static

Definition at line 170 of file coaddInputRecorder.py.

◆ visitFilterKey

lsst.pipe.tasks.coaddInputRecorder.CoaddInputRecorderTask.visitFilterKey

Definition at line 189 of file coaddInputRecorder.py.

◆ visitGoodPixKey

lsst.pipe.tasks.coaddInputRecorder.CoaddInputRecorderTask.visitGoodPixKey

Definition at line 176 of file coaddInputRecorder.py.

◆ visitSchema

lsst.pipe.tasks.coaddInputRecorder.CoaddInputRecorderTask.visitSchema

Definition at line 174 of file coaddInputRecorder.py.

◆ visitWeightKey

lsst.pipe.tasks.coaddInputRecorder.CoaddInputRecorderTask.visitWeightKey

Definition at line 178 of file coaddInputRecorder.py.


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