Outputs¶
PypeIt, despite a pipeline for data reduction, is capable of generating an inordinate amount of data products. These pages document the various data products and the means to control the output. A full description of the naming system is described here.
Contents¶
Standard Products¶
There are four standard types of output products generated by PypeIt. These separate calibrations from spectra and QA plots. Each type is designated by a unique prefix in the filename:
| Output Type | Prefix | Description |
|---|---|---|
| 1D Spectra | spec1d | 1D arrays and meta data associated with extracted 1D spectra |
| Object info | objinfo | ASCII table listing several object attributes |
| 2D Spectra | spec2d | 2D arrays related to sources (e.g. sky-subtracted image) |
| Calibration | MasterFrame | Calibration images, fits, meta files, etc. |
| Reduction | N/A | Files that guide or describe the reduction |
| QA | qa | Quality assurance figures |
Reduction Mode¶
PypeIt can be run in several modes of reduction, which demark the level of sophistication (e.g. quick and dirty vs. MonteCarlo) and also the amount of output written to disk. See ReductionModes for a full description of these. The Table below briefly summarizes the standard outputs that are generated by each mode. More detail is given in the documentation describing each type of output products.
| Mode | Type | Outputs |
|---|---|---|
| Quick | 1D Spectra | boxcar (counts), meta |
| Object info | all | |
| 2D Spectra | none | |
| Calibration | meta | |
| QA | S/N | |
| Minimal | 1D Spectra | optimal (fluxed), meta |
| 2D Spectra | ivar, skysub, waveimg | |
| Calibration | meta | |
| QA | flexure, S/N, slits, tilts, tracing, wavelength | |
| Full | 1D Spectra | boxcar, optimal, meta |
| 2D Spectra | ivar, mask, objmodel, processed, residual, skymodel, skysub, waveimg | |
| Calibration | meta, bias, illumination image, pixel flat, sensitivity fit and image, slit files, tilts image, wavelength fits | |
| QA | flexure, object profile, S/N, slits, tilts, tracing, wavelength |
Compactness¶
There are two modes for writing the output files which differ in the number of files written.
Compact¶
Write the fewest files possible, generally one per each of the Standard Products. This is the PypeIt default for all Reduction Mode.
Organization¶
[Describe directory structure here.]