VivoQuant
Public Slots | Public Member Functions | Protected Member Functions | List of all members
ThreeDimROIOperator Class Reference

Object to interact with the 3D ROI Operator when it is active. More...

Public Slots

void addLayer (string name, bool hidden=false, int alphaSlice=127)
 Adds a new layer to the end of the current layer list. More...
 
void editLayer (int id, string name, bool hidden=false, int alphaSlice=127)
 Edits various layer properties such as name, alpha. More...
 
void deleteLayer (int id=-1, int target=-1, int targetMovePolicy=ROIObject::respectImmutable)
 Removes a layer from the list of layers and reassigns all its ROIs. More...
 
void deleteLayerToROI (int id, int targetROI, int targetLayer, int targetMovePolicy=ROIObject::respectImmutable)
 Removes a layer from the list of layers and reassigns all its ROIs. More...
 
void deleteLayers (Array< int > indices, int target=-1, int targetMovePolicy=ROIObject::respectImmutable)
 Delete multiple layers. More...
 
void clearLayer (int id=-1)
 Reassigns all ROIs of a layer. More...
 
void clearLayers (Array< int > indices)
 Clears multiple layers. More...
 
void addROI (string name, string colorName, bool immutable=false, bool hidden=false, int alphaSlice=127, int alphaSurface=255)
 Adds a new ROI to the end of the current ROI list on the current active layer. More...
 
void addROI (int layerID, string name, string colorName, bool immutable=false, bool hidden=false, int alphaSlice=127, int alphaSurface=255)
 Adds a new ROI to the end of the current ROI list on the specified layer. More...
 
void editROI (int id, string name, string colorName, bool immutable=false, bool hidden=false, int alphaSlice=127, int alphaSurface=255, string layer="")
 Edits various ROI properties such as name, color on the current active layer. More...
 
void editROI (int layerID, int id, string name, string colorName, bool immutable=false, bool hidden=false, int alphaSlice=127, int alphaSurface=255, string layer="")
 Edits various ROI properties such as name, color on the specified layer. More...
 
void deleteROI (int id=-1, int targetROI=-1, int targetLayer=-1, int movePolicy=ROIObject::respectImmutable)
 Removes an ROI from the ROI list and reassigns all its voxels. More...
 
void clearROI (int id=-1, int targetROI=-1, int targetLayer=-1, int movePolicy=ROIObject::respectImmutable)
 Reassigns all voxels of an ROI. More...
 
void clearAll ()
 Reassigns the voxels of every ROI to the background.
 
void clearAllROIs ()
 Deletes all ROIs and removes them from the ROI List.
 
void exportTable (string filename="", bool openFile=true)
 Exports a table of selected metrics for ROIs; e.g. Volume, Sum. More...
 
void showTable (bool quick=false)
 Displays a table of selected metrics for ROIs that have been created; e.g. Volume, Sum. More...
 
void showHistogram ()
 Displays histogram GUI that depicts signal intensity of a given selected ROI.
 
void saveROI (string filename, string compression="RLE")
 Save an ROI to Disk. More...
 
void saveLayer (string filename, int layerID=-1, string compression="RLE")
 Save an ROI Layer to Disk. More...
 
void deleteROIs (Array< int > indices, int targetROI=-1, int targetLayer=-1, int movePolicy=ROIObject::respectImmutable)
 Delete multiple ROIs. More...
 
void clearROIs (Array< int > indices, int targetROI=-1, int targetLayer=-1, int movePolicy=ROIObject::respectImmutable)
 Clears multiple ROIs. More...
 
void exportROIs (Array< int > exportROIs)
 Exports an ROI (or group of ROIs) as a Volume in the Data Manager. More...
 
void toggleHidden (Array< int > indices)
 Toggles the hidden attribute of ROI(s) More...
 
void toggleImmutable (Array< int > indices)
 Toggles the immutable attribute of ROI(s) More...
 
void cutROI (bool bg, bool quiet=false, Array< Index > list=Array< Index >())
 Removes regions of the volumes. More...
 
void submitROI (bool quiet=false, bool allMetric=false)
 Submit the ROIs to the associated data on the iPACS. More...
 
