Imaging Dictionary
This is for version 1J00_1870 of the imaging namespace. Note that the "Imaging" superclass is optional.
Contents
- 1 <Companding>
- 2 <Detector>
- 2.1 <first_line>
- 2.2 <first_sample>
- 2.3 <lines>
- 2.4 <samples>
- 2.5 <detector_to_image_rotation>
- 2.6 <detector_to_image_flip>
- 2.7 <erase_count>
- 2.8 <readout_rate>
- 2.9 <gain_mode_id>
- 2.10 <gain_number>
- 2.11 <analog_offset>
- 2.12 <bad_pixel_replacement_flag>
- 2.13 <bad_pixel_replacement_table_id>
- 2.14 <instrument_idle_timeout>
- 2.15 <early_image_return>
- 2.16 <parameter_table_id>
- 2.17 <Special_Point>
- 2.18 <pds:Internal_Reference>
- 3 <Exposure>
- 3.1 <exposure_count>
- 3.2 <exposure_duration>
- 3.3 <exposure_duration_count>
- 3.4 <exposure_type>
- 3.5 <exposure_scale_factor>
- 3.6 <exposure_coadd_count>
- 3.7 <exposure_readout_time>
- 3.8 <Autoexposure>
- 3.8.1 <active_flag>
- 3.8.2 <processing_venue>
- 3.8.3 <processing_algorithm>
- 3.8.4 <sequence_number>
- 3.8.5 <auto_exposure_data_cut>
- 3.8.6 <auto_exposure_percent>
- 3.8.7 <auto_exposure_pixel_fraction>
- 3.8.8 <auto_exposure_lower_threshold>
- 3.8.9 <auto_exposure_lower_limit>
- 3.8.10 <auto_exposure_roi_first_line>
- 3.8.11 <auto_exposure_roi_first_sample>
- 3.8.12 <auto_exposure_roi_lines>
- 3.8.13 <auto_exposure_roi_samples>
- 3.8.14 <auto_exposure_upper_threshold>
- 3.8.15 <auto_exposure_upper_limit>
- 3.8.16 <max_auto_exposure_iteration_count>
- 3.8.17 <exposure_table>
- 3.8.18 <exposure_table_update_flag>
- 3.8.19 <valid_maximum_pixel>
- 3.8.20 <valid_minimum_pixel>
- 4 <Focus>
- 5 <High_Dynamic_Range>
- 6 <Instrument_State>
- 7 <Onboard_Compression>
- 7.1 <onboard_compression_class>
- 7.2 <onboard_compression_mode>
- 7.3 <onboard_compression_type>
- 7.4 <onboard_compression_rate>
- 7.5 <onboard_compression_ratio>
- 7.6 <onboard_compression_quality>
- 7.7 <onboard_compression_venue>
- 7.8 <deferred_flag>
- 7.9 <error_pixel_count>
- 7.10 <ICER_Parameters>
- 7.11 <LOCO_Parameters>
- 7.12 <JPEG_Parameters>
- 7.13 <JPEG_Progressive_Parameters>
- 7.14 <StarPixel_Flexible_Parameters>
- 7.15 <StarPixel_Lossless_Parameters>
- 8 <Optical_Filter>
- 9 <Sampling>
- 10 <Subframe>
- 11 <Imaging>
- 11.1 <pds:Local_Internal_Reference>
- 11.2 <Brightness_Correction>
- 11.3 <Col_Sum>
- 11.4 <Color_Filter_Array>
- 11.5 <Color_Processing>
- 11.6 <Dark_Current_Correction>
- 11.7 <Data_Quality>
- 11.8 <Detector>
- 11.9 <Downsampling>
- 11.10 <Exposure>
- 11.11 <Flat_Field_Correction>
- 11.12 <Focus>
- 11.13 <Focus_Stack>
- 11.14 <Frame>
- 11.15 <High_Dynamic_Range>
- 11.16 <Histogram>
- 11.17 <Illumination>
- 11.18 <Image_Filter>
- 11.19 <Image_Mask>
- 11.20 <Onboard_Compression>
- 11.21 <Optical_Filter>
- 11.22 <Optical_Properties>
- 11.23 <Pointing_Correction>
- 11.24 <Radiometric_Correction>
- 11.25 <Reference_Pixel>
- 11.26 <Row_Sum>
- 11.27 <Sample>
- 11.28 <Shutter_Subtraction>
- 11.29 <Spatial_Filter>
- 11.30 <Subframe>
- 11.31 <Thumbnail>
- 11.32 <Video>
- 11.33 <Instrument_State>
- 11.34 <Commanded_Parameters>
<Companding>
ELEMENT
Parameters related to data that had its bit depth reduced.
<active_flag>
OPTIONAL
True if companding was applied.
<processing_venue>
OPTIONAL
Free-form string indicating where the companding was performed
<processing_algorithm>
OPTIONAL
Name of companding algorithm.
<sequence_number>
OPTIONAL
(definition not meaningful in this context)
<companding_state>
OPTIONAL
None, Companded, or Expanded
<early_scaling>
OPTIONAL
<Companding_File>
OPTIONAL
<description>
OPTIONAL
<pds:Internal_Reference> or <pds:External_Reference>
OPTIONAL
<name>
OPTIONAL
<Companding_Table>
OPTIONAL
<description>
OPTIONAL
<pds:Internal_Reference> or <pds:External_Reference>
OPTIONAL
<name>
OPTIONAL
<Companding_Table_Mapping>
REQUIRED, REPEATABLE
<input_dn_min>
REQUIRED
<input_dn_max>
REQUIRED
<output_dn>
REQUIRED
<Detector>
ELEMENT
Describes the state of the detector, not onboard processing.
<first_line>
OPTIONAL
<first_sample>
OPTIONAL
<lines>
OPTIONAL
<samples>
OPTIONAL
<detector_to_image_rotation>
OPTIONAL
Clockwise rotation from detector orientation to final image orientation
<detector_to_image_flip>
OPTIONAL
Indicates mirror image flip from detector orientation to final image orientation. Horizontal = left-to-right flip; Vertical = top-to-bottom flip.
Flip is applied before rotation.
<erase_count>
OPTIONAL
<readout_rate>
OPTIONAL
Frequency (Hz) of clock rate at which values were read from the sensor
<gain_mode_id>
OPTIONAL
String identifier for gain mode (permissible values to be set by label designer)
<gain_number>
OPTIONAL
Gain value (floating point multiplicative factor) used in analog to digital conversion (ADC).
<analog_offset>
OPTIONAL
Vakue subtracted from signal prior to ADC
<bad_pixel_replacement_flag>
OPTIONAL
True if bad pixel replacement was requested/completed.
<bad_pixel_replacement_table_id>
OPTIONAL
Name of table used to replace bad pixels. [doesn't appear actionable - not resolvable]
<instrument_idle_timeout>
OPTIONAL
<early_image_return>
OPTIONAL
<parameter_table_id>
OPTIONAL
<Special_Point>
OPTIONAL
<name>
OPTIONAL
<description>
OPTIONAL
<special_line>
OPTIONAL
<special_sample>
OPTIONAL
<pds:Internal_Reference>
OPTIONAL
Not clear what the point of this is. Only valid reference_type is data_to_raw_source_product.
<Exposure>
ELEMENT
<exposure_count>
OPTIONAL
Number of exposures taken during some relevant interval
<exposure_duration>
OPTIONAL
Amount of time a sensor was gathering light
<exposure_duration_count>
OPTIONAL
exposure_duration in DN rather than seconds
<exposure_type>
OPTIONAL
Camera exposure setting: Manual, Auto, Test
<exposure_scale_factor>
OPTIONAL
Multiplier applied to exposure_duration when that number reflects one of a series of exposures obtained to create the data object
<exposure_coadd_count>
OPTIONAL
Number of images co-added to produce the image
<exposure_readout_time>
OPTIONAL
Number of times an exposure (or part) has been read from the camera
<Autoexposure>
OPTIONAL
<active_flag>
OPTIONAL
<processing_venue>
OPTIONAL
<processing_algorithm>
OPTIONAL
<sequence_number>
OPTIONAL
<auto_exposure_data_cut>
OPTIONAL
<auto_exposure_percent>
OPTIONAL
<auto_exposure_pixel_fraction>
OPTIONAL
<auto_exposure_lower_threshold>
OPTIONAL
<auto_exposure_lower_limit>
OPTIONAL
<auto_exposure_roi_first_line>
OPTIONAL
<auto_exposure_roi_first_sample>
OPTIONAL
<auto_exposure_roi_lines>
OPTIONAL
<auto_exposure_roi_samples>
OPTIONAL
<auto_exposure_upper_threshold>
OPTIONAL
<auto_exposure_upper_limit>
OPTIONAL
<max_auto_exposure_iteration_count>
OPTIONAL
<exposure_table>
OPTIONAL
<exposure_table_update_flag>
OPTIONAL
<valid_maximum_pixel>
OPTIONAL
<valid_minimum_pixel>
OPTIONAL
<Focus>
ELEMENT
Parameters describing focus
<focus_mode>
OPTIONAL
<focus_position>
OPTIONAL
<focus_position_count>
OPTIONAL
<autofocus_step_size>
OPTIONAL
<autofocus_step_count>
OPTIONAL
<focus_distance>
OPTIONAL
<focus_initialization_flag>
OPTIONAL
<minimum_focus_distance>
OPTIONAL
<best_focus_distance>
OPTIONAL
<maximum_focus_distance>
OPTIONAL
<High_Dynamic_Range>
ELEMENT
Parameters related to processing in which multiple exposures of different lengths into a single product with greater dynamic range
<active_flag>
OPTIONAL
<processing_venue>
OPTIONAL
<processing_algorithm>
OPTIONAL
<sequence_number>
OPTIONAL
<hdr_acquisition_mode>
OPTIONAL
<hdr_frame_count>
OPTIONAL
<hdr_clipping_threshold>
OPTIONAL
<High_Dynamic_Range_Exposure>
OPTIONAL, REPEATABLE
Specifies exposure parameters for each constituent exposure used
<exposure_duration>
OPTIONAL
<exposure_duration_count>
OPTIONAL
<exposure_time_delta>
OPTIONAL
<pds:Internal_Reference>
OPTIONAL
<Instrument_State>
ELEMENT
Classes providing lists of parameters related to instrument state and operating conditions.
<Device_Component_States>
OPTIONAL
<Device_Component_State>
REQUIRED, REPEATABLE
<device_name>
OPTIONAL
<device_id>
OPTIONAL
<sequence_number>
OPTIONAL
<device_state>
OPTIONAL
<Device_Currents>
OPTIONAL
<Device_Current>
REQUIRED, REPEATABLE
<device_name>
OPTIONAL
<device_id>
OPTIONAL
<sequence_number>
OPTIONAL
<current_value>
OPTIONAL
<Device_Motor_Counts>
OPTIONAL
<Device_Motor_Count>
REQUIRED, REPEATABLE
<device_name>
OPTIONAL
<device_id>
OPTIONAL
<sequence_number>
OPTIONAL
<motor_count>
OPTIONAL
<Device_Temperatures>
OPTIONAL
<Device_Temperature>
REQUIRED, REPEATABLE
<device_name>
OPTIONAL
<device_id>
OPTIONAL
<sequence_number>
OPTIONAL
<raw_count>
OPTIONAL
<temperature_value>
OPTIONAL
<temperature_status>
OPTIONAL
<Device_Voltages>
OPTIONAL
<Device_Voltage>
REQUIRED, REPEATABLE
<device_name>
OPTIONAL
<device_id>
OPTIONAL
<sequence_number>
OPTIONAL
<voltage_value>
OPTIONAL
<Onboard_Compression>
ELEMENT'
Parameters related to onboard compression
<onboard_compression_class>
OPTIONAL
Lossless, Lossy, or Uncompressed
<onboard_compression_mode>
OPTIONAL
Appears to be some sort of integer code that is expected to correspond to compression method somehow, but how is not well-specified.
<onboard_compression_type>
OPTIONAL
Must be one of:
- GZIP
- ICER
- H.264 Frame
- LOCO
- LZO
- JPEG
- JPEG Pogressive
- MSSS Lossless
- Lossless
- None
- StarPixel Lossless
- StarPixel Flexible
<onboard_compression_rate>
OPTIONAL
Average number of bits needed to represent a pixel in compression. [Not really a rate - no units]
<onboard_compression_ratio>
OPTIONAL
Ratio of size of original object to compressed size.
<onboard_compression_quality>
OPTIONAL
"1.0" = uncompressed or losslessly compressed. Everything else depends on the compression algorithm, though higher numbers are better.
<onboard_compression_venue>
OPTIONAL
String indicating where the onboard compression was performed
<deferred_flag>
OPTIONAL
Supposed to indicate when compression was applied (at acquisition or prior to downlink), but it's not clear what the boolean values correspond to.
<error_pixel_count>
OPTIONAL
Number of pixels outside value DN range after decompression processing.
<ICER_Parameters>
OPTIONAL
Parameters used for ICER compression used on Mars Rovers.
<wavelet_filter>
OPTIONAL
<icer_quality>
OPTIONAL
<decomposition_stages>
OPTIONAL
<segment_count>
OPTIONAL
<Image_Compression_Segment>
OPTIONAL, REPEATABLE
<segment_number>
REQUIRED
<first_line>
REQUIRED
<first_sample>
REQUIRED
<lines>
REQUIRED
<samples>
REQUIRED
<segment_quality>
OPTIONAL
<segment_status>
OPTIONAL
<segment_corrupted_flag>
OPTIONAL
<missing_pixel_count>
OPTIONAL
<LOCO_Parameters>
OPTIONAL
Parameters related to LOCO compression, a subtype of ICER compression, used in Mars data.
<wavelet_filter>
OPTIONAL
<missing_pixel_count>
OPTIONAL
<segment_count>
OPTIONAL
<Image_Compression_Segment>
OPTIONAL, REPEATABLE
<segment_corrupted_flag>
OPTIONAL
<missing_pixel_count>
OPTIONAL
<JPEG_Parameters>
OPTIONAL
Parameters specific to JPEG compression.
<color_sampling_mode>
OPTIONAL
<jpeg_quality>
OPTIONAL
<jpeg_parameter>
OPTIONAL
<Image_Compression_Segment>
OPTIONAL, REPEATABLE"
<JPEG_Progressive_Parameters>
OPTIONAL
JPEG Pogressive compression parameters
<color_sampling_mode>
OPTIONAL
<jpeg_quality>
OPTIONAL
<jpeg_parameter>
OPTIONAL
<Image_Compression_Segment>
OPTIONAL, REPEATABLE"
<progressive_stage>
OPTIONAL
<StarPixel_Flexible_Parameters>
OPTIONAL
<starpixel_initial_sampling_interval>
OPTIONAL
<starpixel_degradation>
OPTIONAL
<Image_Compression_Segment>
OPTIONAL, REPEATABLE"
<StarPixel_Lossless_Parameters>
OPTIONAL
<starpixel_initial_sampling_interval>
OPTIONAL
<Image_Compression_Segment>
OPTIONAL, REPEATABLE
<Optical_Filter>
ELEMENT
Parameters describing filters in the optical path
<filter_name>
OPTIONAL
Name used in mission documentation. [Standard values should be defined by mission]
<filter_id>
OPTIONAL
Seems to be the same as "name", but limited to 16 characters
<filter_number>
OPTIONAL
Yet another filter identification, this time a non-negative integer.
<filter_position_count>
OPTIONAL
Position in filter wheel motor counts
<bandwidth>
OPTIONAL
Bandwidth. The method for specifying bandwidth is not defined.
<center_filter_wavelength>
OPTIONAL
Center of the passband or peak transmissivity
<array_band_number>
OPTIONAL
The image plane in the array that corresponds to the optical filter with which the image was acquired (1- vs. 0- based is not specified)
<comment>
OPTIONAL
<pds:Local_Internal_Reference>
OPTIONAL
This is not documented, but it looks like this could be used to tie this specific filter definition to a data objects in the label. This would be necessary if this class is used outside the context of the Imaging class.
<Sampling>
ELEMENT
Broadly inclusive class to contain parameters related to any sort of resampling or processing of pixel values.
<crosstrack_summing>
OPTIONAL
Number of pixels averaged in crosstrack direction
<downtrack_summing>
OPTIONAL
Number of pixels averaged in the downtrack direction
<missing_pixel_count>
OPTIONAL
Total number of missing pixels defined by the image or segment
<original_sample_bits>
OPTIONAL
Number of bits acquired by the sensor before any onboard processing
<sample_bits>
OPTIONAL
Number of bits required to represent the range of the data within the (presumed integer) data type.
<sample_bit_mask>
OPTIONAL
Bit mask representing the sample_bits within the object data type. Bit mask is expressed in PDS3 format (e.g., "2#0000111111111111")
<sampling_factor>
OPTIONAL
N, where every N data points from the original kept by selection, averaging, or taking the median. It applies to both lines and samples
<saturated_pixel_count>
OPTIONAL
Number of saturated pixels in the image
<valid_pixel_count>
OPTIONAL
Total pixels tagged as valid in the image
<Companding>
OPTIONAL
<Subframe>
ELEMENT
Position and other parameters associated with subframes.
Note that no reference base (0 or 1) is given for selecting lines and samples.
<first_line>
OPTIONAL
<first_sample>
OPTIONAL
<lines>
OPTIONAL
<sample>
OPTIONAL
<line_fov>
OPTIONAL
Angular coverage of FOV in "line" direction
<sample_fov>
OPTIONAL
Angular coverage of FOV in "sample" direction
<name>
OPTIONAL
<description>
OPTIONAL
<subframe_type>
OPTIONAL
Current values defined by MSL and thus limit the directive that missions should define their own.
Method of subframing. One of:
- Hardware Compatible
- Hardware Else Software
- None
- Software Only
- Subframe Around Sun
- Sun Subframe or Full
<Imaging>
ELEMENT
<pds:Local_Internal_Reference>
REQUIRED, REPEATABLE
<Brightness_Correction>
OPTIONAL
<Col_Sum>
OPTIONAL
<Color_Filter_Array>
OPTIONAL
<Color_Processing>
OPTIONAL
<Dark_Current_Correction>
OPTIONAL
<Data_Quality>
OPTIONAL
<Detector>
OPTIONAL
<Downsampling>
OPTIONAL
<Exposure>
OPTIONAL
<Flat_Field_Correction>
OPTIONAL
<Focus>
OPTIONAL
<Focus_Stack>
OPTIONAL
<Frame>
OPTIONAL
<High_Dynamic_Range>
OPTIONAL
<Histogram>
OPTIONAL
<Illumination>
OPTIONAL
<Image_Filter>
OPTIONAL
<Image_Mask>
OPTIONAL
<Onboard_Compression>
OPTIONAL
<Optical_Filter>
OPTIONAL
<Optical_Properties>
OPTIONAL
<Pointing_Correction>
OPTIONAL
<Radiometric_Correction>
OPTIONAL
<Reference_Pixel>
OPTIONAL
<Row_Sum>
OPTIONAL
<Sample>
OPTIONAL
<Shutter_Subtraction>
OPTIONAL
<Spatial_Filter>
OPTIONAL
<Subframe>
OPTIONAL
<Thumbnail>
OPTIONAL
<Video>
OPTIONAL
<Instrument_State>
OPTIONAL
<Commanded_Parameters>
OPTIONAL