lsst.pipe.tasks g2e17d592ec+c990792287
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | Protected Member Functions | Static Protected Attributes | List of all members
lsst.pipe.tasks.snapCombine.SnapCombineTask Class Reference
Inheritance diagram for lsst.pipe.tasks.snapCombine.SnapCombineTask:

Public Member Functions

 __init__ (self, *args, **kwargs)
 
 run (self, snap0, snap1)
 

Static Public Attributes

 ConfigClass = SnapCombineConfig
 

Protected Member Functions

 _add_snaps (self, snap0, snap1)
 
 _merge_visit_info (self, info0, info1)
 

Static Protected Attributes

str _DefaultName = "snapCombine"
 

Detailed Description

Combine two snaps into a single visit image.

Definition at line 40 of file snapCombine.py.

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 47 of file snapCombine.py.

Member Function Documentation

◆ _add_snaps()

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

Parameters
----------
snap0 : `lsst.afw.image.Exposure`
    Snap exposure 0.
snap1 : `lsst.afw.image.Exposure`
    Snap exposure 1.

Returns
-------
combined : `lsst.afw.image.Exposure`
    Combined exposure.

Definition at line 76 of file snapCombine.py.

◆ _merge_visit_info()

lsst.pipe.tasks.snapCombine.SnapCombineTask._merge_visit_info ( self,
info0,
info1 )
protected
Merge the visitInfo values from the two exposures.

In particular:
 * id will be the id of snap 0.
 * date will be the average of the dates.
 * exposure time will be the sum of the times.

Parameters
----------
info0, info1 : `lsst.afw.image.VisitInfo`
    Metadata to combine.

Returns
-------
info : `lsst.afw.image.VisitInfo`
    Combined metadata.

Definition at line 110 of file snapCombine.py.

◆ run()

lsst.pipe.tasks.snapCombine.SnapCombineTask.run ( self,
snap0,
snap1 )
Combine two snaps, returning the combined image.

Parameters
----------
snap0 : `lsst.afw.image.Exposure`
    Snapshot exposure 0.
snap1 : `lsst.afw.image.Exposure`
    Snapshot exposure 1.

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

    ``exposure``
        Snap-combined exposure.

Definition at line 51 of file snapCombine.py.

Member Data Documentation

◆ _DefaultName

str lsst.pipe.tasks.snapCombine.SnapCombineTask._DefaultName = "snapCombine"
staticprotected

Definition at line 45 of file snapCombine.py.

◆ ConfigClass

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

Definition at line 44 of file snapCombine.py.


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