wrap_telluric_correct

sofia_redux.instruments.fifi_ls.telluric_correct.wrap_telluric_correct(files, outdir=None, allow_errors=False, atran_dir=None, atran_file=None, cutoff=0.6, skip_corr=False, write=False, jobs=None, narrow=False, hdr_ovr=True, redshift=0.0, restwav=0.0, use_ecmwf=True, ecmwf_dir=None, ozone_model=39, interpolated=True)

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.

atran_filestr, optional

Exact path to an ATRAN file to use directly. If provided, the normal file selection is skipped.

cutofffloat, optional

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

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.

narrowbool, optional

The telluric correction value at the rest wavelength will be used for the complete cube. Only suitable for certain observations.

hdr_ovrbool, optional

If set, rest wavelength and redshift are not taken from the FITS header but provided manually via restwav and redshift.

restwavfloat, optional

Rest wavelength of the observed line for narrow line mode. Only used if hdr_ovr is set.

redshiftfloat, optional

Redshift z of the observed line for narrow line mode. Only used if hdr_ovr is set.

use_ecmwfbool, optional

If set, water vapor values will be retrieved from ECMWF reanalysis files instead of the header.

ecmwf_dirstr, optional

Path to directory containing ECMWF FITS files.

interpolatedbool, optional

If True (default), linearly interpolate between the four ATRAN files bracketing the observed ZA and WV. If False, use the single nearest-matching file.

Returns:

tuple of str

output filenames written to disk