Scan State

SS_01: Current Scan Status & Variable Values

• Version: 1.0.0
• Interface: scan_state
• Action: ss_01

Payload Definition

Type: CurrentScanState

{
  "Version": "String",
  "CurrentView": "ENUM: ScanView",
  "Display": {
    "Version": "String",
    "WindowLower": "Float",
    "WindowUpper": "Float",
    "ThresholdLower": "Float",
    "ThresholdUpper": "Float",
    "Brightness": "Float",
    "Contrast": "Float",
    "Opacity": "Float"
  },
  "Slice": {
    "Version": "String",
    "TransverseLower": "Float",
    "TransverseUpper": "Float",
    "SagittalLower": "Float",
    "SagittalUpper": "Float",
    "CoronalLower": "Float",
    "CoronalUpper": "Float"
  },
  "InteractionSettings": {
    "Version": "String",
    "PanSensivitity": "Float",
    "ZoomSensitivity": "Float",
    "RotateSensitivity": "Float",
    "CameraRotateSensitivity": "Float",
    "KeyboardEnabled": "Boolean",
    "MouseEnabled": "Boolean",
    "InteractionMode": "ENUM: ViewInteractiveMode"
  },
  "Orientations": {
    "Version": "String",
    "Transverse": {
      "Version": "String",
      "View": "ENUM: ScanView",
      "VerticalFlip": "Boolean",
      "HorizontalFlip": "Boolean",
      "Rotation": "Float",
      "Slice": "Float"
    },
    "Sagittal": {
      "Version": "String",
      "View": "ENUM: ScanView",
      "VerticalFlip": "Boolean",
      "HorizontalFlip": "Boolean",
      "Rotation": "Float",
      "Slice": "Float"
    },
    "Coronal": {
      "Version": "String",
      "View": "ENUM: ScanView",
      "VerticalFlip": "Boolean",
      "HorizontalFlip": "Boolean",
      "Rotation": "Float",
      "Slice": "Float"
    }
  },
  "Layout": {
    "Version": "String",
    "SwitchOnViewChange": "Boolean",
    "PositionData": [
      {
        "Version": "String",
        "ActiveView": "Boolean",
        "DefaultView": "ENUM: ScanView",
        "Anchor": "ENUM: AnchorPoint",
        "Offset": {
          "Version": "String",
          "X": "Float",
          "Y": "Float"
        },
        "AspectRatio": "Float",
        "MaxSize": {
          "Version": "String",
          "X": "Float",
          "Y": "Float"
        },
        "Priority": "Int32"
      }
    ]
  },
  "Colour": {
    "Version": "String",
    "Name": "String",
    "ColourGradient": [
      {
        "Version": "String",
        "R": "Float",
        "G": "Float",
        "B": "Float",
        "Time": "Float"
      }
    ],
    "AlphaGradient": [
      {
        "Version": "String",
        "Alpha": "Float",
        "Time": "Float"
      }
    ]
  },
  "NavigationCube": {
    "Version": "String",
    "Transform": {
      "Version": "String",
      "AnchorPoint": "ENUM: AnchorPoint",
      "Position": {
        "Version": "String",
        "X": "Float",
        "Y": "Float"
      },
      "Size": {
        "Version": "String",
        "X": "Float",
        "Y": "Float"
      }
    },
    "Visibility": {
      "Version": "String",
      "Value": "Boolean"
    },
    "Interactivity": {
      "Version": "String",
      "Value": "Boolean"
    }
  }
}

Example definition

Type: CurrentScanState

{
  "Version": "1.0.0",
  "CurrentView": 0,
  "Display": {
    "Version": "0.0.1",
    "WindowLower": 0,
    "WindowUpper": 0,
    "ThresholdLower": 0,
    "ThresholdUpper": 0,
    "Brightness": 0,
    "Contrast": 0,
    "Opacity": 0
  },
  "Slice": {
    "Version": "1.0.0",
    "TransverseLower": 0,
    "TransverseUpper": 0,
    "SagittalLower": 0,
    "SagittalUpper": 0,
    "CoronalLower": 0,
    "CoronalUpper": 0
  },
  "InteractionSettings": {
    "Version": "1.0.0",
    "PanSensivitity": 0,
    "ZoomSensitivity": 0,
    "RotateSensitivity": 0,
    "CameraRotateSensitivity": 0,
    "KeyboardEnabled": false,
    "MouseEnabled": false,
    "InteractionMode": 0
  },
  "Orientations": {
    "Version": "1.0.0",
    "Transverse": {
      "Version": "1.0.0",
      "View": 0,
      "VerticalFlip": false,
      "HorizontalFlip": false,
      "Rotation": 0,
      "Slice": 0
    },
    "Sagittal": {
      "Version": "1.0.0",
      "View": 0,
      "VerticalFlip": false,
      "HorizontalFlip": false,
      "Rotation": 0,
      "Slice": 0
    },
    "Coronal": {
      "Version": "1.0.0",
      "View": 0,
      "VerticalFlip": false,
      "HorizontalFlip": false,
      "Rotation": 0,
      "Slice": 0
    }
  },
  "Layout": {
    "Version": "0.0.1",
    "SwitchOnViewChange": false,
    "PositionData": [
      {
        "Version": null,
        "ActiveView": false,
        "DefaultView": 0,
        "Anchor": 0,
        "Offset": {
          "Version": "1.0.0",
          "X": 0,
          "Y": 0
        },
        "AspectRatio": 0,
        "MaxSize": {
          "Version": "1.0.0",
          "X": 0,
          "Y": 0
        },
        "Priority": 0
      }
    ]
  },
  "Colour": {
    "Version": "0.0.1",
    "Name": "Some Colour Preset",
    "ColourGradient": [
      {
        "Version": "1.0.0",
        "R": 255,
        "G": 255,
        "B": 255,
        "Time": 2
      }
    ],
    "AlphaGradient": [
      {
        "Version": "1.0.0",
        "Alpha": 1,
        "Time": 2
      }
    ]
  },
  "NavigationCube": {
    "Version": "1.0.0",
    "Transform": {
      "Version": "1.0.0",
      "AnchorPoint": 0,
      "Position": {
        "Version": "1.0.0",
        "X": 0,
        "Y": 0
      },
      "Size": {
        "Version": "1.0.0",
        "X": 0,
        "Y": 0
      }
    },
    "Visibility": {
      "Version": "0.0.1",
      "Value": true
    },
    "Interactivity": {
      "Version": "0.0.1",
      "Value": true
    }
  }
}

Response Codes

Code	Description
S00000	Action was received from Front End.
S00001	Action from Front End has completed.
F00000	Error executing the supplied function
F00001	Function is not defined
F00006	Action did not execute within an allotted time
F00008	Function is not found
F00011	The payload supplied is invalid
A00000	Generic warning