Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
15 changes: 15 additions & 0 deletions docs/jwst/lastframe/api_ref.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
===
API
===

Public Step API
===============

.. automodapi:: jwst.lastframe.lastframe_step
:no-inheritance-diagram:

Complete Developer API
======================

.. automodapi:: jwst.lastframe.lastframe_sub
:no-inheritance-diagram:
4 changes: 0 additions & 4 deletions docs/jwst/lastframe/arguments.rst
Comment thread
melanieclarke marked this conversation as resolved.
Outdated

This file was deleted.

6 changes: 5 additions & 1 deletion docs/jwst/lastframe/description.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Description
===========

:Class: `jwst.lastframe.LastFrameStep`
:Class: `jwst.lastframe.lastframe_step.LastFrameStep`
:Alias: lastframe

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

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

Step Arguments
--------------
The ``lastframe`` step does not have any step-specific arguments.

Reference Files
---------------
The ``lastframe`` step does not use any reference files.
4 changes: 1 addition & 3 deletions docs/jwst/lastframe/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,4 @@ Last Frame Correction
:maxdepth: 2

description.rst
arguments.rst

.. automodapi:: jwst.lastframe
api_ref.rst
6 changes: 4 additions & 2 deletions jwst/lastframe/lastframe_step.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
"""Set data quality flag of last group in MIRI data."""

import logging

from stdatamodels.jwst import datamodels
Expand All @@ -14,7 +16,7 @@ class LastFrameStep(Step):
"""
Set data quality flags for the last group in MIRI ramps.

If the number of groups > 2, the GROUP
If the number of groups is greater than 2, the GROUP
data quality flag for the final group will be set to DO_NOT_USE.
"""

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

def process(self, step_input):
"""
For MIRI data with more than 2 groups, set final group dq to DO_NOT_USE.
For MIRI data with more than 2 groups, set final group DQ to DO_NOT_USE.

Parameters
----------
Expand Down
9 changes: 4 additions & 5 deletions jwst/lastframe/lastframe_sub.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
#
# Module for the lastframe correction for MIRI science data sets
#
"""Utility functions for the lastframe correction for MIRI science data sets."""

import logging

from stdatamodels.jwst.datamodels import dqflags
Expand All @@ -20,12 +19,12 @@ def do_correction(output):

Parameters
----------
output : DataModel
output : `~stdatamodels.jwst.datamodels.JwstDataModel`
Science data to be corrected

Returns
-------
output : DataModel
output : `~stdatamodels.jwst.datamodels.JwstDataModel`
Lastframe-corrected science data
"""
# Save some data params for easy use later
Expand Down
Loading