Computes the MD (Mean Diffusivity) of a given Tensor. More...

#include <WMD.h>

Inheritance diagram for WMD:

Collaboration diagram for WMD:

Public Member Functions
	WMD ()
	Creates an object to perform the computation. More...

Public Member Functions inherited from WObjectNDIP< WDataSetDTIToScalar_I >
virtual	~WObjectNDIP ()
	Destructor. More...

virtual std::string	getName () const
	The name of the object. More...

virtual std::string	getDescription () const
	The description of this object. More...

virtual const char **	getIcon () const
	The icon of this object. More...

virtual WProperties::SPtr	getProperties ()
	Return the property group of this object. More...

Public Member Functions inherited from WDataSetDTIToScalar_I
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)
	Actual MD computation takes place inhere. More...

Protected Member Functions inherited from WObjectNDIP< WDataSetDTIToScalar_I >
	WObjectNDIP (std::string name, std::string description, const char **icon=NULL)
	Construct a NDIP'ed object. More...

Additional Inherited Members
Public Types inherited from WObjectNDIP< WDataSetDTIToScalar_I >
typedef std::shared_ptr< WObjectNDIP >	SPtr
	Shared ptr to an instance. More...

typedef std::shared_ptr< const WObjectNDIP >	ConstSPtr
	Shared ptr to a const instance. More...

Protected Attributes inherited from WObjectNDIP< WDataSetDTIToScalar_I >
WProperties::SPtr	m_properties
	the properties of the object. More...

Detailed Description

Computes the MD (Mean Diffusivity) of a given Tensor.

$MD = \frac{1}{3}\sum_{i=1}^{3} \lambda_i$

Definition at line 40 of file WMD.h.

Constructor & Destructor Documentation

WMD::WMD ( )

Creates an object to perform the computation.

Definition at line 28 of file WMD.cpp.

protectedvirtual

Actual MD computation takes place inhere.

Parameters

evals	With the three given Eigenvalues, we may compute the MD. See the wikipedia article above for the formula.
tensor	Although not needed for MD computation, the API requires us to use the signature.

Definition at line 33 of file WMD.cpp.

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