OpenIGTLink US messaging proposal

This page is part of http://wiki.na-mic.org/Wiki/index.php/2016_Winter_Project_Week:TrackedUltrasoundStandardization.

Status message format

The status can be organized as a xml document, and can thus be embedded into any text field in any message. XML also provides an easy system for optional and extension parameters. Each DOM-element can contain a reserved extension element. Here custom properties can be added without interfering with the required/optional properties.

Complete description of all properties for an ultrasound server:

The following are properties for a server residing on an ultrasound scanner. The structure is given in pseudocode, but the intended format is XML.

Parameters are either required, optional or extension:

• required: Defined by standard. Must be present in order to comply with standard.
• optional: Defined by standard. Might be present, if available from scanner and implemented.
• extension: not part of the standard, but added by vendor.

Properties:

• Available_applications { list of names } (list of applications/presets available on the scanner)
• Application_name { name }
• Available_Probes { device_id list } ( List of all probes currently attached to the scanner.)
• Available_Streams { device_id list } (these are an exhaustive list of all stream types that can be of interest from a scanner. Only those supported by the scanner are given. The scalar variants contain raw data, while the RGB/Gray versions are suitable for direct screen display. LUTs can be available when using the raw variants.)
  • Display, (RGB)
  • US_B-Mode (Gray)
  • US_B-Mode-Raw (Scalar)
  • US_Color-Doppler (RGB)
  • US_Color-Doppler-Velocity (Scalar)
  • US_Power-Doppler (RGB)
  • US_Elastography (RGB)
  • US_Elastography (Scalar)
  • US_R0 (Scalar)
  • US_R1 (Scalar)
  • US_RF (Scalar)
  • US_IQ (Complex)
• Probe: {device_id}
  • probe parameters: Name, Center freq, focus pt, pitch, geometry model..?,
• Stream: <stream_name0></stream_name0>
  • Image components: {RGB, Gray, Complex, Scalar}. If Scalar, a color table might be available (in a separate field)
  • Probe sector: (handles most cases, mask handles the rest)
    • origin
    • depth start
    • depth stop
    • azimuth
      • type{linear, sector}
      • width{angle/width}
      • tilt
    • elevation
      • width{angle/width}
      • type{linear, sector}
      • tilt
  • exact: bool. If false, must use Mask stream to get exact geometry

mask: a device_id that can be used to GET a IMAGE containing a mask describing the sector. Color table??? (new message)

• • Is given, points to a device_id that can be used to GET a COLORT, can be applied on scalar image values.

optional parameters name-value pairs, specified by description and value def (unit etc) e.g.: frequency, harmonic y/n, focus points (array), pitch, nyquist velocity, packet size, averaging windows extension parameters same as optional, but user-defined, nonstandard