Documenation for Residual Fringe does not talk about 1D implementation

[stscijgbot-jp]

Issue JP-3352 was created on JIRA by Rosa Diaz:

In Build 9.3 the he current Residual fringe step was updated  to apply to 1d extracted spectra for MIRI MRS data. This, however, is not mentioned in the read-the-docs documentation for the step.

[stscijgbot-jp]

Comment by David Law on JIRA:

Reassigned to myself to update this when I get a chance.  Updates should be made to both the Extrac1d and ResidualFringe docs.

[stscijgbot-jp]

Comment by Jane Morrison on JIRA:

David Law  I took this one on since I am working on documentation.

What can I say about when folks might want to use 2D residual fringe correction vs 1d residual fringe correction ?

 

[stscijgbot-jp]

Comment by David Law on JIRA:

We talk about this a little in the JDox documentation (new MRS Known Issues article coming out this week), but would be useful to say in Readthedocs too.

In brief: 2d residual fringe is nice in that it can defringe an entire cube in theory.  In practice though it takes a long time to run, and doesn't always improve things as much as we'd like.  The 1d residual fringe correction included as an optional flag in extract_1d empirically does a better job and runs MUCH faster, so long as it's applied to per-band spectra.  That doesn't help you if you've got extended source that you're doing custom extractions from the cube to get the spectrum of though.  The new Jdox therefore has some advice for how to run the 1d residual fringing code on your own spectrum extracted with whatever aperture you wanted, in whatever way you wanted: from jwst.residual_fringe.utils import fit_residual_fringes_1d as rf1d flux_cor = {}rf1d(flux, wave, channel{}{}={}{}4{}{}){} (as an example for Ch4 data).  As above it will only really work on per-band data.

[stscijgbot-jp]

Comment by Howard Bushouse on JIRA:

Fixed by #8371

[stscijgbot-jp]

Comment by David Law on JIRA:

Text now in latest readthedocs