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

#include <WDataSetDTI.h>

Inheritance diagram for WDataSetDTI:

Collaboration diagram for WDataSetDTI:

Public Member Functions
	WDataSetDTI (std::shared_ptr< WValueSetBase > newValueSet, std::shared_ptr< WGrid > newGrid)
	Creates a new DTI dataset out of a value set and a grid. More...

	WDataSetDTI ()
	Constructs a new set of tracts. More...

	~WDataSetDTI ()
	Destructs this dataset. More...

virtual WDataSetSingle::SPtr	clone (std::shared_ptr< WValueSetBase > newValueSet, std::shared_ptr< WGrid > newGrid) const
	Creates a copy (clone) of this instance but allows one to change the valueset. More...

virtual WDataSetSingle::SPtr	clone (std::shared_ptr< WValueSetBase > newValueSet) const
	Creates a copy (clone) of this instance but allows one to change the valueset. More...

virtual WDataSetSingle::SPtr	clone (std::shared_ptr< WGrid > newGrid) const
	Creates a copy (clone) of this instance but allows one to change the grid. More...

virtual WDataSetSingle::SPtr	clone () const
	Creates a copy (clone) of this instance. More...

WTensorSym< 2, 3, float >	getTensor (size_t index) const
	Retrieves the i'th tensor. More...

virtual const std::string	getName () const
	Gets the name of this prototype. More...

virtual const std::string	getDescription () const
	Gets the description for this prototype. More...

Public Member Functions inherited from WDataSetSingle
	WDataSetSingle (std::shared_ptr< WValueSetBase > newValueSet, std::shared_ptr< WGrid > newGrid)
	Constructs an instance out of a value set and a grid. More...

	WDataSetSingle ()
	Construct an empty and unusable instance. More...

virtual	~WDataSetSingle ()
	Destroys this DataSet instance. More...

std::shared_ptr< WValueSetBase >	getValueSet () const

std::shared_ptr< WGrid >	getGrid () const

template<typename T >
OW_API_DEPRECATED T	getValueAt (size_t id)
	Get the scalar value stored at id-th position of the array of the value set. More...

double OW_API_DEPRECATED	getValueAt (size_t id) const
	Get the scalar value stored at id-th position of the array of the value set. More...

double	getSingleRawValue (size_t id) const
	Get the raw scalar value stored at id-th position of the raw array of the value set. More...

virtual bool	isTexture () const
	Determines whether this dataset can be used as a texture. More...

virtual osg::ref_ptr< WDataTexture3D >	getTexture () const
	Returns the texture representation of the dataset. More...

Public Member Functions inherited from WDataSet
	WDataSet ()
	This constructor should be used if a dataSet does not stem from a file. More...

virtual	~WDataSet ()
	Since WDataSet is a base class and thus should be polymorphic we add virtual destructor. More...

void	setFilename (const std::string filename)
	Set the name of the file that this data set stems from. More...

std::string	getFilename () const
	Get the name of the file that this data set stems from. More...

OW_API_DEPRECATED void	setFileName (const std::string filename)
	Set the name of the file that this data set stems from. More...

OW_API_DEPRECATED std::string	getFileName () const
	Get the name of the file that this data set stems from. More...

virtual std::shared_ptr< WDataSetVector >	isVectorDataSet ()
	Checks if this dataset is a vector dataset. More...

std::shared_ptr< WProperties >	getProperties () const
	Return a pointer to the properties object of the dataset. More...

std::shared_ptr< WProperties >	getInformationProperties () const
	Return a pointer to the information properties object of the dataset. More...

Public Member Functions inherited from WTransferable
	WTransferable ()
	Default constructor. More...

virtual	~WTransferable ()
	Destructor. More...

Public Member Functions inherited from WPrototyped
	WPrototyped ()
	Default constructor. More...

virtual	~WPrototyped ()
	Destructor. More...

template<typename T >
bool	isA ()
	Checks whether the actual prototype has the specified runtime type. More...

Static Public Member Functions
static std::shared_ptr< WPrototyped >	getPrototype ()
	Returns a prototype instantiated with the true type of the deriving class. More...

Static Public Member Functions inherited from WDataSetSingle
static std::shared_ptr< WPrototyped >	getPrototype ()
	Returns a prototype instantiated with the true type of the deriving class. More...

Static Public Member Functions inherited from WDataSet
static std::shared_ptr< WPrototyped >	getPrototype ()
	Returns a prototype instantiated with the true type of the deriving class. More...

Static Protected Attributes
static std::shared_ptr< WPrototyped >	m_prototype = std::shared_ptr< WPrototyped >()
	The prototype as singleton. More...

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

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

