Computes the eigensystem of a second order tensor field. More...

#include <WMEigenSystem.h>

Inheritance diagram for WMEigenSystem:

Collaboration diagram for WMEigenSystem:

Public Member Functions
	WMEigenSystem ()
	Constructs a new module for eigensystem computation. More...

virtual	~WMEigenSystem ()
	Destructs this module. More...

virtual const std::string	getName () const
	Gives back the name of this module. More...

virtual const std::string	getDescription () const
	Gives back a description of this module. More...

virtual std::shared_ptr< WModule >	factory () const
	Due to the prototype design pattern used to build modules, this method returns a new instance of this method. More...

virtual const char **	getXPMIcon () const
	Get the icon for this module in XPM format. More...

Public Member Functions inherited from WModule
	WModule ()
	Constructs a new WModule instance. More...

virtual	~WModule ()
	Destructor. More...

const InputConnectorList &	getInputConnectors () const
	Gives back input connectors. More...

std::shared_ptr< WModuleInputConnector >	getInputConnector (std::string name)
	Finds the named connector for the module. More...

std::shared_ptr< WModuleInputConnector >	findInputConnector (std::string name)
	Finds the named connector for the module. More...

const OutputConnectorList &	getOutputConnectors () const
	Gives back output connectors. More...

std::shared_ptr< WModuleOutputConnector >	getOutputConnector (std::string name)
	Finds the named connector for the module. More...

std::shared_ptr< WModuleOutputConnector >	findOutputConnector (std::string name)
	Finds the named connector for the module. More...

std::shared_ptr< WModuleConnector >	getConnector (std::string name)
	Finds the named connector for the module. More...

std::shared_ptr< WModuleConnector >	findConnector (std::string name)
	Finds the named connector for the module. More...

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

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

const WBoolFlag &	isInitialized () const
	Determines whether the module instance is properly initialized. More...

const WBoolFlag &	isUseable () const
	Checks whether the module instance is ready to be used. More...

const WBoolFlag &	isAssociated () const
	Checks whether this module is associated with an container. More...

const WBoolFlag &	isReady () const
	Checks whether this module is ready. More...

const WBoolFlag &	isReadyOrCrashed () const
	This is the logical or of isReady and isCrashed. More...

const WBoolFlag &	isRunning () const
	Returns a flag denoting whether the thread currently is running or nor. More...

void	waitRestored ()
	This method waits for the module to be restored completely. More...

bool	isRestoreNeeded () const
	Check whether this module is in restore mode. More...

void	setRestoreNeeded (bool restore=true)
	Change the restore mode. More...

void	reportRestoreComplete ()
	Called by loaders to tell the module that loading has been completed. More...

std::shared_ptr< WModuleContainer >	getAssociatedContainer () const
	The container this module is associated with. More...

virtual boost::signals2::connection	subscribeSignal (MODULE_SIGNAL signal, t_ModuleGenericSignalHandlerType notifier)
	Connects a specified notify function with a signal this module instance is offering. More...

virtual boost::signals2::connection	subscribeSignal (MODULE_SIGNAL signal, t_ModuleErrorSignalHandlerType notifier)
	Connects a specified notify function with a signal this module instance is offering. More...

virtual std::shared_ptr< WProgressCombiner >	getRootProgressCombiner ()
	Gets the modules base progress. More...

virtual MODULE_TYPE	getType () const
	Gets the type of the module. More...

void	disconnect ()
	Completely disconnects all connected connectors of this module. More...

WCombinerTypes::WDisconnectList	getPossibleDisconnections ()
	Gives a list of all WDisconnectCombiners possible. More...

boost::filesystem::path	getLocalPath () const
	Returns the local path of the module. More...

boost::filesystem::path	getLibPath () const
	Returns the absolute path to the library containing this module. More...

std::string	getPackageName () const
	Returns the name of the package the module belongs to, The package name basically is the name of the library containing this and maybe other modules. More...

bool	isDeprecated () const
	Checks whether the module was marked as deprecated. More...

std::string	getDeprecationMessage () const
	Queries the deprecation message of a module if specified. More...

virtual WModuleMetaInformation::ConstSPtr	getMetaInformation () const
	The meta information of this module. More...

const std::string &	getUUID () const
	Get the UUID of the module instance. More...

WPropString	getRuntimeName () const
	Returns the name the user has given this module. More...

const WRequirement *	checkRequirements () const
	This method checks whether all the requirements of the module are complied. More...

virtual boost::signals2::connection	subscribeSignal (THREAD_SIGNAL signal, t_ThreadErrorSignalHandlerType notifier)
	Connects a specified notify function with a signal this thread instance is offering. More...

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

virtual	~WThreadedRunner ()
	Destructor. More...

virtual void	run ()
	Run thread. More...

void	run (THREADFUNCTION f)
	Run thread. More...

void	wait (bool requestFinish=false)
	Wait for the thread to be finished. More...

virtual void	requestStop ()
	This method's purpose is to request a stop without waiting for it. More...

virtual boost::signals2::connection	subscribeSignal (THREAD_SIGNAL signal, t_ThreadErrorSignalHandlerType notifier)
	Connects a specified notify function with a signal this thread instance is offering. More...

const WBoolFlag &	isCrashed () const
	Checks whether this thread has been crashed. More...

const std::string &	getCrashMessage () const
	Get the message of the exception finally causing the crash. More...

void	setThreadName (std::string name)
	Set the name of the thread. More...

std::string	getThreadName () const
	Returns the current thread name. 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...

Protected Member Functions
virtual void	moduleMain ()
	Entry point after loading the module. More...

virtual void	connectors ()
	Initialize the connectors this module is using. More...

virtual void	properties ()
	Initialize the properties for this module. More...

virtual void	requirements ()
	Initialize requirements for this module. More...

Protected Member Functions inherited from WModule
void	threadMain ()
	Thread entry point. More...

virtual void	onThreadException (const WException &e)
	This method is called if an exception was caught, which came from the custom thread code. More...

void	setAssociatedContainer (std::shared_ptr< WModuleContainer > container)
	Sets the container this module is associated with. More...

virtual std::string	deprecated () const
	This function allows module programmers to mark their modules deprecated in a user-friendly way. More...

void	initialize ()
	Manages initialization. More...

virtual void	cleanup ()
	Called whenever the module should shutdown. More...

void	addConnector (std::shared_ptr< WModuleInputConnector > con)
	Adds the specified connector to the list of inputs. More...

void	addConnector (std::shared_ptr< WModuleOutputConnector > con)
	Adds the specified connector to the list of outputs. More...

void	removeConnectors ()
	Removes all connectors properly. More...

virtual void	activate ()
	Callback for m_active. More...

virtual const t_GenericSignalHandlerType	getSignalHandler (MODULE_CONNECTOR_SIGNAL signal)
	Gives the signal handler function responsible for a given signal. More...

virtual void	notifyConnectionEstablished (std::shared_ptr< WModuleConnector > here, std::shared_ptr< WModuleConnector > there)
	Gets called whenever a connector gets connected to the specified input. More...

virtual void	notifyConnectionClosed (std::shared_ptr< WModuleConnector > here, std::shared_ptr< WModuleConnector > there)
	Gets called whenever a connection between a remote and local connector gets closed. More...

virtual void	notifyDataChange (std::shared_ptr< WModuleConnector > input, std::shared_ptr< WModuleConnector > output)
	Gets called when the data on one input connector changed. More...

void	ready ()
	Call this whenever your module is ready and can react on property changes. More...

wlog::WStreamedLogger	infoLog () const
	Logger instance for comfortable info logging. More...

wlog::WStreamedLogger	debugLog () const
	Logger instance for comfortable debug logging. More...

wlog::WStreamedLogger	warnLog () const
	Logger instance for comfortable warning- logs. More...

wlog::WStreamedLogger	errorLog () const
	Logger instance for comfortable error logging. More...

void	setLocalPath (boost::filesystem::path path)
	Sets the local module path. More...

void	setLibPath (boost::filesystem::path path)
	Set the path to the library which contains this module. More...

void	setPackageName (std::string name)
	Set the package name. More...

