getcalpath

sofia_redux.instruments.forcast.getcalpath.getcalpath(header, pathcal=None)[source]

Return the path of the ancillary files used for the pipeline.

Looks up default calibration files and other reference data in the calibration data path, based on the characteristics of the observation, as recorded in the input header.

Parameters:
headerastropy.io.fits.header.Header
pathcalstr, optional

File path to calibration data directory that contains the default calibration files. If not provided, the default data location will be used (sofia_redux.instruments.forcast/data).

Returns:
collections.OrderedDict
namestr

Name of the config mode.

gmodeint

The grism mode to be used during the reduction.

cnmodeint

The chop/nod mode to be used during the reduction.

obstypestr

Observation type.

srctypestr

Source type.

spectelstr

Name of the spectral element used for the observation.

slitstr

Name of the slit used for the observation.

pathcalstr

Base file path for calibration data.

conffilestr

File path to the configuration file.

kwfilestr

File path to the keyword definition file.

badfilestr

File path to the bad pixel mask.

pinfilestr

File path to the pinhole mask locations.

pixshiftxfloat

Shift to add to CRPIX1 to account for filter shifts.

pixshiftyfloat

Shift to add to CRPIX2 to account for filter shifts.

maskfilestr

File path to the grism order mask file.

wavefilestr

File path to the grism wavelength calibration file.

resolutionfloat

Spectral resolution for the grism mode

respfilestr

File path to the grism instrument response file.

slitfilefloat

File path to the grism slit function file.

linefilestr

File path to a line list for wavelength calibration.

wminint

Approximate minimum wavelength for the instrument. Used to identify matching ATRAN files.

wmaxint

Approximate maximum wavelength for the instrument. Used to identify matching ATRAN files.

errorbool

True if there was an error retrieving the files.