lsst.pipe.tasks  20.0.0-16-g6654009b+03b8a8f522
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
 

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.

@param matches: List of matches (first is target, second is input)
@param inputWcs: Original input Wcs
@param inputBBox: Bounding box of input image
@return Wcs

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

@param inputSources: Source catalog of the input frame
@param templateSources: Source of the target frame
@return Match list

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

@param inputSources: Sources from input exposure
@param inputWcs: Wcs of input exposure
@param inputBBox: Bounding box of input exposure
@param templateSources: Sources from template exposure
@return Struct(matches: Matches between sources,
       wcs: Wcs for input in frame of template,
       )

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.

@param inputExp: Input exposure, to be warped
@param newWcs: Revised Wcs for input exposure
@param templateWcs: Target Wcs
@param templateBBox: Target bounding box
@return Warped exposure

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

@param inputSources: Sources on input exposure, to be warped
@param newWcs: Revised Wcs for input exposure
@param templateWcs: Target Wcs
@param templateBBox: Target bounding box
@return Warped sources

Definition at line 155 of file registerImage.py.

Member Data Documentation

◆ ConfigClass

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

Definition at line 57 of file registerImage.py.


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