Represents a Diffusion-Tensor-Image dataset. More...

#include <WDataSetDTI.h>

Inheritance diagram for WDataSetDTI:

Public Member Functions
	WDataSetDTI (boost::shared_ptr< WValueSetBase > newValueSet, boost::shared_ptr< WGrid > newGrid)
	Creates a new DTI dataset out of a value set and a grid.
	~WDataSetDTI ()
	Destructs this dataset.
virtual WDataSetSingle::SPtr	clone (boost::shared_ptr< WValueSetBase > newValueSet) const
	Creates a copy (clone) of this instance but allows to change the valueset.
virtual WDataSetSingle::SPtr	clone (boost::shared_ptr< WGrid > newGrid) const
	Creates a copy (clone) of this instance but allows to change the grid.
virtual WDataSetSingle::SPtr	clone () const
	Creates a copy (clone) of this instance.
WTensorSym< 2, 3, float >	getTensor (size_t index) const
	Retrieves the i'th tensor.
Public Member Functions inherited from WDataSetSingle
	WDataSetSingle (boost::shared_ptr< WValueSetBase > newValueSet, boost::shared_ptr< WGrid > newGrid)
	Constructs an instance out of a value set and a grid.
	WDataSetSingle ()
	Construct an empty and unusable instance.
virtual	~WDataSetSingle ()
	Destroys this DataSet instance.
boost::shared_ptr< WValueSetBase >	getValueSet () const
boost::shared_ptr< WGrid >	getGrid () const
template<typename T >
T	getValueAt (size_t id)
	Get the value stored at position of the value set.
double	getValueAt (size_t id) const
	Get the value stored at position of the value set.
virtual bool	isTexture () const
	Determines whether this dataset can be used as a texture.
virtual osg::ref_ptr < WDataTexture3D >	getTexture () const
	Returns the texture representation of the dataset.
virtual const std::string	getName () const
	Gets the name of this prototype.
virtual const std::string	getDescription () const
	Gets the description for this prototype.
Public Member Functions inherited from WDataSet
	WDataSet ()
	This constructor should be used if a dataSet does not stem from a file.
virtual	~WDataSet ()
	Since WDataSet is a base class and thus should be polymorphic we add virtual destructor.
void	setFileName (const std::string fileName)
	Set the name of the file that this data set stems from.
std::string	getFileName () const
	Get the name of the file that this data set stems from.
virtual boost::shared_ptr < WDataSetVector >	isVectorDataSet ()
	Checks if this dataset is a vector dataset.
boost::shared_ptr< WProperties >	getProperties () const
	Return a pointer to the properties object of the dataset.
boost::shared_ptr< WProperties >	getInformationProperties () const
	Return a pointer to the information properties object of the dataset.
Public Member Functions inherited from WTransferable
	WTransferable ()
	Default constructor.
virtual	~WTransferable ()
	Destructor.
Public Member Functions inherited from WPrototyped
	WPrototyped ()
	Default constructor.
virtual	~WPrototyped ()
	Destructor.
template<typename T >
bool	isA ()
	Checks whether the actual prototype has the specified runtime type.

Static Protected Attributes
static boost::shared_ptr < WPrototyped >	m_prototype = boost::shared_ptr< WPrototyped >()
	The prototype as singleton.
Static Protected Attributes inherited from WDataSetSingle
Static Protected Attributes inherited from WDataSet

Additional Inherited Members
Public Types inherited from WDataSetSingle
typedef boost::shared_ptr < WDataSetSingle >	SPtr
	Convenience typedef for a boost::shared_ptr.
typedef boost::shared_ptr < const WDataSetSingle >	ConstSPtr
	Convenience typedef for a boost::shared_ptr; const.
Static Public Member Functions inherited from WDataSetSingle
static boost::shared_ptr < WPrototyped >	getPrototype ()
	Returns a prototype instantiated with the true type of the deriving class.
Protected Attributes inherited from WDataSetSingle
boost::shared_ptr< WGrid >	m_grid
	Stores the reference of the WGrid of this DataSetSingle instance.
boost::shared_ptr< WValueSetBase >	m_valueSet
	Stores the reference of the WValueSet of this DataSetSingle instance.
Protected Attributes inherited from WDataSet
boost::shared_ptr< WProperties >	m_properties
	The property object for the dataset.
boost::shared_ptr< WProperties >	m_infoProperties
	The property object for the dataset containing only props whose purpose is "PV_PURPOSE_INFORMNATION".

Detailed Description

Represents a Diffusion-Tensor-Image dataset.

Diffusion tensors are symmetric matrices.

Definition at line 37 of file WDataSetDTI.h.

Constructor & Destructor Documentation

WDataSetDTI::WDataSetDTI	(	boost::shared_ptr< WValueSetBase >	newValueSet,
		boost::shared_ptr< WGrid >	newGrid
	)

Creates a new DTI dataset out of a value set and a grid.

Parameters:

newValueSet	Valueset having vectors of dimension 6.
newGrid

Definition at line 31 of file WDataSetDTI.cpp.

Referenced by clone().

WDataSetDTI::~WDataSetDTI ( )

Destructs this dataset.

Definition at line 41 of file WDataSetDTI.cpp.

Member Function Documentation

WDataSetSingle::SPtr WDataSetDTI::clone ( boost::shared_ptr< WValueSetBase > newValueSet ) const

virtual

Creates a copy (clone) of this instance but allows to change the valueset.

Unlike copy construction, this is a very useful function if you want to keep the dynamic type of your dataset even if you just have a WDataSetSingle.

Parameters:

newValueSet the new valueset.

Returns:: the clone

Reimplemented from WDataSetSingle.

Definition at line 45 of file WDataSetDTI.cpp.

References WDataSetSingle::getGrid(), and WDataSetDTI().

WDataSetSingle::SPtr WDataSetDTI::clone ( boost::shared_ptr< WGrid > newGrid ) const

virtual

Creates a copy (clone) of this instance but allows to change the grid.

Unlike copy construction, this is a very useful function if you want to keep the dynamic type of your dataset even if you just have a WDataSetSingle.

Parameters:

newGrid the new grid.

Returns:: the clone

Reimplemented from WDataSetSingle.

Definition at line 50 of file WDataSetDTI.cpp.

References WDataSetSingle::getValueSet(), and WDataSetDTI().

WDataSetSingle::SPtr WDataSetDTI::clone ( ) const

virtual

Creates a copy (clone) of this instance.

Unlike copy construction, this is a very useful function if you want to keep the dynamic type of your dataset even if you just have a WDataSetSingle.

Returns:: the clone

Reimplemented from WDataSetSingle.

Definition at line 55 of file WDataSetDTI.cpp.

References WDataSetSingle::getGrid(), WDataSetSingle::getValueSet(), and WDataSetDTI().

WTensorSym< 2, 3, float > WDataSetDTI::getTensor ( size_t index ) const

Retrieves the i'th tensor.

Warning:: Here is dynamical allocation used inside, this may be a problem when used with multithreading.

Parameters:

index The position of the tensor to retrieve

Returns:: The new constructed symmetrical matrix as tensor.

Definition at line 60 of file WDataSetDTI.cpp.

References WDataSetSingle::m_valueSet.

Referenced by WDataSetDTITest::testTensorAccess().

Member Data Documentation

boost::shared_ptr< WPrototyped > WDataSetDTI::m_prototype = boost::shared_ptr< WPrototyped >()

staticprotected

The prototype as singleton.

Reimplemented from WDataSetSingle.

Definition at line 96 of file WDataSetDTI.h.

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

Public Member Functions

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation