PDS Imaging Node
Spectra Dictionary

• Hierarchical Listing of Classes
• Alphabetical Listing of Classes
• Alphabetical Listing of Attributes
• Class Definitions
• Attribute Dictionary

The Spectra dictionary contains classes that describe the spectral characteristics of Array (and Array subclass) data objects, and of the instruments that acquired them.

• Spectral_Characteristics

• comment
• bin_width_desc

• Local_Internal_Reference

• local_identifier_reference
• local_reference_type
• comment

• Axis_Uniformly_Sampled

• sampling_parameter_type
• sampling_interval
• bin_width
• first_center_value
• last_center_value

• Local_Internal_Reference

• local_identifier_reference
• local_reference_type
• comment

• Axis_Bin_Set

• Local_Internal_Reference

• local_identifier_reference
• local_reference_type
• comment

• Bin

• bin_sequence_number
• center_value
• bin_width
• detector_number
• grating_position
• original_bin_number
• scaling_factor
• value_offset

• Filter

• filter_name
• filter_number

• xs:any

• Spectral_Lookup

• Local_Internal_Reference

• local_identifier_reference
• local_reference_type
• comment

• Internal_Reference

• comment
• lid_reference
• lidvid_reference
• reference_type

• Axis_Bin_Set
• Axis_Uniformly_Sampled
• Bin
• Filter
• Local_Internal_Reference
• Spectral_Characteristics
• Spectral_Lookup

• bin_sequence_number
• bin_width
• bin_width_desc
• center_value
• comment
• detector_number
• filter_name
• filter_number
• first_center_value
• grating_position
• last_center_value
• lid_reference
• lidvid_reference
• local_identifier_reference
• local_reference_type
• original_bin_number
• reference_type
• sampling_interval
• sampling_parameter_type
• scaling_factor
• value_offset

Axis_Bin_Set

Class Description: The Axis_Bin_Set class describes the spectral characteristics of each band along a spectral axis of an Array. This class is used in cases where the spectral information is not uniform along the spectral axis.

	Entity	Card	Value/Class
Hierarchy	pds:Tagged_NonDigital_Object
	. Axis_Bin_Set
Subclasses	none
Attributes	none
Associations	has_Local_Internal_Reference	1..*	Local_Internal_Reference
	has_Bin	1..*	Bin

Axis_Uniformly_Sampled

Class Description: The Axis_Uniformly_Sampled class provides attributes describing the spectral characteristics of an axis of an Array object, in cases where the spectral sampling interval is regular.

	Entity	Card	Value/Class
Hierarchy	pds:Tagged_NonDigital_Object
	. Axis_Uniformly_Sampled
Subclasses	none
Attributes	sampling_parameter_type	1	wavelength wavenumber frequency
	sampling_interval	1
	bin_width	1
	first_center_value	1
	last_center_value	1
Associations	has_Local_Internal_Reference	1..*	Local_Internal_Reference

Bin

Class Description: The Bin class specifies the characteristics of an individual bin along a spectral or other binned axis in an Array object.

	Entity	Card	Value/Class
Hierarchy	pds:Tagged_NonDigital_Object
	. Bin
Subclasses	none
Attributes	bin_sequence_number	1
	center_value	1
	bin_width	1
	detector_number	0..1
	grating_position	0..1
	original_bin_number	0..*
	scaling_factor	0..1
	value_offset	0..1
Associations	has_Filter	0..1	Filter
	any (incomplete)

Filter

Class Description: The Filter class identifies the filter associated with a specific band or bin along a spectral axis in an Array object. The filter may be identified by either name, identifier, or number or some combination of these.

	Entity	Card	Value/Class
Hierarchy	pds:Tagged_NonDigital_Object
	. Filter
Subclasses	none
Attributes	filter_name	0..1
	filter_number	0..1
Associations	none

Internal_Reference

Class Description: The Internal_Reference class is used to cross-reference other products in the PDS registry system.

	Entity	Card	Value/Class
Hierarchy	pds:Tagged_NonDigital_Object
	. Internal_Reference
Subclasses	none
Attributes	comment	0..1
	lid_reference	0..1
	lidvid_reference	0..1
	reference_type	1	spectral_characteristics_to_bin_center_values spectral_characteristics_to_bin_width_values
Associations	none

Local_Internal_Reference

Class Description: The Local_Internal_Reference class is used to cross-reference other classes or objects within the product.

	Entity	Card	Value/Class
Hierarchy	pds:Tagged_NonDigital_Object
	. Local_Internal_Reference
Subclasses	none
Attributes	local_identifier_reference	1
	local_reference_type	1	spectral_characteristics_to_array_axis spectral_characteristics_to_array_object spectral_characteristics_to_bin_center_values spectral_characteristics_to_bin_width_values
	comment	0..1
