Skip to content

Commit

Permalink
[pre-commit.ci] auto fixes from pre-commit.com hooks
Browse files Browse the repository at this point in the history
for more information, see https://pre-commit.ci
  • Loading branch information
pre-commit-ci[bot] committed Jan 17, 2024
1 parent 96ddfdd commit 1974bd0
Show file tree
Hide file tree
Showing 6 changed files with 30 additions and 32 deletions.
8 changes: 4 additions & 4 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ The Roman Space Telescope Calibration Pipeline
:alt: Nancy Roman Space Telescope

Welcome to the documentation for the Roman calibration software,
`romancal <https://github.com/spacetelescope/romancal>`__.
`romancal <https://github.com/spacetelescope/romancal>`__.
This package contains the Python software suite for the
Roman Space Telescope (RST) calibration pipeline, which processes data
from the Roman Wide-Field Instrument (WFI) by applying various corrections
from the Roman Wide-Field Instrument (WFI) by applying various corrections
to produce science-ready, calibrated output products including fully calibrated
individual exposures as well as high-level data products (mosaics,
catalogs, etc.). The tools in this package allow users to run and
Expand All @@ -29,7 +29,7 @@ Roman data files in Python.
If you have questions or concerns regarding the software, please contact the Roman Help
desk at `Roman Help Desk <https://stsci.service-now.com/roman>`_.

--------------------------------
--------------------------------

.. include:: roman/introduction.rst

Expand All @@ -51,7 +51,7 @@ desk at `Roman Help Desk <https://stsci.service-now.com/roman>`_.
:caption: Data Products Documentation

roman/data_products/index.rst

.. toctree::
:caption: RomanCal Package Index
:maxdepth: 3
Expand Down
12 changes: 5 additions & 7 deletions docs/roman/data_products/file_naming.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ File Naming Schemes

Exposure file names
^^^^^^^^^^^^^^^^^^^
The names of the exposure level data are constructed with information from the
science header of the exposure, allowing users to map it to the observation in their corresponding
The names of the exposure level data are constructed with information from the
science header of the exposure, allowing users to map it to the observation in their corresponding
APT files. The ASDF file naming scheme for the Exposure products is::

r<ppppp><cc><aaa><sss><ooo><vvv>_<gg><s><aa>_<eeeee>_<detector>_<prodType>.fits
Expand All @@ -28,13 +28,11 @@ where
- detector: detector name (e.g. WFI01, WFI02, ...)
- prodType: product type identifier (e.g. 'uncal', 'cal')

The standard <prodType> for the pipeline are uncal and cal, for the input products and resulting
calibrated product. There are optional suffixes for intermediate products that are not routinely
produced by the pipeline and are based of the processing level and can include dqinit, saturation,
The standard <prodType> for the pipeline are uncal and cal, for the input products and resulting
calibrated product. There are optional suffixes for intermediate products that are not routinely
produced by the pipeline and are based of the processing level and can include dqinit, saturation,
linearity, jump, darkcurrent, rampfit, assignwcs, flat, and photom.

An example Exposure Level product ASDF file name is::

r0000101001001001001_01101_0001_WFI01_cal.asdf


6 changes: 3 additions & 3 deletions docs/roman/data_products/product_types.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ Exposure Level Data Products
Exposure Step Data Products
+++++++++++++++++++++++++++

The following table contain lists of all data product types for exposure pipeline, as given by their file name suffix. The input uncal file and the final cal file
are the only files that are produced in the standard processing. All the other are optional (opt) files that can be produced when
the user is running the pipeline. The input for each optional step is the output of the preceeding step.
The following table contain lists of all data product types for exposure pipeline, as given by their file name suffix. The input uncal file and the final cal file
are the only files that are produced in the standard processing. All the other are optional (opt) files that can be produced when
the user is running the pipeline. The input for each optional step is the output of the preceeding step.

+------------------------------------------------+-----------------+--------------------------+------------------+---------------------+---------------------------------------+
| Pipeline Step | Input | Output(s) | Model | Units | Description |
Expand Down
26 changes: 13 additions & 13 deletions docs/roman/data_products/science_products.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ resultantdq array is an optional array used to flag missing data in the data For
process.

+--------------+----------+------------+-------+-------------------------------+
| data array | | Data Type | Units | Dimensions |
| data array | | Data Type | Units | Dimensions |
+==============+==========+============+=======+===============================+
| data | Required | uint16 | DN | nresultants x nrows x ncols |
+--------------+----------+------------+-------+-------------------------------+
Expand All @@ -24,29 +24,29 @@ process.
+--------------+----------+------------+-------+-------------------------------+

- data: 3-D data array containing the raw pixel values. The first two dimensions are equal to
the size of the detector readout, with the data from multiple resultants stored along the 3rd
the size of the detector readout, with the data from multiple resultants stored along the 3rd
axis.

