Structure of the manual

• Introduction
  • About us
  • Licensing
    • itom Licensing
    • itom Exception
    • Package Licences
• Installation
  • Minimum system requirements
  • Installation from setup
    • Windows Setup Installation
  • Build from Sources
    • Build dependencies
      • Software packages
      • Detailed information
    • Get sources from Git
    • Build with CMake
      • Concept of CMake
      • Generating itom using CMake
      • Generating any plugin or designer-plugin using CMake
      • Update CMake
      • Additional third-party libraries
        • FFTW
        • GLEW
      • Known problems during CMake configuration
    • Build on linux
      • Necessary packages
      • Recommended folder structure
      • Obtain the sources
      • Configuration process
      • Build plugins
    • Build on Mac OS X
      • Xcode
      • CMake
      • Homebrew
      • Dependencies
      • Python 3
      • Recommended folder structure
      • Obtain the sources
      • Configuration process
      • Build plugins
      • Known Problems
        • PyPort bug
        • python3 not available in Terminal
        • pip install fails with TypeError: unorderable types: str() < NoneType()
  • Plugins, Designer-Plugins
  • All-In-One development setup
    • All-In-One development setup
      • Prerequisites for the development setup
      • Get and install the setup
  • Get this help
    • Build documentation
      • Necessary tools
      • Run doxygen
      • Run Sphinx
      • Show documentation in itom
    • Plugin documentation
      • Create the plugin documentation of any plugin
      • plugin documentation source files
• Getting Started
  • Quick Start
    • The GUI
    • Connect to a hardware plugin using the GUI
    • Scripting
      • Hello World!
      • Get a camera snapshot
        • Step 1: Open the camera
        • Step 2: Get the list of parameters
        • Step 3: Setting Parameters
        • Step 4: Getting Parameters
        • Step 5: Taking a snapshot
        • Step 6: Displaying the image
        • Step 7: Stop/delete the camera
        • Alternative Step 1: Open the camera
      • Apply a median-filter to a snap shot
        • Step 1: Open a script editor window
        • Step 2: Write a simple snap routine
        • Step 3: Retrieve the call for the median filter
        • Step 4: Insert the filter-call into the script
        • Step 5: Add plot commands
        • Step 5: Run the script
      • Getting online help
  • Further Information
  • Tutorials
• The itom User Interface
  • Main Window
    • Command Line
    • Main menus and toolbars
    • Toolboxes
      • Global and Local Workspace
      • Plugins
      • File System
      • Breakpoints
      • Command History
      • Call Stack
  • Script-Editor
    • Basic functions
    • Run or debug the script
    • Breakpoints
    • Syntax highlighting and auto completion
    • Direction class and method navigator
    • Automatic syntax check
    • Icon-Browser
  • Property Dialog
    • General
      • Application
      • Help Viewer
        • Local and remote databases
        • Generated help files
      • Language
    • Console
      • Command History
      • Line Wrap
    • Python
      • Startup
    • Editor
      • API
      • Auto Completion
      • Calltips
      • General
      • Styles
    • Plots and Figures
      • Default Plots
  • Python Package Manager
    • Package Sources
• Plots and Figures
  • Quick tutorial to plots and figures
    • Plots of data objects
    • Live images of cameras and grabbers
    • Properties of plots
  • Figure Management
    • itom.figure.plot
    • itom.figure.liveImage
  • line plots (1D)
    • Properties
    • Signals
    • Slots
      • Deprecated figures
  • 2D image plots
    • Itom2dQwtPlot
      • Properties
      • Signals
      • Slots
    • GraphicViewPlot
      • Properties
      • Slots
      • Signals
    • Deprecated figures
  • isometric Plot
    • Properties
    • Slots
      • Deprecated figures
  • Primitives - Marking and Measuring
    • Drawing items into a Qwt-Plot
    • Script based pick and plot from / to a Qwt-widget
    • Implemented Functions, Signals and Slots
    • Indexing for Geometric Elements
    • Evaluation of Geometric Elements
    • Demo Scripts and Examples
  • Matplotlib
