Reference Files

The cube_build step uses two reference files: CUBEPAR and RESOL. The RESOL reference file is only used for processing MIRI IFU data. CUBEPAR is used for both NIRSpec and MIRI IFU data.

CUBEPAR reference file

REFTYPE

CUBEPAR

Data models

MiriIFUCubeParsModel, NirspecIFUCubeParsModel

The CUBEPAR reference file contains parameter values used to construct the output IFU cubes.

Reference Selection Keywords for CUBEPAR

CRDS selects appropriate CUBEPAR references based on the following keywords. CUBEPAR is not applicable for instruments not in the table.

Instrument

Keywords

MIRI

INSTRUME, EXP_TYPE, DATE-OBS, TIME-OBS

NIRSPEC

INSTRUME, EXP_TYPE, DATE-OBS, TIME-OBS

Standard Keywords

The following table lists the keywords that are required to be present in all reference files. The first column gives the FITS keyword names. The second column gives the jwst data model name for each keyword, which is useful when using data models in creating and populating a new reference file. The third column gives the equivalent meta tag in ASDF reference file headers, which is the same as the name within the data model meta tree (second column).

FITS Keyword

Data Model Name

ASDF meta tag

AUTHOR

model.meta.author

author

DATAMODL

model.meta.model_type

model_type

DATE

model.meta.date

date

DESCRIP

model.meta.description

description

FILENAME

model.meta.filename

N/A

INSTRUME

model.meta.instrument.name

instrument: {name}

PEDIGREE

model.meta.pedigree

pedigree

REFTYPE

model.meta.reftype

reftype

TELESCOP

model.meta.telescope

telescope

USEAFTER

model.meta.useafter

useafter

NOTE: More information on standard required keywords can be found here: Standard Required Keywords

Type Specific Keywords for CUBEPAR

In addition to the standard reference file keywords listed above, the following keywords are required in CUBEPAR reference files, because they are used as CRDS selectors (see Reference Selection Keywords for CUBEPAR):

Keyword

Data Model Name

EXP_TYPE

model.meta.exposure.type

Reference File Format

CUBEPAR reference files are FITS format, with either 3 (MIRI) or 5 (NIRSpec) BINTABLE extensions. The FITS primary data array is assumed to be empty. The format and content of the file is as follows:

EXTNAME

XTENSION

Dimensions

Instrument

CUBEPAR

BINTABLE

TFIELDS = 6

Both

CUBEPAR_MSM

BINTABLE

TFIELDS = 6

Both

MULTICHANNEL_MSM

BINTABLE

TFIELDS = 5

MIRI only

MULTICHAN_PRISM_MSM

BINTABLE

TFIELDS = 5

NIRSpec only

MULTICHAN_MED_MSM

BINTABLE

TFIELDS = 5

NIRSpec only

MULTICHAN_HIGH_MSM

BINTABLE

TFIELDS = 5

NIRSpec only

The formats of the individual table extensions are listed below, first for the MIRI form of the reference file and then for NIRSpec.

Table

Column

Data type

Units

CUBEPAR

CHANNEL

shortint

N/A

BAND

ch*6

N/A

WAVEMIN

float

microns

WAVEMAX

float

microns

SPAXELSIZE

float

arcseconds

SPECTRALSTEP

double

microns

CUBEPAR_MSM

CHANNEL

shortint

N/A

BAND

ch*6

N/A

ROISPATIAL

float

arcseconds

ROISPECTRAL

double

microns

POWER

double

unitless

SOFTRAD

double

unitless

MULTICHANNEL_MSM

WAVELENGTH

double

microns

ROISPATIAL

double

arcseconds

ROISPECTRAL

double

microns

POWER

double

unitless

SOFTRAD

double

unitless

Table

Column

Data type

Units

CUBEPAR

DISPERSER

ch*5

N/A

FILTER

ch*6

N/A

WAVEMIN

double

microns

WAVEMAX

double

microns

SPAXELSIZE

double

arcseconds

SPECTRALSTEP

double

microns

CUBEPAR_MSM

DISPERSER

ch*5

N/A

FILTER

ch*6

N/A

ROISPATIAL

double

arcseconds

ROISPECTRAL

double

microns

POWER

double

unitless

SOFTRAD

double

unitless

MULTICHAN_PRISM_MSM

WAVELENGTH

double

microns

ROISPATIAL

double

arcseconds

ROISPECTRAL

double

microns

POWER

double

unitless

SOFTRAD

double

unitless

MULTICHAN_MED_MSM

WAVELENGTH

float

microns

ROISPATIAL

double

arcseconds

ROISPECTRAL

double

microns

POWER

double

unitless

SOFTRAD

double

unitless

MULTICHAN_HIGH_MSM

WAVELENGTH

float

microns

ROISPATIAL

double

arcseconds

ROISPECTRAL

double

microns

POWER

double

unitless

