Reference File Handlers (nips.references)

This module includes all reference file handling classes. Those classes are used to create, load and save reference files. Each pipeline step has its dedicated reference file class, even if the step does not necessarily need a reference file (and the reference file class is empty), it will still need an instance of this class to remain the same structure as the other pipeline steps (see here for an example).

In addition to the reference file handling classes, this module also includes the functions to search the reference file repository and a references.Keywords class to handle the header keywords of the reference files.

For more information on reference files and the reference file repository see ESA-JWST-SCI-NRS-DD-2017-001.

nips.references Package

The nips.references module contains the reference file classes for the nips package.

Functions

f_build_list([ref_types, nips_only, …])	Function to build (and check) the list of required reference file types
f_build_params(data_keywords, ref_type, …)	Function to build a list of parameters given a ref_file type
f_build_ref_list(glob_output, data_keywords, …)	Function to build a list of relevant reference files given a list of files.
f_check_date(date[, return_none, logger])	Check date is correct format, and convert to datetime instance if recognizable alternative.
f_check_header(filepath, ref_type[, …])	Function to check (and update) the header of all reference files of the given type(s)
f_check_repo_header([ref_types, repo_path, …])	Function to check (and update) the header of all reference files of the given type(s)
f_check_version(version[, return_none, logger])	Check version is correct format, and convert if a recognizable alternative
f_find_ref_files([data_keywords, date, …])	Function to find the required reference files.
f_ingest_ref_files(input_list, ref_path[, …])	Function to ingest the listed files into the reference file repository.
f_make_delivery(ref_file_list, output_file)	Function to create a delivery package (zip archive) from a list of files
f_print_list(input_list, repo_path[, logger])	Function to print the final query list nicely

Classes

Aperture([logger_id])	Class for the description of the properties of an aperture.
BarsRef([logger_id])	Class for the description of the bar shadow correction (bars) reference.
CubeRef([logger_id])	Class for the description of the cube building (cube) reference (Currently just a dummy).
DfltRef([logger_id])	Class for the description of the NIRSpec detector flat (dflt) reference.
ExtiRef([logger_id])	Class for the description of the 1d extraction (extr) reference.
ExtrRef([logger_id])	Class for the description of the 1d extraction (extr) reference file.
FfltRef([logger_id])	Class for the description of the NIRSpec FORE+OTE flat (fflt) reference.
IfltRef([logger_id])	Class for the description of the NIRSpec detector flat (iflt) reference.
ImodRef()	Class for the description of the bar shadow correction (imod) reference.
Keywords([logger_id])	Class for the handling of the keywords of the NIRSpec reference files.
PampRef([logger_id])	Class for the description of the NIRSpec Pixel Area Map correction (pamp) reference.
PthlRef([logger_id])	Class for the description of the NIRSpec pathloss correction (pthl) reference.
RadmRef([logger_id])	Class for the description of the NIRSpec radiometric correction (radm) reference.
RectRef([logger_id])	Class for the description of the rectification (rect) reference.
ScwlRef([logger_id])	Class for the description of the NIRSpec configuration reference files.
SfltRef([logger_id])	Class for the description of the NIRSpec spectrograph flat (sflt) reference.
SiafRef()	Class for the description of the reference SIAF aperture table.
WlzpRef([logger_id])	Class for the description of the wavelength zerpoint correction (wlzp) reference.
XMLSiafRef([logger_id])	Container and utility class for the STScI XML reference SIAF file for NIRSpec.

Class Inheritance Diagram