CroppingOperator Class Reference

Object for croping the displayed data in the Slice viewports. More...

#include <CroppingOperator.h>

Public Slots
void	executeCropping ()
	Executes the selected cropping.
void	embed ()
	Embed the data set to the selected values.

Public Member Functions
void	setFrom (int x, int y, int z)
	Function to set the coordinates of the "From" spinbox to the given coordinates.
void	setTo (int x, int y, int z)
	Function to set the coordinates of the "To" spinbox to the given coordinates.
void	setEmbed (int x, int y, int z)
	Function to set the coordinates of the "embed" spinbox to the given coordinates.
Array< int >	getFrom ()
	Function to get the coordinates of the "From" spinbox.
Array< int >	getTo ()
	Function to get the coordinates of the "To" spinbox.
Array< int >	getEmbed ()
	Function to get the coordinates of the "Embed" spinbox.
bool	setEmbedValueMode (string mode)
	Function to set the embed fill value mode.
string	getEmbedValueMode ()
	Function to get the current embed fill value mode.
void	setEmbedValuePercent (double percent)
	Function to set the percentage used when the embed fill value mode is "Percentage".
double	getEmbedValuePercent ()
	Function to get the percentage used when the embed fill value mode is "Percentage".

Detailed Description

Object for croping the displayed data in the Slice viewports.

This object can be used to crop and embed the data and/or ROIs that are being displayed in each Slice View.

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

Member Function Documentation

getEmbed()

Array< int > getEmbed

(

)

Function to get the coordinates of the "Embed" spinbox.

Returns

Array<int> of the x,y,z coordinates of the "Embed" spinbox

getEmbedValueMode()

string getEmbedValueMode

(

)

Function to get the current embed fill value mode.

Returns

string of the current embed fill value mode ("Minimum", "Maximum", or "Percentage")

getEmbedValuePercent()

double getEmbedValuePercent

(

)

Function to get the percentage used when the embed fill value mode is "Percentage".

Returns

double the current percentage value (0.0-100.0)

getFrom()

Array< int > getFrom

(

)

Function to get the coordinates of the "From" spinbox.

Returns

Array<int> of the x,y,z coordinates of the "From" spinbox

getTo()

Array< int > getTo

(

)

Function to get the coordinates of the "To" spinbox.

Returns

Array<int> of the x,y,z coordinates of the "To" spinbox

setEmbed()

void setEmbed	(	int	x,
		int	y,
		int	z
	)

Function to set the coordinates of the "embed" spinbox to the given coordinates.

Parameters

x	given x coordinate
y	given y coordinate
z	given z coordinate

setEmbedValueMode()

bool setEmbedValueMode

(

string

mode

)

Function to set the embed fill value mode.

Parameters

mode	the fill value mode: "Minimum", "Maximum", or "Percentage"

Returns

true if mode was recognized and applied; false otherwise

setEmbedValuePercent()

void setEmbedValuePercent

(

double

percent

)

Function to set the percentage used when the embed fill value mode is "Percentage".

Parameters

percent

value between 0.0 and 100.0

setFrom()

void setFrom	(	int	x,
		int	y,
		int	z
	)

Function to set the coordinates of the "From" spinbox to the given coordinates.

Parameters

x	given x coordinate
y	given y coordinate
z	given z coordinate

setTo()

void setTo	(	int	x,
		int	y,
		int	z
	)

Function to set the coordinates of the "To" spinbox to the given coordinates.

Parameters

x	given x coordinate
y	given y coordinate
z	given z coordinate