diff --git a/Documentation/Doxygen/3-DeveloperManual/Toolkit/ModuleManuals/MITKModuleManualsList.dox b/Documentation/Doxygen/3-DeveloperManual/Toolkit/ModuleManuals/MITKModuleManualsList.dox
index 032c372b88..015179e6e2 100644
--- a/Documentation/Doxygen/3-DeveloperManual/Toolkit/ModuleManuals/MITKModuleManualsList.dox
+++ b/Documentation/Doxygen/3-DeveloperManual/Toolkit/ModuleManuals/MITKModuleManualsList.dox
@@ -1,28 +1,28 @@
/**
\page MITKModuleManualsListPage MITK Module Manuals
\section MITKModuleManualsListPageOverview Overview
The modules are shared libraries that provide functionality that can be used by developers.
\section MITKModuleManualsListPageModuleManualList List of Module Manuals
- \li \subpage IGTGeneralModulePage
+ \li \subpage NavigationGeneralModulePage
\li \subpage MitkOpenCL_Overview
\li \subpage LegacyGLModule
\li \subpage GeneratingDeviceModulesPage
\li \subpage mitkPython_Overview
\li \subpage USModulePage
\li \subpage OverlaysModulePage
\section MITKModuleManualsListPageAdditionalInformation Additional Information on Certain Modules
\li \ref PlanarPropertiesPage
\li \subpage DiffusionImagingPropertiesPage
\li \subpage ConnectomicsRenderingPropertiesPage
\section MITKMigrationGuides Migration Guides
\li \subpage InteractionMigration
\li \subpage GeometryMigration
*/
diff --git a/Documentation/doxygen.conf.in b/Documentation/doxygen.conf.in
index 55553ce692..106d07c5f2 100644
--- a/Documentation/doxygen.conf.in
+++ b/Documentation/doxygen.conf.in
@@ -1,2453 +1,2455 @@
# Doxyfile 1.8.8
# This file describes the settings to be used by the documentation system
# doxygen (www.doxygen.org) for a project.
#
# All text after a double hash (##) is considered a comment and is placed in
# front of the TAG it is preceding.
#
# All text after a single hash (#) is considered a comment and will be ignored.
# The format is:
# TAG = value [value, ...]
# For lists, items can also be appended using:
# TAG += value [value, ...]
# Values that contain spaces should be placed between quotes (\" \").
#---------------------------------------------------------------------------
# Project related configuration options
#---------------------------------------------------------------------------
# This tag specifies the encoding used for all characters in the config file
# that follow. The default is UTF-8 which is also the encoding used for all text
# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
# for the list of possible encodings.
# The default value is: UTF-8.
DOXYFILE_ENCODING = UTF-8
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
# double-quotes, unless you are using Doxywizard) that should identify the
# project for which the documentation is generated. This name is used in the
# title of most generated pages and in a few other places.
# The default value is: My Project.
PROJECT_NAME = "Medical Imaging Interaction Toolkit"
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
# could be handy for archiving the generated documentation or if some version
# control system is used.
PROJECT_NUMBER = @MITK_VERSION_STRING@
# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a
# quick idea about the purpose of the project. Keep the description short.
PROJECT_BRIEF = "Medical Imaging Interaction Toolkit"
# With the PROJECT_LOGO tag one can specify an logo or icon that is included in
# the documentation. The maximum height of the logo should not exceed 55 pixels
# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
# to the output directory.
PROJECT_LOGO =
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
# into which the generated documentation will be written. If a relative path is
# entered, it will be relative to the location where doxygen was started. If
# left blank the current directory will be used.
OUTPUT_DIRECTORY = @MITK_DOXYGEN_OUTPUT_DIR@
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
# directories (in 2 levels) under the output directory of each output format and
# will distribute the generated files over these directories. Enabling this
# option can be useful when feeding doxygen a huge amount of source files, where
# putting all generated files in the same directory would otherwise causes
# performance problems for the file system.
# The default value is: NO.
CREATE_SUBDIRS = NO
# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
# characters to appear in the names of generated files. If set to NO, non-ASCII
# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
# U+3044.
# The default value is: NO.
ALLOW_UNICODE_NAMES = NO
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
# documentation generated by doxygen is written. Doxygen will use this
# information to generate all constant output in the proper language.
# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
# Ukrainian and Vietnamese.
# The default value is: English.
OUTPUT_LANGUAGE = English
# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member
# descriptions after the members that are listed in the file and class
# documentation (similar to Javadoc). Set to NO to disable this.
# The default value is: YES.
BRIEF_MEMBER_DESC = YES
# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief
# description of a member or function before the detailed description
#
# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
# brief descriptions will be completely suppressed.
# The default value is: YES.
REPEAT_BRIEF = YES
# This tag implements a quasi-intelligent brief description abbreviator that is
# used to form the text in various listings. Each string in this list, if found
# as the leading text of the brief description, will be stripped from the text
# and the result, after processing the whole list, is used as the annotated
# text. Otherwise, the brief description is used as-is. If left blank, the
# following values are used ($name is automatically replaced with the name of
# the entity):The $name class, The $name widget, The $name file, is, provides,
# specifies, contains, represents, a, an and the.
ABBREVIATE_BRIEF =
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
# doxygen will generate a detailed section even if there is only a brief
# description.
# The default value is: NO.
ALWAYS_DETAILED_SEC = NO
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
# inherited members of a class in the documentation of that class as if those
# members were ordinary class members. Constructors, destructors and assignment
# operators of the base classes will not be shown.
# The default value is: NO.
INLINE_INHERITED_MEMB = NO
# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path
# before files name in the file list and in the header files. If set to NO the
# shortest path that makes the file name unique will be used
# The default value is: YES.
FULL_PATH_NAMES = NO
# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
# Stripping is only done if one of the specified strings matches the left-hand
# part of the path. The tag can be used to show relative paths in the file list.
# If left blank the directory from which doxygen is run is used as the path to
# strip.
#
# Note that you can specify absolute paths here, but also relative paths, which
# will be relative from the directory where doxygen is started.
# This tag requires that the tag FULL_PATH_NAMES is set to YES.
STRIP_FROM_PATH =
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
# path mentioned in the documentation of a class, which tells the reader which
# header file to include in order to use a class. If left blank only the name of
# the header file containing the class definition is used. Otherwise one should
# specify the list of include paths that are normally passed to the compiler
# using the -I flag.
STRIP_FROM_INC_PATH =
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
# less readable) file names. This can be useful is your file systems doesn't
# support long names like on DOS, Mac, or CD-ROM.
# The default value is: NO.
SHORT_NAMES = NO
# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
# first line (until the first dot) of a Javadoc-style comment as the brief
# description. If set to NO, the Javadoc-style will behave just like regular Qt-
# style comments (thus requiring an explicit @brief command for a brief
# description.)
# The default value is: NO.
JAVADOC_AUTOBRIEF = NO
# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
# line (until the first dot) of a Qt-style comment as the brief description. If
# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
# requiring an explicit \brief command for a brief description.)
# The default value is: NO.
QT_AUTOBRIEF = NO
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
# a brief description. This used to be the default behavior. The new default is
# to treat a multi-line C++ comment block as a detailed description. Set this
# tag to YES if you prefer the old behavior instead.
#
# Note that setting this tag to YES also means that rational rose comments are
# not recognized any more.
# The default value is: NO.
MULTILINE_CPP_IS_BRIEF = NO
# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
# documentation from any documented member that it re-implements.
# The default value is: YES.
INHERIT_DOCS = YES
# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a
# new page for each member. If set to NO, the documentation of a member will be
# part of the file/class/namespace that contains it.
# The default value is: NO.
SEPARATE_MEMBER_PAGES = NO
# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
# uses this value to replace tabs by spaces in code fragments.
# Minimum value: 1, maximum value: 16, default value: 4.
TAB_SIZE = 8
# This tag can be used to specify a number of aliases that act as commands in
# the documentation. An alias has the form:
# name=value
# For example adding
# "sideeffect=@par Side Effects:\n"
# will allow you to put the command \sideeffect (or @sideeffect) in the
# documentation, which will result in a user-defined paragraph with heading
# "Side Effects:". You can put \n's in the value part of an alias to insert
# newlines.
ALIASES = "FIXME=\par Fix Me's:\n" \
"BlueBerry=\if BLUEBERRY" \
"endBlueBerry=\endif" \
"bundlemainpage{1}=\page \1" \
"embmainpage{1}=\page \1" \
"github{2}=\2 " \
"deprecatedSince{1}=\xrefitem deprecatedSince\1 \"\" \"Functions deprecated as of \1\" \deprecated (as of \1) " \
"minimumCMakeVersion=@CMAKE_MINIMUM_REQUIRED_VERSION@" \
"minimumQt5Version=@MITK_QT5_MINIMUM_VERSION@" \
"imageMacro{3}=\image html \1 \2 \n \image latex \1 \2 width=\3cm" \
"developersguidemainpage{1}=\page \1 " \
"usersguidemainpage{1}=\page \1 " \
"nondependentPluginLink{3}= \ref \1 \"\3\" "
# This tag can be used to specify a number of word-keyword mappings (TCL only).
# A mapping has the form "name=value". For example adding "class=itcl::class"
# will allow you to use the command class in the itcl::class meaning.
TCL_SUBST =
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
# only. Doxygen will then generate output that is more tailored for C. For
# instance, some of the names that are used will be different. The list of all
# members will be omitted, etc.
# The default value is: NO.
OPTIMIZE_OUTPUT_FOR_C = NO
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
# Python sources only. Doxygen will then generate output that is more tailored
# for that language. For instance, namespaces will be presented as packages,
# qualified scopes will look different, etc.
# The default value is: NO.
OPTIMIZE_OUTPUT_JAVA = NO
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
# sources. Doxygen will then generate output that is tailored for Fortran.
# The default value is: NO.
OPTIMIZE_FOR_FORTRAN = NO
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
# sources. Doxygen will then generate output that is tailored for VHDL.
# The default value is: NO.
OPTIMIZE_OUTPUT_VHDL = NO
# Doxygen selects the parser to use depending on the extension of the files it
# parses. With this tag you can assign which parser to use for a given
# extension. Doxygen has a built-in mapping, but you can override or extend it
# using this tag. The format is ext=language, where ext is a file extension, and
# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
# Fortran. In the later case the parser tries to guess whether the code is fixed
# or free formatted code, this is the default for Fortran type files), VHDL. For
# instance to make doxygen treat .inc files as Fortran files (default is PHP),
# and .f files as C (default is Fortran), use: inc=Fortran f=C.
#
# Note For files without extension you can use no_extension as a placeholder.
#
# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
# the files are not read by doxygen.
EXTENSION_MAPPING = cmake=c++
# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
# according to the Markdown format, which allows for more readable
# documentation. See http://daringfireball.net/projects/markdown/ for details.
# The output of markdown processing is further processed by doxygen, so you can
# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
# case of backward compatibilities issues.
# The default value is: YES.
MARKDOWN_SUPPORT = YES
# When enabled doxygen tries to link words that correspond to documented
# classes, or namespaces to their corresponding documentation. Such a link can
# be prevented in individual cases by by putting a % sign in front of the word
# or globally by setting AUTOLINK_SUPPORT to NO.
# The default value is: YES.
AUTOLINK_SUPPORT = YES
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
# to include (a tag file for) the STL sources as input, then you should set this
# tag to YES in order to let doxygen match functions declarations and
# definitions whose arguments contain STL classes (e.g. func(std::string);
# versus func(std::string) {}). This also make the inheritance and collaboration
# diagrams that involve STL classes more complete and accurate.
# The default value is: NO.
BUILTIN_STL_SUPPORT = YES
# If you use Microsoft's C++/CLI language, you should set this option to YES to
# enable parsing support.
# The default value is: NO.
CPP_CLI_SUPPORT = NO
# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
# will parse them like normal C++ but will assume all classes use public instead
# of private inheritance when no explicit protection keyword is present.
# The default value is: NO.
SIP_SUPPORT = NO
# For Microsoft's IDL there are propget and propput attributes to indicate
# getter and setter methods for a property. Setting this option to YES will make
# doxygen to replace the get and set methods by a property in the documentation.
# This will only work if the methods are indeed getting or setting a simple
# type. If this is not the case, or you want to show the methods anyway, you
# should set this option to NO.
# The default value is: YES.
IDL_PROPERTY_SUPPORT = YES
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
# tag is set to YES, then doxygen will reuse the documentation of the first
# member in the group (if any) for the other members of the group. By default
# all members of a group must be documented explicitly.
# The default value is: NO.
DISTRIBUTE_GROUP_DOC = YES
# Set the SUBGROUPING tag to YES to allow class member groups of the same type
# (for instance a group of public functions) to be put as a subgroup of that
# type (e.g. under the Public Functions section). Set it to NO to prevent
# subgrouping. Alternatively, this can be done per class using the
# \nosubgrouping command.
# The default value is: YES.
SUBGROUPING = YES
# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
# are shown inside the group in which they are included (e.g. using \ingroup)
# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
# and RTF).
#
# Note that this feature does not work in combination with
# SEPARATE_MEMBER_PAGES.
# The default value is: NO.
INLINE_GROUPED_CLASSES = NO
# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
# with only public data fields or simple typedef fields will be shown inline in
# the documentation of the scope in which they are defined (i.e. file,
# namespace, or group documentation), provided this scope is documented. If set
# to NO, structs, classes, and unions are shown on a separate page (for HTML and
# Man pages) or section (for LaTeX and RTF).
# The default value is: NO.
INLINE_SIMPLE_STRUCTS = NO
# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
# enum is documented as struct, union, or enum with the name of the typedef. So
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
# with name TypeT. When disabled the typedef will appear as a member of a file,
# namespace, or class. And the struct will be named TypeS. This can typically be
# useful for C code in case the coding convention dictates that all compound
# types are typedef'ed and only the typedef is referenced, never the tag name.
# The default value is: NO.
TYPEDEF_HIDES_STRUCT = NO
# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
# cache is used to resolve symbols given their name and scope. Since this can be
# an expensive process and often the same symbol appears multiple times in the
# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
# doxygen will become slower. If the cache is too large, memory is wasted. The
# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
# symbols. At the end of a run doxygen will report the cache usage and suggest
# the optimal cache size from a speed point of view.
# Minimum value: 0, maximum value: 9, default value: 0.
LOOKUP_CACHE_SIZE = 0
#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
# documentation are documented, even if no documentation was available. Private
# class members and static file members will be hidden unless the
# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
# Note: This will also disable the warnings about undocumented members that are
# normally produced when WARNINGS is set to YES.
# The default value is: NO.
EXTRACT_ALL = YES
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
# be included in the documentation.
# The default value is: NO.
EXTRACT_PRIVATE = NO
# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
# scope will be included in the documentation.
# The default value is: NO.
EXTRACT_PACKAGE = NO
# If the EXTRACT_STATIC tag is set to YES all static members of a file will be
# included in the documentation.
# The default value is: NO.
EXTRACT_STATIC = YES
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined
# locally in source files will be included in the documentation. If set to NO
# only classes defined in header files are included. Does not have any effect
# for Java sources.
# The default value is: YES.
EXTRACT_LOCAL_CLASSES = @MITK_DOXYGEN_INTERNAL_DOCS@
# This flag is only useful for Objective-C code. When set to YES local methods,
# which are defined in the implementation section but not in the interface are
# included in the documentation. If set to NO only methods in the interface are
# included.
# The default value is: NO.
EXTRACT_LOCAL_METHODS = NO
# If this flag is set to YES, the members of anonymous namespaces will be
# extracted and appear in the documentation as a namespace called
# 'anonymous_namespace{file}', where file will be replaced with the base name of
# the file that contains the anonymous namespace. By default anonymous namespace
# are hidden.
# The default value is: NO.
EXTRACT_ANON_NSPACES = NO
# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
# undocumented members inside documented classes or files. If set to NO these
# members will be included in the various overviews, but no documentation
# section is generated. This option has no effect if EXTRACT_ALL is enabled.
# The default value is: NO.
HIDE_UNDOC_MEMBERS = NO
# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
# undocumented classes that are normally visible in the class hierarchy. If set
# to NO these classes will be included in the various overviews. This option has
# no effect if EXTRACT_ALL is enabled.
# The default value is: NO.
HIDE_UNDOC_CLASSES = NO
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
# (class|struct|union) declarations. If set to NO these declarations will be
# included in the documentation.
# The default value is: NO.
HIDE_FRIEND_COMPOUNDS = @MITK_DOXYGEN_HIDE_FRIEND_COMPOUNDS@
# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
# documentation blocks found inside the body of a function. If set to NO these
# blocks will be appended to the function's detailed documentation block.
# The default value is: NO.
HIDE_IN_BODY_DOCS = NO
# The INTERNAL_DOCS tag determines if documentation that is typed after a
# \internal command is included. If the tag is set to NO then the documentation
# will be excluded. Set it to YES to include the internal documentation.
# The default value is: NO.
INTERNAL_DOCS = @MITK_DOXYGEN_INTERNAL_DOCS@
# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
# names in lower-case letters. If set to YES upper-case letters are also
# allowed. This is useful if you have classes or files whose names only differ
# in case and if your file system supports case sensitive file names. Windows
# and Mac users are advised to set this option to NO.
# The default value is: system dependent.
CASE_SENSE_NAMES = YES
# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
# their full class and namespace scopes in the documentation. If set to YES the
# scope will be hidden.
# The default value is: NO.
HIDE_SCOPE_NAMES = NO
# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
# the files that are included by a file in the documentation of that file.
# The default value is: YES.
SHOW_INCLUDE_FILES = YES
# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
# grouped member an include statement to the documentation, telling the reader
# which file to include in order to use the member.
# The default value is: NO.
SHOW_GROUPED_MEMB_INC = NO
# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
# files with double quotes in the documentation rather than with sharp brackets.
# The default value is: NO.
FORCE_LOCAL_INCLUDES = NO
# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
# documentation for inline members.
# The default value is: YES.
INLINE_INFO = YES
# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
# (detailed) documentation of file and class members alphabetically by member
# name. If set to NO the members will appear in declaration order.
# The default value is: YES.
SORT_MEMBER_DOCS = YES
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
# descriptions of file, namespace and class members alphabetically by member
# name. If set to NO the members will appear in declaration order. Note that
# this will also influence the order of the classes in the class list.
# The default value is: NO.
SORT_BRIEF_DOCS = NO
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
# (brief and detailed) documentation of class members so that constructors and
# destructors are listed first. If set to NO the constructors will appear in the
# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
# member documentation.
# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
# detailed member documentation.
# The default value is: NO.
SORT_MEMBERS_CTORS_1ST = NO
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
# of group names into alphabetical order. If set to NO the group names will
# appear in their defined order.
# The default value is: NO.
SORT_GROUP_NAMES = NO
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
# fully-qualified names, including namespaces. If set to NO, the class list will
# be sorted only by class name, not including the namespace part.
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
# Note: This option applies only to the class list, not to the alphabetical
# list.
# The default value is: NO.
SORT_BY_SCOPE_NAME = YES
# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
# type resolution of all parameters of a function it will reject a match between
# the prototype and the implementation of a member function even if there is
# only one candidate or it is obvious which candidate to choose by doing a
# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
# accept a match between prototype and implementation in such cases.
# The default value is: NO.
STRICT_PROTO_MATCHING = NO
# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the
# todo list. This list is created by putting \todo commands in the
# documentation.
# The default value is: YES.
GENERATE_TODOLIST = @MITK_DOXYGEN_GENERATE_TODOLIST@
# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the
# test list. This list is created by putting \test commands in the
# documentation.
# The default value is: YES.
GENERATE_TESTLIST = YES
# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug
# list. This list is created by putting \bug commands in the documentation.
# The default value is: YES.
GENERATE_BUGLIST = @MITK_DOXYGEN_GENERATE_BUGLIST@
# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)
# the deprecated list. This list is created by putting \deprecated commands in
# the documentation.
# The default value is: YES.
GENERATE_DEPRECATEDLIST= @MITK_DOXYGEN_GENERATE_DEPRECATEDLIST@
# The ENABLED_SECTIONS tag can be used to enable conditional documentation
# sections, marked by \if ... \endif and \cond
# ... \endcond blocks.
ENABLED_SECTIONS = @MITK_DOXYGEN_ENABLED_SECTIONS@
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
# initial value of a variable or macro / define can have for it to appear in the
# documentation. If the initializer consists of more lines than specified here
# it will be hidden. Use a value of 0 to hide initializers completely. The
# appearance of the value of individual variables and macros / defines can be
# controlled using \showinitializer or \hideinitializer command in the
# documentation regardless of this setting.
# Minimum value: 0, maximum value: 10000, default value: 30.
MAX_INITIALIZER_LINES = 0
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
# the bottom of the documentation of classes and structs. If set to YES the list
# will mention the files that were used to generate the documentation.
# The default value is: YES.
SHOW_USED_FILES = YES
# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
# will remove the Files entry from the Quick Index and from the Folder Tree View
# (if specified).
# The default value is: YES.
SHOW_FILES = YES
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
# page. This will remove the Namespaces entry from the Quick Index and from the
# Folder Tree View (if specified).
# The default value is: YES.
SHOW_NAMESPACES = YES
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
# doxygen should invoke to get the current version for each file (typically from
# the version control system). Doxygen will invoke the program by executing (via
# popen()) the command command input-file, where command is the value of the
# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
# by doxygen. Whatever the program writes to standard output is used as the file
# version. For an example see the documentation.
FILE_VERSION_FILTER =
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
# by doxygen. The layout file controls the global structure of the generated
# output files in an output format independent way. To create the layout file
# that represents doxygen's defaults, run doxygen with the -l option. You can
# optionally specify a file name after the option, if omitted DoxygenLayout.xml
# will be used as the name of the layout file.
#
# Note that if you run doxygen from a directory containing a file called
# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
# tag is left empty.
LAYOUT_FILE = @MITK_SOURCE_DIR@/Documentation/MITKDoxygenLayout.xml
# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
# the reference definitions. This must be a list of .bib files. The .bib
# extension is automatically appended if omitted. This requires the bibtex tool
# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
# For LaTeX the style of the bibliography can be controlled using
# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
# search path. See also \cite for info how to create references.
CITE_BIB_FILES =
#---------------------------------------------------------------------------
# Configuration options related to warning and progress messages
#---------------------------------------------------------------------------
# The QUIET tag can be used to turn on/off the messages that are generated to
# standard output by doxygen. If QUIET is set to YES this implies that the
# messages are off.
# The default value is: NO.
QUIET = NO
# The WARNINGS tag can be used to turn on/off the warning messages that are
# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES
# this implies that the warnings are on.
#
# Tip: Turn warnings on while writing the documentation.
# The default value is: YES.
WARNINGS = YES
# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate
# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
# will automatically be disabled.
# The default value is: YES.
WARN_IF_UNDOCUMENTED = YES
# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
# potential errors in the documentation, such as not documenting some parameters
# in a documented function, or documenting parameters that don't exist or using
# markup commands wrongly.
# The default value is: YES.
WARN_IF_DOC_ERROR = YES
# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
# are documented, but have no documentation for their parameters or return
# value. If set to NO doxygen will only warn about wrong or incomplete parameter
# documentation, but not about the absence of documentation.
# The default value is: NO.
WARN_NO_PARAMDOC = NO
# The WARN_FORMAT tag determines the format of the warning messages that doxygen
# can produce. The string should contain the $file, $line, and $text tags, which
# will be replaced by the file and line number from which the warning originated
# and the warning text. Optionally the format may contain $version, which will
# be replaced by the version of the file (if it could be obtained via
# FILE_VERSION_FILTER)
# The default value is: $file:$line: $text.
WARN_FORMAT = "$file:$line: $text"
# The WARN_LOGFILE tag can be used to specify a file to which warning and error
# messages should be written. If left blank the output is written to standard
# error (stderr).
WARN_LOGFILE =
#---------------------------------------------------------------------------
# Configuration options related to the input files
#---------------------------------------------------------------------------
# The INPUT tag is used to specify the files and/or directories that contain
# documented source files. You may enter file names like myfile.cpp or
# directories like /usr/src/myproject. Separate the files or directories with
# spaces.
# Note: If this tag is empty the current directory is searched.
INPUT = @MITK_SOURCE_DIR@ \
@MITK_SOURCE_DIR@/README.md \
@MITK_BINARY_DIR@ \
@MITK_DOXYGEN_ADDITIONAL_INPUT_DIRS@
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
# documentation (see: http://www.gnu.org/software/libiconv) for the list of
# possible encodings.
# The default value is: UTF-8.
INPUT_ENCODING = UTF-8
# If the value of the INPUT tag contains directories, you can use the
# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
# *.h) to filter out the source-files in the directories. If left blank the
# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
# *.qsf, *.as and *.js.
FILE_PATTERNS = *.h \
*.cpp \
*.dox \
*.md \
*.txx \
*.tpp \
*.cxx \
*.cmake
# The RECURSIVE tag can be used to specify whether or not subdirectories should
# be searched for input files as well.
# The default value is: NO.
RECURSIVE = YES
# The EXCLUDE tag can be used to specify files and/or directories that should be
# excluded from the INPUT source files. This way you can easily exclude a
# subdirectory from a directory tree whose root is specified with the INPUT tag.
#
# Note that relative paths are relative to the directory from which doxygen is
# run.
EXCLUDE = @MITK_SOURCE_DIR@/Utilities/IpFunc/ \
@MITK_SOURCE_DIR@/Utilities/IpSegmentation/ \
@MITK_SOURCE_DIR@/Utilities/KWStyle/ \
@MITK_SOURCE_DIR@/Utilities/qtsingleapplication/ \
@MITK_SOURCE_DIR@/Applications/PluginGenerator/ \
@MITK_SOURCE_DIR@/Modules/CppMicroServices/core/doc/snippets/ \
@MITK_SOURCE_DIR@/Modules/CppMicroServices/core/doc/doxygen/standalone/ \
@MITK_SOURCE_DIR@/Modules/CppMicroServices/core/test/ \
@MITK_SOURCE_DIR@/Modules/CppMicroServices/core/examples/ \
@MITK_SOURCE_DIR@/Modules/CppMicroServices/core/src/util/jsoncpp.cpp \
@MITK_SOURCE_DIR@/CMake/PackageDepends \
@MITK_SOURCE_DIR@/CMakeExternals \
@MITK_BINARY_DIR@/Documentation/Doxygen \
@MITK_BINARY_DIR@/bin/ \
@MITK_BINARY_DIR@/PT/ \
@MITK_BINARY_DIR@/GP/ \
@MITK_BINARY_DIR@/Modules/CppMicroServices/ \
@MITK_BINARY_DIR@/_CPack_Packages/ \
@MITK_DOXYGEN_ADDITIONAL_EXCLUDE_DIRS@
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
# directories that are symbolic links (a Unix file system feature) are excluded
# from the input.
# The default value is: NO.
EXCLUDE_SYMLINKS = NO
# If the value of the INPUT tag contains directories, you can use the
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
# certain files from those directories.
#
# Note that the wildcards are matched against the file with absolute path, so to
# exclude all test directories for example use the pattern */test/*
EXCLUDE_PATTERNS = README* \
moc_* \
ui_* \
qrc_* \
wrap_* \
Register* \
*/files.cmake \
*/.git/* \
*_p.h \
*Private.* \
*/Internal/* \
*/internal/* \
*/Snippets/* \
*/snippets/* \
*/testing/* \
*/Testing/* \
@MITK_BINARY_DIR@/*.cmake \
@MITK_DOXYGEN_EXCLUDE_PATTERNS@
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
# (namespaces, classes, functions, etc.) that should be excluded from the
# output. The symbol name can be a fully qualified name, a word, or if the
# wildcard * is used, a substring. Examples: ANamespace, AClass,
# AClass::ANamespace, ANamespace::*Test
#
# Note that the wildcards are matched against the file with absolute path, so to
# exclude all test directories use the pattern */test/*
EXCLUDE_SYMBOLS =
# The EXAMPLE_PATH tag can be used to specify one or more files or directories
# that contain example code fragments that are included (see the \include
# command).
EXAMPLE_PATH = @MITK_SOURCE_DIR@/Documentation/Snippets/ \
@MITK_SOURCE_DIR@/Examples/ \
@MITK_SOURCE_DIR@/Examples/Tutorial/ \
@MITK_SOURCE_DIR@/Examples/Plugins/ \
@MITK_SOURCE_DIR@/Examples/QtFreeRender/ \
@MITK_SOURCE_DIR@/Modules/Core/ \
@MITK_SOURCE_DIR@/Modules/CppMicroServices/core/doc/snippets/ \
@MITK_SOURCE_DIR@/Modules/CppMicroServices/core/examples/ \
@MITK_DOXYGEN_OUTPUT_DIR@/html/extension-points/html/ \
@MITK_SOURCE_DIR@/Modules/OpenCL/Documentation/doxygen/snippets/ \
- @MITK_SOURCE_DIR@/Modules/IGT/Tutorial/
+ @MITK_SOURCE_DIR@/Modules/IGT/Tutorial/ \
+ @MITK_SOURCE_DIR@/Plugins/org.mitk.gui.qt.igtexamples/ \
+ @MITK_SOURCE_DIR@/Plugins/org.mitk.gui.qt.igttracking/
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
# *.h) to filter out the source-files in the directories. If left blank all
# files are included.
EXAMPLE_PATTERNS =
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
# searched for input files to be used with the \include or \dontinclude commands
# irrespective of the value of the RECURSIVE tag.
# The default value is: NO.
EXAMPLE_RECURSIVE = YES
# The IMAGE_PATH tag can be used to specify one or more files or directories
# that contain images that are to be included in the documentation (see the
# \image command).
IMAGE_PATH = @MITK_SOURCE_DIR@/Documentation/Doxygen/ \
@MITK_SOURCE_DIR@
# The INPUT_FILTER tag can be used to specify a program that doxygen should
# invoke to filter for each input file. Doxygen will invoke the filter program
# by executing (via popen()) the command:
#
#
#
# where is the value of the INPUT_FILTER tag, and is the
# name of an input file. Doxygen will then use the output that the filter
# program writes to standard output. If FILTER_PATTERNS is specified, this tag
# will be ignored.
#
# Note that the filter must not add or remove lines; it is applied before the
# code is scanned, but not when the output code is generated. If lines are added
# or removed, the anchors will not be placed correctly.
INPUT_FILTER =
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
# basis. Doxygen will compare the file name with each pattern and apply the
# filter if there is a match. The filters are a list of the form: pattern=filter
# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
# patterns match the file name, INPUT_FILTER is applied.
FILTER_PATTERNS = *.cmake=@CMakeDoxygenFilter_EXECUTABLE@
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
# INPUT_FILTER ) will also be used to filter the input files that are used for
# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
# The default value is: NO.
FILTER_SOURCE_FILES = NO
# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
# it is also possible to disable source filtering for a specific pattern using
# *.ext= (so without naming a filter).
# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
FILTER_SOURCE_PATTERNS =
# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
# is part of the input, its contents will be placed on the main page
# (index.html). This can be useful if you have a project on for instance GitHub
# and want to reuse the introduction page also for the doxygen output.
USE_MDFILE_AS_MAINPAGE = README.md
#---------------------------------------------------------------------------
# Configuration options related to source browsing
#---------------------------------------------------------------------------
# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
# generated. Documented entities will be cross-referenced with these sources.
#
# Note: To get rid of all source code in the generated output, make sure that
# also VERBATIM_HEADERS is set to NO.
# The default value is: NO.
SOURCE_BROWSER = YES
# Setting the INLINE_SOURCES tag to YES will include the body of functions,
# classes and enums directly into the documentation.
# The default value is: NO.
INLINE_SOURCES = NO
# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
# special comment blocks from generated source code fragments. Normal C, C++ and
# Fortran comments will always remain visible.
# The default value is: YES.
STRIP_CODE_COMMENTS = YES
# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
# function all documented functions referencing it will be listed.
# The default value is: NO.
REFERENCED_BY_RELATION = YES
# If the REFERENCES_RELATION tag is set to YES then for each documented function
# all documented entities called/used by that function will be listed.
# The default value is: NO.
REFERENCES_RELATION = YES
# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
# to YES, then the hyperlinks from functions in REFERENCES_RELATION and
# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
# link to the documentation.
# The default value is: YES.
REFERENCES_LINK_SOURCE = YES
# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
# source code will show a tooltip with additional information such as prototype,
# brief description and links to the definition and documentation. Since this
# will make the HTML file larger and loading of large files a bit slower, you
# can opt to disable this feature.
# The default value is: YES.
# This tag requires that the tag SOURCE_BROWSER is set to YES.
SOURCE_TOOLTIPS = YES
# If the USE_HTAGS tag is set to YES then the references to source code will
# point to the HTML generated by the htags(1) tool instead of doxygen built-in
# source browser. The htags tool is part of GNU's global source tagging system
# (see http://www.gnu.org/software/global/global.html). You will need version
# 4.8.6 or higher.
#
# To use it do the following:
# - Install the latest version of global
# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
# - Make sure the INPUT points to the root of the source tree
# - Run doxygen as normal
#
# Doxygen will invoke htags (and that will in turn invoke gtags), so these
# tools must be available from the command line (i.e. in the search path).
#
# The result: instead of the source browser generated by doxygen, the links to
# source code will now point to the output of htags.
# The default value is: NO.
# This tag requires that the tag SOURCE_BROWSER is set to YES.
USE_HTAGS = NO
# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
# verbatim copy of the header file for each class for which an include is
# specified. Set to NO to disable this.
# See also: Section \class.
# The default value is: YES.
VERBATIM_HEADERS = YES
#---------------------------------------------------------------------------
# Configuration options related to the alphabetical class index
#---------------------------------------------------------------------------
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
# compounds will be generated. Enable this if the project contains a lot of
# classes, structs, unions or interfaces.
# The default value is: YES.
ALPHABETICAL_INDEX = YES
# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
# which the alphabetical index list will be split.
# Minimum value: 1, maximum value: 20, default value: 5.
# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
COLS_IN_ALPHA_INDEX = 3
# In case all classes in a project start with a common prefix, all classes will
# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
# can be used to specify a prefix (or a list of prefixes) that should be ignored
# while generating the index headers.
# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
IGNORE_PREFIX =
#---------------------------------------------------------------------------
# Configuration options related to the HTML output
#---------------------------------------------------------------------------
# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
# The default value is: YES.
GENERATE_HTML = YES
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
# it.
# The default directory is: html.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_OUTPUT = html
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
# generated HTML page (for example: .htm, .php, .asp).
# The default value is: .html.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_FILE_EXTENSION = .html
# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
# each generated HTML page. If the tag is left blank doxygen will generate a
# standard header.
#
# To get valid HTML the header file that includes any scripts and style sheets
# that doxygen needs, which is dependent on the configuration options used (e.g.
# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
# default header using
# doxygen -w html new_header.html new_footer.html new_stylesheet.css
# YourConfigFile
# and then modify the file new_header.html. See also section "Doxygen usage"
# for information on how to generate the default header that doxygen normally
# uses.
# Note: The header is subject to change so you typically have to regenerate the
# default header when upgrading to a newer version of doxygen. For a description
# of the possible markers and block names see the documentation.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_HEADER =
# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
# generated HTML page. If the tag is left blank doxygen will generate a standard
# footer. See HTML_HEADER for more information on how to generate a default
# footer and what special commands can be used inside the footer. See also
# section "Doxygen usage" for information on how to generate the default footer
# that doxygen normally uses.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_FOOTER =
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
# sheet that is used by each HTML page. It can be used to fine-tune the look of
# the HTML output. If left blank doxygen will generate a default style sheet.
# See also section "Doxygen usage" for information on how to generate the style
# sheet that doxygen normally uses.
# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
# it is more robust and this tag (HTML_STYLESHEET) will in the future become
# obsolete.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_STYLESHEET =
# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
# cascading style sheets that are included after the standard style sheets
# created by doxygen. Using this option one can overrule certain style aspects.
# This is preferred over using HTML_STYLESHEET since it does not replace the
# standard style sheet and is therefor more robust against future updates.
# Doxygen will copy the style sheet files to the output directory.
# Note: The order of the extra stylesheet files is of importance (e.g. the last
# stylesheet in the list overrules the setting of the previous ones in the
# list). For an example see the documentation.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_EXTRA_STYLESHEET = @MITK_DOXYGEN_STYLESHEET@
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
# other source files which should be copied to the HTML output directory. Note
# that these files will be copied to the base HTML output directory. Use the
# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
# files will be copied as-is; there are no commands or markers available.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_EXTRA_FILES = @MITK_SOURCE_DIR@/Documentation/Doxygen/mitkLogo.jpg
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
# will adjust the colors in the stylesheet and background images according to
# this color. Hue is specified as an angle on a colorwheel, see
# http://en.wikipedia.org/wiki/Hue for more information. For instance the value
# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
# purple, and 360 is red again.
# Minimum value: 0, maximum value: 359, default value: 220.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_COLORSTYLE_HUE = 220
# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
# in the HTML output. For a value of 0 the output will use grayscales only. A
# value of 255 will produce the most vivid colors.
# Minimum value: 0, maximum value: 255, default value: 100.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_COLORSTYLE_SAT = 100
# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
# luminance component of the colors in the HTML output. Values below 100
# gradually make the output lighter, whereas values above 100 make the output
# darker. The value divided by 100 is the actual gamma applied, so 80 represents
# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
# change the gamma.
# Minimum value: 40, maximum value: 240, default value: 80.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_COLORSTYLE_GAMMA = 80
# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
# page will contain the date and time when the page was generated. Setting this
# to NO can help when comparing the output of multiple runs.
# The default value is: YES.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_TIMESTAMP = YES
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
# documentation will contain sections that can be hidden and shown after the
# page has loaded.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_DYNAMIC_SECTIONS = @MITK_DOXYGEN_HTML_DYNAMIC_SECTIONS@
# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
# shown in the various tree structured indices initially; the user can expand
# and collapse entries dynamically later on. Doxygen will expand the tree to
# such a level that at most the specified number of entries are visible (unless
# a fully collapsed tree already exceeds this amount). So setting the number of
# entries 1 will produce a full collapsed tree by default. 0 is a special value
# representing an infinite number of entries and will result in a full expanded
# tree by default.
# Minimum value: 0, maximum value: 9999, default value: 100.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_INDEX_NUM_ENTRIES = 100
# If the GENERATE_DOCSET tag is set to YES, additional index files will be
# generated that can be used as input for Apple's Xcode 3 integrated development
# environment (see: http://developer.apple.com/tools/xcode/), introduced with
# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
# Makefile in the HTML output directory. Running make will produce the docset in
# that directory and running make install will install the docset in
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
# for more information.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_DOCSET = NO
# This tag determines the name of the docset feed. A documentation feed provides
# an umbrella under which multiple documentation sets from a single provider
# (such as a company or product suite) can be grouped.
# The default value is: Doxygen generated docs.
# This tag requires that the tag GENERATE_DOCSET is set to YES.
DOCSET_FEEDNAME = "Doxygen generated docs"
# This tag specifies a string that should uniquely identify the documentation
# set bundle. This should be a reverse domain-name style string, e.g.
# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
# The default value is: org.doxygen.Project.
# This tag requires that the tag GENERATE_DOCSET is set to YES.
DOCSET_BUNDLE_ID = org.doxygen.Project
# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
# the documentation publisher. This should be a reverse domain-name style
# string, e.g. com.mycompany.MyDocSet.documentation.
# The default value is: org.doxygen.Publisher.
# This tag requires that the tag GENERATE_DOCSET is set to YES.
DOCSET_PUBLISHER_ID = org.doxygen.Publisher
# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
# The default value is: Publisher.
# This tag requires that the tag GENERATE_DOCSET is set to YES.
DOCSET_PUBLISHER_NAME = Publisher
# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
# Windows.
#
# The HTML Help Workshop contains a compiler that can convert all HTML output
# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
# files are now used as the Windows 98 help format, and will replace the old
# Windows help format (.hlp) on all Windows platforms in the future. Compressed
# HTML files also contain an index, a table of contents, and you can search for
# words in the documentation. The HTML workshop also contains a viewer for
# compressed HTML files.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_HTMLHELP = NO
# The CHM_FILE tag can be used to specify the file name of the resulting .chm
# file. You can add a path in front of the file if the result should not be
# written to the html output directory.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
CHM_FILE =
# The HHC_LOCATION tag can be used to specify the location (absolute path
# including file name) of the HTML help compiler ( hhc.exe). If non-empty
# doxygen will try to run the HTML help compiler on the generated index.hhp.
# The file has to be specified with full path.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
HHC_LOCATION =
# The GENERATE_CHI flag controls if a separate .chi index file is generated (
# YES) or that it should be included in the master .chm file ( NO).
# The default value is: NO.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
GENERATE_CHI = NO
# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)
# and project file content.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
CHM_INDEX_ENCODING =
# The BINARY_TOC flag controls whether a binary table of contents is generated (
# YES) or a normal table of contents ( NO) in the .chm file. Furthermore it
# enables the Previous and Next buttons.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
BINARY_TOC = NO
# The TOC_EXPAND flag can be set to YES to add extra items for group members to
# the table of contents of the HTML help documentation and to the tree view.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
TOC_EXPAND = NO
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
# (.qch) of the generated HTML documentation.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_QHP = @MITK_DOXYGEN_GENERATE_QHP@
# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
# the file name of the resulting .qch file. The path specified is relative to
# the HTML output folder.
# This tag requires that the tag GENERATE_QHP is set to YES.
QCH_FILE = @MITK_DOXYGEN_QCH_FILE@
# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
# Project output. For more information please see Qt Help Project / Namespace
# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
# The default value is: org.doxygen.Project.
# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_NAMESPACE = "org.mitk"
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
# Help Project output. For more information please see Qt Help Project / Virtual
# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
# folders).
# The default value is: doc.
# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_VIRTUAL_FOLDER = MITK
# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
# filter to add. For more information please see Qt Help Project / Custom
# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
# filters).
# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_CUST_FILTER_NAME =
# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
# custom filter to add. For more information please see Qt Help Project / Custom
# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
# filters).
# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_CUST_FILTER_ATTRS =
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
# project's filter section matches. Qt Help Project / Filter Attributes (see:
# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_SECT_FILTER_ATTRS =
# The QHG_LOCATION tag can be used to specify the location of Qt's
# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
# generated .qhp file.
# This tag requires that the tag GENERATE_QHP is set to YES.
QHG_LOCATION = @QT_HELPGENERATOR_EXECUTABLE@
# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
# generated, together with the HTML files, they form an Eclipse help plugin. To
# install this plugin and make it available under the help contents menu in
# Eclipse, the contents of the directory containing the HTML and XML files needs
# to be copied into the plugins directory of eclipse. The name of the directory
# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
# After copying Eclipse needs to be restarted before the help appears.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_ECLIPSEHELP = NO
# A unique identifier for the Eclipse help plugin. When installing the plugin
# the directory name containing the HTML and XML files should also have this
# name. Each documentation set should have its own identifier.
# The default value is: org.doxygen.Project.
# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
ECLIPSE_DOC_ID = org.doxygen.Project
# If you want full control over the layout of the generated HTML pages it might
# be necessary to disable the index and replace it with your own. The
# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
# of each HTML page. A value of NO enables the index and the value YES disables
# it. Since the tabs in the index contain the same information as the navigation
# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
DISABLE_INDEX = NO
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
# structure should be generated to display hierarchical information. If the tag
# value is set to YES, a side panel will be generated containing a tree-like
# index structure (just like the one that is generated for HTML Help). For this
# to work a browser that supports JavaScript, DHTML, CSS and frames is required
# (i.e. any modern browser). Windows users are probably better off using the
# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can
# further fine-tune the look of the index. As an example, the default style
# sheet generated by doxygen has an example that shows how to put an image at
# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
# the same information as the tab index, you could consider setting
# DISABLE_INDEX to YES when enabling this option.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_TREEVIEW = YES
# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
# doxygen will group on one line in the generated HTML documentation.
#
# Note that a value of 0 will completely suppress the enum values from appearing
# in the overview section.
# Minimum value: 0, maximum value: 20, default value: 4.
# This tag requires that the tag GENERATE_HTML is set to YES.
ENUM_VALUES_PER_LINE = 4
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
# to set the initial width (in pixels) of the frame in which the tree is shown.
# Minimum value: 0, maximum value: 1500, default value: 250.
# This tag requires that the tag GENERATE_HTML is set to YES.
TREEVIEW_WIDTH = 300
# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to
# external symbols imported via tag files in a separate window.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
EXT_LINKS_IN_WINDOW = NO
# Use this tag to change the font size of LaTeX formulas included as images in
# the HTML documentation. When you change the font size after a successful
# doxygen run you need to manually remove any form_*.png images from the HTML
# output directory to force them to be regenerated.
# Minimum value: 8, maximum value: 50, default value: 10.
# This tag requires that the tag GENERATE_HTML is set to YES.
FORMULA_FONTSIZE = 10
# Use the FORMULA_TRANPARENT tag to determine whether or not the images
# generated for formulas are transparent PNGs. Transparent PNGs are not
# supported properly for IE 6.0, but are supported on all modern browsers.
#
# Note that when changing this option you need to delete any form_*.png files in
# the HTML output directory before the changes have effect.
# The default value is: YES.
# This tag requires that the tag GENERATE_HTML is set to YES.
FORMULA_TRANSPARENT = YES
# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
# http://www.mathjax.org) which uses client side Javascript for the rendering
# instead of using prerendered bitmaps. Use this if you do not have LaTeX
# installed or if you want to formulas look prettier in the HTML output. When
# enabled you may also need to install MathJax separately and configure the path
# to it using the MATHJAX_RELPATH option.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
USE_MATHJAX = YES
# When MathJax is enabled you can set the default output format to be used for
# the MathJax output. See the MathJax site (see:
# http://docs.mathjax.org/en/latest/output.html) for more details.
# Possible values are: HTML-CSS (which is slower, but has the best
# compatibility), NativeMML (i.e. MathML) and SVG.
# The default value is: HTML-CSS.
# This tag requires that the tag USE_MATHJAX is set to YES.
MATHJAX_FORMAT = HTML-CSS
# When MathJax is enabled you need to specify the location relative to the HTML
# output directory using the MATHJAX_RELPATH option. The destination directory
# should contain the MathJax.js script. For instance, if the mathjax directory
# is located at the same level as the HTML output directory, then
# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
# Content Delivery Network so you can quickly see the result without installing
# MathJax. However, it is strongly recommended to install a local copy of
# MathJax from http://www.mathjax.org before deployment.
# The default value is: http://cdn.mathjax.org/mathjax/latest.
# This tag requires that the tag USE_MATHJAX is set to YES.
MATHJAX_RELPATH = http://www.mathjax.org/mathjax
# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
# extension names that should be enabled during MathJax rendering. For example
# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
# This tag requires that the tag USE_MATHJAX is set to YES.
MATHJAX_EXTENSIONS =
# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
# of code that will be used on startup of the MathJax code. See the MathJax site
# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
# example see the documentation.
# This tag requires that the tag USE_MATHJAX is set to YES.
MATHJAX_CODEFILE =
# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
# the HTML output. The underlying search engine uses javascript and DHTML and
# should work on any modern browser. Note that when using HTML help
# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
# there is already a search function so this one should typically be disabled.
# For large projects the javascript based search engine can be slow, then
# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
# search using the keyboard; to jump to the search box use + S
# (what the is depends on the OS and browser, but it is typically
# , /, or both). Inside the search box use the to jump into the search results window, the results can be navigated
# using the . Press to select an item or to cancel
# the search. The filter options can be selected when the cursor is inside the
# search box by pressing +. Also here use the
# to select a filter and or to activate or cancel the filter
# option.
# The default value is: YES.
# This tag requires that the tag GENERATE_HTML is set to YES.
SEARCHENGINE = YES
# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
# implemented using a web server instead of a web client using Javascript. There
# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
# setting. When disabled, doxygen will generate a PHP script for searching and
# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
# and searching needs to be provided by external tools. See the section
# "External Indexing and Searching" for details.
# The default value is: NO.
# This tag requires that the tag SEARCHENGINE is set to YES.
SERVER_BASED_SEARCH = NO
# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
# script for searching. Instead the search results are written to an XML file
# which needs to be processed by an external indexer. Doxygen will invoke an
# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
# search results.
#
# Doxygen ships with an example indexer ( doxyindexer) and search engine
# (doxysearch.cgi) which are based on the open source search engine library
# Xapian (see: http://xapian.org/).
#
# See the section "External Indexing and Searching" for details.
# The default value is: NO.
# This tag requires that the tag SEARCHENGINE is set to YES.
EXTERNAL_SEARCH = NO
# The SEARCHENGINE_URL should point to a search engine hosted by a web server
# which will return the search results when EXTERNAL_SEARCH is enabled.
#
# Doxygen ships with an example indexer ( doxyindexer) and search engine
# (doxysearch.cgi) which are based on the open source search engine library
# Xapian (see: http://xapian.org/). See the section "External Indexing and
# Searching" for details.
# This tag requires that the tag SEARCHENGINE is set to YES.
SEARCHENGINE_URL =
# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
# search data is written to a file for indexing by an external tool. With the
# SEARCHDATA_FILE tag the name of this file can be specified.
# The default file is: searchdata.xml.
# This tag requires that the tag SEARCHENGINE is set to YES.
SEARCHDATA_FILE = searchdata.xml
# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
# projects and redirect the results back to the right project.
# This tag requires that the tag SEARCHENGINE is set to YES.
EXTERNAL_SEARCH_ID =
# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
# projects other than the one defined by this configuration file, but that are
# all added to the same external search index. Each project needs to have a
# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
# to a relative location where the documentation can be found. The format is:
# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
# This tag requires that the tag SEARCHENGINE is set to YES.
EXTRA_SEARCH_MAPPINGS =
#---------------------------------------------------------------------------
# Configuration options related to the LaTeX output
#---------------------------------------------------------------------------
# If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
# The default value is: YES.
GENERATE_LATEX = NO
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
# it.
# The default directory is: latex.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_OUTPUT = latex
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
# invoked.
#
# Note that when enabling USE_PDFLATEX this option is only used for generating
# bitmaps for formulas in the HTML output, but not in the Makefile that is
# written to the output directory.
# The default file is: latex.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_CMD_NAME = latex
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
# index for LaTeX.
# The default file is: makeindex.
# This tag requires that the tag GENERATE_LATEX is set to YES.
MAKEINDEX_CMD_NAME = makeindex
# If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX
# documents. This may be useful for small projects and may help to save some
# trees in general.
# The default value is: NO.
# This tag requires that the tag GENERATE_LATEX is set to YES.
COMPACT_LATEX = NO
# The PAPER_TYPE tag can be used to set the paper type that is used by the
# printer.
# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
# 14 inches) and executive (7.25 x 10.5 inches).
# The default value is: a4.
# This tag requires that the tag GENERATE_LATEX is set to YES.
PAPER_TYPE = a4wide
# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
# that should be included in the LaTeX output. To get the times font for
# instance you can specify
# EXTRA_PACKAGES=times
# If left blank no extra packages will be included.
# This tag requires that the tag GENERATE_LATEX is set to YES.
EXTRA_PACKAGES = amssymb
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
# generated LaTeX document. The header should contain everything until the first
# chapter. If it is left blank doxygen will generate a standard header. See
# section "Doxygen usage" for information on how to let doxygen write the
# default header to a separate file.
#
# Note: Only use a user-defined header if you know what you are doing! The
# following commands have a special meaning inside the header: $title,
# $datetime, $date, $doxygenversion, $projectname, $projectnumber,
# $projectbrief, $projectlogo. Doxygen will replace $title with the empy string,
# for the replacement values of the other commands the user is refered to
# HTML_HEADER.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_HEADER =
# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
# generated LaTeX document. The footer should contain everything after the last
# chapter. If it is left blank doxygen will generate a standard footer. See
# LATEX_HEADER for more information on how to generate a default footer and what
# special commands can be used inside the footer.
#
# Note: Only use a user-defined footer if you know what you are doing!
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_FOOTER =
# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
# other source files which should be copied to the LATEX_OUTPUT output
# directory. Note that the files will be copied as-is; there are no commands or
# markers available.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_EXTRA_FILES =
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
# contain links (just like the HTML output) instead of page references. This
# makes the output suitable for online browsing using a PDF viewer.
# The default value is: YES.
# This tag requires that the tag GENERATE_LATEX is set to YES.
PDF_HYPERLINKS = NO
# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
# the PDF file directly from the LaTeX files. Set this option to YES to get a
# higher quality PDF documentation.
# The default value is: YES.
# This tag requires that the tag GENERATE_LATEX is set to YES.
USE_PDFLATEX = NO
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
# command to the generated LaTeX files. This will instruct LaTeX to keep running
# if errors occur, instead of asking the user for help. This option is also used
# when generating formulas in HTML.
# The default value is: NO.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_BATCHMODE = NO
# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
# index chapters (such as File Index, Compound Index, etc.) in the output.
# The default value is: NO.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_HIDE_INDICES = NO
# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
# code with syntax highlighting in the LaTeX output.
#
# Note that which sources are shown also depends on other settings such as
# SOURCE_BROWSER.
# The default value is: NO.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_SOURCE_CODE = NO
# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
# bibliography, e.g. plainnat, or ieeetr. See
# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
# The default value is: plain.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_BIB_STYLE = plain
#---------------------------------------------------------------------------
# Configuration options related to the RTF output
#---------------------------------------------------------------------------
# If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The
# RTF output is optimized for Word 97 and may not look too pretty with other RTF
# readers/editors.
# The default value is: NO.
GENERATE_RTF = NO
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
# it.
# The default directory is: rtf.
# This tag requires that the tag GENERATE_RTF is set to YES.
RTF_OUTPUT = rtf
# If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF
# documents. This may be useful for small projects and may help to save some
# trees in general.
# The default value is: NO.
# This tag requires that the tag GENERATE_RTF is set to YES.
COMPACT_RTF = NO
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
# contain hyperlink fields. The RTF file will contain links (just like the HTML
# output) instead of page references. This makes the output suitable for online
# browsing using Word or some other Word compatible readers that support those
# fields.
#
# Note: WordPad (write) and others do not support links.
# The default value is: NO.
# This tag requires that the tag GENERATE_RTF is set to YES.
RTF_HYPERLINKS = NO
# Load stylesheet definitions from file. Syntax is similar to doxygen's config
# file, i.e. a series of assignments. You only have to provide replacements,
# missing definitions are set to their default value.
#
# See also section "Doxygen usage" for information on how to generate the
# default style sheet that doxygen normally uses.
# This tag requires that the tag GENERATE_RTF is set to YES.
RTF_STYLESHEET_FILE =
# Set optional variables used in the generation of an RTF document. Syntax is
# similar to doxygen's config file. A template extensions file can be generated
# using doxygen -e rtf extensionFile.
# This tag requires that the tag GENERATE_RTF is set to YES.
RTF_EXTENSIONS_FILE =
#---------------------------------------------------------------------------
# Configuration options related to the man page output
#---------------------------------------------------------------------------
# If the GENERATE_MAN tag is set to YES doxygen will generate man pages for
# classes and files.
# The default value is: NO.
GENERATE_MAN = NO
# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
# it. A directory man3 will be created inside the directory specified by
# MAN_OUTPUT.
# The default directory is: man.
# This tag requires that the tag GENERATE_MAN is set to YES.
MAN_OUTPUT = man
# The MAN_EXTENSION tag determines the extension that is added to the generated
# man pages. In case the manual section does not start with a number, the number
# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
# optional.
# The default value is: .3.
# This tag requires that the tag GENERATE_MAN is set to YES.
MAN_EXTENSION = .3
# The MAN_SUBDIR tag determines the name of the directory created within
# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
# MAN_EXTENSION with the initial . removed.
# This tag requires that the tag GENERATE_MAN is set to YES.
MAN_SUBDIR =
# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
# will generate one additional man file for each entity documented in the real
# man page(s). These additional files only source the real man page, but without
# them the man command would be unable to find the correct page.
# The default value is: NO.
# This tag requires that the tag GENERATE_MAN is set to YES.
MAN_LINKS = NO
#---------------------------------------------------------------------------
# Configuration options related to the XML output
#---------------------------------------------------------------------------
# If the GENERATE_XML tag is set to YES doxygen will generate an XML file that
# captures the structure of the code including all documentation.
# The default value is: NO.
GENERATE_XML = NO
# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
# it.
# The default directory is: xml.
# This tag requires that the tag GENERATE_XML is set to YES.
XML_OUTPUT = xml
# If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
# listings (including syntax highlighting and cross-referencing information) to
# the XML output. Note that enabling this will significantly increase the size
# of the XML output.
# The default value is: YES.
# This tag requires that the tag GENERATE_XML is set to YES.
XML_PROGRAMLISTING = YES
#---------------------------------------------------------------------------
# Configuration options related to the DOCBOOK output
#---------------------------------------------------------------------------
# If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files
# that can be used to generate PDF.
# The default value is: NO.
GENERATE_DOCBOOK = NO
# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
# front of it.
# The default directory is: docbook.
# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
DOCBOOK_OUTPUT = docbook
# If the DOCBOOK_PROGRAMLISTING tag is set to YES doxygen will include the
# program listings (including syntax highlighting and cross-referencing
# information) to the DOCBOOK output. Note that enabling this will significantly
# increase the size of the DOCBOOK output.
# The default value is: NO.
# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
DOCBOOK_PROGRAMLISTING = NO
#---------------------------------------------------------------------------
# Configuration options for the AutoGen Definitions output
#---------------------------------------------------------------------------
# If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen
# Definitions (see http://autogen.sf.net) file that captures the structure of
# the code including all documentation. Note that this feature is still
# experimental and incomplete at the moment.
# The default value is: NO.
GENERATE_AUTOGEN_DEF = NO
#---------------------------------------------------------------------------
# Configuration options related to the Perl module output
#---------------------------------------------------------------------------
# If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module
# file that captures the structure of the code including all documentation.
#
# Note that this feature is still experimental and incomplete at the moment.
# The default value is: NO.
GENERATE_PERLMOD = NO
# If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary
# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
# output from the Perl module output.
# The default value is: NO.
# This tag requires that the tag GENERATE_PERLMOD is set to YES.
PERLMOD_LATEX = NO
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely
# formatted so it can be parsed by a human reader. This is useful if you want to
# understand what is going on. On the other hand, if this tag is set to NO the
# size of the Perl module output will be much smaller and Perl will parse it
# just the same.
# The default value is: YES.
# This tag requires that the tag GENERATE_PERLMOD is set to YES.
PERLMOD_PRETTY = YES
# The names of the make variables in the generated doxyrules.make file are
# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
# so different doxyrules.make files included by the same Makefile don't
# overwrite each other's variables.
# This tag requires that the tag GENERATE_PERLMOD is set to YES.
PERLMOD_MAKEVAR_PREFIX =
#---------------------------------------------------------------------------
# Configuration options related to the preprocessor
#---------------------------------------------------------------------------
# If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all
# C-preprocessor directives found in the sources and include files.
# The default value is: YES.
ENABLE_PREPROCESSING = YES
# If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names
# in the source code. If set to NO only conditional compilation will be
# performed. Macro expansion can be done in a controlled way by setting
# EXPAND_ONLY_PREDEF to YES.
# The default value is: NO.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
MACRO_EXPANSION = YES
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
# the macro expansion is limited to the macros specified with the PREDEFINED and
# EXPAND_AS_DEFINED tags.
# The default value is: NO.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
EXPAND_ONLY_PREDEF = NO
# If the SEARCH_INCLUDES tag is set to YES the includes files in the
# INCLUDE_PATH will be searched if a #include is found.
# The default value is: YES.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
SEARCH_INCLUDES = YES
# The INCLUDE_PATH tag can be used to specify one or more directories that
# contain include files that are not input files but should be processed by the
# preprocessor.
# This tag requires that the tag SEARCH_INCLUDES is set to YES.
INCLUDE_PATH =
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
# patterns (like *.h and *.hpp) to filter out the header-files in the
# directories. If left blank, the patterns specified with FILE_PATTERNS will be
# used.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
INCLUDE_FILE_PATTERNS =
# The PREDEFINED tag can be used to specify one or more macro names that are
# defined before the preprocessor is started (similar to the -D option of e.g.
# gcc). The argument of the tag is a list of macros of the form: name or
# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
# is assumed. To prevent a macro definition from being undefined via #undef or
# recursively expanded use the := operator instead of the = operator.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
PREDEFINED = itkNotUsed(x)= \
"itkSetMacro(name,type)= virtual void Set##name (type _arg);" \
"itkGetMacro(name,type)= virtual type Get##name ();" \
"itkGetConstMacro(name,type)= virtual type Get##name () const;" \
"itkSetStringMacro(name)= virtual void Set##name (const char* _arg);" \
"itkGetStringMacro(name)= virtual const char* Get##name () const;" \
"itkSetClampMacro(name,type,min,max)= virtual void Set##name (type _arg);" \
"itkSetObjectMacro(name,type)= virtual void Set##name (type* _arg);" \
"itkGetObjectMacro(name,type)= virtual type* Get##name ();" \
"itkSetConstObjectMacro(name,type)= virtual void Set##name ( const type* _arg);" \
"itkGetConstObjectMacro(name,type)= virtual const type* Get##name ();" \
"itkGetConstReferenceMacro(name,type)= virtual const type& Get##name ();" \
"itkGetConstReferenceObjectMacro(name,type)= virtual const type::Pointer& Get##name () const;" \
"itkBooleanMacro(name)= virtual void name##On (); virtual void name##Off ();" \
"itkSetVector2Macro(name,type)= virtual void Set##name (type _arg1, type _arg2) virtual void Set##name (type _arg[2]);" \
"itkGetVector2Macro(name,type)= virtual type* Get##name () const; virtual void Get##name (type& _arg1, type& _arg2) const; virtual void Get##name (type _arg[2]) const;" \
"itkSetVector3Macro(name,type)= virtual void Set##name (type _arg1, type _arg2, type _arg3) virtual void Set##name (type _arg[3]);" \
"itkGetVector3Macro(name,type)= virtual type* Get##name () const; virtual void Get##name (type& _arg1, type& _arg2, type& _arg3) const; virtual void Get##name (type _arg[3]) const;" \
"itkSetVector4Macro(name,type)= virtual void Set##name (type _arg1, type _arg2, type _arg3, type _arg4) virtual void Set##name (type _arg[4]);" \
"itkGetVector4Macro(name,type)= virtual type* Get##name () const; virtual void Get##name (type& _arg1, type& _arg2, type& _arg3, type& _arg4) const; virtual void Get##name (type _arg[4]) const;" \
"itkSetVector6Macro(name,type)= virtual void Set##name (type _arg1, type _arg2, type _arg3, type _arg4, type _arg5, type _arg6) virtual void Set##name (type _arg[6]);" \
"itkGetVector6Macro(name,type)= virtual type* Get##name () const; virtual void Get##name (type& _arg1, type& _arg2, type& _arg3, type& _arg4, type& _arg5, type& _arg6) const; virtual void Get##name (type _arg[6]) const;" \
"itkSetVectorMacro(name,type,count)= virtual void Set##name(type data[]);" \
"itkGetVectorMacro(name,type,count)= virtual type* Get##name () const;" \
"itkNewMacro(type)= static Pointer New();" \
"itkFactorylessNewMacro(type)= static Pointer New();" \
"itkCloneMacro(type)= Pointer Clone() const;" \
"itkTypeMacro(thisClass,superclass)= virtual const char *GetClassName() const;" \
"itkConceptMacro(name,concept)= enum { name = 0 };" \
"ITK_NUMERIC_LIMITS= std::numeric_limits" \
"ITK_TYPENAME= typename" \
"FEM_ABSTRACT_CLASS(thisClass,parentClass)= public: /** Standard Self typedef.*/ typedef thisClass Self; /** Standard Superclass typedef. */ typedef parentClass Superclass; /** Pointer or SmartPointer to an object. */ typedef Self* Pointer; /** Const pointer or SmartPointer to an object. */ typedef const Self* ConstPointer; private:" \
"FEM_CLASS(thisClass,parentClass)= FEM_ABSTRACT_CLASS(thisClass,parentClass) public: /** Create a new object from the existing one */ virtual Baseclass::Pointer Clone() const; /** Class ID for FEM object factory */ static const int CLID; /** Virtual function to access the class ID */ virtual int ClassID() const { return CLID; } /** Object creation in an itk compatible way */ static Self::Pointer New() { return new Self(); } private:" \
FREEVERSION \
ERROR_CHECKING \
HAS_TIFF \
HAS_JPEG \
HAS_NETLIB \
HAS_PNG \
HAS_ZLIB \
HAS_GLUT \
HAS_QT \
VCL_USE_NATIVE_STL=1 \
VCL_USE_NATIVE_COMPLEX=1 \
VCL_HAS_BOOL=1 \
VXL_BIG_ENDIAN=1 \
VXL_LITTLE_ENDIAN=0 \
VNL_DLL_DATA= \
size_t=vcl_size_t \
"US_PREPEND_NAMESPACE(x)=us::x" \
"US_BEGIN_NAMESPACE= namespace us {" \
"US_END_NAMESPACE=}" \
"US_BASECLASS_NAME=itk::LightObject" \
US_EXPORT= \
"DEPRECATED(func)=func"
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
# tag can be used to specify a list of macro names that should be expanded. The
# macro definition that is found in the sources will be used. Use the PREDEFINED
# tag if you want to use a different macro definition that overrules the
# definition found in the source code.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
EXPAND_AS_DEFINED =
# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
# remove all references to function-like macros that are alone on a line, have
# an all uppercase name, and do not end with a semicolon. Such function macros
# are typically used for boiler-plate code, and will confuse the parser if not
# removed.
# The default value is: YES.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
SKIP_FUNCTION_MACROS = YES
#---------------------------------------------------------------------------
# Configuration options related to external references
#---------------------------------------------------------------------------
# The TAGFILES tag can be used to specify one or more tag files. For each tag
# file the location of the external documentation should be added. The format of
# a tag file without this location is as follows:
# TAGFILES = file1 file2 ...
# Adding location for the tag files is done as follows:
# TAGFILES = file1=loc1 "file2 = loc2" ...
# where loc1 and loc2 can be relative or absolute paths or URLs. See the
# section "Linking to external documentation" for more information about the use
# of tag files.
# Note: Each tag file must have a unique name (where the name does NOT include
# the path). If a tag file is not located in the directory in which doxygen is
# run, you must also specify the path to the tagfile here.
TAGFILES =
# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
# tag file that is based on the input files it reads. See section "Linking to
# external documentation" for more information about the usage of tag files.
GENERATE_TAGFILE = @MITK_DOXYGEN_TAGFILE_NAME@
# If the ALLEXTERNALS tag is set to YES all external class will be listed in the
# class index. If set to NO only the inherited external classes will be listed.
# The default value is: NO.
ALLEXTERNALS = NO
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in
# the modules index. If set to NO, only the current project's groups will be
# listed.
# The default value is: YES.
EXTERNAL_GROUPS = NO
# If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in
# the related pages index. If set to NO, only the current project's pages will
# be listed.
# The default value is: YES.
EXTERNAL_PAGES = YES
# The PERL_PATH should be the absolute path and name of the perl script
# interpreter (i.e. the result of 'which perl').
# The default file (with absolute path) is: /usr/bin/perl.
PERL_PATH = /usr/bin/perl
#---------------------------------------------------------------------------
# Configuration options related to the dot tool
#---------------------------------------------------------------------------
# If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram
# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
# NO turns the diagrams off. Note that this option also works with HAVE_DOT
# disabled, but it is recommended to install and use dot, since it yields more
# powerful graphs.
# The default value is: YES.
CLASS_DIAGRAMS = YES
# You can define message sequence charts within doxygen comments using the \msc
# command. Doxygen will then run the mscgen tool (see:
# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
# documentation. The MSCGEN_PATH tag allows you to specify the directory where
# the mscgen tool resides. If left empty the tool is assumed to be found in the
# default search path.
MSCGEN_PATH =
# You can include diagrams made with dia in doxygen documentation. Doxygen will
# then run dia to produce the diagram and insert it in the documentation. The
# DIA_PATH tag allows you to specify the directory where the dia binary resides.
# If left empty dia is assumed to be found in the default search path.
DIA_PATH =
# If set to YES, the inheritance and collaboration graphs will hide inheritance
# and usage relations if the target is undocumented or is not a class.
# The default value is: YES.
HIDE_UNDOC_RELATIONS = YES
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
# available from the path. This tool is part of Graphviz (see:
# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
# Bell Labs. The other options in this section have no effect if this option is
# set to NO
# The default value is: NO.
HAVE_DOT = @HAVE_DOT@
# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
# to run in parallel. When set to 0 doxygen will base this on the number of
# processors available in the system. You can set it explicitly to a value
# larger than 0 to get control over the balance between CPU load and processing
# speed.
# Minimum value: 0, maximum value: 32, default value: 0.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_NUM_THREADS = @MITK_DOXYGEN_DOT_NUM_THREADS@
# When you want a differently looking font in the dot files that doxygen
# generates you can specify the font name using DOT_FONTNAME. You need to make
# sure dot is able to find the font, which can be done by putting it in a
# standard location or by setting the DOTFONTPATH environment variable or by
# setting DOT_FONTPATH to the directory containing the font.
# The default value is: Helvetica.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_FONTNAME = Helvetica
# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
# dot graphs.
# Minimum value: 4, maximum value: 24, default value: 10.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_FONTSIZE = 10
# By default doxygen will tell dot to use the default font as specified with
# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
# the path where dot can find it using this tag.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_FONTPATH =
# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
# each documented class showing the direct and indirect inheritance relations.
# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
CLASS_GRAPH = YES
# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
# graph for each documented class showing the direct and indirect implementation
# dependencies (inheritance, containment, and class references variables) of the
# class with other documented classes.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
COLLABORATION_GRAPH = YES
# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
# groups, showing the direct groups dependencies.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
GROUP_GRAPHS = YES
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
# collaboration diagrams in a style similar to the OMG's Unified Modeling
# Language.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
UML_LOOK = @MITK_DOXYGEN_UML_LOOK@
# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
# class node. If there are many fields or methods and many nodes the graph may
# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
# number of items for each type to make the size more manageable. Set this to 0
# for no limit. Note that the threshold may be exceeded by 50% before the limit
# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
# but if the number exceeds 15, the total amount of fields shown is limited to
# 10.
# Minimum value: 0, maximum value: 100, default value: 10.
# This tag requires that the tag HAVE_DOT is set to YES.
UML_LIMIT_NUM_FIELDS = 10
# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
# collaboration graphs will show the relations between templates and their
# instances.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
TEMPLATE_RELATIONS = YES
# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
# YES then doxygen will generate a graph for each documented file showing the
# direct and indirect include dependencies of the file with other documented
# files.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
INCLUDE_GRAPH = NO
# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
# set to YES then doxygen will generate a graph for each documented file showing
# the direct and indirect include dependencies of the file with other documented
# files.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
INCLUDED_BY_GRAPH = NO
# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
# dependency graph for every global function or class method.
#
# Note that enabling this option will significantly increase the time of a run.
# So in most cases it will be better to enable call graphs for selected
# functions only using the \callgraph command.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
CALL_GRAPH = NO
# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
# dependency graph for every global function or class method.
#
# Note that enabling this option will significantly increase the time of a run.
# So in most cases it will be better to enable caller graphs for selected
# functions only using the \callergraph command.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
CALLER_GRAPH = NO
# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
# hierarchy of all classes instead of a textual one.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
GRAPHICAL_HIERARCHY = NO
# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
# dependencies a directory has on other directories in a graphical way. The
# dependency relations are determined by the #include relations between the
# files in the directories.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
DIRECTORY_GRAPH = YES
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
# generated by dot.
# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
# to make the SVG files visible in IE 9+ (other browsers do not have this
# requirement).
# Possible values are: png, jpg, gif and svg.
# The default value is: png.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_IMAGE_FORMAT = png
# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
# enable generation of interactive SVG images that allow zooming and panning.
#
# Note that this requires a modern browser other than Internet Explorer. Tested
# and working are Firefox, Chrome, Safari, and Opera.
# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
# the SVG files visible. Older versions of IE do not have SVG support.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
INTERACTIVE_SVG = NO
# The DOT_PATH tag can be used to specify the path where the dot tool can be
# found. If left blank, it is assumed the dot tool can be found in the path.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_PATH = @DOXYGEN_DOT_PATH@
# The DOTFILE_DIRS tag can be used to specify one or more directories that
# contain dot files that are included in the documentation (see the \dotfile
# command).
# This tag requires that the tag HAVE_DOT is set to YES.
DOTFILE_DIRS =
# The MSCFILE_DIRS tag can be used to specify one or more directories that
# contain msc files that are included in the documentation (see the \mscfile
# command).
MSCFILE_DIRS =
# The DIAFILE_DIRS tag can be used to specify one or more directories that
# contain dia files that are included in the documentation (see the \diafile
# command).
DIAFILE_DIRS =
# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
# path where java can find the plantuml.jar file. If left blank, it is assumed
# PlantUML is not used or called during a preprocessing step. Doxygen will
# generate a warning when it encounters a \startuml command in this case and
# will not generate output for the diagram.
# This tag requires that the tag HAVE_DOT is set to YES.
PLANTUML_JAR_PATH =
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
# that will be shown in the graph. If the number of nodes in a graph becomes
# larger than this value, doxygen will truncate the graph, which is visualized
# by representing a node as a red box. Note that doxygen if the number of direct
# children of the root node in a graph is already larger than
# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
# Minimum value: 0, maximum value: 10000, default value: 50.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_GRAPH_MAX_NODES = 50
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
# generated by dot. A depth value of 3 means that only nodes reachable from the
# root by following a path via at most 3 edges will be shown. Nodes that lay
# further from the root node will be omitted. Note that setting this option to 1
# or 2 may greatly reduce the computation time needed for large code bases. Also
# note that the size of a graph can be further restricted by
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
# Minimum value: 0, maximum value: 1000, default value: 0.
# This tag requires that the tag HAVE_DOT is set to YES.
MAX_DOT_GRAPH_DEPTH = 0
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
# background. This is disabled by default, because dot on Windows does not seem
# to support this out of the box.
#
# Warning: Depending on the platform used, enabling this option may lead to
# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
# read).
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_TRANSPARENT = NO
# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
# files in one run (i.e. multiple -o and -T options on the command line). This
# makes dot run faster, but since only newer versions of dot (>1.8.10) support
# this, this feature is disabled by default.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_MULTI_TARGETS = NO
# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
# explaining the meaning of the various boxes and arrows in the dot generated
# graphs.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
GENERATE_LEGEND = YES
# If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot
# files that are used to generate the various graphs.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_CLEANUP = YES
diff --git a/Modules/IGT/Documentation/doxygen/IGTHowToImplementATrackingDevice.dox b/Modules/IGT/Documentation/doxygen/IGTHowToImplementATrackingDevice.dox
index 652d192200..1e31f57c8b 100644
--- a/Modules/IGT/Documentation/doxygen/IGTHowToImplementATrackingDevice.dox
+++ b/Modules/IGT/Documentation/doxygen/IGTHowToImplementATrackingDevice.dox
@@ -1,73 +1,73 @@
/**
\page IGTHowToImplementATrackingDevice How To Implement A Tracking Device
If you want to implement your own Tracking device, you need to do the following (see e.g. mitk::VirtualTrackerTypeInformation):
-# Derive a class MyAwesomeTrackingDeviceInformation from the abstract class mitk::TrackingDeviceTypeInformation
-# In the constructor of your class
-# give your device a unique name ("my awesome device")
-# push back at least one mitk::TrackingDeviceData corresponding to your device to m_TrackingDeviceData (mitk::TrackingDeviceType member 'Line' needs to be identical to your chosen device name "my awesome device")
-# Implement the method mitk::TrackingDeviceTypeInformation::CreateTrackingDeviceSource.
Recommended steps (but not necessary):
-# Provide a static method to get your tracking device name.\n
Recommended:
\code{.cpp}
static std::string MyAwesomeTrackingDeviceInformation::GetTrackingDeviceName()
{
return "my awesome device";
}
\endcode
Use this method in your constructor for step 2a) and 2b).
This method will make it easier to implement options for your device in any other Module/Plugin.
If you want to check if the device in use is your device, you need to compare the names - and this can now be done in any
Plugin just by calling this static method. And if you later on decide to change the name of your device into
"my One And Only Device" - there is only one line of code you'll have to adapt.\n
Attention: If you change the name, you must edit all tool storages which were saved, e.g. using \ref org_mitk_views_igtnavigationtoolmanager .\n
Attention: You should use a static method instead of static variables due to the initialization order of static variables and the autoload module.
-# Provide static methods for all your mitk::TrackingDeviceData.\n
Recommended:
\code{.cpp}
TrackingDeviceData MyAwesomeTrackingDeviceInformation::GetDeviceDataForMyFirstDevice()
{
return{ MyAwesomeTrackingDeviceInformation::GetTrackingDeviceName(), "my Model", "my model volume location", "my hardware code" };
}
\endcode
-# Register your Tracking Device to the collection:
\code{.cpp}
#include
#include
#include
#include
mitk::TrackingDeviceTypeCollection* m_DeviceTypeCollection;
us::ModuleContext* context = us::GetModuleContext();
std::vector > refs = context->GetServiceReferences();
if (refs.empty())
{
MITK_ERROR << "No tracking device service found!";
}
m_DeviceTypeCollection = context->GetService(refs.front());
m_DeviceTypeCollection->RegisterTrackingDeviceType(new mitk::MyAwesomeTrackingDeviceInformation());
\endcode
You can do the registration anywhere in your code, also from external projects.
We recommend doing the registration of your tracking device in the autoload function of your module.
Devices, which should be always available (e.g. Polaris, Aurora, Virtual, ...) are registered in mitk::IGTActivator.
-# Implement a widget to configure your device and register it to the collection
-# Derive a Widget class QmitkMyAwesomeTrackingDeviceWidget from QmitkAbstractTrackingDeviceWidget.
Please follow the steps as explained in QmitkAbstractTrackingDeviceWidget.h
-# Create a .ui file
-# Register it to mitk::TrackingDeviceWidgetCollection
\code{.cpp}
m_DeviceWidgetCollection.RegisterTrackingDeviceWidget(mitk::MyAwesomeTrackingDeviceInformation::GetTrackingDeviceName(), new QmitkMyAwesomeTrackingDeviceWidget);
\endcode
You can get the Widget collection analogous to step 3, replacing mitk::TrackingDeviceTypeCollection with mitk::TrackingDeviceWidgetCollection.
Your tracking device should now be available in other Plugins, e.g. \ref org_mitk_views_igttrackingtoolbox .
-*/
+*/
\ No newline at end of file
diff --git a/Modules/IGT/Documentation/doxygen/IGTModule.dox b/Modules/IGT/Documentation/doxygen/IGTModule.dox
index 5ac2b4538b..9c4dc25d6e 100644
--- a/Modules/IGT/Documentation/doxygen/IGTModule.dox
+++ b/Modules/IGT/Documentation/doxygen/IGTModule.dox
@@ -1,32 +1,77 @@
/**
-\page IGTGeneralModulePage The IGT Modules
+\page NavigationGeneralModulePage The Navigation Modules
\section IGTGeneralModulePageOverview Overview
-The module IGT integrates image guided therapy (IGT) functionality to MITK. The main features of MITK-IGT are:
+Navigation modules consist of IGT (Tracking devices), US (Ultrasound) and TOF (3D range imaging) modules. Each module is separated into UI dependent and independent modules (e.g. IGT and IGTUI module). The navigation modules are based on the OpenCVVideoSupport modules and OpenIGTLink modules. In addition, there is the basic module IGTBase, which holds general functionality for all navigation modules.
+
+Most navigation modules support hardware devices. A current list of all supported devices can be found here: Hardware Support .
+
+\section IGTModules IGT modules
+The module IGT integrates image guided therapy (IGT) functionality to MITK. The main features of MITK-IGT are:
- handling and processing of medical imaging data which is available through MITK itself
- support of tracking devices
+ handling and processing of medical imaging data which is available through MITK itself
+ support of tracking devices
a concept for processing tracking data
-MITK-IGT consists of two layers for hardware control (Tracking Layer) and processing of tracking data (Navigation Layer). Additionally it offers components for rapid development of graphical user interfaces (GUIs) of navigation applications. To separate UI functionality from the rest of the code UI classes are encapsulated in the separate module IGT-UI.
+MITK-IGT consists of two layers for hardware control (Tracking Layer) and processing of tracking data (Navigation Layer). Additionally it offers components for rapid development of graphicalt user interfaces (GUIs) of navigation applications. To separate UI functionality from the rest of the code UI classes are encapsulated in the separate module IGT-UI.
+
+The IGT documentation contains the following pages:
+
+
+ \subpage IGTTutorialOverview IGT Tutorial Overview - This tutorial will guide you step by step through all plugins, modules and documentation pages. It contains the following steps:
+
+ \ref IGTTutorialStepPluginIntroduction - Step 1: This tutorial step explains the usage of the most important IGT plugins
+
+ \ref IGTTutorialStepFilterPipeline - Step 2: This tutorial step on how to implement an IGT filter pipeline
+
+ \ref IGTTutorialStepVisualization - Step 3: This tutorial step creates a simple render window to visualize tracking tools.
+
+ \ref IGTTutorialStepSimplePlugin - Step 4: This tutorial step shows you how to create a simple plugin for tracking
+
+ \ref IGTTutorialStepTrackingLab - Step 5: This tutorial step gives step-by-step explanations on how to use the example tracking lab by registering a book of your choice.
+
+ \ref IGTTutorialStepAdvanced - Step 6: This step revises the code of the IGT plugins from the first step in more depth
+
+ \ref IGTTutorialStepOpenIGTLink - Step 7: This tutorial step gives an overview about OpenIGTLink in MITK
+
+ \ref IGTHowToImplementATrackingDevice - Step 8: This guideline is for an implementation of your own tracking device
+
-\section IGTTutorial IGT Tutorial
+ \ref org_mitk_gui_qt_igttracking - Overview of all tracking views which could be used for your application
+
+ \ref org_mitk_views_igttrackingtoolbox - Connect your tracking device and start tracking
+
+ \ref org_mitk_views_igtnavigationtoolmanager - Edit your tool storage
+
+ \ref org_mitk_views_navigationdataplayer - Play your navigation data, e.g. recorded with the tracking toolbox
+
+
+ \ref org_mitk_gui_qt_igtexample - Overview of the example plugin
+
+
+ \ref org_imageguidedtherapytutorial - The plugin which is created in Step \ref IGTTutorialStepSimplePlugin
+
+ \ref org_igttrackinglab - The IGT-TrackingLab view which is described in step \ref IGTTutorialStepTrackingLab
+
+ \ref org_openigtlinkexample OpenIGTLink client example
+
+ \ref org_openigtlinkproviderexample OpenIGTLink server example
+
+ \ref org_openigtlinkplugin An extended OpenIGTLink example
+
+
-If you want to learn more about IGT you can have a look
-on the IGT tutorial, which can be found here:
+\section USModules US modules
- \li \subpage IGTTutorialOverview
+\li The ultrasound user manual: \ref USModulePage
-If you want to implement your own tracking device, have a look here:
- \li \subpage IGTHowToImplementATrackingDevice
+\section TOFModules TOF modules
-\section IGTGeneralModulePageModuleList List of IGT Plugins
+\ref org_toftutorial
-There are also a few ready-to-use sample applications available as MITK-Plugins:
+An explanation on how to create a TOF Module can be found here:
+\li \subpage GeneratingDeviceModulesPage
- \li \ref org_mitk_gui_qt_igtexample
- \li \ref org_mitk_gui_qt_igttracking
-
-*/
+*/
\ No newline at end of file
diff --git a/Modules/IGT/Documentation/doxygen/IGTTutorialOverview.dox b/Modules/IGT/Documentation/doxygen/IGTTutorialOverview.dox
index 431bb50159..f23283b607 100644
--- a/Modules/IGT/Documentation/doxygen/IGTTutorialOverview.dox
+++ b/Modules/IGT/Documentation/doxygen/IGTTutorialOverview.dox
@@ -1,35 +1,49 @@
/**
\page IGTTutorialOverview IGT Tutorial Overview
-The IGT tutorial consists of four steps which will introduce the reader to the basic concepts and functions of IGT.
+The IGT tutorial consists of several steps which will introduce the you to the basic concepts and functions of IGT. The overview of all pages can be found here: \ref NavigationGeneralModulePage.
-\section Step1 Step 1 - IGT filter pipeline
+\section TrackingPlugins Tracking Plugins
-The first step will introduce the concept of the navigation pipeline. Via a virtual tracking device, tracking data
-is written to the console. Everything is organized in a classic c++ main method.
-\li \subpage IGTTutorialStep1
+ Step 1 - Introduction to the Tracking Plugins \n
+During the introduction, you will get familiar with the usage of the tracking plugins. We will guide you step by step through the most important functions of our plugins.
+\li \subpage IGTTutorialStepPluginIntroduction
+
+\section IGTCode The IGT code
-\section Step2 Step 2 - Visualization Filter and MITK Concepts
+ Step 2 - IGT filter pipeline \n
+We will now start with a look at simple code examples to construct a simple navigation pipeline. Via a virtual tracking device, tracking data
+is written to the console. Everything is organized in a classic c++ main method.
+\li \subpage IGTTutorialStepFilterPipeline
-Step 2 adds a broader view of basic MITK concepts. The objects are now added to an mitkDataStorage and rendered
+ Step 3 - Visualization Filter and MITK Concepts \n
+This step adds a broader view of basic MITK concepts. The objects are now added to an mitkDataStorage and rendered
in an mitkRenderWindow. For visualization the NavigationDataObjectVisualizationFilter is used.
Everything is organized in a classic c++ main method.
-\li \subpage IGTTutorialStep2
+\li \subpage IGTTutorialStepVisualization
+
+\section IGTWorkbench IGT within the MITK workbench
-\section Step3 Step 3 - Qt Gui Tutorial
+ Step 4 - Write your own simple Tracking Plugin \n
This step shows how to seamlessly integrate an IGT plugin (the QmitkIGTTutorialView) into the mitkWorkbench. The plugin uses the virtual
tracking device to generate data and renders the result in the mitkWorkbench. It is also possible to connect an
NDI tracking device and use real hardware to track. The code is written in the QmitkView manner.
-\li \subpage IGTTutorialStep3
+\li \subpage IGTTutorialStepSimplePlugin
+
+ Step 5 - Example for a tracking application: The IGT Tracking Lab Plugin \n
+\li \subpage IGTTutorialStepTrackingLab
+
+ Step 6 - Advanced usage of IGT Modules \n
+In this step, we will have a deeper look into the plugins which we already saw within the first introduction step. Here, we point out some details in the code, which might be useful for you to reuse them within your own projects.
+\li \subpage IGTTutorialStepAdvanced
+
+ Step 7 - OpenIGTLink Tutorial \n
+This step gives examples how to use OpenIGTLink in MITK. The first two simple examples include code to open a OpenIGTLink client and server for tracking data. The third, more advanced example shows you how to stream tracking and ultrasound data simultaneously from an external server.
+\li \subpage IGTTutorialStepOpenIGTLink
-\section Step4 Step 4 - Tracking Lab
-Step 4 shows a variety of navigation applications. To this point, for documentation a user manual is available.
-\li \subpage IGTTutorialStep4
+\section FurtherFunctionality Further IGT functionality
-\section Step5 Step 5 - OpenIGTLink Tutorial
-Step 5 gives examples how to use OpenIGTLink in MITK. The first two simple examples include code to open a OpenIGTLink client and server for tracking data. The third, more advanced example shows you how to stream tracking and ultrasound data simultaneously from an external server.
-\li \subpage org_openigtlinkexample
-\li \subpage org_openigtlinkproviderexample
-\li \subpage org_openigtlinkplugin
+If you want to implement your own tracking device, this page might be helpful:
+\li \subpage IGTHowToImplementATrackingDevice
-*/
+*/
\ No newline at end of file
diff --git a/Modules/IGT/Documentation/doxygen/IGTTutorialStep0.dox b/Modules/IGT/Documentation/doxygen/IGTTutorialStep0.dox
new file mode 100644
index 0000000000..c678b10f3f
--- /dev/null
+++ b/Modules/IGT/Documentation/doxygen/IGTTutorialStep0.dox
@@ -0,0 +1,21 @@
+/**
+\page IGTTutorialStepPluginIntroduction Introduction to the IGT Plugins
+
+The IGT module provides some nice views which might help you with your project. This first step leads you through the main functionality of the IGT plugin.
+
+To get familiar with these, please click on each of the views and follow the instructions:
+
+\li \ref org_mitk_views_igttrackingtoolbox - Connect your tracking device and start tracking
+
+\li \ref org_mitk_views_igtnavigationtoolmanager - Edit your tool storage
+
+\li \ref org_mitk_views_navigationdataplayer - Play your navigation data, e.g. recorded with the tracking toolbox
+
+\li \ref org_mitk_views_calibrationtoolmanager Calibration Tool Manager. Will follow soon.
+
+An overview of all tracking views can also be found here:
+\li \ref org_mitk_gui_qt_igttracking
+
+\ref Return to the \ref TrackingPlugins "[IGT Tutorial Overview]"
+
+*/
\ No newline at end of file
diff --git a/Modules/IGT/Documentation/doxygen/IGTTutorialStep1.dox b/Modules/IGT/Documentation/doxygen/IGTTutorialStep1.dox
index c927a32024..d752512557 100644
--- a/Modules/IGT/Documentation/doxygen/IGTTutorialStep1.dox
+++ b/Modules/IGT/Documentation/doxygen/IGTTutorialStep1.dox
@@ -1,46 +1,70 @@
/**
-\page IGTTutorialStep1 IGT filter pipeline
+\page IGTTutorialStepFilterPipeline IGT filter pipeline
The IGT tutorial consists of four main parts for construction of a small navigation pipeline using a virtual tracking device.
The virtual tracking device produces random tool data (position and orientation) so no additional hardware is required.
+The full code of this small navigation pipeline included in this tutorial can be found in MITK-Source/Modules/IGT/Tutorial/mitkIGTTutorialStep1.cpp.
+At the very end of this page, you can find build instructions on how to run this example on your computer.
-\section sec1 In Tracking Layer
+\snippet mitkIGTTutorialStep1.cpp What we will do
+
+\section sec1 Tracking Layer
Firstly a new object "tracker" of the type mitk::VirtualTrackingDevice is created, then two tools, named "tool1" and "tool2",
-are added to this "tracker". Since, the tracking device "tracker" is treated as a virtual tracking
-device "tool1" and "tool2" are just added to the object by method AddTool(name).
+are added to this tracker. Since the tracking device "tracker" is treated as a virtual tracking
+device, tool1 and tool2 are just added to the object by method AddTool(name) and don't need further specification (e.g. real tools might need a calibration file).
+
+\snippet mitkIGTTutorialStep1.cpp Part I Basic 1
-\section sec2 In Navigation Layer
+\section sec2 Navigation Layer
\imageMacro{IGTTutorialStep1.png,"",15.90}
Secondly, a new source of the type mitk::TrackingDeviceSource has to be created with outputs for each single tool of a tracker.
-The source sets the following tracking device by using method SetTrackingDevice as shown below
-\code
-source->SetTrackingDevice(tracker);
-\endcode
+The source sets the following tracking device by using method SetTrackingDevice as shown below.
So now, the source is initialized with the virtual tracking device. Next, the source is connected and tracking is started.
+\snippet mitkIGTTutorialStep1.cpp Part I Basic 2
+
In part II, a displacemt filter (object "displacer") is constructed to change the positions of the filtered NavigationData objects
-with an offset for each direction (X,Y,Z). The given filter has inputs and outputs for each tool, in this example we have 2 tools, hence there exists two inputs and outputs. Every output of the displacement filter object is connected to the recorder object in the next part.
+with an offset for each direction (X,Y,Z). The given filter has inputs and outputs for each tool, in this example we have two tools. Hence, there exist two inputs and outputs. Every output of the displacement filter object is connected to the recorder object in the next part.
+
+\snippet mitkIGTTutorialStep1.cpp Part II
+
+\section sec3 Record Navigation Data
In part III, all the NavigationData is recorded with the NavigationDataRecorder. In order to record, we simply create
an object "recorder" of the type mitk::NavigationDataRecorder and set the appropriate file to it. Now the displacer object is connected to the
-recorder object for every output by using a for-loop in the code, the method StartRecording() is called on the next line. Afterwards,
+recorder object, the method StartRecording() is called on the next line. Afterwards,
the recorder has to be updated a couple of times. In this example the recorder is updating 100 times through
-the second for-loop statement in part III. This can also be seen as a simulation of a timer by using a for-loop.
+a for-loop statement. This can also be seen as a simulation of a timer by using a for-loop.
+
+\snippet mitkIGTTutorialStep1.cpp Part III: Record the data with the NavigationDataRecorder
-Part IV explains how the recoded file can be played for further use. After the object "player" of a type mitk::NavigationDataPlayer
+\section sec4 Play Navigation Data
+
+Part IV explains how the recoded file can be played for further use. After the object "player" of a type mitk::NavigationDataSequentialPlayer
is created, the required file has to be set to the player and playing has to be started. Here, there exists a new pipeline which functions by reading
the recorded file from the harddisc and plays it by using the player as source. During the play, the for-loop makes the file update as in part III.
\imageMacro{IGTTutorialStep1-2.png,"",9.53}
-The full code of small navigation pipeline is shown below and can be found in MITK-Source/Modules/IGT/Tutorial/mitkIGTTutorialStep1.cpp.
-This tutorial is an extra target which can be build separately.
+\snippet mitkIGTTutorialStep1.cpp Part IV: Play the data with the NavigationDataPlayer
+
+\section IGTTutStep1Build IGT Example Build Instructions
+
+This tutorial is an extra target which can be build separately. Make sure, you selected the Navigation option in cmake during your superbuild (set MITK_BUILD_CONFIGURATION to mitkNavigation modules) or select the MITK_BUILD_org.mitk.gui.qt.igtexamples on your MITK-build and make sure that all dependencies are build.
+
+ Visual Studio: Right click in your solution explorer on MITKIGTTutorialStep1 --> Set as start up project --> build & Start without debugging. A new window will open.
+\imageMacro{IGTTutorialStep1_buildInstrWindows.png,"",5}
+
+ Qt creator: Select MITKIGTTutorialStep1 as Project (see screenshot below) and build and run the project. The output can be found in the QT creator console.
+\imageMacro{IGTTutorialStep1_buildInstrLinux.png,"",5}
+
+Your output should look similar to this:
-\include mitkIGTTutorialStep1.cpp
+\imageMacro{IGTTutorialStep1_output.png,"",9.53}
-\ref IGTTutorialStep2 "[Next step]" \ref IGTTutorialOverview "[IGT Tutorial Overview]"
+\ref Return to the \ref IGTTutorialOverview "[IGT Tutorial Overview]"
-*/
+*/
\ No newline at end of file
diff --git a/Modules/IGT/Documentation/doxygen/IGTTutorialStep1_buildInstrLinux.png b/Modules/IGT/Documentation/doxygen/IGTTutorialStep1_buildInstrLinux.png
new file mode 100644
index 0000000000..7af736cc3a
Binary files /dev/null and b/Modules/IGT/Documentation/doxygen/IGTTutorialStep1_buildInstrLinux.png differ
diff --git a/Modules/IGT/Documentation/doxygen/IGTTutorialStep1_buildInstrWindows.png b/Modules/IGT/Documentation/doxygen/IGTTutorialStep1_buildInstrWindows.png
new file mode 100644
index 0000000000..9fabf55312
Binary files /dev/null and b/Modules/IGT/Documentation/doxygen/IGTTutorialStep1_buildInstrWindows.png differ
diff --git a/Modules/IGT/Documentation/doxygen/IGTTutorialStep1_output.png b/Modules/IGT/Documentation/doxygen/IGTTutorialStep1_output.png
new file mode 100644
index 0000000000..0b91cc16dd
Binary files /dev/null and b/Modules/IGT/Documentation/doxygen/IGTTutorialStep1_output.png differ
diff --git a/Modules/IGT/Documentation/doxygen/IGTTutorialStep2.dox b/Modules/IGT/Documentation/doxygen/IGTTutorialStep2.dox
index 8e16595f2e..803aa5044f 100644
--- a/Modules/IGT/Documentation/doxygen/IGTTutorialStep2.dox
+++ b/Modules/IGT/Documentation/doxygen/IGTTutorialStep2.dox
@@ -1,11 +1,55 @@
/**
-\page IGTTutorialStep2 IGT Visualization Filter and MITK Concepts
+\page IGTTutorialStepVisualization IGT Visualization Filter and MITK Concepts
The following code shows how to insert IGT tracking data into an mitk::DataStorage and render the data with the mitk::NavigationDataObjectVisualizationFilter in an mitk::RenderWindow. The full code is shown below and can be found in MITK-Source/Modules/IGT/Tutorial/mitkIGTTutorialStep2.cpp.
-This tutorial is an extra target which can be build separately.
+This tutorial is an extra target which can be build separately (see \ref IGTTutStep1Build).
-\include mitkIGTTutorialStep2.cpp
+The example we are using here regards a moving tracker and a fixed object, and after tracking a transform to move the fixed object to the tracked one is calculated and applied.
-\ref IGTTutorialStep1 "[Previous step]" \ref IGTTutorialStep3 "[Next step]" \ref IGTTutorialOverview "[IGT Tutorial Overview]"
+\snippet mitkIGTTutorialStep2.cpp What we will do
-*/
+The next image describes, what happens in this example. The blue and red object are labeled with "1" at their initial position. Next, the blue object will move (approximately along the yellow arrow) to the second position, while the red one stayes fixed. Now we calculate the transform of the blue cones initial and moved position (1 -> 2) and apply this transform to shift the red object to its final position (3). Now, the relative distance and orientation of the blue and red object is as it was in the beginning.
+
+\imageMacro{IGTTutorialStep2_overview.png,"Overlay of the three steps in this example: 1. Initial position\, 2. Blue object moved along the yellow arc\, 3. Final position\, the red object is moved to get the initial relative position compared to the blue object.",9.53}
+
+\section igtTut2sec1 Set up Render Window and Tracking Device
+
+First of all, we create a new render window. For simplicity, we are not using the MITK workbench yet but run this example as a stand alone application. Hence, we need to create a render window and a data storage.
+
+\snippet mitkIGTTutorialStep2.cpp Render Window
+
+Next, we need to set up the tracking device like we did in the last tutorial step \ref IGTTutorialStepFilterPipeline . We set additionally some boundaries for the tracking.
+
+\snippet mitkIGTTutorialStep2.cpp Setup Tracking Device
+
+\section igtTut2sec2 Create Objects
+
+Now we create a fixed and a moving object. For the moving (tracked) object, we decided for a blue cone. First, we set the name and color and add it to the data storage. Next, we need to create a visualitation filter to display it. Here, we connect in the visualization filter the output of our tracking device source to the cone representation.
+
+\snippet mitkIGTTutorialStep2.cpp Moving Object
+
+The fixed object is created accordingly, with a cylindrical shape and red color. As it is not tracked, we define an initial position and orientation, set it to the cylinder object and also store it as fixedNavigationData for later usage. As the object is not continuously updated, we don't need a visualization filter.
+
+\snippet mitkIGTTutorialStep2.cpp Fixed Object
+
+\section igtTut2sec3 The Tracking loop
+
+Before we start tracking, we need to initialize the rendering manager.
+
+\snippet mitkIGTTutorialStep2.cpp Initialize views
+
+We now move the tracked blue cone object for 75 steps, update the rendering and print the position to the output console.
+
+\snippet mitkIGTTutorialStep2.cpp Tracking
+
+\section igtTut2sec2 Final Transform
+
+Finally, we apply the new position of the tracked object (source->GetOutput) to the stored fixedNavigationData transform and update the rendering one last time.
+
+\snippet mitkIGTTutorialStep2.cpp Calculate Transform
+
+The red cylinder is now moved accodring to the tracked transform.
+
+\ref Return to the \ref IGTTutorialOverview "[IGT Tutorial Overview]"
+
+*/
\ No newline at end of file
diff --git a/Modules/IGT/Documentation/doxygen/IGTTutorialStep2_end.png b/Modules/IGT/Documentation/doxygen/IGTTutorialStep2_end.png
new file mode 100644
index 0000000000..0c1dab6571
Binary files /dev/null and b/Modules/IGT/Documentation/doxygen/IGTTutorialStep2_end.png differ
diff --git a/Modules/IGT/Documentation/doxygen/IGTTutorialStep2_init.png b/Modules/IGT/Documentation/doxygen/IGTTutorialStep2_init.png
new file mode 100644
index 0000000000..f0863748b2
Binary files /dev/null and b/Modules/IGT/Documentation/doxygen/IGTTutorialStep2_init.png differ
diff --git a/Modules/IGT/Documentation/doxygen/IGTTutorialStep2_overview.png b/Modules/IGT/Documentation/doxygen/IGTTutorialStep2_overview.png
new file mode 100644
index 0000000000..ea3307d239
Binary files /dev/null and b/Modules/IGT/Documentation/doxygen/IGTTutorialStep2_overview.png differ
diff --git a/Modules/IGT/Documentation/doxygen/IGTTutorialStep2_track.png b/Modules/IGT/Documentation/doxygen/IGTTutorialStep2_track.png
new file mode 100644
index 0000000000..508d8abcde
Binary files /dev/null and b/Modules/IGT/Documentation/doxygen/IGTTutorialStep2_track.png differ
diff --git a/Modules/IGT/Documentation/doxygen/IGTTutorialStep3.dox b/Modules/IGT/Documentation/doxygen/IGTTutorialStep3.dox
index c4896d294b..2b63a1eb1e 100644
--- a/Modules/IGT/Documentation/doxygen/IGTTutorialStep3.dox
+++ b/Modules/IGT/Documentation/doxygen/IGTTutorialStep3.dox
@@ -1,13 +1,17 @@
/**
-\page IGTTutorialStep3 Qt Gui Tutorial
+\page IGTTutorialStepSimplePlugin IGT QT Tutorial
-This tutorial shows how to integrate IGT in your plugin. You can enable this example in CMake with the
-option: MITK_BUILD_org.mitk.gui.qt.igtexamples. The code of the plugin/view is located in:
+This tutorial shows how to integrate IGT in your plugin. You can enable this example in cmake with the
+option: MITK_BUILD_org.mitk.gui.qt.igtexamples.
+
+\imageMacro{IGTTutorialStep3_cmake.png,"",15.90}
+
+The code of the plugin/view is located in:
MITK-Source/Plugins/org.mitk.gui.qt.igtexamples/src/internal/QmitkIGTTutorialView
The plugin will automatically be lodaed in the mitkWorkbench.
-More information can be found in the user manual: \ref org_imageguidedtherapytutorial "User manual"
+Please read the manual page on how to use this example: \ref org_imageguidedtherapytutorial
-\ref IGTTutorialStep2 "[Previous step]" \ref IGTTutorialStep4 "[Next step]" \ref IGTTutorialOverview "[IGT Tutorial Overview]"
+\ref Return to the \ref IGTTutorialOverview "[IGT Tutorial Overview]"
-*/
+*/
\ No newline at end of file
diff --git a/Modules/IGT/Documentation/doxygen/IGTTutorialStep3_cmake.png b/Modules/IGT/Documentation/doxygen/IGTTutorialStep3_cmake.png
new file mode 100644
index 0000000000..b1395c1f9a
Binary files /dev/null and b/Modules/IGT/Documentation/doxygen/IGTTutorialStep3_cmake.png differ
diff --git a/Modules/IGT/Documentation/doxygen/IGTTutorialStep4.dox b/Modules/IGT/Documentation/doxygen/IGTTutorialStep4.dox
index c3f4790915..4953500b3e 100644
--- a/Modules/IGT/Documentation/doxygen/IGTTutorialStep4.dox
+++ b/Modules/IGT/Documentation/doxygen/IGTTutorialStep4.dox
@@ -1,13 +1,17 @@
/**
-\page IGTTutorialStep4 Tracking Lab
+\page IGTTutorialStepTrackingLab Tracking Lab
The tracking lab is an IGT plugin containing various functions. You can enable this example in CMake with the
-option: MITK_BUILD_org.mitk.gui.qt.igtexamples. The code of the plugin/view is located in:
+option: MITK_BUILD_org.mitk.gui.qt.igtexamples.
+
+\imageMacro{IGTTutorialStep3_cmake.png,"",15.90}
+
+The code of the plugin/view is located in:
MITK-Source/Plugins/org.mitk.gui.qt.igtexamples/src/internal/QmitkIGTTrackingLabView
The plugin will automatically be lodaed in the mitkWorkbench.
-More information can be found in the user manual: \ref org_igttrackinglab "Tracking Lab User Manual"
+Please read the manual page on how to use this example: \ref org_igttrackinglab
-\ref IGTTutorialStep3 "[Previous step]" \ref IGTTutorialOverview "[IGT Tutorial Overview]"
+\ref Return to the \ref IGTTutorialOverview "[IGT Tutorial Overview]"
-*/
+*/
\ No newline at end of file
diff --git a/Modules/IGT/Documentation/doxygen/IGTTutorialStep5.dox b/Modules/IGT/Documentation/doxygen/IGTTutorialStep5.dox
new file mode 100644
index 0000000000..df22c27f1c
--- /dev/null
+++ b/Modules/IGT/Documentation/doxygen/IGTTutorialStep5.dox
@@ -0,0 +1,50 @@
+/**
+\page IGTTutorialStepAdvanced A deeper look into the IGT Plugins
+
+We already know the three views of the IGT tracking plugin from the first tutorial step (\ref IGTTutorialStepPluginIntroduction): \ref org_mitk_views_igttrackingtoolbox , \ref org_mitk_views_igtnavigationtoolmanager and \ref org_mitk_views_navigationdataplayer . While the first tutorial step only dealt with the usage of these views, we now want to have a deeper look at some parts of the code.
+
+\section AutoLoad Autoload all parameters from last session
+
+To increase the usability of the tracking toolbox, all parameters from the last session will be restored. Therefore, we will use the following code to save all parameters. It is also used in the specific tracking device widgets, but we will just have a look at one example, restoring some parameters like the Show-Tracking-Volume-Checkbox, the filename of the autosave path of the tool storage or the index of the tracking volume.
+
+To store the settings, the following code is used:
+
+\snippet QmitkMITKIGTTrackingToolboxView.cpp StoreUISettings
+
+We will reload it with
+\snippet QmitkMITKIGTTrackingToolboxView.cpp LoadUISettings
+
+\sectionLoadToolStorage Load Tool Storage
+
+This code will load a previously stored or autosaved tool storage:
+
+\snippet QmitkMITKIGTTrackingToolboxView.cpp LoadToolStorage
+
+TODO
+
+\section ThreadedTracking Threaded Tracking
+
+Usually, the tracking is done in a separate thread in order to still allow parallel usage of the workbench. If we track the devices in the same thread, the workbench might freeze.
+That's why we use thread workers
+\snippet QmitkMITKIGTTrackingToolboxView.cpp Thread 1
+...which are connected to functions
+\snippet QmitkMITKIGTTrackingToolboxView.cpp Thread 3
+
+The thread will be startet, if we connect a tracking device by pushing the connect button or start tracking etc:
+\snippet QmitkMITKIGTTrackingToolboxView.cpp Thread 4
+
+...and finished afterwards:
+\snippet QmitkMITKIGTTrackingToolboxView.cpp Thread 5
+
+You can access the data from the worker thread if needed:
+\snippet QmitkMITKIGTTrackingToolboxView.cpp Thread 6
+
+Which of the functions is finally executed will be chosen in the ThreadFunc:
+\snippet QmitkMITKIGTTrackingToolboxView.cpp Thread 7
+
+To deconstruct the workers, we first terminate the threads and then delete them
+\snippet QmitkMITKIGTTrackingToolboxView.cpp Thread 2
+
+\ref Return to the \ref IGTTutorialOverview "[IGT Tutorial Overview]"
+
+*/
\ No newline at end of file
diff --git a/Modules/IGT/Documentation/doxygen/IGTTutorialStep6.dox b/Modules/IGT/Documentation/doxygen/IGTTutorialStep6.dox
new file mode 100644
index 0000000000..664f5d7186
--- /dev/null
+++ b/Modules/IGT/Documentation/doxygen/IGTTutorialStep6.dox
@@ -0,0 +1,10 @@
+/**
+\page IGTTutorialStepOpenIGTLink OpenIGTLink Tutorial
+
+\li \subpage org_openigtlinkexample
+\li \subpage org_openigtlinkproviderexample
+\li \subpage org_openigtlinkplugin
+
+\ref Return to the \ref IGTTutorialOverview "[IGT Tutorial Overview]"
+
+*/
\ No newline at end of file
diff --git a/Modules/IGT/Tutorial/mitkIGTTutorialStep1.cpp b/Modules/IGT/Tutorial/mitkIGTTutorialStep1.cpp
index 09cbd8c4c4..7e0470901e 100644
--- a/Modules/IGT/Tutorial/mitkIGTTutorialStep1.cpp
+++ b/Modules/IGT/Tutorial/mitkIGTTutorialStep1.cpp
@@ -1,190 +1,204 @@
/*===================================================================
The Medical Imaging Interaction Toolkit (MITK)
Copyright (c) German Cancer Research Center,
Division of Medical and Biological Informatics.
All rights reserved.
This software is distributed WITHOUT ANY WARRANTY; without
even the implied warranty of MERCHANTABILITY or FITNESS FOR
A PARTICULAR PURPOSE.
See LICENSE.txt or http://www.mitk.org for details.
===================================================================*/
#include
#include
#include
#include
#include
#include "mitkNavigationDataDisplacementFilter.h"
#include
-#include
+#include
#include
//##Documentation
//## \brief A small console tutorial about MITK-IGT
int main(int /*argc*/, char* /*argv*/[])
{
+ //The next line starts a snippet to display this code in the documentation. If you don't revise the documentation, don't remove it!
+ //! [What we will do]
//*************************************************************************
// What we will do...
//*************************************************************************
//In this tutorial we build up a small navigation pipeline with a virtual tracking device
//which produce random positions and orientation so no additional hardware is required.
+ //
//The source of the pipeline is a TrackingDeviceSource object. This we connect to a simple
//filter which just displaces the positions with an offset. After that we use a recorder
- //to store this new positions and other information to disc in a XML file. After that we use
+ //to store this new positions and other information to disc in a XML file. After that, we use
//another source (NavigationDataPlayer) to replay the recorded data.
+ //! [What we will do]
+ //! [Part I Basic 1]
//*************************************************************************
// Part I: Basic initialization of the source and tracking device
//*************************************************************************
//First of all create a tracking device object and two tools for this "device".
//Here we take the VirtualTrackingDevice. This is not a real tracking device it just delivers random
//positions and orientations. You can use other/real tracking devices if you replace the following
//code with different tracking devices, e.g. mitk::NDITrackingDevice. The tools represent the
//sensors of the tracking device. The TrackingDevice fills the tools with data.
std::cout << "Generating TrackingDevice ..." << std::endl;
mitk::VirtualTrackingDevice::Pointer tracker = mitk::VirtualTrackingDevice::New();
tracker->AddTool("tool1");
tracker->AddTool("tool2");
+ //! [Part I Basic 1]
+ //! [Part I Basic 2]
//The tracking device object is used for the physical connection to the device. To use the
//data inside of our tracking pipeline we need a source. This source encapsulate the tracking device
//and provides objects of the type mitk::NavigationData as output. The NavigationData objects stores
//position, orientation, if the data is valid or not and special error informations in a covariance
//matrix.
//
//Typically the start of our pipeline is a TrackingDeviceSource. To work correct we have to set a
//TrackingDevice object. Attention you have to set the tools before you set the whole TrackingDevice
//object to the TrackingDeviceSource because the source need to know how many outputs should be
//generated.
std::cout << "Generating Source ..." << std::endl;
mitk::TrackingDeviceSource::Pointer source = mitk::TrackingDeviceSource::New();
source->SetTrackingDevice(tracker); //here we set the device for the pipeline source
source->Connect(); //here we connect to the tracking system
//Note we do not call this on the TrackingDevice object
source->StartTracking(); //start the tracking
//Now the source generates outputs.
+ //! [Part I Basic 2]
+ //! [Part II]
//*************************************************************************
// Part II: Create a NavigationDataToNavigationDataFilter
//*************************************************************************
//The next thing we do is using a NavigationDataToNavigationDataFilter. One of these filter is the
//very simple NavigationDataDisplacementFilter. This filter just changes the positions of the input
//NavigationData objects with an offset for each direction (X,Y,Z). The input of this filter is the
//source and the output of this filter is the "displaced" input.
std::cout << "Generating DisplacementFilter ..." << std::endl;
mitk::NavigationDataDisplacementFilter::Pointer displacer = mitk::NavigationDataDisplacementFilter::New();
mitk::Vector3D offset;
mitk::FillVector3D(offset, 10.0, 100.0, 1.0); //initialize the offset
displacer->SetOffset(offset); //now set the offset in the NavigationDataDisplacementFilter object
//Connect the two filters. You can use the ConnectTo method to automatically connect all outputs from one filter
// to inputs from another filter.
displacer->ConnectTo(source.GetPointer());
// Alternatively, you can manually connect inputs and outputs.
// The code below shows what the ConnectTo Methods does internally:
//
//for (unsigned int i = 0; i < source->GetNumberOfOutputs(); i++)
//{
// displacer->SetInput(i, source->GetOutput(i)); //here we connect to the displacement filter
//}
+ //! [Part II]
+ //! [Part III: Record the data with the NavigationDataRecorder]
+
//*************************************************************************
// Part III: Record the data with the NavigationDataRecorder
//*************************************************************************
//The next part of our pipeline is the recorder. The input of the recorder is the output of the displacement filter
//and the output is a XML file with the name "Test Output-0.xml", which is written with a NavigationDataSetWriter.
std::cout << "Start Recording ..." << std::endl;
//we need the stringstream for building up our filename
std::stringstream filename;
- //the .xml extension and an counter is NOT added automatically anymore -- that was the case in an earlier version
+ //the .xml extension and an counter is NOT added automatically anymore -- that was the case in an earlier version
filename << itksys::SystemTools::GetCurrentWorkingDirectory() << "/Test Output-0.xml";
std::cout << "Record to file: " << filename.str() << " ..." << std::endl;
mitk::NavigationDataRecorder::Pointer recorder = mitk::NavigationDataRecorder::New();
//now the output of the displacer object is connected to the recorder object
recorder->ConnectTo(displacer);
recorder->StartRecording(); //after finishing the settings you can start the recording mechanism
//now every update of the recorder stores one line into the file for
//each added NavigationData
for (unsigned int x = 0; x < 100; x++) //write 100 datasets
{
recorder->Update(); //the update causes one line in the XML file for every tool
//in this case two lines
itksys::SystemTools::Delay(100); //sleep a little
}
recorder->StopRecording(); //to get proper XML files you should stop recording
//if your application crashes during recording no data
//will be lost it is all stored to disc
//The IO-System needs a filename. Otherwise the output
//is redirected to the console. See MITK-Concepts page for more details on IO in MITK
mitk::IOUtil::SaveBaseData(recorder->GetNavigationDataSet(), filename.str());
+
+ //! [Part III: Record the data with the NavigationDataRecorder]
+
+ //! [Part IV: Play the data with the NavigationDataPlayer]
+
//*************************************************************************
- // Part IV: Play the data with the NavigationDataPlayer
+ // Part IV: Play the data with the NavigationDataSequentialPlayer
//*************************************************************************
//The recording is finished now so now we can play the data. The NavigationDataPlayer is similar
//to the TrackingDevice source. It also derives from NavigationDataSource. So you can use a player
//instead of a TrackingDeviceSource. The input of this player is a NavigationDataSet, which we
//read with a NavigationDataReader.
std::cout << "Start playing from file: " << filename.str() << " ..." << std::endl;
- mitk::NavigationDataPlayer::Pointer player = mitk::NavigationDataPlayer::New();
+ mitk::NavigationDataSequentialPlayer::Pointer player = mitk::NavigationDataSequentialPlayer::New();
mitk::NavigationDataSet::Pointer naviDataSet = dynamic_cast (mitk::IOUtil::LoadBaseData(filename.str()).GetPointer());
player->SetNavigationDataSet(naviDataSet);
- player->StartPlaying(); //this starts the player
- //From now on the player provides NavigationDatas in the order and
- //correct time as they were recorded
+ //From now on, the player provides NavigationDatas in a sequential order. The next position is given, as soon as "update" is called, so this player is not in real time.
+ //If you need the correct time of your tracking Data, use the NavigationDataPlayer instead and call "StartPlaying" and "StopPlaying".
//this connects the outputs of the player to the NavigationData objects
mitk::NavigationData::Pointer nd = player->GetOutput();
mitk::NavigationData::Pointer nd2 = player->GetOutput(1);
- for (unsigned int x=0; x<100; x++)
+ for (unsigned int x = 0; x < 100; x++)
{
if (nd.IsNotNull()) //check if the output is not null
{
- //With this update the NavigationData object propagates through the pipeline to get a new value.
- //In this case we only have a source (NavigationDataPlayer).
- nd->Update();
+ //With this call, we go to the next recorded data set.
+ player->GoToNextSnapshot();
- std::cout << x << ": 1:" << nd->GetPosition() << std::endl;
- std::cout << x << ": 2:" << nd2->GetPosition() << std::endl;
- std::cout << x << ": 1:" << nd->GetOrientation() << std::endl;
- std::cout << x << ": 2:" << nd2->GetOrientation() << std::endl;
+ MITK_INFO << "Time Step " << x;
+ MITK_INFO << "Tool 1:" << nd->GetPosition();
+ MITK_INFO << "Tool 2:" << nd2->GetPosition();
- itksys::SystemTools::Delay(100); //sleep a little like in the recorder part
+ itksys::SystemTools::Delay(100); //sleep a little like in the recorder part, just for nice reading...
}
}
- player->StopPlaying(); //This stops the player
- //With another call of StartPlaying the player will start again at the beginning of the file
itksys::SystemTools::Delay(2000);
std::cout << "finished" << std::endl;
-}
+
+ //! [Part IV: Play the data with the NavigationDataPlayer]
+}
\ No newline at end of file
diff --git a/Modules/IGT/Tutorial/mitkIGTTutorialStep2.cpp b/Modules/IGT/Tutorial/mitkIGTTutorialStep2.cpp
index b6f66b8059..e7e86dbe71 100644
--- a/Modules/IGT/Tutorial/mitkIGTTutorialStep2.cpp
+++ b/Modules/IGT/Tutorial/mitkIGTTutorialStep2.cpp
@@ -1,152 +1,183 @@
/*===================================================================
The Medical Imaging Interaction Toolkit (MITK)
Copyright (c) German Cancer Research Center,
Division of Medical and Biological Informatics.
All rights reserved.
This software is distributed WITHOUT ANY WARRANTY; without
even the implied warranty of MERCHANTABILITY or FITNESS FOR
A PARTICULAR PURPOSE.
See LICENSE.txt or http://www.mitk.org for details.
===================================================================*/
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include
-/**
- * \brief This tutorial shows how to compose navigation datas. Therefore we render two objects.
- * The first object is a cone that is tracked. The second object is a cylinder at a fixed position
- * relative to the cone. At the end of the tracking, the cylinder is moved to its new relative position
- * according to the last output of the tracking device.
- * In addition to IGT tutorial step 1, the objects are added to a datastorage. Furthermore, a renderwindow
- * is used for visual output.
- */
+
+//The next line starts a snippet to display this code in the documentation. If you don't revise the documentation, don't remove it!
+//! [What we will do]
+
+//*************************************************************************
+// What we will do...
+//*************************************************************************
+// This tutorial shows how to compose navigation datas. Therefore we render two objects.
+//The first object is a cone that is tracked. The second object is a cylinder at a fixed position
+//relative to the cone. At the end of the tracking, the cylinder is moved to its new relative position
+//according to the last output of the tracking device.
+//In addition to IGT tutorial step 1, the objects are added to a datastorage. Furthermore, a renderwindow
+//is used for visual output.
+
+//! [What we will do]
int main(int argc, char* argv[])
{
+ //*************************************************************************
+ // Set up Render Window and Tracking Device
+ //*************************************************************************
+ //! [Render Window]
//General code rendering the data in a renderwindow. See MITK Tutorial Step1 for more details.
mitk::StandaloneDataStorage::Pointer dataStorage = mitk::StandaloneDataStorage::New();
mitk::RenderWindow::Pointer renderWindow = mitk::RenderWindow::New();
mitk::DataNode::Pointer dataNode = mitk::DataNode::New();
//Here, we want a 3D renderwindow
renderWindow->GetRenderer()->SetMapperID(mitk::BaseRenderer::Standard3D);
- renderWindow->GetVtkRenderWindow()->SetSize( 500, 500 );
- renderWindow->GetRenderer()->Resize( 500, 500);
+ renderWindow->GetVtkRenderWindow()->SetSize(500, 500);
+ renderWindow->GetRenderer()->Resize(500, 500);
//Connect datastorage and renderwindow
renderWindow->GetRenderer()->SetDataStorage(dataStorage);
- // --------------begin of moving object code -------------------------- //
+ //! [Render Window]
+ //! [Setup Tracking Device]
//Virtual tracking device to generate random positions
mitk::VirtualTrackingDevice::Pointer tracker = mitk::VirtualTrackingDevice::New();
//Bounds (within the random numbers are generated) must be set before the tools are added
double bound = 10.0;
- mitk::ScalarType bounds[] = {-bound, bound, -bound, bound, -bound, bound};
+ mitk::ScalarType bounds[] = { -bound, bound, -bound, bound, -bound, bound };
tracker->SetBounds(bounds);
tracker->AddTool("tool1");
//Tracking device source to get the data
mitk::TrackingDeviceSource::Pointer source = mitk::TrackingDeviceSource::New();
source->SetTrackingDevice(tracker);
source->Connect();
+ //! [Setup Tracking Device]
+
+ //*************************************************************************
+ // Create Objects
+ //*************************************************************************
+
+ //! [Moving Object]
//Cone representation for rendering of the moving object
mitk::Cone::Pointer cone = mitk::Cone::New();
dataNode->SetData(cone);
dataNode->SetName("My tracked object");
dataNode->SetColor(0.0, 1.0, 1.0);
dataStorage->Add(dataNode);
//Filter for rendering the cone at correct postion and orientation
mitk::NavigationDataObjectVisualizationFilter::Pointer visualizer = mitk::NavigationDataObjectVisualizationFilter::New();
visualizer->SetInput(0, source->GetOutput());
visualizer->SetRepresentationObject(0, cone);
- source->StartTracking();
-
- // --------------end of moving object code -------------------------- //
-
- // --------------begin of fixed object code ------------------------- //
+ //! [Moving Object]
+ //! [Fixed Object]
//Cylinder representation for rendering of the fixed object
mitk::DataNode::Pointer cylinderNode = mitk::DataNode::New();
mitk::Cylinder::Pointer cylinder = mitk::Cylinder::New();
cylinderNode->SetData(cylinder);
cylinderNode->SetName("My fixed object");
cylinderNode->SetColor(1.0, 0.0, 0.0);
dataStorage->Add(cylinderNode);
//Define a rotation and a translation for the fixed object
mitk::Matrix3D rotationMatrix;
rotationMatrix.SetIdentity();
double alpha = 0.3;
rotationMatrix[1][1] = cos(alpha);
rotationMatrix[1][2] = -sin(alpha);
rotationMatrix[2][1] = sin(alpha);
rotationMatrix[2][2] = cos(alpha);
mitk::Vector3D offset;
offset.Fill(5.0);
//Add rotation and translation to affine transform
mitk::AffineTransform3D::Pointer affineTransform3D = mitk::AffineTransform3D::New();
affineTransform3D->SetOffset(offset);
affineTransform3D->SetMatrix(rotationMatrix);
//apply rotation and translation
mitk::NavigationData::Pointer fixedNavigationData = mitk::NavigationData::New(affineTransform3D);
cylinder->GetGeometry()->SetIndexToWorldTransform(fixedNavigationData->GetAffineTransform3D());
+ //! [Fixed Object]
- // --------------end of fixed object code ------------------------- //
+ //*************************************************************************
+ // The Tracking loop
+ //*************************************************************************
+ //! [Initialize views]
// Global reinit with the bounds of the virtual tracking device
mitk::TimeGeometry::Pointer timeGeometry = dataStorage->ComputeBoundingGeometry3D(dataStorage->GetAll());
mitk::BaseGeometry::Pointer geometry = timeGeometry->GetGeometryForTimeStep(0);
geometry->SetBounds(bounds);
- mitk::RenderingManager::GetInstance()->InitializeViews( geometry );
+ mitk::RenderingManager::GetInstance()->InitializeViews(geometry);
+ source->StartTracking();
+ //! [Initialize views]
+
+ //! [Tracking]
//Generate and render 75 time steps to move the tracked object
- for(int i=0; i < 75; ++i)
+ for (int i = 0; i < 75; ++i)
{
//Update the cone position
visualizer->Update();
//Update rendering
renderWindow->GetVtkRenderWindow()->Render();
mitk::RenderingManager::GetInstance()->RequestUpdateAll();
MITK_INFO << "Position " << source->GetOutput()->GetPosition();
//Slight delay for the random numbers
itksys::SystemTools::Delay(100);
}
//Stop the tracking device and disconnect it
//The tracking is done, now we want to move the fixed object to its correct relative position regarding the tracked object.
source->StopTracking();
source->Disconnect();
+ //! [Tracking]
+
+ //*************************************************************************
+ // Final Transform
+ //*************************************************************************
+ //! [Calculate Transform]
//Now the tracking is finished and we can use the transformation to move
//the fixed object to its correct position relative to the new position
//of the moving/tracked object. Therefore, we compose the navigation datas.
fixedNavigationData->Compose(source->GetOutput(), false);
//Update the transformation matrix of the cylinder
cylinder->GetGeometry()->SetIndexToWorldTransform(fixedNavigationData->GetAffineTransform3D());
//Update the rendering
renderWindow->GetVtkRenderWindow()->Render();
mitk::RenderingManager::GetInstance()->RequestUpdateAll();
//Wait a little before closing the renderwindow
itksys::SystemTools::Delay(2000);
-}
+ //! [Calculate Transform]
+}
\ No newline at end of file
diff --git a/Modules/IGTUI/Qmitk/QmitkNavigationToolManagementWidget.cpp b/Modules/IGTUI/Qmitk/QmitkNavigationToolManagementWidget.cpp
index 8373926f48..a0e0f9d703 100644
--- a/Modules/IGTUI/Qmitk/QmitkNavigationToolManagementWidget.cpp
+++ b/Modules/IGTUI/Qmitk/QmitkNavigationToolManagementWidget.cpp
@@ -1,404 +1,396 @@
/*===================================================================
The Medical Imaging Interaction Toolkit (MITK)
Copyright (c) German Cancer Research Center,
Division of Medical and Biological Informatics.
All rights reserved.
This software is distributed WITHOUT ANY WARRANTY; without
even the implied warranty of MERCHANTABILITY or FITNESS FOR
A PARTICULAR PURPOSE.
See LICENSE.txt or http://www.mitk.org for details.
===================================================================*/
#include "QmitkNavigationToolManagementWidget.h"
//mitk headers
#include "mitkTrackingTypes.h"
#include
#include
#include
#include
#include
#include
//qt headers
#include
#include
#include
//poco headers
#include
const std::string QmitkNavigationToolManagementWidget::VIEW_ID = "org.mitk.views.navigationtoolmanagementwidget";
QmitkNavigationToolManagementWidget::QmitkNavigationToolManagementWidget(QWidget* parent, Qt::WindowFlags f)
: QWidget(parent, f)
{
m_Controls = NULL;
CreateQtPartControl(this);
CreateConnections();
}
-
QmitkNavigationToolManagementWidget::~QmitkNavigationToolManagementWidget()
{
}
void QmitkNavigationToolManagementWidget::CreateQtPartControl(QWidget *parent)
+{
+ if (!m_Controls)
{
- if (!m_Controls)
- {
// create GUI widgets
m_Controls = new Ui::QmitkNavigationToolManagementWidgetControls;
m_Controls->setupUi(parent);
- }
-
- //Disable StorageControls in the beginning, because there is no storage to edit
- DisableStorageControls();
}
+ //Disable StorageControls in the beginning, because there is no storage to edit
+ DisableStorageControls();
+}
+
void QmitkNavigationToolManagementWidget::OnLoadTool()
{
- if(m_NavigationToolStorage->isLocked())
+ if (m_NavigationToolStorage->isLocked())
{
MessageBox("Storage is locked, cannot modify it. Maybe the tracking device which uses this storage is connected. If you want to modify the storage please disconnect the device first.");
- return;
+ return;
}
mitk::NavigationToolReader::Pointer myReader = mitk::NavigationToolReader::New();
- std::string filename = QFileDialog::getOpenFileName(NULL,tr("Add Navigation Tool"), "/", "*.IGTTool").toLatin1().data();
+ std::string filename = QFileDialog::getOpenFileName(NULL, tr("Add Navigation Tool"), "/", "*.IGTTool").toLatin1().data();
if (filename == "") return;
mitk::NavigationTool::Pointer readTool = myReader->DoRead(filename);
if (readTool.IsNull()) MessageBox("Error: " + myReader->GetErrorMessage());
else
- {
+ {
if (!m_NavigationToolStorage->AddTool(readTool))
- {
+ {
MessageBox("Error: Can't add tool!");
m_DataStorage->Remove(readTool->GetDataNode());
- }
+ }
UpdateToolTable();
m_NavigationToolStorage->UpdateMicroservice();
- }
+ }
}
void QmitkNavigationToolManagementWidget::OnSaveTool()
{
- //if no item is selected, show error message:
- if (m_Controls->m_ToolList->currentItem() == NULL) {MessageBox("Error: Please select tool first!");return;}
-
- mitk::NavigationToolWriter::Pointer myWriter = mitk::NavigationToolWriter::New();
- std::string filename = QFileDialog::getSaveFileName(NULL,tr("Save Navigation Tool"), "/", "*.IGTTool").toLatin1().data();
- filename.append(".IGTTool");
- if (filename == "") return;
- if (!myWriter->DoWrite(filename,m_NavigationToolStorage->GetTool(m_Controls->m_ToolList->currentIndex().row())))
- MessageBox("Error: "+ myWriter->GetErrorMessage());
+ //if no item is selected, show error message:
+ if (m_Controls->m_ToolList->currentItem() == NULL) { MessageBox("Error: Please select tool first!"); return; }
+ mitk::NavigationToolWriter::Pointer myWriter = mitk::NavigationToolWriter::New();
+ std::string filename = QFileDialog::getSaveFileName(NULL, tr("Save Navigation Tool"), "/", "*.IGTTool").toLatin1().data();
+ filename.append(".IGTTool");
+ if (filename == "") return;
+ if (!myWriter->DoWrite(filename, m_NavigationToolStorage->GetTool(m_Controls->m_ToolList->currentIndex().row())))
+ MessageBox("Error: " + myWriter->GetErrorMessage());
}
void QmitkNavigationToolManagementWidget::CreateConnections()
+{
+ if (m_Controls)
{
- if ( m_Controls )
- {
- //main widget page:
- connect( (QObject*)(m_Controls->m_AddTool), SIGNAL(clicked()), this, SLOT(OnAddTool()) );
- connect( (QObject*)(m_Controls->m_DeleteTool), SIGNAL(clicked()), this, SLOT(OnDeleteTool()) );
- connect( (QObject*)(m_Controls->m_EditTool), SIGNAL(clicked()), this, SLOT(OnEditTool()) );
- connect( (QObject*)(m_Controls->m_MoveToolUp), SIGNAL(clicked()), this, SLOT(OnMoveToolUp()) );
- connect( (QObject*)(m_Controls->m_MoveToolDown), SIGNAL(clicked()), this, SLOT(OnMoveToolDown()) );
- connect( (QObject*)(m_Controls->m_LoadStorage), SIGNAL(clicked()), this, SLOT(OnLoadStorage()) );
- connect( (QObject*)(m_Controls->m_SaveStorage), SIGNAL(clicked()), this, SLOT(OnSaveStorage()) );
- connect( (QObject*)(m_Controls->m_LoadTool), SIGNAL(clicked()), this, SLOT(OnLoadTool()) );
- connect( (QObject*)(m_Controls->m_SaveTool), SIGNAL(clicked()), this, SLOT(OnSaveTool()) );
- connect( (QObject*)(m_Controls->m_CreateNewStorage), SIGNAL(clicked()), this, SLOT(OnCreateStorage()) );
-
-
- //widget page "add tool":
- connect( (QObject*)(m_Controls->m_ToolCreationWidget), SIGNAL(Canceled()), this, SLOT(OnAddToolCancel()) );
- connect( (QObject*)(m_Controls->m_ToolCreationWidget), SIGNAL(NavigationToolFinished()), this, SLOT(OnAddToolSave()) );
- }
+ //main widget page:
+ connect((QObject*)(m_Controls->m_AddTool), SIGNAL(clicked()), this, SLOT(OnAddTool()));
+ connect((QObject*)(m_Controls->m_DeleteTool), SIGNAL(clicked()), this, SLOT(OnDeleteTool()));
+ connect((QObject*)(m_Controls->m_EditTool), SIGNAL(clicked()), this, SLOT(OnEditTool()));
+ connect((QObject*)(m_Controls->m_MoveToolUp), SIGNAL(clicked()), this, SLOT(OnMoveToolUp()));
+ connect((QObject*)(m_Controls->m_MoveToolDown), SIGNAL(clicked()), this, SLOT(OnMoveToolDown()));
+ connect((QObject*)(m_Controls->m_LoadStorage), SIGNAL(clicked()), this, SLOT(OnLoadStorage()));
+ connect((QObject*)(m_Controls->m_SaveStorage), SIGNAL(clicked()), this, SLOT(OnSaveStorage()));
+ connect((QObject*)(m_Controls->m_LoadTool), SIGNAL(clicked()), this, SLOT(OnLoadTool()));
+ connect((QObject*)(m_Controls->m_SaveTool), SIGNAL(clicked()), this, SLOT(OnSaveTool()));
+ connect((QObject*)(m_Controls->m_CreateNewStorage), SIGNAL(clicked()), this, SLOT(OnCreateStorage()));
+
+ //widget page "add tool":
+ connect((QObject*)(m_Controls->m_ToolCreationWidget), SIGNAL(Canceled()), this, SLOT(OnAddToolCancel()));
+ connect((QObject*)(m_Controls->m_ToolCreationWidget), SIGNAL(NavigationToolFinished()), this, SLOT(OnAddToolSave()));
}
+}
void QmitkNavigationToolManagementWidget::Initialize(mitk::DataStorage* dataStorage)
- {
+{
m_DataStorage = dataStorage;
- m_Controls->m_ToolCreationWidget->Initialize(m_DataStorage,"Tool0");
- }
+ m_Controls->m_ToolCreationWidget->Initialize(m_DataStorage, "Tool0");
+}
void QmitkNavigationToolManagementWidget::LoadStorage(mitk::NavigationToolStorage::Pointer storageToLoad)
+{
+ if (storageToLoad.IsNotNull())
{
- if(storageToLoad.IsNotNull())
- {
m_NavigationToolStorage = storageToLoad;
m_Controls->m_StorageName->setText(m_NavigationToolStorage->GetName().c_str());
EnableStorageControls();
- }
+ }
else
- {
+ {
m_NavigationToolStorage = NULL;
DisableStorageControls();
- }
+ }
UpdateToolTable();
m_NavigationToolStorage->UpdateMicroservice();
- }
+}
//##################################################################################
//############################## slots: main widget ################################
//##################################################################################
void QmitkNavigationToolManagementWidget::OnMoveToolUp()
{
if (m_NavigationToolStorage.IsNotNull())
{
int toolIndex = m_Controls->m_ToolList->currentIndex().row();
if (toolIndex >= 0)
{
mitk::NavigationTool::Pointer currentNavigationTool = m_NavigationToolStorage->GetTool(toolIndex);
if (currentNavigationTool.IsNotNull())
{
std::string currentIdentifier = currentNavigationTool->GetIdentifier();
int NewNumber = m_Controls->m_ToolList->currentIndex().row() - 1;
if (NewNumber < 0) { MITK_WARN << "Cannot move tool up because it is on the top!"; }
else { m_NavigationToolStorage->AssignToolNumber(currentIdentifier, NewNumber); }
UpdateToolTable();
m_NavigationToolStorage->UpdateMicroservice();
}
}
}
}
void QmitkNavigationToolManagementWidget::OnMoveToolDown()
{
if (m_NavigationToolStorage.IsNotNull())
{
int toolIndex = m_Controls->m_ToolList->currentIndex().row();
if (toolIndex >= 0)
{
mitk::NavigationTool::Pointer currentNavigationTool = m_NavigationToolStorage->GetTool(toolIndex);
if (currentNavigationTool.IsNotNull())
{
std::string currentIdentifier = currentNavigationTool->GetIdentifier();
int NewNumber = m_Controls->m_ToolList->currentIndex().row() + 1;
if (NewNumber >= m_NavigationToolStorage->GetToolCount()) { MITK_WARN << "Cannot move tool down because it is the last tool in this storage!"; }
else { m_NavigationToolStorage->AssignToolNumber(currentIdentifier, NewNumber); }
UpdateToolTable();
m_NavigationToolStorage->UpdateMicroservice();
}
}
}
}
-
void QmitkNavigationToolManagementWidget::OnAddTool()
+{
+ if (m_NavigationToolStorage->isLocked())
{
- if(m_NavigationToolStorage->isLocked())
- {
- MessageBox("Storage is locked, cannot modify it. Maybe the tracking device which uses this storage is connected. If you want to modify the storage please disconnect the device first.");
- return;
- }
- QString defaultIdentifier = "NavigationTool#"+QString::number(m_NavigationToolStorage->GetToolCount());
- QString defaultName = "NavigationTool"+QString::number(m_NavigationToolStorage->GetToolCount());
- m_Controls->m_ToolCreationWidget->Initialize(m_DataStorage,defaultIdentifier.toStdString(),defaultName.toStdString());
- m_edit = false;
- m_Controls->m_MainWidgets->setCurrentIndex(1);
- m_NavigationToolStorage->UpdateMicroservice();
+ MessageBox("Storage is locked, cannot modify it. Maybe the tracking device which uses this storage is connected. If you want to modify the storage please disconnect the device first.");
+ return;
}
+ QString defaultIdentifier = "NavigationTool#" + QString::number(m_NavigationToolStorage->GetToolCount());
+ QString defaultName = "NavigationTool" + QString::number(m_NavigationToolStorage->GetToolCount());
+ m_Controls->m_ToolCreationWidget->Initialize(m_DataStorage, defaultIdentifier.toStdString(), defaultName.toStdString());
+ m_edit = false;
+ m_Controls->m_MainWidgets->setCurrentIndex(1);
+ m_NavigationToolStorage->UpdateMicroservice();
+}
void QmitkNavigationToolManagementWidget::OnDeleteTool()
+{
+ //first: some checks
+ if (m_NavigationToolStorage->isLocked())
{
- //first: some checks
- if(m_NavigationToolStorage->isLocked())
- {
- MessageBox("Storage is locked, cannot modify it. Maybe the tracking device which uses this storage is connected. If you want to modify the storage please disconnect the device first.");
- return;
- }
- else if (m_Controls->m_ToolList->currentItem() == NULL) //if no item is selected, show error message:
- {
- MessageBox("Error: Please select tool first!");
- return;
- }
-
- m_DataStorage->Remove(m_NavigationToolStorage->GetTool(m_Controls->m_ToolList->currentIndex().row())->GetDataNode());
- m_NavigationToolStorage->DeleteTool(m_Controls->m_ToolList->currentIndex().row());
- UpdateToolTable();
- m_NavigationToolStorage->UpdateMicroservice();
+ MessageBox("Storage is locked, cannot modify it. Maybe the tracking device which uses this storage is connected. If you want to modify the storage please disconnect the device first.");
+ return;
}
+ else if (m_Controls->m_ToolList->currentItem() == NULL) //if no item is selected, show error message:
+ {
+ MessageBox("Error: Please select tool first!");
+ return;
+ }
+
+ m_DataStorage->Remove(m_NavigationToolStorage->GetTool(m_Controls->m_ToolList->currentIndex().row())->GetDataNode());
+ m_NavigationToolStorage->DeleteTool(m_Controls->m_ToolList->currentIndex().row());
+ UpdateToolTable();
+ m_NavigationToolStorage->UpdateMicroservice();
+}
void QmitkNavigationToolManagementWidget::OnEditTool()
+{
+ if (m_NavigationToolStorage->isLocked())
{
- if(m_NavigationToolStorage->isLocked())
- {
- MessageBox("Storage is locked, cannot modify it. Maybe the tracking device which uses this storage is connected. If you want to modify the storage please disconnect the device first.");
- return;
- }
- else if (m_Controls->m_ToolList->currentItem() == NULL) //if no item is selected, show error message:
- {
- MessageBox("Error: Please select tool first!");
- return;
- }
- mitk::NavigationTool::Pointer selectedTool = m_NavigationToolStorage->GetTool(m_Controls->m_ToolList->currentIndex().row());
- m_Controls->m_ToolCreationWidget->SetDefaultData(selectedTool);
- m_NavigationToolStorage->SetName("test");
- m_edit = true;
- m_Controls->m_MainWidgets->setCurrentIndex(1);
- m_NavigationToolStorage->UpdateMicroservice();
+ MessageBox("Storage is locked, cannot modify it. Maybe the tracking device which uses this storage is connected. If you want to modify the storage please disconnect the device first.");
+ return;
}
-
-void QmitkNavigationToolManagementWidget::OnCreateStorage()
+ else if (m_Controls->m_ToolList->currentItem() == NULL) //if no item is selected, show error message:
{
- QString storageName = QInputDialog::getText(NULL,"Storage Name","Name of the new tool storage:");
- if (storageName.isNull()) return;
- m_NavigationToolStorage = mitk::NavigationToolStorage::New(this->m_DataStorage);
- m_NavigationToolStorage->SetName(storageName.toStdString());
- m_Controls->m_StorageName->setText(m_NavigationToolStorage->GetName().c_str());
- EnableStorageControls();
- emit NewStorageAdded(m_NavigationToolStorage, storageName.toStdString());
+ MessageBox("Error: Please select tool first!");
+ return;
}
+ mitk::NavigationTool::Pointer selectedTool = m_NavigationToolStorage->GetTool(m_Controls->m_ToolList->currentIndex().row());
+ m_Controls->m_ToolCreationWidget->SetDefaultData(selectedTool);
+ m_NavigationToolStorage->SetName("test");
+ m_edit = true;
+ m_Controls->m_MainWidgets->setCurrentIndex(1);
+ m_NavigationToolStorage->UpdateMicroservice();
+}
+
+void QmitkNavigationToolManagementWidget::OnCreateStorage()
+{
+ QString storageName = QInputDialog::getText(NULL, "Storage Name", "Name of the new tool storage:");
+ if (storageName.isNull()) return;
+ m_NavigationToolStorage = mitk::NavigationToolStorage::New(this->m_DataStorage);
+ m_NavigationToolStorage->SetName(storageName.toStdString());
+ m_Controls->m_StorageName->setText(m_NavigationToolStorage->GetName().c_str());
+ EnableStorageControls();
+ emit NewStorageAdded(m_NavigationToolStorage, storageName.toStdString());
+}
void QmitkNavigationToolManagementWidget::OnLoadStorage()
+{
+ mitk::NavigationToolStorageDeserializer::Pointer myDeserializer = mitk::NavigationToolStorageDeserializer::New(m_DataStorage);
+ std::string filename = QFileDialog::getOpenFileName(NULL, tr("Open Navigation Tool Storage"), "/", tr("IGT Tool Storage (*.IGTToolStorage)")).toStdString();
+ if (filename == "") return;
+
+ try
{
- mitk::NavigationToolStorageDeserializer::Pointer myDeserializer = mitk::NavigationToolStorageDeserializer::New(m_DataStorage);
- std::string filename = QFileDialog::getOpenFileName(NULL, tr("Open Navigation Tool Storage"), "/", tr("IGT Tool Storage (*.IGTToolStorage)")).toStdString();
- if (filename == "") return;
+ mitk::NavigationToolStorage::Pointer tempStorage = myDeserializer->Deserialize(filename);
- try
+ if (tempStorage.IsNull()) MessageBox("Error" + myDeserializer->GetErrorMessage());
+ else
{
- mitk::NavigationToolStorage::Pointer tempStorage = myDeserializer->Deserialize(filename);
-
- if (tempStorage.IsNull()) MessageBox("Error" + myDeserializer->GetErrorMessage());
- else
- {
- Poco::Path myPath = Poco::Path(filename.c_str());
- tempStorage->SetName(myPath.getFileName()); //set the filename as name for the storage, so the user can identify it
- this->LoadStorage(tempStorage);
- emit NewStorageAdded(m_NavigationToolStorage,myPath.getFileName());
- }
+ Poco::Path myPath = Poco::Path(filename.c_str());
+ tempStorage->SetName(myPath.getFileName()); //set the filename as name for the storage, so the user can identify it
+ this->LoadStorage(tempStorage);
+ emit NewStorageAdded(m_NavigationToolStorage, myPath.getFileName());
}
- catch (const mitk::Exception& exception)
- {
- MessageBox(exception.GetDescription());
- }
- m_NavigationToolStorage->UpdateMicroservice();
}
-
-void QmitkNavigationToolManagementWidget::OnSaveStorage()
+ catch (const mitk::Exception& exception)
{
- //read in filename
- QString filename = QFileDialog::getSaveFileName(NULL, tr("Save Navigation Tool Storage"), "/", tr("IGT Tool Storage (*.IGTToolStorage)"));
- if (filename.isEmpty()) return; //canceled by the user
+ MessageBox(exception.GetDescription());
+ }
+ m_NavigationToolStorage->UpdateMicroservice();
+}
- // add file extension if it wasn't added by the file dialog
- if ( filename.right(15) != ".IGTToolStorage" ) { filename += ".IGTToolStorage"; }
+void QmitkNavigationToolManagementWidget::OnSaveStorage()
+{
+ //read in filename
+ QString filename = QFileDialog::getSaveFileName(NULL, tr("Save Navigation Tool Storage"), "/", tr("IGT Tool Storage (*.IGTToolStorage)"));
+ if (filename.isEmpty()) return; //canceled by the user
- //serialize tool storage
- mitk::NavigationToolStorageSerializer::Pointer mySerializer = mitk::NavigationToolStorageSerializer::New();
- if (!mySerializer->Serialize(filename.toStdString(),m_NavigationToolStorage))
- {
- MessageBox("Error: " + mySerializer->GetErrorMessage());
- return;
- }
- Poco::Path myPath = Poco::Path(filename.toStdString());
- m_Controls->m_StorageName->setText(QString::fromStdString(myPath.getFileName()));
+ // add file extension if it wasn't added by the file dialog
+ if (filename.right(15) != ".IGTToolStorage") { filename += ".IGTToolStorage"; }
+ //serialize tool storage
+ mitk::NavigationToolStorageSerializer::Pointer mySerializer = mitk::NavigationToolStorageSerializer::New();
+ if (!mySerializer->Serialize(filename.toStdString(), m_NavigationToolStorage))
+ {
+ MessageBox("Error: " + mySerializer->GetErrorMessage());
+ return;
}
-
+ Poco::Path myPath = Poco::Path(filename.toStdString());
+ m_Controls->m_StorageName->setText(QString::fromStdString(myPath.getFileName()));
+}
//##################################################################################
//############################## slots: add tool widget ############################
//##################################################################################
void QmitkNavigationToolManagementWidget::OnAddToolSave()
- {
- mitk::NavigationTool::Pointer newTool = m_Controls->m_ToolCreationWidget->GetCreatedTool();
-
- if (m_edit) //here we edit a existing tool
- {
- mitk::NavigationTool::Pointer editedTool = m_NavigationToolStorage->GetTool(m_Controls->m_ToolList->currentIndex().row());
- editedTool->Graft(newTool);
- }
- else //here we create a new tool
- {
- m_NavigationToolStorage->AddTool(newTool);
- }
-
- UpdateToolTable();
+{
+ mitk::NavigationTool::Pointer newTool = m_Controls->m_ToolCreationWidget->GetCreatedTool();
- m_Controls->m_MainWidgets->setCurrentIndex(0);
- m_NavigationToolStorage->UpdateMicroservice();
+ if (m_edit) //here we edit a existing tool
+ {
+ mitk::NavigationTool::Pointer editedTool = m_NavigationToolStorage->GetTool(m_Controls->m_ToolList->currentIndex().row());
+ editedTool->Graft(newTool);
}
-
-void QmitkNavigationToolManagementWidget::OnAddToolCancel()
+ else //here we create a new tool
{
- m_Controls->m_MainWidgets->setCurrentIndex(0);
+ m_NavigationToolStorage->AddTool(newTool);
}
+ UpdateToolTable();
+
+ m_Controls->m_MainWidgets->setCurrentIndex(0);
+ m_NavigationToolStorage->UpdateMicroservice();
+}
+
+void QmitkNavigationToolManagementWidget::OnAddToolCancel()
+{
+ m_Controls->m_MainWidgets->setCurrentIndex(0);
+}
//##################################################################################
//############################## private help methods ##############################
//##################################################################################
void QmitkNavigationToolManagementWidget::UpdateToolTable()
- {
+{
m_Controls->m_ToolList->clear();
- if(m_NavigationToolStorage.IsNull()) return;
- for(int i=0; iGetToolCount(); i++)
+ if (m_NavigationToolStorage.IsNull()) return;
+ for (int i = 0; i < m_NavigationToolStorage->GetToolCount(); i++)
+ {
+ QString currentTool = "Tool" + QString::number(i) + ": " + QString(m_NavigationToolStorage->GetTool(i)->GetDataNode()->GetName().c_str()) + " ";
+
+ currentTool += "(" + QString::fromStdString(m_NavigationToolStorage->GetTool(i)->GetTrackingDeviceType()) + "/";
+
+ switch (m_NavigationToolStorage->GetTool(i)->GetType())
{
- QString currentTool = "Tool" + QString::number(i) + ": " + QString(m_NavigationToolStorage->GetTool(i)->GetDataNode()->GetName().c_str())+ " ";
-
- currentTool += "(" + QString::fromStdString(m_NavigationToolStorage->GetTool(i)->GetTrackingDeviceType()) + "/";
-
- switch (m_NavigationToolStorage->GetTool(i)->GetType())
- {
- case mitk::NavigationTool::Instrument:
- currentTool += "Instrument)"; break;
- case mitk::NavigationTool::Fiducial:
- currentTool += "Fiducial)"; break;
- case mitk::NavigationTool::Skinmarker:
- currentTool += "Skinmarker)"; break;
- default:
- currentTool += "Unknown)";
- }
- m_Controls->m_ToolList->addItem(currentTool);
+ case mitk::NavigationTool::Instrument:
+ currentTool += "Instrument)"; break;
+ case mitk::NavigationTool::Fiducial:
+ currentTool += "Fiducial)"; break;
+ case mitk::NavigationTool::Skinmarker:
+ currentTool += "Skinmarker)"; break;
+ default:
+ currentTool += "Unknown)";
}
-
+ m_Controls->m_ToolList->addItem(currentTool);
}
+}
void QmitkNavigationToolManagementWidget::MessageBox(std::string s)
- {
+{
QMessageBox msgBox;
msgBox.setText(s.c_str());
msgBox.exec();
- }
+}
void QmitkNavigationToolManagementWidget::DisableStorageControls()
{
m_Controls->m_StorageName->setText("");
m_Controls->m_AddTool->setEnabled(false);
m_Controls->m_LoadTool->setEnabled(false);
m_Controls->m_MoveToolUp->setEnabled(false);
m_Controls->m_MoveToolDown->setEnabled(false);
m_Controls->m_selectedLabel->setEnabled(false);
m_Controls->m_DeleteTool->setEnabled(false);
m_Controls->m_EditTool->setEnabled(false);
m_Controls->m_SaveTool->setEnabled(false);
m_Controls->m_ToolList->setEnabled(false);
m_Controls->m_SaveStorage->setEnabled(false);
m_Controls->m_ToolLabel->setEnabled(false);
}
void QmitkNavigationToolManagementWidget::EnableStorageControls()
{
m_Controls->m_AddTool->setEnabled(true);
m_Controls->m_LoadTool->setEnabled(true);
m_Controls->m_MoveToolUp->setEnabled(true);
m_Controls->m_MoveToolDown->setEnabled(true);
m_Controls->m_selectedLabel->setEnabled(true);
m_Controls->m_DeleteTool->setEnabled(true);
m_Controls->m_EditTool->setEnabled(true);
m_Controls->m_SaveTool->setEnabled(true);
m_Controls->m_ToolList->setEnabled(true);
m_Controls->m_SaveStorage->setEnabled(true);
m_Controls->m_ToolLabel->setEnabled(true);
-}
+}
\ No newline at end of file
diff --git a/Modules/IGTUI/Qmitk/QmitkNavigationToolManagementWidget.h b/Modules/IGTUI/Qmitk/QmitkNavigationToolManagementWidget.h
index 60e23cd47c..afe0874bcb 100644
--- a/Modules/IGTUI/Qmitk/QmitkNavigationToolManagementWidget.h
+++ b/Modules/IGTUI/Qmitk/QmitkNavigationToolManagementWidget.h
@@ -1,112 +1,112 @@
/*===================================================================
The Medical Imaging Interaction Toolkit (MITK)
Copyright (c) German Cancer Research Center,
Division of Medical and Biological Informatics.
All rights reserved.
This software is distributed WITHOUT ANY WARRANTY; without
even the implied warranty of MERCHANTABILITY or FITNESS FOR
A PARTICULAR PURPOSE.
See LICENSE.txt or http://www.mitk.org for details.
===================================================================*/
#ifndef QMITKNAVIGATIONTOOLMANAGEMENTWIDGET_H
#define QMITKNAVIGATIONTOOLMANAGEMENTWIDGET_H
//QT headers
#include
//mitk headers
#include "MitkIGTUIExports.h"
#include "mitkNavigationTool.h"
#include
//ui header
#include "ui_QmitkNavigationToolManagementWidgetControls.h"
- /** Documentation:
- * \brief An object of this class offers an UI to manage NavigationTools and
- * NavigationToolStorages. This means a user may create, save and load
- * single NavigationTools and/or NavigationToolStorages with this widget.
- *
- * Be sure to call the Initialize-methode before you start the widget
- * otherwise some errors might occure.
- *
- * \ingroup IGTUI
- */
+/** Documentation:
+ * \brief An object of this class offers an UI to manage NavigationTools and
+ * NavigationToolStorages. This means a user may create, save and load
+ * single NavigationTools and/or NavigationToolStorages with this widget.
+ *
+ * Be sure to call the Initialize-methode before you start the widget
+ * otherwise some errors might occure.
+ *
+ * \ingroup IGTUI
+ */
class MITKIGTUI_EXPORT QmitkNavigationToolManagementWidget : public QWidget
{
Q_OBJECT
- public:
- static const std::string VIEW_ID;
+public:
+ static const std::string VIEW_ID;
- /** Initializes the widget. Has to be called before any action, otherwise errors might occur. */
- void Initialize(mitk::DataStorage* dataStorage);
+ /** Initializes the widget. Has to be called before any action, otherwise errors might occur. */
+ void Initialize(mitk::DataStorage* dataStorage);
- /** Loads a storage to the widget. The old storage storage is dropped, so be careful, if the
- * storage is not saved somewhere else it might be lost. You might want to ask the user if he
- * wants to save the storage to the harddisk before calling this method.
- * @param storageToLoad This storage will be loaded and might be modified by the user.
- */
- void LoadStorage(mitk::NavigationToolStorage::Pointer storageToLoad);
+ /** Loads a storage to the widget. The old storage storage is dropped, so be careful, if the
+ * storage is not saved somewhere else it might be lost. You might want to ask the user if he
+ * wants to save the storage to the harddisk before calling this method.
+ * @param storageToLoad This storage will be loaded and might be modified by the user.
+ */
+ void LoadStorage(mitk::NavigationToolStorage::Pointer storageToLoad);
- QmitkNavigationToolManagementWidget(QWidget* parent = 0, Qt::WindowFlags f = 0);
- ~QmitkNavigationToolManagementWidget();
+ QmitkNavigationToolManagementWidget(QWidget* parent = 0, Qt::WindowFlags f = 0);
+ ~QmitkNavigationToolManagementWidget();
- signals:
+signals:
- /** This signal is emmited if a new storage was added by the widget itself, e.g. because
- * a storage was loaded from the harddisk.
- * @param newStorage Holds the new storage which was added.
- * @param storageName Name of the new storage (e.g. filename)
- */
- void NewStorageAdded(mitk::NavigationToolStorage::Pointer newStorage, std::string storageName);
+ /** This signal is emmited if a new storage was added by the widget itself, e.g. because
+ * a storage was loaded from the harddisk.
+ * @param newStorage Holds the new storage which was added.
+ * @param storageName Name of the new storage (e.g. filename)
+ */
+ void NewStorageAdded(mitk::NavigationToolStorage::Pointer newStorage, std::string storageName);
protected slots:
- //main widget page:
- void OnAddTool();
- void OnDeleteTool();
- void OnEditTool();
- void OnLoadTool();
- void OnSaveTool();
- void OnMoveToolUp();
- void OnMoveToolDown();
- void OnLoadStorage();
- void OnSaveStorage();
- void OnCreateStorage();
+ //main widget page:
+ void OnAddTool();
+ void OnDeleteTool();
+ void OnEditTool();
+ void OnLoadTool();
+ void OnSaveTool();
+ void OnMoveToolUp();
+ void OnMoveToolDown();
+ void OnLoadStorage();
+ void OnSaveStorage();
+ void OnCreateStorage();
- //widget page "add tool":
- void OnAddToolCancel();
- void OnAddToolSave();
+ //widget page "add tool":
+ void OnAddToolCancel();
+ void OnAddToolSave();
- protected:
+protected:
- /// \brief Creation of the connections
- virtual void CreateConnections();
+ /// \brief Creation of the connections
+ virtual void CreateConnections();
- virtual void CreateQtPartControl(QWidget *parent);
+ virtual void CreateQtPartControl(QWidget *parent);
- Ui::QmitkNavigationToolManagementWidgetControls* m_Controls;
+ Ui::QmitkNavigationToolManagementWidgetControls* m_Controls;
- /** @brief holds the DataStorage */
- mitk::DataStorage* m_DataStorage;
+ /** @brief holds the DataStorage */
+ mitk::DataStorage* m_DataStorage;
- /** @brief holds the NavigationToolStorage we are working with. */
- mitk::NavigationToolStorage::Pointer m_NavigationToolStorage;
+ /** @brief holds the NavigationToolStorage we are working with. */
+ mitk::NavigationToolStorage::Pointer m_NavigationToolStorage;
- /** @brief shows if we are in edit mode, if not we create new navigation tool objects. */
- bool m_edit;
+ /** @brief shows if we are in edit mode, if not we create new navigation tool objects. */
+ bool m_edit;
- //############## private help methods #######################
- void MessageBox(std::string s);
- void UpdateToolTable();
- void DisableStorageControls();
- void EnableStorageControls();
+ //############## private help methods #######################
+ void MessageBox(std::string s);
+ void UpdateToolTable();
+ void DisableStorageControls();
+ void EnableStorageControls();
};
#endif
diff --git a/Modules/US/Documentation/doxygen/USModule.dox b/Modules/US/Documentation/doxygen/USModule.dox
index 64fe2f4f92..257f6e3d15 100644
--- a/Modules/US/Documentation/doxygen/USModule.dox
+++ b/Modules/US/Documentation/doxygen/USModule.dox
@@ -1,93 +1,93 @@
/**
\page USModulePage The Ultrasound Module
\tableofcontents
\section USModulePageOverview Overview
The Ultrasound Module provides a microservice based API for ultrasound devices .
The main features are:
Microservice-enabled life cycle management, allowing other modules to easily consume mitk::USDevice-functionality.
Handling and processing of ultrasound image data.
Fast image preprocessing capabilities (gray scale conversion, cropping) via OpenCV.
Advanced image processing functions via mitk filters.
The mitk::USVideoDevice class allows to connect any ultrasound device with a video-out via a frame grabber.
Connection of API-Enabled devices (specifically the Telemed LogicScan 128 is implemented).
The submodule USHardwareTelemed provides classes for handling a Telemed API device (mitk::USTelemedDevice).
Control of API-enabled Devices via MITK (Widgets for basic B mode controls and probe selection are available).
- Designed to interact with the \link IGTGeneralModulePage IGT Module \endlink for tracking functionality.
+ Designed to interact with the \link NavigationGeneralModulePage IGT Module \endlink for tracking functionality.
This module requires OpenCV to be enabled in the superbuild options via CMake.
Its functionality is made available to the user via the \link org_mitk_gui_qt_ultrasound UltrasoundSupport plugin \endlink
Documentation on how to use Telemed API devices can be found on \subpage USHardwareTelemedPage.
\section USDeviceHierarchy Ultrasound Device Hierarchy
Ultrasound Devices are managed in a simple hierarchy:
\imageMacro{ClassDiagramUSModuleOverview.png,"",14.92}
mitk::USDevice: The common superclass for all ultrasound devices. Deriving from this class will make sure that US-specific GUI-Components will be able to interact with your class.
Especially, the microservice life cycle is modeled in this class.
mitk::USImageSource: Abstract class used by the mitk::USDevice for getting the images from the ultrasound device. The images are filtered by one ore more mitk::AbstractOpenCVImageFilter if they were set to the mitk::USImageSource object.
Each concrete subclass of mitk::USDevice has to subclass mitk::USImageSource to handle the actual receiving of images from the ultrasound device.
Two devices are implemented in the ultrasound module:
mitk::USVideoDevice: This class can be used for every ultrasound device that is connected to the PC via a frame grabber or a similar video input device.
The \link org_mitk_gui_qt_ultrasound UltrasoundSupport plugin \endlink enables the user to create instances of mitk::USVideoDevice.
There also is a reusable Widget for this Task in the USUI Module.
mitk::USTelemedDevice: This class can be used for API-enabled ultrasound devices of Telemed (e.g. Telemed LogicScan 128).
One can add another device by subclassing mitk::USDevice and mitk::USImageSource. Additionally the control interfaces may be implemented (see \link USControlInterfaces).
\section USDeviceLifeCycle Ultrasound Device Life Cycle
Each mitk::USDevice follows a life cycle handling the availabilty as a micro service and the connection to the hardware:
\imageMacro{MicroServiceLifeCycle.png,"",16.00}
For changing the states corresponding methods are available in mitk::USDevice: mitk::USDevice::Initialize() for initialization, mitk::USDevice::Connect() for connecting, mitk::USDevice::Disconnect() for disconnecting and so on. For example, once an object of mitk::USDevice is constructed it can be made available as a micro service via a call to mitk::USDevice::Initialize(). The state changes to Initialized then and the device is available to other modules or plugins (\link org_mitk_gui_qt_ultrasound UltrasoundSupport\endlink, QmitkUSDeviceManagerWidget) through the micro service framework.
The methods for changing the states should not be overwritten by sublcasses. Instead mitk::USDevice::OnInitialization(), mitk::USDevice::OnConnection() and so on can be overwritten for handling everything that has to be done on the corresponding state change.
When the mitk::USDevice object was created at first it is available just locally. An initialized device is available as a micro service, but not connected to the real hardware. A connected device is connected to the hardware, but no acquiring images. Finally, an activated device is acquiring images from the ultrasound hardware.
\section USControlInterfaces Control Interfaces for API Devices
Capabilities of API-based ultrasound devices are available through control interfaces which are shown below:
\imageMacro{USControlInterfaces.png,"",16.00}
The control interfaces mitk::USControlInterfaceProbes and mitk::USControlInterfaceBMode are available, while mitk::USControlInterfaceDoppler is empty at the moment. Every sublcass of mitk::USDevice can use an implementation of each of these interfaces, but this is not necessary. The mitk::USVideoDevice for example uses a custom control interface only (mitk::USVideoDeviceCustomControls), which is a subclass of mitk::USAbstractControlInterface. The mitk::USTelemedDevice uses mitk::USTelemedBModeControls for handling the ultrasound b mode and mitk::USTelemedProbesControls for handling the connected ultrasound probe.
Each custom control interface needs its own Widget (subclassed of QmitkUSAbstractCustomWidget), if it should be possible to control its functionality by using the \link org_mitk_gui_qt_ultrasound UltrasoundSupport\endlink plugin. For the standard interfaces mitk::USControlInterfaceProbes, mitk::USControlInterfaceBMode and mitk::USControlInterfaceDoppler there are Widgets available in the USUI module (QmitkUSControlsProbesWidget, QmitkUSControlsBModeWidget, QmitkUSControlsDopplerWidget) which can be used by plugins. For each Widget an object of the corresponding control interface must be set on its constructor call. A class diagram showing how the Widgets are connected to the control interfaces can be seen below:
\imageMacro{USControlWidgets.png,"",16.00}
A plugin can use the Widgets by creating a new object of the Widget and setting the corresponding interface object of the mitk::USDevice which should be controlled. How to use custom widgets is described in the class documentation of QmitkUSAbstractCustomWidget.
\section USDWidgets Available Widgets
There are some Widgets available in the USUI module that can be used for plugin development: a device management Widget, a Widget for creating new mitk::USVideoDevice objects and widgets for the control interfaces of API device.
The usage of the Widgets is described in more detail in the \link org_mitk_gui_qt_ultrasound UltrasoundSupport Plugin Documentation\endlink.
\subsection USQmitkUSDeviceManagerWidget QmitkUSDeviceManagerWidget
The QmitkUSDeviceManagerWidget can view every connected mitk::USDevice and allows the user to activate and deactivate devices. Additionally mitk::USVideoDevice can be created using the QmitkUSNewVideoDeviceWidget and removed by a corresponding button.
\subsection USQmitkNewVideoDeviceWidget QmitkUSNewVideoDeviceWidget
The QmitkUSNewVideoDeviceWidget allows the user to configure a frame grabber or other video input as a mitk::USVideoDevice.
\subsection USControlInterfaceWidgets Control Interface Widgets
There exists several widgets for controling ultrasound devices: QmitkUSControlsBModeWidget, QmitkUSControlsProbesWidget, QmitkUSControlsCustomVideoDeviceWidget. Own custom control widgets can be added by subclassing the available QmitkUSAbstractCustomWidget.
*/
\ No newline at end of file
diff --git a/Plugins/org.mitk.gui.qt.igtexamples/documentation/UserManual/QmitkIGTTtrackingLab.dox b/Plugins/org.mitk.gui.qt.igtexamples/documentation/UserManual/QmitkIGTTrackingLab.dox
similarity index 89%
rename from Plugins/org.mitk.gui.qt.igtexamples/documentation/UserManual/QmitkIGTTtrackingLab.dox
rename to Plugins/org.mitk.gui.qt.igtexamples/documentation/UserManual/QmitkIGTTrackingLab.dox
index 55836a3ded..ea52e517f2 100644
--- a/Plugins/org.mitk.gui.qt.igtexamples/documentation/UserManual/QmitkIGTTtrackingLab.dox
+++ b/Plugins/org.mitk.gui.qt.igtexamples/documentation/UserManual/QmitkIGTTrackingLab.dox
@@ -1,56 +1,67 @@
/**
\page org_igttrackinglab IGT Tutorial Step 4: The IGT-TrackingLab
Available sections:
- \ref QmitkIGTTrackingLabUsersManualOverview
- \ref QmitkIGTTrackingLabUsersManualPrel
- \ref QmitkIGTTrackingLabUsersManualConf
- \ref QmitkIGTTrackingLabUsersManualIntialReg
- \ref QmitkIGTTrackingLabUsersManualPermReg
- \ref QmitkIGTTrackingLabUsersManualPtSetRec
- \ref QmitkIGTTrackingLabUsersManualCamView
\section QmitkIGTTrackingLabUsersManualOverview Introduction
-The IGT-TrackingLab is the last step of the IGT tutorial. It is a plugin which shows examples usage for many IGT classes and is also an example navigation implemented with IGT. In the following you can learn how to use the plugin by reading this manual together with the source code.
+The IGT-TrackingLab is the last step of the IGT tutorial. It is a plugin which shows examples usage for many IGT classes and is also an example navigation implemented with IGT. In the following you can learn how to use the plugin by reading this manual together with the source code. Most important code passages are included in this manual.
+
+The symbol of the Tracking Lab View is the following:
+
+\imageMacro{../../resources/IgtTrackingLab.png,"",2}
+
+The view looks like this:
+\imageMacro{IGT_TrackingLab_PluginView.png,"",15.90}
+
+TODO - explain here, what will happen... e.g. register a book, ...
\section QmitkIGTTrackingLabUsersManualPrel Preliminaries
First connect your tracking device to your PC. Then start the MITK Workbench and configure your tracking device using the \ref org_mitk_views_igttrackingtoolbox "Tracking Toolbox View".
+TODO - here should be an option to use previously recorded data.
+
\section QmitkIGTTrackingLabUsersManualConf Configuration
-Select the desired Navigation Data Source . Now it's time to define which tool shall be used as object marker and which tool shall be used as pointer. Next load the Book surface
+Select the desired Navigation Data Source . Now it's time to define which tool shall be used as object marker and which tool shall be used as pointer. Next load the Book surface
provided with the example data (e.g. book.stl from the MITK-Data repository which comes with every superbuild or may also be checked out separately) into MITK. Fixate the object marker on a real book of your choice. Now we need to tell MITK that the object marker has been fixated on a physical object. To do this, select the Book as surface in the Object Selection submenu.
\section QmitkIGTTrackingLabUsersManualIntialReg Initial Registration
Now we need to register the object marker to the surface it's fixed upon, in our case the book. To do this, first press the initial registration button. For MITK to be able to do this registration, we need to
1. Select landmarks on the virtual object (e.g. the corners of the book)
Press the plus button in the Image fiducials column. Shift + click on the corners on the book in the MITK Display .
2. Point to the corresponding landmarks in the real world using the pointer.
Now press the plus button in the Real world fiducials column and point to the corners on the real book. Press Add current instrument position whenever you targeted a corner to tell MITK this is the desired landmark. Make sure you select the "real" edges in the same order as the edges in the image.
Press Register to finalize the initial registration.
Now the object marker is registered onto the book. You can see this in the MITK image. If needed the FRE is shown in the widget.
\section QmitkIGTTrackingLabUsersManualPermReg Permanent Registration
Now everything is set up and registered. We can thus activate permanent registration to continuously track the object, the object marker and the pointer.
For this, simply press the Permanent Registration button and select Activate permanent registration . You can now move the book in the real world and see the same movement in the MITK Display . A nice test to see if everything was correctly registered is to target the corners of the book with the pointer and check if the correct corners are pointed to in the MITK Display .
\section QmitkIGTTrackingLabUsersManualPtSetRec PointSet Recording
A user might now want to track a tool's trajectory. For this, the PointSet Recording was created.
First click on PointSet Recording . Now select your tracking source and the tool whose trajectory shall be recorded. Activate the Point Set Recording checkbox. In the MITK Display little green points will now be drawn for every measured position. Deactivate the checkbox to stop recording. The trajectory is saved in the PointSet Recorded Points visible in the Data Manager.
\section QmitkIGTTrackingLabUsersManualCamView Camera View
Another possible tracking application is the Camera View. Here, a virtual camera is placed at the pointers tip and its images are shown in the MITK Display.
Select Camera View and as usual the Tracking Source and the tool you want to place the virtual camera on. Activate the "Activate Needle View" checkbox and move the pointer around the book. You can now see the book from the pointers perspective.
You may need to adjust the Needle View Direction and the View Up Vector. This is always relative to your tools coordinate center origin. An example of the NDI pointer tool coordinate system is shown below:
\imageMacro{QmitkIGTExamples_Tool.png,"The coordinate system of the NDI pointing tool",16.00}
In the above case, the camera should look in inverse z-direction, and the view up vector should probably be set to positive x. Note this is just an example and may be different depending on your pointer.
-
-*/
+\ref Return to the \ref IGTTutorialOverview "[IGT Tutorial Overview]"
+*/
\ No newline at end of file
diff --git a/Plugins/org.mitk.gui.qt.igtexamples/documentation/UserManual/QmitkIGTTutorial.dox b/Plugins/org.mitk.gui.qt.igtexamples/documentation/UserManual/QmitkIGTTutorial.dox
index 60a919c5fb..6c95608409 100644
--- a/Plugins/org.mitk.gui.qt.igtexamples/documentation/UserManual/QmitkIGTTutorial.dox
+++ b/Plugins/org.mitk.gui.qt.igtexamples/documentation/UserManual/QmitkIGTTutorial.dox
@@ -1,14 +1,90 @@
/**
-\page org_imageguidedtherapytutorial The MITK-IGT Tutorial Module
+\page org_imageguidedtherapytutorial The MITK-IGT Tutorial View
-\imageMacro{QmitkIGTExamples_ImageGuidedTherapy.png,"Icon of the MITK-IGT Tutorial Module",2.00}
-
-\section QmitkIGTTutorialUserManualSummary Summary
-
-This module is not meant as a end-user module. It contains tutorial program code that explains how to use the MITK-IGT component.
+This view is not meant as an end-user module. It contains tutorial program code that explains how to use the MITK-IGT component.
It contains only two buttons. The "Start image guided therapy" button will create a virtual tracking device and a virtual tool.
-It will move the tool around on random paths in a tracking volume of 200x200x200 mm. The tool is visualized with a cone.
+It will move the tool around on random paths in a tracking volume of 200x200x200 mm. The tool is visualized with a cone.
If you do not see a cone moving around, you will need to initialize the rendering views correctly. Use the DataManager view to perform
a global reinit.
-*/
+
+The symbol of this view is the following:
+
+\imageMacro{../../resources/IGTTutorial.png,"",2}
+
+In this tutorial we connect to the NDI Polaris tracking system (or alternatively use a virtual tracking device) and we will show the movement of a tool as cone in the StdMultiWidget editor.
+
+First of all, you will have to add an IGT dependency to your cmake list. FOr this example, MitkIGTUI would be sufficient, but as the plugin contains several views, we have additional OpenIGTLink and US dependencies:
+
+\code{.cpp}
+
+ project(org_mitk_gui_qt_igtexamples)
+
+ mitk_create_plugin(
+ EXPORT_DIRECTIVE IGTEXAMPLES_EXPORT
+ EXPORTED_INCLUDE_SUFFIXES src
+ MODULE_DEPENDS MitkQtWidgetsExt MitkIGT MitkIGTUI MitkOpenIGTLink MitkOpenIGTLinkUI MitkUS
+ )
+\endcode
+
+More information on how to create your own plugin can be found here: \ref NewPluginPage
+
+When clicking the start button, a cone should move in the 3D view and stop after clicking the stop button.
+
+The view has several fuctions. Most of them deal with the basic functionality with the plugin (e.g. CreateQTPartControl or CreateConnections). For a deeper understanding, you might have a look at the files QmitkIGTTutorialView.cpp and QmitkIGTTutorialView.h
+For our IGT functionality, the following functions are important:
+\li OnStartIGT: Starts the navigation pipeline
+\li OnStopIGT: Disconnect the pipeline
+\li OnTimer: Updates the view
+
+Let's now have a deeper look at these functions.
+
+\section OnStartIGT OnStartIGT
+
+\snippet ../../src/internal/QmitkIGTTutorialView.cpp OnStart 1
+
+We first check in a try environment, if we should use an NDI tracking device or a virtual device. Let's start with NDI, we hardcode the parameters here and give out a warning. In your propper application, the parameters should be set via the gui aswell (see \ref org_mitk_views_igttrackingtoolbox ), but for simplicity, we just set hardcoded parameters here. If you want to try it with your own NDI device, you need to adapt these parameters here in the code:
+
+\snippet ../../src/internal/QmitkIGTTutorialView.cpp OnStart 2
+
+The tracking device has to be set to a source. For more information on the tracking pipeline, please have a look at the \ref IGTTutorialStepFilterPipeline.
+
+\snippet QmitkIGTTutorialView.cpp OnStart 3
+
+Alternatively, we can setup a virtual tracking device. We create this device, set the bounds, add a tool and connect it to the source:
+
+\snippet QmitkIGTTutorialView.cpp OnStart 4
+
+Now we need to connect the tracking system
+
+\snippet QmitkIGTTutorialView.cpp OnStart 5
+
+For the visualisation, we need an object. Here, we create a red cone
+
+\snippet QmitkIGTTutorialView.cpp OnStart 6
+
+The visualization filter will actually render the cone
+\snippet QmitkIGTTutorialView.cpp OnStart 7
+
+For a continuous display, we need to call update, here we decide to do it every 100 ms using a timer.
+\snippet QmitkIGTTutorialView.cpp OnStart 8
+
+Disable the selection of tracking devices during tracking:
+\snippet QmitkIGTTutorialView.cpp OnStart 8a
+
+For propper coding, you should always catch the exceptions:
+\snippet QmitkIGTTutorialView.cpp OnStart 9
+
+\section OnTimer OnTimer
+
+Each time, the timer is updated, the following code is executed:
+\snippet QmitkIGTTutorialView.cpp OnTimer
+
+\section OnStopIGT OnStopIGT
+This function will stop the pipeline and clean up everything:
+\snippet QmitkIGTTutorialView.cpp OnStop
+
+You now have a very simple plugin, which creates an own tracking device and starts or stops tracking. Of course, for your more advanced project, you could implement a new tracking device to be available in every plugin (see \ref IGTHowToImplementATrackingDevice) or use already implemented tracking devices via the tracking toolbox and/or microservices. This small example should just show you the most simple way to start tracking.
+
+\ref Return to the \ref IGTTutorialOverview "[IGT Tutorial Overview]"
+*/
\ No newline at end of file
diff --git a/Plugins/org.mitk.gui.qt.igtexamples/documentation/doxygen/IGTExampleIGT_QT_Tutorial_PluginView.png b/Plugins/org.mitk.gui.qt.igtexamples/documentation/doxygen/IGTExampleIGT_QT_Tutorial_PluginView.png
new file mode 100644
index 0000000000..b72414b411
Binary files /dev/null and b/Plugins/org.mitk.gui.qt.igtexamples/documentation/doxygen/IGTExampleIGT_QT_Tutorial_PluginView.png differ
diff --git a/Plugins/org.mitk.gui.qt.igtexamples/documentation/doxygen/IGT_TrackingLab_PluginView.png b/Plugins/org.mitk.gui.qt.igtexamples/documentation/doxygen/IGT_TrackingLab_PluginView.png
new file mode 100644
index 0000000000..42e03a1b76
Binary files /dev/null and b/Plugins/org.mitk.gui.qt.igtexamples/documentation/doxygen/IGT_TrackingLab_PluginView.png differ
diff --git a/Plugins/org.mitk.gui.qt.igtexamples/plugin.xml b/Plugins/org.mitk.gui.qt.igtexamples/plugin.xml
index 557922193a..4e598fac42 100644
--- a/Plugins/org.mitk.gui.qt.igtexamples/plugin.xml
+++ b/Plugins/org.mitk.gui.qt.igtexamples/plugin.xml
@@ -1,38 +1,38 @@
diff --git a/Plugins/org.mitk.gui.qt.igtexamples/src/internal/QmitkIGTTutorialView.cpp b/Plugins/org.mitk.gui.qt.igtexamples/src/internal/QmitkIGTTutorialView.cpp
index 6fdedc8efa..0d7c0cc7af 100644
--- a/Plugins/org.mitk.gui.qt.igtexamples/src/internal/QmitkIGTTutorialView.cpp
+++ b/Plugins/org.mitk.gui.qt.igtexamples/src/internal/QmitkIGTTutorialView.cpp
@@ -1,230 +1,263 @@
/*===================================================================
The Medical Imaging Interaction Toolkit (MITK)
Copyright (c) German Cancer Research Center,
Division of Medical and Biological Informatics.
All rights reserved.
This software is distributed WITHOUT ANY WARRANTY; without
even the implied warranty of MERCHANTABILITY or FITNESS FOR
A PARTICULAR PURPOSE.
See LICENSE.txt or http://www.mitk.org for details.
===================================================================*/
#include "QmitkIGTTutorialView.h"
#include "QmitkStdMultiWidget.h"
#include "mitkNDIPassiveTool.h"
#include "mitkNDITrackingDevice.h"
#include "mitkVirtualTrackingDevice.h"
#include "mitkStandardFileLocations.h"
#include "mitkSerialCommunication.h"
#include "mitkCone.h"
#include
#include
#include "mitkNDIPolarisTypeInformation.h"
const std::string QmitkIGTTutorialView::VIEW_ID = "org.mitk.views.igttutorial";
QmitkIGTTutorialView::QmitkIGTTutorialView()
: QmitkAbstractView(),
m_Controls(NULL), m_Source(NULL), m_Visualizer(NULL), m_Timer(NULL)
{
}
QmitkIGTTutorialView::~QmitkIGTTutorialView()
{
}
void QmitkIGTTutorialView::CreateQtPartControl(QWidget *parent)
{
if (!m_Controls)
{
// create GUI widget
m_Controls = new Ui::QmitkIGTTutorialViewControls;
m_Controls->setupUi(parent);
this->CreateConnections();
}
}
void QmitkIGTTutorialView::CreateConnections()
{
if ( m_Controls )
{
connect( (QObject*)(m_Controls->m_StartButton), SIGNAL(clicked()),(QObject*) this, SLOT(OnStartIGT()));
connect( (QObject*)(m_Controls->m_StopButton), SIGNAL(clicked()),(QObject*) this, SLOT(OnStopIGT()));
}
}
void QmitkIGTTutorialView::SetFocus()
{
m_Controls->m_virtualTrackingRadioButton->setFocus();
}
-
+//The next line starts a snippet to display this code in the documentation. If you don't revise the documentation, don't remove it!
+ //! [OnStart 1]
void QmitkIGTTutorialView::OnStartIGT()
{
- //This method is called when the Do IGT button is pressed. Any kind of navigation application will
+ //This method is called when the "Start Image Guided Therapy" button is pressed. Any kind of navigation application will
//start with the connection to a tracking system and as we do image guided procedures we want to show
- //something on the screen. In this tutorial we connect to the NDI Polaris tracking system and we will
+ //something on the screen. In this tutorial we connect to the NDI Polaris tracking system pr a virtual tracking device and we will
//show the movement of a tool as cone in MITK.
+
+ //! [OnStart 1]
+
+ //! [OnStart 2]
try
{
if(m_Controls->m_NDITrackingRadioButton->isChecked())
{
/**************** Variant 1: Use a NDI Polaris Tracking Device ****************/
//Here we want to use the NDI Polaris tracking device. Therefore we instantiate a object of the class
//NDITrackingDevice and make some settings which are necessary for a proper connection to the device.
MITK_INFO << "NDI tracking";
QMessageBox::warning ( NULL, "Warning", "You have to set the parameters for the NDITracking device inside the code (QmitkIGTTutorialView::OnStartIGT()) before you can use it.");
mitk::NDITrackingDevice::Pointer tracker = mitk::NDITrackingDevice::New(); //instantiate
tracker->SetPortNumber(mitk::SerialCommunication::COM4); //set the comport
tracker->SetBaudRate(mitk::SerialCommunication::BaudRate115200); //set the baud rate
tracker->SetType(mitk::NDIPolarisTypeInformation::GetTrackingDeviceName()); //set the type there you can choose between Polaris and Aurora
//The tools represent the sensors of the tracking device. In this case we have one pointer tool.
//The TrackingDevice object it self fills the tool with data. So we have to add the tool to the
//TrackingDevice object.
// The Polaris system needs a ".rom" file which describes the geometry of the markers related to the tool tip.
//NDI provides an own software (NDI architect) to generate those files.
tracker->AddTool("MyInstrument", "c:\\myinstrument.rom");
+ //! [OnStart 2]
/**************** End of Variant 1 ****************/
-
+ //! [OnStart 3]
//The tracking device object is used for the physical connection to the device. To use the
//data inside of our tracking pipeline we need a source. This source encapsulate the tracking device
//and provides objects of the type mitk::NavigationData as output. The NavigationData objects stores
//position, orientation, if the data is valid or not and special error informations in a covariance
//matrix.
//
//Typically the start of a pipeline is a TrackingDeviceSource. To work correct we have to set a
//TrackingDevice object. Attention you have to set the tools before you set the whole TrackingDevice
//object to the TrackingDeviceSource because the source need to know how many outputs should be
//generated.
m_Source = mitk::TrackingDeviceSource::New(); //We need the filter objects to stay alive,
//therefore they must be members.
m_Source->SetTrackingDevice(tracker); //Here we set the tracking device to the source of the pipeline.
+ //! [OnStart 3]
+
}
+ //! [OnStart 4]
else
{
/**************** Variant 2: Emulate a Tracking Device with mitk::VirtualTrackingDevice ****************/
// For tests, it is useful to simulate a tracking device in software. This is what mitk::VirtualTrackingDevice does.
// It will produce random position, orientation and error values for each tool that is added.
MITK_INFO << "virtual tracking"<SetBounds(bounds);
tracker->AddTool("MyInstrument"); // add a tool to tracker
//The tracking device object is used for the physical connection to the device. To use the
//data inside of our tracking pipeline we need a source. This source encapsulate the tracking device
//and provides objects of the type mitk::NavigationData as output. The NavigationData objects stores
//position, orientation, if the data is valid or not and special error informations in a covariance
//matrix.
//
//Typically the start of a pipeline is a TrackingDeviceSource. To work correct we have to set a
//TrackingDevice object. Attention you have to set the tools before you set the whole TrackingDevice
//object to the TrackingDeviceSource because the source need to know how many outputs should be
//generated.
m_Source = mitk::TrackingDeviceSource::New(); //We need the filter objects to stay alive,
//therefore they must be members.
m_Source->SetTrackingDevice(tracker); //Here we set the tracking device to the source of the pipeline.
/**************** End of Variant 2 ****************/
}
+ //! [OnStart 4]
+
+ //! [OnStart 5]
m_Source->Connect(); //Now we connect to the tracking system.
//Note we do not call this on the TrackingDevice object
+ //! [OnStart 5]
-
+ //! [OnStart 6]
//As we wish to visualize our tool we need to have a PolyData which shows us the movement of our tool.
//Here we take a cone shaped PolyData. In MITK you have to add the PolyData as a node into the DataStorage
//to show it inside of the rendering windows. After that you can change the properties of the cone
//to manipulate rendering, e.g. the position and orientation as in our case.
mitk::Cone::Pointer cone = mitk::Cone::New(); //instantiate a new cone
double scale[] = {10.0, 10.0, 10.0};
cone->GetGeometry()->SetSpacing(scale); //scale it a little that so we can see something
mitk::DataNode::Pointer node = mitk::DataNode::New(); //generate a new node to store the cone into
//the DataStorage.
node->SetData(cone); //The data of that node is our cone.
node->SetName("My tracked object"); //The node has additional properties like a name
node->SetColor(1.0, 0.0, 0.0); //or the color. Here we make it red.
this->GetDataStorage()->Add(node); //After adding the Node with the cone in it to the
//DataStorage, MITK will show the cone in the
//render windows.
+ //! [OnStart 6]
+
+ //! [OnStart 7]
//For updating the render windows we use another filter of the MITK-IGT pipeline concept. The
//NavigationDataObjectVisualizationFilter needs as input a NavigationData and a
//PolyData. In our case the input is the source and the PolyData our cone.
//First we create a new filter for the visualization update.
m_Visualizer = mitk::NavigationDataObjectVisualizationFilter::New();
m_Visualizer->SetInput(0, m_Source->GetOutput()); //Then we connect to the pipeline.
m_Visualizer->SetRepresentationObject(0, cone); //After that we have to assign the cone to the input
//Now this simple pipeline is ready, so we can start the tracking. Here again: We do not call the
//StartTracking method from the tracker object itself. Instead we call this method from our source.
m_Source->StartTracking();
+ //! [OnStart 7]
+ //! [OnStart 8]
//Now every call of m_Visualizer->Update() will show us the cone at the position and orientation
//given from the tracking device.
//We use a QTimer object to call this Update() method in a fixed interval.
if (m_Timer == NULL)
{
m_Timer = new QTimer(this); //create a new timer
}
connect(m_Timer, SIGNAL(timeout()), this, SLOT(OnTimer())); //connect the timer to the method OnTimer()
m_Timer->start(100); //Every 100ms the method OnTimer() is called. -> 10fps
- //Now have look at the OnTimer() method.
+ //! [OnStart 8]
+
+ //! [OnStart 8a]
+ //disable the tracking device selection
+ this->m_Controls->m_NDITrackingRadioButton->setDisabled(true);
+ this->m_Controls->m_virtualTrackingRadioButton->setDisabled(true);
+ //! [OnStart 8a]
+
}
+ //! [OnStart 9]
catch (std::exception& e)
{
// add cleanup
- MITK_INFO << "Error in QmitkIGTTutorial::OnDoIGT():" << e.what();
+ MITK_INFO << "Error in QmitkIGTTutorial::OnStartIGT():" << e.what();
}
+ //! [OnStart 9]
}
-
+ //![OnTimer]
void QmitkIGTTutorialView::OnTimer()
{
//Here we call the Update() method from the Visualization Filter. Internally the filter checks if
//new NavigationData is available. If we have a new NavigationData the cone position and orientation
//will be adapted.
m_Visualizer->Update();
mitk::TimeGeometry::Pointer geo = this->GetDataStorage()->ComputeBoundingGeometry3D(this->GetDataStorage()->GetAll());
mitk::RenderingManager::GetInstance()->InitializeViews( geo );
this->RequestRenderWindowUpdate();
}
+ //![OnTimer]
-
+ //![OnStop]
void QmitkIGTTutorialView::OnStopIGT()
{
//This method is called when the Stop button is pressed. Here we disconnect the pipeline.
if (m_Timer == NULL)
{
MITK_INFO << "No Timer was set yet!";
return;
}
//To disconnect the pipeline in a save way we first stop the timer than we disconnect the tracking device.
//After that we destroy all filters with changing them to NULL.
m_Timer->stop();
disconnect(m_Timer, SIGNAL(timeout()), this, SLOT(OnTimer()));
m_Timer = NULL;
m_Source->StopTracking();
m_Source->Disconnect();
m_Source = NULL;
m_Visualizer = NULL;
m_Source = NULL;
this->GetDataStorage()->Remove(this->GetDataStorage()->GetNamedNode("My tracked object"));
+
+ //enable the tracking device selection
+ this->m_Controls->m_NDITrackingRadioButton->setEnabled(true);
+ this->m_Controls->m_virtualTrackingRadioButton->setEnabled(true);
}
+ //![OnStop]
diff --git a/Plugins/org.mitk.gui.qt.igtexamples/src/internal/QmitkIGTTutorialView.h b/Plugins/org.mitk.gui.qt.igtexamples/src/internal/QmitkIGTTutorialView.h
index f49287015b..afca84667c 100644
--- a/Plugins/org.mitk.gui.qt.igtexamples/src/internal/QmitkIGTTutorialView.h
+++ b/Plugins/org.mitk.gui.qt.igtexamples/src/internal/QmitkIGTTutorialView.h
@@ -1,90 +1,89 @@
/*===================================================================
The Medical Imaging Interaction Toolkit (MITK)
Copyright (c) German Cancer Research Center,
Division of Medical and Biological Informatics.
All rights reserved.
This software is distributed WITHOUT ANY WARRANTY; without
even the implied warranty of MERCHANTABILITY or FITNESS FOR
A PARTICULAR PURPOSE.
See LICENSE.txt or http://www.mitk.org for details.
===================================================================*/
#ifndef _QMITKIGTTUTORIALVIEW_H_INCLUDED
#define _QMITKIGTTUTORIALVIEW_H_INCLUDED
#include
#include
#include "ui_QmitkIGTTutorialViewControls.h"
-//#include "../IgttutorialDll.h"
#include "mitkTrackingDeviceSource.h"
#include "mitkNavigationDataObjectVisualizationFilter.h"
/**
* \brief QmitkIGTTutorial shows a small typically navigation MITK view
*
* Any kind of navigation application will start with the connection to a tracking system
* and as we do image guided procedures we want to show something on the screen. In this
* tutorial we connect to the NDI Polaris tracking system (or alternatively use a virtual tracking device)
* and we will show the movement of a tool as cone in the StdMultiWidget editor.
*
* \sa also take a look at the CMakeLists.txt of this view to see how to
* link to the mitkIGT library.
*/
class QmitkIGTTutorialView : public QmitkAbstractView
{
// this is needed for all Qt objects that should have a MOC object (everything that derives from QObject)
Q_OBJECT
public:
static const std::string VIEW_ID;
QmitkIGTTutorialView();
virtual ~QmitkIGTTutorialView();
virtual void CreateQtPartControl(QWidget *parent) override;
/// \brief Creation of the connections of main and control widget
virtual void CreateConnections();
virtual void SetFocus() override;
protected slots:
/**
* \brief Execute MITK-IGT Tutorial
*/
void OnStartIGT();
/**
* \brief stop IGT scene and clean up
*/
void OnStopIGT();
/**
* \brief timer based update of IGT scene
*/
void OnTimer();
protected:
Ui::QmitkIGTTutorialViewControls* m_Controls;
mitk::TrackingDeviceSource::Pointer m_Source; ///< source filer that connects to the tracking device
mitk::NavigationDataObjectVisualizationFilter::Pointer m_Visualizer; ///< visualization filter uses output from m_Source
QTimer* m_Timer; ///< timer for continuous tracking update
};
#endif // _QMITKIGTTUTORIALVIEW_H_INCLUDED
diff --git a/Plugins/org.mitk.gui.qt.igttracking/documentation/UserManual/QmitkIGTTracking.dox b/Plugins/org.mitk.gui.qt.igttracking/documentation/UserManual/QmitkIGTTracking.dox
index ee044a325b..7fcaa565d5 100644
--- a/Plugins/org.mitk.gui.qt.igttracking/documentation/UserManual/QmitkIGTTracking.dox
+++ b/Plugins/org.mitk.gui.qt.igttracking/documentation/UserManual/QmitkIGTTracking.dox
@@ -1,14 +1,17 @@
/**
\page org_mitk_gui_qt_igttracking The IGT Tracking Plugin
This plugin offers basic tracking functionalities. This includes connecting to a tracking system, logging and recording of tracking data, managing tracking tools and playing recorded tracking data.
-The plugin includes different views, which are described in different pages in detail:
+The plugin includes different views, which are described on different pages in detail:
- \subpage org_mitk_views_igttrackingtoolbox : Allows for connecting to a tracking system and logging/recording of the tracked data.
- \subpage org_mitk_views_igtnavigationtoolmanager : Navigation Tool Manager: This view offers functionality to manage tool storages. Each tool storage holds a preconfigured tool collection. Once saved you can load a tool storage in the Tracking Toolbox and don't need to add every tool seperately.
- \subpage org_mitk_views_navigationdataplayer : Navigation Data Player: Plays navigation data which was recorded with the Tracking Toolbox for example.
+ \subpage org_mitk_views_igttrackingtoolbox : Allows for connecting a tracking system and logging/recording the tracked data.
+ \subpage org_mitk_views_igtnavigationtoolmanager : This view offers functionality to manage tool storages. Each tool storage holds a preconfigured tool collection. Once saved you can load a tool storage in the Tracking Toolbox and don't need to add every tool seperately.
+ \subpage org_mitk_views_navigationdataplayer : Plays navigation data which was recorded with the Tracking Toolbox for example.
+ \subpage org_mitk_views_calibrationtoolmanager Calibration Tool Manager. Will follow soon.
-*/
+\ref Return to the \ref TrackingPlugins "[IGT Tutorial Overview]"
+
+*/
\ No newline at end of file
diff --git a/Plugins/org.mitk.gui.qt.igttracking/documentation/UserManual/QmitkIGTTracking_ConfigurationWidget.png b/Plugins/org.mitk.gui.qt.igttracking/documentation/UserManual/QmitkIGTTracking_ConfigurationWidget.png
index 124576ec53..758804b206 100644
Binary files a/Plugins/org.mitk.gui.qt.igttracking/documentation/UserManual/QmitkIGTTracking_ConfigurationWidget.png and b/Plugins/org.mitk.gui.qt.igttracking/documentation/UserManual/QmitkIGTTracking_ConfigurationWidget.png differ
diff --git a/Plugins/org.mitk.gui.qt.igttracking/documentation/UserManual/QmitkIGTTracking_IconNavigationDataPlayer.png b/Plugins/org.mitk.gui.qt.igttracking/documentation/UserManual/QmitkIGTTracking_IconNavigationDataPlayer.png
deleted file mode 100644
index 52f0fa42df..0000000000
Binary files a/Plugins/org.mitk.gui.qt.igttracking/documentation/UserManual/QmitkIGTTracking_IconNavigationDataPlayer.png and /dev/null differ
diff --git a/Plugins/org.mitk.gui.qt.igttracking/documentation/UserManual/QmitkIGTTracking_LogFile.png b/Plugins/org.mitk.gui.qt.igttracking/documentation/UserManual/QmitkIGTTracking_LogFile.png
new file mode 100644
index 0000000000..64ee634a39
Binary files /dev/null and b/Plugins/org.mitk.gui.qt.igttracking/documentation/UserManual/QmitkIGTTracking_LogFile.png differ
diff --git a/Plugins/org.mitk.gui.qt.igttracking/documentation/UserManual/QmitkIGTTracking_LoggingWidget.png b/Plugins/org.mitk.gui.qt.igttracking/documentation/UserManual/QmitkIGTTracking_LoggingWidget.png
new file mode 100644
index 0000000000..0b55bb9108
Binary files /dev/null and b/Plugins/org.mitk.gui.qt.igttracking/documentation/UserManual/QmitkIGTTracking_LoggingWidget.png differ
diff --git a/Plugins/org.mitk.gui.qt.igttracking/documentation/UserManual/QmitkIGTTracking_NavigationToolManagementAddTool.png b/Plugins/org.mitk.gui.qt.igttracking/documentation/UserManual/QmitkIGTTracking_NavigationToolManagementAddTool.png
index c6214c0764..5686a31d9e 100644
Binary files a/Plugins/org.mitk.gui.qt.igttracking/documentation/UserManual/QmitkIGTTracking_NavigationToolManagementAddTool.png and b/Plugins/org.mitk.gui.qt.igttracking/documentation/UserManual/QmitkIGTTracking_NavigationToolManagementAddTool.png differ
diff --git a/Plugins/org.mitk.gui.qt.igttracking/documentation/UserManual/QmitkIGTTracking_NavigationToolManagement_TrackingTools.png b/Plugins/org.mitk.gui.qt.igttracking/documentation/UserManual/QmitkIGTTracking_NavigationToolManagement_TrackingTools.png
new file mode 100644
index 0000000000..8a7f178294
Binary files /dev/null and b/Plugins/org.mitk.gui.qt.igttracking/documentation/UserManual/QmitkIGTTracking_NavigationToolManagement_TrackingTools.png differ
diff --git a/Plugins/org.mitk.gui.qt.igttracking/documentation/UserManual/QmitkIGTTracking_Options.png b/Plugins/org.mitk.gui.qt.igttracking/documentation/UserManual/QmitkIGTTracking_Options.png
new file mode 100644
index 0000000000..2f88a8574b
Binary files /dev/null and b/Plugins/org.mitk.gui.qt.igttracking/documentation/UserManual/QmitkIGTTracking_Options.png differ
diff --git a/Plugins/org.mitk.gui.qt.igttracking/documentation/UserManual/QmitkIGTTracking_ScreenshotMitk.png b/Plugins/org.mitk.gui.qt.igttracking/documentation/UserManual/QmitkIGTTracking_ScreenshotMitk.png
index 06df765e73..1ec5a78af7 100644
Binary files a/Plugins/org.mitk.gui.qt.igttracking/documentation/UserManual/QmitkIGTTracking_ScreenshotMitk.png and b/Plugins/org.mitk.gui.qt.igttracking/documentation/UserManual/QmitkIGTTracking_ScreenshotMitk.png differ
diff --git a/Plugins/org.mitk.gui.qt.igttracking/documentation/UserManual/QmitkIGTTracking_ScreenshotMitk.svg b/Plugins/org.mitk.gui.qt.igttracking/documentation/UserManual/QmitkIGTTracking_ScreenshotMitk.svg
new file mode 100644
index 0000000000..289e9e72a0
--- /dev/null
+++ b/Plugins/org.mitk.gui.qt.igttracking/documentation/UserManual/QmitkIGTTracking_ScreenshotMitk.svg
@@ -0,0 +1,1397 @@
+
+
+
+
+
+
+
+ image/svg+xml
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Tool visualization
+
+ Tracking volume
+ Tool information
+
+
diff --git a/Plugins/org.mitk.gui.qt.igttracking/documentation/UserManual/QmitkIGTTracking_TrackingControl.png b/Plugins/org.mitk.gui.qt.igttracking/documentation/UserManual/QmitkIGTTracking_TrackingControl.png
new file mode 100644
index 0000000000..805a5d8e0d
Binary files /dev/null and b/Plugins/org.mitk.gui.qt.igttracking/documentation/UserManual/QmitkIGTTracking_TrackingControl.png differ
diff --git a/Plugins/org.mitk.gui.qt.igttracking/documentation/UserManual/QmitkIGTTracking_TrackingToolsWidget.png b/Plugins/org.mitk.gui.qt.igttracking/documentation/UserManual/QmitkIGTTracking_TrackingToolsWidget.png
index fa1f304e46..9e0722b241 100644
Binary files a/Plugins/org.mitk.gui.qt.igttracking/documentation/UserManual/QmitkIGTTracking_TrackingToolsWidget.png and b/Plugins/org.mitk.gui.qt.igttracking/documentation/UserManual/QmitkIGTTracking_TrackingToolsWidget.png differ
diff --git a/Plugins/org.mitk.gui.qt.igttracking/documentation/UserManual/QmitkMITKIGTNavigationToolManager.dox b/Plugins/org.mitk.gui.qt.igttracking/documentation/UserManual/QmitkMITKIGTNavigationToolManager.dox
index 5614af4744..dd73cd5f6c 100644
--- a/Plugins/org.mitk.gui.qt.igttracking/documentation/UserManual/QmitkMITKIGTNavigationToolManager.dox
+++ b/Plugins/org.mitk.gui.qt.igttracking/documentation/UserManual/QmitkMITKIGTNavigationToolManager.dox
@@ -1,51 +1,53 @@
/**
\page org_mitk_views_igtnavigationtoolmanager The MITK-IGT Navigation Tool Manager
-\imageMacro{QmitkIGTTracking_IconNavigationToolManager.png,"Icon of the Navigation Tool Manager",2.00}
+\imageMacro{../resources/QmitkIGTTracking_IconNavigationToolManager.png,"Icon of the Navigation Tool Manager",2.00}
\section QmitkMITKIGTNavigationToolManager Introduction
This view allows for creating and editing NavigationToolStorages. These storages contains naviagtion tools of a tracking device, can be saved permanently and used later for any other IGT application.
\tableofcontents
\section QmitkMITKIGTNavigationToolManagerToolOverview Navigation Tools Overview
A navigation tool of MITK-IGT represents a tracking tool (e.g. an emt sensor or an optically tracked tool) and it's corresponding data, like it's name and it's surface. A navigation tool is a generalized container for any trackable object in combination with it's additional information. Every navigation tool has different properties which are:
Name
Unique identifier
Tool definition file
Serial number
Surface for visualization
Type of tracking device
Type of the tool
Tool landmarks
Note that not all properties are needed for all types of tools. A tool definition file, for example, is only needed by optical tracking tools (e.g. a .rom file for Polaris or a toolfile for the MicronTracker). A tool associated with the aurora system is alwalys identified by it's serial number. You can also detect Aurora tools automatically with the TrackingToolbox view and edit the automatically detected tool storage later with this view.
\section QmitkMITKIGTNavigationToolManagerManagingNavigationToolStorage Managing Navigation Tool Storage
In order to create edit a tool storage container, you can select one of the available tool storages listed in the upper part of the UI. The list shows all tool storages which are available throug the micro services concept of MITK. The list also shows the current tool storage of the IGT tracking toolbox view if it is active. In addition to the listed tool storages, you can load new storages from the hard disc which will then appear in the list and might be edited as all other storage by simply selecting it in the list. You may also save a selected tool storage to the hard disc or create a new one.
In the lower part of the UI you always see the list of tools of the tool storage which is currently selected in the upper part. Use the buttons "add", "edit" and "delete" to manage the contained navigation tools. If you click "edit" or "delete" the operation is applied on the currently selected tool, as shown in the screenshot below.
\imageMacro{QmitkIGTTracking_NavigationToolManagemantStartScreen.png,"Screenshot of the main view of NavigationToolManagent",10.90}
\section QmitkMITKIGTNavigationToolManagerAddingEditingNavigationTools Adding / Editing Navigation Tools
-If you add or edit a navigation tool, an input mask, as shown in the screenshot below, appears. The tool identifier is filled automatically, if you change it, remember that it is unique in the current storage. Also, choose a valid surface for every tool, this is nessesary for correct tool visualization. The other information depends on the tracking system type. So choose a tool file for the Polaris or the MicronTracker system and type in a serial number for the Aurora system. Two identical tools with the same serial number are also possible, they are assigned by the order in which they are attached to the device. As long as they also have the same surface as representation, this should not be a problem for most of the use cases.
+If you add or edit a navigation tool, an input mask, as shown in the screenshot below, appears. The tool identifier is filled automatically, if you change it, remember that it is unique in the current storage. Also, choose a valid surface for every tool, this is nessesary for correct tool visualization. By default, a cone is displayed. The other information depends on the tracking system type, e.g. choose a tool file for the Polaris or the MicronTracker system and type in a serial number for the Aurora system. Two identical tools with the same serial number are also possible, they are assigned by the order in which they are attached to the device. As long as they also have the same surface as representation, this should not be a problem for most of the use cases.
The tool type is additional information which is not needed by the tracking device but might be needed by further IGT applications. The same applies to the tool landmarks which might be defined for a tool. There are two different types of landmarks which are designed as described here:
Tool Calibration Landmarks: These landmarks may be used clearly define the tools pose only by using landmarks in the tool coordinate system. E.g., two landmarks for a 5DoF tool and three landmarks for a 6DoF tool. These landmarks may be used, e.g., for a point based registration of a tool from image space to tracking space.
Tool Registration Landmarks: These landmarks are designed for representing defined landmarks on a tools surface. The number of these landmarks might exeed the number of tool calibration landmarks for reasons of redundancy and averaging. They are used for, e.g., manually registering the pose of a tool by visual markers in a CT scan. If you would use these landmarks to do a point based registration from image space to tracking space later, you might overweight the tool because of two many landmarks compared to other markers.
\imageMacro{QmitkIGTTracking_NavigationToolManagementAddTool.png,"Screenshot of add/edit navigation tool screen",9.19}
-*/
+Return to the Tutorial Step: \ref IGTTutorialStepPluginIntroduction
+
+*/
\ No newline at end of file
diff --git a/Plugins/org.mitk.gui.qt.igttracking/documentation/UserManual/QmitkMITKIGTTrackingToolbox.dox b/Plugins/org.mitk.gui.qt.igttracking/documentation/UserManual/QmitkMITKIGTTrackingToolbox.dox
index f47a0e3cb7..91713bc56b 100644
--- a/Plugins/org.mitk.gui.qt.igttracking/documentation/UserManual/QmitkMITKIGTTrackingToolbox.dox
+++ b/Plugins/org.mitk.gui.qt.igttracking/documentation/UserManual/QmitkMITKIGTTrackingToolbox.dox
@@ -1,56 +1,93 @@
/**
\page org_mitk_views_igttrackingtoolbox The MITK-IGT Tracking Toolbox
-\imageMacro{QmitkIGTTracking_IconTrackingToolbox.png,"Icon of the MITK-IGT Tracking Toolbox",2.00}
+\imageMacro{../resources/iconTrackingToolBox.png,"Icon of the MITK-IGT Tracking Toolbox",2.00}
\tableofcontents
\section QmitkMITKIGTTrackingToolboxIntroduction Introduction
-The MITK-IGT Tracking Toolbox is a view which allows you to connect to a tracking device, track and visualize navigation tools and write the tracked data into a log file. Currently the devices Polaris, Aurora (both Northern Digital Inc. (NDI); Waterloo, Ontario, Canada) and MicronTracker (Claron Technology, Inc.; Toronto, Ontario, Canada) are supported. The MicroBird family (Ascension Technology Corporation, Inc.; Burlington, USA) will hopefully follow soon since it is already supported by the tracking layer of IGT. The logging feature of the Tracking Toolbox supports logging in XML or CSV format.
+The MITK-IGT Tracking Toolbox is a view which allows you to connect to a tracking device, track and visualize navigation tools and write the tracked data into a log file.
+This page gives an overview of the view and is at the same time part of the IGT tutorial step \ref IGTTutorialStepPluginIntroduction. All parts containing instructions
+for the tutorial begin with the bold printed label Tutorial .
\imageMacro{QmitkIGTTracking_ScreenshotMitk.png,"MITK Screenshot with the TrackingToolbox activated",16.00}
\section QmitkMITKIGTTrackingToolboxWorkflow General workflow Introduction
+Currently the devices Polaris, Aurora (both Northern Digital Inc. (NDI); Waterloo, Ontario, Canada), MicronTracker (Claron Technology, Inc.; Toronto, Ontario, Canada) and Optitrack (NaturalPoint) are supported (see Hardware Tracking Device Support ). Different tracking hardware can be used via OpenIGTLink connections (see \ref IGTTutorialStepOpenIGTLink "Open IGT Link tutorial"
+). For this Tracking Toolbox tutorial, we will use a virtual tracking device, which allows you to use simulated tracking data. This is very helpful if you want to test or implement some tracking application and don't have the hardware always available.
+
A general Workflow with the Tracking Toolbox may be:
Configuration of a tracking device
- Loading a toolfile which holds tool definitions
+ Adding or loading a toolfile which holds tool definitions
Start tracking
Logging tracked data
+Tutorial: In the following sections, we will get familiar with each of these points using the Virtual Tracking Device.
+
\section QmitkMITKIGTTrackingToolboxConnecting Tracking Device Configuration
-The tracking device can be specified in the tracking device configuration section located in the upper area of the tracking tab. As shown in the screenshot below, you choose your tracking device in the drop down menu. If you use a tracking system connected to a serial port, like Aurora or Polaris, you then need to specifiy the serial port. In case of the MicronTracker you only need to ensure that all drivers are installed correctly and integrated into MITK. If you want to check the connection, press "test connection". The results are displayed in the small black box on the right.
+The tracking device can be specified in the tracking device configuration section located in the upper area of the tracking tab. As shown in the screenshot below, you choose your tracking device in the drop down menu.
+
+If you use a real tracking system, you might need to set some parameters like the serial port for Aurora or Polaris or the host name for your OpenIGTLink connection. Most implemented tracking device include an option to test your conection. Therefore you just need to press the button "test connection". The results are displayed in the small black box on the right.
+
+Tutorial: For a first introduction, please select the virtual tracking device in the drop-down-menu. You should see an option to add some jittering to the simulated data.
\imageMacro{QmitkIGTTracking_ConfigurationWidget.png,"Tracking Device Configuration",8.55}
-\section QmitkMITKIGTTrackingToolboxLoadingTools Loading tools
+\section Tracking Tools
+
+For tracking, you need information about your tools. You can either add single tools, load previously created tool storages or for some devices auto-detect all available tools. The best way to edit tools after creation/loading is \ref org_mitk_views_igtnavigationtoolmanager view. Creation of new tools or loading of existing tool storages can be done within the Tracking Tool Widget
+
+\imageMacro{QmitkIGTTracking_NavigationToolManagement_TrackingTools.png, "The tracking tool widget for adding or loading tools.",9.00}
+
+All added or loaded tools will then be displayed in grey as shown in the screenshot below. If you start tracking they will become green if the tools were found and red if they were not found inside the tracking volume.
+\imageMacro{QmitkIGTTracking_TrackingToolsWidget.png,"Added Tracking Tools",9.08}
-To load tools which can be tracked you need a predefined tracking tool storage. If you use the Aurora system you also have the possibility to automatically detect the connected tools. In this case a tracking tool storage is created by the software (see section below). Otherwise you can use the MITK view NavigationToolManager to define a navigation tool storage. There you can create navigation tools with the corresponding toolfiles, visualization surfaces and so on. Please see NavigationToolManager manual for more details.
+\subsection QmitkMITKIGTTrackingToolboxAddingTools Adding tools
+The most simple step to begin with is to add new tools with this widget. The same widget is also available within \ref org_mitk_views_igtnavigationtoolmanager view and the single parameters are explained there in more detail.
+\imageMacro{QmitkIGTTracking_NavigationToolManagementAddTool.png,"Adding a new tool", 9.00}
-Navigation tool storages can be loaded by pressing the button "Load Tools". Please ensure that the tracking device type of the tools matches the chosen tracking device, otherwise you will get an error message if you try to start tracking. All loaded tools will then be displayed in grey as shown in the screenshot below. If you start tracking they will become green if the tools were found and red if they were not found inside the tracking volume.
+Tutorial: Please click the "Add single tool" button and make sure, that the Virtual Tracker is selected in the drop-down-menu (the tracking device configured in the first step must always match your tools!). You might want to give your tool a new name in the "Basic Information" section and load a surface for visualization in the "Tool Visualization" section (a surface file can be found in your binary folder if you did compile MITK by yourself: MITK-superbuild\MITK-Data\IGT-Data\ClaronTool.stl). If you don't have any surface data, you can just select "use simple cone". Click on "Finished" and repeat this step to add a second tool.
-\imageMacro{QmitkIGTTracking_TrackingToolsWidget.png,"Tracking Tools",9.08}
+\subsection QmitkMITKIGTTrackingToolboxLoadingTools Loading tools
+To load tools which can be tracked you need a predefined tracking tool storage. You can use the MITK \ref org_mitk_views_igtnavigationtoolmanager view to define a navigation tool storage or to save the tools created within the last step in a toolstorage.
-\section QmitkMITKIGTTrackingToolboxAutoDetection Auto detection of tools (only Aurora)
+Navigation tool storages can be loaded by pressing the button "Load Tools". Please ensure that the tracking device type of the tools matches the chosen tracking device, otherwise you will get an error message if you try to start tracking.
-If the Aurora tracking system is used, a button "Auto Detection" appears. If you press this button the software connects to the system and automatically detects all connected tools. You will then be asked whether you want to save the detected tools as a tool storage to the hard drive. You might want to do this if you want to use or modify this tool storage later. In the automatically detected tool storage the tools are named AutoDetectedTools1, AutoDetectedTools2, and so on. Small spheres are used as tool surfaces. After autodetection the detected tools are loaded automatically even if you did not save them.
+\subsection QmitkMITKIGTTrackingToolboxAutoDetection Auto detection of tools (only Aurora)
+If you use the Aurora system you also have the possibility to automatically detect the connected tools. In this case a tracking tool storage is created by the software.
+In the Tracking Device Configuration widget, a button "Auto Detection" appears. If you press this button the software connects to the system and automatically detects all connected tools. You will then be asked whether you want to save the detected tools as a tool storage to the hard drive. You might want to do this if you want to use or modify this tool storage later. In the automatically detected tool storage the tools are named AutoDetectedTools1, AutoDetectedTools2, and so on. Small spheres are used as tool surfaces. After autodetection the detected tools are loaded automatically even if you did not save them.
\section QmitkMITKIGTTrackingToolboxStartTracking Start/stop tracking
+To start tracking, you first need to connect to your tracking device ("connect" button). If your tools or tool storage don't match the tracking device or if no connection can be established, this might give an error message here.
+\imageMacro{QmitkIGTTracking_TrackingControl.png,"Tracking Control to start tracking.", 9.00}
+If connected succesfully, the start tracking button is enabled. As soon as you clicked this button, the tool information and tools will be highlighted red or green (un-/successful tracking) and in case of successful tracking, it's position will be updated and the tools are visualized in the 3D view of MITK.
+Note that options may not be changed after connecting the tracking device.
-Tracking can simply be started by pressing "Start Tracking". Note that options may not be changed during tracking. Once tracking has started the tracking volume (only if the option is on) and the tools are visualized in the 3D view of MITK.
+You can start, freeze, unfreeze and stop the tracking as long as you are connected. If you want to finish your tracking, please stop an disconnect your tracking device.
-\section QmitkMITKIGTTrackingToolboxLogging Logging features
+Tutorial: Please click "connect" and "start tracking". Both tools should move within the tracking volume, the position data should be updated in the tool widget and be highlighted green. You can freeze, unfreeze and stop/restart the tracking as often as you like. When finished, please stop and disconnect.
+
+\section QmitkMITKIGTTrackingOptions Options
+
+In the options tab you can enable or disable the visualization of the tracking volume and of the tool quaternions. If enabled, the tool quaternions are shown in the tool information. You can also define the update rate of the tracking data. The update rate should not be set higher than the update rate of the tracking system. Other options might be available here depending on the newest developement within MITK-IGT.
+\imageMacro{QmitkIGTTracking_Options.png,"Recorded logging data.", 9.00}
+\section QmitkMITKIGTTrackingToolboxLogging Logging features
+The logging feature of the Tracking Toolbox supports logging in XML or CSV format.
If your device is tracking, you are able to log the tracking data by using the logging tab. You first must define a file name. You can then choose whether you want comma seperated (csv) or xml format. Press "Start Logging" to start logging. You can also limit the number of logged frames, which will cause the logging to stop automatically after the given number.
-\section QmitkMITKIGTTrackingOptions Options
+\imageMacro{QmitkIGTTracking_LoggingWidget.png,"Tracking options.", 9.00}
+
+Tutorial: Please connect and start tracking as you already did in the last step, switch to the logging tab, specify a csv file and start logging for a view seconds. Stop the tracking after a short period of time. You should now find the specified file which should look similar to the following screenshot and contain position data for both tools:
+\imageMacro{QmitkIGTTracking_LogFile.png,"Recorded logging data.", 9.00}
-In the options tab you can enable or disable the visualization of the tracking volume and of the tool quaternions. If enabled, the tool quaternions are shown in the tool information. You can also define the update rate of the tracking data. The update rate should not be set higher than the update rate of the tracking system.
+Return to the Tutorial Step: \ref IGTTutorialStepPluginIntroduction
-*/
+*/
\ No newline at end of file
diff --git a/Plugins/org.mitk.gui.qt.igttracking/documentation/UserManual/QmitkNavigationDataPlayer.dox b/Plugins/org.mitk.gui.qt.igttracking/documentation/UserManual/QmitkNavigationDataPlayer.dox
index 0066b56cf3..9940cc1627 100644
--- a/Plugins/org.mitk.gui.qt.igttracking/documentation/UserManual/QmitkNavigationDataPlayer.dox
+++ b/Plugins/org.mitk.gui.qt.igttracking/documentation/UserManual/QmitkNavigationDataPlayer.dox
@@ -1,25 +1,29 @@
/**
\page org_mitk_views_navigationdataplayer The NavigationData Player
-\imageMacro{QmitkIGTTracking_IconNavigationDataPlayer.png,"Icon of the NavigationData Player",2.00}
+\imageMacro{../resources/iconNavigationDataPlayer.png,"Icon of the NavigationData Player",2.00}
\tableofcontents
\section NavigationDataPlayerOverview
The navigation data player plays recorded or artificial navigation data of one ore more tracking tools and visualizes their trajectory.
It can also make the data available als a NavigationDataSource to Plugins that require a stream of tracking data, without having to create a tracking device.
\imageMacro{QmitkIGTTracking_NavigationDataPlayer.png, "The Navigation Data Player", 7}
To use it, select a set of recorded navigation data using the "Open File" button.
The Player will show the number of tools and the number of frames in the file.
Select the sequential player if you want to play the data with a specified tempo (set the update Interval accordingly).
Use the Time-based player to play the data in the speed they were originally acquired in.
Check "Repeat" to repeat the data as a loop indefinitely.
Check "Register as Microservice" to make the data available as a microservice TrackingDataSource. Other Filters can then be connected to it from other plugins. This is useful for development purposes or to replay previously recorded Situations.
Check "Display" to render the data in the render Window.
-*/
+Tutorial: As part of the IGT tutorial, you might try to replay your recorded data from step \ref org_mitk_views_igttrackingtoolbox. You should see two spheric tools moving within the tracking volume. Note that the tool storage is not included in the navigation data player at the moment, and hence all tools are represented as spheres.
+
+Return to the Tutorial Step: \ref IGTTutorialStepPluginIntroduction
+
+*/
\ No newline at end of file
diff --git a/Plugins/org.mitk.gui.qt.igttracking/documentation/UserManual/QmitkIGTTracking_IconNavigationToolManager.png b/Plugins/org.mitk.gui.qt.igttracking/resources/QmitkIGTTracking_IconNavigationToolManager.png
similarity index 100%
rename from Plugins/org.mitk.gui.qt.igttracking/documentation/UserManual/QmitkIGTTracking_IconNavigationToolManager.png
rename to Plugins/org.mitk.gui.qt.igttracking/resources/QmitkIGTTracking_IconNavigationToolManager.png
diff --git a/Plugins/org.mitk.gui.qt.igttracking/resources/iconTrackingToolBox.png b/Plugins/org.mitk.gui.qt.igttracking/resources/iconTrackingToolBox.png
new file mode 100644
index 0000000000..af308c7b4b
Binary files /dev/null and b/Plugins/org.mitk.gui.qt.igttracking/resources/iconTrackingToolBox.png differ
diff --git a/Plugins/org.mitk.gui.qt.igttracking/src/internal/QmitkMITKIGTNavigationToolManagerView.cpp b/Plugins/org.mitk.gui.qt.igttracking/src/internal/QmitkMITKIGTNavigationToolManagerView.cpp
index 581d2c53b6..f3205dd8f2 100644
--- a/Plugins/org.mitk.gui.qt.igttracking/src/internal/QmitkMITKIGTNavigationToolManagerView.cpp
+++ b/Plugins/org.mitk.gui.qt.igttracking/src/internal/QmitkMITKIGTNavigationToolManagerView.cpp
@@ -1,84 +1,79 @@
/*===================================================================
The Medical Imaging Interaction Toolkit (MITK)
Copyright (c) German Cancer Research Center,
Division of Medical and Biological Informatics.
All rights reserved.
This software is distributed WITHOUT ANY WARRANTY; without
even the implied warranty of MERCHANTABILITY or FITNESS FOR
A PARTICULAR PURPOSE.
See LICENSE.txt or http://www.mitk.org for details.
===================================================================*/
// Blueberry
#include
#include
// Qmitk
#include "QmitkMITKIGTNavigationToolManagerView.h"
#include "QmitkStdMultiWidget.h"
// MITK
#include
// Qt
#include
-
-
const std::string QmitkMITKIGTNavigationToolManagerView::VIEW_ID = "org.mitk.views.mitkigtnavigationtoolmanager";
QmitkMITKIGTNavigationToolManagerView::QmitkMITKIGTNavigationToolManagerView()
-: QmitkAbstractView()
-, m_Controls( 0 )
+ : QmitkAbstractView()
+ , m_Controls(0)
{
}
QmitkMITKIGTNavigationToolManagerView::~QmitkMITKIGTNavigationToolManagerView()
{
- for(int i=0; i < m_AllStoragesHandledByThisWidget.size(); i++)
+ for (int i = 0; i < m_AllStoragesHandledByThisWidget.size(); i++)
m_AllStoragesHandledByThisWidget.at(i)->UnRegisterMicroservice();
}
-
-void QmitkMITKIGTNavigationToolManagerView::CreateQtPartControl( QWidget *parent )
+void QmitkMITKIGTNavigationToolManagerView::CreateQtPartControl(QWidget *parent)
{
// build up qt view, unless already done
- if ( !m_Controls )
+ if (!m_Controls)
{
// create GUI widgets from the Qt Designer's .ui file
m_Controls = new Ui::QmitkMITKIGTNavigationToolManagerViewControls;
- m_Controls->setupUi( parent );
- connect( (QObject*)(m_Controls->m_toolManagerWidget), SIGNAL(NewStorageAdded(mitk::NavigationToolStorage::Pointer,std::string)), this, SLOT(NewStorageByWidget(mitk::NavigationToolStorage::Pointer,std::string)) );
- connect( (QObject*)(m_Controls->m_ToolStorageListWidget), SIGNAL(NavigationToolStorageSelected(mitk::NavigationToolStorage::Pointer)), this, SLOT(ToolStorageSelected(mitk::NavigationToolStorage::Pointer)) );
+ m_Controls->setupUi(parent);
+ connect((QObject*)(m_Controls->m_toolManagerWidget), SIGNAL(NewStorageAdded(mitk::NavigationToolStorage::Pointer, std::string)), this, SLOT(NewStorageByWidget(mitk::NavigationToolStorage::Pointer, std::string)));
+ connect((QObject*)(m_Controls->m_ToolStorageListWidget), SIGNAL(NavigationToolStorageSelected(mitk::NavigationToolStorage::Pointer)), this, SLOT(ToolStorageSelected(mitk::NavigationToolStorage::Pointer)));
}
m_Controls->m_toolManagerWidget->Initialize(this->GetDataStorage());
}
void QmitkMITKIGTNavigationToolManagerView::SetFocus()
{
m_Controls->m_ToolStorageListWidget->setFocus();
}
-void QmitkMITKIGTNavigationToolManagerView::NewStorageByWidget(mitk::NavigationToolStorage::Pointer storage,std::string storageName)
+void QmitkMITKIGTNavigationToolManagerView::NewStorageByWidget(mitk::NavigationToolStorage::Pointer storage, std::string storageName)
{
storage->RegisterAsMicroservice(storageName);
m_AllStoragesHandledByThisWidget.push_back(storage);
}
void QmitkMITKIGTNavigationToolManagerView::ToolStorageSelected(mitk::NavigationToolStorage::Pointer storage)
{
if (storage.IsNull()) //no storage selected
- {
- //reset everything
- return;
- }
+ {
+ //reset everything
+ return;
+ }
this->m_Controls->m_toolManagerWidget->LoadStorage(storage);
-}
-
-
+}
\ No newline at end of file
diff --git a/Plugins/org.mitk.gui.qt.igttracking/src/internal/QmitkMITKIGTNavigationToolManagerView.h b/Plugins/org.mitk.gui.qt.igttracking/src/internal/QmitkMITKIGTNavigationToolManagerView.h
index bbac8e6ad7..c9fff653b4 100644
--- a/Plugins/org.mitk.gui.qt.igttracking/src/internal/QmitkMITKIGTNavigationToolManagerView.h
+++ b/Plugins/org.mitk.gui.qt.igttracking/src/internal/QmitkMITKIGTNavigationToolManagerView.h
@@ -1,67 +1,63 @@
/*===================================================================
The Medical Imaging Interaction Toolkit (MITK)
Copyright (c) German Cancer Research Center,
Division of Medical and Biological Informatics.
All rights reserved.
This software is distributed WITHOUT ANY WARRANTY; without
even the implied warranty of MERCHANTABILITY or FITNESS FOR
A PARTICULAR PURPOSE.
See LICENSE.txt or http://www.mitk.org for details.
===================================================================*/
#ifndef QmitkMITKIGTNavigationToolManagerView_h
#define QmitkMITKIGTNavigationToolManagerView_h
#include
#include
#include
#include "ui_QmitkMITKIGTNavigationToolManagerViewControls.h"
-
-
/*!
\brief QmitkMITKIGTNavigationToolManagerView
\warning This application module is not yet documented. Use "svn blame/praise/annotate" and ask the author to provide basic documentation.
-*/
+ */
class QmitkMITKIGTNavigationToolManagerView : public QmitkAbstractView
{
// this is needed for all Qt objects that should have a Qt meta-object
// (everything that derives from QObject and wants to have signal/slots)
Q_OBJECT
- public:
+public:
- static const std::string VIEW_ID;
+ static const std::string VIEW_ID;
- QmitkMITKIGTNavigationToolManagerView();
- virtual ~QmitkMITKIGTNavigationToolManagerView();
+ QmitkMITKIGTNavigationToolManagerView();
+ virtual ~QmitkMITKIGTNavigationToolManagerView();
- virtual void CreateQtPartControl(QWidget *parent) override;
+ virtual void CreateQtPartControl(QWidget *parent) override;
- virtual void SetFocus() override;
+ virtual void SetFocus() override;
protected slots:
- void NewStorageByWidget(mitk::NavigationToolStorage::Pointer storage,std::string);
- void ToolStorageSelected(mitk::NavigationToolStorage::Pointer);
+ void NewStorageByWidget(mitk::NavigationToolStorage::Pointer storage, std::string);
+ void ToolStorageSelected(mitk::NavigationToolStorage::Pointer);
- protected:
+protected:
- Ui::QmitkMITKIGTNavigationToolManagerViewControls* m_Controls;
+ Ui::QmitkMITKIGTNavigationToolManagerViewControls* m_Controls;
- /** Someone needs to hold the smart pointers of new storages, otherwise the objects will be lost although they are listed as microservice. */
- std::vector m_AllStoragesHandledByThisWidget;
+ /** Someone needs to hold the smart pointers of new storages, otherwise the objects will be lost although they are listed as microservice. */
+ std::vector m_AllStoragesHandledByThisWidget;
};
-
-
#endif // _QMITKMITKIGTNAVIGATIONTOOLMANAGERVIEW_H_INCLUDED
diff --git a/Plugins/org.mitk.gui.qt.igttracking/src/internal/QmitkMITKIGTTrackingToolboxView.cpp b/Plugins/org.mitk.gui.qt.igttracking/src/internal/QmitkMITKIGTTrackingToolboxView.cpp
index 9393b109f2..198e7fe7da 100644
--- a/Plugins/org.mitk.gui.qt.igttracking/src/internal/QmitkMITKIGTTrackingToolboxView.cpp
+++ b/Plugins/org.mitk.gui.qt.igttracking/src/internal/QmitkMITKIGTTrackingToolboxView.cpp
@@ -1,1509 +1,1532 @@
/*===================================================================
The Medical Imaging Interaction Toolkit (MITK)
Copyright (c) German Cancer Research Center,
Division of Medical and Biological Informatics.
All rights reserved.
This software is distributed WITHOUT ANY WARRANTY; without
even the implied warranty of MERCHANTABILITY or FITNESS FOR
A PARTICULAR PURPOSE.
See LICENSE.txt or http://www.mitk.org for details.
===================================================================*/
// Blueberry
#include
#include
// Qmitk
#include "QmitkMITKIGTTrackingToolboxView.h"
#include "QmitkTrackingDeviceConfigurationWidget.h"
#include "QmitkStdMultiWidget.h"
// Qt
#include
#include
#include
// MITK
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include "mitkNDIAuroraTypeInformation.h"
// vtk
#include
//for exceptions
#include
#include
//for Microservice
#include "mitkPluginActivator.h"
#include
#include
#include "usServiceReference.h"
const std::string QmitkMITKIGTTrackingToolboxView::VIEW_ID = "org.mitk.views.mitkigttrackingtoolbox";
QmitkMITKIGTTrackingToolboxView::QmitkMITKIGTTrackingToolboxView()
: QmitkFunctionality()
, m_Controls(nullptr)
, m_MultiWidget(nullptr)
, m_DeviceTypeCollection(nullptr)
{
m_TrackingLoggingTimer = new QTimer(this);
m_TrackingRenderTimer = new QTimer(this);
m_TimeoutTimer = new QTimer(this);
m_tracking = false;
m_connected = false;
m_logging = false;
m_loggedFrames = 0;
-
//create filename for autosaving of tool storage
QString loggingPathWithoutFilename = QString(mitk::LoggingBackend::GetLogFile().c_str());
if (!loggingPathWithoutFilename.isEmpty()) //if there already is a path for the MITK logging file use this one
- {
+ {
//extract path from path+filename (if someone knows a better way to do this feel free to change it)
int lengthOfFilename = QFileInfo(QString::fromStdString(mitk::LoggingBackend::GetLogFile())).fileName().size();
- loggingPathWithoutFilename.resize(loggingPathWithoutFilename.size()-lengthOfFilename);
+ loggingPathWithoutFilename.resize(loggingPathWithoutFilename.size() - lengthOfFilename);
m_AutoSaveFilename = loggingPathWithoutFilename + "TrackingToolboxAutoSave.IGTToolStorage";
- }
+ }
else //if not: use a temporary path from IOUtil
- {
+ {
m_AutoSaveFilename = QString(mitk::IOUtil::GetTempPath().c_str()) + "TrackingToolboxAutoSave.IGTToolStorage";
- }
+ }
MITK_INFO("IGT Tracking Toolbox") << "Filename for auto saving of IGT ToolStorages: " << m_AutoSaveFilename.toStdString();
+ //! [Thread 1]
//initialize worker thread
m_WorkerThread = new QThread();
m_Worker = new QmitkMITKIGTTrackingToolboxViewWorker();
+ //! [Thread 1]
ctkPluginContext* pluginContext = mitk::PluginActivator::GetContext();
if (pluginContext)
{
QString interfaceName = QString::fromStdString(us_service_interface_iid());
QList serviceReference = pluginContext->getServiceReferences(interfaceName);
if (serviceReference.size() > 0)
{
m_DeviceTypeServiceReference = serviceReference.at(0);
const ctkServiceReference& r = serviceReference.at(0);
m_DeviceTypeCollection = pluginContext->getService(r);
}
else
{
MITK_INFO << "No Tracking Device Collection!";
}
-
}
-
}
QmitkMITKIGTTrackingToolboxView::~QmitkMITKIGTTrackingToolboxView()
{
-this->StoreUISettings();
-m_TrackingLoggingTimer->stop();
-m_TrackingRenderTimer->stop();
-m_TimeoutTimer->stop();
-delete m_TrackingLoggingTimer;
-delete m_TrackingRenderTimer;
-delete m_TimeoutTimer;
-try
- {
- // wait for thread to finish
- m_WorkerThread->terminate();
- m_WorkerThread->wait();
- //clean up worker thread
- if(m_WorkerThread) {delete m_WorkerThread;}
- if(m_Worker) {delete m_Worker;}
- //remove the tracking volume
- this->GetDataStorage()->Remove(m_TrackingVolumeNode);
- //unregister microservices
- if(m_toolStorage) {m_toolStorage->UnRegisterMicroservice();}
- if(m_TrackingDeviceSource) {m_TrackingDeviceSource->UnRegisterMicroservice();}
- if(m_IGTLMessageProvider.IsNotNull()){m_IGTLMessageProvider->UnRegisterMicroservice();}
- }
- catch(std::exception& e) {MITK_WARN << "Unexpected exception during clean up of tracking toolbox view: " << e.what();}
- catch(...) {MITK_WARN << "Unexpected unknown error during clean up of tracking toolbox view!";}
-//store tool storage and UI settings for persistence
-this->AutoSaveToolStorage();
-this->StoreUISettings();
-
-m_DeviceTypeCollection = nullptr;
-mitk::PluginActivator::GetContext()->ungetService(m_DeviceTypeServiceReference);
-
+ this->StoreUISettings();
+ m_TrackingLoggingTimer->stop();
+ m_TrackingRenderTimer->stop();
+ m_TimeoutTimer->stop();
+ delete m_TrackingLoggingTimer;
+ delete m_TrackingRenderTimer;
+ delete m_TimeoutTimer;
+ try
+ {
+ //! [Thread 2]
+ // wait for thread to finish
+ m_WorkerThread->terminate();
+ m_WorkerThread->wait();
+ //clean up worker thread
+ if (m_WorkerThread) { delete m_WorkerThread; }
+ if (m_Worker) { delete m_Worker; }
+ //! [Thread 2]
+
+ //remove the tracking volume
+ this->GetDataStorage()->Remove(m_TrackingVolumeNode);
+ //unregister microservices
+ if (m_toolStorage) { m_toolStorage->UnRegisterMicroservice(); }
+ if (m_TrackingDeviceSource) { m_TrackingDeviceSource->UnRegisterMicroservice(); }
+ if (m_IGTLMessageProvider.IsNotNull()){ m_IGTLMessageProvider->UnRegisterMicroservice(); }
+ }
+ catch (std::exception& e) { MITK_WARN << "Unexpected exception during clean up of tracking toolbox view: " << e.what(); }
+ catch (...) { MITK_WARN << "Unexpected unknown error during clean up of tracking toolbox view!"; }
+ //store tool storage and UI settings for persistence
+ this->AutoSaveToolStorage();
+ this->StoreUISettings();
+
+ m_DeviceTypeCollection = nullptr;
+ mitk::PluginActivator::GetContext()->ungetService(m_DeviceTypeServiceReference);
}
-void QmitkMITKIGTTrackingToolboxView::CreateQtPartControl( QWidget *parent )
+void QmitkMITKIGTTrackingToolboxView::CreateQtPartControl(QWidget *parent)
{
// build up qt view, unless already done
- if ( !m_Controls )
+ if (!m_Controls)
{
// create GUI widgets from the Qt Designer's .ui file
m_Controls = new Ui::QmitkMITKIGTTrackingToolboxViewControls;
- m_Controls->setupUi( parent );
+ m_Controls->setupUi(parent);
//create connections
- connect( m_Controls->m_LoadTools, SIGNAL(clicked()), this, SLOT(OnLoadTools()) );
- connect( m_Controls->m_ConnectDisconnectButton, SIGNAL(clicked()), this, SLOT(OnConnectDisconnect()) );
- connect( m_Controls->m_StartStopTrackingButton, SIGNAL(clicked()), this, SLOT(OnStartStopTracking()) );
- connect( m_Controls->m_FreezeUnfreezeTrackingButton, SIGNAL(clicked()), this, SLOT(OnFreezeUnfreezeTracking()) );
- connect( m_TrackingLoggingTimer, SIGNAL(timeout()), this, SLOT(UpdateLoggingTrackingTimer()));
- connect( m_TrackingRenderTimer, SIGNAL(timeout()), this, SLOT(UpdateRenderTrackingTimer()));
- connect( m_TimeoutTimer, SIGNAL(timeout()), this, SLOT(OnTimeOut()));
- connect( m_Controls->m_ChooseFile, SIGNAL(clicked()), this, SLOT(OnChooseFileClicked()));
- connect( m_Controls->m_StartLogging, SIGNAL(clicked()), this, SLOT(StartLogging()));
- connect( m_Controls->m_StopLogging, SIGNAL(clicked()), this, SLOT(StopLogging()));
- connect( m_Controls->m_VolumeSelectionBox, SIGNAL(currentIndexChanged(QString)), this, SLOT(OnTrackingVolumeChanged(QString)));
- connect( m_Controls->m_ShowTrackingVolume, SIGNAL(clicked()), this, SLOT(OnShowTrackingVolumeChanged()));
- connect( m_Controls->m_AutoDetectTools, SIGNAL(clicked()), this, SLOT(OnAutoDetectTools()));
- connect( m_Controls->m_ResetTools, SIGNAL(clicked()), this, SLOT(OnResetTools()));
- connect( m_Controls->m_AddSingleTool, SIGNAL(clicked()), this, SLOT(OnAddSingleTool()));
- connect( m_Controls->m_NavigationToolCreationWidget, SIGNAL(NavigationToolFinished()), this, SLOT(OnAddSingleToolFinished()));
- connect( m_Controls->m_NavigationToolCreationWidget, SIGNAL(Canceled()), this, SLOT(OnAddSingleToolCanceled()));
- connect( m_Controls->m_csvFormat, SIGNAL(clicked()), this, SLOT(OnToggleFileExtension()));
- connect( m_Controls->m_xmlFormat, SIGNAL(clicked()), this, SLOT(OnToggleFileExtension()));
- connect( m_Controls->m_UseDifferentUpdateRates, SIGNAL(clicked()), this, SLOT(OnToggleDifferentUpdateRates()));
- connect( m_Controls->m_RenderUpdateRate, SIGNAL(valueChanged(int)), this, SLOT(OnChangeRenderUpdateRate()));
- connect( m_Controls->m_DisableAllTimers, SIGNAL(stateChanged(int)), this, SLOT(EnableDisableTimerButtons(int)));
+ connect(m_Controls->m_LoadTools, SIGNAL(clicked()), this, SLOT(OnLoadTools()));
+ connect(m_Controls->m_ConnectDisconnectButton, SIGNAL(clicked()), this, SLOT(OnConnectDisconnect()));
+ connect(m_Controls->m_StartStopTrackingButton, SIGNAL(clicked()), this, SLOT(OnStartStopTracking()));
+ connect(m_Controls->m_FreezeUnfreezeTrackingButton, SIGNAL(clicked()), this, SLOT(OnFreezeUnfreezeTracking()));
+ connect(m_TrackingLoggingTimer, SIGNAL(timeout()), this, SLOT(UpdateLoggingTrackingTimer()));
+ connect(m_TrackingRenderTimer, SIGNAL(timeout()), this, SLOT(UpdateRenderTrackingTimer()));
+ connect(m_TimeoutTimer, SIGNAL(timeout()), this, SLOT(OnTimeOut()));
+ connect(m_Controls->m_ChooseFile, SIGNAL(clicked()), this, SLOT(OnChooseFileClicked()));
+ connect(m_Controls->m_StartLogging, SIGNAL(clicked()), this, SLOT(StartLogging()));
+ connect(m_Controls->m_StopLogging, SIGNAL(clicked()), this, SLOT(StopLogging()));
+ connect(m_Controls->m_VolumeSelectionBox, SIGNAL(currentIndexChanged(QString)), this, SLOT(OnTrackingVolumeChanged(QString)));
+ connect(m_Controls->m_ShowTrackingVolume, SIGNAL(clicked()), this, SLOT(OnShowTrackingVolumeChanged()));
+ connect(m_Controls->m_AutoDetectTools, SIGNAL(clicked()), this, SLOT(OnAutoDetectTools()));
+ connect(m_Controls->m_ResetTools, SIGNAL(clicked()), this, SLOT(OnResetTools()));
+ connect(m_Controls->m_AddSingleTool, SIGNAL(clicked()), this, SLOT(OnAddSingleTool()));
+ connect(m_Controls->m_NavigationToolCreationWidget, SIGNAL(NavigationToolFinished()), this, SLOT(OnAddSingleToolFinished()));
+ connect(m_Controls->m_NavigationToolCreationWidget, SIGNAL(Canceled()), this, SLOT(OnAddSingleToolCanceled()));
+ connect(m_Controls->m_csvFormat, SIGNAL(clicked()), this, SLOT(OnToggleFileExtension()));
+ connect(m_Controls->m_xmlFormat, SIGNAL(clicked()), this, SLOT(OnToggleFileExtension()));
+ connect(m_Controls->m_UseDifferentUpdateRates, SIGNAL(clicked()), this, SLOT(OnToggleDifferentUpdateRates()));
+ connect(m_Controls->m_RenderUpdateRate, SIGNAL(valueChanged(int)), this, SLOT(OnChangeRenderUpdateRate()));
+ connect(m_Controls->m_DisableAllTimers, SIGNAL(stateChanged(int)), this, SLOT(EnableDisableTimerButtons(int)));
//connections for the tracking device configuration widget
- connect( m_Controls->m_configurationWidget, SIGNAL(TrackingDeviceSelectionChanged()), this, SLOT(OnTrackingDeviceChanged()));
-
+ connect(m_Controls->m_configurationWidget, SIGNAL(TrackingDeviceSelectionChanged()), this, SLOT(OnTrackingDeviceChanged()));
+ //! [Thread 3]
//connect worker thread
- connect(m_Worker, SIGNAL(AutoDetectToolsFinished(bool,QString)), this, SLOT(OnAutoDetectToolsFinished(bool,QString)) );
- connect(m_Worker, SIGNAL(ConnectDeviceFinished(bool,QString)), this, SLOT(OnConnectFinished(bool,QString)) );
- connect(m_Worker, SIGNAL(StartTrackingFinished(bool,QString)), this, SLOT(OnStartTrackingFinished(bool,QString)) );
- connect(m_Worker, SIGNAL(StopTrackingFinished(bool,QString)), this, SLOT(OnStopTrackingFinished(bool,QString)) );
- connect(m_Worker, SIGNAL(DisconnectDeviceFinished(bool,QString)), this, SLOT(OnDisconnectFinished(bool,QString)) );
- connect(m_WorkerThread,SIGNAL(started()), m_Worker, SLOT(ThreadFunc()) );
+ connect(m_Worker, SIGNAL(AutoDetectToolsFinished(bool, QString)), this, SLOT(OnAutoDetectToolsFinished(bool, QString)));
+ connect(m_Worker, SIGNAL(ConnectDeviceFinished(bool, QString)), this, SLOT(OnConnectFinished(bool, QString)));
+ connect(m_Worker, SIGNAL(StartTrackingFinished(bool, QString)), this, SLOT(OnStartTrackingFinished(bool, QString)));
+ connect(m_Worker, SIGNAL(StopTrackingFinished(bool, QString)), this, SLOT(OnStopTrackingFinished(bool, QString)));
+ connect(m_Worker, SIGNAL(DisconnectDeviceFinished(bool, QString)), this, SLOT(OnDisconnectFinished(bool, QString)));
+ connect(m_WorkerThread, SIGNAL(started()), m_Worker, SLOT(ThreadFunc()));
//move the worker to the thread
m_Worker->moveToThread(m_WorkerThread);
+ //! [Thread 3]
//initialize widgets
m_Controls->m_TrackingToolsStatusWidget->SetShowPositions(true);
m_Controls->m_TrackingToolsStatusWidget->SetTextAlignment(Qt::AlignLeft);
//initialize tracking volume node
m_TrackingVolumeNode = mitk::DataNode::New();
m_TrackingVolumeNode->SetName("TrackingVolume");
- m_TrackingVolumeNode->SetBoolProperty("Backface Culling",true);
+ m_TrackingVolumeNode->SetBoolProperty("Backface Culling", true);
mitk::Color red;
red.SetRed(1);
m_TrackingVolumeNode->SetColor(red);
//initialize buttons
m_Controls->m_AutoDetectTools->setVisible(false); //only visible if tracking device is Aurora
m_Controls->m_StartStopTrackingButton->setEnabled(false);
m_Controls->m_FreezeUnfreezeTrackingButton->setEnabled(false);
//initialize warning labels
m_Controls->m_renderWarningLabel->setVisible(false);
m_Controls->m_TrackingFrozenLabel->setVisible(false);
//Update List of available models for selected tool.
std::vector Compatibles;
- if ( (m_Controls == NULL) || //check all these stuff for NULL, latterly this causes crashes from time to time
+ if ((m_Controls == NULL) || //check all these stuff for NULL, latterly this causes crashes from time to time
(m_Controls->m_configurationWidget == NULL) ||
(m_Controls->m_configurationWidget->GetTrackingDevice().IsNull()))
{
MITK_ERROR << "Couldn't get current tracking device or an object is NULL, something went wrong!";
return;
}
else
{
- Compatibles = m_DeviceTypeCollection->GetDeviceDataForLine( m_Controls->m_configurationWidget->GetTrackingDevice()->GetType());
+ Compatibles = m_DeviceTypeCollection->GetDeviceDataForLine(m_Controls->m_configurationWidget->GetTrackingDevice()->GetType());
}
m_Controls->m_VolumeSelectionBox->clear();
- for(std::size_t i = 0; i < Compatibles.size(); i++)
+ for (std::size_t i = 0; i < Compatibles.size(); i++)
{
m_Controls->m_VolumeSelectionBox->addItem(Compatibles[i].Model.c_str());
}
//initialize tool storage
m_toolStorage = mitk::NavigationToolStorage::New(GetDataStorage());
m_toolStorage->SetName("TrackingToolbox Default Storage");
m_toolStorage->RegisterAsMicroservice("no tracking device");
//set home directory as default path for logfile
m_Controls->m_LoggingFileName->setText(QDir::toNativeSeparators(QDir::homePath()) + QDir::separator() + "logfile.csv");
//tracking device may be changed already by the persistence of the
//QmitkTrackingDeciveConfigurationWidget
this->OnTrackingDeviceChanged();
this->LoadUISettings();
//add tracking volume node only to data storage
this->GetDataStorage()->Add(m_TrackingVolumeNode);
if (!m_Controls->m_ShowTrackingVolume->isChecked()) m_TrackingVolumeNode->SetOpacity(0.0);
else m_TrackingVolumeNode->SetOpacity(0.25);
//Update List of available models for selected tool.
m_Controls->m_VolumeSelectionBox->clear();
- for(std::size_t i = 0; i < Compatibles.size(); i++)
+ for (std::size_t i = 0; i < Compatibles.size(); i++)
{
m_Controls->m_VolumeSelectionBox->addItem(Compatibles[i].Model.c_str());
}
}
}
-void QmitkMITKIGTTrackingToolboxView::StdMultiWidgetAvailable (QmitkStdMultiWidget &stdMultiWidget)
+void QmitkMITKIGTTrackingToolboxView::StdMultiWidgetAvailable(QmitkStdMultiWidget &stdMultiWidget)
{
m_MultiWidget = &stdMultiWidget;
}
void QmitkMITKIGTTrackingToolboxView::StdMultiWidgetNotAvailable()
{
m_MultiWidget = NULL;
}
void QmitkMITKIGTTrackingToolboxView::OnLoadTools()
{
//read in filename
- QString filename = QFileDialog::getOpenFileName(NULL,tr("Open Tool Storage"), "/", tr("Tool Storage Files (*.IGTToolStorage)"));
+ QString filename = QFileDialog::getOpenFileName(NULL, tr("Open Tool Storage"), "/", tr("Tool Storage Files (*.IGTToolStorage)"));
if (filename.isNull()) return;
//read tool storage from disk
std::string errorMessage = "";
mitk::NavigationToolStorageDeserializer::Pointer myDeserializer = mitk::NavigationToolStorageDeserializer::New(GetDataStorage());
// try-catch block for exceptions
try
{
- this->ReplaceCurrentToolStorage(myDeserializer->Deserialize(filename.toStdString()),filename.toStdString());
+ this->ReplaceCurrentToolStorage(myDeserializer->Deserialize(filename.toStdString()), filename.toStdString());
}
- catch(mitk::IGTException)
+ catch (mitk::IGTException)
{
- std::string errormessage = "Error during loading the tool storage file. Please only load tool storage files created with the NavigationToolManager view.";
- QMessageBox::warning(NULL, "Tool Storage Loading Error", errormessage.c_str());
- return;
+ std::string errormessage = "Error during loading the tool storage file. Please only load tool storage files created with the NavigationToolManager view.";
+ QMessageBox::warning(NULL, "Tool Storage Loading Error", errormessage.c_str());
+ return;
}
- if(m_toolStorage->isEmpty())
+ if (m_toolStorage->isEmpty())
{
errorMessage = myDeserializer->GetErrorMessage();
MessageBox(errorMessage);
return;
}
//update label
UpdateToolStorageLabel(filename);
//update tool preview
m_Controls->m_TrackingToolsStatusWidget->RemoveStatusLabels();
m_Controls->m_TrackingToolsStatusWidget->PreShowTools(m_toolStorage);
//save filename for persistent storage
m_ToolStorageFilename = filename;
}
void QmitkMITKIGTTrackingToolboxView::OnResetTools()
{
- this->ReplaceCurrentToolStorage(mitk::NavigationToolStorage::New(GetDataStorage()),"TrackingToolbox Default Storage");
+ this->ReplaceCurrentToolStorage(mitk::NavigationToolStorage::New(GetDataStorage()), "TrackingToolbox Default Storage");
m_Controls->m_TrackingToolsStatusWidget->RemoveStatusLabels();
QString toolLabel = QString("");
m_Controls->m_toolLabel->setText(toolLabel);
m_ToolStorageFilename = "";
}
void QmitkMITKIGTTrackingToolboxView::OnStartStopTracking()
{
- if(!m_connected)
- {
+ if (!m_connected)
+ {
MITK_WARN << "Can't start tracking if no device is connected. Aborting";
return;
- }
- if(m_tracking) {OnStopTracking();}
- else {OnStartTracking();}
+ }
+ if (m_tracking) { OnStopTracking(); }
+ else { OnStartTracking(); }
}
void QmitkMITKIGTTrackingToolboxView::OnFreezeUnfreezeTracking()
{
- if( m_Controls->m_FreezeUnfreezeTrackingButton->text() == "Freeze Tracking" )
+ if (m_Controls->m_FreezeUnfreezeTrackingButton->text() == "Freeze Tracking")
{
m_TrackingDeviceSource->Freeze();
m_Controls->m_FreezeUnfreezeTrackingButton->setText("Unfreeze Tracking");
m_Controls->m_TrackingFrozenLabel->setVisible(true);
}
- else if( m_Controls->m_FreezeUnfreezeTrackingButton->text() == "Unfreeze Tracking" )
+ else if (m_Controls->m_FreezeUnfreezeTrackingButton->text() == "Unfreeze Tracking")
{
m_TrackingDeviceSource->UnFreeze();
m_Controls->m_FreezeUnfreezeTrackingButton->setText("Freeze Tracking");
m_Controls->m_TrackingFrozenLabel->setVisible(false);
}
}
void QmitkMITKIGTTrackingToolboxView::OnConnectDisconnect()
{
- if(m_connected) {OnDisconnect();}
- else {OnConnect();}
+ if (m_connected) { OnDisconnect(); }
+ else { OnConnect(); }
}
void QmitkMITKIGTTrackingToolboxView::OnConnect()
{
MITK_INFO << "Connect Clicked";
//check if everything is ready to start tracking
if (this->m_toolStorage.IsNull())
{
MessageBox("Error: No Tools Loaded Yet!");
return;
}
else if (this->m_toolStorage->GetToolCount() == 0)
{
MessageBox("Error: No Way To Track Without Tools!");
return;
}
//parse tracking device data
mitk::TrackingDeviceData data = mitk::UnspecifiedTrackingTypeInformation::GetDeviceDataUnspecified();
- QString qstr = m_Controls->m_VolumeSelectionBox->currentText();
- if ( (! qstr.isNull()) || (! qstr.isEmpty()) ) {
+ QString qstr = m_Controls->m_VolumeSelectionBox->currentText();
+ if ((!qstr.isNull()) || (!qstr.isEmpty())) {
std::string str = qstr.toStdString();
data = m_DeviceTypeCollection->GetDeviceDataByName(str); //Data will be set later, after device generation
}
+ //! [Thread 4]
//initialize worker thread
m_Worker->SetWorkerMethod(QmitkMITKIGTTrackingToolboxViewWorker::eConnectDevice);
m_Worker->SetTrackingDevice(this->m_Controls->m_configurationWidget->GetTrackingDevice());
m_Worker->SetInverseMode(m_Controls->m_InverseMode->isChecked());
m_Worker->SetNavigationToolStorage(this->m_toolStorage);
m_Worker->SetTrackingDeviceData(data);
//start worker thread
m_WorkerThread->start();
+ //! [Thread 4]
//disable buttons
this->m_Controls->m_MainWidget->setEnabled(false);
}
void QmitkMITKIGTTrackingToolboxView::EnableDisableTimerButtons(int enable)
{
bool enableBool = enable;
m_Controls->m_UpdateRateOptionsGroupBox->setEnabled(!enableBool);
m_Controls->m_renderWarningLabel->setVisible(enableBool);
}
void QmitkMITKIGTTrackingToolboxView::OnConnectFinished(bool success, QString errorMessage)
{
m_WorkerThread->quit();
m_WorkerThread->wait();
//enable buttons
this->m_Controls->m_MainWidget->setEnabled(true);
if (!success)
{
MITK_WARN << errorMessage.toStdString();
MessageBox(errorMessage.toStdString());
return;
}
+ //! [Thread 6]
//get data from worker thread
m_TrackingDeviceSource = m_Worker->GetTrackingDeviceSource();
m_TrackingDeviceData = m_Worker->GetTrackingDeviceData();
m_ToolVisualizationFilter = m_Worker->GetToolVisualizationFilter();
+ //! [Thread 6]
//enable/disable Buttons
DisableOptionsButtons();
DisableTrackingConfigurationButtons();
m_Controls->m_TrackingControlLabel->setText("Status: connected");
m_Controls->m_ConnectDisconnectButton->setText("Disconnect");
m_Controls->m_StartStopTrackingButton->setEnabled(true);
m_connected = true;
- }
+}
void QmitkMITKIGTTrackingToolboxView::OnDisconnect()
{
m_Worker->SetWorkerMethod(QmitkMITKIGTTrackingToolboxViewWorker::eDisconnectDevice);
m_WorkerThread->start();
m_Controls->m_MainWidget->setEnabled(false);
}
void QmitkMITKIGTTrackingToolboxView::OnDisconnectFinished(bool success, QString errorMessage)
{
m_WorkerThread->quit();
m_WorkerThread->wait();
m_Controls->m_MainWidget->setEnabled(true);
if (!success)
{
MITK_WARN << errorMessage.toStdString();
MessageBox(errorMessage.toStdString());
return;
}
//enable/disable Buttons
m_Controls->m_StartStopTrackingButton->setEnabled(false);
EnableOptionsButtons();
EnableTrackingConfigurationButtons();
m_Controls->m_TrackingControlLabel->setText("Status: disconnected");
m_Controls->m_ConnectDisconnectButton->setText("Connect");
m_Controls->m_FreezeUnfreezeTrackingButton->setText("Freeze Tracking");
m_Controls->m_TrackingFrozenLabel->setVisible(false);
m_connected = false;
- }
+}
void QmitkMITKIGTTrackingToolboxView::OnStartTracking()
{
m_Worker->SetWorkerMethod(QmitkMITKIGTTrackingToolboxViewWorker::eStartTracking);
m_WorkerThread->start();
this->m_Controls->m_MainWidget->setEnabled(false);
}
void QmitkMITKIGTTrackingToolboxView::OnStartTrackingFinished(bool success, QString errorMessage)
{
+ //! [Thread 5]
m_WorkerThread->quit();
m_WorkerThread->wait();
+ //! [Thread 5]
this->m_Controls->m_MainWidget->setEnabled(true);
- if(!success)
+ if (!success)
{
MessageBox(errorMessage.toStdString());
MITK_WARN << errorMessage.toStdString();
return;
}
- if(!(m_Controls->m_DisableAllTimers->isChecked()))
+ if (!(m_Controls->m_DisableAllTimers->isChecked()))
{
- if(m_Controls->m_UseDifferentUpdateRates->isChecked())
- {
- if(m_Controls->m_RenderUpdateRate->value() != 0)
- m_TrackingRenderTimer->start(1000/(m_Controls->m_RenderUpdateRate->value()));
- m_TrackingLoggingTimer->start(1000/(m_Controls->m_LogUpdateRate->value()));
- }
- else
- {
- m_TrackingRenderTimer->start(1000/(m_Controls->m_UpdateRate->value()));
- m_TrackingLoggingTimer->start(1000/(m_Controls->m_UpdateRate->value()));
- }
+ if (m_Controls->m_UseDifferentUpdateRates->isChecked())
+ {
+ if (m_Controls->m_RenderUpdateRate->value() != 0)
+ m_TrackingRenderTimer->start(1000 / (m_Controls->m_RenderUpdateRate->value()));
+ m_TrackingLoggingTimer->start(1000 / (m_Controls->m_LogUpdateRate->value()));
+ }
+ else
+ {
+ m_TrackingRenderTimer->start(1000 / (m_Controls->m_UpdateRate->value()));
+ m_TrackingLoggingTimer->start(1000 / (m_Controls->m_UpdateRate->value()));
+ }
}
m_Controls->m_TrackingControlLabel->setText("Status: tracking");
//connect the tool visualization widget
- for(std::size_t i=0; iGetNumberOfOutputs(); i++)
+ for (std::size_t i = 0; i < m_TrackingDeviceSource->GetNumberOfOutputs(); i++)
{
m_Controls->m_TrackingToolsStatusWidget->AddNavigationData(m_TrackingDeviceSource->GetOutput(i));
}
m_Controls->m_TrackingToolsStatusWidget->ShowStatusLabels();
- if (m_Controls->m_ShowToolQuaternions->isChecked()) {m_Controls->m_TrackingToolsStatusWidget->SetShowQuaternions(true);}
- else {m_Controls->m_TrackingToolsStatusWidget->SetShowQuaternions(false);}
+ if (m_Controls->m_ShowToolQuaternions->isChecked()) { m_Controls->m_TrackingToolsStatusWidget->SetShowQuaternions(true); }
+ else { m_Controls->m_TrackingToolsStatusWidget->SetShowQuaternions(false); }
//if activated enable open IGT link microservice
if (m_Controls->m_EnableOpenIGTLinkMicroService->isChecked())
- {
+ {
//create convertion filter
- m_IGTLConversionFilter = mitk::NavigationDataToIGTLMessageFilter::New();
+ m_IGTLConversionFilter = mitk::NavigationDataToIGTLMessageFilter::New();
m_IGTLConversionFilter->SetName("IGT Tracking Toolbox");
m_IGTLConversionFilter->ConnectTo(m_ToolVisualizationFilter);
m_IGTLConversionFilter->SetOperationMode(mitk::NavigationDataToIGTLMessageFilter::ModeSendTDataMsg);
m_IGTLConversionFilter->RegisterAsMicroservice();
//create server and message provider
m_IGTLServer = mitk::IGTLServer::New(false);
m_IGTLServer->SetName("Tracking Toolbox IGTL Server");
m_IGTLMessageProvider = mitk::IGTLMessageProvider::New();
m_IGTLMessageProvider->SetIGTLDevice(m_IGTLServer);
m_IGTLMessageProvider->RegisterAsMicroservice();
- }
+ }
//show tracking volume
this->OnTrackingVolumeChanged(m_Controls->m_VolumeSelectionBox->currentText());
m_tracking = true;
m_Controls->m_ConnectDisconnectButton->setEnabled(false);
m_Controls->m_StartStopTrackingButton->setText("Stop Tracking");
m_Controls->m_FreezeUnfreezeTrackingButton->setEnabled(true);
this->GlobalReinit();
}
void QmitkMITKIGTTrackingToolboxView::OnStopTracking()
{
if (!m_tracking) return;
m_TrackingRenderTimer->stop();
m_TrackingLoggingTimer->stop();
m_Worker->SetWorkerMethod(QmitkMITKIGTTrackingToolboxViewWorker::eStopTracking);
m_WorkerThread->start();
m_Controls->m_MainWidget->setEnabled(false);
}
void QmitkMITKIGTTrackingToolboxView::OnStopTrackingFinished(bool success, QString errorMessage)
{
m_WorkerThread->quit();
m_WorkerThread->wait();
m_Controls->m_MainWidget->setEnabled(true);
- if(!success)
+ if (!success)
{
MessageBox(errorMessage.toStdString());
MITK_WARN << errorMessage.toStdString();
return;
}
m_Controls->m_TrackingControlLabel->setText("Status: connected");
if (m_logging) StopLogging();
m_Controls->m_TrackingToolsStatusWidget->RemoveStatusLabels();
m_Controls->m_TrackingToolsStatusWidget->PreShowTools(m_toolStorage);
m_tracking = false;
m_Controls->m_StartStopTrackingButton->setText("Start Tracking");
m_Controls->m_ConnectDisconnectButton->setEnabled(true);
m_Controls->m_FreezeUnfreezeTrackingButton->setEnabled(false);
//unregister open IGT link micro service
if (m_Controls->m_EnableOpenIGTLinkMicroService->isChecked())
- {
+ {
m_IGTLConversionFilter->UnRegisterMicroservice();
m_IGTLMessageProvider->UnRegisterMicroservice();
- }
+ }
this->GlobalReinit();
}
void QmitkMITKIGTTrackingToolboxView::OnTrackingDeviceChanged()
{
mitk::TrackingDeviceType Type;
if (m_Controls->m_configurationWidget->GetTrackingDevice().IsNotNull())
{
Type = m_Controls->m_configurationWidget->GetTrackingDevice()->GetType();
//enable controls because device is valid
m_Controls->m_TrackingToolsGoupBox->setEnabled(true);
m_Controls->m_TrackingControlsGroupBox->setEnabled(true);
}
else
{
Type = mitk::UnspecifiedTrackingTypeInformation::GetTrackingDeviceName();
MessageBox("Error: This tracking device is not included in this project. Please make sure that the device is installed and activated in your MITK build.");
m_Controls->m_TrackingToolsGoupBox->setEnabled(false);
m_Controls->m_TrackingControlsGroupBox->setEnabled(false);
return;
}
// Code to enable/disable device specific buttons
if (Type == mitk::NDIAuroraTypeInformation::GetTrackingDeviceName()) //Aurora
{
m_Controls->m_AutoDetectTools->setVisible(true);
m_Controls->m_AddSingleTool->setEnabled(false);
}
else //Polaris or Microntracker
{
m_Controls->m_AutoDetectTools->setVisible(false);
m_Controls->m_AddSingleTool->setEnabled(true);
}
// Code to select appropriate tracking volume for current type
std::vector Compatibles = m_DeviceTypeCollection->GetDeviceDataForLine(Type);
m_Controls->m_VolumeSelectionBox->clear();
- for(std::size_t i = 0; i < Compatibles.size(); i++)
+ for (std::size_t i = 0; i < Compatibles.size(); i++)
{
m_Controls->m_VolumeSelectionBox->addItem(Compatibles[i].Model.c_str());
}
}
void QmitkMITKIGTTrackingToolboxView::OnTrackingVolumeChanged(QString qstr)
{
if (qstr.isNull()) return;
if (qstr.isEmpty()) return;
mitk::TrackingVolumeGenerator::Pointer volumeGenerator = mitk::TrackingVolumeGenerator::New();
std::string str = qstr.toStdString();
mitk::TrackingDeviceData data = m_DeviceTypeCollection->GetDeviceDataByName(str);
m_TrackingDeviceData = data;
volumeGenerator->SetTrackingDeviceData(data);
volumeGenerator->Update();
mitk::Surface::Pointer volumeSurface = volumeGenerator->GetOutput();
m_TrackingVolumeNode->SetData(volumeSurface);
if (!m_Controls->m_ShowTrackingVolume->isChecked()) m_TrackingVolumeNode->SetOpacity(0.0);
else m_TrackingVolumeNode->SetOpacity(0.25);
GlobalReinit();
}
void QmitkMITKIGTTrackingToolboxView::OnShowTrackingVolumeChanged()
{
if (m_Controls->m_ShowTrackingVolume->isChecked())
{
OnTrackingVolumeChanged(m_Controls->m_VolumeSelectionBox->currentText());
m_TrackingVolumeNode->SetOpacity(0.25);
}
else
{
m_TrackingVolumeNode->SetOpacity(0.0);
}
}
void QmitkMITKIGTTrackingToolboxView::OnAutoDetectTools()
{
if (m_Controls->m_configurationWidget->GetTrackingDevice()->GetType() == mitk::NDIAuroraTypeInformation::GetTrackingDeviceName())
{
DisableTrackingConfigurationButtons();
m_Worker->SetWorkerMethod(QmitkMITKIGTTrackingToolboxViewWorker::eAutoDetectTools);
m_Worker->SetTrackingDevice(m_Controls->m_configurationWidget->GetTrackingDevice().GetPointer());
m_Worker->SetDataStorage(this->GetDataStorage());
m_WorkerThread->start();
m_TimeoutTimer->start(5000);
MITK_INFO << "Timeout Timer started";
//disable controls until worker thread is finished
this->m_Controls->m_MainWidget->setEnabled(false);
}
}
void QmitkMITKIGTTrackingToolboxView::OnAutoDetectToolsFinished(bool success, QString errorMessage)
{
- m_TimeoutTimer->stop();
- m_WorkerThread->quit();
- m_WorkerThread->wait();
+ m_TimeoutTimer->stop();
+ m_WorkerThread->quit();
+ m_WorkerThread->wait();
//enable controls again
this->m_Controls->m_MainWidget->setEnabled(true);
- EnableTrackingConfigurationButtons();
+ EnableTrackingConfigurationButtons();
- if(!success)
+ if (!success)
{
MITK_WARN << errorMessage.toStdString();
MessageBox(errorMessage.toStdString());
EnableTrackingConfigurationButtons();
return;
}
mitk::NavigationToolStorage::Pointer autoDetectedStorage = m_Worker->GetNavigationToolStorage();
- //save detected tools
- this->ReplaceCurrentToolStorage(autoDetectedStorage,"Autodetected NDI Aurora Storage");
- //auto save the new storage to hard disc (for persistence)
- AutoSaveToolStorage();
- //update label
- QString toolLabel = QString("Loaded Tools: ") + QString::number(m_toolStorage->GetToolCount()) + " Tools (Auto Detected)";
- m_Controls->m_toolLabel->setText(toolLabel);
- //update tool preview
- m_Controls->m_TrackingToolsStatusWidget->RemoveStatusLabels();
+ //save detected tools
+ this->ReplaceCurrentToolStorage(autoDetectedStorage, "Autodetected NDI Aurora Storage");
+ //auto save the new storage to hard disc (for persistence)
+ AutoSaveToolStorage();
+ //update label
+ QString toolLabel = QString("Loaded Tools: ") + QString::number(m_toolStorage->GetToolCount()) + " Tools (Auto Detected)";
+ m_Controls->m_toolLabel->setText(toolLabel);
+ //update tool preview
+ m_Controls->m_TrackingToolsStatusWidget->RemoveStatusLabels();
m_Controls->m_TrackingToolsStatusWidget->PreShowTools(m_toolStorage);
EnableTrackingConfigurationButtons();
- if (m_toolStorage->GetToolCount()>0)
+ if (m_toolStorage->GetToolCount() > 0)
{
//ask the user if he wants to save the detected tools
QMessageBox msgBox;
- switch(m_toolStorage->GetToolCount())
+ switch (m_toolStorage->GetToolCount())
{
case 1:
msgBox.setText("Found one tool!");
break;
default:
msgBox.setText("Found " + QString::number(m_toolStorage->GetToolCount()) + " tools!");
}
msgBox.setInformativeText("Do you want to save this tools as tool storage, so you can load them again?");
msgBox.setStandardButtons(QMessageBox::Yes | QMessageBox::No);
msgBox.setDefaultButton(QMessageBox::No);
int ret = msgBox.exec();
if (ret == 16384) //yes
{
//ask the user for a filename
- QString fileName = QFileDialog::getSaveFileName(NULL, tr("Save File"),"/",tr("*.IGTToolStorage"));
+ QString fileName = QFileDialog::getSaveFileName(NULL, tr("Save File"), "/", tr("*.IGTToolStorage"));
//check for empty filename
- if(fileName == "") {return;}
+ if (fileName == "") { return; }
mitk::NavigationToolStorageSerializer::Pointer mySerializer = mitk::NavigationToolStorageSerializer::New();
//when Serialize method is used exceptions are thrown, need to be adapted
//try-catch block for exception handling in Serializer
try
{
- mySerializer->Serialize(fileName.toStdString(),m_toolStorage);
+ mySerializer->Serialize(fileName.toStdString(), m_toolStorage);
}
- catch(mitk::IGTException)
+ catch (mitk::IGTException)
{
std::string errormessage = "Error during serialization. Please check the Zip file.";
QMessageBox::warning(NULL, "IGTPlayer: Error", errormessage.c_str());
}
return;
}
else if (ret == 65536) //no
{
return;
}
}
- //print a logging message about the detected tools
- switch(m_toolStorage->GetToolCount())
- {
- case 0:
- MITK_INFO("IGT Tracking Toolbox") << "Found no tools. Empty ToolStorage was autosaved to " << m_ToolStorageFilename.toStdString();
- break;
- case 1:
- MITK_INFO("IGT Tracking Toolbox") << "Found one tool. ToolStorage was autosaved to " << m_ToolStorageFilename.toStdString();
- break;
- default:
- MITK_INFO("IGT Tracking Toolbox") << "Found " << m_toolStorage->GetToolCount() << " tools. ToolStorage was autosaved to " << m_ToolStorageFilename.toStdString();
- }
+ //print a logging message about the detected tools
+ switch (m_toolStorage->GetToolCount())
+ {
+ case 0:
+ MITK_INFO("IGT Tracking Toolbox") << "Found no tools. Empty ToolStorage was autosaved to " << m_ToolStorageFilename.toStdString();
+ break;
+ case 1:
+ MITK_INFO("IGT Tracking Toolbox") << "Found one tool. ToolStorage was autosaved to " << m_ToolStorageFilename.toStdString();
+ break;
+ default:
+ MITK_INFO("IGT Tracking Toolbox") << "Found " << m_toolStorage->GetToolCount() << " tools. ToolStorage was autosaved to " << m_ToolStorageFilename.toStdString();
+ }
}
void QmitkMITKIGTTrackingToolboxView::MessageBox(std::string s)
{
QMessageBox msgBox;
msgBox.setText(s.c_str());
msgBox.exec();
}
void QmitkMITKIGTTrackingToolboxView::UpdateRenderTrackingTimer()
{
//update filter
m_ToolVisualizationFilter->Update();
MITK_DEBUG << "Number of outputs ToolVisualizationFilter: " << m_ToolVisualizationFilter->GetNumberOfIndexedOutputs();
MITK_DEBUG << "Number of inputs ToolVisualizationFilter: " << m_ToolVisualizationFilter->GetNumberOfIndexedInputs();
//update tool colors to show tool status
- for(unsigned int i=0; iGetNumberOfIndexedOutputs(); i++)
+ for (unsigned int i = 0; i < m_ToolVisualizationFilter->GetNumberOfIndexedOutputs(); i++)
{
mitk::NavigationData::Pointer currentTool = m_ToolVisualizationFilter->GetOutput(i);
- if(currentTool->IsDataValid())
- {this->m_toolStorage->GetTool(i)->GetDataNode()->SetColor(mitk::IGTColor_VALID);}
+ if (currentTool->IsDataValid())
+ {
+ this->m_toolStorage->GetTool(i)->GetDataNode()->SetColor(mitk::IGTColor_VALID);
+ }
else
- {this->m_toolStorage->GetTool(i)->GetDataNode()->SetColor(mitk::IGTColor_WARNING);}
+ {
+ this->m_toolStorage->GetTool(i)->GetDataNode()->SetColor(mitk::IGTColor_WARNING);
+ }
}
//refresh view and status widget
mitk::RenderingManager::GetInstance()->RequestUpdateAll();
m_Controls->m_TrackingToolsStatusWidget->Refresh();
//code to better isolate bug 17713, could be removed when bug 17713 is fixed
static int i = 0;
static mitk::Point3D lastPositionTool1 = m_ToolVisualizationFilter->GetOutput(0)->GetPosition();
static itk::TimeStamp lastTimeStamp = m_ToolVisualizationFilter->GetOutput(0)->GetTimeStamp();
i++;
//every 20 frames: check if tracking is frozen
- if(i>20)
- {
+ if (i > 20)
+ {
i = 0;
if (m_ToolVisualizationFilter->GetOutput(0)->IsDataValid())
+ {
+ if (mitk::Equal(lastPositionTool1, m_ToolVisualizationFilter->GetOutput(0)->GetPosition(), 0.000000001, false))
{
- if (mitk::Equal(lastPositionTool1,m_ToolVisualizationFilter->GetOutput(0)->GetPosition(),0.000000001,false))
- {
MITK_WARN << "Seems as tracking (of at least tool 1) is frozen which means that bug 17713 occurred. Restart tracking might help.";
//display further information to find the bug
MITK_WARN << "Timestamp of current navigation data: " << m_ToolVisualizationFilter->GetOutput(0)->GetTimeStamp();
MITK_WARN << "Timestamp of last navigation data (which holds the same values): " << lastTimeStamp;
- }
+ }
lastPositionTool1 = m_ToolVisualizationFilter->GetOutput(0)->GetPosition();
lastTimeStamp = m_ToolVisualizationFilter->GetOutput(0)->GetTimeStamp();
- }
}
+ }
}
void QmitkMITKIGTTrackingToolboxView::UpdateLoggingTrackingTimer()
{
//update logging
if (m_logging)
{
this->m_loggingFilter->Update();
m_loggedFrames = this->m_loggingFilter->GetNumberOfRecordedSteps();
- this->m_Controls->m_LoggedFramesLabel->setText("Logged Frames: "+QString::number(m_loggedFrames));
+ this->m_Controls->m_LoggedFramesLabel->setText("Logged Frames: " + QString::number(m_loggedFrames));
//check if logging stopped automatically
- if((m_loggedFrames>1)&&(!m_loggingFilter->GetRecording())){StopLogging();}
+ if ((m_loggedFrames > 1) && (!m_loggingFilter->GetRecording())){ StopLogging(); }
}
//refresh status widget
m_Controls->m_TrackingToolsStatusWidget->Refresh();
-
}
void QmitkMITKIGTTrackingToolboxView::OnChooseFileClicked()
{
QDir currentPath = QFileInfo(m_Controls->m_LoggingFileName->text()).dir();
// if no path was selected (QDir would select current working dir then) or the
// selected path does not exist -> use home directory
- if ( currentPath == QDir() || ! currentPath.exists() )
+ if (currentPath == QDir() || !currentPath.exists())
{
currentPath = QDir(QDir::homePath());
}
- QString filename = QFileDialog::getSaveFileName(NULL,tr("Choose Logging File"), currentPath.absolutePath(), "*.*");
+ QString filename = QFileDialog::getSaveFileName(NULL, tr("Choose Logging File"), currentPath.absolutePath(), "*.*");
if (filename == "") return;
this->m_Controls->m_LoggingFileName->setText(filename);
this->OnToggleFileExtension();
}
// bug-16470: toggle file extension after clicking on radio button
void QmitkMITKIGTTrackingToolboxView::OnToggleFileExtension()
{
QString currentInputText = this->m_Controls->m_LoggingFileName->text();
QString currentFile = QFileInfo(currentInputText).baseName();
QDir currentPath = QFileInfo(currentInputText).dir();
- if(currentFile.isEmpty())
+ if (currentFile.isEmpty())
{
currentFile = "logfile";
}
// Setting currentPath to default home path when currentPath is empty or it does not exist
- if(currentPath == QDir() || !currentPath.exists())
+ if (currentPath == QDir() || !currentPath.exists())
{
currentPath = QDir::homePath();
}
// check if csv radio button is clicked
- if(this->m_Controls->m_csvFormat->isChecked())
+ if (this->m_Controls->m_csvFormat->isChecked())
{
// you needn't add a seperator to the input text when currentpath is the rootpath
- if(currentPath.isRoot())
+ if (currentPath.isRoot())
{
this->m_Controls->m_LoggingFileName->setText(QDir::toNativeSeparators(currentPath.absolutePath()) + currentFile + ".csv");
}
else
{
this->m_Controls->m_LoggingFileName->setText(QDir::toNativeSeparators(currentPath.absolutePath()) + QDir::separator() + currentFile + ".csv");
}
}
// check if xml radio button is clicked
- else if(this->m_Controls->m_xmlFormat->isChecked())
+ else if (this->m_Controls->m_xmlFormat->isChecked())
{
// you needn't add a seperator to the input text when currentpath is the rootpath
- if(currentPath.isRoot())
+ if (currentPath.isRoot())
{
this->m_Controls->m_LoggingFileName->setText(QDir::toNativeSeparators(currentPath.absolutePath()) + currentFile + ".xml");
}
else
{
this->m_Controls->m_LoggingFileName->setText(QDir::toNativeSeparators(currentPath.absolutePath()) + QDir::separator() + currentFile + ".xml");
}
}
}
void QmitkMITKIGTTrackingToolboxView::OnToggleDifferentUpdateRates()
{
- if(m_Controls->m_UseDifferentUpdateRates->isChecked())
+ if (m_Controls->m_UseDifferentUpdateRates->isChecked())
{
- if(m_Controls->m_RenderUpdateRate->value() == 0)
+ if (m_Controls->m_RenderUpdateRate->value() == 0)
m_Controls->m_renderWarningLabel->setVisible(true);
else
m_Controls->m_renderWarningLabel->setVisible(false);
m_Controls->m_UpdateRate->setEnabled(false);
m_Controls->m_OptionsUpdateRateLabel->setEnabled(false);
m_Controls->m_RenderUpdateRate->setEnabled(true);
m_Controls->m_OptionsRenderUpdateRateLabel->setEnabled(true);
m_Controls->m_LogUpdateRate->setEnabled(true);
m_Controls->m_OptionsLogUpdateRateLabel->setEnabled(true);
}
else
{
m_Controls->m_renderWarningLabel->setVisible(false);
m_Controls->m_UpdateRate->setEnabled(true);
m_Controls->m_OptionsUpdateRateLabel->setEnabled(true);
m_Controls->m_RenderUpdateRate->setEnabled(false);
m_Controls->m_OptionsRenderUpdateRateLabel->setEnabled(false);
m_Controls->m_LogUpdateRate->setEnabled(false);
m_Controls->m_OptionsLogUpdateRateLabel->setEnabled(false);
}
}
void QmitkMITKIGTTrackingToolboxView::OnChangeRenderUpdateRate()
{
- if(m_Controls->m_RenderUpdateRate->value() == 0)
+ if (m_Controls->m_RenderUpdateRate->value() == 0)
m_Controls->m_renderWarningLabel->setVisible(true);
else
m_Controls->m_renderWarningLabel->setVisible(false);
}
void QmitkMITKIGTTrackingToolboxView::StartLogging()
{
if (m_ToolVisualizationFilter.IsNull())
{
MessageBox("Cannot activate logging without a connected device. Configure and connect a tracking device first.");
return;
}
if (!m_logging)
{
//initialize logging filter
m_loggingFilter = mitk::NavigationDataRecorder::New();
m_loggingFilter->ConnectTo(m_ToolVisualizationFilter);
- if (m_Controls->m_LoggingLimit->isChecked()){m_loggingFilter->SetRecordCountLimit(m_Controls->m_LoggedFramesLimit->value());}
+ if (m_Controls->m_LoggingLimit->isChecked()){ m_loggingFilter->SetRecordCountLimit(m_Controls->m_LoggedFramesLimit->value()); }
//start filter with try-catch block for exceptions
try
{
m_loggingFilter->StartRecording();
}
- catch(mitk::IGTException)
+ catch (mitk::IGTException)
{
std::string errormessage = "Error during start recording. Recorder already started recording?";
QMessageBox::warning(NULL, "IGTPlayer: Error", errormessage.c_str());
m_loggingFilter->StopRecording();
return;
}
//update labels / logging variables
this->m_Controls->m_LoggingLabel->setText("Logging ON");
this->m_Controls->m_LoggedFramesLabel->setText("Logged Frames: 0");
m_loggedFrames = 0;
m_logging = true;
DisableLoggingButtons();
}
}
void QmitkMITKIGTTrackingToolboxView::StopLogging()
{
if (m_logging)
{
//stop logging
m_loggingFilter->StopRecording();
m_logging = false;
//update GUI
this->m_Controls->m_LoggingLabel->setText("Logging OFF");
EnableLoggingButtons();
//write the results to a file
- if(m_Controls->m_csvFormat->isChecked())
- {
- mitk::IOUtil::SaveBaseData(m_loggingFilter->GetNavigationDataSet(), this->m_Controls->m_LoggingFileName->text().toStdString());
- }
+ if (m_Controls->m_csvFormat->isChecked())
+ {
+ mitk::IOUtil::SaveBaseData(m_loggingFilter->GetNavigationDataSet(), this->m_Controls->m_LoggingFileName->text().toStdString());
+ }
else if (m_Controls->m_xmlFormat->isChecked())
- {
- mitk::IOUtil::SaveBaseData(m_loggingFilter->GetNavigationDataSet(), this->m_Controls->m_LoggingFileName->text().toStdString());
- }
+ {
+ mitk::IOUtil::SaveBaseData(m_loggingFilter->GetNavigationDataSet(), this->m_Controls->m_LoggingFileName->text().toStdString());
+ }
}
}
void QmitkMITKIGTTrackingToolboxView::OnAddSingleTool()
{
QString Identifier = "Tool#";
QString Name = "NewTool";
if (m_toolStorage.IsNotNull()) {
Identifier += QString::number(m_toolStorage->GetToolCount());
Name += QString::number(m_toolStorage->GetToolCount());
- } else {
+ }
+ else {
Identifier += "0";
Name += "0";
}
- m_Controls->m_NavigationToolCreationWidget->Initialize(GetDataStorage(),Identifier.toStdString(),Name.toStdString());
- m_Controls->m_NavigationToolCreationWidget->SetTrackingDeviceType(m_Controls->m_configurationWidget->GetTrackingDevice()->GetType(),false);
+ m_Controls->m_NavigationToolCreationWidget->Initialize(GetDataStorage(), Identifier.toStdString(), Name.toStdString());
+ m_Controls->m_NavigationToolCreationWidget->SetTrackingDeviceType(m_Controls->m_configurationWidget->GetTrackingDevice()->GetType(), false);
m_Controls->m_TrackingToolsWidget->setCurrentIndex(1);
//disable tracking volume during tool editing
lastTrackingVolumeState = m_Controls->m_ShowTrackingVolume->isChecked();
if (lastTrackingVolumeState) m_Controls->m_ShowTrackingVolume->click();
GlobalReinit();
}
void QmitkMITKIGTTrackingToolboxView::OnAddSingleToolFinished()
{
m_Controls->m_TrackingToolsWidget->setCurrentIndex(0);
if (this->m_toolStorage.IsNull())
{
//this shouldn't happen!
MITK_WARN << "No ToolStorage available, cannot add tool, aborting!";
return;
}
m_toolStorage->AddTool(m_Controls->m_NavigationToolCreationWidget->GetCreatedTool());
m_Controls->m_TrackingToolsStatusWidget->PreShowTools(m_toolStorage);
m_Controls->m_toolLabel->setText("");
//auto save current storage for persistence
MITK_INFO << "Auto saving manually added tools for persistence.";
AutoSaveToolStorage();
//enable tracking volume again
if (lastTrackingVolumeState) m_Controls->m_ShowTrackingVolume->click();
GlobalReinit();
}
void QmitkMITKIGTTrackingToolboxView::OnAddSingleToolCanceled()
{
m_Controls->m_TrackingToolsWidget->setCurrentIndex(0);
//enable tracking volume again
if (lastTrackingVolumeState) m_Controls->m_ShowTrackingVolume->click();
GlobalReinit();
}
void QmitkMITKIGTTrackingToolboxView::GlobalReinit()
{
// get all nodes that have not set "includeInBoundingBox" to false
mitk::NodePredicateNot::Pointer pred = mitk::NodePredicateNot::New(mitk::NodePredicateProperty::New("includeInBoundingBox", mitk::BoolProperty::New(false)));
mitk::DataStorage::SetOfObjects::ConstPointer rs = this->GetDataStorage()->GetSubset(pred);
// calculate bounding geometry of these nodes
mitk::TimeGeometry::Pointer bounds = this->GetDataStorage()->ComputeBoundingGeometry3D(rs, "visible");
// initialize the views to the bounding geometry
mitk::RenderingManager::GetInstance()->InitializeViews(bounds);
}
void QmitkMITKIGTTrackingToolboxView::DisableLoggingButtons()
{
m_Controls->m_StartLogging->setEnabled(false);
m_Controls->m_LoggingFileName->setEnabled(false);
m_Controls->m_ChooseFile->setEnabled(false);
m_Controls->m_LoggingLimit->setEnabled(false);
m_Controls->m_LoggedFramesLimit->setEnabled(false);
m_Controls->m_csvFormat->setEnabled(false);
m_Controls->m_xmlFormat->setEnabled(false);
m_Controls->m_StopLogging->setEnabled(true);
}
void QmitkMITKIGTTrackingToolboxView::EnableLoggingButtons()
{
m_Controls->m_StartLogging->setEnabled(true);
m_Controls->m_LoggingFileName->setEnabled(true);
m_Controls->m_ChooseFile->setEnabled(true);
m_Controls->m_LoggingLimit->setEnabled(true);
m_Controls->m_LoggedFramesLimit->setEnabled(true);
m_Controls->m_csvFormat->setEnabled(true);
m_Controls->m_xmlFormat->setEnabled(true);
m_Controls->m_StopLogging->setEnabled(false);
}
void QmitkMITKIGTTrackingToolboxView::DisableOptionsButtons()
{
m_Controls->m_ShowTrackingVolume->setEnabled(false);
m_Controls->m_UseDifferentUpdateRates->setEnabled(false);
m_Controls->m_UpdateRate->setEnabled(false);
m_Controls->m_OptionsUpdateRateLabel->setEnabled(false);
m_Controls->m_RenderUpdateRate->setEnabled(false);
m_Controls->m_OptionsRenderUpdateRateLabel->setEnabled(false);
m_Controls->m_LogUpdateRate->setEnabled(false);
m_Controls->m_OptionsLogUpdateRateLabel->setEnabled(false);
m_Controls->m_DisableAllTimers->setEnabled(false);
m_Controls->m_OtherOptionsGroupBox->setEnabled(false);
}
void QmitkMITKIGTTrackingToolboxView::EnableOptionsButtons()
{
m_Controls->m_ShowTrackingVolume->setEnabled(true);
m_Controls->m_UseDifferentUpdateRates->setEnabled(true);
m_Controls->m_DisableAllTimers->setEnabled(true);
m_Controls->m_OtherOptionsGroupBox->setEnabled(true);
OnToggleDifferentUpdateRates();
}
void QmitkMITKIGTTrackingToolboxView::EnableTrackingControls()
{
m_Controls->m_TrackingControlsGroupBox->setEnabled(true);
}
void QmitkMITKIGTTrackingToolboxView::DisableTrackingControls()
{
m_Controls->m_TrackingControlsGroupBox->setEnabled(false);
}
void QmitkMITKIGTTrackingToolboxView::EnableTrackingConfigurationButtons()
{
m_Controls->m_AutoDetectTools->setEnabled(true);
if (m_Controls->m_configurationWidget->GetTrackingDevice()->GetType() != mitk::NDIAuroraTypeInformation::GetTrackingDeviceName()) m_Controls->m_AddSingleTool->setEnabled(true);
m_Controls->m_LoadTools->setEnabled(true);
m_Controls->m_ResetTools->setEnabled(true);
}
void QmitkMITKIGTTrackingToolboxView::DisableTrackingConfigurationButtons()
{
m_Controls->m_AutoDetectTools->setEnabled(false);
if (m_Controls->m_configurationWidget->GetTrackingDevice()->GetType() != mitk::NDIAuroraTypeInformation::GetTrackingDeviceName()) m_Controls->m_AddSingleTool->setEnabled(false);
m_Controls->m_LoadTools->setEnabled(false);
m_Controls->m_ResetTools->setEnabled(false);
}
void QmitkMITKIGTTrackingToolboxView::ReplaceCurrentToolStorage(mitk::NavigationToolStorage::Pointer newStorage, std::string newStorageName)
{
//first: get rid of the old one
//don't reset if there is no tool storage. BugFix #17793
- if ( m_toolStorage.IsNotNull() ){
+ if (m_toolStorage.IsNotNull()){
m_toolStorage->UnLockStorage(); //only to be sure...
m_toolStorage->UnRegisterMicroservice();
m_toolStorage = nullptr;
}
//now: replace by the new one
m_toolStorage = newStorage;
m_toolStorage->SetName(newStorageName);
m_toolStorage->RegisterAsMicroservice("no tracking device");
}
void QmitkMITKIGTTrackingToolboxView::OnTimeOut()
{
MITK_INFO << "Time Out";
m_WorkerThread->terminate();
m_WorkerThread->wait();
m_TimeoutTimer->stop();
}
+//! [StoreUISettings]
void QmitkMITKIGTTrackingToolboxView::StoreUISettings()
{
// persistence service does not directly work in plugins for now
// -> using QSettings
QSettings settings;
settings.beginGroup(QString::fromStdString(VIEW_ID));
// set the values of some widgets and attrbutes to the QSettings
settings.setValue("ShowTrackingVolume", QVariant(m_Controls->m_ShowTrackingVolume->isChecked()));
settings.setValue("toolStorageFilename", QVariant(m_ToolStorageFilename));
settings.setValue("VolumeSelectionBox", QVariant(m_Controls->m_VolumeSelectionBox->currentIndex()));
settings.endGroup();
}
+//! [StoreUISettings]
+//! [LoadUISettings]
void QmitkMITKIGTTrackingToolboxView::LoadUISettings()
{
// persistence service does not directly work in plugins for now
// -> using QSettings
QSettings settings;
settings.beginGroup(QString::fromStdString(VIEW_ID));
// set some widgets and attributes by the values from the QSettings
m_Controls->m_ShowTrackingVolume->setChecked(settings.value("ShowTrackingVolume", true).toBool());
m_Controls->m_VolumeSelectionBox->setCurrentIndex(settings.value("VolumeSelectionBox", 0).toInt());
m_ToolStorageFilename = settings.value("toolStorageFilename", QVariant("")).toString();
settings.endGroup();
+ //! [LoadUISettings]
-
+ //! [LoadToolStorage]
// try to deserialize the tool storage from the given tool storage file name
- if ( ! m_ToolStorageFilename.isEmpty() )
+ if (!m_ToolStorageFilename.isEmpty())
{
// try-catch block for exceptions
try
{
mitk::NavigationToolStorageDeserializer::Pointer myDeserializer = mitk::NavigationToolStorageDeserializer::New(GetDataStorage());
m_toolStorage->UnRegisterMicroservice();
m_toolStorage = myDeserializer->Deserialize(m_ToolStorageFilename.toStdString());
m_toolStorage->RegisterAsMicroservice("no tracking device");
//update label
UpdateToolStorageLabel(m_ToolStorageFilename);
//update tool preview
m_Controls->m_TrackingToolsStatusWidget->RemoveStatusLabels();
m_Controls->m_TrackingToolsStatusWidget->PreShowTools(m_toolStorage);
}
- catch(mitk::IGTException)
+ catch (mitk::IGTException)
{
- MITK_WARN("QmitkMITKIGTTrackingToolBoxView") << "Error during restoring tools. Problems with file ("<OnResetTools(); //if there where errors reset the tool storage to avoid problems later on
}
}
+ //! [LoadToolStorage]
}
void QmitkMITKIGTTrackingToolboxView::UpdateToolStorageLabel(QString pathOfLoadedStorage)
{
QFileInfo myPath(pathOfLoadedStorage); //use this to seperate filename from path
QString toolLabel = myPath.fileName();
if (toolLabel.size() > 45) //if the tool storage name is to long trimm the string
- {
+ {
toolLabel.resize(40);
- toolLabel+="[...]";
- }
+ toolLabel += "[...]";
+ }
m_Controls->m_toolLabel->setText(toolLabel);
}
void QmitkMITKIGTTrackingToolboxView::AutoSaveToolStorage()
{
m_ToolStorageFilename = m_AutoSaveFilename;
mitk::NavigationToolStorageSerializer::Pointer mySerializer = mitk::NavigationToolStorageSerializer::New();
- mySerializer->Serialize(m_ToolStorageFilename.toStdString(),m_toolStorage);
+ mySerializer->Serialize(m_ToolStorageFilename.toStdString(), m_toolStorage);
}
-
void QmitkMITKIGTTrackingToolboxViewWorker::SetWorkerMethod(WorkerMethod w)
{
m_WorkerMethod = w;
}
void QmitkMITKIGTTrackingToolboxViewWorker::SetTrackingDevice(mitk::TrackingDevice::Pointer t)
{
m_TrackingDevice = t;
}
void QmitkMITKIGTTrackingToolboxViewWorker::SetDataStorage(mitk::DataStorage::Pointer d)
{
m_DataStorage = d;
}
void QmitkMITKIGTTrackingToolboxViewWorker::SetInverseMode(bool mode)
{
m_InverseMode = mode;
}
void QmitkMITKIGTTrackingToolboxViewWorker::SetTrackingDeviceData(mitk::TrackingDeviceData d)
{
m_TrackingDeviceData = d;
}
void QmitkMITKIGTTrackingToolboxViewWorker::SetNavigationToolStorage(mitk::NavigationToolStorage::Pointer n)
{
m_NavigationToolStorage = n;
}
+//! [Thread 7]
void QmitkMITKIGTTrackingToolboxViewWorker::ThreadFunc()
{
- switch(m_WorkerMethod)
+ switch (m_WorkerMethod)
{
case eAutoDetectTools:
this->AutoDetectTools();
break;
case eConnectDevice:
this->ConnectDevice();
break;
case eStartTracking:
this->StartTracking();
break;
case eStopTracking:
this->StopTracking();
break;
case eDisconnectDevice:
this->DisconnectDevice();
break;
default:
MITK_WARN << "Undefined worker method was set ... something went wrong!";
break;
- }
+ }
}
+//! [Thread 7]
void QmitkMITKIGTTrackingToolboxViewWorker::AutoDetectTools()
{
mitk::ProgressBar::GetInstance()->AddStepsToDo(4);
mitk::NavigationToolStorage::Pointer autoDetectedStorage = mitk::NavigationToolStorage::New(m_DataStorage);
mitk::NDITrackingDevice::Pointer currentDevice = dynamic_cast(m_TrackingDevice.GetPointer());
try
{
currentDevice->OpenConnection();
mitk::ProgressBar::GetInstance()->Progress();
currentDevice->StartTracking();
}
- catch(mitk::Exception& e)
+ catch (mitk::Exception& e)
{
QString message = QString("Warning, can not auto-detect tools! (") + QString(e.GetDescription()) + QString(")");
//MessageBox(message.toStdString()); //TODO: give message to the user here!
MITK_WARN << message.toStdString();
mitk::ProgressBar::GetInstance()->Progress(4);
- emit AutoDetectToolsFinished(false,message.toStdString().c_str());
+ emit AutoDetectToolsFinished(false, message.toStdString().c_str());
return;
}
- for (unsigned int i=0; iGetToolCount(); i++)
+ for (unsigned int i = 0; i < currentDevice->GetToolCount(); i++)
{
//create a navigation tool with sphere as surface
std::stringstream toolname;
toolname << "AutoDetectedTool" << i;
mitk::NavigationTool::Pointer newTool = mitk::NavigationTool::New();
newTool->SetSerialNumber(dynamic_cast(currentDevice->GetTool(i))->GetSerialNumber());
newTool->SetIdentifier(toolname.str());
newTool->SetTrackingDeviceType(mitk::NDIAuroraTypeInformation::GetTrackingDeviceName());
mitk::DataNode::Pointer newNode = mitk::DataNode::New();
mitk::Surface::Pointer mySphere = mitk::Surface::New();
vtkSphereSource *vtkData = vtkSphereSource::New();
vtkData->SetRadius(3.0f);
vtkData->SetCenter(0.0, 0.0, 0.0);
vtkData->Update();
mySphere->SetVtkPolyData(vtkData->GetOutput());
vtkData->Delete();
newNode->SetData(mySphere);
newNode->SetName(toolname.str());
newTool->SetDataNode(newNode);
autoDetectedStorage->AddTool(newTool);
}
m_NavigationToolStorage = autoDetectedStorage;
currentDevice->StopTracking();
mitk::ProgressBar::GetInstance()->Progress();
currentDevice->CloseConnection();
- emit AutoDetectToolsFinished(true,"");
+ emit AutoDetectToolsFinished(true, "");
mitk::ProgressBar::GetInstance()->Progress(4);
}
void QmitkMITKIGTTrackingToolboxViewWorker::ConnectDevice()
{
std::string message = "";
mitk::ProgressBar::GetInstance()->AddStepsToDo(10);
//build the IGT pipeline
mitk::TrackingDevice::Pointer trackingDevice = m_TrackingDevice;
trackingDevice->SetData(m_TrackingDeviceData);
//set device to rotation mode transposed becaus we are working with VNL style quaternions
- if(m_InverseMode)
- {trackingDevice->SetRotationMode(mitk::TrackingDevice::RotationTransposed);}
+ if (m_InverseMode)
+ {
+ trackingDevice->SetRotationMode(mitk::TrackingDevice::RotationTransposed);
+ }
//Get Tracking Volume Data
mitk::TrackingDeviceData data = m_TrackingDeviceData;
mitk::ProgressBar::GetInstance()->Progress();
//Create Navigation Data Source with the factory class
- mitk::TrackingDeviceSourceConfigurator::Pointer myTrackingDeviceSourceFactory = mitk::TrackingDeviceSourceConfigurator::New(m_NavigationToolStorage,trackingDevice);
+ mitk::TrackingDeviceSourceConfigurator::Pointer myTrackingDeviceSourceFactory = mitk::TrackingDeviceSourceConfigurator::New(m_NavigationToolStorage, trackingDevice);
m_TrackingDeviceSource = myTrackingDeviceSourceFactory->CreateTrackingDeviceSource(m_ToolVisualizationFilter);
mitk::ProgressBar::GetInstance()->Progress();
- if ( m_TrackingDeviceSource.IsNull() )
+ if (m_TrackingDeviceSource.IsNull())
{
message = std::string("Cannot connect to device: ") + myTrackingDeviceSourceFactory->GetErrorMessage();
- emit ConnectDeviceFinished(false,QString(message.c_str()));
+ emit ConnectDeviceFinished(false, QString(message.c_str()));
return;
}
//set filter to rotation mode transposed becaus we are working with VNL style quaternions
- if(m_InverseMode)
+ if (m_InverseMode)
m_ToolVisualizationFilter->SetRotationMode(mitk::NavigationDataObjectVisualizationFilter::RotationTransposed);
//First check if the created object is valid
if (m_TrackingDeviceSource.IsNull())
{
message = myTrackingDeviceSourceFactory->GetErrorMessage();
- emit ConnectDeviceFinished(false,QString(message.c_str()));
+ emit ConnectDeviceFinished(false, QString(message.c_str()));
return;
}
MITK_INFO << "Number of tools: " << m_TrackingDeviceSource->GetNumberOfOutputs();
mitk::ProgressBar::GetInstance()->Progress();
//The tools are maybe reordered after initialization, e.g. in case of auto-detected tools of NDI Aurora
mitk::NavigationToolStorage::Pointer toolsInNewOrder = myTrackingDeviceSourceFactory->GetUpdatedNavigationToolStorage();
if ((toolsInNewOrder.IsNotNull()) && (toolsInNewOrder->GetToolCount() > 0))
{
//so delete the old tools in wrong order and add them in the right order
//we cannot simply replace the tool storage because the new storage is
//not correctly initialized with the right data storage
/*
m_NavigationToolStorage->DeleteAllTools();
for (int i=0; i < toolsInNewOrder->GetToolCount(); i++) {m_NavigationToolStorage->AddTool(toolsInNewOrder->GetTool(i));}
This was replaced and thereby fixed Bug 18318 DeleteAllTools() is not Threadsafe!
*/
- for(int i = 0; i < toolsInNewOrder->GetToolCount(); i++ )
+ for (int i = 0; i < toolsInNewOrder->GetToolCount(); i++)
{
- m_NavigationToolStorage->AssignToolNumber(toolsInNewOrder->GetTool(i)->GetIdentifier(),i);
+ m_NavigationToolStorage->AssignToolNumber(toolsInNewOrder->GetTool(i)->GetIdentifier(), i);
}
-
}
mitk::ProgressBar::GetInstance()->Progress();
//connect to device
try
{
m_TrackingDeviceSource->Connect();
mitk::ProgressBar::GetInstance()->Progress();
//Microservice registration:
m_TrackingDeviceSource->RegisterAsMicroservice();
m_NavigationToolStorage->UnRegisterMicroservice();
m_NavigationToolStorage->RegisterAsMicroservice(m_TrackingDeviceSource->GetMicroserviceID());
m_NavigationToolStorage->LockStorage();
}
catch (...) //todo: change to mitk::IGTException
{
message = "Error on connecting the tracking device.";
- emit ConnectDeviceFinished(false,QString(message.c_str()));
+ emit ConnectDeviceFinished(false, QString(message.c_str()));
return;
}
- emit ConnectDeviceFinished(true,QString(message.c_str()));
+ emit ConnectDeviceFinished(true, QString(message.c_str()));
mitk::ProgressBar::GetInstance()->Progress(10);
}
void QmitkMITKIGTTrackingToolboxViewWorker::StartTracking()
{
QString errorMessage = "";
try
{
m_TrackingDeviceSource->StartTracking();
}
catch (...) //todo: change to mitk::IGTException
{
errorMessage += "Error while starting the tracking device!";
- emit StartTrackingFinished(false,errorMessage);
+ emit StartTrackingFinished(false, errorMessage);
return;
}
//remember the original colors of the tools
- m_OriginalColors = std::map();
- for(int i=0; im_NavigationToolStorage->GetToolCount(); i++)
- {
+ m_OriginalColors = std::map();
+ for (int i = 0; i < this->m_NavigationToolStorage->GetToolCount(); i++)
+ {
mitk::DataNode::Pointer currentToolNode = m_NavigationToolStorage->GetTool(i)->GetDataNode();
float c[3];
currentToolNode->GetColor(c);
mitk::Color color;
color.SetRed(c[0]);
color.SetGreen(c[1]);
color.SetBlue(c[2]);
m_OriginalColors[currentToolNode] = color;
- }
+ }
- emit StartTrackingFinished(true,errorMessage);
+ emit StartTrackingFinished(true, errorMessage);
}
void QmitkMITKIGTTrackingToolboxViewWorker::StopTracking()
{
//stop tracking
try
{
m_TrackingDeviceSource->StopTracking();
}
- catch(mitk::Exception& e)
+ catch (mitk::Exception& e)
{
emit StopTrackingFinished(false, e.GetDescription());
}
//restore the original colors of the tools
- for(int i=0; im_NavigationToolStorage->GetToolCount(); i++)
+ for (int i = 0; i < this->m_NavigationToolStorage->GetToolCount(); i++)
{
mitk::DataNode::Pointer currentToolNode = m_NavigationToolStorage->GetTool(i)->GetDataNode();
if (m_OriginalColors.find(currentToolNode) == m_OriginalColors.end())
- {MITK_WARN << "Cannot restore original color of tool " << m_NavigationToolStorage->GetTool(i)->GetToolName();}
+ {
+ MITK_WARN << "Cannot restore original color of tool " << m_NavigationToolStorage->GetTool(i)->GetToolName();
+ }
else
- {currentToolNode->SetColor(m_OriginalColors[currentToolNode]);}
+ {
+ currentToolNode->SetColor(m_OriginalColors[currentToolNode]);
+ }
}
//emit signal
emit StopTrackingFinished(true, "");
}
void QmitkMITKIGTTrackingToolboxViewWorker::DisconnectDevice()
{
try
{
- if (m_TrackingDeviceSource->IsTracking()) {m_TrackingDeviceSource->StopTracking();}
+ if (m_TrackingDeviceSource->IsTracking()) { m_TrackingDeviceSource->StopTracking(); }
m_TrackingDeviceSource->Disconnect();
m_TrackingDeviceSource->UnRegisterMicroservice();
m_NavigationToolStorage->UnLockStorage();
}
- catch(mitk::Exception& e)
+ catch (mitk::Exception& e)
{
emit DisconnectDeviceFinished(false, e.GetDescription());
}
emit DisconnectDeviceFinished(true, "");
-}
+}
\ No newline at end of file