- amp33: This is the reference output from a dedicated SCA Output that reads additional Reference
Pixels on the SCA that are separate from the full-frame array read out by the Science Outputs.
- amp33: This is the reference output from a dedicated SCA Output that reads additional Reference
Pixels on the SCA that are separate from the full-frame array read out by the Science Outputs.
This Output is active in parallel with either the 32 Science Outputs or the 1 Guide Window Output.

- resultantdq: An array that flags the location of any missing data discovered in
the data formating process.


Ramp data: ``ramp``
^^^^^^^^^^^^^^^^^^^
As raw data progress through the :ref:`romancal.pipeline.ExposurePipeline <exposure_pipeline>` pipeline
they are stored internally in a `~romancal.datamodels.RampModel`.
This type of data model is serialized to a ``ramp`` type ASDF
file on disk. The original detector pixel values are converted
from integer to floating-point data type. An ERR array and two
types of data quality arrays are also added to the product.
from integer to floating-point data type. An ERR array and two
types of data quality arrays are also added to the product.
The ASDF file layout is as follows:

+----------------------+----------+------------+-----------+-------------------------------+
| data array | | Data Type | Units | Dimensions |
| data array | | Data Type | Units | Dimensions |
+======================+==========+============+===========+===============================+
| data | Required | float32 | e :sup:`-`| nresultants x nrows x ncols |
+----------------------+----------+------------+-----------+-------------------------------+
Expand All @@ -68,7 +68,7 @@ The ASDF file layout is as follows:
+----------------------+----------+------------+-----------+-------------------------------+

- data: 3-D data array containing the pixel values. The first two dimensions are equal to
the size of the detector readout, with the data from multiple resultants stored along the 3rd
the size of the detector readout, with the data from multiple resultants stored along the 3rd
axis.
- pixeldq: 2-D data array containing DQ flags that apply to all groups and all resultants
for a given pixel (e.g. a hot pixel is hot in all groups and resultants).
Expand All @@ -86,8 +86,8 @@ The ASDF file layout is as follows:

.. Note::
The reference pixels that are on the outer border of the science array are copied to these
storage arrays (border_ref_pixel_<position>) at the dq_init step but are retained in
the science array until being trimmed at the ramp fitting step.
storage arrays (border_ref_pixel_<position>) at the dq_init step but are retained in
the science array until being trimmed at the ramp fitting step.


Calibrated data: ``cal``
Expand All @@ -98,7 +98,7 @@ Single exposure calibrated products contain many of the same arrays as the previ
The calibrated products are the result of an average over all integrations (``cal``).

+----------------------+----------+------------+-------------------------+-------------------------------+
| data array | | Data Type | Units | Dimensions |
| data array | | Data Type | Units | Dimensions |
+======================+==========+============+=========================+===============================+
| data | Required | float32 | e\ :sup:`-`/ s | nrows x ncols |
+----------------------+----------+------------+-------------------------+-------------------------------+
Expand Down Expand Up @@ -138,4 +138,4 @@ The calibrated products are the result of an average over all integrations (``ca
- border_ref_pix_left: Copy of original border reference pixels, on left (from viewers perspective).
- 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).
- border_ref_pix_bottom: Copy of original border reference pixels, on the bottom (from viewers perspective).
8 changes: 4 additions & 4 deletions docs/roman/data_products/stages.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ Here we describe the structure and content of the most frequently used forms of
Roman science data products, which are in `ASDF <https://asdf-standard.readthedocs.io/>`_ format. Each type of ASDF
file is the result of serialization of a corresponding :ref:`DataModel<datamodels>`.

Within the various STScI internal data processing and archiving systems that are used for routine processing of
Roman data, there are some different uses of terminology to refer to different levels of processing.
Within the various STScI internal data processing and archiving systems that are used for routine processing of
Roman data, there are some different uses of terminology to refer to different levels of processing.
The WFI data is converted into ASDF files by Science Data Formatting (SDF), level 0. SDF also inserts data
from the engineering database and from the proposal database to create the level 1 files. SDF produces one ASDF
file per detector and exposure and these level 1 files are used as input to the Exposure Level Processing. The
from the engineering database and from the proposal database to create the level 1 files. SDF produces one ASDF
file per detector and exposure and these level 1 files are used as input to the Exposure Level Processing. The
output of the exposure level processing is a level 2 file.

+-------------------------------------+-------------------------------------+------------------------------------+
Expand Down
2 changes: 1 addition & 1 deletion docs/roman/introduction.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Introduction
============

Welcome to the documentation for `romancal <https://github.com/spacetelescope/romancal>`__.
Welcome to the documentation for `romancal <https://github.com/spacetelescope/romancal>`__.
This package contains the calibration software for the WFI instrument on the Nancy Grace Roman
Space Telescope.

Expand Down

0 comments on commit 1974bd0

Please sign in to comment.