void submitLayer (bool quiet=false, bool allMetric=false, int layerID=-1)
 Submit the ROIs of the specified layer to the associated data on the iPACS. More...
 
void loadROIFromIPACS (bool quiet=false)
 Download the ROIs from associated data on the iPACS. More...
 
void loadLayerFromIPACS (bool quiet=false, int layerID=-1)
 Download the ROIs into the specified layer from the associated data on the iPACS. More...
 
void loadRTStructureAsROI (string filename)
 
void loadVOIAsROI (string filename)
 Support for PMOD region of interest files. More...
 
void kmeanManualSeedCluster (string kmeans)
 a helper function to set the seed mean value for manual kmean segmentation More...
 
void copyLayerToClipboard ()
 
void pasteROIFromClipboard (bool quite=false)
 

Public Member Functions

void loadROI (string filename)
 Loads a .rmha file from disk into the 3D ROI Operator. More...
 
void loadLayer (string filename, int layerID=-1)
 Loads a .rmha file from disk into the 3D ROI Operator. More...
 
string getROICenterOfMass (unsigned char id)
 Returns the geometric center of mass of an ROI. More...
 
double getROIVolume (unsigned char id)
 Returns the volume of a ROI. More...
 
double get2DROIVolumeEstimation (unsigned char id, unsigned char planeId, unsigned int px1, unsigned int py1, unsigned int px2, unsigned int py2, unsigned int sections=20)
 Returns the Modified Simpson's approach for volume estimation of a 2D ROI on a given plane. More...
 
Array< int > getROIContourPoints (unsigned char id, unsigned char planeId)
 Returns the outline points of an ROI on the current slice of a given plane. More...
 
Array< string > getSplinePath (int id, bool interpolated=false)
 Returns the current spline points when using the spline tool. More...
 
void setSplinePath (int id, Array< string > list, bool closed=false)
 Sets spline points in the spline tool. More...
 
int numROIs ()
 Returns the number of ROIs in the current layer. More...
 
int numTotalROIs ()
 Returns the number of ROIs currently in the operator (all layers) More...
 
int numLayers ()
 Returns the number of layers currently in the operator. More...
 
Array< string > getROIDetails (int i)
 Returns various details regarding the display of an ROI. More...
 
Array< string > getLayerDetails (int i)
 Returns various details regarding the display of a layer. More...
 
void setInputROI (int roiIdx)
 Sets the input ROI for the Segmentation Tools. More...
 
void setInputROI (int layerId, int roiIdx)
 Sets the input ROI for the Segmentation Tools. More...
 
void setCurrentROI (int i)
 Sets the currently selected ROI in the 3D ROI Operator. More...
 
void setCurrentLayer (int i)
 Sets the currently selected layer in the 3D ROI Operator. More...
 

Protected Member Functions

void setROIViewMode (string mode)
 Set ROI painting mode. More...
 
void drawSphere (int x, int y, int z, float radius, int roi_id, bool updateDisplay=true)
 Draws a ROI sphere at a given point. More...
 
void drawCircle (int plane, int x, int y, int z, float radius, int roi_id, bool updateDisplay=true)
 Draws a ROI circle at a given point. More...
 
void drawCube (int x, int y, int z, float radius, int roi_id, bool updateDisplay=true)
 Draws a ROI cube at a given point. More...
 
void drawRect (int plane, int x, int y, int z, float radius, int roi_id, bool updateDisplay=true)
 Draws a ROI square at a given point. More...
 
void drawCylinder (int plane, int x, int y, int z, float radius, float height, int roi_id, bool updateDisplay=true)
 Draws a ROI square at a given point. More...
 
void resizeROI (int layerID=-1)
 

Detailed Description

Object to interact with the 3D ROI Operator when it is active.

This object can be used to interact with Regions Of Interest (ROIs) when the 3D ROI Tool Operator is loaded.

ROIs are index starting with the background at 0 See also ScriptMaster::currentOp() to obtain this object and MainWin::setViewMode() to enter the 3D ROI Operator

Member Function Documentation

◆ addLayer

void addLayer ( string  name,
bool  hidden = false,
int  alphaSlice = 127 
)
slot

Adds a new layer to the end of the current layer list.