Associations	none

Spectral_Characteristics

Class Description: The Spectral_Characteristics class provides information about the spectral characteristics of an Array object.

	Entity	Card	Value/Class
Hierarchy	pds:Tagged_NonDigital_Object
	. Spectral_Characteristics
Subclasses	none
Attributes	comment	0..1
	bin_width_desc	1
Associations	has_Local_Internal_Reference	1..*	Local_Internal_Reference
	choice(sp.Axis_Uniformly_Sampled,sp.Axis_Bin_Set,sp.Spectral_Lookup) (incomplete)

Spectral_Lookup

Class Description: The Spectral_Lookup class references a 2-dimensional lookup map providing spectral characteristics for a corresponding spectral Array object. The referenced lookup map may either be internal to the referencing product, or an external stand-alone product.

	Entity	Card	Value/Class
Hierarchy	pds:Tagged_NonDigital_Object
	. Spectral_Lookup
Subclasses	none
Attributes	none
Associations	choice(sp.Local_Internal_Reference,pds.Internal_Reference) (incomplete)

bin_sequence_number

The bin_sequence_number provides the sequential numbering of bins along an axis in an Array object.

Type: ASCII_Integer
Minimum Value: 1
Nillable: false
Steward: img
Name Space Id: sp


Terminological Entries:
- QUBE.BAND_BIN.BAND_BIN_BAND_NUMBER (English, PDS3)
- QUBE.BAND_BIN.BAND_BIN_WIDTH (English, PDS3)
- SPECTRAL_QUBE.BAND_BIN.BAND_BIN_BAND_NUMBER (English, PDS3)
- SPECTRAL_QUBE.BAND_BIN.BAND_BIN_WIDTH (English, PDS3)


bin_width

The bin_width attribute provides the width of a bin along a spectral axis in an Array object, in the specified units. The method used to calculate the width must be specified using the bin_width_desc attribute.

Type: ASCII_Real
Unit of Measure Type: sp:Units_of_Spectra
Minimum Value: 0.0
Nillable: false
Steward: img
Name Space Id: sp


bin_width_desc

The bin_width_desc attributes provides a description of the method used to calculate the bin_width of a bin along a spectral axis in an Array object. The description should include information on the shape (e.g. gaussian, square wave, etc.) and what the bin_width value means (i.e., standard deviation of a gaussian function or full-width at half max (FWHM)).

Type: ASCII_Text_Preserved
Minimum Characters: 1
Nillable: false
Steward: img
Name Space Id: sp


center_value

The center_value attribute provides the wavelength, wave number, or frequency describing the center of a bin along the band axis of a spectral data object. When describing data from a spectrometer, the value corresponds to the peak of the response function for a particular detector and/or grating position.

Type: ASCII_Real
Unit of Measure Type: sp:Units_of_Spectra
Minimum Value: 0.0
Nillable: false
Steward: img
Name Space Id: sp


comment

The comment attribute provides one or more remarks or thoughts relevant to the object.

Type: ASCII_Text_Preserved
Minimum Characters: 1
Nillable: false
Steward: pds
Name Space Id: pds


detector_number

The detector_number attribute provides the spectrometer detector number corresponding to a band of a spectral qube. Detector numbers are usually assigned consecutively from 1, in order of increasing wavelength.

Type: ASCII_Integer
Minimum Value: 1
Nillable: false
Steward: img
Name Space Id: sp


filter_name

The filter_name attribute provides the commonly-used name of the instrument filter through which an image or measurement was acquired or which is associated with a given instrument mode.

Type: ASCII_Short_String_Collapsed
Minimum Characters: 1
Nillable: false
Steward: img
Name Space Id: sp


filter_number

The filter_number attribute provides the numeric identifier of an instrument filter through which an image or measurement was acquired or which is associated with a given instrument mode. Within the bin class of a spectral data object, it identifies the filter through which data in the given band were acquired.

Type: ASCII_Integer
Minimum Value: 0
Nillable: false
Steward: img
Name Space Id: sp


first_center_value

The first_center_value attribute provides the wavelength, wave number, or frequency describing the center of the first bin along the spectral axis of a spectral data object.

Type: ASCII_Real
Unit of Measure Type: sp:Units_of_Spectra
Minimum Value: 0.0
Nillable: false
Steward: img
Name Space Id: sp


grating_position

The grating_position attribute of a spectral qube describes the grating position which corresponds to the band. Grating positions are usually assigned consecutively from 0, and increasing position causes increasing wavelength for each detector.

Type: ASCII_Integer
Minimum Value: 0
Nillable: false
Steward: img
Name Space Id: sp