• Extending the user interface of itom
  • Customize the menu and toolbars of itom
    • Add toolbars and buttons
    • Create menus
    • Icons in user-defined toolbars and menus
  • Show messages, input boxes and default dialogs
    • Message boxes
    • Input boxes
      • Integer input box
      • Double input box
      • Text input box
      • Option selection dialog
    • Standard dialogs
      • Indicate existing directory
      • OpenFileName-Dialog
      • SaveFileName-Dialog
  • Creating advanced dialogs and windows
    • Qt Designer
      • Widget Library
    • Loading user interface in itom
      • Widget embedded in itom-dialog (TYPEDIALOG)
      • Main window or dialog (TYPEWINDOW)
      • Main window or widget as dockable toolbox (TYPEDOCKWIDGET)
    • Accessing control elements
    • Getting and setting properties
    • Supported datatypes
    • Connecting signals
    • Calling slots
    • Connecting internal signals and slots in Qt Designer
    • Auto-connecting signals using python decorators
    • Debugging user interfaces and slot-methods
    • Access the status bar of a main window
    • Hints and limitations
  • Custom Designer Widgets
    • DataObjectTable
      • Properties
    • dObMetaDataTable
      • Properties
    • EvaluateGeometricsFigure
      • Properties
      • Slots
      • Signals
    • MotorController
      • Properties
      • Slots
      • Signals
  • Implement a more complex GUI in a plugin (C/C++)
• Plugins
  • Basic concept
  • How to start and use a plugin
    • Hardware Plugins
      • Script-based startup
      • GUI-based startup
  • Development under C++
    • RetVal - The return type of itom methods
    • ItomSharedSemaphore
      • Scheme of the inter-thread communication
    • DataObject
      • Creating a data object
      • Addressing the elements of a data object
        • Direct access of one single element of a Data Object using at<_Tp>() method
        • Addressing elements of a data object using row pointer
        • Assigning a single value to all elements of a data object
        • Direct access to the underlying cv::Mat
        • Accessing all elements of a data object using iterators
      • Working with data objects
        • Creating Eye Matrix
        • Creating Ones Matrix
        • Creating Zeros Matrix
        • Adjusting ROI of a Data Object
        • Setting and Getting Axis Units
        • Setting and Getting Axis Scale
      • Copy data into an existing data object
      • Operations on data objects
        • Adjugate of a data object
        • Transpose a data object
        • Squeeze a data object
        • Basic operators with data objects
          • Arithmetic operators
          • Comparison operators
          • Shift operators
          • Bitwise operations
          • Combination of different operators
    • Parameter-Container class of itom
      • Introduction
      • ParamBase and Param and the Meta-classes
      • Usage and differences of the classes ParamBase and Param
      • Types and flags
      • Class ParamBase
      • Class Param
    • Parameters - Meta Information
      • Class ParamMeta
      • Class CharMeta, IntMeta and DoubleMeta
      • Class CharArrayMeta, IntArrayMeta and DoubleArrayMeta
      • Class StringMeta
      • Class DObjMeta
      • Class HWMeta
    • Parameters - Validation
      • Validation with respect to given meta information
      • Overall validation methods
    • Introduction to plugins
      • Plugin load mechanism of itom
      • Basic plugin structure
      • Communication between itom, Python and each plugin
    • Plugin interface class
      • The constructor of the plugin interface class
      • Method getAddInInst of the plugin interface class
      • Method closeThisInst of the plugin interface class
    • Plugin class - Basic information
      • Common components for actuator and dataIO plugins
      • Plugin-Framework
        • Constructor
        • Destructor
        • Init
        • Close
        • getParam
        • setParam
      • Extend your plugin by registering further functions
      • Possible parameter names for parameter-map m_params
    • Plugin class - DataIO
      • Base idea behind any DataIO
      • Grabber plugin
        • Parameters and Unit Conventions
      • AD-Converters
      • RawIO-Plugins
    • Plugin class - Actuator
      • Base idea of any actuator
      • Programming steps
      • Actuator plugin class
      • Signalling the current position and status of any axes
      • Interruption of movement
      • Parameters and Unit Conventions
    • Plugin class - Algo
      • Plugin-Structure
      • Factory-Class
      • Plugin-Class
      • Filter-Methods
      • Widget-Method (GUI-Extensions)
      • Publish Filter- and Widget-Methods at Initialization
        • Algorithm Categories and Interfaces
          • Algorithm Categories
          • Algorithm Interfaces
            • iNotSpecified
            • iReadDataObject
            • iWriteDataObject
            • iReadPointCloud
            • iWritePointCloud
            • iReadPolygonMesh
            • iWritePolygonMesh
          • Definition of new algorithm interfaces
      • Finish and close plugin
    • Create a new plugin via CMake
      • Templates
      • Generate project
    • Automatic loading and saving of plugin parameters
    • itom API
      • Initialization
      • Usage
    • Link or load external libraries
      • Link to a static library
      • Link to a shared library
      • Load external library at runtime
    • Project settings for plugins
      • Prerequisites
      • General settings
      • Qt-dependent settings
      • Include settings
      • Linker settings
    • Optional dock widget (toolbox) for hardware plugins
      • Base idea behind the toolbox
      • User Interface Design
      • Necessary Source Code
      • Special functions for actuators
      • Prepare the plugin for the toolbox
    • Optional configuration dialog for hardware plugins
      • Base idea behind the config dialog
      • User Interface Design
      • Necessary Source Code
      • Implement the config dialog in the plugin
