GetDrawingColorLabel
purpose: returns current color label being used to draw
input: none
output: current color being used to draw
pre: current color is set to a valid color
post: none
GetOverlayColorLabel
purpose: returns current color overlay color
input: none
output: current overlay color
pre: overlay color is set to a valid color
post: none
GetBrightness
purpose: get current brightness level
input: none
output: current brightness level as an integer
pre: brightness is a integer value in range [0, 255]
post: output in range [0, 255]
GetContrast
purpose: get current contrast level
input: none
output: current contrast level as an integer
pre: contrast is a integer value in range [0, 255]
post: output in range [0, 255]
GetCrosshairsPosition
purpose: returns 3D cursor position
input: none
output: 3D coordinate object containing current 3D cursor position
pre: 3D cursor is in a valid position
post: none
GetToolbarMode
purpose: returns the current mode
input: none
output: integer which represents the current mode
pre: none
post: none
GetUpdateSliceFlag
purpose: informs 2D windows whether or not they need to update their current displayed slice
input: none
output: return True if 2D windows need to update slices
else return False
pre: none
post: none
GetCoverageMode
purpose: returns the following:
0 – draw over all voxels (labelled or unlabelled)
1 – draw over specific labelled voxels with current_draw_over_color
2 – draw over voxels that are labelled (not unlabelled)
input: none
output: see above
pre: none
post: none
SetDrawingColorLabel
purpose: to set the drawing color label to desired color
input: desired color label ID (in form of an integer index)
output: none
pre: none
post: drawing color label is desired value
SetOverlayColorLabel
purpose: to set the overlay color label to desired color
input: desired color label ID (in form of an integer index)
output: none
pre: none
post: overlay color label is desired value
SetBrightnessValue
purpose: to set the brightness to the desired level
input: desired brightness level as an integer [0,255]
output: none
pre: none
post: brightness is desired value
SetContrastWidth
purpose: to set the contrast to the desired level
input: desired contrast level as an integer [0,255]
output: none
pre: none
post: contrast is desired value
SetCrosshairsPosition
purpose: to set the 3D crosshair to the desired position within the voxl data set
input: 3D coordinate object containing desired 3D cursor position
output: none
pre: none
post: 3D crosshair is desired value
SetToolbarMode
purpose: to set the toolbar mode to the desired setting
input: the desired toolbar mode in the form of an integer within the valid range of options
output: none
pre: none
post: toolbar mode is the mode indicated by the input integer
SetUpdateSliceFlag
purpose: to set the update slice flag to true or false
input: a boolean
output: none
pre: none
post: update slice flag is set to value specified by the input
SetCoverageMode
purpose: to set the coverage mode to one of three options (see GetCoverageMode)
input: an integer in the range [0,2]
output: none
pre: none
post: coverage mode is set to value specified by the input
GetDrawingLock
purpose: checks drawingLockOwner;
input: none
output: none
pre:
post:
ReleaseDrawingLock
purpose: if windowID = DrawingLockOwner, set DrawingLockOwner = -1 and return True; else return False
input: windowID of calling window
output: boolean
pre:
post:
IsDrawingLocked
purpose: returns True if DrawingLockOwner > 0; else return False
input: none
output: boolean
pre:
post: