Skip to content

Commit 37d59cc

Browse files
committed
Update docs
1 parent 7e97f09 commit 37d59cc

File tree

3 files changed

+18
-2
lines changed

3 files changed

+18
-2
lines changed

docs/jwst/clean_flicker_noise/arguments.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,15 @@ the behavior of the processing.
3131
affected by failed-open MSA shutters. For MIRI imaging, mask
3232
regions of the detector not used for science.
3333

34+
``--apply_flat_field`` (boolean, default=False)
35+
If set, images are flat-corrected prior to fitting background
36+
and noise levels. A full-frame flat field image
37+
(reference type FLAT) is required. For modes that do not provide
38+
FLAT files via CRDS, including all NIRSpec modes, a manually
39+
generated override flat is required to enable this option.
40+
Use the `override_flat` parameter to provide an alternate flat image
41+
as needed.
42+
3443
``--n_sigma`` (float, default=2.0)
3544
The sigma-clipping threshold to use when searching for outliers
3645
and illuminated pixels to be excluded from use in the background

docs/jwst/clean_flicker_noise/main.rst

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -184,6 +184,9 @@ information on all referenced parameters.
184184
This will mask out regions of the detector under the metering
185185
structure.
186186

187+
#. If `apply_flat_field` is set and a flat file is available, divide the
188+
draft rate data by the flat image.
189+
187190
#. Iteratively sigma clip the data to get a center value (mean or median)
188191
and sigma value (standard deviation).
189192

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

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

206+
#. If `apply_flat_field` is set and a flat file is available, divide the
207+
diff image by the flat image.
208+
203209
#. Fit and remove a background level, using the scene mask to identify
204210
background pixels.
205211

@@ -231,7 +237,8 @@ information on all referenced parameters.
231237
detector channel.
232238

233239
#. Restore the background level to the cleaned, background-subtracted
234-
diff image.
240+
diff image. Also restore the flat structure if needed by multiplying the
241+
cleaned diff by the flat image.
235242

236243
#. Add the cleaned diff back to a cleaned version of the previous
237244
group image.

jwst/clean_flicker_noise/clean_flicker_noise_step.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ def process(self, input):
8383
(reference type FLAT) is required. For modes that do not provide
8484
FLAT files via CRDS, including all NIRSpec modes, a manually
8585
generated override flat is required to enable this option.
86-
Use the `override_flat` parameter to provide alternate flat images
86+
Use the `override_flat` parameter to provide an alternate flat image
8787
as needed.
8888
8989
n_sigma : float, optional

0 commit comments

Comments
 (0)