Skip to content

Commit

Permalink
fix remaining i2d mentions and add coadd suffix
Browse files Browse the repository at this point in the history
  • Loading branch information
braingram committed Dec 2, 2024
1 parent 6e73a27 commit 8413ff3
Show file tree
Hide file tree
Showing 6 changed files with 12 additions and 12 deletions.
6 changes: 3 additions & 3 deletions docs/roman/associations/skycell_asn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -71,15 +71,15 @@ contribute data to. The association files will be json files with names based

.. code-block:: text
r0099101001001003001_<skycell name>_<product_type>_<filter>_<release product name>_i2d_asn.json
r0099101001001003001_<skycell name>_<product_type>_<filter>_<release product name>_coadd_asn.json
or for the selections above

.. code-block:: text
r0099101001001003001_r257dp63x98y83_visit_F158_prompt_i2d_asn.json
r0099101001001003001_r257dp63x98y83_visit_F158_prompt_coadd_asn.json
where the skycell name can vary based on the location on the celestial sphere and the i2d indicates
where the skycell name can vary based on the location on the celestial sphere and the coadd indicates
that this is resampled 2-d imaging data. The release product name can be changed from the default
by adding the optional argument --release-product <new name> to the command line.

Expand Down
4 changes: 2 additions & 2 deletions docs/roman/data_products/product_types.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Exposure Level Data Products
+==================================================================+========================+==========================+======+=======================+=======================================+
| :ref:`romancal.pipeline.ExposurePipeline <exposure_pipeline>` | uncal | cal | Exp | DN/s | 2-D calibrated data |
+------------------------------------------------------------------+------------------------+--------------------------+------+-----------------------+---------------------------------------+
| :ref:`romancal.pipeline.MosaicPipeline <mosaic_pipeline>` | cal | i2d | Exp | DN/s | 2-D calibrated data |
| :ref:`romancal.pipeline.MosaicPipeline <mosaic_pipeline>` | cal | coadd | Exp | DN/s | 2-D calibrated data |
+------------------------------------------------------------------+------------------------+--------------------------+------+-----------------------+---------------------------------------+


Expand Down Expand Up @@ -81,5 +81,5 @@ the user is running the pipeline. The input for each optional step is the output
+---------------------------------------------------+-----------------+------------------------------+------------------+---------------------+---------------------------------------+
| :ref:`resample <resample_step>` | | resamplestep (opt) | ModelLibrary | MJy/sr | A list of _cal files |
+---------------------------------------------------+-----------------+------------------------------+------------------+---------------------+---------------------------------------+
| | | i2d | MosaicModel | MJy/sr | A 2D resampled image |
| | | coadd | MosaicModel | MJy/sr | A 2D resampled image |
+---------------------------------------------------+-----------------+------------------------------+------------------+---------------------+---------------------------------------+
6 changes: 3 additions & 3 deletions docs/roman/data_products/science_products.rst
Original file line number Diff line number Diff line change
Expand Up @@ -141,12 +141,12 @@ The calibrated products are the result of an average over all integrations (``ca
- border_ref_pix_bottom: Copy of original border reference pixels, on the bottom (from viewers perspective).


Resampled 2-D data: ``i2d``
Resampled 2-D data: ``coadd``
^^^^^^^^^^^^^^^^^^^^^^^^^^^
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:
``coadd`` products.
The ASDF structure for ``coadd`` products is as follows:

+----------------------+----------+------------+---------------------------+-------------------------------+
| data array | | Data Type | Units | Dimensions |
Expand Down
2 changes: 1 addition & 1 deletion docs/roman/outlier_detection/outlier_detection.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Specifically, this routine performs the following operations:
should be used when resampling to create the output mosaic. Any pixel with a
DQ value not included in this value (or list of values) will be ignored when
resampling.
* Resampled images will be written out to disk with suffix `_outlier_i2d` by default.
* Resampled images will be written out to disk with suffix `_outlier_coadd` by default.
* **If resampling is turned off** through the use of the ``resample_data`` parameter,
a copy of the unrectified input images (as a ModelLibrary)
will be used for subsequent processing.
Expand Down
4 changes: 2 additions & 2 deletions docs/roman/pipeline/mosaic_pipeline.rst
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ Outputs
The resampled data can be found in

:Data model: `~romancal.datamodels.WfiMosaic`
:File suffix: _i2d
:File suffix: _coadd

Catalog file (MosaicSourceCatalog)
+++++++++++++++++++++++++++++++++++
Expand All @@ -92,6 +92,6 @@ Result of applying all the mosaic level pipeline steps up through the
:ref:`source_catalog <source_catalog_step>` step is to produce data background corrected
and cleaned of outliers and resampled to a distortion free grid along with
the source catalog and segmentation map.
The i2d file is 2D image data, with additional attributes for the mosaicing information. The cat
The coadd file is 2D image data, with additional attributes for the mosaicing information. The cat
file is an asdf file with the detected sources and the segmenation map is an asdf file
linking the input images to the detected sources.
2 changes: 1 addition & 1 deletion romancal/lib/suffix.py
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@
"refpix",
"cat",
"segm",
"i2d",
"coadd",
]

# Suffixes that are discovered but should not be considered.
Expand Down

0 comments on commit 8413ff3

Please sign in to comment.