Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
melanieclarke committed Jan 9, 2025
1 parent c78f298 commit 87f8827
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 2 deletions.
9 changes: 9 additions & 0 deletions docs/jwst/clean_flicker_noise/arguments.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,15 @@ the behavior of the processing.
affected by failed-open MSA shutters. For MIRI imaging, mask
regions of the detector not used for science.

``--apply_flat_field`` (boolean, default=False)
If set, images are flat-corrected prior to fitting background
and noise levels. A full-frame flat field image
(reference type FLAT) is required. For modes that do not provide
FLAT files via CRDS, including all NIRSpec modes, a manually
generated override flat is required to enable this option.
Use the `override_flat` parameter to provide an alternate flat image
as needed.

``--n_sigma`` (float, default=2.0)
The sigma-clipping threshold to use when searching for outliers
and illuminated pixels to be excluded from use in the background
Expand Down
9 changes: 8 additions & 1 deletion docs/jwst/clean_flicker_noise/main.rst
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,9 @@ information on all referenced parameters.
This will mask out regions of the detector under the metering
structure.

#. If `apply_flat_field` is set and a flat file is available, divide the
draft rate data by the flat image.

#. Iteratively sigma clip the data to get a center value (mean or median)
and sigma value (standard deviation).

Expand All @@ -200,6 +203,9 @@ information on all referenced parameters.

#. Make a diff image (current group – previous group) to correct.

#. If `apply_flat_field` is set and a flat file is available, divide the
diff image by the flat image.

#. Fit and remove a background level, using the scene mask to identify
background pixels.

Expand Down Expand Up @@ -231,7 +237,8 @@ information on all referenced parameters.
detector channel.

#. Restore the background level to the cleaned, background-subtracted
diff image.
diff image. Also restore the flat structure if needed by multiplying the
cleaned diff by the flat image.

#. Add the cleaned diff back to a cleaned version of the previous
group image.
Expand Down
2 changes: 1 addition & 1 deletion jwst/clean_flicker_noise/clean_flicker_noise_step.py
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ def process(self, input):
(reference type FLAT) is required. For modes that do not provide
FLAT files via CRDS, including all NIRSpec modes, a manually
generated override flat is required to enable this option.
Use the `override_flat` parameter to provide alternate flat images
Use the `override_flat` parameter to provide an alternate flat image
as needed.
n_sigma : float, optional
Expand Down

0 comments on commit 87f8827

Please sign in to comment.