Skip to content

Commit

Permalink
Document slit low/high parameters
Browse files Browse the repository at this point in the history
  • Loading branch information
melanieclarke committed Feb 25, 2025
1 parent 382532d commit efb8b48
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 4 deletions.
28 changes: 26 additions & 2 deletions docs/jwst/assign_wcs/arguments.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,31 @@ the behavior of the processing.
Number of points for the SIP fit.

``--slit_y_low`` (float, default=-0.55)
Lower edge of a NIRSpec slit.
Lower edge of a NIRSpec slit in slit units (see below).

``--slit_y_high`` (float, default=0.55)
Upper edge of a NIRSpec slit.
Upper edge of a NIRSpec slit in slit units.

Slit units are specified as a fraction of the nominal slit or shutter height
in detector orientation. In these relative units, -0.5 is the nominal *top*
edge of the slit open area in science orientation, 0.0 is the center of the slit,
and 0.5 is the nominal *bottom* edge of the slit open area in science orientation.

Set the `slit_y_low` value to a larger negative value to include more pixels
at the *top* of a slit bounding box; a smaller negative value to to include fewer
pixels.

Set the `slit_y_high` value to a larger positive value to include more pixels
at the *bottom* of a slit bounding box; a smaller positive value to to include fewer
pixels.

For MSA slits in NIRSpec MOS mode, the slit units are relative to a single open shutter
height, not a full "slitlet" composed of multiple shutters. For this mode, an
extra margin of half a shutter is automatically added to the slit boundaries specified
here, corresponding to a couple extra detector pixels at the top and bottom of each
slitlet.

Please note that significantly enlarging the slit limit values may introduce
contamination from adjacent open slits when the slit images are extracted
in the :ref:`extract_2d <extract_2d_step>` step, so these parameters should be used
with caution.
4 changes: 2 additions & 2 deletions jwst/assign_wcs/assign_wcs_step.py
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,8 @@ class AssignWcsStep(Step):
sip_max_inv_pix_error = float(default=0.01) # max err for SIP fit, inverse.
sip_inv_degree = integer(max=6, default=None) # degree for inverse SIP fit, None to use best fit.
sip_npoints = integer(default=12) # number of points for SIP
slit_y_low = float(default=-.55) # The lower edge of a slit.
slit_y_high = float(default=.55) # The upper edge of a slit.
slit_y_low = float(default=-.55) # The lower edge of a slit (NIRSpec only).
slit_y_high = float(default=.55) # The upper edge of a slit (NIRSpec only).
""" # noqa: E501

reference_file_types = ['distortion', 'filteroffset', 'specwcs', 'regions',
Expand Down

0 comments on commit efb8b48

Please sign in to comment.