Reference Files¶

The tso_photometry step uses a TSOPHOT reference file.

TSOPHOT Reference File¶

REFTYPE

TSOPHOT

Data model

TsoPhotModel

The TSOPHOT reference file contains photometry aperture radii for TSO imaging observation modes.

Reference Selection Keywords for TSOPHOT¶

CRDS selects appropriate TSOPHOT references based on the following keywords. TSOPHOT is not applicable for instruments not in the table. All keywords used for file selection are required.

Instrument

Keywords

MIRI

INSTRUME, EXP_TYPE, TSOVISIT, DATE-OBS, TIME-OBS

NIRCam

INSTRUME, EXP_TYPE, TSOVISIT, 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 TSOPHOT¶

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

Keyword

Data Model Name

EXP_TYPE

model.meta.exposure.type

TSOVISIT

model.meta.visit.tsovisit

Reference File Format¶

TSOPHOT reference files are ASDF format. An object called ‘radii’ in a TSOPHOT file defines the radii that the step needs. This object is a list of one or more dictionaries. Each such dictionary has four keys: ‘pupil’, ‘radius’, ‘radius_inner’, and ‘radius_outer’. The particular one of these dictionaries to use is selected by comparing meta.instrument.pupil with the value corresponding to ‘pupil’ in each dictionary. If an exact match is found, that dictionary will be used. If no match is found, the first dictionary with ‘pupil’: ‘ANY’ will be selected. The radii will be taken from the values of keys ‘radius’, ‘radius_inner’, and ‘radius_outer’.