Skip to content

Commit

Permalink
Improve docs for IsrTask.addDistortionModel
Browse files Browse the repository at this point in the history
This is a separate commit from adding addDistortionModel
because the doxygen command cleanup commit made rebasing
too much work.
  • Loading branch information
r-owen committed Jan 30, 2018
1 parent 123859e commit 0e48ede
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions python/lsst/ip/isr/isrTask.py
Original file line number Diff line number Diff line change
Expand Up @@ -864,6 +864,18 @@ def overscanCorrection(self, exposure, amp):
def addDistortionModel(self, exposure, camera):
"""!Update the WCS in exposure with a distortion model based on camera geometry
Add a model for optical distortion based on geometry found in `camera`
and the `exposure`'s detector. The raw input exposure is assumed
have a TAN WCS that has no compensation for optical distortion.
Two other possibilities are:
- The raw input exposure already has a model for optical distortion,
as is the case for raw DECam data.
In that case you should set config.doAddDistortionModel False.
- The raw input exposure has a model for distortion, but it has known
deficiencies severe enough to be worth fixing (e.g. because they
cause problems for fitting a better WCS). In that case you should
override this method with a version suitable for your raw data.
@param[in,out] exposure exposure to process; must include a Detector and a WCS;
the WCS of the exposure is modified in place
@param[in] camera camera geometry; an lsst.afw.cameraGeom.Camera
Expand Down

0 comments on commit 0e48ede

Please sign in to comment.