Protected Member Functions inherited from WThreadedRunner
virtual void	notifyStop ()
	Gets called when the thread should be stopped. More...

void	yield () const
	Give remaining execution timeslice to another thread. More...

void	sleep (const int32_t t) const
	Sets thread asleep. More...

void	msleep (const int32_t t) const
	Sets thread asleep. More...

void	waitForStop ()
	Let the thread sleep until a stop request was given. More...

void	handleDeadlyException (const WException &e, std::string sender="WThreadedRunner")
	Handle the specified exception which was not caught in the thread, which basically means the thread has crashed. More...

Private Types
typedef WThreadedPerVoxelOperation< float, 6, double, 12 >	TPVOFloat
	the threaded per-voxel function for the eigenvector computation (float input) More...

typedef WThreadedPerVoxelOperation< double, 6, double, 12 >	TPVODouble
	the threaded per-voxel function for the eigenvector computation (double input) More...

typedef WThreadedFunction< TPVOFloat >	EigenFunctionTypeFloat
	the thread pool type for the eigencomputation (float input) More...

typedef WThreadedFunction< TPVODouble >	EigenFunctionTypeDouble
	the thread pool type for the eigencomputation (double input) More...

typedef WValueSet< double >	FloatValueSetType
	the valueset type More...

typedef wtracking::WThreadedTrackingFunction	Tracking
	the threaded tracking functor More...

typedef WThreadedFunction< Tracking >	TrackingFuncType
	the tracking threadpool More...

typedef std::shared_ptr< WModuleOutputData< WDataSetVector > >	EigenOutputConnector
	Shortcut for the vector field output connectors. More...

Private Member Functions
void	resetProgress (std::size_t todo, std::string name)
	Resets the current progress to 0. More...

void	resetEigenFunction (std::shared_ptr< WDataSetDTI > tensors)
	Resets the threaded function/threadpool. More...

void	updateOCs (std::shared_ptr< const WDataSetSingle > es)
	Update the output connectors out of the computed eigensystem field. More...

TPVOFloat::OutTransmitType const	eigenFuncFloat (TPVOFloat::TransmitType const &input)
	The function that computes the eigenvectors from the input tensor field. More...

TPVODouble::OutTransmitType const	eigenFuncDouble (TPVODouble::TransmitType const &input)
	The function that computes the eigenvectors from the input tensor field. More...

TPVODouble::OutTransmitType const	eigenSolverDouble (TPVODouble::TransmitType const &input)
	Computes the eigen system for double input parameters via using applyEigenSolver. More...

TPVOFloat::OutTransmitType const	eigenSolverFloat (TPVOFloat::TransmitType const &input)
	Computes the eigen system for double input parameters via using applyEigenSolver. More...

boost::array< double, 12 >	applyEigenSolver (const Eigen::Matrix3d &m) const
	Copies the eigenvalues and eigenvectors from the libEigen output format into the double array. More...

boost::array< double, 12 >	computeEigenSystem (WTensorSym< 2, 3, double > const &m) const
	Is used by every thread to compute the eigensystem for the given tensor. More...

Private Attributes
std::shared_ptr< WModuleInputData< WDataSetDTI > >	m_tensorIC
	Input tensor field. More...

std::vector< EigenOutputConnector >	m_evecOutputs
	Ouput vector field for principal eigenvectors as well as one for all eigenvalues at once. More...

std::vector< std::shared_ptr< WModuleOutputData< WDataSetScalar > > >	m_evalOutputs
	Output scalar field , each for an eigenvalue field. More...

std::shared_ptr< WThreadedFunctionBase >	m_eigenPool
	The threadpool for the eigenvector computation. More...

std::shared_ptr< TPVOFloat >	m_eigenOperationFloat
	the functor used for the calculation of the eigenvectors More...

std::shared_ptr< TPVODouble >	m_eigenOperationDouble
	the functor used for the calculation of the eigenvectors More...

std::shared_ptr< WProgress >	m_currentProgress
	Indicating current work progress. More...

WPropSelection	m_strategySelector
	List for selecting the strategy. More...

Additional Inherited Members
Public Types inherited from WModule
typedef std::vector< std::shared_ptr< WModuleInputConnector > >	InputConnectorList
	The type for the list of input connectors. More...

