Description

Object to interact with the Splitting Operator when it is active.

This object can be used to apply volume splitting operations on loaded images when the Splitting Operator is open.

Select this operator with VQ.mainWin().setViewMode(), then obtain it with VQ.currentOp().

VQ.mainWin().setViewMode("Slice View", "Splitting"); // switch to the splitting operator

var splittingOperator = VQ.currentOp();

Public Slots
void	addSelectedDataShapeDefault ()
	Will attempt to add the currently selected shape with the current data defaults of that type. If of a group type the rows and columns will be the currently set values.
void	addDataShapeDefault (int selection, int rows, int cols)
	Will attempt to add the shape selected with the current data defaults of that type.
void	addSelectedUserShapeDefault ()
	Will attempt to add the currently selected shape from the user defaults of that type.
void	addUserShapeDefault (int selection)
	Will attempt to add the shape selected from the user defaults of that type.
void	saveSelectedUserShapeDefault ()
	Will attempt to save out the currently selected shape to the the user default of that type.
void	deleteFiducial (int idx=-1, int childRow=-1, int childCol=-1)
	Delete the specified fiducial.
void	resetShapeToSavedState ()
	Will attemp to reset the current selected shape to the last user saved state for that type.
void	splitFiducials (Index idx=Index())
	Split all delineated fiducials into separate data objects. Runs the main purpose of this operator.
void	splitFiducialsToFiles (Index idx=Index(), string filename=string(), bool compress=false)
	Split all delineated fiducials into separate data objects and stores them to disk.
bool	saveShapes ()
	Saves out the entire current shape list, a file save dialog will appear.
bool	loadShapes ()
	Loads the saved shape list and replaces the current list, a file open dialog will appear.
bool	saveToFile (string name)
	Saves the current shape list to file.
bool	loadFromFile (string name)
	Loads from file a shape list and replaces the current list.

Public Member Functions
void	setFiducialName (string name, int row, int col=-1)
	Change the name of a fiducial.
void	setFiducialOrientation (string orient, int row, int col=-1)
	Change the orientation of a fiducial.
void	addRectangleFiducial (double topLeftX, double topLeftY, double topLeftZ, double bottomRightX, double bottomRightY, double bottomRightZ, string name=string())
	Add a new 3D rectangle-shaped fiducial using RAS coordinates.
void	addRectangleFiducial (VQ.Plane plane, string name=string())
	Add a new 3D rectangle-shaped fiducial with data correlated defaults and initialized in a centered position within the image.
void	addRectangleFiducial (VQ.Plane plane, double rwidth, double rheight, string name=string())
	Add a new 3D rectangle-shaped fiducial with the dimensions and initialized in a centered position within the image.
void	addRectangleFiducial (VQ.Plane plane, double rwidth, double rheight, double rdepth, string name=string())
	Add a new 3D rectangle-shaped fiducial initialized in a centered position within the image.
void	addCylinderFiducial (VQ.Plane plane, double centerX, double centerY, double centerZ, double radius, double height, string name=string())
	Add a new 3D cylindrically-shaped fiducial with 3D center point, plane, radius, and height.
void	addCylinderFiducial (VQ.Plane plane, string name=string())
	Add a new 3D cylindrically-shaped fiducial with data correlated defaults and initialized in a centered position within the image.
void	addCylinderFiducial (VQ.Plane plane, double radius, string name=string())
	Add a new 3D cylinderically-shaped fiducial with height axis along plane, specified radius, and centered in the plane. The height of the cylinder is the 90% of the full FOV along the plane axis.
void	addRectangleGroup (VQ.Plane plane, int nrows, int ncols, string name=string(), Array< string > rectNames=Array< string >())
	Add a grid of rectangular fiducials on a specified plane.
void	addCylinderGroup (VQ.Plane plane, int nrows, int ncols, double radius=-1, string name=string())
	Add a grid of cylinder fiducials on a specified plane.
void	selectFiducial (int idx, int childIdx=-1)
	Set the currently selected fiducial in the graphical interface.

Member Function Documentation

◆ addCylinderFiducial() [1/3]