Parameters
nameName of the layer
hiddenHide the layer or not
alphaSliceAlpha of the layer in the slice view (0-255)

◆ addROI [1/2]

void addROI ( string  name,
string  colorName,
bool  immutable = false,
bool  hidden = false,
int  alphaSlice = 127,
int  alphaSurface = 255 
)
slot

Adds a new ROI to the end of the current ROI list on the current active layer.

Parameters
nameName of the ROI
colorNameColor of the ROI.
immutableMake the ROI Immutable or not
hiddenHide the ROI or not
alphaSliceAlpha of the ROI in the slice view (0-255)
alphaSurfaceAlpha of the ROI in the VTK viewer (0-255)
Note
Available colors can be found here: http://www.w3.org/TR/SVG/types.html#ColorKeywords

◆ addROI [2/2]

void addROI ( int  layerID,
string  name,
string  colorName,
bool  immutable = false,
bool  hidden = false,
int  alphaSlice = 127,
int  alphaSurface = 255 
)
slot

Adds a new ROI to the end of the current ROI list on the specified layer.

Parameters
layerIDthe layer to which the ROI should be added to
nameName of the ROI
colorNameColor of the ROI.
immutableMake the ROI Immutable or not
hiddenHide the ROI or not
alphaSliceAlpha of the ROI in the slice view (0-255)
alphaSurfaceAlpha of the ROI in the VTK viewer (0-255)
Note
Available colors can be found here: http://www.w3.org/TR/SVG/types.html#ColorKeywords

◆ clearLayer

void clearLayer ( int  id = -1)
slot

Reassigns all ROIs of a layer.

Parameters
idIndex of layer to clear
Note
layer id stays in the layer list

◆ clearLayers

void clearLayers ( Array< int >  indices)
slot

Clears multiple layers.

Parameters
indicesArray of indicies to clear

◆ clearROI

void clearROI ( int  id = -1,
int  targetROI = -1,
int  targetLayer = -1,
int  movePolicy = ROIObject::respectImmutable 
)
slot

Reassigns all voxels of an ROI.

Parameters
idIndex of ROI to clear
targetROIIndex of ROI to recieve id's voxels
targetLayerIndex of layer to recieve id's voxels
Note
ROI id stays in the ROI list

◆ clearROIs

void clearROIs ( Array< int >  indices,
int  targetROI = -1,
int  targetLayer = -1,
int  movePolicy = ROIObject::respectImmutable 
)
slot

Clears multiple ROIs.

Parameters
indicesArray of indicies to clear
targetROIDestination ROI for voxels in indicies
targetLayerDestination layer for voxels in indicies

◆ copyLayerToClipboard

void copyLayerToClipboard ( )
slot

Copy active layer to Clipboard. this function can be used to copy ROI between layers or VQ instances.

◆ cutROI

void cutROI ( bool  bg,
bool  quiet = false,
Array< Index >  list = Array< Index >() 
)
slot

Removes regions of the volumes.

Parameters
bgIf true, removes all voxels in active volumes in the background ROI. If false, removes voxels in the current ROI
quietIf true, does not give a warning
Note
Voxels in ACTIVE volumes are rest to the minimum value set in the cache. This should be equal to the global minimum of the volume but isn't always the case
A volume MUST active (ie "turned on") for voxels to be reset

◆ deleteLayer

void deleteLayer ( int  id = -1,
int  target = -1,
int  targetMovePolicy = ROIObject::respectImmutable 
)
slot

Removes a layer from the list of layers and reassigns all its ROIs.

Parameters
idIndex of layer to delete
targetIndex of layer to recieve id's from deleted ROIs
targetMovePolicyis 0=replace, 1=no overwrite (keep target), 2=respect immutable status of target (default), 3=make new ROIs from overlap

◆ deleteLayers

void deleteLayers ( Array< int >  indices,
int  target = -1,
int  targetMovePolicy = ROIObject::respectImmutable 
)
slot

Delete multiple layers.

Parameters
indicesArray of indicies to delete
targetDestination layer for voxels in indicies
targetMovePolicyis 0=replace, 1=no overwrite (keep target), 2=respect immutable status of target (default), 3=make new ROIs from overlap