typedef std::vector< std::shared_ptr< WModuleOutputConnector > >	OutputConnectorList
	The type for the list of output connectors. More...

typedef std::shared_ptr< WModule >	SPtr
	Shared pointer to a WModule. More...

typedef std::shared_ptr< const WModule >	ConstSPtr
	Shared pointer to a const WModule. More...

Public Types inherited from WThreadedRunner
typedef std::shared_ptr< WThreadedRunner >	SPtr
	Abbreviation to a shared_ptr to this type. More...

typedef std::shared_ptr< const WThreadedRunner >	ConstSPtr
	Abbreviation to a const shared_ptr to this type. More...

typedef boost::function< void(void) >	THREADFUNCTION
	Type used for simple thread functions. More...

Static Public Member Functions inherited from WModule
static SPtr	findByUUID (std::string uuid)
	Find a module instance by UUID. More...

Static Public Member Functions inherited from WThreadedRunner
static void	setThisThreadName (std::string name)
	Static function to set the name of the calling thread. More...

Protected Types inherited from WModule
typedef std::vector< WRequirement * >	Requirements
	The type of the requirement list. More...

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

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

std::shared_ptr< WProgressCombiner >	m_progress
	Progress indicator used as parent for all progress' of this module. More...

WBoolFlag	m_initialized
	True if everything is initialized and ready to be used. More...

WBoolFlag	m_isAssociated
	True if container got associated with this flag. More...

WBoolFlag	m_isUsable
	True if associated && initialized. More...

WBoolFlag	m_isReady
	True if ready() was called. More...

WBoolFlag	m_isReadyOrCrashed
	It is true whenever m_isReady or WThreadedRunner::m_isCrashed is true. More...

WBoolFlag	m_isRunning
	True if the module currently is running. More...

WBoolFlag	m_isLoadFinished
	Flag to denote whether the module container and the project loader have finished their work. More...

bool	m_restoreMode
	Flag denoting the current restore mode. More...

std::shared_ptr< WProgress >	m_readyProgress
	Progress indicator for the "ready" state. More...

WConditionSet	m_moduleState
	The internal state of the module. More...

std::shared_ptr< WModuleContainer >	m_container
	The container this module belongs to. More...

InputConnectorList	m_inputConnectors
	Set of input connectors associated with this module. More...

OutputConnectorList	m_outputConnectors
	Set of output connectors associated with this module. More...

WPropBool	m_active
	True whenever the module should be active. More...

WPropString	m_runtimeName
	This property holds a user specified name for the current module instance. More...

boost::filesystem::path	m_localPath
	The path where the module binary resides in. More...

boost::filesystem::path	m_libPath
	The absolute path to the library containing this module. More...

std::string	m_packageName
	The name of the lib/the package containing this module. More...

Requirements	m_requirements
	The list of requirements. More...

Protected Attributes inherited from WThreadedRunner
boost::thread	m_thread
	Thread instance. More...

WBoolFlag	m_shutdownFlag
	Condition getting fired whenever the thread should quit. More...

WBoolFlag	m_isCrashed
	True whenever an exception is thrown during threadMain. More...

std::string	m_crashMessage
	The crash message. More...

Detailed Description

Computes the eigensystem of a second order tensor field.

For each eigen vector and eigen value an output connector field is available. If you need all you may connect to a special output carrying all eigenvalues.

Definition at line 54 of file WMEigenSystem.h.

Member Typedef Documentation

◆ EigenFunctionTypeDouble

typedef WThreadedFunction< TPVODouble > WMEigenSystem::EigenFunctionTypeDouble

private

the thread pool type for the eigencomputation (double input)

Definition at line 125 of file WMEigenSystem.h.

◆ EigenFunctionTypeFloat

typedef WThreadedFunction< TPVOFloat > WMEigenSystem::EigenFunctionTypeFloat

private

the thread pool type for the eigencomputation (float input)

Definition at line 122 of file WMEigenSystem.h.

◆ EigenOutputConnector

typedef std::shared_ptr< WModuleOutputData< WDataSetVector > > WMEigenSystem::EigenOutputConnector

private

Shortcut for the vector field output connectors.

Definition at line 218 of file WMEigenSystem.h.

◆ FloatValueSetType

typedef WValueSet< double > WMEigenSystem::FloatValueSetType

private

the valueset type

Definition at line 128 of file WMEigenSystem.h.

◆ TPVODouble

typedef WThreadedPerVoxelOperation< double, 6, double, 12 > WMEigenSystem::TPVODouble

private

the threaded per-voxel function for the eigenvector computation (double input)

Definition at line 119 of file WMEigenSystem.h.

◆ TPVOFloat

typedef WThreadedPerVoxelOperation< float, 6, double, 12 > WMEigenSystem::TPVOFloat

private

the threaded per-voxel function for the eigenvector computation (float input)

Definition at line 116 of file WMEigenSystem.h.

◆ Tracking

typedef wtracking::WThreadedTrackingFunction WMEigenSystem::Tracking

private

the threaded tracking functor

Definition at line 131 of file WMEigenSystem.h.

◆ TrackingFuncType

typedef WThreadedFunction< Tracking > WMEigenSystem::TrackingFuncType

private

the tracking threadpool

Definition at line 134 of file WMEigenSystem.h.

Constructor & Destructor Documentation

◆ WMEigenSystem()

WMEigenSystem::WMEigenSystem ( )

Constructs a new module for eigensystem computation.

Definition at line 40 of file WMEigenSystem.cpp.

Referenced by factory().

Here is the caller graph for this function:

◆ ~WMEigenSystem()

WMEigenSystem::~WMEigenSystem ( )

virtual

Destructs this module.

Definition at line 45 of file WMEigenSystem.cpp.

Member Function Documentation

◆ applyEigenSolver()

boost::array< double, 12 > WMEigenSystem::applyEigenSolver ( const Eigen::Matrix3d & m ) const

private

Copies the eigenvalues and eigenvectors from the libEigen output format into the double array.

Parameters

m	The symmetric input matrix where only the lower triangular part is considered.

Returns: The 12 components of the eigen system.

Definition at line 285 of file WMEigenSystem.cpp.

Referenced by eigenSolverDouble(), and eigenSolverFloat().

Here is the caller graph for this function:

◆ computeEigenSystem()

boost::array< double, 12 > WMEigenSystem::computeEigenSystem ( WTensorSym< 2, 3, double > const & m ) const

private

Is used by every thread to compute the eigensystem for the given tensor.

Parameters

m	Tensor to compute the eigensystem for

Returns: Eigen system of the given tensor.

Definition at line 219 of file WMEigenSystem.cpp.

Referenced by eigenFuncDouble(), and eigenFuncFloat().

Here is the caller graph for this function:

◆ connectors()

void WMEigenSystem::connectors ( )

protectedvirtual

Initialize the connectors this module is using.

Reimplemented from WModule.

Definition at line 73 of file WMEigenSystem.cpp.

References WModule::connectors(), WModuleInputData< T >::createAndAdd(), m_evalOutputs, m_evecOutputs, and m_tensorIC.

Here is the call graph for this function:

◆ eigenFuncDouble()

WMEigenSystem::TPVODouble::OutTransmitType const WMEigenSystem::eigenFuncDouble ( TPVODouble::TransmitType const & input )

private

The function that computes the eigenvectors from the input tensor field.

Parameters

input A subarray of a valueset that consists of the 6 floats that make up the tensor.

Returns: The complete eigen system as double array with 12 components.

Definition at line 250 of file WMEigenSystem.cpp.

References computeEigenSystem(), and m_currentProgress.

Here is the call graph for this function:

◆ eigenFuncFloat()

WMEigenSystem::TPVOFloat::OutTransmitType const WMEigenSystem::eigenFuncFloat ( TPVOFloat::TransmitType const & input )

private

The function that computes the eigenvectors from the input tensor field.

Parameters

input A subarray of a valueset that consists of the 6 floats that make up the tensor.

Returns: The complete eigen system as double array with 12 components.

Definition at line 235 of file WMEigenSystem.cpp.

