Test module to open a new widget and display EEG data. More...

#include <WMEEGView.h>

Inheritance diagram for WMEEGView:

Collaboration diagram for WMEEGView:

Public Member Functions
	WMEEGView ()
	default constructor More...

virtual	~WMEEGView ()
	destructor 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 std::string	getName () const
	Gets the name of this module. More...

virtual const std::string	getDescription () const
	Gets the description for this module. 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	connectors ()
	Initialize connectors in this function. More...

virtual void	properties ()
	Initialize properties in this function. More...

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

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

virtual void	moduleMain ()
	Entry point after loading the 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	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...

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 Member Functions
void	createColorMap ()
	Prepare textures for colormapping EEG signal. More...

bool	openCustomWidget ()
	Opens a custom widget and connects the m_node with it. More...

void	closeCustomWidget ()
	Disconnects the m_node from the custom widget and closes the widget. More...

void	redraw ()
	Removes all Nodes from m_rootNode2d and m_rootNode3d and adds new ones based on the current data stored in m_eeg. More...

osg::ref_ptr< osg::Node >	drawElectrodes ()
	Draw the electrode positions in 3D. More...

osg::ref_ptr< osg::Node >	drawHeadSurface ()
	Draw the head surface in 3D. More...

osg::ref_ptr< osg::Node >	drawLabels ()
	Draw the electrode labels in 3D. More...

Private Attributes
std::shared_ptr< WModuleInputData< WEEG2 > >	m_eeg_input
	Input connector for a EEG dataset. More...

std::shared_ptr< WModuleInputData< WDataSetDipoles > >	m_dipoles_input
	Input connector for dipoles of EEG data. More...

std::shared_ptr< WCondition >	m_propCondition
	A condition used to notify about changes in several properties. More...

WPropGroup	m_manualNavigationGroup
	Group for parameters that are normally adjusted using mouse actions. More...

WPropGroup	m_appearanceGroup
	Group for parameters that adjust the appearance of the EEG widget. More...

WPropBool	m_drawElectrodes
	Property determining whether electode positions should be drawn. More...

WPropBool	m_drawHeadSurface
	Property determining whether the head surface should be drawn. More...

WPropBool	m_drawLabels
	Property determining whether electrode labels should be drawn. More...

WPropBool	m_proofOfConcept
	Property determining whether we only show the proof of concept or the real dipoles. More...

WPropBool	m_snapToDipole
	Property determining whether the selected time position should be snapped to an active dipole. More...

WPropBool	m_butterfly
	Property switching between standard and butterfly plot of curves (overlay of all curves in one row) More...

WPropDouble	m_ROIsize
	Size of the region of interest. More...

WPropInt	m_labelsWidth
	the width of the label display in pixel as property More...

WPropDouble	m_timePos
	the time position in seconds where to start the graph at the left edge as property More...

WPropDouble	m_timeRange
	the width of the graph in seconds as property More...

WPropInt	m_graphWidth
	the width of the graph in pixel as property More...

WPropDouble	m_yPos
	the y position in pixel at the lower edge as property More...

WPropDouble	m_ySpacing
	the distance between two curves of the graph in pixel as property More...

WPropDouble	m_ySensitivity
	the sensitivity of the graph in microvolt per pixel as property More...

WPropDouble	m_colorSensitivity
	The sensitivity of the color map as property. More...

std::shared_ptr< WFlag< std::shared_ptr< WEEGEvent > > >	m_event
	event marking a special time position as WFlag More...

std::shared_ptr< WEEG2 >	m_eeg
	Pointer to the loaded EEG dataset. More...

std::shared_ptr< WDataSetDipoles >	m_dipoles
	Pointer to the loaded dipoles dataset. More...

std::shared_ptr< WUIViewWidget >	m_widget
	Custom widget which is used by this module to display its data. More...

osg::ref_ptr< WEEGViewHandler >	m_handler
	GUI event handler used for interactive changing of many properties. More...

osg::ref_ptr< WGEGroupNode >	m_rootNode2d
	OSG node for all 2D stuff of this module. More...