◆ deleteLayerToROI

void deleteLayerToROI ( int  id,
int  targetROI,
int  targetLayer,
int  targetMovePolicy = ROIObject::respectImmutable 
)
slot

Removes a layer from the list of layers and reassigns all its ROIs.

Parameters
idIndex of layer to delete
targetROIIndex of ROI to recieve id's from deleted ROIs
targetLayerIndex of layer to recieve id's
targetMovePolicyis 0=replace, 1=no overwrite (keep target), 2=respect immutable status of target (default), 3=make new ROIs from overlap

◆ deleteROI

void deleteROI ( int  id = -1,
int  targetROI = -1,
int  targetLayer = -1,
int  movePolicy = ROIObject::respectImmutable 
)
slot

Removes an ROI from the ROI list and reassigns all its voxels.

Parameters
idIndex of an ROI in the current layer to delete
targetROIIndex of an ROI to recieve id's voxels
targetLayerIndex of the layer of the target ROI

◆ deleteROIs

void deleteROIs ( Array< int >  indices,
int  targetROI = -1,
int  targetLayer = -1,
int  movePolicy = ROIObject::respectImmutable 
)
slot

Delete multiple ROIs.

Parameters
indicesArray of indicies to delete
targetROIDestination ROI for voxels in indicies
targetLayerDestination layer for voxels in indicies

◆ drawCircle()

void drawCircle ( int  plane,
int  x,
int  y,
int  z,
float  radius,
int  roi_id,
bool  updateDisplay = true 
)
protected

Draws a ROI circle at a given point.

Parameters
planePlane in which to draw the circle (0=sagittal,1=coronal,2=transverse)
xCoordinate in the X (sagittal) plane of center of circle
yCoordinate in the Y (coronal) plane of center of circle
zCoordinate in the Z (transverse) plane of center of circle
radiusRadius of the circle, in voxels
roi_idIndex of ROI to update
updateDisplayIf true, will immediately update the display to show the drawn ROI
Note
If making many (>10) drawing calls, it is recommended to turn off updateDisplay until the last iteration
(x,y,z) correspond to dimensions (0,1,2) as gotten by QSliceViewControl::getPos() or other View Controler functions

◆ drawCube()

void drawCube ( int  x,
int  y,
int  z,
float  radius,
int  roi_id,
bool  updateDisplay = true 
)
protected

Draws a ROI cube at a given point.

Parameters
xCoordinate in the X (sagittal) plane of center of cube
yCoordinate in the Y (coronal) plane of center of cube
zCoordinate in the Z (transverse) plane of center of cube
radiusRadius of the cube, in voxels. Cube has sides of length 2*radius
roi_idIndex of ROI to update
updateDisplayIf true, will immediately update the display to show the drawn ROI
Note
If making many (>10) drawing calls, it is recommended to turn off updateDisplay until the last iteration
(x,y,z) correspond to dimensions (0,1,2) as gotten by QSliceViewControl::getPos() or other View Controler functions

◆ drawCylinder()

void drawCylinder ( int  plane,
int  x,
int  y,
int  z,
float  radius,
float  height,
int  roi_id,
bool  updateDisplay = true 
)
protected

Draws a ROI square at a given point.

Parameters
planePlane in which to draw the circle (0=sagittal,1=coronal,2=transverse)
xCoordinate in the X (sagittal) plane of center of cylinder
yCoordinate in the Y (coronal) plane of center of cylinder
zCoordinate in the Z (transverse) plane of center of cylinder
radiusRadius of the cylinder, in voxels
heightHeight of the cylinder. Height is extended to height/2 on either sides of the center point perpendicular to plane
roi_idIndex of ROI to update
updateDisplayIf true, will immediately update the display to show the drawn ROI
Note
If making many (>10) drawing calls, it is recommended to turn off updateDisplay until the last iteration
(x,y,z) correspond to dimensions (0,1,2) as gotten by QSliceViewControl::getPos() or other View Controler functions

◆ drawRect()

void drawRect ( int  plane,
int  x,
int  y,
int  z,
float  radius,
int  roi_id,
bool  updateDisplay = true 
)
protected

Draws a ROI square at a given point.

