MeVisLab Reference Manual

MeVisLab Reference Manual

Reference Guide for the MeVisLab GUI

Version 2.2

Copyright © MeVis Medical Solutions, 2003-2011

2011-09-03

Table of Contents

1. Introduction

1.1. About the MeVisLab Reference Manual
1.2. Associated Documents

2. MeVisLab User Interface

2.1. Overview
2.2. Views

3. Modules and Networks

3.1. Types of Modules

3.2. Connector and Connection Types

3.3. Mouse Pointers

3.4. Mouseover Information

3.5. Module Halo

3.6. Module Highlighting

3.7. Module Handling

3.7.1. Module Context Menu
3.7.2. Additional Inputs
3.7.3. Show Internal Network (Macro Modules)

3.8. Network Handling

3.8.1. Network Context Menu
3.8.2. Connections Context Menus

3.9. Using Groups

3.9.1. Creating Groups and Adding/Removing Modules
3.9.2. Editing, Converting and Deleting Groups
3.9.3. Copying Groups Including Modules

3.10. Using Notes

3.10.1. Creating Notes
3.10.2. Handling Notes
3.10.3. Editing and Deleting Notes
3.10.4. Copying Notes Including Text

3.11. Using the Mini Map

3.12. Network Quick Search

4. Menu Bar

4.1. File Menu

4.1.1. New
4.1.2. Open
4.1.3. Close
4.1.4. Save
4.1.5. Save As
4.1.6. Save Copy As
4.1.7. Revert To Saved
4.1.8. Recent Files
4.1.9. Run Project Wizard
4.1.10. Create Local Macro
4.1.11. Add Local Macro
4.1.12. Open File in Integrated Text Editor
4.1.13. Show Integrated Text Editor
4.1.14. Run ToolRunner
4.1.15. Run TestCaseManager
4.1.16. Restart with Current Networks
4.1.17. Quit

4.2. Edit Menu

4.2.1. Undo
4.2.2. Redo
4.2.3. Clear Undo History
4.2.4. Cut
4.2.5. Copy
4.2.6. Paste
4.2.7. Duplicate
4.2.8. Delete
4.2.9. Select All
4.2.10. Deselect All
4.2.11. Invert Selection
4.2.12. Align / Distribute
4.2.13. Reload Selected Modules

4.3. Preferences

4.3.1. Preferences — General
4.3.2. Preferences — Packages
4.3.3. Preferences — Module Groups
4.3.4. Preferences — Supportive Programs
4.3.5. Preferences — Paths
4.3.6. Preferences — Developer
4.3.7. Preferences — Python
4.3.8. Preferences — Network Appearance
4.3.9. Preferences — Network Interaction
4.3.10. Preferences — Panel Appearance
4.3.11. Preferences — Cout/Cerr Redirection
4.3.12. Preferences — Symbol Controlled Debugging
4.3.13. Preferences — Exceptions/Tracing

4.4. Modules Menu

4.5. Applications Menu

4.6. Extras Menu

4.6.1. Reload Module Database (Keep Cache)
4.6.2. Reload Module Database (Clear Cache)
4.6.3. Reload Imported Python Modules
4.6.4. Run Module Tests
4.6.5. Generate Module Reference for User Packages (HTML)
4.6.6. Debug Widgets
4.6.7. Verbose Scripting
4.6.8. Show Connector Details
4.6.9. Show Image Connector Preview
4.6.10. Clear Image Cache

4.7. Scripting Menu

4.7.1. Show Scripting Console
4.7.2. Edit Network Script
4.7.3. Start Network Script

4.8. View Menu

4.8.1. View All
4.8.2. Zoom To Selection
4.8.3. Zoom In
4.8.4. Zoom Out
4.8.5. Zoom 100%
4.8.6. Layout
4.8.7. Toolbars
4.8.8. Views

4.9. Networks Menu

4.9.1. Cascade
4.9.2. Tile
4.9.3. Show Tab Bar
4.9.4. Next
4.9.5. Previous
4.9.6. Close Current
4.9.7. Close All

4.10. Panels Menu

4.10.1. Panels Stay In Front Of Main Window
4.10.2. Hide Panels of Invisible Networks
4.10.3. Minimize All Open Panels
4.10.4. Show All Minimized Panels
4.10.5. Working with the Panel List

4.11. Help Menu

4.11.1. Show Help Overview
4.11.2. Search in Documentation
4.11.3. Browse Help Pages
4.11.4. Welcome
4.11.5. About
4.11.6. Enter License

5.1. File Operations
5.2. Edit
5.3. Zooming
5.4. Quick Search
5.5. Align / Distribute

6. Bottom Bar

6.1. ML Cache
6.2. Stop Button
6.3. Toggle Layout

7. Background Tasks

8. Debug Output

9. Module Browser

10. Module Inspector

10.1. Fields

10.1.1. Editing Field Values
10.1.2. Module Inspector Fields Context Menu

10.2. Files

10.2.1. Module Inspector Files Context Menu

10.3.1. Tree Context Menu

10.4. About

10.5. Related

10.5.1. Related Context Menu

10.6. Scripting

11. Module List

12. Module Search

12.1. Module Search

12.2. Advanced Search

12.3. Module Search Result Context Menu

12.3.1. General options
12.3.2. Additional options for Macro Modules

12.4. Search in Network

13. Network Field WatchList

14. Output Inspector

15. Parameter Connections Inspector

15.1. Parameter Connections Inspector View
15.2. Parameter Connections Inspector Context Menu

16. Profiling

16.1. Introduction to Profiling

16.2. Using Profiling

16.2.1. Modules
16.2.2. Fields
16.2.3. Functions

17. Screenshot Gallery

17.1. Screenshot Gallery
17.2. Screenshot Gallery Context Menu
17.3. Movies in the Screenshot Gallery

18. Scripting

18.1. Scripting

18.1.1. Scripting Context Menu

18.2. Scripting Assistant

19. Search in Documentation

20. Snippets List

21. Project Wizard

21.1. Project Wizard Introduction

21.2. Modules (C++) Wizard

21.2.1. First C++ Module Wizard Dialog
21.2.2. Inventor Module
21.2.3. ML Module
21.2.4. WEM Module

21.3. Modules (Scripting) Wizard

21.4. Module Field Interface

21.5. Packages

21.6. Example .Wiz File (Inventor Module), indented for a better readability

22. MeVisLab Advanced Text Editor (MATE)

22.1. What is MATE?

22.2. MATE Text Editor User Interface

22.3. Menu Bar

22.4. Module Menu

22.5. Outline Area

22.6. Edit Area

22.7. Preferences

22.8. MATE as Python Debugger

22.9. MATE as Module Help Editor

22.9.1. Context Menus
22.9.2. Formatting
22.9.3. How it works

22.10. MATE Shortcuts on Windows and Linux/KDE

22.11. Shortcuts on Mac OS X

23. Shortcuts

23.1. Shortcuts on Windows and Linux/KDE
23.2. Shortcuts under Mac OS X
23.3. Module and Network Handling — Shortcuts and Tricks (All Platforms)

24. Tips and Tricks

24.1. Command-Line Options

24.2. MeVisLabPackageScanner.exe

24.3. EatDicom.exe

24.4. Connecting Inventor Engines to ML Modules

24.5. Using SyncFloat to Reduce System Load

24.5.1. Case 1: Two Inventor and one ML module connected in a circle
24.5.2. Case 2: A macro module (including an Inventor module) and another Inventor module connected in a circle

24.6. Printing MeVisLab Networks

24.7. Multithreading in MeVisLab

24.7.1. ML Multithreading
24.7.2. Background Tasks
24.7.3. Modules for Multithreading

24.8. Set Open Inventor Override Flag (Inventor Modules)

25. Coding Style Guide

25.1. General Rules

25.2. Naming Conventions

25.2.1. Code
25.2.2. Files
25.2.3. MeVisLab/ML Identifiers
25.2.4. MDL Layout

25.3. General Programming

25.5. Python

25.6. ML Programming

List of Figures