osg::ref_ptr< WGEGroupNode >	m_rootNode3d
	OSG node for all 3D stuff of this module. More...

osg::ref_ptr< osg::Node >	m_electrodesNode
	OSG node for the 3D display of the electrode positions. More...

osg::ref_ptr< osg::Node >	m_headSurfaceNode
	OSG node for the 3D display of the head surface. More...

osg::ref_ptr< osg::Node >	m_labelsNode
	OSG node for the 3D display of the electrode labels. More...

std::vector< osg::ref_ptr< WROIBox > >	m_rois
	The ROIs around the source dipole positions at the time determined by m_event. More...

WBoolFlag	m_dataChanged
	Bool flag which gets set when the data was changed. More...

bool	m_wasActive
	The current active-state. More...

double	m_currentEventTime
	The time of the current event. More...

osg::ref_ptr< osgSim::ScalarsToColors >	m_colorMap
	A ScalarsToColors object mapping the potentials at the electrodes to colors. More...

osg::ref_ptr< osg::Texture1D >	m_colorMapTexture
	A 1D texture containing the color map as image. More...

std::shared_ptr< WEEGSourceCalculator >	m_sourceCalculator
	calculates a source position at a given time position 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

Test module to open a new widget and display EEG data.

Definition at line 51 of file WMEEGView.h.

Constructor & Destructor Documentation

◆ WMEEGView()

WMEEGView::WMEEGView ( )

default constructor

Definition at line 65 of file WMEEGView.cpp.

Referenced by factory().

Here is the caller graph for this function:

◆ ~WMEEGView()

WMEEGView::~WMEEGView ( )

virtual

destructor

Definition at line 73 of file WMEEGView.cpp.

Member Function Documentation

◆ closeCustomWidget()

void WMEEGView::closeCustomWidget ( )

private

Disconnects the m_node from the custom widget and closes the widget.

Definition at line 464 of file WMEEGView.cpp.

References m_handler, m_rootNode2d, and m_widget.

Referenced by moduleMain().

Here is the caller graph for this function:

◆ connectors()

void WMEEGView::connectors ( )

protectedvirtual

Initialize connectors in this function.

Reimplemented from WModule.

Definition at line 105 of file WMEEGView.cpp.

References WModule::addConnector(), WModule::connectors(), m_dipoles_input, and m_eeg_input.

Here is the call graph for this function:

◆ createColorMap()

void WMEEGView::createColorMap ( )

private

Prepare textures for colormapping EEG signal.

Definition at line 407 of file WMEEGView.cpp.

References m_colorMap, and m_colorMapTexture.

Referenced by moduleMain().

Here is the caller graph for this function:

◆ drawElectrodes()

osg::ref_ptr< osg::Node > WMEEGView::drawElectrodes ( )

private

Draw the electrode positions in 3D.

Returns: an OSG Node containing the electrode positions

Definition at line 742 of file WMEEGView.cpp.

References m_colorMap, m_colorSensitivity, m_eeg, m_event, and WModule::warnLog().

Referenced by moduleMain(), and redraw().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ drawHeadSurface()

osg::ref_ptr< osg::Node > WMEEGView::drawHeadSurface ( )

private

Draw the head surface in 3D.

Returns: an OSG Node containing the head surface

Definition at line 774 of file WMEEGView.cpp.

References wge::convertToOsgGeometry(), m_colorMapTexture, m_colorSensitivity, m_eeg, m_event, wge::triangulate(), and WModule::warnLog().

Referenced by moduleMain(), and redraw().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ drawLabels()

osg::ref_ptr< osg::Node > WMEEGView::drawLabels ( )

private

Draw the electrode labels in 3D.

Returns: an OSG Node containing the electrode labels

Definition at line 825 of file WMEEGView.cpp.

References m_eeg, and WModule::warnLog().

Referenced by moduleMain(), and redraw().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ factory()

std::shared_ptr< WModule > WMEEGView::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 77 of file WMEEGView.cpp.

References WMEEGView().

Here is the call graph for this function:

◆ getDescription()

const std::string WMEEGView::getDescription ( ) const

virtual