void addCylinderFiducial	(	VQ.Plane	plane,
		double	centerX,
		double	centerY,
		double	centerZ,
		double	radius,
		double	height,
		string	name = string() )

Add a new 3D cylindrically-shaped fiducial with 3D center point, plane, radius, and height.

Parameters

plane	A value of VQ.Plane (e.g. VQ.Plane.Sagittal)
centerX	is the Left->Right coordinate of geometric center
centerY	is the Posterior->Anterior coordinate of geometric center
centerZ	is the Superior->Inferior coordinate of geometric center
radius	is the radius of the cylinder
height	is the height of the cylinder
name	is the displayed name fo the cylinder

◆ addCylinderFiducial() [2/3]

void addCylinderFiducial	(	VQ.Plane	plane,
		double	radius,
		string	name = string() )

Add a new 3D cylinderically-shaped fiducial with height axis along plane, specified radius, and centered in the plane. The height of the cylinder is the 90% of the full FOV along the plane axis.

Parameters

plane	A value of VQ.Plane (e.g. VQ.Plane.Sagittal)
radius	is the radius of the cylinder
name	is the displayed name fo the cylinder

◆ addCylinderFiducial() [3/3]

void addCylinderFiducial	(	VQ.Plane	plane,
		string	name = string() )

Add a new 3D cylindrically-shaped fiducial with data correlated defaults and initialized in a centered position within the image.

Parameters

plane	A value of VQ.Plane (e.g. VQ.Plane.Sagittal)
name	is the name given to the new fiducial

◆ addCylinderGroup()

void addCylinderGroup	(	VQ.Plane	plane,
		int	nrows,
		int	ncols,
		double	radius = -1,
		string	name = string() )

Add a grid of cylinder fiducials on a specified plane.

Parameters

plane	A value of VQ.Plane (e.g. VQ.Plane.Sagittal)
nrows	is the number of rows in the grid of rectangles to be added
ncols	is the number of columns in the grid of rectangles to be added
radius	is the radius of the cylinder
name	is the name given to the new fiducial

◆ addDataShapeDefault

void addDataShapeDefault	(	int	selection,
		int	rows,
		int	cols )

slot

Will attempt to add the shape selected with the current data defaults of that type.

Parameters

selection	is the corresponding shape or shape group index
rows	is the number of rows the group should have if of that type
cols	is the number of columns the group should have if of that type

◆ addRectangleFiducial() [1/4]

void addRectangleFiducial	(	double	topLeftX,
		double	topLeftY,
		double	topLeftZ,
		double	bottomRightX,
		double	bottomRightY,
		double	bottomRightZ,
		string	name = string() )

Add a new 3D rectangle-shaped fiducial using RAS coordinates.

Parameters

topLeftX	is the left-most coordinate bounding the rectangle
topLeftY	is the posterior-most coordinate bounding the rectangle
topLeftZ	is the superior-most coordinate bounding the rectangle
bottomRightX	is the right-most coordinate bounding the rectangle
bottomRightY	is the anterior-most coordinate bounding the rectangle
bottomRightZ	is the inferior-most coordinate bounding the rectangle
name	is name given to the new fiducial

◆ addRectangleFiducial() [2/4]

void addRectangleFiducial	(	VQ.Plane	plane,
		double	rwidth,
		double	rheight,
		double	rdepth,
		string	name = string() )

Add a new 3D rectangle-shaped fiducial initialized in a centered position within the image.

Parameters

plane	A value of VQ.Plane (e.g. VQ.Plane.Sagittal)
rwidth	is the physical width (mm) of the fiducial
rheight	is the physical height (mm) of the fiducial
rdepth	is the physical depth (mm) of the fiducial
name	is the name given to the new fiducial

◆ addRectangleFiducial() [3/4]

void addRectangleFiducial	(	VQ.Plane	plane,
		double	rwidth,
		double	rheight,
		string	name = string() )

Add a new 3D rectangle-shaped fiducial with the dimensions and initialized in a centered position within the image.

Parameters

plane	A value of VQ.Plane (e.g. VQ.Plane.Sagittal)
rwidth	is the physical width (mm) of the fiducial
rheight	is the physical height (mm) of the fiducial
name	is the name given to the new fiducial

