OpenWalnut
1.5.0dev
|
Create non uniformly shaped ROIs for fiber selection. More...
#include <WMArbitraryROIs.h>
Public Member Functions | |
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 | activate () |
Callback for m_active. 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... | |
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 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 | |
void | initSelectionROI () |
create a selection box to mark the area in a dataset which will provide the data for a new ROI More... | |
void | createCutDataset () |
creates a new dataset More... | |
void | renderMesh () |
renders the temporary ROI More... | |
void | finalizeROI () |
creates a ROI and adds it to the ROI manager More... | |
void | cleanup () |
Removes the ROI and cleans up the scene. More... | |
template<typename T > | |
std::shared_ptr< std::vector< float > > | cutArea (std::shared_ptr< WGrid > inGrid, std::shared_ptr< WValueSet< T > > vals) |
copies the data from the input dataset which is marked by the selection box, otherwise data is zero More... | |
Private Attributes | |
std::shared_ptr< WCondition > | m_recompute |
This condition denotes whether we need to recompute the surface. More... | |
std::shared_ptr< WModuleInputData< WDataSetScalar > > | m_input |
Input connector required by this module. More... | |
std::shared_ptr< const WDataSetScalar > | m_dataSet |
pointer to dataSet to be able to access it throughout the whole module. More... | |
std::shared_ptr< WValueSet< float > > | m_newValueSet |
pointer to the created cut valueSet More... | |
osg::ref_ptr< WROIBox > | m_selectionROI |
stores a pointer to the cutting tool ROI More... | |
std::shared_ptr< WCondition > | m_propCondition |
A condition used to notify about changes in several properties. More... | |
WPropTrigger | m_finalizeTrigger |
A trigger which can be used to trigger some kind of operation. More... | |
WPropDouble | m_threshold |
the threshold for the ROI More... | |
WPropColor | m_surfaceColor |
Property determining the color for the surface. More... | |
osg::ref_ptr< WGEGroupNode > | m_moduleNode |
Pointer to the modules group node. We need it to be able to update it when callback is invoked. More... | |
osg::ref_ptr< osg::Geode > | m_outputGeode |
Pointer to geode containing the glpyhs. More... | |
std::shared_ptr< WTriangleMesh > | m_triMesh |
This triangle mesh is provided as output through the connector. More... | |
bool | m_showSelector |
flag indication if the temporary ROI should be shown; More... | |
WPosition | m_lastMinPos |
the last know min position of the ROI if there was any More... | |
WPosition | m_lastMaxPos |
the last know max position of the ROI if there was any 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... | |
Create non uniformly shaped ROIs for fiber selection.
Definition at line 50 of file WMArbitraryROIs.h.
|
protectedvirtual |
Callback for m_active.
Overwrite this in your modules to handle m_active changes separately.
Reimplemented from WModule.
Definition at line 389 of file WMArbitraryROIs.cpp.
References WModule::activate(), WModule::m_active, and m_selectionROI.
|
privatevirtual |
Removes the ROI and cleans up the scene.
Reimplemented from WModule.
Definition at line 173 of file WMArbitraryROIs.cpp.
References WKernel::getGraphicsEngine(), WKernel::getRunningKernel(), m_lastMaxPos, m_lastMinPos, m_moduleNode, and m_selectionROI.
Referenced by moduleMain().
|
protectedvirtual |
Initialize the connectors this module is using.
Reimplemented from WModule.
Definition at line 89 of file WMArbitraryROIs.cpp.
References WModule::addConnector(), WModule::connectors(), and m_input.
|
private |
creates a new dataset
Definition at line 196 of file WMArbitraryROIs.cpp.
References WModule::m_active, m_dataSet, and m_threshold.
Referenced by initSelectionROI(), and moduleMain().
|
private |
copies the data from the input dataset which is marked by the selection box, otherwise data is zero
inGrid | The grid from which the area will be cut |
vals | The values on the original grid |
Definition at line 268 of file WMArbitraryROIs.cpp.
References m_selectionROI.
|
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.
Implements WModule.
Definition at line 65 of file WMArbitraryROIs.cpp.
|
private |
creates a ROI and adds it to the ROI manager
Definition at line 364 of file WMArbitraryROIs.cpp.
References WKernel::getRoiManager(), WKernel::getRunningKernel(), WModule::m_active, m_dataSet, m_newValueSet, m_surfaceColor, m_threshold, and m_triMesh.
Referenced by moduleMain().
|
virtual |
Gives back a description of this module.
Implements WPrototyped.
Definition at line 82 of file WMArbitraryROIs.cpp.
|
virtual |
Gives back the name of this module.
Implements WPrototyped.
Definition at line 76 of file WMArbitraryROIs.cpp.
|
virtual |
Get the icon for this module in XPM format.
Reimplemented from WModule.
Definition at line 71 of file WMArbitraryROIs.cpp.
|
private |
create a selection box to mark the area in a dataset which will provide the data for a new ROI
Definition at line 189 of file WMArbitraryROIs.cpp.
References createCutDataset(), m_lastMaxPos, m_lastMinPos, and m_selectionROI.
Referenced by moduleMain().
|
protectedvirtual |
Entry point after loading the module.
Runs in separate thread.
Implements WModule.
Definition at line 112 of file WMArbitraryROIs.cpp.
References WConditionSet::add(), cleanup(), createCutDataset(), finalizeROI(), WKernel::getRunningKernel(), WKernel::getSelectionManager(), initSelectionROI(), m_dataSet, m_finalizeTrigger, m_input, m_lastMaxPos, m_lastMinPos, WModule::m_moduleState, m_propCondition, m_recompute, m_showSelector, WThreadedRunner::m_shutdownFlag, m_threshold, WPVBaseTypes::PV_TRIGGER_READY, WPVBaseTypes::PV_TRIGGER_TRIGGERED, WModule::ready(), renderMesh(), WConditionSet::setResetable(), and WConditionSet::wait().
|
protectedvirtual |
Initialize the properties for this module.
Reimplemented from WModule.
Definition at line 101 of file WMArbitraryROIs.cpp.
References m_finalizeTrigger, m_propCondition, WModule::m_properties, m_surfaceColor, m_threshold, WModule::properties(), and WPVBaseTypes::PV_TRIGGER_READY.
|
private |
renders the temporary ROI
Definition at line 306 of file WMArbitraryROIs.cpp.
References WKernel::getGraphicsEngine(), WKernel::getRunningKernel(), m_moduleNode, m_outputGeode, m_showSelector, and m_triMesh.
Referenced by moduleMain().
|
private |
pointer to dataSet to be able to access it throughout the whole module.
Definition at line 154 of file WMArbitraryROIs.h.
Referenced by createCutDataset(), finalizeROI(), and moduleMain().
|
private |
A trigger which can be used to trigger some kind of operation.
Definition at line 168 of file WMArbitraryROIs.h.
Referenced by moduleMain(), and properties().
|
private |
Input connector required by this module.
Definition at line 152 of file WMArbitraryROIs.h.
Referenced by connectors(), and moduleMain().
|
private |
the last know max position of the ROI if there was any
Definition at line 183 of file WMArbitraryROIs.h.
Referenced by cleanup(), initSelectionROI(), and moduleMain().
|
private |
the last know min position of the ROI if there was any
Definition at line 182 of file WMArbitraryROIs.h.
Referenced by cleanup(), initSelectionROI(), and moduleMain().
|
private |
Pointer to the modules group node. We need it to be able to update it when callback is invoked.
Definition at line 174 of file WMArbitraryROIs.h.
Referenced by cleanup(), and renderMesh().
|
private |
pointer to the created cut valueSet
Definition at line 156 of file WMArbitraryROIs.h.
Referenced by finalizeROI().
|
private |
Pointer to geode containing the glpyhs.
Definition at line 176 of file WMArbitraryROIs.h.
Referenced by renderMesh().
|
private |
A condition used to notify about changes in several properties.
Definition at line 163 of file WMArbitraryROIs.h.
Referenced by moduleMain(), and properties().
|
private |
This condition denotes whether we need to recompute the surface.
Definition at line 150 of file WMArbitraryROIs.h.
Referenced by moduleMain().
|
private |
stores a pointer to the cutting tool ROI
Definition at line 158 of file WMArbitraryROIs.h.
Referenced by activate(), cleanup(), cutArea(), and initSelectionROI().
|
private |
flag indication if the temporary ROI should be shown;
Definition at line 180 of file WMArbitraryROIs.h.
Referenced by moduleMain(), and renderMesh().
|
private |
Property determining the color for the surface.
Definition at line 172 of file WMArbitraryROIs.h.
Referenced by finalizeROI(), and properties().
|
private |
the threshold for the ROI
Definition at line 170 of file WMArbitraryROIs.h.
Referenced by createCutDataset(), finalizeROI(), moduleMain(), and properties().
|
private |
This triangle mesh is provided as output through the connector.
Definition at line 178 of file WMArbitraryROIs.h.
Referenced by finalizeROI(), and renderMesh().