Gets the description for this module.

Returns: the description

Implements WPrototyped.

Definition at line 87 of file WMEEGView.cpp.

◆ getName()

const std::string WMEEGView::getName ( ) const

virtual

Gets the name of this module.

Returns: the name.

Implements WPrototyped.

Definition at line 82 of file WMEEGView.cpp.

Referenced by openCustomWidget().

Here is the caller graph for this function:

◆ getXPMIcon()

const char ** WMEEGView::getXPMIcon ( ) const

virtual

Get the icon for this module in XPM format.

Returns: the icon.

Reimplemented from WModule.

Definition at line 92 of file WMEEGView.cpp.

◆ moduleMain()

void WMEEGView::moduleMain ( )

protectedvirtual

Entry point after loading the module.

Runs in separate thread.

Implements WModule.

Definition at line 222 of file WMEEGView.cpp.

References WConditionSet::add(), closeCustomWidget(), createColorMap(), WModule::debugLog(), drawElectrodes(), drawHeadSurface(), drawLabels(), WFlag< T >::getCondition(), WKernel::getGraphicsEngine(), WKernel::getRoiManager(), WKernel::getRunningKernel(), WModule::m_active, m_butterfly, m_currentEventTime, m_dataChanged, m_dipoles, m_dipoles_input, m_drawElectrodes, m_drawHeadSurface, m_drawLabels, m_eeg, m_eeg_input, m_electrodesNode, m_event, m_headSurfaceNode, m_labelsNode, WModule::m_moduleState, m_proofOfConcept, m_propCondition, m_rois, m_ROIsize, m_rootNode3d, WThreadedRunner::m_shutdownFlag, m_sourceCalculator, m_wasActive, openCustomWidget(), WModule::ready(), redraw(), WFlag< T >::set(), WConditionSet::setResetable(), and WConditionSet::wait().

Here is the call graph for this function:

◆ notifyConnectionEstablished()

void WMEEGView::notifyConnectionEstablished	(	std::shared_ptr< WModuleConnector >	,
		std::shared_ptr< WModuleConnector >
	)

protectedvirtual

Gets called whenever a connector gets connected to the specified input.

Sets the m_dataChanged flag.

Reimplemented from WModule.

Definition at line 210 of file WMEEGView.cpp.

References m_dataChanged, and WFlag< T >::set().

Here is the call graph for this function:

◆ notifyDataChange()

void WMEEGView::notifyDataChange	(	std::shared_ptr< WModuleConnector >	,
		std::shared_ptr< WModuleConnector >
	)

protectedvirtual

Gets called when the data on one input connector changed.

Sets the m_dataChanged flag.

Reimplemented from WModule.

Definition at line 216 of file WMEEGView.cpp.

References m_dataChanged, and WFlag< T >::set().

Here is the call graph for this function:

◆ openCustomWidget()

bool WMEEGView::openCustomWidget ( )

private

Opens a custom widget and connects the m_node with it.

Returns: whether the custom widget could be opened successfully

Definition at line 435 of file WMEEGView.cpp.

References WModule::debugLog(), WFlag< T >::getCondition(), getName(), WKernel::getRunningKernel(), WKernel::getUI(), m_handler, m_rootNode2d, WThreadedRunner::m_shutdownFlag, m_widget, and WModule::warnLog().

Referenced by moduleMain().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ properties()

void WMEEGView::properties ( )

protectedvirtual

Initialize properties in this function.

Reimplemented from WModule.

Definition at line 119 of file WMEEGView.cpp.

References m_appearanceGroup, m_butterfly, m_colorSensitivity, m_drawElectrodes, m_drawHeadSurface, m_drawLabels, m_graphWidth, m_labelsWidth, m_manualNavigationGroup, m_proofOfConcept, m_propCondition, WModule::m_properties, m_ROIsize, m_snapToDipole, m_timePos, m_timeRange, m_yPos, m_ySensitivity, m_ySpacing, and WModule::properties().

Here is the call graph for this function:

◆ redraw()

void WMEEGView::redraw ( )

private

Removes all Nodes from m_rootNode2d and m_rootNode3d and adds new ones based on the current data stored in m_eeg.

Definition at line 480 of file WMEEGView.cpp.

References WModule::debugLog(), drawElectrodes(), drawHeadSurface(), drawLabels(), WKernel::getGraphicsEngine(), WKernel::getRunningKernel(), m_butterfly, m_colorSensitivity, m_dipoles, m_drawElectrodes, m_drawHeadSurface, m_drawLabels, m_eeg, m_electrodesNode, m_event, m_graphWidth, m_handler, m_headSurfaceNode, m_labelsNode, m_labelsWidth, m_proofOfConcept, m_rootNode2d, m_rootNode3d, m_snapToDipole, m_sourceCalculator, m_timePos, m_timeRange, m_wasActive, m_widget, m_yPos, m_ySensitivity, and m_ySpacing.

Referenced by moduleMain().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ requirements()

void WMEEGView::requirements ( )

protectedvirtual

Initialize requirements for this module.

Reimplemented from WModule.

Definition at line 98 of file WMEEGView.cpp.

References WModule::m_requirements.

Member Data Documentation

◆ m_appearanceGroup

WPropGroup WMEEGView::m_appearanceGroup

private

Group for parameters that adjust the appearance of the EEG widget.

Definition at line 154 of file WMEEGView.h.

Referenced by properties().

◆ m_butterfly

WPropBool WMEEGView::m_butterfly

private

Property switching between standard and butterfly plot of curves (overlay of all curves in one row)

Definition at line 184 of file WMEEGView.h.

Referenced by moduleMain(), properties(), and redraw().

◆ m_colorMap

osg::ref_ptr< osgSim::ScalarsToColors > WMEEGView::m_colorMap

private

A ScalarsToColors object mapping the potentials at the electrodes to colors.

Used for the display of electrode positions and the head surface.

Definition at line 312 of file WMEEGView.h.

Referenced by createColorMap(), and drawElectrodes().

◆ m_colorMapTexture

osg::ref_ptr< osg::Texture1D > WMEEGView::m_colorMapTexture

private

A 1D texture containing the color map as image.

Used for the interpolation on the head surface.

Definition at line 318 of file WMEEGView.h.

Referenced by createColorMap(), and drawHeadSurface().

◆ m_colorSensitivity

WPropDouble WMEEGView::m_colorSensitivity

private

The sensitivity of the color map as property.

The color map ranges from -m_colorSensitivity to +m_colorSensitivity in microvolt.

Definition at line 231 of file WMEEGView.h.

Referenced by drawElectrodes(), drawHeadSurface(), properties(), and redraw().

◆ m_currentEventTime

double WMEEGView::m_currentEventTime

private

The time of the current event.

Used to check whether the event changed.

Definition at line 306 of file WMEEGView.h.

Referenced by moduleMain().

◆ m_dataChanged

WBoolFlag WMEEGView::m_dataChanged

private

Bool flag which gets set when the data was changed.

The module threads waits for this flag and performs a redraw.

Definition at line 296 of file WMEEGView.h.

Referenced by moduleMain(), notifyConnectionEstablished(), and notifyDataChange().

◆ m_dipoles

std::shared_ptr< WDataSetDipoles > WMEEGView::m_dipoles

private

Pointer to the loaded dipoles dataset.

Definition at line 246 of file WMEEGView.h.

Referenced by moduleMain(), and redraw().

◆ m_dipoles_input

std::shared_ptr< WModuleInputData< WDataSetDipoles > > WMEEGView::m_dipoles_input

private

Input connector for dipoles of EEG data.

Definition at line 139 of file WMEEGView.h.

Referenced by connectors(), and moduleMain().

◆ m_drawElectrodes

WPropBool WMEEGView::m_drawElectrodes

private

Property determining whether electode positions should be drawn.

Definition at line 159 of file WMEEGView.h.

Referenced by moduleMain(), properties(), and redraw().

◆ m_drawHeadSurface

WPropBool WMEEGView::m_drawHeadSurface

private

Property determining whether the head surface should be drawn.

Definition at line 164 of file WMEEGView.h.