Additional Inherited Members
Public Types inherited from WDataSetSingle
typedef std::shared_ptr< WDataSetSingle >	SPtr
	Convenience typedef for a std::shared_ptr. More...

typedef std::shared_ptr< const WDataSetSingle >	ConstSPtr
	Convenience typedef for a std::shared_ptr; const. More...

Public Types inherited from WDataSet
typedef std::shared_ptr< WDataSet >	SPtr
	Shared pointer abbreviation to a instance of this class. More...

typedef std::shared_ptr< const WDataSet >	ConstSPtr
	Shared pointer abbreviation to a const instance of this class. More...

Protected Attributes inherited from WDataSetSingle
std::shared_ptr< WGrid >	m_grid
	Stores the reference of the WGrid of this DataSetSingle instance. More...

std::shared_ptr< WValueSetBase >	m_valueSet
	Stores the reference of the WValueSet of this DataSetSingle instance. More...

Protected Attributes inherited from WDataSet
std::shared_ptr< WProperties >	m_properties
	The property object for the dataset. More...

std::shared_ptr< WProperties >	m_infoProperties
	The property object for the dataset containing only props whose purpose is "PV_PURPOSE_INFORMNATION". More...

Detailed Description

Represents a Diffusion-Tensor-Image dataset.

Diffusion tensors are symmetric matrices.

Definition at line 39 of file WDataSetDTI.h.

Constructor & Destructor Documentation

◆ WDataSetDTI() [1/2]

WDataSetDTI::WDataSetDTI	(	std::shared_ptr< WValueSetBase >	newValueSet,
		std::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 39 of file WDataSetDTI.cpp.

◆ WDataSetDTI() [2/2]

WDataSetDTI::WDataSetDTI ( )

Constructs a new set of tracts.

The constructed instance is not usable but needed for prototype mechanism.

Definition at line 33 of file WDataSetDTI.cpp.

Referenced by clone(), and getPrototype().

Here is the caller graph for this function:

◆ ~WDataSetDTI()

WDataSetDTI::~WDataSetDTI ( )

Destructs this dataset.

Definition at line 49 of file WDataSetDTI.cpp.

Member Function Documentation

◆ clone() [1/4]

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 68 of file WDataSetDTI.cpp.

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

Here is the call graph for this function:

◆ clone() [2/4]

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

virtual

Creates a copy (clone) of this instance but allows one 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 63 of file WDataSetDTI.cpp.

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

Here is the call graph for this function:

◆ clone() [3/4]

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

virtual

Creates a copy (clone) of this instance but allows one 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 58 of file WDataSetDTI.cpp.

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

Here is the call graph for this function:

◆ clone() [4/4]

WDataSetSingle::SPtr WDataSetDTI::clone	(	std::shared_ptr< WValueSetBase >	newValueSet,
		std::shared_ptr< WGrid >	newGrid
	)		const

virtual

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

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

Parameters

newValueSet	the new valueset.
newGrid	the new grid.

Returns: the clone

Reimplemented from WDataSetSingle.

Definition at line 53 of file WDataSetDTI.cpp.

References WDataSetDTI().

Here is the call graph for this function:

◆ getDescription()

const std::string WDataSetDTI::getDescription ( ) const

virtual

Gets the description for this prototype.

Returns: the description

Reimplemented from WDataSetSingle.

Definition at line 85 of file WDataSetDTI.cpp.

◆ getName()

const std::string WDataSetDTI::getName ( ) const

virtual

Gets the name of this prototype.

Returns: the name.

Reimplemented from WDataSetSingle.

Definition at line 80 of file WDataSetDTI.cpp.

◆ getPrototype()

std::shared_ptr< WPrototyped > WDataSetDTI::getPrototype ( )

static

Returns a prototype instantiated with the true type of the deriving class.

Returns: the prototype.

Definition at line 91 of file WDataSetDTI.cpp.

References m_prototype, and WDataSetDTI().

Here is the call graph for this function:

◆ getTensor()

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 73 of file WDataSetDTI.cpp.

References WDataSetSingle::m_valueSet.

Member Data Documentation

◆ m_prototype

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

staticprotected

The prototype as singleton.

Definition at line 135 of file WDataSetDTI.h.

Referenced by getPrototype().

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

Public Member Functions

Static Public Member Functions

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ WDataSetDTI() [1/2]

◆ WDataSetDTI() [2/2]

◆ ~WDataSetDTI()

Member Function Documentation

◆ clone() [1/4]

◆ clone() [2/4]

◆ clone() [3/4]

◆ clone() [4/4]

◆ getDescription()

◆ getName()

◆ getPrototype()

◆ getTensor()

Member Data Documentation

◆ m_prototype