ResidualFringeCorrection

class jwst.residual_fringe.residual_fringe.ResidualFringeCorrection(input_model, residual_fringe_reference_file, regions_reference_file, ignore_regions, save_intermediate_results=False, transmission_level=80, make_output_path=None)

Bases: object

Calculate and apply correction for residual fringes.

Parameters:

input_modelIFUImageModel

Input data to correct; updated in-place.

residual_fringe_reference_filestr

Path to FRINGEFREQ reference file.

regions_reference_filestr

Path to REGIONS reference file.

ignore_regionsdict

Wavelength regions to ignore. Keys are “num”, “min”, and “max”. Values are the number of regions specified (int), the list of minimum wavelength values, and the list of maximum wavelength values. Length of minimum and maximum lists must match.

save_intermediate_resultsbool, optional

If True, intermediate files are saved to disk.

transmission_levelint, optional

The transmission level used to extract the appropriate region definitions from the REGIONS reference file.

make_output_pathcallable or None, optional

If provided, is used to create the output file names when save_intermediate_results is True. If None, filenames are created with the default Step.make_output_path method.

Methods Summary

calc_weights()	Make a weights array based on flux.
do_correction()	Apply residual fringe correction to a copy of input model.

Methods Documentation

calc_weights()

Make a weights array based on flux.

This is a placeholder function. For now, it just returns a normalised flux array to use as a weights array. This is because any smoothing results in incorrect fringe correction around emission lines. This can be changed in the future if need be.

Returns:

weightsndarray

Weights array.

do_correction()

Apply residual fringe correction to a copy of input model.

Returns:

output_modelIFUImageModel

Datamodel with correction applied.