SOFTRAD

double

unitless

These reference files contain tables for each wavelength band giving the spatial and spectral size, and the size of the region of interest (ROI) to use to construct an IFU cube. If more than one wavelength band is used to build the IFU cube, then the final spatial and spectral size will be the smallest one from the list of input bands. The “CUBEPAR” table contains the spatial and spectral cube sample size for each band. The “CUBEPAR_MSM” table contains the Modified Shepard Method (MSM) weighting values to use for each band. The “MULTICHANNEL_MSM” table contains the wavelengths and associated region of interest size to use when IFU cubes are created from several bands and the final output is to have an IFU cube of varying spectral scale.

For MIRI, the twelve spectral bands can be combined into a single IFU cube, in which case all of the information needed to create cubes of varying wavelength sampling is contained in this table. For NIRSpec IFU data, however, there are three types of multi-band cubes that can be created: PRISM, MEDIUM, and HIGH resolution. The three MULTICHAN_<type>_MSM tables in the NIRSpec version of the reference file contain the wavelength sampling and region of interest size information to use with each of these types of multi-band cubes.

RESOL reference file

REFTYPE

RESOL

Data model

MiriResolutionModel

The RESOL reference file contains the MIRI MRS PSF and LSF widths, per wavelength band. This information is used if the cube_build weight function incorporates the size of the PSF and LSF, i.e. when using the parameter setting “–weighting = miripsf”.

Reference Selection Keywords for RESOL

CRDS selects appropriate RESOL references based on the following keywords. RESOL is not applicable for instruments not in the table.

Instrument

Keywords

MIRI

INSTRUME, DETECTOR, CHANNEL, DATE-OBS, TIME-OBS

Standard Keywords

The following table lists the keywords that are required to be present in all reference files. The first column gives the FITS keyword names. The second column gives the jwst data model name for each keyword, which is useful when using data models in creating and populating a new reference file. The third column gives the equivalent meta tag in ASDF reference file headers, which is the same as the name within the data model meta tree (second column).

FITS Keyword

Data Model Name

ASDF meta tag

AUTHOR

model.meta.author

author

DATAMODL

model.meta.model_type

model_type

DATE

model.meta.date

date

DESCRIP

model.meta.description

description

FILENAME

model.meta.filename

N/A

INSTRUME

model.meta.instrument.name

instrument: {name}

PEDIGREE

model.meta.pedigree

pedigree

REFTYPE

model.meta.reftype

reftype

TELESCOP

model.meta.telescope

telescope

USEAFTER

model.meta.useafter

useafter

NOTE: More information on standard required keywords can be found here: Standard Required Keywords

Type Specific Keywords for RESOL

In addition to the standard reference file keywords listed above, the following keywords are required in RESOL reference files, because they are used as CRDS selectors (see Reference Selection Keywords for RESOL):

Keyword

Data Model Name

CHANNEL

model.meta.instrument.channel

Reference File Format

MIRI RESOL reference files are FITS format, with three BINTABLE extensions. The FITS primary data array is assumed to be empty. The format and content of the file is as follows:

EXTNAME

XTENSION

Dimensions

RESOLVING_POWER

BINTABLE

TFIELDS = 11

PSF_FWHM_ALPHA

BINTABLE

TFIELDS = 5

PSF_FWHM_BETA

BINTABLE

TFIELDS = 5

The formats of the individual table extensions are listed below.

Table

Column

Data type

Units

RESOLVING_POWER

SUB_BAND

ch*16

N/A

R_CENTRE

double

microns

R_A_LOW

double

N/A

R_B_LOW

double

1/microns

R_C_LOW

double

1/microns2

R_A_HIGH

double

N/A

R_B_HIGH

double

1/microns

R_C_HIGH

double

1/microns2

R_A_AVG

double

N/A

R_B_AVG

double

1/microns

R_C_AVG

double

1/microns2

PSF_FWHM_ALPHA

A_CUTOFF

double

microns

A_A_SHORT

double

arcsec

A_B_SHORT

double

arcsec/micron

A_A_LONG

double

arcsec

A_B_LONG

double

arcsec/micron

PSF_FWHM_BETA

B_CUTOFF

double

microns

B_A_SHORT

double

arcsec

B_B_SHORT

double

arcsec/micron

B_A_LONG

double

arcsec

B_B_LONG

double

arcsec/micron

The RESOLVING_POWER table contains information to use for each band. This table has 12 rows and 11 columns; one row of information for each MIRI band. The 11 columns contain the polynomial coefficients used to determine the resolving power for each band. The PSF_FWHM_ALPHA table has a format of 1 row and 5 columns. The 5 columns contain the polynomial coefficients used for determining the alpha coordinate PSF size. Similarly, the PSF_FWHM_BETA table has a format of 1 row and 5 columns, which contain the polynomial coefficients used for determining the beta coordinate PSF size.