Parameters
planePlane in which to draw the square (0=sagittal,1=coronal,2=transverse)
xCoordinate in the X (sagittal) plane of center of square
yCoordinate in the Y (coronal) plane of center of square
zCoordinate in the Z (transverse) plane of center of square
radiusRadius of the square, in voxels (square has sides of length 2*radius)
roi_idIndex of ROI to update
updateDisplayIf true, will immediately update the display to show the drawn ROI
Note
If making many (>10) drawing calls, it is recommended to turn off updateDisplay until the last iteration
(x,y,z) correspond to dimensions (0,1,2) as gotten by QSliceViewControl::getPos() or other View Controler functions

◆ drawSphere()

void drawSphere ( int  x,
int  y,
int  z,
float  radius,
int  roi_id,
bool  updateDisplay = true 
)
protected

Draws a ROI sphere at a given point.

Parameters
xCoordinate in the X (sagittal) plane of center of sphere
yCoordinate in the Y (coronal) plane of center of sphere
zCoordinate in the Z (transverse) plane of center of sphere
radiusRadius of the sphere, in voxels
roi_idIndex of ROI to update
updateDisplayIf true, will immediately update the display to show the drawn ROI
Note
If making many (>10) drawing calls, it is recommended to turn off updateDisplay until the last iteration
(x,y,z) correspond to dimensions (0,1,2) as gotten by QSliceViewControl::getPos() or other View Controler functions

◆ editLayer

void editLayer ( int  id,
string  name,
bool  hidden = false,
int  alphaSlice = 127 
)
slot

Edits various layer properties such as name, alpha.

Parameters
idIndex of layer to edit
nameName of the layer
hiddenHide the layer or not
alphaSliceAlpha of the ROI in the slice view (0-255)

◆ editROI [1/2]

void editROI ( int  id,
string  name,
string  colorName,
bool  immutable = false,
bool  hidden = false,
int  alphaSlice = 127,
int  alphaSurface = 255,
string  layer = "" 
)
slot

Edits various ROI properties such as name, color on the current active layer.

Parameters
idIndex of ROI to edit
nameName of the ROI
colorNameColor of the ROI.
immutableMake the ROI Immutable or not
hiddenHide the ROI or not
alphaSliceAlpha of the ROI in the slice view (0-255)
alphaSurfaceAlpha of the ROI in the VTK viewer (0-255)
layerName of the layer this ROI is moved to
Note
Available colors can be found here: http://www.w3.org/TR/SVG/types.html#ColorKeywords

◆ editROI [2/2]

void editROI ( int  layerID,
int  id,
string  name,
string  colorName,
bool  immutable = false,
bool  hidden = false,
int  alphaSlice = 127,
int  alphaSurface = 255,
string  layer = "" 
)
slot

Edits various ROI properties such as name, color on the specified layer.

Parameters
layerIDthe layer to which the ROI is on
idIndex of ROI to edit
nameName of the ROI
colorNameColor of the ROI.
immutableMake the ROI Immutable or not
hiddenHide the ROI or not
alphaSliceAlpha of the ROI in the slice view (0-255)
alphaSurfaceAlpha of the ROI in the VTK viewer (0-255)
layerName of the layer this ROI is moved to
Note
Available colors can be found here: http://www.w3.org/TR/SVG/types.html#ColorKeywords

◆ exportROIs

void exportROIs ( Array< int >  exportROIs)
slot

Exports an ROI (or group of ROIs) as a Volume in the Data Manager.

Parameters
exportROIsArray of ROI indicies to export
Note
ROIs will be exported into a new volume and appended to the end of the data manager. The index number of each ROI will have that corresponding value for all its voxels

◆ exportTable

void exportTable ( string  filename = "",
bool  openFile = true 
)
slot

Exports a table of selected metrics for ROIs; e.g. Volume, Sum.

Parameters
filenameName of output file

◆ get2DROIVolumeEstimation()

double get2DROIVolumeEstimation ( unsigned char  id,
unsigned char  planeId,
unsigned int  px1,
unsigned int  py1,
unsigned int  px2,
unsigned int  py2,
unsigned int  sections = 20 
)

Returns the Modified Simpson's approach for volume estimation of a 2D ROI on a given plane.

