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

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

Public Slots

void deleteFiducial (int idx=-1, int childRow=-1, int childCol=-1)
 Delete the specified fiducial. More...
 
void splitFiducials (Index idx=Index())
 Split all delineated fiducials into separate data objects. Runs the main purpose of this operator. More...
 
void splitFiducialsToFiles (Index idx=Index(), string filename=string())
 Split all delineated fiducials into separate data objects and stores them to disk. More...
 
void saveToFile (string name)
 save to file More...
 
void loadFromFile (string name)
 load from file More...
 

Public Member Functions

void setFiducialName (string name, int row, int col=-1)
 Change the name of a fiducial. More...
 
void setFiducialOrientation (string orient, int row, int col=-1)
 Change the orientation of a fiducial. More...
 
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. More...
 
void addRectangleFiducial (int plane, double rwidth, double rheight, string name=string())
 Add a new 3D rectangle-shaped fiducial spanning an entire plane/axis and initialized in a centered position within the image. More...
 
void addRectangleFiducial (int 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. More...
 
void addCylinderFiducial (int 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. More...
 
void addCylinderFiducial (int 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 full FOV along the plane axis. More...
 
void addRectangleGroup (int plane, int nrows, int ncols, string name=string(), Array< string > rectNames=Array< string >())
 Add a grid of rectangular fiducials on a specified plane. More...
 
void addCylinderGroup (int plane, int nrows, int ncols, double radius=-1, string name=string())
 Add a grid of cylinder fiducials on a specified plane. More...
 
void selectFiducial (int idx, int childIdx=-1)
 Set the currently selected fiducial in the graphical interface. More...
 

Detailed 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.

See also ScriptMaster::currentOp() to obtain this object.

Member Function Documentation

◆ addCylinderFiducial() [1/2]

void addCylinderFiducial ( int  plane,
double  centerX,
double  centerY,
double  centerZ,
double  radius,
double  height,
string  name = string() 
)
inline

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

Parameters
planeis 0=Coronal, 1=Sagittal, 2=Transverse
centerXis the Left->Right coordinate of geometric center
centerYis the Posterior->Anterior coordinate of geometric center
centerZis the Superior->Inferior coordinate of geometric center
radiusis the radius of the cylinder
heightis the height of the cylinder
nameis the displayed name fo the cylinder

◆ addCylinderFiducial() [2/2]

void addCylinderFiducial ( int  plane,
double  radius,
string  name = string() 
)
inline

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 full FOV along the plane axis.

Parameters
planeis 0=Coronal, 1=Sagittal, 2=Transverse
radiusis the radius of the cylinder
nameis the displayed name fo the cylinder

◆ addCylinderGroup()

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

Add a grid of cylinder fiducials on a specified plane.

Parameters
planeis 0=Coronal, 1=Sagittal, 2=Transverse
nrowsis the number of rows in the grid of rectangles to be added
ncolsis the number of columns in the grid of rectangles to be added
radiusis the radius of the cylinder
nameis the name given to the new fiducial

◆ addRectangleFiducial() [1/3]

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

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

Parameters
topLeftXis the left-most coordinate bounding the rectangle
topLeftYis the posterior-most coordinate bounding the rectangle
topLeftZis the superior-most coordinate bounding the rectangle
bottomRightXis the right-most coordinate bounding the rectangle
bottomRightYis the anterior-most coordinate bounding the rectangle
bottomRightZis the inferior-most coordinate bounding the rectangle
nameis name given to the new fiducial

◆ addRectangleFiducial() [2/3]

void addRectangleFiducial ( int  plane,
double  rwidth,
double  rheight,
double  rdepth,
string  name = string() 
)
inline

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

Parameters
planeis 0=Coronal, 1=Sagittal, 2=Transverse
rwidthis the physical width (mm) of the fiducial
rheightis the physical height (mm) of the fiducial
rdepthis the physical depth (mm) of the fiducial
nameis the name given to the new fiducial

◆ addRectangleFiducial() [3/3]

void addRectangleFiducial ( int  plane,
double  rwidth,
double  rheight,
string  name = string() 
)
inline

Add a new 3D rectangle-shaped fiducial spanning an entire plane/axis and initialized in a centered position within the image.

Parameters
planeis 0=Coronal, 1=Sagittal, 2=Transverse
rwidthis the physical width (mm) of the fiducial
rheightis the physical height (mm) of the fiducial
nameis the name given to the new fiducial

◆ addRectangleGroup()

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

Add a grid of rectangular fiducials on a specified plane.

Parameters
planeis 0=Coronal, 1=Sagittal, 2=Transverse
nrowsis the number of rows in the grid of rectangles to be added
ncolsis the number of columns in the grid of rectangles to be added
nameis the name given to the new fiducial

◆ deleteFiducial

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

Delete the specified fiducial.

Parameters
idxis the root-level index in the fiducial tree
childRowif the fiducial to be deleted is the part of a group, this is the row within that group
childColif the fiducial to be deleted is the part of a group, this is the column within that group

◆ loadFromFile

void loadFromFile ( string  name)
slot

load from file

Parameters
filename

◆ saveToFile

void saveToFile ( string  name)
slot

save to file

Parameters
filename;

◆ selectFiducial()

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

Set the currently selected fiducial in the graphical interface.

Parameters
idxis the root-level index in the fiducial tree
childIdxif 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
nameThe new name of the fiducial
rowThe fiducial's row index
rowThe fiducial's col index

◆ setFiducialOrientation()

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

Change the orientation of a fiducial.

Parameters
orientThe orientation of the fiducial
rowThe fiducial's row index
rowThe fiducial's col index

◆ splitFiducials

void splitFiducials ( Index  idx = Index())
slot

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

Parameters
idxis 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() 
)
slot

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

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