OpenWalnut  1.5.0dev
Public Member Functions | Protected Member Functions | List of all members
WDataSetDTIToScalar_I Class Referenceabstract

Interface to compute various measures on tensors. More...

#include <WDataSetDTIToScalar_I.h>

+ Inheritance diagram for WDataSetDTIToScalar_I:

Public Member Functions

virtual WDataSetScalar::SPtr operator() (WProgress::SPtr progress, WBoolFlag const &shutdown, WDataSetDTI::SPtr tensors, WDataSetVector::SPtr evals)
 This runs the given strategy on the given dataset. More...
 
virtual ~WDataSetDTIToScalar_I ()
 Destructor. More...
 

Protected Member Functions

virtual double tensorToScalar (const WVector3d &evals, const WTensorSym< 2, 3, float > &tensor)=0
 Actual scalar computation. More...
 

Detailed Description

Interface to compute various measures on tensors.

Prominent examples are the Fractional Anisotropy (FA), trace, Relative Anisotropy, Mean Diffusivity, Radial Diffusivity, etc. As many scalar measures may use either the tensor components directly or rely on derived measures such as eigenvalues, both are needed for generating the scalar.

Definition at line 42 of file WDataSetDTIToScalar_I.h.

Constructor & Destructor Documentation

◆ ~WDataSetDTIToScalar_I()

WDataSetDTIToScalar_I::~WDataSetDTIToScalar_I ( )
virtual

Destructor.

Definition at line 36 of file WDataSetDTIToScalar_I.cpp.

Member Function Documentation

◆ operator()()

WDataSetScalar::SPtr WDataSetDTIToScalar_I::operator() ( WProgress::SPtr  progress,
WBoolFlag const &  shutdown,
WDataSetDTI::SPtr  tensors,
WDataSetVector::SPtr  evals 
)
virtual

This runs the given strategy on the given dataset.

Parameters
progressthe progress instance you should increment each time you fill the value for one voxel.
shutdownPossibility to abort in case of shutdown.
tensorsThe tensor components
evalsThe Eigenvalues
Returns
The scalar dataset, for which each tensor a scalar value is derived according to the subclass implementation.

Definition at line 40 of file WDataSetDTIToScalar_I.cpp.

References wlog::debug(), and tensorToScalar().

+ Here is the call graph for this function:

◆ tensorToScalar()

virtual double WDataSetDTIToScalar_I::tensorToScalar ( const WVector3d evals,
const WTensorSym< 2, 3, float > &  tensor 
)
protectedpure virtual

Actual scalar computation.

Parameters
evalsEigenvalues
tensorTensor components
Returns
Scalar value derived either from tensor components, eigenvalues or both.

Implemented in WTensorTrace, WRD, WRA, WMD, WFA, and WAD.

Referenced by operator()().

+ Here is the caller graph for this function:

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