wrap_combine_grating_scans

sofia_redux.instruments.fifi_ls.combine_grating_scans.wrap_combine_grating_scans(files, outdir=None, correct_bias=True, allow_errors=False, write=False, jobs=None)

Wrapper for combine_grating_scans over multiple files.

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

Parameters:

filesarray_like of str

paths to files to be scan-combined

outdirstr, optional

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

correct_biasbool, optional

If True, additive offset between separate grating scans will be removed, using overlapping wavelength regions to determine the value of the bias.

allow_errorsbool, optional

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

writebool, optional

If True, write the output to disk and return the filename instead of the HDU.

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