OpenWalnut  1.3.1
Public Member Functions | Static Public Member Functions | Static Protected Attributes | Private Member Functions | Private Attributes | List of all members
WDataSetRawHARDI Class Reference

This data set type contains raw HARDI and its gradients. More...

#include <WDataSetRawHARDI.h>

+ Inheritance diagram for WDataSetRawHARDI:

Public Member Functions

 WDataSetRawHARDI (boost::shared_ptr< WValueSetBase > newValueSet, boost::shared_ptr< WGrid > newGrid, boost::shared_ptr< std::vector< WVector3d > > newGradients, double diffusionBValue=1.0)
 Constructs an instance out of:
 WDataSetRawHARDI ()
 Construct an empty and unusable instance.
virtual ~WDataSetRawHARDI ()
 Destroys this DataSet instance.
virtual WDataSetSingle::SPtr clone (boost::shared_ptr< WValueSetBase > newValueSet) const
 Creates a copy (clone) of this instance but allows one to change the valueset.
virtual WDataSetSingle::SPtr clone (boost::shared_ptr< WGrid > newGrid) const
 Creates a copy (clone) of this instance but allows one to change the grid.
virtual WDataSetSingle::SPtr clone () const
 Creates a copy (clone) of this instance.
const WVector3dgetGradient (size_t index) const
 Returns the gradient for the index.
std::size_t getNumberOfMeasurements () const
 Returns the count of measurements per voxel, which is equal to the count of the used gradients.
virtual const std::string getName () const
 Gets the name of this prototype.
virtual const std::string getDescription () const
 Gets the description for this prototype.
std::vector< WVector3d > const & getOrientations () const
 Get the orientations.
std::vector< size_t > const & getZeroGradientIndexes () const
 Get the indexes of zero gradients.
std::vector< size_t > const & getNonZeroGradientIndexes () const
 Get the indexes of non-zero gradients.
template<typename T >
WValue< TgetNonZeroGradientSignals (size_t index) const
 Returns only the measurements for which the gradient was non-zero.
double getDiffusionBValue () const
 Returns the b-value of the diffusion.
- 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< WValueSetBasegetValueSet () const
boost::shared_ptr< WGridgetGrid () 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.
- 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.
OW_API_DEPRECATED void setFileName (const std::string filename)
 Set the name of the file that this data set stems from.
OW_API_DEPRECATED 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< WPropertiesgetProperties () const
 Return a pointer to the properties object of the dataset.
boost::shared_ptr< WPropertiesgetInformationProperties () 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 Public Member Functions

static boost::shared_ptr
< WPrototyped
getPrototype ()
 Returns a prototype instantiated with the true type of the deriving class.

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 boost::shared_ptr
< WPrototyped
m_prototype = boost::shared_ptr< WPrototyped >()
 The prototype as singleton.
- Static Protected Attributes inherited from WDataSet
static boost::shared_ptr
< WPrototyped
m_prototype = boost::shared_ptr< WPrototyped >()
 The prototype as singleton.

Private Member Functions

void buildGradientIndexes ()
 Build indexes for the zero and non-zero gradients.

Private Attributes

boost::shared_ptr< std::vector
< WVector3d > > 
m_gradients
 Gradients of measurements.
double m_diffusionBValue
 Strength (b-value) of the so-called magnetic diffusion gradient.
std::vector< size_t > m_zeroGradientIndexes
 The indexes for the which gradient is zero.
std::vector< size_t > m_nonZeroGradientIndexes
 The indexes for the which gradient is non-zero.

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.
- Protected Attributes inherited from WDataSetSingle
boost::shared_ptr< WGridm_grid
 Stores the reference of the WGrid of this DataSetSingle instance.
boost::shared_ptr< WValueSetBasem_valueSet
 Stores the reference of the WValueSet of this DataSetSingle instance.

Detailed Description

This data set type contains raw HARDI and its gradients.

Definition at line 39 of file WDataSetRawHARDI.h.

Constructor & Destructor Documentation

WDataSetRawHARDI::WDataSetRawHARDI ( boost::shared_ptr< WValueSetBase newValueSet,
boost::shared_ptr< WGrid newGrid,
boost::shared_ptr< std::vector< WVector3d > >  newGradients,
double  diffusionBValue = 1.0 
)

Constructs an instance out of:

  • an appropriate value set with a vector of measure values for each voxel,
  • a grid and
  • the gradients used during the measurement of the different values.
Parameters
newValueSetthe vector value set to use
newGridthe grid which maps world space to the value set
newGradientsthe Gradients of the
diffusionBValueStrength of the gradient

Definition at line 36 of file WDataSetRawHARDI.cpp.

References buildGradientIndexes().

WDataSetRawHARDI::WDataSetRawHARDI ( )

Construct an empty and unusable instance.

This is needed for the prototype mechanism.

Definition at line 67 of file WDataSetRawHARDI.cpp.

Referenced by clone(), and getPrototype().

WDataSetRawHARDI::~WDataSetRawHARDI ( )
virtual

Destroys this DataSet instance.

Definition at line 72 of file WDataSetRawHARDI.cpp.

Member Function Documentation

void WDataSetRawHARDI::buildGradientIndexes ( )
private

Build indexes for the zero and non-zero gradients.

Definition at line 50 of file WDataSetRawHARDI.cpp.

