1 Definition

A Qualifier stating the conventions by which the numbers of a Spatial Attitude (OSD-OSA), of Spatial Data (CAV-SPD) and of Pointing Data (OSD-BPO) are to be read. It states what the data cannot state, and it does not change them. When the Qualifier is absent, the default conventions of the Data Type apply. For Position, Orientation and Spatial Attitude (OSD) they are those of ISO 8855: a right-handed East-North-Up frame; body axes X forward, Y left, Z up; Euler angles (α, β, γ) = (yaw, pitch, roll), intrinsic rotations about Z, Y′, X″, positive by the right-hand rule; degrees and metres; a quaternion (w, x, y, z). A Data Type with no stated default does not state its conventions.

2 Functional Requirements

A Spatial Qualifier shall include:

  1. The Spatial Qualifier Header.
  2. The ID of the Spatial Qualifier.
  3. The Sub-Types: the kind of data it qualifies (Position, Orientation, Spatial Attitude, Spatial Data, Pointing Data).
  4. The Formats: how a position is expressed (Cartesian, Spherical, Cylindrical, Geodetic, Toroidal) and how an orientation is expressed (three Euler angles, or a quaternion).
  5. The Attributes: the conventions.

The Attributes may include: the reference frame and its origin, which may also be stated so that a machine can use it, by one of: a geodetic point (latitude, longitude, height), the Position of an identified Object (a frame attached to that Object, with its body axes), or a registered coordinate reference system (EPSG code); the handedness of the Cartesian axes; the up axis and the forward axis; the unit of length and of angle; the sense of a positive rotation; for Euler angles, the order of the three rotations and whether they are intrinsic or extrinsic; for a quaternion, the order of the four numbers and the convention (Hamilton or JPL); for spherical coordinates, the order of the three numbers, whether the polar angle is a colatitude or an elevation, the axis from which the azimuth is measured and its sense; for geodetic coordinates, the datum, the epoch and the reference of the height.

3 Syntax

https://schemas.mpai.community/TFA/V1.5/data/SpatialQualifier.json

4 Semantics

Label Description
Header Spatial Qualifier Header – Standard “TFA-SAQ-Vx.y”
SpatialQualifierID Identifier of the Spatial Qualifier.
SubTypes Kind: the kind of data qualified.
Formats PositionFormat: Cartesian, Spherical, Cylindrical, Geodetic or Toroidal. OrientationFormat: EulerAngles or Quaternion (four numbers, with no gimbal lock).
ReferenceFrame Name of the frame (e.g. Ego, Local ENU, Map, Geocentric, Screen, Room) and what its origin is (Origin, text). At most one of: OriginGeodetic, the origin as latitude and longitude (degrees) and, when it is known, height (metres) in the Datum of Geodetic, WGS84 when absent; OriginObjectID, the Object whose Position is the origin, the axes being its body axes; EPSG, a registered coordinate reference system written EPSG:<code> (e.g. EPSG:4978, the Earth-fixed WGS 84 frame), whose origin and axes are those of the registry entry.
Handedness Right or Left.
UpAxis, ForwardAxis One of +X, -X, +Y, -Y, +Z, -Z.
LengthUnit, AngleUnit m, cm, mm, km or pixel; degree or radian.
PositiveRotation Anticlockwise or Clockwise, seen looking against the axis.
Euler Order (XYZ, XZY, YXZ, YZX, ZXY, ZYX, XYX, XZX, YXY, YZY, ZXZ, ZYZ) and Rotations (Intrinsic: about the axes already turned; Extrinsic: about the fixed axes).
Quaternion Order (xyzw or wxyz) and Convention (Hamilton or JPL).
Spherical Order (RadiusAzimuthPolar or RadiusPolarAzimuth), PolarAngle (Colatitude or Elevation), AzimuthZeroAxis and AzimuthSense.
Geodetic Datum, Epoch and HeightReference (Ellipsoidal or Orthometric).
DataXMData, DescrMetadata Information on this Qualifier instance; descriptive metadata.

5 Conformance Testing

A Data instance Conforms with the Spatial Qualifier if it validates against the Spatial Qualifier’s JSON Schema, and if the data it qualifies are consistent with it: for example, an orientation of four numbers when the Format is Quaternion, three numbers when it is EulerAngles.