hdrkeys Documentation

hdrkeys - Set keywords in Table file for ISL spectrum header info
"hdrkeys" is intended to set or update keyword values in the label
of a Table file that contains a spectrum.  This information will
then be used by the "tbl2isl" program for setting the Instrument
Spectral Library (ISL) header fields when the spectrum is
inserted into an ISL file.  The information that can be specified
by "hdrkeys" also includes the names of the ISL spectrum families
with which the spectrum will be associated and the type codes for
the spectrum's secondary data arrays (if any).

If a TAE parameter has a NULL value, the corresponding keyword in
the label will not be set.  If a value is specified, then the
value of the corresponding keyword will be set.  This will either
create a new keyword or update the value of an existing keyword.

Values for the SPECTRUM_NAME and SPECTRUM_TYPE_ID (specified
by the SPECNAME and SPECTYPE parameters) are required in an ISL
spectrum header.  (These values can optionally be specified
when running "tbl2isl".)  All other spectrum header fields, family
names and secondary data arrays are optional.

The spectral header information is written to the label as keywords
in the SPECTRAL_HEADER_DATA Group.  The names of these keywords
correspond to the names of the ISL spectral header fields.  The
family names list is written as the value of the FAMILY_NAME keyword.
The type codes for the secondary data arrays are written as the value
of the SPECTRUM_TYPE_ID keyword in the SECONDARY_HEADER_DATA Group.

"hdrkeys" also writes a description of the structure of the ISL
spectrum header into the SPECTRAL_HEADER_DEFINITION Group of keywords.
This structure definition is used by "tbl2isl" when creating a new
ISL file.

Programmer:  Tracie Stoewe, U.S.G.S., Flagstaff

Table file to be updated
  (Default extension is .tbl)

NONE

Name of TABLE OBJECT

"TABLE"

Spectrum name
  (40 characters)

NONE

Spectrum Type ID (1-11)

NONE

Material State ID (0-7)

--

Source type ID (1-4)

--

Source name

--

Source Index 1

--

Source Index 2

--

Source Box Width
  (Number of SAMPLES)

--

Source Box Height
  (Number of LINES)

--

Number of spectra in average

--

Chemical composition forumula

--

Surface pressure of a gas
 (PASCALS)

--

Sample temperature (KELVIN)

--

Path length (METERS)

--

Incidence angle (DEGREES)

--

Emission angle (DEGREES)

--

Phase angle (DEGREES)

--

Family names

--

Secondary data array type codes
  (-1 to -6)

--

User comment

" "

ADDITIONAL NOTES:

Parm	Description
FROM	Name of Table file whose label is to be updated. If the file extension is omitted, then ".tbl" will be assumed.
OBJNAM	Name of TABLE OBJECT that contains the spectrum.
SPECNAME	SPECTRUM_NAME ISL spectrum header field. The name of the spectrum. Must be unique for all primary spectra within an Instrument Spectral Library file.
SPECTYPE	SPECTRUM_TYPE_ID ISL spectrum header field. Specifies type of stored primary spectrum. Primary spectra type codes have positive values while secondary data codes have negative values. Valid primary spectrum codes: 0 = reserved for system usage 1 = real part of complex index of refraction 2 = radiance 3 = reflectance 4 = reflectance*solar spectrum 5 = transmission 6 = transmission*solar spectrum 7 = absorption 8 = absorption coefficient 9 = emissivity 10 = instrument noise spectrum 11 = unclassifiable
STATE	MATERIAL_STATE_ID ISL spectrum header field. Specifies the state of the observed medium. 0 = unknown 1 = gas 2 = liquid 3 = solid, polished 4 = solid, rough 5 = solid, particulate 6 = natural surface (remote sensed) 7 = suspended droplets (clouds)
SORCTYPE	SOURCE_TYPE_ID ISL spectrum header field. Code that helps identify where the spectrum originated. 1 = laboratory 2 = Fight instrument via SPECAVE or other such applications 3 = theory 4 = others (?)
SORCNAME	SOURCE_NAME ISL spectrum header field. Name of the source where the spectrum originated. Dependent on the SORCTYPE. If SORCTYPE=1,3 or 4, SORCNAME will be the name of the person who generated the spectrum. If SORCTYPE=2, SORCNAME will contain the name of the file from which the spectrum was generated.
SORCINX1	SOURCE_INDEX_1 ISL spectrum header field. This is additional information about the spectrum source. If SORCTYPE=1, this indicates the library number. If SORCTYPE=2, the source is from applications and this contains the SAMPLE from a file where the spectrum was obtained. If SORCTYPE=3, this refers to the run number.
SORCINX2	SOURCE_INDEX_2 ISL spectrum header field. A second field containing information about the spectrum source. If SORCTYPE=1, this specifies the location or index of the spectrum from the library. If SORCTYPE=2, this specifies LINE number from a file where the spectrum was obtained. If SORCTYPE=3, this is used for the curve number.
WIDTH	SOURCE_REGION_WIDTH ISL spectrum header field. If SORCTYPE=1 or 3, this is undefined. If SORCTYPE=2, this specifies the width of the box size in SAMPLES used in the "cubespec" or "cv" program to generate the spectrum.
HEIGHT	SOURCE_REGION_HEIGHT ISL spectrum header field. If SORCTYPE=1 or 3, this is undefined. If SORCTYPE=2, this specifies the height of the box size in LINES used in the "cubespec" or "cv" program to generate the spectrum.
AVECOUNT	AVERAGED_SPECTRUM_COUNT ISL spectrum header field. This specifies the total number of observed or original spectra averaged to generate this spectrum.
CHEMDESC	CHEMICAL_DESCRIPTION ISL spectrum header field. ASCII representation of the chemical composition formula of the material. This can also be used as a comment.
PRESSURE	MATERIAL_PRESSURE ISL spectrum header field. Specifies the surface pressure of a gas in PASCALS.
TEMP	MATERIAL_TEMPERATURE ISL spectrum header field. Specifies the sample temperature in KELVIN.
PATHLENG	MATERIAL_PATH_LENGTH ISL spectrum header field. This is the path length in a fluid, the particle size of a particulate solid, or the mean crystal size for rough or polished solids (METERS)
INCIDENC	INCIDENCE_ANGLE ISL spectrum header field. Angle between viewer and the SUN in DEGREES.
EMISSION	EMISSION_ANGLE ISL spectrum header field. Angle between viewer and the spacecraft in DEGREES.
PHASE	PHASE_ANGLE ISL spectrum header field. Angle between spacecraft and the SUN in DEGREES.
FAMNAME	Names of families which this spectrum will be entered into. These will be defined as "permanent families" in the ISL.
SECTYPE	Specifies type of stored secondary data arrays. These should be entered in the order of the columns in the Table file following the wavelength and spectral value, i.e., for columns 3-N. Primary spectra type codes have positive values while secondary data codes have negative values. Valid secondary type codes: -6 = count of valid pixels in averaged group -5 = maximum of averaged group -4 = minimum of averaged group -3 = standard deviation of averaged group -2 = uncertainty -1 = imaginary part of any complex type defined by its primary ID
USERNOTE	Comment from the user. This will be recorded in the ISIS session log file and in the History entry that is put into the Hisory object of the output file.