Imaging Dictionary 1.6

From The SBN Wiki
Jump to navigation Jump to search

Contents

<Imaging>

REQUIRED

Monolithic class.




<pds:Local_Internal_Reference>

REQUIRED, repeatable

imaging_parameters_to_image_object

<Color_Filter_Array>

OPTIONAL

Applies to color images; seems to allow encoding.

DO NOT USE

<Color_Processing>

OPTIONAL

Applies to color images; seems to allow encoding.

DO NOT USE.

<Detector>

OPTIONAL

Describes state of detector as reported by the detector.

<first_line>

OPTIONAL

<first_sample>

OPTIONAL

<lines>

OPTIONAL

<sampled>

OPTIONAL

<detector_to_image_rotation>

OPTIONAL

Rotation resulting from the optical path

<erase_count>

OPTIONAL

Number of times the detector was flushed

<readout_rate>

OPTIONAL

Clock rate for reading values from sensor. (Which clock isn't specified.)

<gain_mode_id>

OPTIONAL

Gain state indicator; values must be defined in mission dictionary.

<gain_number>

OPTIONAL

Gain factor for analog-to-digital conversion

<analog_offset>

OPTIONAL

Value subtracted from signal prior to analog-to-digital conversion.


<Downsampling>

OPTIONAL

Presence of this class implies downsampling happened somewhere (software or hardware).

<Pixel_Averaging_Dimensions>

OPTIONAL

<height_pixels>

REQUIRED

<width_pixels>

REQUIRED


<Exposure>

OPTIONAL

This class is now out of both contexts mentioned in its definition.

<exposure_count>

OPTIONAL

Number of exposures taken during some (unspecified) interval

<exposure_duration>

OPTIONAL

Amount of time in which light was gathered. It is not specified whether this is for one exposure or the total exposures represented by the exposure count. Units of time

<exposure_duration_count>

OPTIONAL

Instrument count equivalent of the preceding attribute.

<exposure_type>

OPTIONAL

One of: Auto, Manual, Test

<Autoexposure>

OPTIONAL

This appears to be a lab- or instrument-specific class.

DO NOT USE.

<Flat_Field_Correction>

OPTIONAL

Indicates what sort of flat field was applied. Implies the image is flat-fielded.

<active_flag>

OPTIONAL

Boolean with unconstrained values.

<processing_venue>

OPTIONAL

No standard values defined.

<processing_algorithm>

OPTIONAL

No standard values defined.

<sequence_number>

OPTIONAL

Definition refers to a series which does not appear to exist.

<Radial_Flat_Field_Function>

OPTIONAL

Used to specify synthetic flat field parameters.

<Flat_Field_File>

OPTIONAL

Identifies flat field file. This allows an external reference, which should never be valid in an archive product. It's not clear how the description would be different from the comment in the pds:Internal_Reference class. One of Internal/External_Reference must be specified.

<description>

OPTIONAL

<pds:External_Reference>

OPTIONAL

<pds:Internal_Reference>

OPTIONAL

<name>

OPTIONAL

Not clear what this is naming.


<Focus>

OPTIONAL, repeatable

Used to indicate focus parameters. Seems N/A to SBN, but might have use especially in conjunction with Focus_Stack.

<Focus_Stack>

OPTIONAL, repeatable

Used for image stacks where images were taken at different focus settings.


<Frame>

OPTIONAL

<frame_id>

OPTIONAL

Has a null Schematron rule. Not sure why. Definition implies there should be a standard value list.

<frame_type_name>

OPTIONAL

Has a null Schematron rule. Not sure why. Definition implies there should be a standard value list and that frames only occur in a sterro imaging scenario.


<Onboard_Compression>

OPTIONAL, repeatable

Not clear what it means to repeat this class. Also not clear if this class is generally applicable, given the standard value lists involved.

<onboard_compression_class>

OPTIONAL

One of Lossless, Lossy, Uncompressed.

<onboard_compression_mode>

OPTIONAL

Number corresponding to following onboard_compression_type.

<onboard_compression_type>

OPTIONAL

One of: ICER, LOCO, JPEG, JPEG Progressive, MSSS Lossless, None.

<onboard_compression_rate>

OPTIONAL

Average number of bits needed per pixel in the compressed image.

<onboard_compression_ratio>

OPTIONAL

Original size/compressed size of image (measured in bytes).

<onboard_compression_quality>

OPTIONAL

Number between 0 and 1 indicating degree of losslessness (1.0 = Lossless or uncompressed). Fuzzy number.

<deferred_flag>

OPTIONAL

True if compression was done after acquisition.

<error_pixel_count>

OPTIONAL

Invalid pixels left after decompression.

Parameter Classes

OPTIONAL, repeatable

Classes to hold parameters for four of the onboard_compression_type values listed previously.


<Optical_Filter>

OPTIONAL, repeatable

<filter_name>

OPTIONAL

<filter_id>

OPTIONAL

<filter_number>

OPTIONAL

<bandwidth>

OPTIONAL

Wavelength units

<center_filter_wavelength>

OPTIONAL

Wavelength units

<comment>

OPTIONAL

<pds:Local_Internal_Reference>

OPTIONAL

Not clear what this is for. Schematron requires a value of "data_to", but message indicates different value. Not clear why you would allow a local reference but not pds:Internal_Reference.


<Radiometric_Correction>

OPTIONAL

For radiometric correction parameters.

<active_fleg>

OPTIONAL

True of radiometric correction was applied.

<processing_venue>

OPTIONAL

Indicates where processing was performed. No standard values.

<processing_algorithm>

OPTIONAL

Algorithm name/ID. Standard values should be defined in mission dictionary.

<sequence_number>

OPTIONAL

Not clear what comprises the "sequence".

Correction Parameters

Half a dozen specific parameters, all of which are optional.


<Sampling>

OPTIONAL

Parameters related to downsampling, scaling, etc.

<crosstrack_summing>

OPTIONAL

<downtrack_summing>

OPTIONAL

<sample_bits>

OPTIONAL

Bits comprising the recording range of the detector. The recorded value is sign-extended to the width of the pixel data type.

<sample_bit_mask>

OPTIONAL

This attribute appears to be attempting to define standards on data object formats/interpretation.

<sampling_factor>

OPTIONAL

The definition appears to be self-contradicting. This is basically the number of original pixels contributing to the reported pixel, however that was accomplished.

<Companding>

OPTIONAL

<active_flag>

OPTIONAL

True if companding was applied.

<processing_venue>

OPTIONAL

Indicate where the processing was performed.

<processing_algoithm>

OPTIONAL

Standard values should be defined in mission dictionary.

<sequence_number>

OPTIONAL

Context not clear.

<companding_state>

OPTIONAL

One of Companded, Expanded, None

<Companding_File>

OPTIONAL

File containing the companding lookup table. One of pds:Internal_Reference or pds:External_Reference is required.

<description>

OPTIONAL

Purpose not clear.

<pds:External_Reference>

OPTIONAL

This should never be used in archival data.

<pds:Internal_Reference>

OPTIONAL

No values are defined for pds:reference_type in this context.


<Shutter_Subtraction>

OPTIONAL

<active_flag>

OPTIONAL

True if shutter subtraction was performed.

<processing_venue>

OPTIONAL

<processing_algorithm>

OPTIONAL

Values must be defined in mission dictionary.

<sequence_number>

OPTIONAL

<shutter_subtraction_mode>

OPTIONAL

One of: Conditional, True Definition is logically inconsistent with active_flag; does not explain dependency implications on exposure_duration_threshold.

<exposure_duration_threshold_count>

OPTIONAL

Expressed in raw (instrumental time) counts. Only applicable when the preceding attribute is Conditional. This is validated.


<Subframe>

OPTIONAL

Parameters describing subframe relationship to original frame.


<Video>

OPTIONAL

Parameters describing time sequences of images, or (oddly) somehow one image within the sequence.


<Instrument_State>

OPTIONAL, repeatable

A rat's nest of classes that do not seem as generally applicable to describing device states as their naming implies.


<Commanded_Parameters>

OPTIONAL

A duplicate structure to everything in the main class, from Color_Array to Subframe. Indicates commanded vs. actual/measured values.