|
| 1 | +# CRDS Reference Files |
| 2 | + |
| 3 | +This science workflow guides users through understanding the structure, content, and |
| 4 | +usage of Calibration Reference Data System (CRDS) reference files for the Roman Wide |
| 5 | +Field Instrument (WFI). |
| 6 | + |
| 7 | +The notebooks in this workflow are designed as standalone tutorials but can |
| 8 | +be followed sequentially for a complete introduction to how reference files are |
| 9 | +retrieved, inspected, and visualized. |
| 10 | + |
| 11 | +## Workflow Overview |
| 12 | + |
| 13 | +### General CRDS Introduction |
| 14 | + |
| 15 | +- [crds_reference_files.ipynb](../../notebooks/crds_reference_files/crds_reference_files.ipynb) |
| 16 | + |
| 17 | + - Learn what CRDS is, how reference files are matched and delivered, and how to use `crds.getreferences()` and `crds.getrecommendations()`. |
| 18 | + |
| 19 | +### Reference File Inspection Fundamentals |
| 20 | + |
| 21 | +- [crds_reference_files.ipynb](../../crds_reference_files/crds_reference_files.ipynb) (first part) + individual reference file notebooks |
| 22 | + |
| 23 | +Understand the common structure of Roman reference files using `roman_datamodels` and the `.info()` method. |
| 24 | + |
| 25 | +### Individual Reference File Notebooks |
| 26 | + |
| 27 | +Explore each major reference file type in detail: |
| 28 | + |
| 29 | +| Reference File | Purpose | Key Concepts Covered | Notebook | |
| 30 | +|----------------|---------|----------------------|----------| |
| 31 | +| **MASK** (Bad Pixel Mask) | DQ flags and bad pixel identification | `dq` array, bitwise flags, flagged pixel statistics | [bad_pixels_mask_reffile.ipynb](../../notebooks/crds_reference_files/bad_pixels_mask_reffile.ipynb) | |
| 32 | +| **DARK** | Dark current correction | Pixel-by-pixel and frame-by-frame dark current values per detector readout mode | [dark_reffile.ipynb](../../notebooks/crds_reference_files/dark_reffile.ipynb) | |
| 33 | +| **SATURATION** | Saturation thresholds | Per-pixel thresholds, flag handling | [saturation_reffile.ipynb](../../notebooks/crds_reference_files/saturation_reffile.ipynb) | |
| 34 | +| **REFPIX** | Reference pixel correction | Frequency-dependent coefficients (`alpha`, `gamma`, `zeta`) | [reference_pixel_reffile.ipynb](../../notebooks/crds_reference_files/reference_pixel_reffile.ipynb) | |
| 35 | +| **DISTORTION** | Astrometric distortion model | Astropy `CompoundModel`, grid evaluation, vector fields | [distortion_reffile.ipynb](../../notebooks/crds_reference_files/distortion_reffile.ipynb) | |
| 36 | +| **PHOTOM** | Photometric calibration | conversion factors for putting pixel values into physical units | [photom_reffile.ipynb](../../notebooks/crds_reference_files/photom_reffile.ipynb) | |
| 37 | +| **GAIN** | DN to electrons conversion | Per-pixel gain maps, amplifier structure | [gain_reffile.ipynb](../../notebooks/crds_reference_files/gain_reffile.ipynb) | |
| 38 | +| **READNOISE** | Read noise characterization | Per-pixel read noise maps | [readnoise_reffile.ipynb](../../notebooks/crds_reference_files/readnoise_reffile.ipynb) | |
| 39 | +| **AREA** | Pixel solid angle | Pixel area maps in steradians | [area_reffile.ipyn](../../notebooks/crds_reference_files/area_reffile.ipynb) | |
| 40 | +| **PSF / ePSF** | Empirical point spread function | Multi-dimensional ePSF stamps, extended PSF | [psf_reffile.ipynb](../../notebooks/crds_reference_files/psf_reffile.ipynb) | |
| 41 | +| **LINEARITY** family | Non-linearity correction | `LINEARITY`, `INVERSELINEARITY`, `INTEGRALNONLINEARITY` (per-amplifier lookup tables) | [linearity_reffile.ipynb](../../notebooks/crds_reference_files/linearity_reffile.ipynb) | |
| 42 | + |
| 43 | + |
| 44 | +## Suggested Learning Path |
| 45 | + |
| 46 | +1. Start with the general **CRDS Reference Files** notebook. |
| 47 | +3. Go through the individual reference file notebooks in roughly this order: |
| 48 | + - MASK -> DARK -> SATURATION -> FLAT (foundational) |
| 49 | + - GAIN -> READNOISE -> AREA -> DISTORTION (detector characterization) |
| 50 | + - LINEARITY family (important for flux accuracy) |
| 51 | + - PHOTO (photometric calibration) |
| 52 | + - REFPIX, PSF/ePSF (more specialized) |
| 53 | +4. Return to the general CRDS notebook as needed for context. |
| 54 | + |
| 55 | + |
| 56 | +<img src="https://raw.githubusercontent.com/spacetelescope/roman_notebooks/refs/heads/main/images/crds_workflow.jpg" alt="CRDS Workflow" width="250" /> |
| 57 | + |
| 58 | + |
| 59 | +## How to Use This Workflow |
| 60 | + |
| 61 | +- Work through the notebooks sequentially for a comprehensive understanding. |
| 62 | +- Use individual notebooks independently when you need to inspect a specific reference file. |
| 63 | +- All notebooks follow a consistent structure |
| 64 | + |
| 65 | +## Related Workflows |
| 66 | + |
| 67 | +- **WFI Data Simulation** — Uses many of these reference files via Roman-I-Sim and CRDS. |
| 68 | +- **WFI Data Analysis** — Uses calibrated data products that depend on these reference files. |
| 69 | +- **Exposure Pipeline** tutorial — Shows where these reference files are actually applied in `romancal`. |
| 70 | + |
0 commit comments