wrap_telluric_correct

sofia_redux.instruments.fifi_ls.telluric_correct.wrap_telluric_correct(files, outdir=None, allow_errors=False, atran_dir=None, cutoff=0.6, use_wv=False, skip_corr=False, write=False, jobs=None)[source]

Wrapper for telluric_correct over multiple files.

See telluric_correct for full description of reduction on a single file.

Parameters:
filesarray_like of str

paths to files to be telluric corrected

outdirstr, optional

Directory path to write output. If None, output files will be written to the same directory as the input files.

allow_errorsbool, optional

If True, return all created files on error. Otherwise, return None

atran_dirstr, optional

Path to a directory containing ATRAN reference FITS files. If not provided, the default set of files packaged with the pipeline will be used.

cutofffloat, optional

Used as the fractional transmission below which data will be set to NaN. Set to 0 to keep all data.

use_wvbool, optional

If set, water vapor values from the header will be used to select the correct ATRAN file.

skip_corrbool, optional

If set, telluric correction will not be applied, but ATRAN spectra will still be attached to the output file.

writebool, optional

If True, write output files to disk.

jobsint, optional

Specifies the maximum number of concurrently running jobs. Values of 0 or 1 will result in serial processing. A negative value sets jobs to n_cpus + 1 + jobs such that -1 would use all cpus, and -2 would use all but one cpu.

Returns:
tuple of str

output filenames written to disk