Gauss filtering for WDataSetScalar. More...

#include <WMGaussFiltering.h>

Inheritance diagram for WMGaussFiltering:

Collaboration diagram for WMGaussFiltering:

Public Member Functions
	WMGaussFiltering ()
	Standard constructor. More...

	~WMGaussFiltering ()
	Destructor. 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...

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 void	requirements ()
	Initialize requirements in this function. 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 Member Functions
template<typename T >
double	filterAtPosition (std::shared_ptr< WValueSet< T > > vals, size_t nX, size_t nY, size_t nZ, size_t x, size_t y, size_t z, size_t offset)
	Simple convolution using a small gauss-like mask. More...

template<typename T >
std::vector< double >	filterField (std::shared_ptr< WValueSet< T > > vals, std::shared_ptr< WGridRegular3D > grid, std::shared_ptr< WProgress > prog)
	Run the filter over the field. More...

template<typename T >
void	filterField1D (std::vector< T > *newVals, const std::vector< T > &vals, std::shared_ptr< WProgress > prog, size_t Nx, size_t Ny, size_t Nz, size_t dx, size_t dy, size_t dz)
	Run the 1D Gaussian filter over the field. More...

template<typename T >
void	filterField1D (std::vector< double > *newVals, std::shared_ptr< WValueSet< T > > vals, std::shared_ptr< WProgress > prog, size_t Nx, size_t Ny, size_t Nz, size_t dx, size_t dy, size_t dz)
	Run the 1D Gaussian filter over the field. More...

template<typename T >
std::shared_ptr< WValueSet< double > >	iterativeFilterField (std::shared_ptr< WValueSet< T > > vals, unsigned int iterations)
	Run the filter iteratively over the field. More...

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

WPropInt	m_iterations
	The number of iterations to use for filtering. More...

WPropBool	m_3DMaskMode
	1D or 3D filtering flag More...

std::shared_ptr< WModuleInputData< WDataSetScalar > >	m_input
	Input connector required by this module. More...

std::shared_ptr< WModuleOutputData< WDataSetScalar > >	m_output
	The only output of this filter module. More...

std::shared_ptr< WDataSetScalar >	m_dataSet
	Pointer providing access to the treated data set in the whole module. 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

Gauss filtering for WDataSetScalar.

Problems: It works only on double value sets so far.

Reminder:: The boundary values will not be touched and considered to be zero.

Definition at line 49 of file WMGaussFiltering.h.

Constructor & Destructor Documentation

◆ WMGaussFiltering()

WMGaussFiltering::WMGaussFiltering ( )

Standard constructor.

Definition at line 44 of file WMGaussFiltering.cpp.

Referenced by factory().

Here is the caller graph for this function:

◆ ~WMGaussFiltering()

WMGaussFiltering::~WMGaussFiltering ( )

Destructor.

Definition at line 51 of file WMGaussFiltering.cpp.

References WModule::removeConnectors().

Here is the call graph for this function:

Member Function Documentation

◆ connectors()

void WMGaussFiltering::connectors ( )

protectedvirtual

Initialize the connectors this module is using.

Reimplemented from WModule.

Definition at line 374 of file WMGaussFiltering.cpp.

References WModule::addConnector(), WModule::connectors(), m_input, and m_output.

Here is the call graph for this function:

◆ factory()

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

References WMGaussFiltering().

Here is the call graph for this function:

◆ filterAtPosition()

template<typename T >

double WMGaussFiltering::filterAtPosition	(	std::shared_ptr< WValueSet< T > >	vals,
		size_t	nX,
		size_t	nY,
		size_t	nZ,
		size_t	x,
		size_t	y,
		size_t	z,
		size_t	offset
	)

private

Simple convolution using a small gauss-like mask.

Parameters

vals	the valueset to work on
nX	number of positions in x direction
nY	number of positions in y direction
nZ	number of positions in z direction
x	index for x direction
y	index for x direction
z	index for x direction
offset	the offset to add to the index (useful for addressing vector/tensor elements)

Returns: the filtered value for a given position

Definition at line 94 of file WMGaussFiltering.cpp.

Referenced by filterField().

Here is the caller graph for this function:

◆ filterField()

template<typename T >

std::vector< double > WMGaussFiltering::filterField	(	std::shared_ptr< WValueSet< T > >	vals,
		std::shared_ptr< WGridRegular3D >	grid,
		std::shared_ptr< WProgress >	prog
	)

private

Run the filter over the field.

Parameters

vals	the valueset to work on
grid	the grid for the valueset
prog	the progress used for this filter iteration

Returns: the filtered array of values.

Definition at line 119 of file WMGaussFiltering.cpp.

References filterAtPosition(), filterField1D(), and m_3DMaskMode.

Referenced by iterativeFilterField().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ filterField1D() [1/2]

template<typename T >

void WMGaussFiltering::filterField1D	(	std::vector< double > *	newVals,
		std::shared_ptr< WValueSet< T > >	vals,
		std::shared_ptr< WProgress >	prog,
		size_t	Nx,
		size_t	Ny,
		size_t	Nz,
		size_t	dx,
		size_t	dy,
		size_t	dz
	)

private

Run the 1D Gaussian filter over the field.

Parameters

newVals	result of the filtering
vals	the values to work on
prog	the progress used for this filter iteration
Nx	dimension along the filter
Ny	first dimension perpendicular to the filter
Nz	second dimension perpendicular to the filter
dx	element offset along the filter
dy	element offset perpendicular to the filter
dz	second element offset perpendicular to the filter

