Filling Out the Display Dictionary Classes

From The SBN Wiki
Revision as of 11:53, 21 July 2014 by Raugh (talk | contribs) (Safety Save)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

The display dictionary is a discipline dictionary, which means that its classes will appear in the <Discipline_Area&gt at the bottom of the <Observation_Area> in observational product labels (and in the <Context_Area>, if appropriate, in non-observational products). The classes in this dictionary define the appropriate way to draw or otherwise display array-type data objects in order to be able to correct interpret geometric or other quantities referenced to, e.g., an image elsewhere in the label.

Frequently, the use of one of these classes will be required when there are array data described in the label.

<Display_Settings>

REQUIRED

This is the main wrapper class for the Display Dictionary. It must be used whenever you want or need to include display information in any label that includes one or more array-type objects, in which case it is repeated for each object that needs display information.

<Local_Internal_Reference>

REQUIRED

This class is used to identify the specific array-type object to which these display settings apply.

<comment>

OPTIONAL

This is a free-text field for any clarifying comments you might wish to include.

<local_identifier_reference>

REQUIRED

This attribute identifies the array object to which the display settings apply, by citing the local_identifier value from the associated array object. All array-type objects have an optional <local_identifier> attribute, which, when present, must have a value that is unique within the label. You must assign local_identifier values to your arrays when you are providing display information.

<local_reference_type>

REQUIRED

This must have the value display_settings_to_array.

<Display_Direction>

REQUIRED

This class defines the correct orientation for displaying the array axes associated with a single image plane (that is, the Line and Sample axes).

<comment>

OPTIONAL

Another opportunity for free-format comments.

<horizontal_display_axis>

REQUIRED

This attribute identifies which axis of the array is considered the horizontal (or "sample") axis by referencing the <axis_name> value. The value must match the name exactly (i.e., case counts).

<horizontal_display_direction>

REQUIRED

This attribute indicates the direction in which pixels should be drawn sequentially along the horizontal axis of the display device. It must have one of these two values (case and embedded blanks are significant):

  • Left to Right
  • Right to Left

<vertical_display_axis>

REQUIRED

This attribute identifies which axis of the array is considered the vertical (or "line") axis by reference the <axis_name> value. The value must match the name exactly (i.e., case counts).

<vetical_display_direction>

REQUIRED

This attribute indicates the direction in which lines of pixels should be stacked sequentially along the vertical direction of the display device. It must have one of these two values (case and embedded blanks are significant):

  • Top to Bottom
  • Bottom to Top