wrap_spatial_calibrate

sofia_redux.instruments.fifi_ls.spatial_calibrate.wrap_spatial_calibrate(files, outdir=None, obsdate=None, flipsign=None, rotate=True, allow_errors=False, write=False, jobs=None)

Wrapper for spatial_calibrate over multiple files.

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

Parameters:

filesarray_like of str

paths to files to be spatially calibrated

outdirstr, optional

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

obsdatearray_like of int, optional

Date of observation. Intended for files that do not have the DATE-OBS keyword (and value) in the FITS primary header (early files do not). Format is [YYYY,MM,DD].

flipsignbool, optional

If True, DLAM_MAP and DBET_MAP will be multiplied by -1. If False, DLAM_MAP and DBET_MAP will be used as is. If None (default), the observation date will be used to determine what the sign convention should be.

rotatebool, optional

If True, rotate by the detector angle to set N up.

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