Referenced by moduleMain(), properties(), and redraw().

◆ m_drawLabels

WPropBool WMEEGView::m_drawLabels

private

Property determining whether electrode labels should be drawn.

Definition at line 169 of file WMEEGView.h.

Referenced by moduleMain(), properties(), and redraw().

◆ m_eeg

std::shared_ptr< WEEG2 > WMEEGView::m_eeg

private

Pointer to the loaded EEG dataset.

Definition at line 241 of file WMEEGView.h.

Referenced by drawElectrodes(), drawHeadSurface(), drawLabels(), moduleMain(), and redraw().

◆ m_eeg_input

std::shared_ptr< WModuleInputData< WEEG2 > > WMEEGView::m_eeg_input

private

Input connector for a EEG dataset.

Definition at line 134 of file WMEEGView.h.

Referenced by connectors(), and moduleMain().

◆ m_electrodesNode

osg::ref_ptr< osg::Node > WMEEGView::m_electrodesNode

private

OSG node for the 3D display of the electrode positions.

Definition at line 273 of file WMEEGView.h.

Referenced by moduleMain(), and redraw().

◆ m_event

std::shared_ptr< WFlag< std::shared_ptr< WEEGEvent > > > WMEEGView::m_event

private

event marking a special time position as WFlag

Definition at line 236 of file WMEEGView.h.

Referenced by drawElectrodes(), drawHeadSurface(), moduleMain(), and redraw().

◆ m_graphWidth

WPropInt WMEEGView::m_graphWidth

private

the width of the graph in pixel as property

Definition at line 210 of file WMEEGView.h.

Referenced by properties(), and redraw().

◆ m_handler

osg::ref_ptr< WEEGViewHandler > WMEEGView::m_handler

private

GUI event handler used for interactive changing of many properties.

Definition at line 256 of file WMEEGView.h.

Referenced by closeCustomWidget(), openCustomWidget(), and redraw().

◆ m_headSurfaceNode

osg::ref_ptr< osg::Node > WMEEGView::m_headSurfaceNode

private

OSG node for the 3D display of the head surface.

Definition at line 278 of file WMEEGView.h.

Referenced by moduleMain(), and redraw().

◆ m_labelsNode

osg::ref_ptr< osg::Node > WMEEGView::m_labelsNode

private

OSG node for the 3D display of the electrode labels.

Definition at line 283 of file WMEEGView.h.

Referenced by moduleMain(), and redraw().

◆ m_labelsWidth

WPropInt WMEEGView::m_labelsWidth

private

the width of the label display in pixel as property

Definition at line 194 of file WMEEGView.h.

Referenced by properties(), and redraw().

◆ m_manualNavigationGroup

WPropGroup WMEEGView::m_manualNavigationGroup

private

Group for parameters that are normally adjusted using mouse actions.

Definition at line 149 of file WMEEGView.h.

Referenced by properties().

◆ m_proofOfConcept

WPropBool WMEEGView::m_proofOfConcept

private

Property determining whether we only show the proof of concept or the real dipoles.

Definition at line 174 of file WMEEGView.h.

Referenced by moduleMain(), properties(), and redraw().

◆ m_propCondition

std::shared_ptr< WCondition > WMEEGView::m_propCondition

private

A condition used to notify about changes in several properties.

Definition at line 144 of file WMEEGView.h.

Referenced by moduleMain(), and properties().

◆ m_rois

std::vector< osg::ref_ptr< WROIBox > > WMEEGView::m_rois

private

The ROIs around the source dipole positions at the time determined by m_event.

Used to select the fibers around this dipoles.

Definition at line 290 of file WMEEGView.h.

Referenced by moduleMain().

◆ m_ROIsize

WPropDouble WMEEGView::m_ROIsize

private

Size of the region of interest.

Definition at line 189 of file WMEEGView.h.

Referenced by moduleMain(), and properties().

◆ m_rootNode2d

osg::ref_ptr< WGEGroupNode > WMEEGView::m_rootNode2d

private

OSG node for all 2D stuff of this module.

All other OSG nodes should be placed as child to this node.

