OpenWalnut: WROIArbitrary Class Reference

A box containing information on an arbitrarily shaped a region of interest. More...

#include <WROIArbitrary.h>

Inheritance diagram for WROIArbitrary:

List of all members.

Classes
class	ROIArbNodeCallback
	Node callback to handle updates properly. More...
Public Member Functions
	WROIArbitrary (size_t nbCoordsX, size_t nbCoordsY, size_t nbCoordsZ, const WMatrix< double > &mat, const std::vector< float > &vals, boost::shared_ptr< WTriangleMesh > triMesh, float threshold, float maxThreshold, WColor color)
	constructor
	WROIArbitrary (size_t nbCoordsX, size_t nbCoordsY, size_t nbCoordsZ, const WMatrix< double > &mat, const std::vector< float > &vals, float maxThreshold, WColor color)
	constructor
virtual	~WROIArbitrary ()
	destructor
void	properties ()
	initalizes the properties
void	propertyChanged ()
	callback when a property gets changed
void	setThreshold (double threshold)
	setter
double	getThreshold ()
	getter
std::vector< size_t >	getCoordDimensions ()
	Get the number of vertices in the three coordinate directions.
std::vector< double >	getCoordOffsets ()
	Get the vertex offsets in the three coordinate directions.
float	getValue (size_t i)
	Get the i-th value of the data defining the ROI.
virtual void	updateGFX ()
	updates the graphics
Private Attributes
std::vector< size_t >	m_nbCoordsVec
	The data's number of vertices in X, Y and Z direction.
WMatrix< double >	m_matrix
	The 4x4 transformation matrix for the vertices.
const std::vector< float >	m_vals
	The data at the vertices.
boost::shared_ptr< WTriangleMesh >	m_triMesh
	This triangle mesh is provided as output through the connector.
WPropDouble	m_threshold
	the threshold
WColor	m_color
	The ROI color.

Detailed Description

A box containing information on an arbitrarily shaped a region of interest.

Definition at line 50 of file WROIArbitrary.h.

Constructor & Destructor Documentation

WROIArbitrary::WROIArbitrary	(	size_t	nbCoordsX,
		size_t	nbCoordsY,
		size_t	nbCoordsZ,
		const WMatrix< double > &	mat,
		const std::vector< float > &	vals,
		boost::shared_ptr< WTriangleMesh >	triMesh,
		float	threshold,
		float	maxThreshold,
		WColor	color
	)

constructor

Parameters:

	nbCoordsX	number of vertices in X direction
	nbCoordsY	number of vertices in Y direction
	nbCoordsZ	number of vertices in Z direction
	mat	the matrix transforming the vertices from canonical space
	vals	the values at the vertices
	triMesh
	threshold
	maxThreshold	The maximum of the values.
	color	the color to use for the ROI.

Definition at line 40 of file WROIArbitrary.cpp.

References WGraphicsEngine::getGraphicsEngine(), m_nbCoordsVec, m_threshold, properties(), WROI::setDirty(), and updateGFX().

WROIArbitrary::WROIArbitrary	(	size_t	nbCoordsX,
		size_t	nbCoordsY,
		size_t	nbCoordsZ,
		const WMatrix< double > &	mat,
		const std::vector< float > &	vals,
		float	maxThreshold,
		WColor	color
	)

constructor

Parameters:

	nbCoordsX	number of vertices in X direction
	nbCoordsY	number of vertices in Y direction
	nbCoordsZ	number of vertices in Z direction
	mat	the matrix transforming the vertices from canonical space
	vals	the values at the vertices
	maxThreshold	The maximum of the values.
	color	the color to use for the ROI.

Definition at line 71 of file WROIArbitrary.cpp.

References WGraphicsEngine::getGraphicsEngine(), m_nbCoordsVec, m_threshold, properties(), WROI::setDirty(), and updateGFX().

WROIArbitrary::~WROIArbitrary ( ) [virtual]

destructor

Definition at line 99 of file WROIArbitrary.cpp.

Member Function Documentation

std::vector< size_t > WROIArbitrary::getCoordDimensions ( )

Get the number of vertices in the three coordinate directions.

Returns:: A vector containing the numbers of vertices

Definition at line 128 of file WROIArbitrary.cpp.

References m_nbCoordsVec.

std::vector< double > WROIArbitrary::getCoordOffsets ( )

Get the vertex offsets in the three coordinate directions.

Returns:: The offsets between point in each of the three coordinate directions

Definition at line 133 of file WROIArbitrary.cpp.

References m_matrix.

double WROIArbitrary::getThreshold ( )

getter

Returns:: The threshold on the data in box which leads to the arbitrary ROI

Definition at line 123 of file WROIArbitrary.cpp.

References m_threshold.

float WROIArbitrary::getValue ( size_t i )

Get the i-th value of the data defining the ROI.

Parameters:

i

the index of the value

Returns:: The value at the given index.

Definition at line 142 of file WROIArbitrary.cpp.

References m_vals.

void WROIArbitrary::properties ( )

initalizes the properties

Reimplemented from WROI.

Definition at line 107 of file WROIArbitrary.cpp.

References WROI::m_properties, m_threshold, and propertyChanged().

Referenced by WROIArbitrary().

void WROIArbitrary::propertyChanged ( )

callback when a property gets changed

Reimplemented from WROI.

Definition at line 112 of file WROIArbitrary.cpp.

References WROI::setDirty().

Referenced by properties().

void WROIArbitrary::setThreshold ( double threshold )

setter

Parameters:

threshold

Definition at line 117 of file WROIArbitrary.cpp.

References m_threshold, and WROI::setDirty().

void WROIArbitrary::updateGFX ( ) [virtual]

updates the graphics

Implements WROI.

Definition at line 147 of file WROIArbitrary.cpp.

References WMarchingLegoAlgorithm::generateSurface(), m_color, WROI::m_dirty, m_matrix, m_nbCoordsVec, m_threshold, m_triMesh, and m_vals.

Referenced by WROIArbitrary().

Member Data Documentation

WColor WROIArbitrary::m_color [private]

The ROI color.

Reimplemented from WROI.

Definition at line 160 of file WROIArbitrary.h.

Referenced by updateGFX().

WMatrix< double > WROIArbitrary::m_matrix [private]

The 4x4 transformation matrix for the vertices.

Definition at line 149 of file WROIArbitrary.h.

Referenced by getCoordOffsets(), and updateGFX().

std::vector< size_t > WROIArbitrary::m_nbCoordsVec [private]

The data's number of vertices in X, Y and Z direction.

Definition at line 147 of file WROIArbitrary.h.

Referenced by getCoordDimensions(), updateGFX(), and WROIArbitrary().

WPropDouble WROIArbitrary::m_threshold [private]

the threshold

Reimplemented from WROI.

Definition at line 155 of file WROIArbitrary.h.

Referenced by getThreshold(), properties(), setThreshold(), updateGFX(), and WROIArbitrary().

boost::shared_ptr< WTriangleMesh > WROIArbitrary::m_triMesh [private]

This triangle mesh is provided as output through the connector.

Definition at line 153 of file WROIArbitrary.h.

Referenced by updateGFX().

const std::vector< float > WROIArbitrary::m_vals [private]

The data at the vertices.

Definition at line 151 of file WROIArbitrary.h.

Referenced by getValue(), and updateGFX().

The documentation for this class was generated from the following files:

All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends