Scan Orientation

SO_01: Rotate Current View by +/- 180

  • Version: 1.0.0
  • Interface: scan_orientation
  • Action: so_01

Payload Definition

Type: RotationValue
{
  "Version": "String",
  "View": "ENUM: ScanView",
  "Angle": "Float"
}

Example definition

Type: RotationValue
{
  "Version": "1.0.0",
  "View": 0,
  "Angle": 0
}

Response Codes

CodeDescription
S00000Action was received from Front End.
S00001Action from Front End has completed.
F00000Error executing the supplied function
F00001Function is not defined
F00006Action did not execute within an allotted time
F00008Function is not found
F00011The payload supplied is invalid
F00015Enum value out of range
F00022When the View supplied cannot be allocated to Volume

SO_02: Flip Scan Horizontally

  • Version: 1.0.0
  • Interface: scan_orientation
  • Action: so_02

Payload Definition

Type: FlipValue
{
  "Version": "String",
  "View": "ENUM: ScanView",
  "Flipped": "Boolean"
}

Example definition

Type: FlipValue
{
  "Version": "0.0.1",
  "View": 0,
  "Flipped": false
}

Response Codes

CodeDescription
S00000Action was received from Front End.
S00001Action from Front End has completed.
F00000Error executing the supplied function
F00001Function is not defined
F00006Action did not execute within an allotted time
F00008Function is not found
F00011The payload supplied is invalid
F00015Enum value out of range

SO_03: Flip Scan Vertically

  • Version: 1.0.0
  • Interface: scan_orientation
  • Action: so_03

Payload Definition

Type: FlipValue
{
  "Version": "String",
  "View": "ENUM: ScanView",
  "Flipped": "Boolean"
}

Example definition

Type: FlipValue
{
  "Version": "0.0.1",
  "View": 0,
  "Flipped": false
}

Response Codes

CodeDescription
S00000Action was received from Front End.
S00001Action from Front End has completed.
F00000Error executing the supplied function
F00001Function is not defined
F00006Action did not execute within an allotted time
F00008Function is not found
F00011The payload supplied is invalid
F00015Enum value out of range
Last Updated:
Contributors: Elliott Cooper