2.1. Typical MeVisLab User Interface
2.2. View Docked in the Views Area
2.3. Floating View
2.4. Moving View to Another Position in Views Area
2.5. Stacked Views
2.6. Resizing a View in the Views Area
3.1. Example Network for SynchroView2D with Viewer (Panel), Automatic Panel and Settings
3.2. View2D with Connected "Invisible" Open Inventor Connector
3.3. Parameter Connection — Panel Mouseover
3.4. Connector Image Preview
3.5. Connector Detail Info and Image Preview
3.6. Halo Appearances — Classic and Alternative
3.7. Alternative Halo with Changed Colors
3.8. Highlighting of Selections — Classic Halo
3.9. Highlighting of Selections — Alternative Halo
3.10. Nodes and Groups with Alternative Halo — Selected and Highlighted
3.11. Preview of Internal Networks of Macro Modules
3.12. Module Context Menu
3.13. Module Context Menu — Show Window
3.14. Automatic Panel
3.15. Panel Defined in MDL
3.16. Module Context Menu — Edit Instance Name
3.17. Modules and Instance Names
3.18. Module Context Menu — Help
3.19. Module Context Menu — Debugging
3.20. Run Tests — Test Selection
3.21. Run Module Tests — Reports
3.22. Show DLL Dependency
3.23. Module Context Menu — Related Files
3.24. View3D With Visible Inventor Inputs (Default)
3.25. View3D With Hidden Inventor Inputs
3.26. RegionGrowingMacro — Internal Network
3.27. Network Context Menu
3.28. Parameter Connection Context Menu
3.29. Module with Internal/Self-Connected Parameter Connection
3.30. Data Connection Context Menu
3.31. Modules in Groups
3.32. Network Context Menu — Adding Groups
3.33. Network Context Menu — Adding to a Specific Group
3.34. Group Context Menu
3.35. Note (expanded)
3.36. Creating a Note
3.37. Note (collapsed)
3.38. Note Context Menu
3.39. Note in a Group
3.40. Mini Map
3.41. Navigating in the Mini Map
3.42. Parent Navigation Frame for Macro Modules
3.43. Parent Navigation Frame Context Menu
3.44. Network Quick Search
3.45. Network Quick Search — Options
3.46. Network Quick Search — Show All Results
3.47. Network Quick Search — Highlight Results
4.1. File Menu
4.2. Local Macro Creation
4.3. Modules Connected to Outer Macros
4.4. Edit Menu (Windows example)
4.5. Align / Distribute
4.6. Preferences — General
4.7. Preferences — Packages
4.8. Preferences — Module Groups
4.9. Preferences — Supportive Programs
4.10. Preferences — Paths
4.11. Preferences — Developer
4.12. Preferences — Python
4.13. Preferences — Network Appearance
4.14. Connector Detail Info and Image Preview
4.15. A Mini Map Example
4.16. A Mini Map of Parent Navigation Frame
4.17. Mini Map in Print (Color) Style
4.18. Halo Appearances — Classic and Alternative
4.19. Preferences — Network Interaction
4.20. Preferences — Panel Appearance
4.21. Preferences — Cout/Cerr Redirection
4.22. Preferences — Symbol Controlled Debugging
4.23. Preferences — Tracing
4.24. Error Test Module
4.25. Modules Menu
4.26. Applications Menu
4.27. Extras Menu
4.28. Module Selection
4.29. Scripting Menu
4.30. View Menu
4.31. View — Layout Submenu
4.32. Store Current Layout
4.33. Edit User Layouts
4.34. View — Toolbars Submenu
4.35. View — Views Submenu
4.36. Networks Menu
4.37. Panels Menu
4.38. Panels Menu — Listing all Open Panels
4.39. Panels Menu — Listing Only Panels of Visible Network
4.40. Panels Menu — Visible Network with Minimized Panels
4.41. Help Menu
5.1. Toolbar
5.2. Quick Search Options
5.3. Quick Search — Info Box
5.4. Quick Search History
6.1. Bottom Bar
7.1. ML Background Tasks
7.2. ML Background Tasks — Context Menu
7.3. ML Background Tasks — Context Menu for Running Processes
7.4. Warning for Running Background Tasks
7.5. Save in Background for GVRVolumeSave
8.1. Debug Output
9.1. Module Browser
10.1. Module Inspector — Fields
10.2. Automatic Panel
10.3. Module Inspector — Edit Boolean
10.4. Module Inspector — Edit Color
10.5. Module Inspector — Edit Text
10.6. Module Inspector — Edit Values
10.7. Module Inspector Fields Context Menu
10.8. Module Inspector — Files
10.9. Module Inspector Files Context Menu
10.10. Module Inspector — Tree
10.11. Module Inspector Tree Context Menu
10.12. Show Available MDL Tags
10.13. Module Inspector — About
10.14. Module Inspector — Related
10.15. Module Inspector Related Context Menu
10.16. Module Inspector — Scripting
11.1. Module List
12.1. Module Search with Demo Entry
12.2. Module Search — Advanced
12.3. Module Search — Searching In
12.4. Module Search — Operators
12.5. Module Search Results — Context Menu
12.6. Search in Network
13.1. Network Field WatchList
14.1. ML LUT Inspector
14.2. Curve Inspector
14.3. MarkerList Inspector
15.1. Parameter Connections Inspector View
15.2. Parameter Connection Example — View2D and View3D
15.3. Parameter Connection Example — View2DExtensions
15.4. Parameter Connection Example — Navigating between Fields
15.5. Parameter Connections Inspector Context Menu
16.1. Functions to be profiled
16.2. Profiling
16.3. Profiling Report
16.4. Profiling Modules
16.5. Profiling — Heading Configuration
16.6. Count
16.7. Profiling Fields
16.8. Profiling Functions as Flat Profile
16.9. Profiling Functions as Call Graph
16.10. Functions with Filters Visible
17.1. Screenshot Gallery
17.2. Screenshot Gallery Context Menu
17.3. Screenshot Gallery with Movie Preview
18.1. Scripting Editor
18.2. Scripting Example
18.3. Scripting Context Menu
18.4. Scripting Editor
19.1. Search in Documentation
19.2. Search in Documentation — Help Window
19.3. Search in Documentation — ML Example
19.4. Search in Documentation — MDL Example
19.5. Search in Documentation — Python Example
20.1. Snippets List
20.2. Snippets List — Context Menu
21.1. Project Wizard (no user packages available)
21.2. Project Wizard (with user packages available)
21.3. First C++ Module Wizard Dialog — ML Module Example
21.4. Inventor Type
21.5. Imaging Module Properties (New Style)
21.6. New Style ML Module
21.7. New Style ML Module — Uses Fixed Datatype
21.8. New Style ML Module — Uses Datatype Of Input Image
21.9. New Style ML Module — Entering The Supported Types
21.10. New Style ML Module — Configuring The Input Handling
21.11. New Style ML Module — Uses The Same Datatype As
21.12. Imaging Module Properties (Classic Style)
21.13. Additional ML Module Properties
21.14. WEM Wizard
21.15. Project Wizard
21.16. Module Field Interfaces
21.17. Package Wizard
22.1. MATE User Interface
22.2. MATE View Menu
22.3. MATE Module Menu — Without Attached Module
22.4. MATE Module Menu - With Attached Module
22.5. MATE Module Menu — Windows Submenu
22.6. MATE Module Menu — Files Submenu
22.7. Outline Area
22.8. MATE Edit Area
22.9. MATE Edit Area — Code Completion for Keywords
22.10. MATE Edit Area — Code Completion for Commands Defined in MDL
22.11. MATE Edit Area — Context Menu
22.12. MATE Preferences
22.13. MATE with Python Debugger
22.14. Debug Menu
22.15. MATE for Module Help
22.16. Outline Context Menu
22.17. Text Context Menu
22.18. Automatically Documented Elements
24.1. Command-Line Options Window in Windows
24.2. MeVisLabPackageScanner Help
24.3. Excerpt of the EatDicom help
24.4. Dicom Import Log
24.5. DicomImport Module and Panel
24.6. Field Bridge Example
24.7. SyncFloat Example — ML and Inventor Modules
24.8. SyncFloat Example — Macro and Inventor Modules
24.9. Open Inventor Scene Without Override
24.10. Open Inventor Scene With Override
24.11. Open Inventor Scene With Ignore Flag (Red)
24.12. Open Inventor Scene With Ignore Flag (Blue)