References computeEigenSystem(), and m_currentProgress.

Here is the call graph for this function:

◆ eigenSolverDouble()

WMEigenSystem::TPVODouble::OutTransmitType const WMEigenSystem::eigenSolverDouble ( TPVODouble::TransmitType const & input )

private

Computes the eigen system for double input parameters via using applyEigenSolver.

Parameters

input A subarray of a valueset that consists of the 6 floats that make up the tensor.

Returns: The complete eigen system as double array with 12 components.

Definition at line 265 of file WMEigenSystem.cpp.

References applyEigenSolver().

Here is the call graph for this function:

◆ eigenSolverFloat()

WMEigenSystem::TPVOFloat::OutTransmitType const WMEigenSystem::eigenSolverFloat ( TPVOFloat::TransmitType const & input )

private

Computes the eigen system for double input parameters via using applyEigenSolver.

Parameters

input A subarray of a valueset that consists of the 6 floats that make up the tensor.

Returns: The complete eigen system as double array with 12 components.

Definition at line 275 of file WMEigenSystem.cpp.

References applyEigenSolver().

Here is the call graph for this function:

◆ factory()

std::shared_ptr< WModule > WMEigenSystem::factory ( ) const

virtual

Due to the prototype design pattern used to build modules, this method returns a new instance of this method.

NOTE: it should never be initialized or modified in some other way. A simple new instance is required.

Returns: the prototype used to create every module in OpenWalnut.

Implements WModule.

Definition at line 50 of file WMEigenSystem.cpp.

References WMEigenSystem().

Here is the call graph for this function:

◆ getDescription()

const std::string WMEigenSystem::getDescription ( ) const

virtual

Gives back a description of this module.

Returns: description to module.

Implements WPrototyped.

Definition at line 65 of file WMEigenSystem.cpp.

◆ getName()

const std::string WMEigenSystem::getName ( ) const

virtual

Gives back the name of this module.

Returns: the module's name.

Implements WPrototyped.

Definition at line 60 of file WMEigenSystem.cpp.

◆ getXPMIcon()

const char ** WMEigenSystem::getXPMIcon ( ) const

virtual

Get the icon for this module in XPM format.

Returns: The icon.

Reimplemented from WModule.

Definition at line 56 of file WMEigenSystem.cpp.

◆ moduleMain()

void WMEigenSystem::moduleMain ( )

protectedvirtual

Entry point after loading the module.

Runs in separate thread.

Implements WModule.

Definition at line 110 of file WMEigenSystem.cpp.

References WConditionSet::add(), WModule::infoLog(), m_currentProgress, m_eigenOperationDouble, m_eigenOperationFloat, m_eigenPool, WModule::m_moduleState, WThreadedRunner::m_shutdownFlag, m_strategySelector, m_tensorIC, WModule::ready(), resetEigenFunction(), resetProgress(), WConditionSet::setResetable(), and WConditionSet::wait().

Here is the call graph for this function:

◆ properties()

void WMEigenSystem::properties ( )

protectedvirtual

Initialize the properties for this module.

Reimplemented from WModule.

Definition at line 90 of file WMEigenSystem.cpp.

References WPropertyHelper::PC_SELECTONLYONE::addTo(), WPropertyHelper::PC_NOTEMPTY::addTo(), WModule::m_properties, m_strategySelector, and WModule::properties().

Here is the call graph for this function:

◆ requirements()

void WMEigenSystem::requirements ( )

protectedvirtual

Initialize requirements for this module.

Reimplemented from WModule.

Definition at line 105 of file WMEigenSystem.cpp.

◆ resetEigenFunction()

void WMEigenSystem::resetEigenFunction ( std::shared_ptr< WDataSetDTI > tensors )

private

Resets the threaded function/threadpool.

Parameters

tensors The field of computed eigen systems, where each eigensystem is in the form: ev, evc, ev, evec, ev, evec.

Definition at line 312 of file WMEigenSystem.cpp.

References WModule::debugLog(), m_eigenOperationDouble, m_eigenOperationFloat, m_eigenPool, WModule::m_moduleState, and WConditionSet::remove().

Referenced by moduleMain().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resetProgress()

