Imaging Dictionary

From The SBN Wiki
Jump to navigation Jump to search

This is for version 1J00_1870 of the imaging namespace. Note that the "Imaging" superclass is optional.

Contents

<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

Column Summarion parameters

<Color_Filter_Array>

OPTIONAL

Parameters for filter arrays applied to a single image, as in the case of the Bayer filter. This includes parameters for data still encoded in the filter pattern.

<Color_Processing>

OPTIONAL

Parameters for color correction and processing applied

<Dark_Current_Correction>

OPTIONAL

Parameters for describing dark current removal [that don't seem relevant to the sort of processing done for SBN images]. I don't see an option for a dark image application.

<Data_Quality>

OPTIONAL

Parameters for identifying quality issues with image. This seems to provide totals of pixels falling into various categories and a series of flags for issues arising during image acquisition.

<Detector>

OPTIONAL

<Downsampling>

OPTIONAL

Parameters related to downsampling

<Exposure>

OPTIONAL

<Flat_Field_Correction>

OPTIONAL

Parameters to identify when and how a flat field was applied, including an option to identify a flat field file.

<Focus>

OPTIONAL

<Focus_Stack>

OPTIONAL

For cases where images were taken with different focus settings

<Frame>

OPTIONAL

Small class for defining per-frame identification attributes (only)

<High_Dynamic_Range>

OPTIONAL

<Histogram>

OPTIONAL

Used to describe an object that is a histogram

<Illumination>

OPTIONAL

Appears to be for artificial illumination only

<Image_Filter>

OPTIONAL

No idea what this is for

<Image_Mask>

OPTIONAL

Parameters related to how masking was applied to an image

<Onboard_Compression>

OPTIONAL

<Optical_Filter>

OPTIONAL

<Optical_Properties>

OPTIONAL

Focal length, f-number, and zoom position

<Pointing_Correction>

OPTIONAL

Related to camera model transformation

<Radiometric_Correction>

OPTIONAL

Radiometric calibration parameters. Seems to be specific to RGB images, although there is an iof_conversion_coefficient" attribute.

<Reference_Pixel>

OPTIONAL

Identifies pixels used to monitor electronics

<Row_Sum>

OPTIONAL

Describes a row summation product

<Sample>

OPTIONAL

<Shutter_Subtraction>

OPTIONAL

<Spatial_Filter>

OPTIONAL

No idea what's going on here

<Subframe>

OPTIONAL

<Thumbnail>

OPTIONAL

Used to describe a Thumbnail product

<Tiling>

OPTIONAL

Parameters related to how a single image is/was broken into tiles

<Video>

OPTIONAL

Parameters for a time series of images

<Instrument_State>

OPTIONAL

<Commanded_Parameters>

OPTIONAL

A repeat of Image, except this is what was commanded, vs what was actually received and done