lsst.pipe.tasks gf53ffbb2c7+83d25aaa19
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.pipe.tasks.snapCombine.SnapCombineTask Class Reference
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 two snaps into a single visit image.

Notes
-----
Debugging:
The `~lsst.base.lsstDebug` variables in SnapCombineTask are:

display
A dictionary containing debug point names as keys with frame number as value. Valid keys are:

.. code-block:: none

    repair0
    Display the first snap after repairing.
    repair1
    Display the second snap after repairing.

Definition at line 134 of file snapCombine.py.

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 156 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.

Parameters
----------
snap0 : `Unknown`
    Snap exposure 0.
snap1 : `Unknown`
    Snap exposure 1.

Returns
-------
combinedExp : `Unknown`
    Combined exposure.

Definition at line 240 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.

Parameters
----------
combinedMetadata : `lsst.daf.base.PropertySet`
    Metadata of combined exposure;
    on input this is a deep copy of metadata0 (a PropertySet).
metadata0 : `lsst.daf.base.PropertySet`
    Metadata of snap0 (a PropertySet).
metadata1 : `lsst.daf.base.PropertySet`
    Metadata of snap1 (a PropertySet).

Notes
-----
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 283 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.

exposure : `lsst.afw.image.Exposure`
    Exposure to process.

Returns
-------
psf : `Unknown`
    PSF, WCS

AssertionError
    Raised if any of the following occur:
    - No exposure provided.
    - No wcs in exposure.

Definition at line 331 of file snapCombine.py.

◆ run()

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

Parameters
----------
snap0 : `Unknown`
    Snapshot exposure 0.
snap1 : `Unknown`
    Snapshot exposure 1.
defects : `list` or `None`, optional
    Defect list (for repair task).

Returns
-------
result : `lsst.pipe.base.Struct`
    Results as a struct with attributes:

    ``exposure``
        Snap-combined exposure.
    ``sources``
        Detected sources, or `None` if detection not performed.

Definition at line 166 of file snapCombine.py.

Member Data Documentation

◆ algMetadata

lsst.pipe.tasks.snapCombine.SnapCombineTask.algMetadata

Definition at line 160 of file snapCombine.py.

◆ ConfigClass

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

Definition at line 153 of file snapCombine.py.

◆ schema

lsst.pipe.tasks.snapCombine.SnapCombineTask.schema

Definition at line 159 of file snapCombine.py.


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