• Python scripting language
  • Introduction
    • Python tutorial
      • Creating a project folder and run a first program
        • Create a project folder
        • Creating a .py file and running it
        • Encoding of files
      • Variables and names
        • Using variables
      • Strings and text
        • Strings
        • String formatting
        • More on strings
        • Byte array....
      • Dictionaries, Lists and Tuples
        • Dictionaries
          • Defining Dictionaries
          • Modifying Dictionaries
          • Deleting Items From Dictionaries
        • Lists
          • Defining Lists
          • Negative List Indices
          • Slicing a List
          • Adding Elements to Lists
          • Difference between append und extend
          • Searching Lists
          • Deleting List Elements
          • Using List Operators
        • Tuples
      • If and else statements
        • if Statements
      • Loops and Lists
        • for Statements
        • The range Function
        • break and continue Statements, and else Clauses on Loops
      • Classes and Objects
        • Classes
          • A Word About Names and Objects
          • Python Scopes and Namespaces
      • Scopes and Namespaces Example
      • Class Definition Syntax
      • Class Objects
      • Instance Objects
      • Method Objects
      • Multiple Inheritance
      • Functions
        • Defining Functions
          • More on Defining Functions
      • Default Argument Values
      • Keyword Arguments
      • Arbitrary Argument Lists
      • Unpacking Argument Lists
      • Lambda Forms
      • Documentation Strings
      • Modules
        • Import Modules
        • Reload Modules in itom
        • path Variablen
        • itom-packages Folder
          • More on Modules
      • Executing modules as scripts
      • The Module Search Path
      • “Compiled” Python files
      • Importing * From a Package
      • Intra-package References
      • Packages in Multiple Directories
      • Prompting and passing
      • Reading and writing files
    • Python Limitations in itom
    • Python - common problems and solutions
      • Re-Assigning a variable
      • Variable deleted but referenced object is not closed
      • Codec error
    • Reload modified modules
  • Python module itom
    • Python-Module itom
      • Import itom
      • Content of itom
        • DataObject
          • Introduction
          • Creating a dataObject
        • npDataObject
        • Plugin-Interface and Plugins
    • Load and save images and other files
      • Native file formats
      • Plugin-based file formats
      • Image file formats
    • Glossary
  • Further python packages
    • Python-Module numpy
    • Python-Module scipy
    • Python-Module matplotlib
      • Set Matplotlib backend to itom
      • Simple Matplotlib example
      • Embedding a matplotlib figure in your own user interface
  • Tutorials, documentations about Python 3
• itom Script Reference
  • itom methods
    • Plotting and camera
    • Using algorithms and filters
    • Methods for getting help and information about filters, plugins, ui-elements, ...
    • Adding elements to the GUI
    • Disk-IO
    • Debug-Tools
    • Further commands
  • dataIO
  • actuator
  • Algorithms, Widgets and Filters
  • figure
  • plotItem
  • ui-elements (ui, uiItem)
    • uiItem-Class
    • ui-Class
  • dataObject
  • point
  • pointCloud
  • polygonMesh
  • region
  • rgba
  • autoInterval
  • timer
    • timer-Class
  • font
• Miscellaneous
  • How to use the help
    • Rebuild the Help
  • Units and Conventions
    • General
    • Physical Units
• Demo scripts
  • itom Basics
  • Plugins
  • Algorithm / Filter
  • ui