lsst.pipe.tasks g0f82ab2f21+b4c33f426f
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.pipe.tasks.snapCombine.SnapCombineTask Class Reference

More...

Inheritance diagram for lsst.pipe.tasks.snapCombine.SnapCombineTask:

Public Member Functions

def __init__ (self, *args, **kwargs)
 
def run (self, snap0, snap1, defects=None)
 
def addSnaps (self, snap0, snap1)
 
def fixMetadata (self, combinedMetadata, metadata0, metadata1)
 
def makeInitialPsf (self, exposure, fwhmPix=None)
 

Public Attributes

 schema
 
 algMetadata
 

Static Public Attributes

 ConfigClass = SnapCombineConfig
 

Detailed Description

Combine snaps.

Contents

Debug variables

The command line task interface supports a flag -d to import debug.py from your PYTHONPATH; see Debugging Tasks with lsstDebug for more about debug.py files.

The available variables in SnapCombineTask are:

display
A dictionary containing debug point names as keys with frame number as value. Valid keys are:
repair0
Display the first snap after repairing.
repair1
Display the second snap after repairing.

Definition at line 136 of file snapCombine.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.pipe.tasks.snapCombine.SnapCombineTask.__init__ (   self,
args,
**  kwargs 
)

Definition at line 169 of file snapCombine.py.

Member Function Documentation

◆ addSnaps()

def lsst.pipe.tasks.snapCombine.SnapCombineTask.addSnaps (   self,
  snap0,
  snap1 
)
Add two snap exposures together, returning a new exposure

@param[in] snap0 snap exposure 0
@param[in] snap1 snap exposure 1
@return combined exposure

Definition at line 250 of file snapCombine.py.

◆ fixMetadata()

def lsst.pipe.tasks.snapCombine.SnapCombineTask.fixMetadata (   self,
  combinedMetadata,
  metadata0,
  metadata1 
)
Fix the metadata of the combined exposure (in place)

This implementation handles items specified by config.averageKeys and config.sumKeys,
which have data type restrictions. To handle other data types (such as sexagesimal
positions and ISO dates) you must supplement this method with your own code.

@param[in,out] combinedMetadata metadata of combined exposure;
    on input this is a deep copy of metadata0 (a PropertySet)
@param[in] metadata0 metadata of snap0 (a PropertySet)
@param[in] metadata1 metadata of snap1 (a PropertySet)

@note the inputs are presently PropertySets due to ticket #2542. However, in some sense
they are just PropertyLists that are missing some methods. In particular: comments and order
are preserved if you alter an existing value with set(key, value).

Definition at line 285 of file snapCombine.py.

◆ makeInitialPsf()

def lsst.pipe.tasks.snapCombine.SnapCombineTask.makeInitialPsf (   self,
  exposure,
  fwhmPix = None 
)
Initialise the detection procedure by setting the PSF and WCS

@param exposure Exposure to process
@return PSF, WCS

Definition at line 326 of file snapCombine.py.

◆ run()

def lsst.pipe.tasks.snapCombine.SnapCombineTask.run (   self,
  snap0,
  snap1,
  defects = None 
)
Combine two snaps

@param[in] snap0: snapshot exposure 0
@param[in] snap1: snapshot exposure 1
@defects[in] defect list (for repair task)
@return a pipe_base Struct with fields:
- exposure: snap-combined exposure
- sources: detected sources, or None if detection not performed

Definition at line 180 of file snapCombine.py.

Member Data Documentation

◆ algMetadata

lsst.pipe.tasks.snapCombine.SnapCombineTask.algMetadata

Definition at line 174 of file snapCombine.py.

◆ ConfigClass

lsst.pipe.tasks.snapCombine.SnapCombineTask.ConfigClass = SnapCombineConfig
static

Definition at line 166 of file snapCombine.py.

◆ schema

lsst.pipe.tasks.snapCombine.SnapCombineTask.schema

Definition at line 173 of file snapCombine.py.


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