Parameters
idIndex of ROI
planeId(0 = sagittal, 1 = coronal, 2 = transverse)
p1Long axis start point
p1Long axis end point
sectionsThe number of sections along the long axis
Returns
The estimated volume

◆ getLayerDetails()

Array<string> getLayerDetails ( int  i)

Returns various details regarding the display of a layer.

Parameters
iIndex of Layer to get details
Returns
A length 2 array containing the following information:
array[0]: Name of Layer
array[1]: Layer Alpha in the slice view (0-255: 0=transparent, 255=opaque)

◆ getROICenterOfMass()

string getROICenterOfMass ( unsigned char  id)

Returns the geometric center of mass of an ROI.

Parameters
idIndex of ROI to load
Returns
String of containing the x,y, and z position of the center of mass of the ROI in the form "x,y,z"

◆ getROIContourPoints()

Array<int> getROIContourPoints ( unsigned char  id,
unsigned char  planeId 
)

Returns the outline points of an ROI on the current slice of a given plane.

Parameters
idIndex of ROI
planeId(0 = sagittal, 1 = coronal, 2 = transverse)
Returns
String of (x,y) coordinates in the format "x1,y1,x2,y2..." in the planeID (on the current slice) where the outline of the ROI id exists)

◆ getROIDetails()

Array<string> getROIDetails ( int  i)

Returns various details regarding the display of an ROI.

Parameters
iIndex of ROI to get details
Returns
A length 6 array containing the following information:
array[0]: Name of ROI
array[1]: ROI Color
array[2]: 0 if ROI is mutable, 1 if ROI is immutable
array[3]: 0 if ROI is visible, 1 if ROI is hidden
array[4]: ROI Alpha in the slice view (0-255: 0=transparent, 255=opaque)
array[5]: ROI Alpha in the VTK Viewer (0-255: 0=transparent, 255=opaque)

◆ getROIVolume()

double getROIVolume ( unsigned char  id)

Returns the volume of a ROI.

Parameters
idIndex of ROI
Returns
Double containing ROI volume (in mm^3)

◆ getSplinePath()

Array<string> getSplinePath ( int  id,
bool  interpolated = false 
)

Returns the current spline points when using the spline tool.

Parameters
idPlane (0 = sagittal , 1 = conronal, 2 = transverse) to grab spline points
interpolatedIf true, returns every point along interpolated (green) line. If false, returns just the clicked points
Returns
String of (x,y) coordinates in the format "x1,y1,x2,y2..."

◆ kmeanManualSeedCluster

void kmeanManualSeedCluster ( string  kmeans)
slot

a helper function to set the seed mean value for manual kmean segmentation

Parameters
astring that contains double values that split by ","

◆ loadLayer()

void loadLayer ( string  filename,
int  layerID = -1 
)

Loads a .rmha file from disk into the 3D ROI Operator.

Parameters
filenamePath to filename on disk
layerIDThe layer index to load into (if not provided, the ROIs will be loaded in the active layer)

◆ loadLayerFromIPACS

void loadLayerFromIPACS ( bool  quiet = false,
int  layerID = -1 
)
slot

Download the ROIs into the specified layer from the associated data on the iPACS.

Parameters
quietIf true, the most recent ROIs will be loaded and no dialog will be shown
layerIDThe layer ID to download the ROIs to (if not specified, the active layer will be used)

◆ loadROI()

void loadROI ( string  filename)

Loads a .rmha file from disk into the 3D ROI Operator.

Parameters
filenamePath to filename on disk

◆ loadROIFromIPACS

void loadROIFromIPACS ( bool  quiet = false)
slot

Download the ROIs from associated data on the iPACS.

Parameters
quietIf true, the most recent ROIs will be loaded and no dialog will be shown

◆ loadRTStructureAsROI

void loadRTStructureAsROI ( string  filename)
slot

Use DicomReader to load an ROI in the RT Structure Set format specified by the Dicom standard and used by the Siemens IRW. Replaces existing roi;

◆ loadVOIAsROI

void loadVOIAsROI ( string  filename)
slot

Support for PMOD region of interest files.

Parameters
filenameName of file

◆ numLayers()