last_center_value

The last_center_value attribute provides the wavelength, wave number, or frequency describing the center of the last bin along the spectral axis of a spectral data object.

Type: ASCII_Real
Unit of Measure Type: sp:Units_of_Spectra
Minimum Value: 0.0
Nillable: false
Steward: img
Name Space Id: sp


lidvid_reference

The lidvid_reference attribute provides the logical_identifier plus version_id, which uniquely identifies a product.

Type: ASCII_LIDVID
Minimum Characters: 19
Maximum Characters: 127
Nillable: false
Steward: pds
Name Space Id: pds


lid_reference

The lid_reference attribute provides the logical_identifier for a product.

Type: ASCII_LID
Minimum Characters: 14
Maximum Characters: 127
Nillable: false
Steward: pds
Name Space Id: pds


local_identifier_reference

The local_identifier_reference attribute provides the local_identifier of the digital object described by the referencing class. Note that a local_identifier attribute, with the same value as this local_identifier_reference, must be present within the label.

Type: ASCII_Short_String_Collapsed
Nillable: false
Steward: img
Name Space Id: sp


local_reference_type

The local_reference_type attribute provides the name of an association between an entity identified by a local_identifier_reference and another corresponding entity identified by a local_identifier

Type: ASCII_Short_String_Collapsed
Nillable: false
Steward: img
Name Space Id: sp


Values:
- spectral_characteristics_to_array_axis - The spectral characteristics described here pertain to the referenced array axis.
- spectral_characteristics_to_array_object - The spectral characteristics described here pertain to the referenced array.
- spectral_characteristics_to_bin_center_values - The spectral array described here is associated with another array (object or product) that describes the bin center values of the detector for this array.
- spectral_characteristics_to_bin_width_values - The spectral array described here is associated with another array (object or product) that describes the bin width values of the detector for this array.


original_bin_number

The original_bin_number attribute of a spectral Array object is used when the current data object is a subset of some original data object. The original_bin_number for each band identifies the bin_sequence_number of the corresponding band in the original data object.

Type: ASCII_Integer
Minimum Value: 1
Nillable: false
Steward: img
Name Space Id: sp


reference_type

The reference_type attribute provides the name of the association.

Type: ASCII_Short_String_Collapsed
Minimum Characters: 1
Maximum Characters: 127
Nillable: false
Steward: pds
Name Space Id: pds


Values:
- spectral_characteristics_to_bin_center_values - The spectral array described here is associated with another array (object or product) that describes the bin center values of the detector for this array.
- spectral_characteristics_to_bin_width_values - The spectral array described here is associated with another array (object or product) that describes the bin width values of the detector for this array.


sampling_interval

The sampling_interval attribute provides the spacing of points at which data are sampled and at which a value for an instrument or data parameter is available. This sampling interval can be either the original (raw) sampling or the result of some resampling process. The sampling parameter (wavelength, frequency, etc.) is identified by the sampling_parameter_type attribute.

Type: ASCII_Real
Unit of Measure Type: sp:Units_of_Spectra
Minimum Value: 0.0
Nillable: false
Steward: img
Name Space Id: sp


sampling_parameter_type

The sampling_parameter_type attribute indicates the nature of the parameter specified along the spectral axis in an Array object.

Type: ASCII_Short_String_Collapsed
Minimum Characters: 9
Maximum Characters: 11
Nillable: false
Steward: img
Name Space Id: sp


Values:
- wavelength - Values along the spectral axis in the Array data object are provided in units of wavelength, i.e., in terms of the distance between successive crests of the electromagnetic wave.
- wavenumber - Values along the spectral axis in the Array data object are provided in units of wavenumber, i.e., in terms of the number of waves in a unit distance.
- frequency - Values along the spectral axis in the Array data object are provided in units of frequency, i.e., in terms of the number of waves in a unit of time.


scaling_factor

The scaling_factor attribute is the scaling factor to be applied to each stored value in order to recover an original value. The observed value (Ov) is calculated from the stored value (Sv) thus: Ov = (Sv * scaling_factor) + value_offset. The default value is 1.

Type: ASCII_Real
Nillable: false
Steward: pds
Name Space Id: pds


value_offset

The value_offset attribute is the offset to be applied to each stored value in order to recover an original value. The observed value (Ov) is calculated from the stored value (Sv) thus: Ov = (Sv * scaling_factor) + value_offset. The default value is 0.

Type: ASCII_Real
Nillable: false
Steward: pds
Name Space Id: pds


xs:any

The xs:any structure permits the inclusion in a class of any attribute from a namespace other than the namespace of the current class. For example, it would permit the inclusion of mission defined attributes in a discipline defined class, if that class included the xs:any construct.