PIDF SPIN ANGLE STRUCTURE

The PIDF Spin Angle Structure provides labeling information and unit information for the UDF spin angle data. This structure is rarely used by applications other than to display the information within a GUI MENU. It is often not included in the PIDF.

The PIDF spin angle structure has the generalized form:

struct SpinAngle {
   string name = "Entry";
   string short_name = "Entry";
   int    num_units = Entry;
   int    unit_number = Entry;
};

The fields within the structure can be entered in any order. Not all of the above structure fields need be present in a structure definition. Default values are supplied for any unspecified field.

KEYWORD: name

A descriptive label for the measurement. The provided label should be reasonably short and should not contain any reference to units. This is a string field which if not included in the SpinAngle structure is defaulted to a NULL.

KEYWORD: short_name

A short descriptive label for the measurement. This label is generally a decimated version of what is given in the name field.

This is a string field which if not included in the SpinAngle structure is defaulted to a NULL.

KEYWORD: num_units

The number of unit definitions included in the structure. There should always be at least one unit definition even if does no conversion and returns the UDF data in its raw or stored format.

This is an int field which must be present in the structure.

KEYWORD: unit_number

The structure number of one of the PIDF unit definitions. This provides the information to take the raw measurement into one of the unit definitions provided for it. There are num_units instances of this field within the SpinAngle structure.

This is an int field of which at least one instance must be present in the structure.

EXAMPLES

The following is an example of fully functional PIDF spin angle structure. The entries are shown within the overall PIDF definition braces which would occur only once within the PIDF file.

EXAMPLE 1

pidf v2_IMMIMAGE {
$*********************************************************************
    struct SpinAngle {
        string name = "Spin Angle";                       $$ name
        string short_name = "Phase";                      $$ short name
        int num_units = 1;                                $$ no. of units
        int unit_number = 16;                             $$ unit numbers
    };
$*********************************************************************
};

&larr Previous	TOC	HOME	Next &rarr
Data Quality Structure			Pitch Angle Structure