spam2isl Documentation

spam2isl - Convert a SPAM library to ISL format
SPAM2ISL creates an Instrument Spectral Library (ISL) file from
a SPAM formated library.  SPAM2ISL takes its wavelength information
from a TABLE file.  Note that BANDTAB can be used to generate the
input table file.  The table file must contain the original band
number, wavelength for each band and the full width at half maximum
value for each wavelength.  Each of these values are contained in a
column in the TABLE file.  The original band column name is BAND,
WAVELN specifies the column for wave lengths and FWHM is the name
of the full width at half maximum column.  Furthermore, the BAND column
must be a 4-byte INTEGER, WAVELN and FWHM 4-byte REAL columns.  The
total number of bands that will be created in the output ISL will
correspond the the number of occupied ROWS found in the TABLE file.

The user may allocate an extra number of ISL entries via the XSPECS
parameter.  The number specified here will be added onto the number of
spectra found in the SPAM library.  This will allow addition of other
spectra to the library.

The user also has the option to set library characteristics that deal
with the type of instrument the SPAM spectra are being convolved to.
The INSTNAME, INSTMODE and INSTUNIT parameters may be set by the user
to specify name of the instrument, instrument mode of spectral
aquisition and the units of the aquired spectra, respectively.
If these parameters are not specified, then the values are searched
for in the TABLE file object under keywords, INSTRUMENT_ID,
INSTRUMENT_MODE_ID and UNITS, respectively.  If any value is
undetermined, it is set to UNKNOWN.

Programmer: Kris Becker, U.S.G.S., Flagstaff

Name of TABLE file containing
the band information

NONE

Name of the TABLE file object
that contains the band
information

" "

SPAM library file name

"$ISISDATA/spamlib.lib"

Output ISL file name

NONE

Number of extra entries in the
ISL to allocate

0

Name of instrument

" "

Spectra aquisition mode of
instrument

" "

Units of spectra

" "

Comment to user

" "

ADDITIONAL NOTES:

Parm	Description
FROM	Name of TABLE file that contains BAND information that will be used to convolve SPAM spectra to the desired spectral signal.
TBLOBJ	Name of TABLE object that contains the BAND information that will be used to create spectra in the output ISL from the input SPAM spectra.
SPAMFILE	Specifies the SPAM format library to convert. The default is set to the SPAM master library.
TO	Output ISL file name. This file specification can optionally include the disk directory of the file. If the file extension is omitted, then ".ISL" will be assumed.
XSPECS	Number of extra entries to allocate in spectral library. The value specified here will be added to the number of SPAM spectra found in the SPAM library and together, they will determine the total number of entries to allocate to the output ISL file.
INSTNAME	Name of the instrument that spectra are being convolved to. The user has the option to specify the name if it is so desirable. If the user does not specify the name of the instrument, then the TABLE file object label description is searched and the value of the INSTRUMENT_ID keyword will be used if it exists. If niether method determines the value, a value of UNKNOWN is used.
INSTMODE	Mode of the instrument that spectra are being convolved to. This specifies the mode the instrument was in during spectral aquisition (if applicable). The user has the option to specify the mode if it is so desirable. If the user does not specify the mode of the instrument, then the TABLE file object label description is searched and the value of the INSTRUMENT_MODE_ID keyword will be used if it exists. If neither method determines the value, a NULL value will be used.
INSTUNIT	Units of the instrument that spectra are being convolved to. The user has the option to specify the units if it is so desirable. If the user does not specify the units of the instrument, then the TABLE file object label description is searched and the value of the UNITS keyword will be used if it exists. If neither method determines the value, a value of UNKNOWN is used.
USERNOTE	Allows the user to add a comment that is recorded in the history and log file for this run.