Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

rcal-846 Add mosaic info to the science products RTD page #1262

Merged
merged 5 commits into from
Jun 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions CHANGES.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
0.15.2 (unreleased)
===================

Documentation
-------------

- Update RTD to include mosaic data (i2d) description [#1262]


general
-------

Expand Down
2 changes: 1 addition & 1 deletion docs/roman/associations/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ from the observatory telemetry into a ASDF file. At this point, the
science exposures enter the calibration pipeline.

The pipeline consists of the ELP (Exposure Level Processing) and
the HLP (High Level Processing) which together comprise three levels of data generation and processing:
the Mosaic Level Processing which together comprise three levels of data generation and processing:
Level 1, Level 2, and Level 3. Level 1 data consist of uncalibrated individual
exposures, containing raw pixel information, formatted into the shape of
the detectors. Level 2 data have been processed to correct for instrument artifacts and
Expand Down
36 changes: 36 additions & 0 deletions docs/roman/data_products/science_products.rst
Original file line number Diff line number Diff line change
Expand Up @@ -139,3 +139,39 @@ The calibrated products are the result of an average over all integrations (``ca
- border_ref_pix_right: Copy of original border reference pixels, on right (from viewers perspective).
- border_ref_pix_top: Copy of original border reference pixels, on the top (from viewers perspective).
- border_ref_pix_bottom: Copy of original border reference pixels, on the bottom (from viewers perspective).


Resampled 2-D data: ``i2d``
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Images and spectra that have been resampled by the :ref:`resample <resample_step>` step use a
different set of data arrays than other science products. Resampled 2-D images are stored in
``i2d`` products.
The ASDF structure for ``i2d`` products is as follows:

+----------------------+----------+------------+---------------------------+-------------------------------+
| data array | | Data Type | Units | Dimensions |
+======================+==========+============+===========================+===============================+
| data | Required | float32 | MJy/steradian | nrows x ncols |
+----------------------+----------+------------+---------------------------+-------------------------------+
| context | Required | uint32 | N/A | nplanes x nrows x ncols |
+----------------------+----------+------------+---------------------------+-------------------------------+
| err | Required | float32 | MJy/steradian | nrows x ncols |
+----------------------+----------+------------+---------------------------+-------------------------------+
| weight | Required | float32 | N/A | nrows x ncols |
+----------------------+----------+------------+---------------------------+-------------------------------+
| var_poisson | Required | float32 | (MJy/steradian)\ :sup:`2` | nrows x ncols |
+----------------------+----------+------------+---------------------------+-------------------------------+
| var_rnoise | Required | float32 | (MJy/steradian)\ :sup:`2` | nrows x ncols |
+----------------------+----------+------------+---------------------------+-------------------------------+
| var_flat | Required | float32 | (MJy/steradian)\ :sup:`2` | nrows x ncols |
+----------------------+----------+------------+---------------------------+-------------------------------+
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you check the units here? The flux calibration step is supposed to make sure the units are MJy/sr (or the square of that for the variances), but we may have errors, of course. I had understood the context image to be N x nrows x ncols, where N depends on the number of input images, and is 1 for sky cells with fewer than 32 input images. Not true?

Copy link
Collaborator Author

@ddavis-stsci ddavis-stsci Jun 3, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I must have looked at an old file. I've updated the units.

for the number of planes in the context image I thought as you said, it should be the number of input images modulo 32. In the output I see
context (NDArrayType): shape=(2, 9191, 8642), dtype=uint32 # Context Data
The number of input images was 8 (not all overlapping).
Maybe a bug?



- data: 2-D data array containing the pixel values, in units of surface brightness
- context: 3-D context image, which encodes information about which input images contribute
to a specific output pixel
- error: 2-D data array containing resampled uncertainty estimates, given as standard deviation
- weight: 2-D weight image giving the relative weight of the output pixels
- var_poisson: 2-D resampled Poisson variance estimates for each pixel
- var_rnoise: 2-D resampled read noise variance estimates for each pixel
- var_flat: 2-D resampled flat-field variance estimates for each pixel
2 changes: 1 addition & 1 deletion docs/roman/pipeline/main.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ processing:
The details differ for imaging and spectroscopic exposures and can be found at :ref:`exposure_pipeline`.


- The High Level Processing (HLP) uses overlapping exposures to match the sky background,
- The Mosaic Level Processing (MLP) uses overlapping exposures to match the sky background,
detect aberrant data values and resample the image to produce a single undistorted product.
Details are at: :ref:`mosaic_pipeline`

Expand Down
Loading