Skip to content

DOC: Complete API for imprint #10435

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
melanieclarke merged 2 commits into from
Apr 17, 2026
Merged

DOC: Complete API for imprint #10435

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4aadad6
DOC: Complete API for imprint
pllim Apr 7, 2026
de58e2c
Merge branch 'main' into api-all-the-things-imprint
melanieclarke Apr 17, 2026
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
14 changes: 14 additions & 0 deletions docs/jwst/imprint/api_ref.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
===
API
===

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

.. automodapi:: jwst.imprint.imprint_step
:no-inheritance-diagram:

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

N/A
4 changes: 2 additions & 2 deletions docs/jwst/imprint/description.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Description
===========

:Class: `jwst.imprint.ImprintStep`
:Class: `jwst.imprint.imprint_step.ImprintStep`
:Alias: imprint

The NIRSpec MSA imprint subtraction step removes patterns created in NIRSpec
Expand Down Expand Up @@ -29,7 +29,7 @@ unaltered.
When subtracting the imprint data model from the target data model,
the SCI data array of the imprint exposure is subtracted from the SCI array
of the target exposure, and the DQ arrays of the two exposures are combined using
a bitwise logical OR operation. The error and variance arrays are not
a bitwise OR operation. The error and variance arrays are not
currently used or modified.

Step Arguments
Expand Down
3 changes: 1 addition & 2 deletions docs/jwst/imprint/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,4 @@ Imprint Subtraction
:maxdepth: 2

description.rst

.. automodapi:: jwst.imprint
api_ref.rst
6 changes: 4 additions & 2 deletions jwst/imprint/imprint_step.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
"""Remove NIRSpec MSA imprint structure from an exposure."""

import logging

from stdatamodels.jwst import datamodels
Expand Down Expand Up @@ -45,14 +47,14 @@ def process(self, input_data, imprint):

Parameters
----------
input_data : `~stdatamodels.jwst.datamodels.JwstDataModel` or str
input_data : str or `~stdatamodels.jwst.datamodels.JwstDataModel`
Input exposure to be corrected.
imprint : list of str or `~stdatamodels.jwst.datamodels.JwstDataModel`
Imprint exposures associated with the input.

Returns
-------
DataModel
`~stdatamodels.jwst.datamodels.JwstDataModel`
The imprint subtracted exposure.
"""
# Open the input science image and get its dither pattern position number
Expand Down
Loading