Skip to content

Commit ab89d80

Browse files
authored
DOC: Complete API for group_scale (#10425)
1 parent 61678e3 commit ab89d80

6 files changed

Lines changed: 27 additions & 15 deletions

File tree

docs/jwst/group_scale/api_ref.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
===
2+
API
3+
===
4+
5+
Public Step API
6+
===============
7+
8+
.. automodapi:: jwst.group_scale.group_scale_step
9+
:no-inheritance-diagram:
10+
11+
Complete Developer API
12+
======================
13+
14+
.. automodapi:: jwst.group_scale.group_scale
15+
:no-inheritance-diagram:

docs/jwst/group_scale/arguments.rst

Lines changed: 0 additions & 4 deletions
This file was deleted.

docs/jwst/group_scale/description.rst

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Description
22
===========
33

4-
:Class: `jwst.group_scale.GroupScaleStep`
4+
:Class: `jwst.group_scale.group_scale_step.GroupScaleStep`
55
:Alias: group_scale
66

77
The ``group_scale`` step rescales pixel values in raw JWST science
@@ -26,9 +26,9 @@ power of 2. When NFRAMES is not a power of 2, the next largest
2626
divisor is used to perform the averaging. For example, when
2727
``NFRAMES=5``, a divisor of 8 (bit shift of 3) is used to compute the
2828
average. This results in averaged values for each group that
29-
are too low by the factor NFRAMES/FRMDIVSR. This step rescales the
29+
are too low by the factor ``NFRAMES/FRMDIVSR``. This step rescales the
3030
pixel values by multiplying all groups in all integrations by the
31-
factor FRMDIVSR/NFRAMES.
31+
factor ``FRMDIVSR/NFRAMES``.
3232

3333
The step decides whether rescaling is necessary by comparing the
3434
values of the NFRAMES and FRMDIVSR keywords. If they are equal,
@@ -62,11 +62,15 @@ per group and the number of groups per integration that are downlinked
6262
from the instrument are stored in the special keywords "MIRNFRMS" and
6363
"MIRNGRPS", respectively, so that their values are preserved. During
6464
Stage 1 processing in the pipeline, the value of the NFRAMES keyword is
65-
computed from MIRNFRMS * FRMDIVSR. The result is that when 4 frames
65+
computed from ```MIRNFRMS * FRMDIVSR``. The result is that when 4 frames
6666
are averaged together on board, both NFRAMES and FRMDIVSR will have a
6767
value of 4, which allows the ``group_scale`` step to correctly
6868
determine that no rescaling of the data is necessary.
6969

70+
Step Arguments
71+
--------------
72+
The ``group_scale`` step does not have any step-specific arguments.
73+
7074
Reference Files
7175
---------------
7276
The ``group_scale`` step does not use any reference files.

docs/jwst/group_scale/index.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,4 @@ Group Scale Correction
88
:maxdepth: 2
99

1010
description.rst
11-
arguments.rst
12-
13-
.. automodapi:: jwst.group_scale
11+
api_ref.rst

jwst/group_scale/group_scale.py

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
1-
#
2-
# Module for rescaling grouped data for NFRAME
3-
# not equal to a power of 2
4-
#
1+
"""Functions for rescaling grouped data for NFRAME not equal to a power of 2."""
52

63
import logging
74

jwst/group_scale/group_scale_step.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
"""Perform the group scale step."""
2+
13
import logging
24
import warnings
35

0 commit comments

Comments
 (0)