List of Tables

1.1. List of MeVisLab Documents
3.1. Module Types
3.2. Invalid Modules
3.3. Connectors
3.4. Connections
3.5. Mouse Pointers
3.6. Mouseover Information
15.1. Connections Symbols
16.1. Function Type Icons
22.1. Buttons for Debugging
22.2. Icons for Debugging
22.3. Help Toolbar Buttons
22.4. Inline markup
22.5. Directives
22.6. Roles
22.7. MATE Shortcuts File Menu (Windows/Linux)
22.8. MATE Shortcuts Edit Menu (Windows/Linux)
22.9. MATE Shortcuts Help Editor (Windows/Linux)
22.10. MATE Shortcuts Debugging (Windows, from Visual Studio)
22.11. MATE Shortcuts Debugging (Linux, from Codeblocks)
22.12. MATE Shortcuts Application Menu (Mac OS X)
22.13. MATE Shortcuts File Menu (Mac OS X)
22.14. MATE Shortcuts Edit Menu (Mac OS X)
22.15. MATE Shortcuts Debugging (Mac OS X, from XCode)
23.1. Shortcuts File Menu (Windows/Linux)
23.2. Shortcuts Edit Menu (Windows/Linux)
23.3. Shortcuts Scripting Menu (Windows/Linux)
23.4. Shortcuts Networks Menu (Windows/Linux)
23.5. Shortcuts Panels Menu (Windows/Linux)
23.6. Shortcuts Help Menu (Windows/Linux)
23.7. Other Shortcuts (Windows/Linux)
23.8. Shortcuts Application Menu (Mac OS X)
23.9. Shortcuts File Menu (Mac OS X)
23.10. Shortcuts Edit Menu (Mac OS X)
23.11. Shortcuts Scripting Menu (Mac OS X)
23.12. Shortcuts Networks Menu (Mac OS X)
23.13. Shortcuts Panels Menu (Mac OS X)
23.14. Shortcuts Help Menu (Mac OS X)
23.15. Other Shortcuts (Mac OS X)
23.16. Module Level
23.17. Mini Map
23.18. Parent Navigation Frame (PNF)
23.19. Network
23.20. Connections and Connectors
23.21. Groups
23.22. Notes
24.1. Command-Line Options

© 2011 MeVis Medical Solutions AG


		Chapter 1. Introduction