lsst.pipe.tasks g584c84fe5e+e9a263d33d
Public Member Functions | Static Public Attributes | List of all members
lsst.pipe.tasks.registerImage.RegisterTask Class Reference
Inheritance diagram for lsst.pipe.tasks.registerImage.RegisterTask:

Public Member Functions

def run (self, inputSources, inputWcs, inputBBox, templateSources)
 
def matchSources (self, inputSources, templateSources)
 
def fitWcs (self, matches, inputWcs, inputBBox)
 
def warpExposure (self, inputExp, newWcs, templateWcs, templateBBox)
 
def warpSources (self, inputSources, newWcs, templateWcs, templateBBox)
 

Static Public Attributes

 ConfigClass = RegisterConfig
 

Detailed Description

Task to register (align) multiple images.

The 'run' method provides a revised Wcs from matches and fitting sources.
Additional methods are provided as a convenience to warp an exposure
('warpExposure') and sources ('warpSources') with the new Wcs.

Definition at line 49 of file registerImage.py.

Member Function Documentation

◆ fitWcs()

def lsst.pipe.tasks.registerImage.RegisterTask.fitWcs (   self,
  matches,
  inputWcs,
  inputBBox 
)
Fit Wcs to matches.

The fitting includes iterative sigma-clipping.

Parameters
----------
matches : `list`
    List of matches (first is target, second is input).
inputWcs : `lsst.afw.geom.SkyWcs`
    Original input Wcs.
inputBBox : `lsst.geom.Box`
    Bounding box of input exposure.

Returns
-------
wcs: `lsst.afw.geom.SkyWcs`
    Wcs fitted to matches.

Definition at line 116 of file registerImage.py.

◆ matchSources()

def lsst.pipe.tasks.registerImage.RegisterTask.matchSources (   self,
  inputSources,
  templateSources 
)
Match sources between the input and template.

The order of the input arguments matters (because the later Wcs
fitting assumes a particular order).

Parameters
----------
inputSources : `lsst.afw.table.SourceCatalog`
    Source catalog of the input frame.
templateSources : `lsst.afw.table.SourceCatalog`
    Source of the target frame.

Returns
-------
matches: `list`
    Match list.

Definition at line 90 of file registerImage.py.

◆ run()

def lsst.pipe.tasks.registerImage.RegisterTask.run (   self,
  inputSources,
  inputWcs,
  inputBBox,
  templateSources 
)
Register (align) an input exposure to the template
The sources must have RA,Dec set, and accurate to within the
'matchRadius' of the configuration in order to facilitate source
matching.  We fit a new Wcs, but do NOT set it in the input exposure.

Parameters
----------
inputSources : `lsst.afw.table.SourceCatalog`
    Sources from input exposure.
inputWcs : `lsst.afw.geom.SkyWcs`
    Wcs of input exposure.
inputBBox : `lsst.geom.Box`
    Bounding box of input exposure.
templateSources : `lsst.afw.table.SourceCatalog`
    Sources from template exposure.

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

    ``matches``
        Matches between sources (`list`).
    ``wcs``
        Wcs for input in frame of template (`lsst.afw.geom.SkyWcs`).

Definition at line 59 of file registerImage.py.

◆ warpExposure()

def lsst.pipe.tasks.registerImage.RegisterTask.warpExposure (   self,
  inputExp,
  newWcs,
  templateWcs,
  templateBBox 
)
Warp input exposure to template frame.

There are a variety of data attached to the exposure (e.g., PSF, PhotoCalib
and other metadata), but we do not attempt to warp these to the template
frame.

Parameters
----------
inputExp : `lsst.afw.image.Exposure`
    Input exposure, to be warped.
newWcs : `lsst.afw.geom.SkyWcs`
    Revised Wcs for input exposure.
templateWcs : `lsst.afw.geom.SkyWcs`
    Target Wcs.
templateBBox : `lsst.geom.Box`
    Target bounding box.

Returns
-------
alignedExp : `lsst.afw.image.Exposure`
    Warped exposure.

Definition at line 166 of file registerImage.py.

◆ warpSources()

def lsst.pipe.tasks.registerImage.RegisterTask.warpSources (   self,
  inputSources,
  newWcs,
  templateWcs,
  templateBBox 
)
Warp sources to the new frame.

It would be difficult to transform all possible quantities of potential
interest between the two frames.  We therefore update only the sky and
pixel coordinates.

Parameters
----------
inputSources : `lsst.afw.table.SourceCatalog`
    Sources on input exposure, to be warped.
newWcs : `lsst.afw.geom.SkyWcs`
    Revised Wcs for input exposure.
templateWcs : `lsst.afw.geom.SkyWcs`
    Target Wcs.
templateBBox : `lsst.geom.Box`
    Target bounding box.

Returns
-------
alignedSources : `lsst.afw.table.SourceCatalog`
    Warped sources.

Definition at line 194 of file registerImage.py.

Member Data Documentation

◆ ConfigClass

lsst.pipe.tasks.registerImage.RegisterTask.ConfigClass = RegisterConfig
static

Definition at line 57 of file registerImage.py.


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