int numLayers ( )
inline

Returns the number of layers currently in the operator.

Returns
Number of layers in the operator

◆ numROIs()

int numROIs ( )
inline

Returns the number of ROIs in the current layer.

Returns
Number of ROIs for the current layer
Note
Background is included so the function will never return less than 1

◆ numTotalROIs()

int numTotalROIs ( )
inline

Returns the number of ROIs currently in the operator (all layers)

Returns
The sum of the number of ROIs from all the Layers
Note
A Background ROI for each layer is included in the total

◆ pasteROIFromClipboard

void pasteROIFromClipboard ( bool  quite = false)
slot

Paste ROIs from Clipbard to current active layer. this function can be used to copy ROI between layers or VQ instances.

Parameters
quietIf true, overlayed ROIs will be overwritten and no dialog will be shown.

◆ resizeROI()

void resizeROI ( int  layerID = -1)
protected

If the dimensions of the underlying ROI object do not match that of the reference image, resize and clear the ROI object and display a notification dialog

◆ saveLayer

void saveLayer ( string  filename,
int  layerID = -1,
string  compression = "RLE" 
)
slot

Save an ROI Layer to Disk.

Parameters
filenameLocal path to output (saved) rmha file
layerIDThe layerID of the ROI to be saved
compressionType of Compression to use (Use RLE in almost all cases)

◆ saveROI

void saveROI ( string  filename,
string  compression = "RLE" 
)
slot

Save an ROI to Disk.

Parameters
filenameLocal path to output (saved) rmha file
compressionType of Compression to use (Use RLE in almost all cases)

◆ setCurrentLayer()

void setCurrentLayer ( int  i)
inline

Sets the currently selected layer in the 3D ROI Operator.

Parameters
iIndex of the layer to set as Current

◆ setCurrentROI()

void setCurrentROI ( int  i)
inline

Sets the currently selected ROI in the 3D ROI Operator.

Parameters
iIndex of the ROI to set as Current

◆ setInputROI() [1/2]

void setInputROI ( int  roiIdx)

Sets the input ROI for the Segmentation Tools.

Parameters
iIndex of ROI from the current active layer to set as Input

◆ setInputROI() [2/2]

void setInputROI ( int  layerId,
int  roiIdx 
)

Sets the input ROI for the Segmentation Tools.

Parameters
iIndex of layer to set as Input
iIndex of ROI to set as Input

◆ setROIViewMode()

void setROIViewMode ( string  mode)
protected

Set ROI painting mode.

Parameters
modePaint mode name, should be "All Layer", "All ROI", "Current Layer", "Outline"

◆ setSplinePath()

void setSplinePath ( int  id,
Array< string >  list,
bool  closed = false 
)

Sets spline points in the spline tool.

Parameters
idIndex of ROI
listArray in the form [x1,y1,x2,y2,...] denoting the points of the spline
closedif True, will complete the spline interpolation

◆ showTable

void showTable ( bool  quick = false)
slot

Displays a table of selected metrics for ROIs that have been created; e.g. Volume, Sum.

Parameters
quickIf true will automatically display a table of metrics; default = false

◆ submitLayer

void submitLayer ( bool  quiet = false,
bool  allMetric = false,
int  layerID = -1 
)
slot

Submit the ROIs of the specified layer to the associated data on the iPACS.

Parameters
quietIf true, no setting dialog is shown and latest saving parameters are used
allMetricif true, force to save all the quantification metrics
layerIDThe layer ID to save the ROIs from (if not specified, the active layer will be used)

◆ submitROI

void submitROI ( bool  quiet = false,
bool  allMetric = false 
)
slot

Submit the ROIs to the associated data on the iPACS.

Parameters
quietIf true, no setting dialog is shown and latest saving parameters are used
allMetricif true, force to save all the quantification metrics

◆ toggleHidden

void toggleHidden ( Array< int >  indices)
slot

Toggles the hidden attribute of ROI(s)

Parameters
indicesArray of ROI indicies to toggle

◆ toggleImmutable

void toggleImmutable ( Array< int >  indices)
slot

Toggles the immutable attribute of ROI(s)

Parameters
indicesArray of ROI indicies to toggle