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
documentation [2012/11/12 03:01]
mjc 		documentation [2025/07/03 00:23] (current)
onken Update for v2
Line 1: Line 1:
 ====== PyWiFeS Documentation ====== ====== PyWiFeS Documentation ======
  
-==== Overview ====+** The usage of PyWiFeS has been modified for version 2. Please disregard these instructions and follow those on [[https://pywifes-pipeline.readthedocs.io/en/latest/usage.html| our ReadTheDocs site]].** 
 + 
 +This page is a starting point for running the actual reduction code.  Eventually it will also host documentation for individual function syntax. 
 + 
 +If you are interested in a high-level overview of the techniques and algorithms employed in PyWiFeS, you should head over to the [[data_reduction| main data reduction page]]. 
 + 
 +==== Data Reduction Overview ====
 Data reduction is generally run in two steps: Data reduction is generally run in two steps:
   - **Gather Metadata** - in the 'scripts/' directory of your PyWiFeS installation directory you will find the script 'generate_metadata_script.py'.  Use this to organize your metadata in the following steps:   - **Gather Metadata** - in the 'scripts/' directory of your PyWiFeS installation directory you will find the script 'generate_metadata_script.py'.  Use this to organize your metadata in the following steps:
Line 45: Line 51:
  
 Also important to note here is that an object frame only get automatically classified as a standard star if the 'OBJECT' header field is filled with a name from the standard star list defined in 'wifes_calib.py' in the 'src/' directory. Also important to note here is that an object frame only get automatically classified as a standard star if the 'OBJECT' header field is filled with a name from the standard star list defined in 'wifes_calib.py' in the 'src/' directory.
 +
 +A schematic overview of the PyWiFeS metadata heirarchy is illustrated in the Figure below.  Python dictionaries are colour green, while Python lists are coloured red.
 +
 +{{ :wiki:metadata_wifes.png?600 |}}
  
 ==== Reduction Script ==== ==== Reduction Script ====
Line 60: Line 70:
  
 The reduction steps used by default in the scripts are described in great detail on the [[default_reduction| default data reduction steps]] page. The reduction steps used by default in the scripts are described in great detail on the [[default_reduction| default data reduction steps]] page.
- 
-==== Individual Function Documentation ==== 
-Basic Preprocessing Functions 
-  * [[subtract_overscan]] 
-  * [[subtract_interslit_bias]] 
- 
-Image coaddition / arithmetic 
-  * [[imarith]] 
-  * [[imarith_mef]] 
-  * [[imcombine]] 
-  * [[imcombine_mef]] 
- 
-Cosmics Rays 
-  * [[lacos_wifes]] 
- 
-Wavelength Solution 
-  * [[derive_wifes_wave_solution]] 
-  * [[derive_wifes_skyline_solution]] 
- 
-Wire Solution 
-  * [[derive_wifes_wire_solution]] 
- 
-Flat-fielding 
-  * [[wifes_2dim_response]] 
-  * [[wifes_illumination]] 
-  * [[wifes_pixel_response]] 
- 
-WiFeS Data Formatting 
-  * [[wifes_slitlet_mef]] 
-  * [[generate_wifes_cube]] 
- 
-Flux Calibration 
-  * [[derive_wifes_calibration]] 
-  * [[calibrate_wifes_cube]] 
-  * [[derive_wifes_telluric]] 
-  * [[apply_wifes_telluric]] 
Back to top