Skip to content

Commit 5c8aab0

Browse files
authored
DOC: Complete API for lastframe (#10415)
1 parent 95af53b commit 5c8aab0

6 files changed

Lines changed: 29 additions & 15 deletions

File tree

docs/jwst/lastframe/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.lastframe.lastframe_step
9+
:no-inheritance-diagram:
10+
11+
Complete Developer API
12+
======================
13+
14+
.. automodapi:: jwst.lastframe.lastframe_sub
15+
:no-inheritance-diagram:

docs/jwst/lastframe/arguments.rst

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

docs/jwst/lastframe/description.rst

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

4-
:Class: `jwst.lastframe.LastFrameStep`
4+
:Class: `jwst.lastframe.lastframe_step.LastFrameStep`
55
:Alias: lastframe
66

77
The last frame correction step is only applied to MIRI data and flags the
@@ -15,6 +15,10 @@ groups to work with in later steps.
1515

1616
Only the GROUPDQ array is modified. The SCI, ERR, and PIXELDQ arrays are unchanged.
1717

18+
Step Arguments
19+
--------------
20+
The ``lastframe`` step does not have any step-specific arguments.
21+
1822
Reference Files
1923
---------------
2024
The ``lastframe`` step does not use any reference files.

docs/jwst/lastframe/index.rst

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

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

jwst/lastframe/lastframe_step.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
"""Set data quality flag of last group in MIRI data."""
2+
13
import logging
24

35
from stdatamodels.jwst import datamodels
@@ -14,7 +16,7 @@ class LastFrameStep(Step):
1416
"""
1517
Set data quality flags for the last group in MIRI ramps.
1618
17-
If the number of groups > 2, the GROUP
19+
If the number of groups is greater than 2, the GROUP
1820
data quality flag for the final group will be set to DO_NOT_USE.
1921
"""
2022

@@ -25,7 +27,7 @@ class LastFrameStep(Step):
2527

2628
def process(self, step_input):
2729
"""
28-
For MIRI data with more than 2 groups, set final group dq to DO_NOT_USE.
30+
For MIRI data with more than 2 groups, set final group DQ to DO_NOT_USE.
2931
3032
Parameters
3133
----------

jwst/lastframe/lastframe_sub.py

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
1-
#
2-
# Module for the lastframe correction for MIRI science data sets
3-
#
1+
"""Utility functions for the lastframe correction for MIRI science data sets."""
2+
43
import logging
54

65
from stdatamodels.jwst.datamodels import dqflags
@@ -20,12 +19,12 @@ def do_correction(output):
2019
2120
Parameters
2221
----------
23-
output : DataModel
22+
output : `~stdatamodels.jwst.datamodels.JwstDataModel`
2423
Science data to be corrected
2524
2625
Returns
2726
-------
28-
output : DataModel
27+
output : `~stdatamodels.jwst.datamodels.JwstDataModel`
2928
Lastframe-corrected science data
3029
"""
3130
# Save some data params for easy use later

0 commit comments

Comments
 (0)