Skip to content

Commit

Permalink
update docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
rcooke-ast committed Oct 15, 2024
1 parent 06b95d5 commit 8dbf228
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 0 deletions.
3 changes: 3 additions & 0 deletions pypeit/images/buildimage.py
Original file line number Diff line number Diff line change
Expand Up @@ -222,6 +222,9 @@ def buildimage_fromlist(spectrograph, det, frame_par, file_list, bias=None, bpm=
Flag processed image will be a mosaic of multiple detectors. By
default, this is determined by the format of ``det`` and whether or
not this is a bias or dark frame. *Only used for testing purposes.*
manual_spat_flexure (:obj:`list`, `numpy.ndarray`_, optional):
A list of the spatial flexures for each image in file_list. This is only
used to manually correct the slit traces for spatial flexure of each image.
calib_dir (:obj:`str`, `Path`_, optional):
The directory for processed calibration files. Required for
elements of :attr:`frame_image_classes`, ignored otherwise.
Expand Down
3 changes: 3 additions & 0 deletions pypeit/images/rawimage.py
Original file line number Diff line number Diff line change
Expand Up @@ -519,6 +519,9 @@ def process(self, par, bpm=None, scattlight=None, flatimages=None, bias=None, sl
mosaic. If flats or slits are provided (and used), this *must*
be true because these objects are always defined in the mosaic
frame.
manual_spat_flexure (:obj:`float`, optional):
The spatial flexure of the image. This is only set if the user wishes to
manually correct the slit traces of this image for spatial flexure.
debug (:obj:`bool`, optional):
Run in debug mode.
Expand Down

0 comments on commit 8dbf228

Please sign in to comment.