Definition at line 161 of file WMGaussFiltering.cpp.

◆ filterField1D() [2/2]

template<typename T >

void WMGaussFiltering::filterField1D	(	std::vector< T > *	newVals,
		const std::vector< T > &	vals,
		std::shared_ptr< WProgress >	prog,
		size_t	Nx,
		size_t	Ny,
		size_t	Nz,
		size_t	dx,
		size_t	dy,
		size_t	dz
	)

private

Run the 1D Gaussian filter over the field.

Parameters

newVals	result of the filtering
vals	the values to work on
prog	the progress used for this filter iteration
Nx	dimension along the filter
Ny	first dimension perpendicular to the filter
Nz	second dimension perpendicular to the filter
dx	element offset along the filter
dy	element offset perpendicular to the filter
dz	second element offset perpendicular to the filter

Definition at line 182 of file WMGaussFiltering.cpp.

Referenced by filterField().

Here is the caller graph for this function:

◆ getDescription()

const std::string WMGaussFiltering::getDescription ( ) const

virtual

Gives back a description of this module.

Returns: description of module.

Implements WPrototyped.

Definition at line 72 of file WMGaussFiltering.cpp.

◆ getName()

const std::string WMGaussFiltering::getName ( ) const

virtual

Gives back the name of this module.

Returns: the module's name.

Implements WPrototyped.

Definition at line 67 of file WMGaussFiltering.cpp.

◆ getXPMIcon()

const char ** WMGaussFiltering::getXPMIcon ( ) const

virtual

Get the icon for this module in XPM format.

Returns: The icon.

Reimplemented from WModule.

Definition at line 62 of file WMGaussFiltering.cpp.

◆ iterativeFilterField()

template<typename T >

std::shared_ptr< WValueSet< double > > WMGaussFiltering::iterativeFilterField	(	std::shared_ptr< WValueSet< T > >	vals,
		unsigned int	iterations
	)

private

Run the filter iteratively over the field.

The number of iterations is determined by m_iterations.

Parameters

vals	the valueset to work on
iterations	the number of iterations. If this value is <=1 then the filter gets applied exactly once.

Returns: the filtered valueset.

Definition at line 203 of file WMGaussFiltering.cpp.

References filterField(), m_3DMaskMode, m_dataSet, and WModule::m_progress.

Here is the call graph for this function:

◆ moduleMain()

void WMGaussFiltering::moduleMain ( )

protectedvirtual

Entry point after loading the module.

Runs in separate thread.

Implements WModule.

Definition at line 244 of file WMGaussFiltering.cpp.

References WConditionSet::add(), WModule::debugLog(), m_3DMaskMode, m_dataSet, m_input, m_iterations, WModule::m_moduleState, m_output, m_propCondition, WThreadedRunner::m_shutdownFlag, WModule::ready(), WConditionSet::setResetable(), and WConditionSet::wait().

Here is the call graph for this function:

◆ properties()

void WMGaussFiltering::properties ( )

protectedvirtual

Initialize the properties for this module.

Reimplemented from WModule.

Definition at line 396 of file WMGaussFiltering.cpp.

References m_3DMaskMode, m_iterations, m_propCondition, WModule::m_properties, and WModule::properties().

Here is the call graph for this function:

Member Data Documentation

◆ m_3DMaskMode

WPropBool WMGaussFiltering::m_3DMaskMode

private

1D or 3D filtering flag

Definition at line 118 of file WMGaussFiltering.h.

Referenced by filterField(), iterativeFilterField(), moduleMain(), and properties().

◆ m_dataSet

std::shared_ptr< WDataSetScalar > WMGaussFiltering::m_dataSet

private

Pointer providing access to the treated data set in the whole module.

Definition at line 198 of file WMGaussFiltering.h.

Referenced by iterativeFilterField(), and moduleMain().

◆ m_input

std::shared_ptr< WModuleInputData< WDataSetScalar > > WMGaussFiltering::m_input

private

Input connector required by this module.

Definition at line 196 of file WMGaussFiltering.h.

Referenced by connectors(), and moduleMain().

◆ m_iterations

WPropInt WMGaussFiltering::m_iterations

private

The number of iterations to use for filtering.

Definition at line 113 of file WMGaussFiltering.h.

Referenced by moduleMain(), and properties().

◆ m_output

std::shared_ptr< WModuleOutputData< WDataSetScalar > > WMGaussFiltering::m_output

private

The only output of this filter module.

Definition at line 197 of file WMGaussFiltering.h.

Referenced by connectors(), and moduleMain().

◆ m_propCondition

std::shared_ptr< WCondition > WMGaussFiltering::m_propCondition

private

A condition used to notify about changes in several properties.

Definition at line 108 of file WMGaussFiltering.h.

Referenced by moduleMain(), and properties().

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

◆ WMGaussFiltering()

◆ ~WMGaussFiltering()

Member Function Documentation

◆ connectors()

◆ factory()

◆ filterAtPosition()

◆ filterField()

◆ filterField1D() [1/2]

◆ filterField1D() [2/2]

◆ getDescription()

◆ getName()

◆ getXPMIcon()

◆ iterativeFilterField()

◆ moduleMain()

◆ properties()

Member Data Documentation

◆ m_3DMaskMode

◆ m_dataSet

◆ m_input

◆ m_iterations

◆ m_output

◆ m_propCondition