◆ addRectangleFiducial() [4/4]

void addRectangleFiducial	(	VQ.Plane	plane,
		string	name = string() )

Add a new 3D rectangle-shaped fiducial with data correlated defaults and initialized in a centered position within the image.

Parameters

plane	A value of VQ.Plane (e.g. VQ.Plane.Sagittal)
name	is the name given to the new fiducial

◆ addRectangleGroup()

void addRectangleGroup	(	VQ.Plane	plane,
		int	nrows,
		int	ncols,
		string	name = string(),
		Array< string >	rectNames = Array< string >() )

Add a grid of rectangular fiducials on a specified plane.

Parameters

plane	A value of VQ.Plane (e.g. VQ.Plane.Sagittal)
nrows	is the number of rows in the grid of rectangles to be added
ncols	is the number of columns in the grid of rectangles to be added
name	is the name given to the new fiducial
rectNames	Optional names for the individual rectangles in the grid

◆ addUserShapeDefault

void addUserShapeDefault ( int selection )

slot

Will attempt to add the shape selected from the user defaults of that type.

Parameters

selection is the corresponding shape or shape group index

◆ deleteFiducial

void deleteFiducial	(	int	idx = -1,
		int	childRow = -1,
		int	childCol = -1 )

slot

Delete the specified fiducial.

Parameters

idx	is the root-level index in the fiducial tree
childRow	if the fiducial to be deleted is the part of a group, this is the row within that group
childCol	if the fiducial to be deleted is the part of a group, this is the column within that group

◆ loadFromFile

bool loadFromFile ( string name )

slot

Loads from file a shape list and replaces the current list.

Parameters

name	Path and file name to load from

◆ saveToFile

bool saveToFile ( string name )

slot

Saves the current shape list to file.

Parameters

name	Path and file name to save to

◆ selectFiducial()

void selectFiducial	(	int	idx,
		int	childIdx = -1 )

Set the currently selected fiducial in the graphical interface.

Parameters

idx	is the root-level index in the fiducial tree
childIdx	if the fiducial to be selected is the part of a group, this is the index within that group

◆ setFiducialName()

void setFiducialName	(	string	name,
		int	row,
		int	col = -1 )

Change the name of a fiducial.

Parameters

name	The new name of the fiducial
row	The fiducial's row index
col	The fiducial's column index (default: -1)

◆ setFiducialOrientation()

void setFiducialOrientation	(	string	orient,
		int	row,
		int	col = -1 )

Change the orientation of a fiducial.

Parameters

orient	The orientation of the fiducial
row	The fiducial's row index
col	The fiducial's column index (default: -1)

◆ splitFiducials

void splitFiducials ( Index idx = Index() )

slot

Split all delineated fiducials into separate data objects. Runs the main purpose of this operator.

Parameters

idx	is DataManager index of data set to split. If a valid index is not provided, the user will be prompted for a selection

◆ splitFiducialsToFiles

void splitFiducialsToFiles	(	Index	idx = Index(),
		string	filename = string(),
		bool	compress = false )

slot

Split all delineated fiducials into separate data objects and stores them to disk.

Parameters

idx	is DataManager index of data set to split. If a valid index is not provided, the user will be prompted for a selection
filename	is the name of the file to save to.
compress	Use JPEG2000 Lossless compression

Description

Public Slots

Public Member Functions

Member Function Documentation

◆ addCylinderFiducial() [1/3]

◆ addCylinderFiducial() [2/3]

◆ addCylinderFiducial() [3/3]

◆ addCylinderGroup()

◆ addDataShapeDefault

◆ addRectangleFiducial() [1/4]

◆ addRectangleFiducial() [2/4]

◆ addRectangleFiducial() [3/4]

◆ addRectangleFiducial() [4/4]

◆ addRectangleGroup()

◆ addUserShapeDefault

◆ deleteFiducial

◆ loadFromFile

◆ saveToFile

◆ selectFiducial()

◆ setFiducialName()

◆ setFiducialOrientation()

◆ splitFiducials

◆ splitFiducialsToFiles