References m_gradients, m_nonZeroGradientIndexes, and m_zeroGradientIndexes.

Referenced by WDataSetRawHARDI().

WDataSetSingle::SPtr WDataSetRawHARDI::clone ( boost::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
newValueSetthe new valueset.
Returns
the clone

Reimplemented from WDataSetSingle.

Definition at line 76 of file WDataSetRawHARDI.cpp.

References getDiffusionBValue(), WDataSetSingle::getGrid(), m_gradients, and WDataSetRawHARDI().

WDataSetSingle::SPtr WDataSetRawHARDI::clone ( boost::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
newGridthe new grid.
Returns
the clone

Reimplemented from WDataSetSingle.

Definition at line 81 of file WDataSetRawHARDI.cpp.

References getDiffusionBValue(), WDataSetSingle::getValueSet(), m_gradients, and WDataSetRawHARDI().

WDataSetSingle::SPtr WDataSetRawHARDI::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 86 of file WDataSetRawHARDI.cpp.

References getDiffusionBValue(), WDataSetSingle::getGrid(), WDataSetSingle::getValueSet(), m_gradients, and WDataSetRawHARDI().

const std::string WDataSetRawHARDI::getDescription ( ) const
virtual

Gets the description for this prototype.

Returns
the description

Reimplemented from WDataSetSingle.

Definition at line 130 of file WDataSetRawHARDI.cpp.

double WDataSetRawHARDI::getDiffusionBValue ( ) const

Returns the b-value of the diffusion.

Returns
b-value as double

Definition at line 115 of file WDataSetRawHARDI.cpp.

References m_diffusionBValue.

Referenced by clone().

const WVector3d & WDataSetRawHARDI::getGradient ( size_t  index) const

Returns the gradient for the index.

Returns
gradient of measurement
Parameters
index

Definition at line 101 of file WDataSetRawHARDI.cpp.

References m_gradients.

const std::string WDataSetRawHARDI::getName ( ) const
virtual

Gets the name of this prototype.

Returns
the name.

Reimplemented from WDataSetSingle.

Definition at line 125 of file WDataSetRawHARDI.cpp.

std::vector< size_t > const & WDataSetRawHARDI::getNonZeroGradientIndexes ( ) const
inline

Get the indexes of non-zero gradients.

Returns
Returns the indexes for the which gradient is non-zero.

Definition at line 204 of file WDataSetRawHARDI.h.

References m_nonZeroGradientIndexes.

template<typename T >
WValue< T > WDataSetRawHARDI::getNonZeroGradientSignals ( size_t  index) const

Returns only the measurements for which the gradient was non-zero.

Parameters
indexthe index of the voxel.
Returns
non-zero gradient signals

Definition at line 209 of file WDataSetRawHARDI.h.

References m_nonZeroGradientIndexes, and WDataSetSingle::m_valueSet.

std::size_t WDataSetRawHARDI::getNumberOfMeasurements ( ) const

Returns the count of measurements per voxel, which is equal to the count of the used gradients.

Returns
measurements per voxel

Definition at line 120 of file WDataSetRawHARDI.cpp.

References m_gradients.

std::vector< WVector3d > const & WDataSetRawHARDI::getOrientations ( ) const

Get the orientations.

Returns
A vector of orientations.

Definition at line 110 of file WDataSetRawHARDI.cpp.

References m_gradients.

boost::shared_ptr< WPrototyped > WDataSetRawHARDI::getPrototype ( )
static

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

Returns
the prototype.

Reimplemented from WDataSetSingle.

Definition at line 91 of file WDataSetRawHARDI.cpp.

References m_prototype, and WDataSetRawHARDI().

std::vector< size_t > const & WDataSetRawHARDI::getZeroGradientIndexes ( ) const
inline

Get the indexes of zero gradients.

Returns
Returns the indexes for the which gradient is zero.

Definition at line 199 of file WDataSetRawHARDI.h.

References m_zeroGradientIndexes.

Member Data Documentation

double WDataSetRawHARDI::m_diffusionBValue
private

Strength (b-value) of the so-called magnetic diffusion gradient.

Definition at line 186 of file WDataSetRawHARDI.h.

Referenced by getDiffusionBValue().

boost::shared_ptr< std::vector< WVector3d > > WDataSetRawHARDI::m_gradients
private

Gradients of measurements.

Definition at line 182 of file WDataSetRawHARDI.h.

Referenced by buildGradientIndexes(), clone(), getGradient(), getNumberOfMeasurements(), and getOrientations().

std::vector< size_t > WDataSetRawHARDI::m_nonZeroGradientIndexes
private

The indexes for the which gradient is non-zero.

Definition at line 196 of file WDataSetRawHARDI.h.

Referenced by buildGradientIndexes(), getNonZeroGradientIndexes(), and getNonZeroGradientSignals().

boost::shared_ptr< WPrototyped > WDataSetRawHARDI::m_prototype = boost::shared_ptr< WPrototyped >()
staticprotected

The prototype as singleton.

Definition at line 174 of file WDataSetRawHARDI.h.

Referenced by getPrototype().

std::vector< size_t > WDataSetRawHARDI::m_zeroGradientIndexes
private

The indexes for the which gradient is zero.

Definition at line 191 of file WDataSetRawHARDI.h.

Referenced by buildGradientIndexes(), and getZeroGradientIndexes().


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