Definition at line 262 of file WMEEGView.h.

Referenced by closeCustomWidget(), openCustomWidget(), and redraw().

◆ m_rootNode3d

osg::ref_ptr< WGEGroupNode > WMEEGView::m_rootNode3d

private

OSG node for all 3D stuff of this module.

All other OSG nodes should be placed as child to this node.

Definition at line 268 of file WMEEGView.h.

Referenced by moduleMain(), and redraw().

◆ m_snapToDipole

WPropBool WMEEGView::m_snapToDipole

private

Property determining whether the selected time position should be snapped to an active dipole.

Definition at line 179 of file WMEEGView.h.

Referenced by properties(), and redraw().

◆ m_sourceCalculator

std::shared_ptr< WEEGSourceCalculator > WMEEGView::m_sourceCalculator

private

calculates a source position at a given time position

Definition at line 323 of file WMEEGView.h.

Referenced by moduleMain(), and redraw().

◆ m_timePos

WPropDouble WMEEGView::m_timePos

private

the time position in seconds where to start the graph at the left edge as property

Definition at line 200 of file WMEEGView.h.

Referenced by properties(), and redraw().

◆ m_timeRange

WPropDouble WMEEGView::m_timeRange

private

the width of the graph in seconds as property

Definition at line 205 of file WMEEGView.h.

Referenced by properties(), and redraw().

◆ m_wasActive

bool WMEEGView::m_wasActive

private

The current active-state.

Whether the widget is open and usable.

Definition at line 301 of file WMEEGView.h.

Referenced by moduleMain(), and redraw().

◆ m_widget

std::shared_ptr< WUIViewWidget > WMEEGView::m_widget

private

Custom widget which is used by this module to display its data.

Definition at line 251 of file WMEEGView.h.

Referenced by closeCustomWidget(), openCustomWidget(), and redraw().

◆ m_yPos

WPropDouble WMEEGView::m_yPos

private

the y position in pixel at the lower edge as property

Definition at line 215 of file WMEEGView.h.

Referenced by properties(), and redraw().

◆ m_ySensitivity

WPropDouble WMEEGView::m_ySensitivity

private

the sensitivity of the graph in microvolt per pixel as property

Definition at line 225 of file WMEEGView.h.

Referenced by properties(), and redraw().

◆ m_ySpacing

WPropDouble WMEEGView::m_ySpacing

private

the distance between two curves of the graph in pixel as property

Definition at line 220 of file WMEEGView.h.

Referenced by properties(), and redraw().

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

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ WMEEGView()

◆ ~WMEEGView()

Member Function Documentation

◆ closeCustomWidget()

◆ connectors()

◆ createColorMap()

◆ drawElectrodes()

◆ drawHeadSurface()

◆ drawLabels()

◆ factory()

◆ getDescription()

◆ getName()

◆ getXPMIcon()

◆ moduleMain()

◆ notifyConnectionEstablished()

◆ notifyDataChange()

◆ openCustomWidget()

◆ properties()

◆ redraw()

◆ requirements()

Member Data Documentation

◆ m_appearanceGroup

◆ m_butterfly

◆ m_colorMap

◆ m_colorMapTexture

◆ m_colorSensitivity

◆ m_currentEventTime

◆ m_dataChanged

◆ m_dipoles

◆ m_dipoles_input

◆ m_drawElectrodes

◆ m_drawHeadSurface

◆ m_drawLabels

◆ m_eeg

◆ m_eeg_input

◆ m_electrodesNode

◆ m_event

◆ m_graphWidth

◆ m_handler

◆ m_headSurfaceNode

◆ m_labelsNode

◆ m_labelsWidth

◆ m_manualNavigationGroup

◆ m_proofOfConcept

◆ m_propCondition

◆ m_rois

◆ m_ROIsize

◆ m_rootNode2d

◆ m_rootNode3d

◆ m_snapToDipole

◆ m_sourceCalculator

◆ m_timePos

◆ m_timeRange

◆ m_wasActive

◆ m_widget

◆ m_yPos

◆ m_ySensitivity

◆ m_ySpacing