Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
subtract_overscan [2012/12/14 02:24]
mjc 		subtract_overscan [2025/07/03 01:03] (current)
onken Update for v2
Line 1: Line 1:
 +** This was the beginning of an effort to document the options available for each step of the pipeline. For an up-to-date and complete implementation of this kind of documentation, please see the [[https://pywifes-pipeline.readthedocs.io/en/latest/index.html| ReadTheDocs site]].**
 +
 ===== pywifes.subtract_overscan ===== ===== pywifes.subtract_overscan =====
 **Purpose:** to subtract overscan from raw WiFeS data. **Purpose:** to subtract overscan from raw WiFeS data.
  
-==== Parameters ====+==== Input Parameters ====
 <code> <code>
 def subtract_overscan(inimg, outimg, def subtract_overscan(inimg, outimg,
Line 12: Line 14:
 </code> </code>
  
-  * ''inimg'' - Input raw WiFeS image, including detector pixels plus overscan pixels. +  * ''inimg'' (//required//) - Input raw WiFeS image, including detector pixels plus overscan pixels. 
-  * ''outimg'' - Overscan-subtracted data including only 4k x 4k (or appropriate binned size) detector pixels.+  * ''outimg'' (//required//) - Overscan-subtracted data including only 4k x 4k (or appropriate binned size) detector pixels.
   * ''data_hdu'' - FITS extension in which image data is stored.  Default value should be 0, but some data have been stored in data_hdu=1 for unknown reasons.   * ''data_hdu'' - FITS extension in which image data is stored.  Default value should be 0, but some data have been stored in data_hdu=1 for unknown reasons.
   * ''detector_regions'' - Regions of the image data which corresponds to the actual detector.  This is a list of length N of lists of length 4, where N is the number of amplifiers reading out the data and each amp is defined by a length 4 list of [xmin, xmax, ymin, ymax] in //unbinned// pixel values.  Note these are //not// indexed in Python syntax, but instead are similar to the ''DETSEC'' header keyword syntax.  If 'None' default values for given detector epoch are used.   * ''detector_regions'' - Regions of the image data which corresponds to the actual detector.  This is a list of length N of lists of length 4, where N is the number of amplifiers reading out the data and each amp is defined by a length 4 list of [xmin, xmax, ymin, ymax] in //unbinned// pixel values.  Note these are //not// indexed in Python syntax, but instead are similar to the ''DETSEC'' header keyword syntax.  If 'None' default values for given detector epoch are used.
Back to top