void WMEigenSystem::resetProgress	(	std::size_t	todo,
		std::string	name
	)

private

Resets the current progress to 0.

Parameters

todo	The number of operations of the new progress.
name	Identifying what kind of work this progress is indicating.

Definition at line 302 of file WMEigenSystem.cpp.

References m_currentProgress, and WModule::m_progress.

Referenced by moduleMain().

Here is the caller graph for this function:

◆ updateOCs()

void WMEigenSystem::updateOCs ( std::shared_ptr< const WDataSetSingle > es )

private

Update the output connectors out of the computed eigensystem field.

Parameters

es	Dataset carrying all eigen systems.

Definition at line 164 of file WMEigenSystem.cpp.

References m_evecOutputs.

Member Data Documentation

◆ m_currentProgress

std::shared_ptr< WProgress > WMEigenSystem::m_currentProgress

private

Indicating current work progress.

Definition at line 242 of file WMEigenSystem.h.

Referenced by eigenFuncDouble(), eigenFuncFloat(), moduleMain(), and resetProgress().

◆ m_eigenOperationDouble

std::shared_ptr< TPVODouble > WMEigenSystem::m_eigenOperationDouble

private

the functor used for the calculation of the eigenvectors

Definition at line 237 of file WMEigenSystem.h.

Referenced by moduleMain(), and resetEigenFunction().

◆ m_eigenOperationFloat

std::shared_ptr< TPVOFloat > WMEigenSystem::m_eigenOperationFloat

private

the functor used for the calculation of the eigenvectors

Definition at line 234 of file WMEigenSystem.h.

Referenced by moduleMain(), and resetEigenFunction().

◆ m_eigenPool

std::shared_ptr< WThreadedFunctionBase > WMEigenSystem::m_eigenPool

private

The threadpool for the eigenvector computation.

Definition at line 231 of file WMEigenSystem.h.

Referenced by moduleMain(), and resetEigenFunction().

◆ m_evalOutputs

std::vector< std::shared_ptr< WModuleOutputData< WDataSetScalar > > > WMEigenSystem::m_evalOutputs

private

Output scalar field , each for an eigenvalue field.

Definition at line 228 of file WMEigenSystem.h.

Referenced by connectors().

◆ m_evecOutputs

std::vector< EigenOutputConnector > WMEigenSystem::m_evecOutputs

private

Ouput vector field for principal eigenvectors as well as one for all eigenvalues at once.

Definition at line 223 of file WMEigenSystem.h.

Referenced by connectors(), and updateOCs().

◆ m_strategySelector

WPropSelection WMEigenSystem::m_strategySelector

private

List for selecting the strategy.

Definition at line 247 of file WMEigenSystem.h.

Referenced by moduleMain(), and properties().

◆ m_tensorIC

std::shared_ptr< WModuleInputData< WDataSetDTI > > WMEigenSystem::m_tensorIC

private

Input tensor field.

Definition at line 213 of file WMEigenSystem.h.

Referenced by connectors(), and moduleMain().

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

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ EigenFunctionTypeDouble

◆ EigenFunctionTypeFloat

◆ EigenOutputConnector

◆ FloatValueSetType

◆ TPVODouble

◆ TPVOFloat

◆ Tracking

◆ TrackingFuncType

Constructor & Destructor Documentation

◆ WMEigenSystem()

◆ ~WMEigenSystem()

Member Function Documentation

◆ applyEigenSolver()

◆ computeEigenSystem()

◆ connectors()

◆ eigenFuncDouble()

◆ eigenFuncFloat()

◆ eigenSolverDouble()

◆ eigenSolverFloat()

◆ factory()

◆ getDescription()

◆ getName()

◆ getXPMIcon()

◆ moduleMain()

◆ properties()

◆ requirements()

◆ resetEigenFunction()

◆ resetProgress()

◆ updateOCs()

Member Data Documentation

◆ m_currentProgress

◆ m_eigenOperationDouble

◆ m_eigenOperationFloat

◆ m_eigenPool

◆ m_evalOutputs

◆ m_evecOutputs

◆ m_strategySelector

◆ m_tensorIC