introvoyz041 commited on
Commit
2d6bfa0
·
verified ·
1 Parent(s): 686c579

Migrated from GitHub

Browse files
This view is limited to 50 files because it contains too many changes.   See raw diff
Files changed (50) hide show
  1. .gitattributes +12 -0
  2. data/.clang-format +90 -0
  3. data/.isort.cfg +7 -0
  4. data/.pre-commit-config.yaml +53 -0
  5. data/.pylintrc +553 -0
  6. data/.readthedocs.yaml +35 -0
  7. data/Doxyfile +1783 -0
  8. data/camera_calibration_config.rviz +1621 -0
  9. data/docker-compose.yml +9 -0
  10. data/docs/Makefile +20 -0
  11. data/docs/make.bat +35 -0
  12. data/docs/requirements.txt +2 -0
  13. data/docs/source/conf.py +73 -0
  14. data/docs/source/contributing/coding_style.rst +219 -0
  15. data/docs/source/contributing/index.rst +10 -0
  16. data/docs/source/contributing/ros.rst +187 -0
  17. data/docs/source/contributing/toolkit.rst +4 -0
  18. data/docs/source/docker.rst +130 -0
  19. data/docs/source/getting_started.rst +205 -0
  20. data/docs/source/images/youbot_annotated.png +3 -0
  21. data/docs/source/index.rst +42 -0
  22. data/docs/source/infrastructure.rst +73 -0
  23. data/docs/source/introduction.rst +5 -0
  24. data/docs/source/mir_manipulation/docstring/index.rst +10 -0
  25. data/docs/source/mir_manipulation/docstring/mir_moveit_scene_ros.rst +20 -0
  26. data/docs/source/mir_manipulation/docstring/mir_pregrasp_planning_ros.rst +28 -0
  27. data/docs/source/mir_manipulation/index.rst +6 -0
  28. data/docs/source/mir_navigation/docstring/index.rst +10 -0
  29. data/docs/source/mir_navigation/docstring/mir_move_base_ros.rst +12 -0
  30. data/docs/source/mir_navigation/index.rst +217 -0
  31. data/docs/source/mir_perception/barrier_tape.rst +4 -0
  32. data/docs/source/mir_perception/camera.rst +207 -0
  33. data/docs/source/mir_perception/cavity_detection.rst +4 -0
  34. data/docs/source/mir_perception/dataset.rst +124 -0
  35. data/docs/source/mir_perception/docstring/index.rst +7 -0
  36. data/docs/source/mir_perception/images/camera_calib_side.png +3 -0
  37. data/docs/source/mir_perception/images/camera_calib_top.png +3 -0
  38. data/docs/source/mir_perception/images/perception_architecture.png +3 -0
  39. data/docs/source/mir_perception/index.rst +21 -0
  40. data/docs/source/mir_perception/object_recognition.rst +106 -0
  41. data/docs/source/mir_perception/object_segmentation.rst +143 -0
  42. data/docs/source/mir_perception/training.rst +47 -0
  43. data/docs/source/mir_planning/actions/insert_cavity.rst +15 -0
  44. data/docs/source/mir_planning/actions/insert_object.rst +12 -0
  45. data/docs/source/mir_planning/actions/move_base_safe.rst +17 -0
  46. data/docs/source/mir_planning/actions/perceive_cavity.rst +11 -0
  47. data/docs/source/mir_planning/actions/perceive_location.rst +11 -0
  48. data/docs/source/mir_planning/actions/perceive_mock.rst +23 -0
  49. data/docs/source/mir_planning/actions/pick_object.rst +12 -0
  50. data/docs/source/mir_planning/actions/place_object.rst +11 -0
.gitattributes CHANGED
@@ -57,3 +57,15 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
57
  # Video files - compressed
58
  *.mp4 filter=lfs diff=lfs merge=lfs -text
59
  *.webm filter=lfs diff=lfs merge=lfs -text
 
 
 
 
 
 
 
 
 
 
 
 
 
57
  # Video files - compressed
58
  *.mp4 filter=lfs diff=lfs merge=lfs -text
59
  *.webm filter=lfs diff=lfs merge=lfs -text
60
+ data/mir_command_tools/mir_teleop/ros/doc/youbot_joypad_description.pdf filter=lfs diff=lfs merge=lfs -text
61
+ data/mir_command_tools/mir_teleop/ros/doc/youbot_joypad_description.vsd filter=lfs diff=lfs merge=lfs -text
62
+ data/mir_common/mir_description/meshes/grippers/dynamixel/d435_center/dynamixel_motor_mount.stl filter=lfs diff=lfs merge=lfs -text
63
+ data/mir_common/mir_description/meshes/grippers/dynamixel/v3/dynamixel_intel_camera_combined.stl filter=lfs diff=lfs merge=lfs -text
64
+ data/mir_common/mir_description/meshes/sensor_mounts/d435.dae filter=lfs diff=lfs merge=lfs -text
65
+ data/mir_perception/mir_cavity_detector/tools/code/feature_extraction_from_dataset filter=lfs diff=lfs merge=lfs -text
66
+ data/mir_perception/mir_object_recognition/common/config/dgcnn_asus/model.ckpt.data-00000-of-00001 filter=lfs diff=lfs merge=lfs -text
67
+ data/mir_perception/mir_object_recognition/common/config/dgcnn_asus/model.ckpt.meta filter=lfs diff=lfs merge=lfs -text
68
+ data/mir_perception/mir_object_recognition/common/config/squeezeDet/atwork_sydney/model.ckpt.data-00000-of-00001 filter=lfs diff=lfs merge=lfs -text
69
+ data/mir_perception/mir_object_recognition/common/config/squeezeDet/atwork_sydney/model.ckpt.meta filter=lfs diff=lfs merge=lfs -text
70
+ data/mir_perception/mir_object_recognition/common/config/squeezeDet/stable/model.ckpt.data-00000-of-00001 filter=lfs diff=lfs merge=lfs -text
71
+ data/mir_perception/mir_object_recognition/common/config/squeezeDet/stable/model.ckpt.meta filter=lfs diff=lfs merge=lfs -text
data/.clang-format ADDED
@@ -0,0 +1,90 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ Language: Cpp
3
+ # BasedOnStyle: Google
4
+ AccessModifierOffset: -1
5
+ AlignAfterOpenBracket: Align
6
+ AlignConsecutiveAssignments: false
7
+ AlignConsecutiveDeclarations: false
8
+ AlignEscapedNewlinesLeft: true
9
+ AlignOperands: true
10
+ AlignTrailingComments: true
11
+ AllowAllParametersOfDeclarationOnNextLine: true
12
+ AllowShortBlocksOnASingleLine: false
13
+ AllowShortCaseLabelsOnASingleLine: false
14
+ AllowShortFunctionsOnASingleLine: All
15
+ AllowShortIfStatementsOnASingleLine: true
16
+ AllowShortLoopsOnASingleLine: true
17
+ AlwaysBreakAfterDefinitionReturnType: None
18
+ AlwaysBreakAfterReturnType: None
19
+ AlwaysBreakBeforeMultilineStrings: true
20
+ AlwaysBreakTemplateDeclarations: true
21
+ BinPackArguments: true
22
+ BinPackParameters: true
23
+ BraceWrapping:
24
+ AfterClass: false
25
+ AfterControlStatement: false
26
+ AfterEnum: false
27
+ AfterFunction: false
28
+ AfterNamespace: false
29
+ AfterObjCDeclaration: false
30
+ AfterStruct: false
31
+ AfterUnion: false
32
+ BeforeCatch: false
33
+ BeforeElse: false
34
+ IndentBraces: false
35
+ BreakBeforeBinaryOperators: None
36
+ BreakBeforeBraces: Linux
37
+ BreakBeforeTernaryOperators: true
38
+ BreakConstructorInitializersBeforeComma: false
39
+ ColumnLimit: 100
40
+ CommentPragmas: '^ IWYU pragma:'
41
+ ConstructorInitializerAllOnOneLineOrOnePerLine: true
42
+ ConstructorInitializerIndentWidth: 4
43
+ ContinuationIndentWidth: 4
44
+ Cpp11BracedListStyle: true
45
+ DerivePointerAlignment: true
46
+ DisableFormat: false
47
+ ExperimentalAutoDetectBinPacking: false
48
+ ForEachMacros: [ foreach, Q_FOREACH, BOOST_FOREACH ]
49
+ IncludeCategories:
50
+ - Regex: '^<.*\.h>'
51
+ Priority: 1
52
+ - Regex: '^<.*'
53
+ Priority: 2
54
+ - Regex: '.*'
55
+ Priority: 3
56
+ IndentCaseLabels: true
57
+ IndentWidth: 2
58
+ IndentWrappedFunctionNames: false
59
+ KeepEmptyLinesAtTheStartOfBlocks: false
60
+ MacroBlockBegin: ''
61
+ MacroBlockEnd: ''
62
+ MaxEmptyLinesToKeep: 1
63
+ NamespaceIndentation: None
64
+ ObjCBlockIndentWidth: 2
65
+ ObjCSpaceAfterProperty: false
66
+ ObjCSpaceBeforeProtocolList: false
67
+ PenaltyBreakBeforeFirstCallParameter: 1
68
+ PenaltyBreakComment: 300
69
+ PenaltyBreakFirstLessLess: 120
70
+ PenaltyBreakString: 1000
71
+ PenaltyExcessCharacter: 1000000
72
+ PenaltyReturnTypeOnItsOwnLine: 200
73
+ PointerAlignment: Left
74
+ ReflowComments: true
75
+ SortIncludes: true
76
+ SpaceAfterCStyleCast: false
77
+ SpaceBeforeAssignmentOperators: true
78
+ SpaceBeforeParens: ControlStatements
79
+ SpaceInEmptyParentheses: false
80
+ SpacesBeforeTrailingComments: 2
81
+ SpacesInAngles: false
82
+ SpacesInContainerLiterals: true
83
+ SpacesInCStyleCastParentheses: false
84
+ SpacesInParentheses: false
85
+ SpacesInSquareBrackets: false
86
+ Standard: Auto
87
+ TabWidth: 8
88
+ UseTab: Never
89
+ ...
90
+
data/.isort.cfg ADDED
@@ -0,0 +1,7 @@
 
 
 
 
 
 
 
 
1
+ [settings]
2
+ known_third_party = PIL,actionlib,actionlib_msgs,arm_navigation_msgs,at_work_robot_example_ros,atwork_ros_msgs,brics_actuator,catkin_pkg,diagnostic_msgs,dynamic_reconfigure,geometry_msgs,mas_perception_msgs,mcr_common_converters_ros,mcr_manipulation_measurers_ros,mcr_manipulation_msgs,mcr_manipulation_pose_selector_ros,mcr_perception_msgs,mcr_perception_states,mcr_pose_generation_ros,mcr_states,mercury_planner,mir_actions,mir_controller_msgs,mir_knowledge,mir_knowledge_ros,mir_navigation_msgs,mir_planning_msgs,mir_planning_visualisation,mir_pregrasp_planning,mir_pregrasp_planning_ros,mir_states,mir_states_common,mir_world_generation,move_base_msgs,moveit_commander,moveit_msgs,nav_msgs,numpy,pandas,param_server_utils,roslib,rospkg,rosplan_dispatch_msgs,rosplan_knowledge_msgs,rospy,rostest,rosunit,sensor_msgs,shape_msgs,simple_script_server,smach,smach_ros,std_msgs,std_srvs,tf,visualization_msgs,yaml,zmq
3
+ multi_line_output=3
4
+ include_trailing_comma=True
5
+ force_grid_wrap=0
6
+ use_parentheses=True
7
+ line_length=88
data/.pre-commit-config.yaml ADDED
@@ -0,0 +1,53 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # See https://pre-commit.com for more information
2
+ # See https://pre-commit.com/hooks.html for more hooks
3
+ repos:
4
+ - repo: https://github.com/asottile/seed-isort-config
5
+ rev: v1.9.3
6
+ hooks:
7
+ - id: seed-isort-config
8
+
9
+ - repo: https://github.com/pre-commit/mirrors-isort
10
+ rev: v4.3.21
11
+ hooks:
12
+ - id: isort
13
+
14
+ - repo: https://github.com/ambv/black
15
+ rev: stable
16
+ hooks:
17
+ - id: black
18
+ language_version: python3.7 # Black requires python3.6 or above to run
19
+
20
+ - repo: https://github.com/pycqa/pylint
21
+ rev: pylint-2.4.4
22
+ hooks:
23
+ - id: pylint
24
+ entry: pylint --verbose --jobs 4
25
+ language_version: python3.7
26
+
27
+ - repo: https://github.com/pocc/pre-commit-hooks
28
+ rev: python
29
+ hooks:
30
+ - id: clang-format
31
+ language_version: python3.7
32
+
33
+ - repo: https://github.com/bmorcos/pre-commit-hooks-cpp
34
+ rev: master
35
+ hooks:
36
+ - id: cpplint
37
+ - id: cppcheck
38
+
39
+
40
+ - repo: https://github.com/pre-commit/pre-commit-hooks
41
+ rev: v2.5.0
42
+ hooks:
43
+ - id: trailing-whitespace
44
+ - id: check-json
45
+ - id: check-yaml
46
+ - id: check-toml
47
+ - id: check-xml
48
+ - id: check-merge-conflict
49
+ - id: mixed-line-ending
50
+ - id: name-tests-test
51
+ args: ['--django']
52
+ - id: no-commit-to-branch
53
+ args: [-b, kinetic, -b, melodic]
data/.pylintrc ADDED
@@ -0,0 +1,553 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ [MASTER]
2
+
3
+ # A comma-separated list of package or module names from where C extensions may
4
+ # be loaded. Extensions are loading into the active Python interpreter and may
5
+ # run arbitrary code
6
+ extension-pkg-whitelist=
7
+
8
+ # Add files or directories to the blacklist. They should be base names, not
9
+ # paths.
10
+ ignore=CVS
11
+
12
+ # Add files or directories matching the regex patterns to the blacklist. The
13
+ # regex matches against base names, not paths.
14
+ ignore-patterns=
15
+
16
+ # Python code to execute, usually for sys.path manipulation such as
17
+ # pygtk.require().
18
+ #init-hook=
19
+
20
+ # Use multiple processes to speed up Pylint.
21
+ jobs=1
22
+
23
+ # List of plugins (as comma separated values of python modules names) to load,
24
+ # usually to register additional checkers.
25
+ load-plugins=
26
+
27
+ # Pickle collected data for later comparisons.
28
+ persistent=yes
29
+
30
+ # Specify a configuration file.
31
+ #rcfile=
32
+
33
+ # When enabled, pylint would attempt to guess common misconfiguration and emit
34
+ # user-friendly hints instead of false-positive error messages
35
+ suggestion-mode=yes
36
+
37
+ # Allow loading of arbitrary C extensions. Extensions are imported into the
38
+ # active Python interpreter and may run arbitrary code.
39
+ unsafe-load-any-extension=no
40
+
41
+
42
+ [MESSAGES CONTROL]
43
+
44
+ # Only show warnings with the listed confidence levels. Leave empty to show
45
+ # all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED
46
+ confidence=
47
+
48
+ # Disable the message, report, category or checker with the given id(s). You
49
+ # can either give multiple identifiers separated by comma (,) or put this
50
+ # option multiple times (only on the command line, not in the configuration
51
+ # file where it should appear only once).You can also use "--disable=all" to
52
+ # disable everything first and then reenable specific checks. For example, if
53
+ # you want to run only the similarities checker, you can use "--disable=all
54
+ # --enable=similarities". If you want to run only the classes checker, but have
55
+ # no Warning level messages displayed, use"--disable=all --enable=classes
56
+ # --disable=W"
57
+ disable=print-statement,
58
+ parameter-unpacking,
59
+ unpacking-in-except,
60
+ old-raise-syntax,
61
+ backtick,
62
+ long-suffix,
63
+ old-ne-operator,
64
+ old-octal-literal,
65
+ import-star-module-level,
66
+ non-ascii-bytes-literal,
67
+ invalid-unicode-literal,
68
+ raw-checker-failed,
69
+ bad-inline-option,
70
+ locally-disabled,
71
+ locally-enabled,
72
+ file-ignored,
73
+ suppressed-message,
74
+ useless-suppression,
75
+ deprecated-pragma,
76
+ apply-builtin,
77
+ basestring-builtin,
78
+ buffer-builtin,
79
+ cmp-builtin,
80
+ coerce-builtin,
81
+ execfile-builtin,
82
+ file-builtin,
83
+ long-builtin,
84
+ raw_input-builtin,
85
+ reduce-builtin,
86
+ standarderror-builtin,
87
+ unicode-builtin,
88
+ xrange-builtin,
89
+ coerce-method,
90
+ delslice-method,
91
+ getslice-method,
92
+ setslice-method,
93
+ no-absolute-import,
94
+ old-division,
95
+ dict-iter-method,
96
+ dict-view-method,
97
+ next-method-called,
98
+ metaclass-assignment,
99
+ indexing-exception,
100
+ raising-string,
101
+ reload-builtin,
102
+ oct-method,
103
+ hex-method,
104
+ nonzero-method,
105
+ cmp-method,
106
+ input-builtin,
107
+ round-builtin,
108
+ intern-builtin,
109
+ unichr-builtin,
110
+ map-builtin-not-iterating,
111
+ zip-builtin-not-iterating,
112
+ range-builtin-not-iterating,
113
+ filter-builtin-not-iterating,
114
+ using-cmp-argument,
115
+ eq-without-hash,
116
+ div-method,
117
+ idiv-method,
118
+ rdiv-method,
119
+ exception-message-attribute,
120
+ invalid-str-codec,
121
+ sys-max-int,
122
+ bad-python3-import,
123
+ deprecated-string-function,
124
+ deprecated-str-translate-call,
125
+ deprecated-itertools-function,
126
+ deprecated-types-field,
127
+ next-method-defined,
128
+ dict-items-not-iterating,
129
+ dict-keys-not-iterating,
130
+ dict-values-not-iterating,
131
+ deprecated-operator-function,
132
+ deprecated-urllib-function,
133
+ xreadlines-attribute,
134
+ deprecated-sys-function,
135
+ exception-escape,
136
+ comprehension-escape,
137
+ R0205, # Python 2.7 classes require object
138
+ E0401, # Rospkg cant be imported in python 3.7
139
+ C0330, # Black code formatter takes care of this
140
+ W0703 # To be removed later after specifying exceptions
141
+
142
+ # Enable the message, report, category or checker with the given id(s). You can
143
+ # either give multiple identifier separated by comma (,) or put this option
144
+ # multiple time (only on the command line, not in the configuration file where
145
+ # it should appear only once). See also the "--disable" option for examples.
146
+ enable=c-extension-no-member
147
+
148
+
149
+ [REPORTS]
150
+
151
+ # Python expression which should return a note less than 10 (10 is the highest
152
+ # note). You have access to the variables errors warning, statement which
153
+ # respectively contain the number of errors / warnings messages and the total
154
+ # number of statements analyzed. This is used by the global evaluation report
155
+ # (RP0004).
156
+ evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
157
+
158
+ # Template used to display messages. This is a python new-style format string
159
+ # used to format the message information. See doc for all details
160
+ #msg-template=
161
+
162
+ # Set the output format. Available formats are text, parseable, colorized, json
163
+ # and msvs (visual studio).You can also give a reporter class, eg
164
+ # mypackage.mymodule.MyReporterClass.
165
+ output-format=text
166
+
167
+ # Tells whether to display a full report or only the messages
168
+ reports=no
169
+
170
+ # Activate the evaluation score.
171
+ score=yes
172
+
173
+
174
+ [REFACTORING]
175
+
176
+ # Maximum number of nested blocks for function / method body
177
+ max-nested-blocks=5
178
+
179
+ # Complete name of functions that never returns. When checking for
180
+ # inconsistent-return-statements if a never returning function is called then
181
+ # it will be considered as an explicit return statement and no message will be
182
+ # printed.
183
+ never-returning-functions=optparse.Values,sys.exit
184
+
185
+
186
+ [BASIC]
187
+
188
+ # Naming style matching correct argument names
189
+ argument-naming-style=snake_case
190
+
191
+ # Regular expression matching correct argument names. Overrides argument-
192
+ # naming-style
193
+ #argument-rgx=
194
+
195
+ # Naming style matching correct attribute names
196
+ attr-naming-style=snake_case
197
+
198
+ # Regular expression matching correct attribute names. Overrides attr-naming-
199
+ # style
200
+ #attr-rgx=
201
+
202
+ # Bad variable names which should always be refused, separated by a comma
203
+ bad-names=foo,
204
+ bar,
205
+ baz,
206
+ toto,
207
+ tutu,
208
+ tata
209
+
210
+ # Naming style matching correct class attribute names
211
+ class-attribute-naming-style=any
212
+
213
+ # Regular expression matching correct class attribute names. Overrides class-
214
+ # attribute-naming-style
215
+ #class-attribute-rgx=
216
+
217
+ # Naming style matching correct class names
218
+ class-naming-style=PascalCase
219
+
220
+ # Regular expression matching correct class names. Overrides class-naming-style
221
+ #class-rgx=
222
+
223
+ # Naming style matching correct constant names
224
+ const-naming-style=UPPER_CASE
225
+
226
+ # Regular expression matching correct constant names. Overrides const-naming-
227
+ # style
228
+ #const-rgx=
229
+
230
+ # Minimum line length for functions/classes that require docstrings, shorter
231
+ # ones are exempt.
232
+ docstring-min-length=-1
233
+
234
+ # Naming style matching correct function names
235
+ function-naming-style=snake_case
236
+
237
+ # Regular expression matching correct function names. Overrides function-
238
+ # naming-style
239
+ #function-rgx=
240
+
241
+ # Good variable names which should always be accepted, separated by a comma
242
+ good-names=i,
243
+ j,
244
+ k,
245
+ ex,
246
+ Run,
247
+ _
248
+
249
+ # Include a hint for the correct naming format with invalid-name
250
+ include-naming-hint=no
251
+
252
+ # Naming style matching correct inline iteration names
253
+ inlinevar-naming-style=any
254
+
255
+ # Regular expression matching correct inline iteration names. Overrides
256
+ # inlinevar-naming-style
257
+ #inlinevar-rgx=
258
+
259
+ # Naming style matching correct method names
260
+ method-naming-style=snake_case
261
+
262
+ # Regular expression matching correct method names. Overrides method-naming-
263
+ # style
264
+ #method-rgx=
265
+
266
+ # Naming style matching correct module names
267
+ module-naming-style=snake_case
268
+
269
+ # Regular expression matching correct module names. Overrides module-naming-
270
+ # style
271
+ #module-rgx=
272
+
273
+ # Colon-delimited sets of names that determine each other's naming style when
274
+ # the name regexes allow several styles.
275
+ name-group=
276
+
277
+ # Regular expression which should only match function or class names that do
278
+ # not require a docstring.
279
+ no-docstring-rgx=^_
280
+
281
+ # List of decorators that produce properties, such as abc.abstractproperty. Add
282
+ # to this list to register other decorators that produce valid properties.
283
+ property-classes=abc.abstractproperty
284
+
285
+ # Naming style matching correct variable names
286
+ variable-naming-style=snake_case
287
+
288
+ # Regular expression matching correct variable names. Overrides variable-
289
+ # naming-style
290
+ #variable-rgx=
291
+
292
+
293
+ [SPELLING]
294
+
295
+ # Limits count of emitted suggestions for spelling mistakes
296
+ max-spelling-suggestions=4
297
+
298
+ # Spelling dictionary name. Available dictionaries: none. To make it working
299
+ # install python-enchant package.
300
+ spelling-dict=
301
+
302
+ # List of comma separated words that should not be checked.
303
+ spelling-ignore-words=
304
+
305
+ # A path to a file that contains private dictionary; one word per line.
306
+ spelling-private-dict-file=
307
+
308
+ # Tells whether to store unknown words to indicated private dictionary in
309
+ # --spelling-private-dict-file option instead of raising a message.
310
+ spelling-store-unknown-words=no
311
+
312
+
313
+ [FORMAT]
314
+
315
+ # Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
316
+ expected-line-ending-format=
317
+
318
+ # Regexp for a line that is allowed to be longer than the limit.
319
+ ignore-long-lines=^\s*(# )?<?https?://\S+>?$
320
+
321
+ # Number of spaces of indent required inside a hanging or continued line.
322
+ indent-after-paren=4
323
+
324
+ # String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
325
+ # tab).
326
+ indent-string=' '
327
+
328
+ # Maximum number of characters on a single line.
329
+ max-line-length=100
330
+
331
+ # Maximum number of lines in a module
332
+ max-module-lines=1000
333
+
334
+ # List of optional constructs for which whitespace checking is disabled. `dict-
335
+ # separator` is used to allow tabulation in dicts, etc.: {1 : 1,\n222: 2}.
336
+ # `trailing-comma` allows a space between comma and closing bracket: (a, ).
337
+ # `empty-line` allows space-only lines.
338
+ no-space-check=trailing-comma,
339
+ dict-separator
340
+
341
+ # Allow the body of a class to be on the same line as the declaration if body
342
+ # contains single statement.
343
+ single-line-class-stmt=no
344
+
345
+ # Allow the body of an if to be on the same line as the test if there is no
346
+ # else.
347
+ single-line-if-stmt=no
348
+
349
+
350
+ [TYPECHECK]
351
+
352
+ # List of decorators that produce context managers, such as
353
+ # contextlib.contextmanager. Add to this list to register other decorators that
354
+ # produce valid context managers.
355
+ contextmanager-decorators=contextlib.contextmanager
356
+
357
+ # List of members which are set dynamically and missed by pylint inference
358
+ # system, and so shouldn't trigger E1101 when accessed. Python regular
359
+ # expressions are accepted.
360
+ generated-members=
361
+
362
+ # Tells whether missing members accessed in mixin class should be ignored. A
363
+ # mixin class is detected if its name ends with "mixin" (case insensitive).
364
+ ignore-mixin-members=yes
365
+
366
+ # This flag controls whether pylint should warn about no-member and similar
367
+ # checks whenever an opaque object is returned when inferring. The inference
368
+ # can return multiple potential results while evaluating a Python object, but
369
+ # some branches might not be evaluated, which results in partial inference. In
370
+ # that case, it might be useful to still emit no-member and other checks for
371
+ # the rest of the inferred objects.
372
+ ignore-on-opaque-inference=yes
373
+
374
+ # List of class names for which member attributes should not be checked (useful
375
+ # for classes with dynamically set attributes). This supports the use of
376
+ # qualified names.
377
+ ignored-classes=optparse.Values,thread._local,_thread._local
378
+
379
+ # List of module names for which member attributes should not be checked
380
+ # (useful for modules/projects where namespaces are manipulated during runtime
381
+ # and thus existing member attributes cannot be deduced by static analysis. It
382
+ # supports qualified module names, as well as Unix pattern matching.
383
+ ignored-modules=
384
+
385
+ # Show a hint with possible names when a member name was not found. The aspect
386
+ # of finding the hint is based on edit distance.
387
+ missing-member-hint=yes
388
+
389
+ # The minimum edit distance a name should have in order to be considered a
390
+ # similar match for a missing member name.
391
+ missing-member-hint-distance=1
392
+
393
+ # The total number of similar names that should be taken in consideration when
394
+ # showing a hint for a missing member.
395
+ missing-member-max-choices=1
396
+
397
+
398
+ [VARIABLES]
399
+
400
+ # List of additional names supposed to be defined in builtins. Remember that
401
+ # you should avoid to define new builtins when possible.
402
+ additional-builtins=
403
+
404
+ # Tells whether unused global variables should be treated as a violation.
405
+ allow-global-unused-variables=yes
406
+
407
+ # List of strings which can identify a callback function by name. A callback
408
+ # name must start or end with one of those strings.
409
+ callbacks=cb_,
410
+ _cb
411
+
412
+ # A regular expression matching the name of dummy variables (i.e. expectedly
413
+ # not used).
414
+ dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_
415
+
416
+ # Argument names that match this expression will be ignored. Default to name
417
+ # with leading underscore
418
+ ignored-argument-names=_.*|^ignored_|^unused_
419
+
420
+ # Tells whether we should check for unused import in __init__ files.
421
+ init-import=no
422
+
423
+ # List of qualified module names which can have objects that can redefine
424
+ # builtins.
425
+ redefining-builtins-modules=six.moves,past.builtins,future.builtins,io,builtins
426
+
427
+
428
+ [LOGGING]
429
+
430
+ # Logging modules to check that the string format arguments are in logging
431
+ # function parameter format
432
+ logging-modules=logging
433
+
434
+
435
+ [MISCELLANEOUS]
436
+
437
+ # List of note tags to take in consideration, separated by a comma.
438
+ notes=FIXME,
439
+ XXX,
440
+ TODO
441
+
442
+
443
+ [SIMILARITIES]
444
+
445
+ # Ignore comments when computing similarities.
446
+ ignore-comments=yes
447
+
448
+ # Ignore docstrings when computing similarities.
449
+ ignore-docstrings=yes
450
+
451
+ # Ignore imports when computing similarities.
452
+ ignore-imports=no
453
+
454
+ # Minimum lines number of a similarity.
455
+ min-similarity-lines=4
456
+
457
+
458
+ [IMPORTS]
459
+
460
+ # Allow wildcard imports from modules that define __all__.
461
+ allow-wildcard-with-all=no
462
+
463
+ # Analyse import fallback blocks. This can be used to support both Python 2 and
464
+ # 3 compatible code, which means that the block might have code that exists
465
+ # only in one or another interpreter, leading to false positives when analysed.
466
+ analyse-fallback-blocks=no
467
+
468
+ # Deprecated modules which should not be used, separated by a comma
469
+ deprecated-modules=regsub,
470
+ TERMIOS,
471
+ Bastion,
472
+ rexec
473
+
474
+ # Create a graph of external dependencies in the given file (report RP0402 must
475
+ # not be disabled)
476
+ ext-import-graph=
477
+
478
+ # Create a graph of every (i.e. internal and external) dependencies in the
479
+ # given file (report RP0402 must not be disabled)
480
+ import-graph=
481
+
482
+ # Create a graph of internal dependencies in the given file (report RP0402 must
483
+ # not be disabled)
484
+ int-import-graph=
485
+
486
+ # Force import order to recognize a module as part of the standard
487
+ # compatibility libraries.
488
+ known-standard-library=
489
+
490
+ # Force import order to recognize a module as part of a third party library.
491
+ known-third-party=enchant
492
+
493
+
494
+ [CLASSES]
495
+
496
+ # List of method names used to declare (i.e. assign) instance attributes.
497
+ defining-attr-methods=__init__,
498
+ __new__,
499
+ setUp
500
+
501
+ # List of member names, which should be excluded from the protected access
502
+ # warning.
503
+ exclude-protected=_asdict,
504
+ _fields,
505
+ _replace,
506
+ _source,
507
+ _make
508
+
509
+ # List of valid names for the first argument in a class method.
510
+ valid-classmethod-first-arg=cls
511
+
512
+ # List of valid names for the first argument in a metaclass class method.
513
+ valid-metaclass-classmethod-first-arg=mcs
514
+
515
+
516
+ [DESIGN]
517
+
518
+ # Maximum number of arguments for function / method
519
+ max-args=5
520
+
521
+ # Maximum number of attributes for a class (see R0902).
522
+ max-attributes=7
523
+
524
+ # Maximum number of boolean expressions in a if statement
525
+ max-bool-expr=5
526
+
527
+ # Maximum number of branch for function / method body
528
+ max-branches=12
529
+
530
+ # Maximum number of locals for function / method body
531
+ max-locals=15
532
+
533
+ # Maximum number of parents for a class (see R0901).
534
+ max-parents=7
535
+
536
+ # Maximum number of public methods for a class (see R0904).
537
+ max-public-methods=20
538
+
539
+ # Maximum number of return / yield for function / method body
540
+ max-returns=6
541
+
542
+ # Maximum number of statements in function / method body
543
+ max-statements=50
544
+
545
+ # Minimum number of public methods for a class (see R0903).
546
+ min-public-methods=2
547
+
548
+
549
+ [EXCEPTIONS]
550
+
551
+ # Exceptions that will emit a warning when being caught. Defaults to
552
+ # "Exception"
553
+ overgeneral-exceptions=Exception
data/.readthedocs.yaml ADDED
@@ -0,0 +1,35 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Read the Docs configuration file for Sphinx projects
2
+ # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
3
+
4
+ # Required
5
+ version: 2
6
+
7
+ # Set the OS, Python version and other tools you might need
8
+ build:
9
+ os: ubuntu-22.04
10
+ tools:
11
+ python: "3.11"
12
+ # You can also specify other tool versions:
13
+ # nodejs: "20"
14
+ # rust: "1.70"
15
+ # golang: "1.20"
16
+
17
+ # Build documentation in the "docs/" directory with Sphinx
18
+ sphinx:
19
+ configuration: docs/source/conf.py
20
+ # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
21
+ # builder: "dirhtml"
22
+ # Fail on all warnings to avoid broken references
23
+ # fail_on_warning: true
24
+
25
+ # Optionally build your docs in additional formats such as PDF and ePub
26
+ formats:
27
+ - pdf
28
+ - epub
29
+
30
+ # Optional but recommended, declare the Python requirements required
31
+ # to build your documentation
32
+ # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
33
+ python:
34
+ install:
35
+ - requirements: docs/requirements.txt
data/Doxyfile ADDED
@@ -0,0 +1,1783 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Doxyfile 1.7.6.1
2
+
3
+ # This file describes the settings to be used by the documentation system
4
+ # doxygen (www.doxygen.org) for a project.
5
+ #
6
+ # All text after a hash (#) is considered a comment and will be ignored.
7
+ # The format is:
8
+ # TAG = value [value, ...]
9
+ # For lists items can also be appended using:
10
+ # TAG += value [value, ...]
11
+ # Values that contain spaces should be placed between quotes (" ").
12
+
13
+ # ---------------------------------------------------------------------------
14
+ # Project related configuration options
15
+ # ---------------------------------------------------------------------------
16
+
17
+ # This tag specifies the encoding used for all characters in the config file
18
+ # that follow. The default is UTF-8 which is also the encoding used for all
19
+ # text before the first occurrence of this tag. Doxygen uses libiconv (or the
20
+ # iconv built into libc) for the transcoding. See
21
+ # http://www.gnu.org/software/libiconv for the list of possible encodings.
22
+
23
+ DOXYFILE_ENCODING = UTF - 8
24
+
25
+ # The PROJECT_NAME tag is a single word (or sequence of words) that should
26
+ # identify the project. Note that if you do not use Doxywizard you need
27
+ # to put quotes around the project name if it contains spaces.
28
+
29
+ PROJECT_NAME = "mas_industrial_robotics"
30
+
31
+ # The PROJECT_NUMBER tag can be used to enter a project or revision number.
32
+ # This could be handy for archiving the generated documentation or
33
+ # if some version control system is used.
34
+
35
+ PROJECT_NUMBER =
36
+
37
+ # Using the PROJECT_BRIEF tag one can provide an optional one line description
38
+ # for a project that appears at the top of each page and should give viewer
39
+ # a quick idea about the purpose of the project. Keep the description short.
40
+
41
+ PROJECT_BRIEF =
42
+
43
+ # With the PROJECT_LOGO tag one can specify an logo or icon that is
44
+ # included in the documentation. The maximum height of the logo should not
45
+ # exceed 55 pixels and the maximum width should not exceed 200 pixels.
46
+ # Doxygen will copy the logo to the output directory.
47
+
48
+ PROJECT_LOGO =
49
+
50
+ # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
51
+ # base path where the generated documentation will be put.
52
+ # If a relative path is entered, it will be relative to the location
53
+ # where doxygen was started. If left blank the current directory will be used.
54
+
55
+ OUTPUT_DIRECTORY =
56
+
57
+ # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
58
+ # 4096 sub-directories (in 2 levels) under the output directory of each output
59
+ # format and will distribute the generated files over these directories.
60
+ # Enabling this option can be useful when feeding doxygen a huge amount of
61
+ # source files, where putting all generated files in the same directory would
62
+ # otherwise cause performance problems for the file system.
63
+
64
+ CREATE_SUBDIRS = NO
65
+
66
+ # The OUTPUT_LANGUAGE tag is used to specify the language in which all
67
+ # documentation generated by doxygen is written. Doxygen will use this
68
+ # information to generate all constant output in the proper language.
69
+ # The default language is English, other supported languages are:
70
+ # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
71
+ # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
72
+ # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
73
+ # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
74
+ # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
75
+ # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
76
+
77
+ OUTPUT_LANGUAGE = English
78
+
79
+ # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
80
+ # include brief member descriptions after the members that are listed in
81
+ # the file and class documentation (similar to JavaDoc).
82
+ # Set to NO to disable this.
83
+
84
+ BRIEF_MEMBER_DESC = YES
85
+
86
+ # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
87
+ # the brief description of a member or function before the detailed description.
88
+ # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
89
+ # brief descriptions will be completely suppressed.
90
+
91
+ REPEAT_BRIEF = YES
92
+
93
+ # This tag implements a quasi-intelligent brief description abbreviator
94
+ # that is used to form the text in various listings. Each string
95
+ # in this list, if found as the leading text of the brief description, will be
96
+ # stripped from the text and the result after processing the whole list, is
97
+ # used as the annotated text. Otherwise, the brief description is used as-is.
98
+ # If left blank, the following values are used ("$name" is automatically
99
+ # replaced with the name of the entity): "The $name class" "The $name widget"
100
+ # "The $name file" "is" "provides" "specifies" "contains"
101
+ # "represents" "a" "an" "the"
102
+
103
+ ABBREVIATE_BRIEF =
104
+
105
+ # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
106
+ # Doxygen will generate a detailed section even if there is only a brief
107
+ # description.
108
+
109
+ ALWAYS_DETAILED_SEC = NO
110
+
111
+ # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
112
+ # inherited members of a class in the documentation of that class as if those
113
+ # members were ordinary class members. Constructors, destructors and assignment
114
+ # operators of the base classes will not be shown.
115
+
116
+ INLINE_INHERITED_MEMB = NO
117
+
118
+ # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
119
+ # path before files name in the file list and in the header files. If set
120
+ # to NO the shortest path that makes the file name unique will be used.
121
+
122
+ FULL_PATH_NAMES = YES
123
+
124
+ # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
125
+ # can be used to strip a user-defined part of the path. Stripping is
126
+ # only done if one of the specified strings matches the left-hand part of
127
+ # the path. The tag can be used to show relative paths in the file list.
128
+ # If left blank the directory from which doxygen is run is used as the
129
+ # path to strip.
130
+
131
+ STRIP_FROM_PATH =
132
+
133
+ # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
134
+ # the path mentioned in the documentation of a class, which tells
135
+ # the reader which header file to include in order to use a class.
136
+ # If left blank only the name of the header file containing the class
137
+ # definition is used. Otherwise one should specify the include paths that
138
+ # are normally passed to the compiler using the -I flag.
139
+
140
+ STRIP_FROM_INC_PATH =
141
+
142
+ # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
143
+ # (but less readable) file names. This can be useful if your file system
144
+ # doesn't support long names like on DOS, Mac, or CD-ROM.
145
+
146
+ SHORT_NAMES = NO
147
+
148
+ # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
149
+ # will interpret the first line (until the first dot) of a JavaDoc-style
150
+ # comment as the brief description. If set to NO, the JavaDoc
151
+ # comments will behave just like regular Qt-style comments
152
+ # (thus requiring an explicit @brief command for a brief description.)
153
+
154
+ JAVADOC_AUTOBRIEF = NO
155
+
156
+ # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
157
+ # interpret the first line (until the first dot) of a Qt-style
158
+ # comment as the brief description. If set to NO, the comments
159
+ # will behave just like regular Qt-style comments (thus requiring
160
+ # an explicit \brief command for a brief description.)
161
+
162
+ QT_AUTOBRIEF = NO
163
+
164
+ # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
165
+ # treat a multi-line C++ special comment block (i.e. a block of //! or ///
166
+ # comments) as a brief description. This used to be the default behaviour.
167
+ # The new default is to treat a multi-line C++ comment block as a detailed
168
+ # description. Set this tag to YES if you prefer the old behaviour instead.
169
+
170
+ MULTILINE_CPP_IS_BRIEF = NO
171
+
172
+ # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
173
+ # member inherits the documentation from any documented member that it
174
+ # re-implements.
175
+
176
+ INHERIT_DOCS = YES
177
+
178
+ # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
179
+ # a new page for each member. If set to NO, the documentation of a member will
180
+ # be part of the file/class/namespace that contains it.
181
+
182
+ SEPARATE_MEMBER_PAGES = NO
183
+
184
+ # The TAB_SIZE tag can be used to set the number of spaces in a tab.
185
+ # Doxygen uses this value to replace tabs by spaces in code fragments.
186
+
187
+ TAB_SIZE = 8
188
+
189
+ # This tag can be used to specify a number of aliases that acts
190
+ # as commands in the documentation. An alias has the form "name=value".
191
+ # For example adding "sideeffect=\par Side Effects:\n" will allow you to
192
+ # put the command \sideeffect (or @sideeffect) in the documentation, which
193
+ # will result in a user-defined paragraph with heading "Side Effects:".
194
+ # You can put \n's in the value part of an alias to insert newlines.
195
+
196
+ ALIASES =
197
+
198
+ # This tag can be used to specify a number of word-keyword mappings (TCL only).
199
+ # A mapping has the form "name=value". For example adding
200
+ # "class=itcl::class" will allow you to use the command class in the
201
+ # itcl::class meaning.
202
+
203
+ TCL_SUBST =
204
+
205
+ # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
206
+ # sources only. Doxygen will then generate output that is more tailored for C.
207
+ # For instance, some of the names that are used will be different. The list
208
+ # of all members will be omitted, etc.
209
+
210
+ OPTIMIZE_OUTPUT_FOR_C = NO
211
+
212
+ # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
213
+ # sources only. Doxygen will then generate output that is more tailored for
214
+ # Java. For instance, namespaces will be presented as packages, qualified
215
+ # scopes will look different, etc.
216
+
217
+ OPTIMIZE_OUTPUT_JAVA = NO
218
+
219
+ # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
220
+ # sources only. Doxygen will then generate output that is more tailored for
221
+ # Fortran.
222
+
223
+ OPTIMIZE_FOR_FORTRAN = NO
224
+
225
+ # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
226
+ # sources. Doxygen will then generate output that is tailored for
227
+ # VHDL.
228
+
229
+ OPTIMIZE_OUTPUT_VHDL = NO
230
+
231
+ # Doxygen selects the parser to use depending on the extension of the files it
232
+ # parses. With this tag you can assign which parser to use for a given extension.
233
+ # Doxygen has a built-in mapping, but you can override or extend it using this
234
+ # tag. The format is ext=language, where ext is a file extension, and language
235
+ # is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
236
+ # C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
237
+ # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
238
+ # (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
239
+ # you also need to set FILE_PATTERNS otherwise the files are not read by
240
+ # doxygen.
241
+
242
+ EXTENSION_MAPPING =
243
+
244
+ # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
245
+ # to include (a tag file for) the STL sources as input, then you should
246
+ # set this tag to YES in order to let doxygen match functions declarations and
247
+ # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
248
+ # func(std::string) {}). This also makes the inheritance and collaboration
249
+ # diagrams that involve STL classes more complete and accurate.
250
+
251
+ BUILTIN_STL_SUPPORT = NO
252
+
253
+ # If you use Microsoft's C++/CLI language, you should set this option to YES to
254
+ # enable parsing support.
255
+
256
+ CPP_CLI_SUPPORT = NO
257
+
258
+ # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
259
+ # Doxygen will parse them like normal C++ but will assume all classes use public
260
+ # instead of private inheritance when no explicit protection keyword is
261
+ # present.
262
+
263
+ SIP_SUPPORT = NO
264
+
265
+ # For Microsoft's IDL there are propget and propput attributes to indicate getter
266
+ # and setter methods for a property. Setting this option to YES (the default)
267
+ # will make doxygen replace the get and set methods by a property in the
268
+ # documentation. This will only work if the methods are indeed getting or
269
+ # setting a simple type. If this is not the case, or you want to show the
270
+ # methods anyway, you should set this option to NO.
271
+
272
+ IDL_PROPERTY_SUPPORT = YES
273
+
274
+ # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
275
+ # tag is set to YES, then doxygen will reuse the documentation of the first
276
+ # member in the group (if any) for the other members of the group. By default
277
+ # all members of a group must be documented explicitly.
278
+
279
+ DISTRIBUTE_GROUP_DOC = NO
280
+
281
+ # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
282
+ # the same type (for instance a group of public functions) to be put as a
283
+ # subgroup of that type (e.g. under the Public Functions section). Set it to
284
+ # NO to prevent subgrouping. Alternatively, this can be done per class using
285
+ # the \nosubgrouping command.
286
+
287
+ SUBGROUPING = YES
288
+
289
+ # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
290
+ # unions are shown inside the group in which they are included (e.g. using
291
+ # @ingroup) instead of on a separate page (for HTML and Man pages) or
292
+ # section (for LaTeX and RTF).
293
+
294
+ INLINE_GROUPED_CLASSES = NO
295
+
296
+ # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and
297
+ # unions with only public data fields will be shown inline in the documentation
298
+ # of the scope in which they are defined (i.e. file, namespace, or group
299
+ # documentation), provided this scope is documented. If set to NO (the default),
300
+ # structs, classes, and unions are shown on a separate page (for HTML and Man
301
+ # pages) or section (for LaTeX and RTF).
302
+
303
+ INLINE_SIMPLE_STRUCTS = NO
304
+
305
+ # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
306
+ # is documented as struct, union, or enum with the name of the typedef. So
307
+ # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
308
+ # with name TypeT. When disabled the typedef will appear as a member of a file,
309
+ # namespace, or class. And the struct will be named TypeS. This can typically
310
+ # be useful for C code in case the coding convention dictates that all compound
311
+ # types are typedef'ed and only the typedef is referenced, never the tag name.
312
+
313
+ TYPEDEF_HIDES_STRUCT = NO
314
+
315
+ # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
316
+ # determine which symbols to keep in memory and which to flush to disk.
317
+ # When the cache is full, less often used symbols will be written to disk.
318
+ # For small to medium size projects (<1000 input files) the default value is
319
+ # probably good enough. For larger projects a too small cache size can cause
320
+ # doxygen to be busy swapping symbols to and from disk most of the time
321
+ # causing a significant performance penalty.
322
+ # If the system has enough physical memory increasing the cache will improve the
323
+ # performance by keeping more symbols in memory. Note that the value works on
324
+ # a logarithmic scale so increasing the size by one will roughly double the
325
+ # memory usage. The cache size is given by this formula:
326
+ # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
327
+ # corresponding to a cache size of 2^16 = 65536 symbols.
328
+
329
+ SYMBOL_CACHE_SIZE = 0
330
+
331
+ # Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be
332
+ # set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
333
+ # their name and scope. Since this can be an expensive process and often the
334
+ # same symbol appear multiple times in the code, doxygen keeps a cache of
335
+ # pre-resolved symbols. If the cache is too small doxygen will become slower.
336
+ # If the cache is too large, memory is wasted. The cache size is given by this
337
+ # formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0,
338
+ # corresponding to a cache size of 2^16 = 65536 symbols.
339
+
340
+ LOOKUP_CACHE_SIZE = 0
341
+
342
+ # ---------------------------------------------------------------------------
343
+ # Build related configuration options
344
+ # ---------------------------------------------------------------------------
345
+
346
+ # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
347
+ # documentation are documented, even if no documentation was available.
348
+ # Private class members and static file members will be hidden unless
349
+ # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
350
+
351
+ EXTRACT_ALL = YES
352
+
353
+ # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
354
+ # will be included in the documentation.
355
+
356
+ EXTRACT_PRIVATE = NO
357
+
358
+ # If the EXTRACT_STATIC tag is set to YES all static members of a file
359
+ # will be included in the documentation.
360
+
361
+ EXTRACT_STATIC = YES
362
+
363
+ # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
364
+ # defined locally in source files will be included in the documentation.
365
+ # If set to NO only classes defined in header files are included.
366
+
367
+ EXTRACT_LOCAL_CLASSES = YES
368
+
369
+ # This flag is only useful for Objective-C code. When set to YES local
370
+ # methods, which are defined in the implementation section but not in
371
+ # the interface are included in the documentation.
372
+ # If set to NO (the default) only methods in the interface are included.
373
+
374
+ EXTRACT_LOCAL_METHODS = NO
375
+
376
+ # If this flag is set to YES, the members of anonymous namespaces will be
377
+ # extracted and appear in the documentation as a namespace called
378
+ # 'anonymous_namespace{file}', where file will be replaced with the base
379
+ # name of the file that contains the anonymous namespace. By default
380
+ # anonymous namespaces are hidden.
381
+
382
+ EXTRACT_ANON_NSPACES = NO
383
+
384
+ # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
385
+ # undocumented members of documented classes, files or namespaces.
386
+ # If set to NO (the default) these members will be included in the
387
+ # various overviews, but no documentation section is generated.
388
+ # This option has no effect if EXTRACT_ALL is enabled.
389
+
390
+ HIDE_UNDOC_MEMBERS = NO
391
+
392
+ # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
393
+ # undocumented classes that are normally visible in the class hierarchy.
394
+ # If set to NO (the default) these classes will be included in the various
395
+ # overviews. This option has no effect if EXTRACT_ALL is enabled.
396
+
397
+ HIDE_UNDOC_CLASSES = NO
398
+
399
+ # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
400
+ # friend (class|struct|union) declarations.
401
+ # If set to NO (the default) these declarations will be included in the
402
+ # documentation.
403
+
404
+ HIDE_FRIEND_COMPOUNDS = NO
405
+
406
+ # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
407
+ # documentation blocks found inside the body of a function.
408
+ # If set to NO (the default) these blocks will be appended to the
409
+ # function's detailed documentation block.
410
+
411
+ HIDE_IN_BODY_DOCS = NO
412
+
413
+ # The INTERNAL_DOCS tag determines if documentation
414
+ # that is typed after a \internal command is included. If the tag is set
415
+ # to NO (the default) then the documentation will be excluded.
416
+ # Set it to YES to include the internal documentation.
417
+
418
+ INTERNAL_DOCS = NO
419
+
420
+ # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
421
+ # file names in lower-case letters. If set to YES upper-case letters are also
422
+ # allowed. This is useful if you have classes or files whose names only differ
423
+ # in case and if your file system supports case sensitive file names. Windows
424
+ # and Mac users are advised to set this option to NO.
425
+
426
+ CASE_SENSE_NAMES = YES
427
+
428
+ # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
429
+ # will show members with their full class and namespace scopes in the
430
+ # documentation. If set to YES the scope will be hidden.
431
+
432
+ HIDE_SCOPE_NAMES = NO
433
+
434
+ # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
435
+ # will put a list of the files that are included by a file in the documentation
436
+ # of that file.
437
+
438
+ SHOW_INCLUDE_FILES = YES
439
+
440
+ # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
441
+ # will list include files with double quotes in the documentation
442
+ # rather than with sharp brackets.
443
+
444
+ FORCE_LOCAL_INCLUDES = NO
445
+
446
+ # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
447
+ # is inserted in the documentation for inline members.
448
+
449
+ INLINE_INFO = YES
450
+
451
+ # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
452
+ # will sort the (detailed) documentation of file and class members
453
+ # alphabetically by member name. If set to NO the members will appear in
454
+ # declaration order.
455
+
456
+ SORT_MEMBER_DOCS = YES
457
+
458
+ # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
459
+ # brief documentation of file, namespace and class members alphabetically
460
+ # by member name. If set to NO (the default) the members will appear in
461
+ # declaration order.
462
+
463
+ SORT_BRIEF_DOCS = NO
464
+
465
+ # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
466
+ # will sort the (brief and detailed) documentation of class members so that
467
+ # constructors and destructors are listed first. If set to NO (the default)
468
+ # the constructors will appear in the respective orders defined by
469
+ # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
470
+ # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
471
+ # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
472
+
473
+ SORT_MEMBERS_CTORS_1ST = NO
474
+
475
+ # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
476
+ # hierarchy of group names into alphabetical order. If set to NO (the default)
477
+ # the group names will appear in their defined order.
478
+
479
+ SORT_GROUP_NAMES = NO
480
+
481
+ # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
482
+ # sorted by fully-qualified names, including namespaces. If set to
483
+ # NO (the default), the class list will be sorted only by class name,
484
+ # not including the namespace part.
485
+ # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
486
+ # Note: This option applies only to the class list, not to the
487
+ # alphabetical list.
488
+
489
+ SORT_BY_SCOPE_NAME = NO
490
+
491
+ # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
492
+ # do proper type resolution of all parameters of a function it will reject a
493
+ # match between the prototype and the implementation of a member function even
494
+ # if there is only one candidate or it is obvious which candidate to choose
495
+ # by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
496
+ # will still accept a match between prototype and implementation in such cases.
497
+
498
+ STRICT_PROTO_MATCHING = NO
499
+
500
+ # The GENERATE_TODOLIST tag can be used to enable (YES) or
501
+ # disable (NO) the todo list. This list is created by putting \todo
502
+ # commands in the documentation.
503
+
504
+ GENERATE_TODOLIST = YES
505
+
506
+ # The GENERATE_TESTLIST tag can be used to enable (YES) or
507
+ # disable (NO) the test list. This list is created by putting \test
508
+ # commands in the documentation.
509
+
510
+ GENERATE_TESTLIST = YES
511
+
512
+ # The GENERATE_BUGLIST tag can be used to enable (YES) or
513
+ # disable (NO) the bug list. This list is created by putting \bug
514
+ # commands in the documentation.
515
+
516
+ GENERATE_BUGLIST = YES
517
+
518
+ # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
519
+ # disable (NO) the deprecated list. This list is created by putting
520
+ # \deprecated commands in the documentation.
521
+
522
+ GENERATE_DEPRECATEDLIST = YES
523
+
524
+ # The ENABLED_SECTIONS tag can be used to enable conditional
525
+ # documentation sections, marked by \if sectionname ... \endif.
526
+
527
+ ENABLED_SECTIONS =
528
+
529
+ # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
530
+ # the initial value of a variable or macro consists of for it to appear in
531
+ # the documentation. If the initializer consists of more lines than specified
532
+ # here it will be hidden. Use a value of 0 to hide initializers completely.
533
+ # The appearance of the initializer of individual variables and macros in the
534
+ # documentation can be controlled using \showinitializer or \hideinitializer
535
+ # command in the documentation regardless of this setting.
536
+
537
+ MAX_INITIALIZER_LINES = 30
538
+
539
+ # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
540
+ # at the bottom of the documentation of classes and structs. If set to YES the
541
+ # list will mention the files that were used to generate the documentation.
542
+
543
+ SHOW_USED_FILES = YES
544
+
545
+ # If the sources in your project are distributed over multiple directories
546
+ # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
547
+ # in the documentation. The default is NO.
548
+
549
+ SHOW_DIRECTORIES = YES
550
+
551
+ # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
552
+ # This will remove the Files entry from the Quick Index and from the
553
+ # Folder Tree View (if specified). The default is YES.
554
+
555
+ SHOW_FILES = YES
556
+
557
+ # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
558
+ # Namespaces page.
559
+ # This will remove the Namespaces entry from the Quick Index
560
+ # and from the Folder Tree View (if specified). The default is YES.
561
+
562
+ SHOW_NAMESPACES = YES
563
+
564
+ # The FILE_VERSION_FILTER tag can be used to specify a program or script that
565
+ # doxygen should invoke to get the current version for each file (typically from
566
+ # the version control system). Doxygen will invoke the program by executing (via
567
+ # popen()) the command <command> <input-file>, where <command> is the value of
568
+ # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
569
+ # provided by doxygen. Whatever the program writes to standard output
570
+ # is used as the file version. See the manual for examples.
571
+
572
+ FILE_VERSION_FILTER =
573
+
574
+ # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
575
+ # by doxygen. The layout file controls the global structure of the generated
576
+ # output files in an output format independent way. The create the layout file
577
+ # that represents doxygen's defaults, run doxygen with the -l option.
578
+ # You can optionally specify a file name after the option, if omitted
579
+ # DoxygenLayout.xml will be used as the name of the layout file.
580
+
581
+ LAYOUT_FILE =
582
+
583
+ # The CITE_BIB_FILES tag can be used to specify one or more bib files
584
+ # containing the references data. This must be a list of .bib files. The
585
+ # .bib extension is automatically appended if omitted. Using this command
586
+ # requires the bibtex tool to be installed. See also
587
+ # http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style
588
+ # of the bibliography can be controlled using LATEX_BIB_STYLE. To use this
589
+ # feature you need bibtex and perl available in the search path.
590
+
591
+ CITE_BIB_FILES =
592
+
593
+ # ---------------------------------------------------------------------------
594
+ # configuration options related to warning and progress messages
595
+ # ---------------------------------------------------------------------------
596
+
597
+ # The QUIET tag can be used to turn on/off the messages that are generated
598
+ # by doxygen. Possible values are YES and NO. If left blank NO is used.
599
+
600
+ QUIET = NO
601
+
602
+ # The WARNINGS tag can be used to turn on/off the warning messages that are
603
+ # generated by doxygen. Possible values are YES and NO. If left blank
604
+ # NO is used.
605
+
606
+ WARNINGS = YES
607
+
608
+ # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
609
+ # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
610
+ # automatically be disabled.
611
+
612
+ WARN_IF_UNDOCUMENTED = YES
613
+
614
+ # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
615
+ # potential errors in the documentation, such as not documenting some
616
+ # parameters in a documented function, or documenting parameters that
617
+ # don't exist or using markup commands wrongly.
618
+
619
+ WARN_IF_DOC_ERROR = YES
620
+
621
+ # The WARN_NO_PARAMDOC option can be enabled to get warnings for
622
+ # functions that are documented, but have no documentation for their parameters
623
+ # or return value. If set to NO (the default) doxygen will only warn about
624
+ # wrong or incomplete parameter documentation, but not about the absence of
625
+ # documentation.
626
+
627
+ WARN_NO_PARAMDOC = NO
628
+
629
+ # The WARN_FORMAT tag determines the format of the warning messages that
630
+ # doxygen can produce. The string should contain the $file, $line, and $text
631
+ # tags, which will be replaced by the file and line number from which the
632
+ # warning originated and the warning text. Optionally the format may contain
633
+ # $version, which will be replaced by the version of the file (if it could
634
+ # be obtained via FILE_VERSION_FILTER)
635
+
636
+ WARN_FORMAT = "$file:$line: $text"
637
+
638
+ # The WARN_LOGFILE tag can be used to specify a file to which warning
639
+ # and error messages should be written. If left blank the output is written
640
+ # to stderr.
641
+
642
+ WARN_LOGFILE =
643
+
644
+ # ---------------------------------------------------------------------------
645
+ # configuration options related to the input files
646
+ # ---------------------------------------------------------------------------
647
+
648
+ # The INPUT tag can be used to specify the files and/or directories that contain
649
+ # documented source files. You may enter file names like "myfile.cpp" or
650
+ # directories like "/usr/src/myproject". Separate the files or directories
651
+ # with spaces.
652
+
653
+ INPUT =
654
+
655
+ # This tag can be used to specify the character encoding of the source files
656
+ # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
657
+ # also the default input encoding. Doxygen uses libiconv (or the iconv built
658
+ # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
659
+ # the list of possible encodings.
660
+
661
+ INPUT_ENCODING = UTF - 8
662
+
663
+ # If the value of the INPUT tag contains directories, you can use the
664
+ # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
665
+ # and *.h) to filter out the source-files in the directories. If left
666
+ # blank the following patterns are tested:
667
+ # *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
668
+ # *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
669
+ # *.f90 *.f *.for *.vhd *.vhdl
670
+
671
+ FILE_PATTERNS =
672
+
673
+ # The RECURSIVE tag can be used to turn specify whether or not subdirectories
674
+ # should be searched for input files as well. Possible values are YES and NO.
675
+ # If left blank NO is used.
676
+
677
+ RECURSIVE = YES
678
+
679
+ # The EXCLUDE tag can be used to specify files and/or directories that should be
680
+ # excluded from the INPUT source files. This way you can easily exclude a
681
+ # subdirectory from a directory tree whose root is specified with the INPUT tag.
682
+ # Note that relative paths are relative to the directory from which doxygen is
683
+ # run.
684
+
685
+ EXCLUDE =
686
+
687
+ # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
688
+ # directories that are symbolic links (a Unix file system feature) are excluded
689
+ # from the input.
690
+
691
+ EXCLUDE_SYMLINKS = NO
692
+
693
+ # If the value of the INPUT tag contains directories, you can use the
694
+ # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
695
+ # certain files from those directories. Note that the wildcards are matched
696
+ # against the file with absolute path, so to exclude all test directories
697
+ # for example use the pattern */test/*
698
+
699
+ EXCLUDE_PATTERNS =
700
+
701
+ # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
702
+ # (namespaces, classes, functions, etc.) that should be excluded from the
703
+ # output. The symbol name can be a fully qualified name, a word, or if the
704
+ # wildcard * is used, a substring. Examples: ANamespace, AClass,
705
+ # AClass::ANamespace, ANamespace::*Test
706
+
707
+ EXCLUDE_SYMBOLS =
708
+
709
+ # The EXAMPLE_PATH tag can be used to specify one or more files or
710
+ # directories that contain example code fragments that are included (see
711
+ # the \include command).
712
+
713
+ EXAMPLE_PATH =
714
+
715
+ # If the value of the EXAMPLE_PATH tag contains directories, you can use the
716
+ # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
717
+ # and *.h) to filter out the source-files in the directories. If left
718
+ # blank all files are included.
719
+
720
+ EXAMPLE_PATTERNS =
721
+
722
+ # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
723
+ # searched for input files to be used with the \include or \dontinclude
724
+ # commands irrespective of the value of the RECURSIVE tag.
725
+ # Possible values are YES and NO. If left blank NO is used.
726
+
727
+ EXAMPLE_RECURSIVE = NO
728
+
729
+ # The IMAGE_PATH tag can be used to specify one or more files or
730
+ # directories that contain image that are included in the documentation (see
731
+ # the \image command).
732
+
733
+ IMAGE_PATH =
734
+
735
+ # The INPUT_FILTER tag can be used to specify a program that doxygen should
736
+ # invoke to filter for each input file. Doxygen will invoke the filter program
737
+ # by executing (via popen()) the command <filter> <input-file>, where <filter>
738
+ # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
739
+ # input file. Doxygen will then use the output that the filter program writes
740
+ # to standard output.
741
+ # If FILTER_PATTERNS is specified, this tag will be
742
+ # ignored.
743
+
744
+ INPUT_FILTER =
745
+
746
+ # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
747
+ # basis.
748
+ # Doxygen will compare the file name with each pattern and apply the
749
+ # filter if there is a match.
750
+ # The filters are a list of the form:
751
+ # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
752
+ # info on how filters are used. If FILTER_PATTERNS is empty or if
753
+ # non of the patterns match the file name, INPUT_FILTER is applied.
754
+
755
+ FILTER_PATTERNS = *.py = doxypy
756
+
757
+ # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
758
+ # INPUT_FILTER) will be used to filter the input files when producing source
759
+ # files to browse (i.e. when SOURCE_BROWSER is set to YES).
760
+
761
+ FILTER_SOURCE_FILES = NO
762
+
763
+ # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
764
+ # pattern. A pattern will override the setting for FILTER_PATTERN (if any)
765
+ # and it is also possible to disable source filtering for a specific pattern
766
+ # using *.ext= (so without naming a filter). This option only has effect when
767
+ # FILTER_SOURCE_FILES is enabled.
768
+
769
+ FILTER_SOURCE_PATTERNS =
770
+
771
+ # ---------------------------------------------------------------------------
772
+ # configuration options related to source browsing
773
+ # ---------------------------------------------------------------------------
774
+
775
+ # If the SOURCE_BROWSER tag is set to YES then a list of source files will
776
+ # be generated. Documented entities will be cross-referenced with these sources.
777
+ # Note: To get rid of all source code in the generated output, make sure also
778
+ # VERBATIM_HEADERS is set to NO.
779
+
780
+ SOURCE_BROWSER = YES
781
+
782
+ # Setting the INLINE_SOURCES tag to YES will include the body
783
+ # of functions and classes directly in the documentation.
784
+
785
+ INLINE_SOURCES = NO
786
+
787
+ # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
788
+ # doxygen to hide any special comment blocks from generated source code
789
+ # fragments. Normal C and C++ comments will always remain visible.
790
+
791
+ STRIP_CODE_COMMENTS = NO
792
+
793
+ # If the REFERENCED_BY_RELATION tag is set to YES
794
+ # then for each documented function all documented
795
+ # functions referencing it will be listed.
796
+
797
+ REFERENCED_BY_RELATION = NO
798
+
799
+ # If the REFERENCES_RELATION tag is set to YES
800
+ # then for each documented function all documented entities
801
+ # called/used by that function will be listed.
802
+
803
+ REFERENCES_RELATION = NO
804
+
805
+ # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
806
+ # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
807
+ # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
808
+ # link to the source code.
809
+ # Otherwise they will link to the documentation.
810
+
811
+ REFERENCES_LINK_SOURCE = YES
812
+
813
+ # If the USE_HTAGS tag is set to YES then the references to source code
814
+ # will point to the HTML generated by the htags(1) tool instead of doxygen
815
+ # built-in source browser. The htags tool is part of GNU's global source
816
+ # tagging system (see http://www.gnu.org/software/global/global.html). You
817
+ # will need version 4.8.6 or higher.
818
+
819
+ USE_HTAGS = NO
820
+
821
+ # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
822
+ # will generate a verbatim copy of the header file for each class for
823
+ # which an include is specified. Set to NO to disable this.
824
+
825
+ VERBATIM_HEADERS = YES
826
+
827
+ # ---------------------------------------------------------------------------
828
+ # configuration options related to the alphabetical class index
829
+ # ---------------------------------------------------------------------------
830
+
831
+ # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
832
+ # of all compounds will be generated. Enable this if the project
833
+ # contains a lot of classes, structs, unions or interfaces.
834
+
835
+ ALPHABETICAL_INDEX = YES
836
+
837
+ # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
838
+ # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
839
+ # in which this list will be split (can be a number in the range [1..20])
840
+
841
+ COLS_IN_ALPHA_INDEX = 5
842
+
843
+ # In case all classes in a project start with a common prefix, all
844
+ # classes will be put under the same header in the alphabetical index.
845
+ # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
846
+ # should be ignored while generating the index headers.
847
+
848
+ IGNORE_PREFIX =
849
+
850
+ # ---------------------------------------------------------------------------
851
+ # configuration options related to the HTML output
852
+ # ---------------------------------------------------------------------------
853
+
854
+ # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
855
+ # generate HTML output.
856
+
857
+ GENERATE_HTML = YES
858
+
859
+ # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
860
+ # If a relative path is entered the value of OUTPUT_DIRECTORY will be
861
+ # put in front of it. If left blank `html' will be used as the default path.
862
+
863
+ HTML_OUTPUT = html
864
+
865
+ # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
866
+ # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
867
+ # doxygen will generate files with .html extension.
868
+
869
+ HTML_FILE_EXTENSION = .html
870
+
871
+ # The HTML_HEADER tag can be used to specify a personal HTML header for
872
+ # each generated HTML page. If it is left blank doxygen will generate a
873
+ # standard header. Note that when using a custom header you are responsible
874
+ # for the proper inclusion of any scripts and style sheets that doxygen
875
+ # needs, which is dependent on the configuration options used.
876
+ # It is advised to generate a default header using "doxygen -w html
877
+ # header.html footer.html stylesheet.css YourConfigFile" and then modify
878
+ # that header. Note that the header is subject to change so you typically
879
+ # have to redo this when upgrading to a newer version of doxygen or when
880
+ # changing the value of configuration settings such as GENERATE_TREEVIEW!
881
+
882
+ HTML_HEADER =
883
+
884
+ # The HTML_FOOTER tag can be used to specify a personal HTML footer for
885
+ # each generated HTML page. If it is left blank doxygen will generate a
886
+ # standard footer.
887
+
888
+ HTML_FOOTER =
889
+
890
+ # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
891
+ # style sheet that is used by each HTML page. It can be used to
892
+ # fine-tune the look of the HTML output. If the tag is left blank doxygen
893
+ # will generate a default style sheet. Note that doxygen will try to copy
894
+ # the style sheet file to the HTML output directory, so don't put your own
895
+ # style sheet in the HTML output directory as well, or it will be erased!
896
+
897
+ HTML_STYLESHEET =
898
+
899
+ # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
900
+ # other source files which should be copied to the HTML output directory. Note
901
+ # that these files will be copied to the base HTML output directory. Use the
902
+ # $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
903
+ # files. In the HTML_STYLESHEET file, use the file name only. Also note that
904
+ # the files will be copied as-is; there are no commands or markers available.
905
+
906
+ HTML_EXTRA_FILES =
907
+
908
+ # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
909
+ # Doxygen will adjust the colors in the style sheet and background images
910
+ # according to this color. Hue is specified as an angle on a colorwheel,
911
+ # see http://en.wikipedia.org/wiki/Hue for more information.
912
+ # For instance the value 0 represents red, 60 is yellow, 120 is green,
913
+ # 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
914
+ # The allowed range is 0 to 359.
915
+
916
+ HTML_COLORSTYLE_HUE = 220
917
+
918
+ # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
919
+ # the colors in the HTML output. For a value of 0 the output will use
920
+ # grayscales only. A value of 255 will produce the most vivid colors.
921
+
922
+ HTML_COLORSTYLE_SAT = 100
923
+
924
+ # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
925
+ # the luminance component of the colors in the HTML output. Values below
926
+ # 100 gradually make the output lighter, whereas values above 100 make
927
+ # the output darker. The value divided by 100 is the actual gamma applied,
928
+ # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
929
+ # and 100 does not change the gamma.
930
+
931
+ HTML_COLORSTYLE_GAMMA = 80
932
+
933
+ # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
934
+ # page will contain the date and time when the page was generated. Setting
935
+ # this to NO can help when comparing the output of multiple runs.
936
+
937
+ HTML_TIMESTAMP = YES
938
+
939
+ # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
940
+ # files or namespaces will be aligned in HTML using tables. If set to
941
+ # NO a bullet list will be used.
942
+
943
+ HTML_ALIGN_MEMBERS = YES
944
+
945
+ # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
946
+ # documentation will contain sections that can be hidden and shown after the
947
+ # page has loaded. For this to work a browser that supports
948
+ # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
949
+ # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
950
+
951
+ HTML_DYNAMIC_SECTIONS = NO
952
+
953
+ # If the GENERATE_DOCSET tag is set to YES, additional index files
954
+ # will be generated that can be used as input for Apple's Xcode 3
955
+ # integrated development environment, introduced with OSX 10.5 (Leopard).
956
+ # To create a documentation set, doxygen will generate a Makefile in the
957
+ # HTML output directory. Running make will produce the docset in that
958
+ # directory and running "make install" will install the docset in
959
+ # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
960
+ # it at startup.
961
+ # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
962
+ # for more information.
963
+
964
+ GENERATE_DOCSET = NO
965
+
966
+ # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
967
+ # feed. A documentation feed provides an umbrella under which multiple
968
+ # documentation sets from a single provider (such as a company or product suite)
969
+ # can be grouped.
970
+
971
+ DOCSET_FEEDNAME = "Doxygen generated docs"
972
+
973
+ # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
974
+ # should uniquely identify the documentation set bundle. This should be a
975
+ # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
976
+ # will append .docset to the name.
977
+
978
+ DOCSET_BUNDLE_ID = org.doxygen.Project
979
+
980
+ # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
981
+ # the documentation publisher. This should be a reverse domain-name style
982
+ # string, e.g. com.mycompany.MyDocSet.documentation.
983
+
984
+ DOCSET_PUBLISHER_ID = org.doxygen.Publisher
985
+
986
+ # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
987
+
988
+ DOCSET_PUBLISHER_NAME = Publisher
989
+
990
+ # If the GENERATE_HTMLHELP tag is set to YES, additional index files
991
+ # will be generated that can be used as input for tools like the
992
+ # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
993
+ # of the generated HTML documentation.
994
+
995
+ GENERATE_HTMLHELP = NO
996
+
997
+ # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
998
+ # be used to specify the file name of the resulting .chm file. You
999
+ # can add a path in front of the file if the result should not be
1000
+ # written to the html output directory.
1001
+
1002
+ CHM_FILE =
1003
+
1004
+ # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
1005
+ # be used to specify the location (absolute path including file name) of
1006
+ # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
1007
+ # the HTML help compiler on the generated index.hhp.
1008
+
1009
+ HHC_LOCATION =
1010
+
1011
+ # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
1012
+ # controls if a separate .chi index file is generated (YES) or that
1013
+ # it should be included in the master .chm file (NO).
1014
+
1015
+ GENERATE_CHI = NO
1016
+
1017
+ # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
1018
+ # is used to encode HtmlHelp index (hhk), content (hhc) and project file
1019
+ # content.
1020
+
1021
+ CHM_INDEX_ENCODING =
1022
+
1023
+ # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
1024
+ # controls whether a binary table of contents is generated (YES) or a
1025
+ # normal table of contents (NO) in the .chm file.
1026
+
1027
+ BINARY_TOC = NO
1028
+
1029
+ # The TOC_EXPAND flag can be set to YES to add extra items for group members
1030
+ # to the contents of the HTML help documentation and to the tree view.
1031
+
1032
+ TOC_EXPAND = NO
1033
+
1034
+ # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1035
+ # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
1036
+ # that can be used as input for Qt's qhelpgenerator to generate a
1037
+ # Qt Compressed Help (.qch) of the generated HTML documentation.
1038
+
1039
+ GENERATE_QHP = NO
1040
+
1041
+ # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
1042
+ # be used to specify the file name of the resulting .qch file.
1043
+ # The path specified is relative to the HTML output folder.
1044
+
1045
+ QCH_FILE =
1046
+
1047
+ # The QHP_NAMESPACE tag specifies the namespace to use when generating
1048
+ # Qt Help Project output. For more information please see
1049
+ # http://doc.trolltech.com/qthelpproject.html#namespace
1050
+
1051
+ QHP_NAMESPACE = org.doxygen.Project
1052
+
1053
+ # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
1054
+ # Qt Help Project output. For more information please see
1055
+ # http://doc.trolltech.com/qthelpproject.html#virtual-folders
1056
+
1057
+ QHP_VIRTUAL_FOLDER = doc
1058
+
1059
+ # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
1060
+ # add. For more information please see
1061
+ # http://doc.trolltech.com/qthelpproject.html#custom-filters
1062
+
1063
+ QHP_CUST_FILTER_NAME =
1064
+
1065
+ # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
1066
+ # custom filter to add. For more information please see
1067
+ # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
1068
+ # Qt Help Project / Custom Filters</a>.
1069
+
1070
+ QHP_CUST_FILTER_ATTRS =
1071
+
1072
+ # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1073
+ # project's
1074
+ # filter section matches.
1075
+ # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
1076
+ # Qt Help Project / Filter Attributes</a>.
1077
+
1078
+ QHP_SECT_FILTER_ATTRS =
1079
+
1080
+ # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
1081
+ # be used to specify the location of Qt's qhelpgenerator.
1082
+ # If non-empty doxygen will try to run qhelpgenerator on the generated
1083
+ # .qhp file.
1084
+
1085
+ QHG_LOCATION =
1086
+
1087
+ # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
1088
+ # will be generated, which together with the HTML files, form an Eclipse help
1089
+ # plugin. To install this plugin and make it available under the help contents
1090
+ # menu in Eclipse, the contents of the directory containing the HTML and XML
1091
+ # files needs to be copied into the plugins directory of eclipse. The name of
1092
+ # the directory within the plugins directory should be the same as
1093
+ # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
1094
+ # the help appears.
1095
+
1096
+ GENERATE_ECLIPSEHELP = NO
1097
+
1098
+ # A unique identifier for the eclipse help plugin. When installing the plugin
1099
+ # the directory name containing the HTML and XML files should also have
1100
+ # this name.
1101
+
1102
+ ECLIPSE_DOC_ID = org.doxygen.Project
1103
+
1104
+ # The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)
1105
+ # at top of each HTML page. The value NO (the default) enables the index and
1106
+ # the value YES disables it. Since the tabs have the same information as the
1107
+ # navigation tree you can set this option to NO if you already set
1108
+ # GENERATE_TREEVIEW to YES.
1109
+
1110
+ DISABLE_INDEX = NO
1111
+
1112
+ # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1113
+ # structure should be generated to display hierarchical information.
1114
+ # If the tag value is set to YES, a side panel will be generated
1115
+ # containing a tree-like index structure (just like the one that
1116
+ # is generated for HTML Help). For this to work a browser that supports
1117
+ # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
1118
+ # Windows users are probably better off using the HTML help feature.
1119
+ # Since the tree basically has the same information as the tab index you
1120
+ # could consider to set DISABLE_INDEX to NO when enabling this option.
1121
+
1122
+ GENERATE_TREEVIEW = NO
1123
+
1124
+ # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
1125
+ # (range [0,1..20]) that doxygen will group on one line in the generated HTML
1126
+ # documentation. Note that a value of 0 will completely suppress the enum
1127
+ # values from appearing in the overview section.
1128
+
1129
+ ENUM_VALUES_PER_LINE = 4
1130
+
1131
+ # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
1132
+ # and Class Hierarchy pages using a tree view instead of an ordered list.
1133
+
1134
+ USE_INLINE_TREES = NO
1135
+
1136
+ # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1137
+ # used to set the initial width (in pixels) of the frame in which the tree
1138
+ # is shown.
1139
+
1140
+ TREEVIEW_WIDTH = 250
1141
+
1142
+ # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1143
+ # links to external symbols imported via tag files in a separate window.
1144
+
1145
+ EXT_LINKS_IN_WINDOW = NO
1146
+
1147
+ # Use this tag to change the font size of Latex formulas included
1148
+ # as images in the HTML documentation. The default is 10. Note that
1149
+ # when you change the font size after a successful doxygen run you need
1150
+ # to manually remove any form_*.png images from the HTML output directory
1151
+ # to force them to be regenerated.
1152
+
1153
+ FORMULA_FONTSIZE = 10
1154
+
1155
+ # Use the FORMULA_TRANPARENT tag to determine whether or not the images
1156
+ # generated for formulas are transparent PNGs. Transparent PNGs are
1157
+ # not supported properly for IE 6.0, but are supported on all modern browsers.
1158
+ # Note that when changing this option you need to delete any form_*.png files
1159
+ # in the HTML output before the changes have effect.
1160
+
1161
+ FORMULA_TRANSPARENT = YES
1162
+
1163
+ # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
1164
+ # (see http://www.mathjax.org) which uses client side Javascript for the
1165
+ # rendering instead of using prerendered bitmaps. Use this if you do not
1166
+ # have LaTeX installed or if you want to formulas look prettier in the HTML
1167
+ # output. When enabled you also need to install MathJax separately and
1168
+ # configure the path to it using the MATHJAX_RELPATH option.
1169
+
1170
+ USE_MATHJAX = NO
1171
+
1172
+ # When MathJax is enabled you need to specify the location relative to the
1173
+ # HTML output directory using the MATHJAX_RELPATH option. The destination
1174
+ # directory should contain the MathJax.js script. For instance, if the mathjax
1175
+ # directory is located at the same level as the HTML output directory, then
1176
+ # MATHJAX_RELPATH should be ../mathjax. The default value points to the
1177
+ # mathjax.org site, so you can quickly see the result without installing
1178
+ # MathJax, but it is strongly recommended to install a local copy of MathJax
1179
+ # before deployment.
1180
+
1181
+ MATHJAX_RELPATH = http: // www.mathjax.org / mathjax
1182
+
1183
+ # The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
1184
+ # names that should be enabled during MathJax rendering.
1185
+
1186
+ MATHJAX_EXTENSIONS =
1187
+
1188
+ # When the SEARCHENGINE tag is enabled doxygen will generate a search box
1189
+ # for the HTML output. The underlying search engine uses javascript
1190
+ # and DHTML and should work on any modern browser. Note that when using
1191
+ # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
1192
+ # (GENERATE_DOCSET) there is already a search function so this one should
1193
+ # typically be disabled. For large projects the javascript based search engine
1194
+ # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1195
+
1196
+ SEARCHENGINE = YES
1197
+
1198
+ # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1199
+ # implemented using a PHP enabled web server instead of at the web client
1200
+ # using Javascript. Doxygen will generate the search PHP script and index
1201
+ # file to put on the web server. The advantage of the server
1202
+ # based approach is that it scales better to large projects and allows
1203
+ # full text search. The disadvantages are that it is more difficult to setup
1204
+ # and does not have live searching capabilities.
1205
+
1206
+ SERVER_BASED_SEARCH = NO
1207
+
1208
+ # ---------------------------------------------------------------------------
1209
+ # configuration options related to the LaTeX output
1210
+ # ---------------------------------------------------------------------------
1211
+
1212
+ # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1213
+ # generate Latex output.
1214
+
1215
+ GENERATE_LATEX = YES
1216
+
1217
+ # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1218
+ # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1219
+ # put in front of it. If left blank `latex' will be used as the default path.
1220
+
1221
+ LATEX_OUTPUT = latex
1222
+
1223
+ # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1224
+ # invoked. If left blank `latex' will be used as the default command name.
1225
+ # Note that when enabling USE_PDFLATEX this option is only used for
1226
+ # generating bitmaps for formulas in the HTML output, but not in the
1227
+ # Makefile that is written to the output directory.
1228
+
1229
+ LATEX_CMD_NAME = latex
1230
+
1231
+ # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1232
+ # generate index for LaTeX. If left blank `makeindex' will be used as the
1233
+ # default command name.
1234
+
1235
+ MAKEINDEX_CMD_NAME = makeindex
1236
+
1237
+ # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1238
+ # LaTeX documents. This may be useful for small projects and may help to
1239
+ # save some trees in general.
1240
+
1241
+ COMPACT_LATEX = NO
1242
+
1243
+ # The PAPER_TYPE tag can be used to set the paper type that is used
1244
+ # by the printer. Possible values are: a4, letter, legal and
1245
+ # executive. If left blank a4wide will be used.
1246
+
1247
+ PAPER_TYPE = a4
1248
+
1249
+ # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1250
+ # packages that should be included in the LaTeX output.
1251
+
1252
+ EXTRA_PACKAGES = amsmath
1253
+
1254
+ # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1255
+ # the generated latex document. The header should contain everything until
1256
+ # the first chapter. If it is left blank doxygen will generate a
1257
+ # standard header. Notice: only use this tag if you know what you are doing!
1258
+
1259
+ LATEX_HEADER =
1260
+
1261
+ # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
1262
+ # the generated latex document. The footer should contain everything after
1263
+ # the last chapter. If it is left blank doxygen will generate a
1264
+ # standard footer. Notice: only use this tag if you know what you are doing!
1265
+
1266
+ LATEX_FOOTER =
1267
+
1268
+ # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1269
+ # is prepared for conversion to pdf (using ps2pdf). The pdf file will
1270
+ # contain links (just like the HTML output) instead of page references
1271
+ # This makes the output suitable for online browsing using a pdf viewer.
1272
+
1273
+ PDF_HYPERLINKS = YES
1274
+
1275
+ # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1276
+ # plain latex in the generated Makefile. Set this option to YES to get a
1277
+ # higher quality PDF documentation.
1278
+
1279
+ USE_PDFLATEX = YES
1280
+
1281
+ # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1282
+ # command to the generated LaTeX files. This will instruct LaTeX to keep
1283
+ # running if errors occur, instead of asking the user for help.
1284
+ # This option is also used when generating formulas in HTML.
1285
+
1286
+ LATEX_BATCHMODE = NO
1287
+
1288
+ # If LATEX_HIDE_INDICES is set to YES then doxygen will not
1289
+ # include the index chapters (such as File Index, Compound Index, etc.)
1290
+ # in the output.
1291
+
1292
+ LATEX_HIDE_INDICES = NO
1293
+
1294
+ # If LATEX_SOURCE_CODE is set to YES then doxygen will include
1295
+ # source code with syntax highlighting in the LaTeX output.
1296
+ # Note that which sources are shown also depends on other settings
1297
+ # such as SOURCE_BROWSER.
1298
+
1299
+ LATEX_SOURCE_CODE = NO
1300
+
1301
+ # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1302
+ # bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
1303
+ # http://en.wikipedia.org/wiki/BibTeX for more info.
1304
+
1305
+ LATEX_BIB_STYLE = plain
1306
+
1307
+ # ---------------------------------------------------------------------------
1308
+ # configuration options related to the RTF output
1309
+ # ---------------------------------------------------------------------------
1310
+
1311
+ # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1312
+ # The RTF output is optimized for Word 97 and may not look very pretty with
1313
+ # other RTF readers or editors.
1314
+
1315
+ GENERATE_RTF = NO
1316
+
1317
+ # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1318
+ # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1319
+ # put in front of it. If left blank `rtf' will be used as the default path.
1320
+
1321
+ RTF_OUTPUT = rtf
1322
+
1323
+ # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1324
+ # RTF documents. This may be useful for small projects and may help to
1325
+ # save some trees in general.
1326
+
1327
+ COMPACT_RTF = NO
1328
+
1329
+ # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1330
+ # will contain hyperlink fields. The RTF file will
1331
+ # contain links (just like the HTML output) instead of page references.
1332
+ # This makes the output suitable for online browsing using WORD or other
1333
+ # programs which support those fields.
1334
+ # Note: wordpad (write) and others do not support links.
1335
+
1336
+ RTF_HYPERLINKS = NO
1337
+
1338
+ # Load style sheet definitions from file. Syntax is similar to doxygen's
1339
+ # config file, i.e. a series of assignments. You only have to provide
1340
+ # replacements, missing definitions are set to their default value.
1341
+
1342
+ RTF_STYLESHEET_FILE =
1343
+
1344
+ # Set optional variables used in the generation of an rtf document.
1345
+ # Syntax is similar to doxygen's config file.
1346
+
1347
+ RTF_EXTENSIONS_FILE =
1348
+
1349
+ # ---------------------------------------------------------------------------
1350
+ # configuration options related to the man page output
1351
+ # ---------------------------------------------------------------------------
1352
+
1353
+ # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1354
+ # generate man pages
1355
+
1356
+ GENERATE_MAN = NO
1357
+
1358
+ # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1359
+ # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1360
+ # put in front of it. If left blank `man' will be used as the default path.
1361
+
1362
+ MAN_OUTPUT = man
1363
+
1364
+ # The MAN_EXTENSION tag determines the extension that is added to
1365
+ # the generated man pages (default is the subroutine's section .3)
1366
+
1367
+ MAN_EXTENSION = .3
1368
+
1369
+ # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1370
+ # then it will generate one additional man file for each entity
1371
+ # documented in the real man page(s). These additional files
1372
+ # only source the real man page, but without them the man command
1373
+ # would be unable to find the correct page. The default is NO.
1374
+
1375
+ MAN_LINKS = NO
1376
+
1377
+ # ---------------------------------------------------------------------------
1378
+ # configuration options related to the XML output
1379
+ # ---------------------------------------------------------------------------
1380
+
1381
+ # If the GENERATE_XML tag is set to YES Doxygen will
1382
+ # generate an XML file that captures the structure of
1383
+ # the code including all documentation.
1384
+
1385
+ GENERATE_XML = NO
1386
+
1387
+ # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1388
+ # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1389
+ # put in front of it. If left blank `xml' will be used as the default path.
1390
+
1391
+ XML_OUTPUT = xml
1392
+
1393
+ # The XML_SCHEMA tag can be used to specify an XML schema,
1394
+ # which can be used by a validating XML parser to check the
1395
+ # syntax of the XML files.
1396
+
1397
+ XML_SCHEMA =
1398
+
1399
+ # The XML_DTD tag can be used to specify an XML DTD,
1400
+ # which can be used by a validating XML parser to check the
1401
+ # syntax of the XML files.
1402
+
1403
+ XML_DTD =
1404
+
1405
+ # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1406
+ # dump the program listings (including syntax highlighting
1407
+ # and cross-referencing information) to the XML output. Note that
1408
+ # enabling this will significantly increase the size of the XML output.
1409
+
1410
+ XML_PROGRAMLISTING = YES
1411
+
1412
+ # ---------------------------------------------------------------------------
1413
+ # configuration options for the AutoGen Definitions output
1414
+ # ---------------------------------------------------------------------------
1415
+
1416
+ # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1417
+ # generate an AutoGen Definitions (see autogen.sf.net) file
1418
+ # that captures the structure of the code including all
1419
+ # documentation. Note that this feature is still experimental
1420
+ # and incomplete at the moment.
1421
+
1422
+ GENERATE_AUTOGEN_DEF = NO
1423
+
1424
+ # ---------------------------------------------------------------------------
1425
+ # configuration options related to the Perl module output
1426
+ # ---------------------------------------------------------------------------
1427
+
1428
+ # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1429
+ # generate a Perl module file that captures the structure of
1430
+ # the code including all documentation. Note that this
1431
+ # feature is still experimental and incomplete at the
1432
+ # moment.
1433
+
1434
+ GENERATE_PERLMOD = NO
1435
+
1436
+ # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1437
+ # the necessary Makefile rules, Perl scripts and LaTeX code to be able
1438
+ # to generate PDF and DVI output from the Perl module output.
1439
+
1440
+ PERLMOD_LATEX = NO
1441
+
1442
+ # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1443
+ # nicely formatted so it can be parsed by a human reader.
1444
+ # This is useful
1445
+ # if you want to understand what is going on.
1446
+ # On the other hand, if this
1447
+ # tag is set to NO the size of the Perl module output will be much smaller
1448
+ # and Perl will parse it just the same.
1449
+
1450
+ PERLMOD_PRETTY = YES
1451
+
1452
+ # The names of the make variables in the generated doxyrules.make file
1453
+ # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1454
+ # This is useful so different doxyrules.make files included by the same
1455
+ # Makefile don't overwrite each other's variables.
1456
+
1457
+ PERLMOD_MAKEVAR_PREFIX =
1458
+
1459
+ # ---------------------------------------------------------------------------
1460
+ # Configuration options related to the preprocessor
1461
+ # ---------------------------------------------------------------------------
1462
+
1463
+ # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1464
+ # evaluate all C-preprocessor directives found in the sources and include
1465
+ # files.
1466
+
1467
+ ENABLE_PREPROCESSING = YES
1468
+
1469
+ # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1470
+ # names in the source code. If set to NO (the default) only conditional
1471
+ # compilation will be performed. Macro expansion can be done in a controlled
1472
+ # way by setting EXPAND_ONLY_PREDEF to YES.
1473
+
1474
+ MACRO_EXPANSION = NO
1475
+
1476
+ # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1477
+ # then the macro expansion is limited to the macros specified with the
1478
+ # PREDEFINED and EXPAND_AS_DEFINED tags.
1479
+
1480
+ EXPAND_ONLY_PREDEF = NO
1481
+
1482
+ # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1483
+ # pointed to by INCLUDE_PATH will be searched when a #include is found.
1484
+
1485
+ SEARCH_INCLUDES = YES
1486
+
1487
+ # The INCLUDE_PATH tag can be used to specify one or more directories that
1488
+ # contain include files that are not input files but should be processed by
1489
+ # the preprocessor.
1490
+
1491
+ INCLUDE_PATH =
1492
+
1493
+ # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1494
+ # patterns (like *.h and *.hpp) to filter out the header-files in the
1495
+ # directories. If left blank, the patterns specified with FILE_PATTERNS will
1496
+ # be used.
1497
+
1498
+ INCLUDE_FILE_PATTERNS =
1499
+
1500
+ # The PREDEFINED tag can be used to specify one or more macro names that
1501
+ # are defined before the preprocessor is started (similar to the -D option of
1502
+ # gcc). The argument of the tag is a list of macros of the form: name
1503
+ # or name=definition (no spaces). If the definition and the = are
1504
+ # omitted =1 is assumed. To prevent a macro definition from being
1505
+ # undefined via #undef or recursively expanded use the := operator
1506
+ # instead of the = operator.
1507
+
1508
+ PREDEFINED =
1509
+
1510
+ # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1511
+ # this tag can be used to specify a list of macro names that should be expanded.
1512
+ # The macro definition that is found in the sources will be used.
1513
+ # Use the PREDEFINED tag if you want to use a different macro definition that
1514
+ # overrules the definition found in the source code.
1515
+
1516
+ EXPAND_AS_DEFINED =
1517
+
1518
+ # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1519
+ # doxygen's preprocessor will remove all references to function-like macros
1520
+ # that are alone on a line, have an all uppercase name, and do not end with a
1521
+ # semicolon, because these will confuse the parser if not removed.
1522
+
1523
+ SKIP_FUNCTION_MACROS = YES
1524
+
1525
+ # ---------------------------------------------------------------------------
1526
+ # Configuration::additions related to external references
1527
+ # ---------------------------------------------------------------------------
1528
+
1529
+ # The TAGFILES option can be used to specify one or more tagfiles.
1530
+ # Optionally an initial location of the external documentation
1531
+ # can be added for each tagfile. The format of a tag file without
1532
+ # this location is as follows:
1533
+ #
1534
+ # TAGFILES = file1 file2 ...
1535
+ # Adding location for the tag files is done as follows:
1536
+ #
1537
+ # TAGFILES = file1=loc1 "file2 = loc2" ...
1538
+ # where "loc1" and "loc2" can be relative or absolute paths or
1539
+ # URLs. If a location is present for each tag, the installdox tool
1540
+ # does not have to be run to correct the links.
1541
+ # Note that each tag file must have a unique name
1542
+ # (where the name does NOT include the path)
1543
+ # If a tag file is not located in the directory in which doxygen
1544
+ # is run, you must also specify the path to the tagfile here.
1545
+
1546
+ TAGFILES =
1547
+
1548
+ # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1549
+ # a tag file that is based on the input files it reads.
1550
+
1551
+ GENERATE_TAGFILE =
1552
+
1553
+ # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1554
+ # in the class index. If set to NO only the inherited external classes
1555
+ # will be listed.
1556
+
1557
+ ALLEXTERNALS = NO
1558
+
1559
+ # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1560
+ # in the modules index. If set to NO, only the current project's groups will
1561
+ # be listed.
1562
+
1563
+ EXTERNAL_GROUPS = YES
1564
+
1565
+ # The PERL_PATH should be the absolute path and name of the perl script
1566
+ # interpreter (i.e. the result of `which perl').
1567
+
1568
+ PERL_PATH = /usr / bin / perl
1569
+
1570
+ # ---------------------------------------------------------------------------
1571
+ # Configuration options related to the dot tool
1572
+ # ---------------------------------------------------------------------------
1573
+
1574
+ # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1575
+ # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1576
+ # or super classes. Setting the tag to NO turns the diagrams off. Note that
1577
+ # this option also works with HAVE_DOT disabled, but it is recommended to
1578
+ # install and use dot, since it yields more powerful graphs.
1579
+
1580
+ CLASS_DIAGRAMS = YES
1581
+
1582
+ # You can define message sequence charts within doxygen comments using the \msc
1583
+ # command. Doxygen will then run the mscgen tool (see
1584
+ # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1585
+ # documentation. The MSCGEN_PATH tag allows you to specify the directory where
1586
+ # the mscgen tool resides. If left empty the tool is assumed to be found in the
1587
+ # default search path.
1588
+
1589
+ MSCGEN_PATH =
1590
+
1591
+ # If set to YES, the inheritance and collaboration graphs will hide
1592
+ # inheritance and usage relations if the target is undocumented
1593
+ # or is not a class.
1594
+
1595
+ HIDE_UNDOC_RELATIONS = NO
1596
+
1597
+ # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1598
+ # available from the path. This tool is part of Graphviz, a graph visualization
1599
+ # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1600
+ # have no effect if this option is set to NO (the default)
1601
+
1602
+ HAVE_DOT = YES
1603
+
1604
+ # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
1605
+ # allowed to run in parallel. When set to 0 (the default) doxygen will
1606
+ # base this on the number of processors available in the system. You can set it
1607
+ # explicitly to a value larger than 0 to get control over the balance
1608
+ # between CPU load and processing speed.
1609
+
1610
+ DOT_NUM_THREADS = 0
1611
+
1612
+ # By default doxygen will use the Helvetica font for all dot files that
1613
+ # doxygen generates. When you want a differently looking font you can specify
1614
+ # the font name using DOT_FONTNAME. You need to make sure dot is able to find
1615
+ # the font, which can be done by putting it in a standard location or by setting
1616
+ # the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
1617
+ # directory containing the font.
1618
+
1619
+ DOT_FONTNAME = Helvetica
1620
+
1621
+ # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1622
+ # The default size is 10pt.
1623
+
1624
+ DOT_FONTSIZE = 10
1625
+
1626
+ # By default doxygen will tell dot to use the Helvetica font.
1627
+ # If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to
1628
+ # set the path where dot can find it.
1629
+
1630
+ DOT_FONTPATH =
1631
+
1632
+ # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1633
+ # will generate a graph for each documented class showing the direct and
1634
+ # indirect inheritance relations. Setting this tag to YES will force the
1635
+ # CLASS_DIAGRAMS tag to NO.
1636
+
1637
+ CLASS_GRAPH = YES
1638
+
1639
+ # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1640
+ # will generate a graph for each documented class showing the direct and
1641
+ # indirect implementation dependencies (inheritance, containment, and
1642
+ # class references variables) of the class with other documented classes.
1643
+
1644
+ COLLABORATION_GRAPH = YES
1645
+
1646
+ # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1647
+ # will generate a graph for groups, showing the direct groups dependencies
1648
+
1649
+ GROUP_GRAPHS = YES
1650
+
1651
+ # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1652
+ # collaboration diagrams in a style similar to the OMG's Unified Modeling
1653
+ # Language.
1654
+
1655
+ UML_LOOK = YES
1656
+
1657
+ # If set to YES, the inheritance and collaboration graphs will show the
1658
+ # relations between templates and their instances.
1659
+
1660
+ TEMPLATE_RELATIONS = NO
1661
+
1662
+ # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1663
+ # tags are set to YES then doxygen will generate a graph for each documented
1664
+ # file showing the direct and indirect include dependencies of the file with
1665
+ # other documented files.
1666
+
1667
+ INCLUDE_GRAPH = YES
1668
+
1669
+ # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1670
+ # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1671
+ # documented header file showing the documented files that directly or
1672
+ # indirectly include this file.
1673
+
1674
+ INCLUDED_BY_GRAPH = YES
1675
+
1676
+ # If the CALL_GRAPH and HAVE_DOT options are set to YES then
1677
+ # doxygen will generate a call dependency graph for every global function
1678
+ # or class method. Note that enabling this option will significantly increase
1679
+ # the time of a run. So in most cases it will be better to enable call graphs
1680
+ # for selected functions only using the \callgraph command.
1681
+
1682
+ CALL_GRAPH = NO
1683
+
1684
+ # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1685
+ # doxygen will generate a caller dependency graph for every global function
1686
+ # or class method. Note that enabling this option will significantly increase
1687
+ # the time of a run. So in most cases it will be better to enable caller
1688
+ # graphs for selected functions only using the \callergraph command.
1689
+
1690
+ CALLER_GRAPH = NO
1691
+
1692
+ # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1693
+ # will generate a graphical hierarchy of all classes instead of a textual one.
1694
+
1695
+ GRAPHICAL_HIERARCHY = YES
1696
+
1697
+ # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1698
+ # then doxygen will show the dependencies a directory has on other directories
1699
+ # in a graphical way. The dependency relations are determined by the #include
1700
+ # relations between the files in the directories.
1701
+
1702
+ DIRECTORY_GRAPH = YES
1703
+
1704
+ # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1705
+ # generated by dot. Possible values are svg, png, jpg, or gif.
1706
+ # If left blank png will be used. If you choose svg you need to set
1707
+ # HTML_FILE_EXTENSION to xhtml in order to make the SVG files
1708
+ # visible in IE 9+ (other browsers do not have this requirement).
1709
+
1710
+ DOT_IMAGE_FORMAT = png
1711
+
1712
+ # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
1713
+ # enable generation of interactive SVG images that allow zooming and panning.
1714
+ # Note that this requires a modern browser other than Internet Explorer.
1715
+ # Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you
1716
+ # need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
1717
+ # visible. Older versions of IE do not have SVG support.
1718
+
1719
+ INTERACTIVE_SVG = NO
1720
+
1721
+ # The tag DOT_PATH can be used to specify the path where the dot tool can be
1722
+ # found. If left blank, it is assumed the dot tool can be found in the path.
1723
+
1724
+ DOT_PATH =
1725
+
1726
+ # The DOTFILE_DIRS tag can be used to specify one or more directories that
1727
+ # contain dot files that are included in the documentation (see the
1728
+ # \dotfile command).
1729
+
1730
+ DOTFILE_DIRS =
1731
+
1732
+ # The MSCFILE_DIRS tag can be used to specify one or more directories that
1733
+ # contain msc files that are included in the documentation (see the
1734
+ # \mscfile command).
1735
+
1736
+ MSCFILE_DIRS =
1737
+
1738
+ # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1739
+ # nodes that will be shown in the graph. If the number of nodes in a graph
1740
+ # becomes larger than this value, doxygen will truncate the graph, which is
1741
+ # visualized by representing a node as a red box. Note that doxygen if the
1742
+ # number of direct children of the root node in a graph is already larger than
1743
+ # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1744
+ # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1745
+
1746
+ DOT_GRAPH_MAX_NODES = 50
1747
+
1748
+ # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1749
+ # graphs generated by dot. A depth value of 3 means that only nodes reachable
1750
+ # from the root by following a path via at most 3 edges will be shown. Nodes
1751
+ # that lay further from the root node will be omitted. Note that setting this
1752
+ # option to 1 or 2 may greatly reduce the computation time needed for large
1753
+ # code bases. Also note that the size of a graph can be further restricted by
1754
+ # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1755
+
1756
+ MAX_DOT_GRAPH_DEPTH = 0
1757
+
1758
+ # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1759
+ # background. This is disabled by default, because dot on Windows does not
1760
+ # seem to support this out of the box. Warning: Depending on the platform used,
1761
+ # enabling this option may lead to badly anti-aliased labels on the edges of
1762
+ # a graph (i.e. they become hard to read).
1763
+
1764
+ DOT_TRANSPARENT = NO
1765
+
1766
+ # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1767
+ # files in one run (i.e. multiple -o and -T options on the command line). This
1768
+ # makes dot run faster, but since only newer versions of dot (>1.8.10)
1769
+ # support this, this feature is disabled by default.
1770
+
1771
+ DOT_MULTI_TARGETS = YES
1772
+
1773
+ # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1774
+ # generate a legend page explaining the meaning of the various boxes and
1775
+ # arrows in the dot generated graphs.
1776
+
1777
+ GENERATE_LEGEND = YES
1778
+
1779
+ # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1780
+ # remove the intermediate dot files that are used to generate
1781
+ # the various graphs.
1782
+
1783
+ DOT_CLEANUP = YES
data/camera_calibration_config.rviz ADDED
@@ -0,0 +1,1621 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ Panels:
2
+ - Class: rviz/Displays
3
+ Help Height: 0
4
+ Name: Displays
5
+ Property Tree Widget:
6
+ Expanded:
7
+ - /Global Options1
8
+ - /TF1/Frames1
9
+ - /btt1/Perception1/perception_markers1/Namespaces1
10
+ - /btt1/New_Perception1/rgb_labels1/Namespaces1
11
+ - /btt1/Navigation1/nav goals1/Namespaces1
12
+ - /btt1/direct_base_ctrl1/base_link_as_pose1
13
+ Splitter Ratio: 0.5240506529808044
14
+ Tree Height: 797
15
+ - Class: rviz/Selection
16
+ Name: Selection
17
+ - Class: rviz/Tool Properties
18
+ Expanded:
19
+ - /2D Pose Estimate1
20
+ - /2D Nav Goal1
21
+ - /Publish Point1
22
+ Name: Tool Properties
23
+ Splitter Ratio: 0.5886790156364441
24
+ - Class: rviz/Views
25
+ Expanded:
26
+ - /Current View1
27
+ Name: Views
28
+ Splitter Ratio: 0.5
29
+ - Class: rviz/Time
30
+ Name: Time
31
+ SyncMode: 0
32
+ SyncSource: raw_color_pcl
33
+ - Class: rviz/Tool Properties
34
+ Expanded: ~
35
+ Name: Tool Properties
36
+ Splitter Ratio: 0.5
37
+ - Class: rviz/Selection
38
+ Name: Selection
39
+ Preferences:
40
+ PromptSaveOnExit: true
41
+ Toolbars:
42
+ toolButtonStyle: 2
43
+ Visualization Manager:
44
+ Class: ""
45
+ Displays:
46
+ - Alpha: 0.4000000059604645
47
+ Cell Size: 1
48
+ Class: rviz/Grid
49
+ Color: 160; 160; 164
50
+ Enabled: true
51
+ Line Style:
52
+ Line Width: 0.029999999329447746
53
+ Value: Lines
54
+ Name: Grid
55
+ Normal Cell Count: 0
56
+ Offset:
57
+ X: 0
58
+ Y: 0
59
+ Z: 0
60
+ Plane: XY
61
+ Plane Cell Count: 10
62
+ Reference Frame: <Fixed Frame>
63
+ Value: true
64
+ - Alpha: 0.5
65
+ Class: rviz/RobotModel
66
+ Collision Enabled: false
67
+ Enabled: true
68
+ Links:
69
+ All Links Enabled: true
70
+ Expand Joint Details: false
71
+ Expand Link Details: false
72
+ Expand Tree: false
73
+ Link Tree Style: Links in Alphabetic Order
74
+ arm_cam3d_camera_color_frame:
75
+ Alpha: 1
76
+ Show Axes: false
77
+ Show Trail: false
78
+ arm_cam3d_camera_color_optical_frame:
79
+ Alpha: 1
80
+ Show Axes: false
81
+ Show Trail: false
82
+ arm_cam3d_camera_depth_frame:
83
+ Alpha: 1
84
+ Show Axes: false
85
+ Show Trail: false
86
+ arm_cam3d_camera_depth_optical_frame:
87
+ Alpha: 1
88
+ Show Axes: false
89
+ Show Trail: false
90
+ arm_cam3d_camera_left_ir_frame:
91
+ Alpha: 1
92
+ Show Axes: false
93
+ Show Trail: false
94
+ arm_cam3d_camera_left_ir_optical_frame:
95
+ Alpha: 1
96
+ Show Axes: false
97
+ Show Trail: false
98
+ arm_cam3d_camera_link:
99
+ Alpha: 1
100
+ Show Axes: false
101
+ Show Trail: false
102
+ Value: true
103
+ arm_cam3d_camera_right_ir_frame:
104
+ Alpha: 1
105
+ Show Axes: false
106
+ Show Trail: false
107
+ arm_cam3d_camera_right_ir_optical_frame:
108
+ Alpha: 1
109
+ Show Axes: false
110
+ Show Trail: false
111
+ arm_link_0:
112
+ Alpha: 1
113
+ Show Axes: false
114
+ Show Trail: false
115
+ Value: true
116
+ arm_link_1:
117
+ Alpha: 1
118
+ Show Axes: false
119
+ Show Trail: false
120
+ Value: true
121
+ arm_link_2:
122
+ Alpha: 1
123
+ Show Axes: false
124
+ Show Trail: false
125
+ Value: true
126
+ arm_link_3:
127
+ Alpha: 1
128
+ Show Axes: false
129
+ Show Trail: false
130
+ Value: true
131
+ arm_link_4:
132
+ Alpha: 1
133
+ Show Axes: false
134
+ Show Trail: false
135
+ Value: true
136
+ arm_link_5:
137
+ Alpha: 1
138
+ Show Axes: false
139
+ Show Trail: false
140
+ Value: true
141
+ base_footprint:
142
+ Alpha: 1
143
+ Show Axes: false
144
+ Show Trail: false
145
+ base_ground_link:
146
+ Alpha: 1
147
+ Show Axes: false
148
+ Show Trail: false
149
+ base_laser_front_link:
150
+ Alpha: 1
151
+ Show Axes: false
152
+ Show Trail: false
153
+ Value: true
154
+ base_laser_rear_link:
155
+ Alpha: 1
156
+ Show Axes: false
157
+ Show Trail: false
158
+ Value: true
159
+ base_link:
160
+ Alpha: 1
161
+ Show Axes: false
162
+ Show Trail: false
163
+ Value: true
164
+ caster_link_bl:
165
+ Alpha: 1
166
+ Show Axes: false
167
+ Show Trail: false
168
+ caster_link_br:
169
+ Alpha: 1
170
+ Show Axes: false
171
+ Show Trail: false
172
+ caster_link_fl:
173
+ Alpha: 1
174
+ Show Axes: false
175
+ Show Trail: false
176
+ caster_link_fr:
177
+ Alpha: 1
178
+ Show Axes: false
179
+ Show Trail: false
180
+ fixed_camera_link:
181
+ Alpha: 1
182
+ Show Axes: false
183
+ Show Trail: false
184
+ Value: true
185
+ full_platform_arm_root_link:
186
+ Alpha: 1
187
+ Show Axes: false
188
+ Show Trail: false
189
+ full_platform_link:
190
+ Alpha: 1
191
+ Show Axes: false
192
+ Show Trail: false
193
+ Value: true
194
+ gripper_bracket_left_link:
195
+ Alpha: 1
196
+ Show Axes: false
197
+ Show Trail: false
198
+ Value: true
199
+ gripper_bracket_right_link:
200
+ Alpha: 1
201
+ Show Axes: false
202
+ Show Trail: false
203
+ Value: true
204
+ gripper_finger_left_link:
205
+ Alpha: 1
206
+ Show Axes: false
207
+ Show Trail: false
208
+ Value: true
209
+ gripper_finger_mount_left_link:
210
+ Alpha: 1
211
+ Show Axes: false
212
+ Show Trail: false
213
+ Value: true
214
+ gripper_finger_mount_right_link:
215
+ Alpha: 1
216
+ Show Axes: false
217
+ Show Trail: false
218
+ Value: true
219
+ gripper_finger_right_link:
220
+ Alpha: 1
221
+ Show Axes: false
222
+ Show Trail: false
223
+ Value: true
224
+ gripper_motor_left_base_link:
225
+ Alpha: 1
226
+ Show Axes: false
227
+ Show Trail: false
228
+ Value: true
229
+ gripper_motor_left_link:
230
+ Alpha: 1
231
+ Show Axes: false
232
+ Show Trail: false
233
+ gripper_motor_mount_link:
234
+ Alpha: 1
235
+ Show Axes: false
236
+ Show Trail: false
237
+ Value: true
238
+ gripper_motor_right_base_link:
239
+ Alpha: 1
240
+ Show Axes: false
241
+ Show Trail: false
242
+ Value: true
243
+ gripper_motor_right_link:
244
+ Alpha: 1
245
+ Show Axes: false
246
+ Show Trail: false
247
+ gripper_static_grasp_link:
248
+ Alpha: 1
249
+ Show Axes: false
250
+ Show Trail: false
251
+ tower_cam3d_camera_color_frame:
252
+ Alpha: 1
253
+ Show Axes: false
254
+ Show Trail: false
255
+ tower_cam3d_camera_color_optical_frame:
256
+ Alpha: 1
257
+ Show Axes: false
258
+ Show Trail: false
259
+ tower_cam3d_camera_depth_frame:
260
+ Alpha: 1
261
+ Show Axes: false
262
+ Show Trail: false
263
+ tower_cam3d_camera_depth_optical_frame:
264
+ Alpha: 1
265
+ Show Axes: false
266
+ Show Trail: false
267
+ tower_cam3d_camera_left_ir_frame:
268
+ Alpha: 1
269
+ Show Axes: false
270
+ Show Trail: false
271
+ tower_cam3d_camera_left_ir_optical_frame:
272
+ Alpha: 1
273
+ Show Axes: false
274
+ Show Trail: false
275
+ tower_cam3d_camera_link:
276
+ Alpha: 1
277
+ Show Axes: false
278
+ Show Trail: false
279
+ Value: true
280
+ tower_cam3d_camera_right_ir_frame:
281
+ Alpha: 1
282
+ Show Axes: false
283
+ Show Trail: false
284
+ tower_cam3d_camera_right_ir_optical_frame:
285
+ Alpha: 1
286
+ Show Axes: false
287
+ Show Trail: false
288
+ wheel_link_bl:
289
+ Alpha: 1
290
+ Show Axes: false
291
+ Show Trail: false
292
+ Value: true
293
+ wheel_link_br:
294
+ Alpha: 1
295
+ Show Axes: false
296
+ Show Trail: false
297
+ Value: true
298
+ wheel_link_fl:
299
+ Alpha: 1
300
+ Show Axes: false
301
+ Show Trail: false
302
+ Value: true
303
+ wheel_link_fr:
304
+ Alpha: 1
305
+ Show Axes: false
306
+ Show Trail: false
307
+ Value: true
308
+ Name: RobotModel
309
+ Robot Description: robot_description
310
+ TF Prefix: ""
311
+ Update Interval: 0
312
+ Value: true
313
+ Visual Enabled: true
314
+ - Class: rviz/TF
315
+ Enabled: false
316
+ Frame Timeout: 15
317
+ Frames:
318
+ All Enabled: false
319
+ Marker Alpha: 1
320
+ Marker Scale: 1
321
+ Name: TF
322
+ Show Arrows: true
323
+ Show Axes: true
324
+ Show Names: true
325
+ Tree:
326
+ {}
327
+ Update Interval: 0
328
+ Value: false
329
+ - Class: rviz/Group
330
+ Displays:
331
+ - Class: rviz/Group
332
+ Displays:
333
+ - Alpha: 1
334
+ Autocompute Intensity Bounds: true
335
+ Autocompute Value Bounds:
336
+ Max Value: 10
337
+ Min Value: -10
338
+ Value: true
339
+ Axis: Z
340
+ Channel Name: intensity
341
+ Class: rviz/PointCloud2
342
+ Color: 255; 255; 255
343
+ Color Transformer: RGB8
344
+ Decay Time: 0
345
+ Enabled: true
346
+ Invert Rainbow: false
347
+ Max Color: 255; 255; 255
348
+ Min Color: 0; 0; 0
349
+ Name: raw_color_pcl
350
+ Position Transformer: XYZ
351
+ Queue Size: 10
352
+ Selectable: false
353
+ Size (Pixels): 1
354
+ Size (m): 0.019999999552965164
355
+ Style: Points
356
+ Topic: /tower_cam3d/depth_registered/points
357
+ Unreliable: false
358
+ Use Fixed Frame: true
359
+ Use rainbow: true
360
+ Value: true
361
+ - Alpha: 1
362
+ Autocompute Intensity Bounds: true
363
+ Autocompute Value Bounds:
364
+ Max Value: 10
365
+ Min Value: -10
366
+ Value: true
367
+ Axis: Z
368
+ Channel Name: intensity
369
+ Class: rviz/PointCloud2
370
+ Color: 255; 255; 255
371
+ Color Transformer: Intensity
372
+ Decay Time: 0
373
+ Enabled: false
374
+ Invert Rainbow: false
375
+ Max Color: 255; 255; 255
376
+ Min Color: 0; 0; 0
377
+ Name: tabletop_clusters
378
+ Position Transformer: XYZ
379
+ Queue Size: 10
380
+ Selectable: true
381
+ Size (Pixels): 3
382
+ Size (m): 0.009999999776482582
383
+ Style: Points
384
+ Topic: /mcr_perception/scene_segmentation/tabletop_clusters
385
+ Unreliable: false
386
+ Use Fixed Frame: true
387
+ Use rainbow: true
388
+ Value: false
389
+ - Class: rviz/Marker
390
+ Enabled: false
391
+ Marker Topic: /mcr_perception/scene_segmentation/bounding_boxes
392
+ Name: perception_markers
393
+ Namespaces:
394
+ {}
395
+ Queue Size: 100
396
+ Value: false
397
+ - Alpha: 1
398
+ Autocompute Intensity Bounds: true
399
+ Autocompute Value Bounds:
400
+ Max Value: 10
401
+ Min Value: -10
402
+ Value: true
403
+ Axis: Z
404
+ Channel Name: intensity
405
+ Class: rviz/PointCloud2
406
+ Color: 255; 255; 255
407
+ Color Transformer: RGB8
408
+ Decay Time: 0
409
+ Enabled: false
410
+ Invert Rainbow: false
411
+ Max Color: 255; 255; 255
412
+ Min Color: 0; 0; 0
413
+ Name: passthrough_x
414
+ Position Transformer: XYZ
415
+ Queue Size: 10
416
+ Selectable: true
417
+ Size (Pixels): 3
418
+ Size (m): 0.009999999776482582
419
+ Style: Flat Squares
420
+ Topic: /mcr_perception/passthrough_x/output
421
+ Unreliable: false
422
+ Use Fixed Frame: true
423
+ Use rainbow: true
424
+ Value: false
425
+ - Class: rviz/MarkerArray
426
+ Enabled: false
427
+ Marker Topic: /mcr_perception/scene_segmentation/labels
428
+ Name: pcl_labels
429
+ Namespaces:
430
+ {}
431
+ Queue Size: 100
432
+ Value: false
433
+ - Alpha: 0.30000001192092896
434
+ Autocompute Intensity Bounds: true
435
+ Autocompute Value Bounds:
436
+ Max Value: 10
437
+ Min Value: -10
438
+ Value: true
439
+ Axis: Z
440
+ Channel Name: intensity
441
+ Class: rviz/PointCloud2
442
+ Color: 170; 255; 0
443
+ Color Transformer: FlatColor
444
+ Decay Time: 0
445
+ Enabled: false
446
+ Invert Rainbow: false
447
+ Max Color: 255; 255; 255
448
+ Min Color: 0; 0; 0
449
+ Name: tabletop_accum
450
+ Position Transformer: XYZ
451
+ Queue Size: 10
452
+ Selectable: true
453
+ Size (Pixels): 3
454
+ Size (m): 0.009999999776482582
455
+ Style: Spheres
456
+ Topic: /mcr_perception/scene_segmentation_node/tabletop_clusters
457
+ Unreliable: false
458
+ Use Fixed Frame: true
459
+ Use rainbow: true
460
+ Value: false
461
+ - Alpha: 1
462
+ Class: rviz/Polygon
463
+ Color: 25; 255; 0
464
+ Enabled: false
465
+ Name: Polygon
466
+ Queue Size: 10
467
+ Topic: /mcr_perception/convex_hull/output_polygon
468
+ Unreliable: false
469
+ Value: false
470
+ - Class: rviz/Image
471
+ Enabled: true
472
+ Image Topic: /arm_cam3d/rgb/image_raw
473
+ Max Value: 1
474
+ Median window: 5
475
+ Min Value: 0
476
+ Name: Image
477
+ Normalize Range: true
478
+ Queue Size: 2
479
+ Transport Hint: raw
480
+ Unreliable: false
481
+ Value: true
482
+ - Alpha: 1
483
+ Autocompute Intensity Bounds: true
484
+ Autocompute Value Bounds:
485
+ Max Value: 10
486
+ Min Value: -10
487
+ Value: true
488
+ Axis: Z
489
+ Channel Name: intensity
490
+ Class: rviz/LaserScan
491
+ Color: 255; 255; 255
492
+ Color Transformer: ""
493
+ Decay Time: 0
494
+ Enabled: false
495
+ Invert Rainbow: false
496
+ Max Color: 255; 255; 255
497
+ Min Color: 0; 0; 0
498
+ Name: barrier_scan
499
+ Position Transformer: ""
500
+ Queue Size: 10
501
+ Selectable: true
502
+ Size (Pixels): 3
503
+ Size (m): 0.009999999776482582
504
+ Style: Flat Squares
505
+ Topic: /barrier_tape/scan
506
+ Unreliable: false
507
+ Use Fixed Frame: true
508
+ Use rainbow: true
509
+ Value: false
510
+ - Alpha: 1
511
+ Autocompute Intensity Bounds: true
512
+ Autocompute Value Bounds:
513
+ Max Value: 10
514
+ Min Value: -10
515
+ Value: true
516
+ Axis: Z
517
+ Channel Name: intensity
518
+ Class: rviz/PointCloud2
519
+ Color: 255; 255; 255
520
+ Color Transformer: Intensity
521
+ Decay Time: 0
522
+ Enabled: false
523
+ Invert Rainbow: false
524
+ Max Color: 255; 255; 255
525
+ Min Color: 0; 0; 0
526
+ Name: cloud_accumulator
527
+ Position Transformer: XYZ
528
+ Queue Size: 10
529
+ Selectable: true
530
+ Size (Pixels): 3
531
+ Size (m): 0.009999999776482582
532
+ Style: Boxes
533
+ Topic: /mcr_perception/scene_segmentation/output
534
+ Unreliable: false
535
+ Use Fixed Frame: true
536
+ Use rainbow: true
537
+ Value: false
538
+ - Alpha: 1
539
+ Arrow Length: 0.10000000149011612
540
+ Axes Length: 0.30000001192092896
541
+ Axes Radius: 0.009999999776482582
542
+ Class: rviz/PoseArray
543
+ Color: 255; 25; 0
544
+ Enabled: false
545
+ Head Length: 0.07000000029802322
546
+ Head Radius: 0.029999999329447746
547
+ Name: DetectedCavities
548
+ Queue Size: 10
549
+ Shaft Length: 0.23000000417232513
550
+ Shaft Radius: 0.009999999776482582
551
+ Shape: Arrow (Flat)
552
+ Topic: /mcr_perception/cavity_finder/output/pose
553
+ Unreliable: false
554
+ Value: false
555
+ - Class: rviz/Image
556
+ Enabled: true
557
+ Image Topic: /mcr_perception/cavity_finder/output/rgb_debug_image
558
+ Max Value: 1
559
+ Median window: 5
560
+ Min Value: 0
561
+ Name: cavity_debug
562
+ Normalize Range: true
563
+ Queue Size: 2
564
+ Transport Hint: raw
565
+ Unreliable: false
566
+ Value: true
567
+ - Alpha: 1
568
+ Arrow Length: 0.30000001192092896
569
+ Axes Length: 0.30000001192092896
570
+ Axes Radius: 0.009999999776482582
571
+ Class: rviz/PoseArray
572
+ Color: 255; 25; 0
573
+ Enabled: false
574
+ Head Length: 0.07000000029802322
575
+ Head Radius: 0.029999999329447746
576
+ Name: detectedobjects
577
+ Queue Size: 10
578
+ Shaft Length: 0.23000000417232513
579
+ Shaft Radius: 0.009999999776482582
580
+ Shape: Arrow (Flat)
581
+ Topic: /mcr_perception/multimodal_object_identification/output/pose
582
+ Unreliable: false
583
+ Value: false
584
+ - Alpha: 1
585
+ Autocompute Intensity Bounds: true
586
+ Autocompute Value Bounds:
587
+ Max Value: 10
588
+ Min Value: -10
589
+ Value: true
590
+ Axis: Z
591
+ Channel Name: intensity
592
+ Class: rviz/PointCloud2
593
+ Color: 255; 255; 255
594
+ Color Transformer: Intensity
595
+ Decay Time: 0
596
+ Enabled: false
597
+ Invert Rainbow: false
598
+ Max Color: 255; 255; 255
599
+ Min Color: 0; 0; 0
600
+ Name: mm_pointcloud
601
+ Position Transformer: XYZ
602
+ Queue Size: 10
603
+ Selectable: true
604
+ Size (Pixels): 3
605
+ Size (m): 0.009999999776482582
606
+ Style: Points
607
+ Topic: /mcr_perception/multimodal_object_identification/output/pointclouds_combined
608
+ Unreliable: false
609
+ Use Fixed Frame: true
610
+ Use rainbow: true
611
+ Value: false
612
+ - Alpha: 1
613
+ Autocompute Intensity Bounds: true
614
+ Autocompute Value Bounds:
615
+ Max Value: 10
616
+ Min Value: -10
617
+ Value: true
618
+ Axis: Z
619
+ Channel Name: intensity
620
+ Class: rviz/PointCloud2
621
+ Color: 255; 255; 255
622
+ Color Transformer: Intensity
623
+ Decay Time: 0
624
+ Enabled: false
625
+ Invert Rainbow: false
626
+ Max Color: 255; 255; 255
627
+ Min Color: 0; 0; 0
628
+ Name: mm_platform
629
+ Position Transformer: XYZ
630
+ Queue Size: 10
631
+ Selectable: true
632
+ Size (Pixels): 3
633
+ Size (m): 0.009999999776482582
634
+ Style: Flat Squares
635
+ Topic: /mcr_perception/multimodal_object_identification/output/platform_pointcloud
636
+ Unreliable: false
637
+ Use Fixed Frame: true
638
+ Use rainbow: true
639
+ Value: false
640
+ - Class: rviz/Image
641
+ Enabled: true
642
+ Image Topic: /mcr_perception/multimodal_object_identification/output/rgb_debug_image
643
+ Max Value: 1
644
+ Median window: 5
645
+ Min Value: 0
646
+ Name: mm_rgb_debug
647
+ Normalize Range: true
648
+ Queue Size: 2
649
+ Transport Hint: raw
650
+ Unreliable: false
651
+ Value: true
652
+ Enabled: true
653
+ Name: Perception
654
+ - Class: rviz/Group
655
+ Displays:
656
+ - Class: rviz/Image
657
+ Enabled: true
658
+ Image Topic: /tower_cam3d/rgb/image_raw
659
+ Max Value: 1
660
+ Median window: 5
661
+ Min Value: 0
662
+ Name: raw_image
663
+ Normalize Range: true
664
+ Queue Size: 2
665
+ Transport Hint: raw
666
+ Unreliable: false
667
+ Value: true
668
+ - Class: rviz/Image
669
+ Enabled: true
670
+ Image Topic: /mir_perception/multimodal_object_recognition/recognizer/rgb/output/debug_image
671
+ Max Value: 1
672
+ Median window: 5
673
+ Min Value: 0
674
+ Name: yolo_debug
675
+ Normalize Range: true
676
+ Queue Size: 2
677
+ Transport Hint: raw
678
+ Unreliable: false
679
+ Value: true
680
+ - Alpha: 1
681
+ Autocompute Intensity Bounds: true
682
+ Autocompute Value Bounds:
683
+ Max Value: 10
684
+ Min Value: -10
685
+ Value: true
686
+ Axis: Z
687
+ Channel Name: intensity
688
+ Class: rviz/PointCloud2
689
+ Color: 255; 255; 255
690
+ Color Transformer: RGB8
691
+ Decay Time: 0
692
+ Enabled: false
693
+ Invert Rainbow: false
694
+ Max Color: 255; 255; 255
695
+ Min Color: 0; 0; 0
696
+ Name: raw_pointcloud2
697
+ Position Transformer: XYZ
698
+ Queue Size: 10
699
+ Selectable: true
700
+ Size (Pixels): 3
701
+ Size (m): 0.009999999776482582
702
+ Style: Points
703
+ Topic: /tower_cam3d/depth_registered/points
704
+ Unreliable: false
705
+ Use Fixed Frame: true
706
+ Use rainbow: true
707
+ Value: false
708
+ - Alpha: 1
709
+ Autocompute Intensity Bounds: true
710
+ Autocompute Value Bounds:
711
+ Max Value: 10
712
+ Min Value: -10
713
+ Value: true
714
+ Axis: Z
715
+ Channel Name: intensity
716
+ Class: rviz/PointCloud2
717
+ Color: 255; 255; 255
718
+ Color Transformer: RGB8
719
+ Decay Time: 0
720
+ Enabled: false
721
+ Invert Rainbow: false
722
+ Max Color: 255; 255; 255
723
+ Min Color: 0; 0; 0
724
+ Name: rgb_tabletop_clusters
725
+ Position Transformer: XYZ
726
+ Queue Size: 10
727
+ Selectable: true
728
+ Size (Pixels): 3
729
+ Size (m): 0.009999999776482582
730
+ Style: Points
731
+ Topic: /mir_perception/multimodal_object_recognition/tabletop_cluster_rgb
732
+ Unreliable: false
733
+ Use Fixed Frame: true
734
+ Use rainbow: true
735
+ Value: false
736
+ - Alpha: 1
737
+ Autocompute Intensity Bounds: true
738
+ Autocompute Value Bounds:
739
+ Max Value: 10
740
+ Min Value: -10
741
+ Value: true
742
+ Axis: Z
743
+ Channel Name: intensity
744
+ Class: rviz/PointCloud2
745
+ Color: 255; 255; 255
746
+ Color Transformer: RGB8
747
+ Decay Time: 0
748
+ Enabled: false
749
+ Invert Rainbow: false
750
+ Max Color: 255; 255; 255
751
+ Min Color: 0; 0; 0
752
+ Name: rgb_debug_pointcloud
753
+ Position Transformer: XYZ
754
+ Queue Size: 10
755
+ Selectable: true
756
+ Size (Pixels): 3
757
+ Size (m): 0.009999999776482582
758
+ Style: Points
759
+ Topic: /mir_perception/multimodal_object_recognition/output/debug_cloud_plane
760
+ Unreliable: false
761
+ Use Fixed Frame: true
762
+ Use rainbow: true
763
+ Value: false
764
+ - Alpha: 1
765
+ Autocompute Intensity Bounds: true
766
+ Autocompute Value Bounds:
767
+ Max Value: 10
768
+ Min Value: -10
769
+ Value: true
770
+ Axis: Z
771
+ Channel Name: intensity
772
+ Class: rviz/PointCloud2
773
+ Color: 255; 255; 255
774
+ Color Transformer: FlatColor
775
+ Decay Time: 0
776
+ Enabled: false
777
+ Invert Rainbow: false
778
+ Max Color: 255; 255; 255
779
+ Min Color: 0; 0; 0
780
+ Name: pcl_tabletop_clusters
781
+ Position Transformer: XYZ
782
+ Queue Size: 10
783
+ Selectable: true
784
+ Size (Pixels): 3
785
+ Size (m): 0.009999999776482582
786
+ Style: Points
787
+ Topic: /mir_perception/multimodal_object_recognition/tabletop_cluster_pcl
788
+ Unreliable: false
789
+ Use Fixed Frame: true
790
+ Use rainbow: true
791
+ Value: false
792
+ - Alpha: 1
793
+ Arrow Length: 0.30000001192092896
794
+ Axes Length: 0.30000001192092896
795
+ Axes Radius: 0.009999999776482582
796
+ Class: rviz/PoseArray
797
+ Color: 255; 25; 0
798
+ Enabled: false
799
+ Head Length: 0.07000000029802322
800
+ Head Radius: 0.029999999329447746
801
+ Name: rgb_PoseArray
802
+ Queue Size: 10
803
+ Shaft Length: 0.23000000417232513
804
+ Shaft Radius: 0.009999999776482582
805
+ Shape: Arrow (Flat)
806
+ Topic: /mir_perception/multimodal_object_recognition/output/rgb_object_pose_array
807
+ Unreliable: false
808
+ Value: false
809
+ - Alpha: 1
810
+ Arrow Length: 0.30000001192092896
811
+ Axes Length: 0.30000001192092896
812
+ Axes Radius: 0.009999999776482582
813
+ Class: rviz/PoseArray
814
+ Color: 255; 255; 255
815
+ Enabled: false
816
+ Head Length: 0.07000000029802322
817
+ Head Radius: 0.029999999329447746
818
+ Name: pcl_PoseArray
819
+ Queue Size: 10
820
+ Shaft Length: 0.23000000417232513
821
+ Shaft Radius: 0.009999999776482582
822
+ Shape: Arrow (Flat)
823
+ Topic: /mir_perception/multimodal_object_recognition/output/pcl_object_pose_array
824
+ Unreliable: false
825
+ Value: false
826
+ - Class: rviz/MarkerArray
827
+ Enabled: false
828
+ Marker Topic: /mir_perception/multimodal_object_recognition/pcl_labels
829
+ Name: pcl_labels
830
+ Namespaces:
831
+ {}
832
+ Queue Size: 100
833
+ Value: false
834
+ - Class: rviz/MarkerArray
835
+ Enabled: false
836
+ Marker Topic: /mir_perception/multimodal_object_recognition/rgb_labels
837
+ Name: rgb_labels
838
+ Namespaces:
839
+ {}
840
+ Queue Size: 100
841
+ Value: false
842
+ - Class: rviz/Marker
843
+ Enabled: false
844
+ Marker Topic: /mir_perception/multimodal_object_recognition/bounding_boxes
845
+ Name: bounding_boxes_pcl
846
+ Namespaces:
847
+ {}
848
+ Queue Size: 100
849
+ Value: false
850
+ - Alpha: 1
851
+ Axes Length: 1
852
+ Axes Radius: 0.10000000149011612
853
+ Class: rviz/Pose
854
+ Color: 0; 170; 0
855
+ Enabled: false
856
+ Head Length: 0.05000000074505806
857
+ Head Radius: 0.07999999821186066
858
+ Name: pose_selector
859
+ Queue Size: 10
860
+ Shaft Length: 0.4000000059604645
861
+ Shaft Radius: 0.008999999612569809
862
+ Shape: Arrow
863
+ Topic: /mcr_perception/object_selector/output/object_pose
864
+ Unreliable: false
865
+ Value: false
866
+ - Alpha: 1
867
+ Arrow Length: 0.30000001192092896
868
+ Axes Length: 0.30000001192092896
869
+ Axes Radius: 0.009999999776482582
870
+ Class: rviz/PoseArray
871
+ Color: 255; 25; 0
872
+ Enabled: false
873
+ Head Length: 0.07000000029802322
874
+ Head Radius: 0.029999999329447746
875
+ Name: rgb_object_poseArray
876
+ Queue Size: 10
877
+ Shaft Length: 0.23000000417232513
878
+ Shaft Radius: 0.009999999776482582
879
+ Shape: Arrow (Flat)
880
+ Topic: /mir_perception/multimodal_object_recognition/output/rgb_object_pose_array
881
+ Unreliable: false
882
+ Value: false
883
+ Enabled: false
884
+ Name: New_Perception
885
+ - Class: rviz/Group
886
+ Displays:
887
+ - Alpha: 1
888
+ Class: rviz/Polygon
889
+ Color: 255; 85; 0
890
+ Enabled: false
891
+ Name: robot_footprint
892
+ Queue Size: 10
893
+ Topic: /move_base/local_costmap/footprint
894
+ Unreliable: false
895
+ Value: false
896
+ - Alpha: 0.8999999761581421
897
+ Autocompute Intensity Bounds: true
898
+ Autocompute Value Bounds:
899
+ Max Value: 10
900
+ Min Value: -10
901
+ Value: true
902
+ Axis: Z
903
+ Channel Name: intensity
904
+ Class: rviz/LaserScan
905
+ Color: 0; 85; 255
906
+ Color Transformer: FlatColor
907
+ Decay Time: 0
908
+ Enabled: true
909
+ Invert Rainbow: false
910
+ Max Color: 255; 255; 255
911
+ Min Color: 0; 0; 0
912
+ Name: scan_front
913
+ Position Transformer: XYZ
914
+ Queue Size: 10
915
+ Selectable: true
916
+ Size (Pixels): 5
917
+ Size (m): 0.009999999776482582
918
+ Style: Points
919
+ Topic: /scan_front
920
+ Unreliable: false
921
+ Use Fixed Frame: true
922
+ Use rainbow: true
923
+ Value: true
924
+ - Alpha: 0.8999999761581421
925
+ Autocompute Intensity Bounds: true
926
+ Autocompute Value Bounds:
927
+ Max Value: 10
928
+ Min Value: -10
929
+ Value: true
930
+ Axis: Z
931
+ Channel Name: intensity
932
+ Class: rviz/LaserScan
933
+ Color: 255; 0; 0
934
+ Color Transformer: FlatColor
935
+ Decay Time: 0
936
+ Enabled: true
937
+ Invert Rainbow: false
938
+ Max Color: 255; 255; 255
939
+ Min Color: 0; 0; 0
940
+ Name: scan_rear
941
+ Position Transformer: XYZ
942
+ Queue Size: 10
943
+ Selectable: true
944
+ Size (Pixels): 5
945
+ Size (m): 0.009999999776482582
946
+ Style: Points
947
+ Topic: /scan_rear
948
+ Unreliable: false
949
+ Use Fixed Frame: true
950
+ Use rainbow: true
951
+ Value: true
952
+ - Alpha: 0.5
953
+ Class: rviz/Map
954
+ Color Scheme: map
955
+ Draw Behind: true
956
+ Enabled: true
957
+ Name: map
958
+ Topic: /map
959
+ Unreliable: false
960
+ Use Timestamp: false
961
+ Value: true
962
+ - Alpha: 0.699999988079071
963
+ Class: rviz/Map
964
+ Color Scheme: costmap
965
+ Draw Behind: false
966
+ Enabled: false
967
+ Name: local_costmap
968
+ Topic: /move_base/local_costmap/costmap
969
+ Unreliable: false
970
+ Use Timestamp: false
971
+ Value: false
972
+ - Alpha: 0.20000000298023224
973
+ Class: rviz/Map
974
+ Color Scheme: costmap
975
+ Draw Behind: false
976
+ Enabled: false
977
+ Name: global_costmap
978
+ Topic: /move_base/global_costmap/costmap
979
+ Unreliable: false
980
+ Use Timestamp: false
981
+ Value: false
982
+ - Alpha: 1
983
+ Arrow Length: 0.30000001192092896
984
+ Axes Length: 0.30000001192092896
985
+ Axes Radius: 0.009999999776482582
986
+ Class: rviz/PoseArray
987
+ Color: 255; 25; 0
988
+ Enabled: true
989
+ Head Length: 0.07000000029802322
990
+ Head Radius: 0.029999999329447746
991
+ Name: global_plan_wo
992
+ Queue Size: 10
993
+ Shaft Length: 0.23000000417232513
994
+ Shaft Radius: 0.009999999776482582
995
+ Shape: Arrow (Flat)
996
+ Topic: /move_base/GlobalPlannerWithOrientations/plan
997
+ Unreliable: false
998
+ Value: true
999
+ - Alpha: 1
1000
+ Buffer Length: 1
1001
+ Class: rviz/Path
1002
+ Color: 170; 0; 127
1003
+ Enabled: true
1004
+ Head Diameter: 0.30000001192092896
1005
+ Head Length: 0.20000000298023224
1006
+ Length: 0.30000001192092896
1007
+ Line Style: Lines
1008
+ Line Width: 0.029999999329447746
1009
+ Name: global_plan_as_path
1010
+ Offset:
1011
+ X: 0
1012
+ Y: 0
1013
+ Z: 0
1014
+ Pose Color: 255; 85; 255
1015
+ Pose Style: None
1016
+ Queue Size: 10
1017
+ Radius: 0.029999999329447746
1018
+ Shaft Diameter: 0.10000000149011612
1019
+ Shaft Length: 0.10000000149011612
1020
+ Topic: /move_base/GlobalPlannerWithOrientations/path_plan
1021
+ Unreliable: false
1022
+ Value: true
1023
+ - Alpha: 1
1024
+ Buffer Length: 1
1025
+ Class: rviz/Path
1026
+ Color: 25; 255; 0
1027
+ Enabled: true
1028
+ Head Diameter: 0.30000001192092896
1029
+ Head Length: 0.20000000298023224
1030
+ Length: 0.30000001192092896
1031
+ Line Style: Lines
1032
+ Line Width: 0.029999999329447746
1033
+ Name: dwa_global_plan
1034
+ Offset:
1035
+ X: 0
1036
+ Y: 0
1037
+ Z: 0
1038
+ Pose Color: 255; 85; 255
1039
+ Pose Style: None
1040
+ Queue Size: 10
1041
+ Radius: 0.029999999329447746
1042
+ Shaft Diameter: 0.10000000149011612
1043
+ Shaft Length: 0.10000000149011612
1044
+ Topic: /move_base/DWAPlannerROS/global_plan
1045
+ Unreliable: false
1046
+ Value: true
1047
+ - Alpha: 1
1048
+ Buffer Length: 1
1049
+ Class: rviz/Path
1050
+ Color: 85; 85; 127
1051
+ Enabled: true
1052
+ Head Diameter: 0.30000001192092896
1053
+ Head Length: 0.20000000298023224
1054
+ Length: 0.30000001192092896
1055
+ Line Style: Lines
1056
+ Line Width: 0.029999999329447746
1057
+ Name: local_plan
1058
+ Offset:
1059
+ X: 0
1060
+ Y: 0
1061
+ Z: 0
1062
+ Pose Color: 255; 85; 255
1063
+ Pose Style: None
1064
+ Queue Size: 10
1065
+ Radius: 0.029999999329447746
1066
+ Shaft Diameter: 0.10000000149011612
1067
+ Shaft Length: 0.10000000149011612
1068
+ Topic: /move_base/DWAPlannerROS/local_plan
1069
+ Unreliable: false
1070
+ Value: true
1071
+ - Alpha: 1
1072
+ Arrow Length: 0.30000001192092896
1073
+ Axes Length: 0.30000001192092896
1074
+ Axes Radius: 0.009999999776482582
1075
+ Class: rviz/PoseArray
1076
+ Color: 255; 25; 0
1077
+ Enabled: true
1078
+ Head Length: 0.07000000029802322
1079
+ Head Radius: 0.029999999329447746
1080
+ Name: amcl particles
1081
+ Queue Size: 10
1082
+ Shaft Length: 0.23000000417232513
1083
+ Shaft Radius: 0.009999999776482582
1084
+ Shape: Arrow (Flat)
1085
+ Topic: /particlecloud
1086
+ Unreliable: false
1087
+ Value: true
1088
+ - Class: rviz/MarkerArray
1089
+ Enabled: true
1090
+ Marker Topic: /visualization_marker_array
1091
+ Name: nav goals
1092
+ Namespaces:
1093
+ {}
1094
+ Queue Size: 100
1095
+ Value: true
1096
+ - Class: rviz/Group
1097
+ Displays:
1098
+ - Class: rviz/Marker
1099
+ Enabled: true
1100
+ Marker Topic: /move_base/force_field_recovery/force_field_vector
1101
+ Name: ff_vector
1102
+ Namespaces:
1103
+ {}
1104
+ Queue Size: 100
1105
+ Value: true
1106
+ - Alpha: 1
1107
+ Autocompute Intensity Bounds: true
1108
+ Autocompute Value Bounds:
1109
+ Max Value: 10
1110
+ Min Value: -10
1111
+ Value: true
1112
+ Axis: Z
1113
+ Channel Name: intensity
1114
+ Class: rviz/PointCloud2
1115
+ Color: 255; 85; 0
1116
+ Color Transformer: FlatColor
1117
+ Decay Time: 0
1118
+ Enabled: true
1119
+ Invert Rainbow: false
1120
+ Max Color: 255; 255; 255
1121
+ Min Color: 0; 0; 0
1122
+ Name: obstacle_cloud
1123
+ Position Transformer: XYZ
1124
+ Queue Size: 10
1125
+ Selectable: true
1126
+ Size (Pixels): 3
1127
+ Size (m): 0.05000000074505806
1128
+ Style: Spheres
1129
+ Topic: /move_base/force_field_recovery/obstacle_cloud
1130
+ Unreliable: false
1131
+ Use Fixed Frame: true
1132
+ Use rainbow: true
1133
+ Value: true
1134
+ - Class: rviz/Marker
1135
+ Enabled: true
1136
+ Marker Topic: /move_base/force_field_recovery/obstacle_neighborhood
1137
+ Name: obst_neighbourhood
1138
+ Namespaces:
1139
+ {}
1140
+ Queue Size: 100
1141
+ Value: true
1142
+ Enabled: false
1143
+ Name: force_field
1144
+ Enabled: false
1145
+ Name: Navigation
1146
+ - Class: rviz/Group
1147
+ Displays:
1148
+ - Alpha: 1
1149
+ Axes Length: 1
1150
+ Axes Radius: 0.10000000149011612
1151
+ Class: rviz/Pose
1152
+ Color: 85; 170; 0
1153
+ Enabled: true
1154
+ Head Length: 0.10000000149011612
1155
+ Head Radius: 0.029999999329447746
1156
+ Name: random object pose
1157
+ Queue Size: 10
1158
+ Shaft Length: 0.10000000149011612
1159
+ Shaft Radius: 0.009999999776482582
1160
+ Shape: Arrow
1161
+ Topic: /mcr_perception/random_object_selector/output/object_pose
1162
+ Unreliable: false
1163
+ Value: true
1164
+ - Alpha: 0.8999999761581421
1165
+ Axes Length: 1
1166
+ Axes Radius: 0.10000000149011612
1167
+ Class: rviz/Pose
1168
+ Color: 170; 85; 255
1169
+ Enabled: true
1170
+ Head Length: 0.10000000149011612
1171
+ Head Radius: 0.10000000149011612
1172
+ Name: modified pose
1173
+ Queue Size: 10
1174
+ Shaft Length: 0.5
1175
+ Shaft Radius: 0.05000000074505806
1176
+ Shape: Arrow
1177
+ Topic: /move_base_relative/random_obj_selector_transformer_republisher/output/transformed_pose
1178
+ Unreliable: false
1179
+ Value: true
1180
+ Enabled: false
1181
+ Name: move_relative
1182
+ - Class: rviz/Group
1183
+ Displays:
1184
+ - Alpha: 1
1185
+ Axes Length: 1
1186
+ Axes Radius: 0.10000000149011612
1187
+ Class: rviz/Pose
1188
+ Color: 0; 85; 0
1189
+ Enabled: true
1190
+ Head Length: 0.30000001192092896
1191
+ Head Radius: 0.10000000149011612
1192
+ Name: base_link_as_pose
1193
+ Queue Size: 10
1194
+ Shaft Length: 1
1195
+ Shaft Radius: 0.05000000074505806
1196
+ Shape: Arrow
1197
+ Topic: /mcr_navigation/direct_base_controller/pose_converter/converted_pose
1198
+ Unreliable: false
1199
+ Value: true
1200
+ - Alpha: 1
1201
+ Axes Length: 1
1202
+ Axes Radius: 0.10000000149011612
1203
+ Class: rviz/Pose
1204
+ Color: 85; 85; 255
1205
+ Enabled: true
1206
+ Head Length: 0.30000001192092896
1207
+ Head Radius: 0.10000000149011612
1208
+ Name: goal_pose
1209
+ Queue Size: 10
1210
+ Shaft Length: 1
1211
+ Shaft Radius: 0.05000000074505806
1212
+ Shape: Arrow
1213
+ Topic: /pose_transformer/transformed_pose
1214
+ Unreliable: false
1215
+ Value: true
1216
+ Enabled: false
1217
+ Name: direct_base_ctrl
1218
+ - Class: rviz/Group
1219
+ Displays:
1220
+ - Alpha: 0.8999999761581421
1221
+ Axes Length: 1
1222
+ Axes Radius: 0.10000000149011612
1223
+ Class: rviz/Pose
1224
+ Color: 0; 255; 0
1225
+ Enabled: false
1226
+ Head Length: 0.10000000149011612
1227
+ Head Radius: 0.029999999329447746
1228
+ Name: winner_pose
1229
+ Queue Size: 10
1230
+ Shaft Length: 0.10000000149011612
1231
+ Shaft Radius: 0.009999999776482582
1232
+ Shape: Arrow
1233
+ Topic: /pregrasp_planner_pipeline/grasp_planner/pose_out
1234
+ Unreliable: false
1235
+ Value: false
1236
+ - Alpha: 1
1237
+ Arrow Length: 0.30000001192092896
1238
+ Axes Length: 0.30000001192092896
1239
+ Axes Radius: 0.009999999776482582
1240
+ Class: rviz/PoseArray
1241
+ Color: 255; 25; 0
1242
+ Enabled: false
1243
+ Head Length: 0.07000000029802322
1244
+ Head Radius: 0.029999999329447746
1245
+ Name: generated_poses
1246
+ Queue Size: 10
1247
+ Shaft Length: 0.23000000417232513
1248
+ Shaft Radius: 0.009999999776482582
1249
+ Shape: Arrow (Flat)
1250
+ Topic: /pregrasp_planner_pipeline/pose_generator/poses_list
1251
+ Unreliable: false
1252
+ Value: false
1253
+ - Alpha: 1
1254
+ Axes Length: 1
1255
+ Axes Radius: 0.10000000149011612
1256
+ Class: rviz/Pose
1257
+ Color: 255; 25; 0
1258
+ Enabled: true
1259
+ Head Length: 0.30000001192092896
1260
+ Head Radius: 0.10000000149011612
1261
+ Name: pose_in_pregrasp_planner
1262
+ Queue Size: 10
1263
+ Shaft Length: 1
1264
+ Shaft Radius: 0.05000000074505806
1265
+ Shape: Arrow
1266
+ Topic: /mir_pregrasp_planner_pipeline/pose_in
1267
+ Unreliable: false
1268
+ Value: true
1269
+ Enabled: false
1270
+ Name: pregrasp_planner
1271
+ - Class: rviz/Group
1272
+ Displays:
1273
+ - Class: rviz/Image
1274
+ Enabled: true
1275
+ Image Topic: /mcr_perception/barrier_tape_detection/debug_image
1276
+ Max Value: 1
1277
+ Median window: 5
1278
+ Min Value: 0
1279
+ Name: debug_image
1280
+ Normalize Range: true
1281
+ Queue Size: 2
1282
+ Transport Hint: raw
1283
+ Unreliable: false
1284
+ Value: true
1285
+ - Alpha: 1
1286
+ Autocompute Intensity Bounds: true
1287
+ Autocompute Value Bounds:
1288
+ Max Value: 10
1289
+ Min Value: -10
1290
+ Value: true
1291
+ Axis: Z
1292
+ Channel Name: intensity
1293
+ Class: rviz/PointCloud2
1294
+ Color: 255; 255; 255
1295
+ Color Transformer: Intensity
1296
+ Decay Time: 0
1297
+ Enabled: true
1298
+ Invert Rainbow: false
1299
+ Max Color: 255; 255; 255
1300
+ Min Color: 0; 0; 0
1301
+ Name: PointCloud2
1302
+ Position Transformer: XYZ
1303
+ Queue Size: 10
1304
+ Selectable: true
1305
+ Size (Pixels): 3
1306
+ Size (m): 0.009999999776482582
1307
+ Style: Flat Squares
1308
+ Topic: /mcr_perception/barrier_tape_detection/output/yellow_barrier_tape_pointcloud
1309
+ Unreliable: false
1310
+ Use Fixed Frame: true
1311
+ Use rainbow: true
1312
+ Value: true
1313
+ - Alpha: 1
1314
+ Autocompute Intensity Bounds: true
1315
+ Autocompute Value Bounds:
1316
+ Max Value: 10
1317
+ Min Value: -10
1318
+ Value: true
1319
+ Axis: Z
1320
+ Channel Name: intensity
1321
+ Class: rviz/LaserScan
1322
+ Color: 255; 255; 255
1323
+ Color Transformer: ""
1324
+ Decay Time: 0
1325
+ Enabled: true
1326
+ Invert Rainbow: false
1327
+ Max Color: 255; 255; 255
1328
+ Min Color: 0; 0; 0
1329
+ Name: LaserScan
1330
+ Position Transformer: ""
1331
+ Queue Size: 10
1332
+ Selectable: true
1333
+ Size (Pixels): 3
1334
+ Size (m): 0.009999999776482582
1335
+ Style: Flat Squares
1336
+ Topic: /barrier_tape/scan
1337
+ Unreliable: false
1338
+ Use Fixed Frame: true
1339
+ Use rainbow: true
1340
+ Value: true
1341
+ Enabled: false
1342
+ Name: barrier_tape
1343
+ - Class: rviz/Group
1344
+ Displays:
1345
+ - Alpha: 1
1346
+ Autocompute Intensity Bounds: true
1347
+ Autocompute Value Bounds:
1348
+ Max Value: 10
1349
+ Min Value: -10
1350
+ Value: true
1351
+ Axis: Z
1352
+ Channel Name: intensity
1353
+ Class: rviz/PointCloud2
1354
+ Color: 255; 255; 255
1355
+ Color Transformer: Intensity
1356
+ Decay Time: 0
1357
+ Enabled: true
1358
+ Invert Rainbow: false
1359
+ Max Color: 255; 255; 255
1360
+ Min Color: 0; 0; 0
1361
+ Name: line_tracing_3d
1362
+ Position Transformer: XYZ
1363
+ Queue Size: 10
1364
+ Selectable: true
1365
+ Size (Pixels): 3
1366
+ Size (m): 0.009999999776482582
1367
+ Style: Flat Squares
1368
+ Topic: /mcr_perception/line_contour_detector/output/pointclouds_filtered
1369
+ Unreliable: false
1370
+ Use Fixed Frame: true
1371
+ Use rainbow: true
1372
+ Value: true
1373
+ - Class: rviz/Image
1374
+ Enabled: true
1375
+ Image Topic: /mcr_perception/line_contour_detector/output/debug_image
1376
+ Max Value: 1
1377
+ Median window: 5
1378
+ Min Value: 0
1379
+ Name: line_tracing_rgb
1380
+ Normalize Range: true
1381
+ Queue Size: 2
1382
+ Transport Hint: raw
1383
+ Unreliable: false
1384
+ Value: true
1385
+ - Alpha: 1
1386
+ Buffer Length: 1
1387
+ Class: rviz/Path
1388
+ Color: 25; 255; 0
1389
+ Enabled: true
1390
+ Head Diameter: 0.30000001192092896
1391
+ Head Length: 0.20000000298023224
1392
+ Length: 0.30000001192092896
1393
+ Line Style: Lines
1394
+ Line Width: 0.029999999329447746
1395
+ Name: line_path
1396
+ Offset:
1397
+ X: 0
1398
+ Y: 0
1399
+ Z: 0
1400
+ Pose Color: 255; 85; 255
1401
+ Pose Style: None
1402
+ Queue Size: 10
1403
+ Radius: 0.029999999329447746
1404
+ Shaft Diameter: 0.10000000149011612
1405
+ Shaft Length: 0.10000000149011612
1406
+ Topic: /mir_manipulation/mir_trajectory_executor/line_tracing_path
1407
+ Unreliable: false
1408
+ Value: true
1409
+ Enabled: false
1410
+ Name: line_tracing
1411
+ - Class: rviz/Group
1412
+ Displays:
1413
+ - Alpha: 1
1414
+ Axes Length: 0.10000000149011612
1415
+ Axes Radius: 0.009999999776482582
1416
+ Class: rviz/Pose
1417
+ Color: 255; 25; 0
1418
+ Enabled: true
1419
+ Head Length: 0.30000001192092896
1420
+ Head Radius: 0.10000000149011612
1421
+ Name: grasp_pose
1422
+ Queue Size: 10
1423
+ Shaft Length: 1
1424
+ Shaft Radius: 0.05000000074505806
1425
+ Shape: Axes
1426
+ Topic: /mir_pregrasp_planner_pipeline/pose_out
1427
+ Unreliable: false
1428
+ Value: true
1429
+ - Alpha: 1
1430
+ Axes Length: 0.20000000298023224
1431
+ Axes Radius: 0.009999999776482582
1432
+ Class: rviz/Pose
1433
+ Color: 255; 25; 0
1434
+ Enabled: true
1435
+ Head Length: 0.30000001192092896
1436
+ Head Radius: 0.10000000149011612
1437
+ Name: object_pose
1438
+ Queue Size: 10
1439
+ Shaft Length: 1
1440
+ Shaft Radius: 0.05000000074505806
1441
+ Shape: Axes
1442
+ Topic: /mcr_perception/object_selector/output/object_pose
1443
+ Unreliable: false
1444
+ Value: true
1445
+ - Alpha: 0.10000000149011612
1446
+ Axes Length: 0.10000000149011612
1447
+ Axes Radius: 0.009999999776482582
1448
+ Class: rviz/Pose
1449
+ Color: 255; 0; 255
1450
+ Enabled: true
1451
+ Head Length: 0.10000000149011612
1452
+ Head Radius: 0.009999999776482582
1453
+ Name: base_goal_pose
1454
+ Queue Size: 10
1455
+ Shaft Length: 0.10000000149011612
1456
+ Shaft Radius: 0.009999999776482582
1457
+ Shape: Axes
1458
+ Topic: /wbc_base_motion_calculator_pipeline/pose_transformer/transformed_pose
1459
+ Unreliable: false
1460
+ Value: true
1461
+ - Alpha: 1
1462
+ Axes Length: 1
1463
+ Axes Radius: 0.10000000149011612
1464
+ Class: rviz/Pose
1465
+ Color: 0; 0; 0
1466
+ Enabled: true
1467
+ Head Length: 0.30000001192092896
1468
+ Head Radius: 0.10000000149011612
1469
+ Name: base_start_pose
1470
+ Queue Size: 10
1471
+ Shaft Length: 0.10000000149011612
1472
+ Shaft Radius: 0.05000000074505806
1473
+ Shape: Arrow
1474
+ Topic: /base_motion_calculator/pose_out_1
1475
+ Unreliable: false
1476
+ Value: true
1477
+ - Alpha: 1
1478
+ Arrow Length: 0.30000001192092896
1479
+ Axes Length: 0.30000001192092896
1480
+ Axes Radius: 0.009999999776482582
1481
+ Class: rviz/PoseArray
1482
+ Color: 255; 25; 0
1483
+ Enabled: false
1484
+ Head Length: 0.07000000029802322
1485
+ Head Radius: 0.029999999329447746
1486
+ Name: PoseArray
1487
+ Queue Size: 10
1488
+ Shaft Length: 0.23000000417232513
1489
+ Shaft Radius: 0.009999999776482582
1490
+ Shape: Arrow (Flat)
1491
+ Topic: /pregrasp_planner_pipeline/pose_generator/poses_list
1492
+ Unreliable: false
1493
+ Value: false
1494
+ Enabled: false
1495
+ Name: WBC
1496
+ Enabled: false
1497
+ Name: btt
1498
+ - Alpha: 1
1499
+ Axes Length: 1
1500
+ Axes Radius: 0.10000000149011612
1501
+ Class: rviz/Pose
1502
+ Color: 0; 255; 0
1503
+ Enabled: true
1504
+ Head Length: 0.10000000149011612
1505
+ Head Radius: 0.05000000074505806
1506
+ Name: camera_calibration_obj_pose
1507
+ Queue Size: 10
1508
+ Shaft Length: 0.30000001192092896
1509
+ Shaft Radius: 0.009999999776482582
1510
+ Shape: Arrow
1511
+ Topic: /mcr_perception/object_selector/output/object_pose
1512
+ Unreliable: false
1513
+ Value: true
1514
+ - Alpha: 1
1515
+ Autocompute Intensity Bounds: true
1516
+ Autocompute Value Bounds:
1517
+ Max Value: 10
1518
+ Min Value: -10
1519
+ Value: true
1520
+ Axis: Z
1521
+ Channel Name: intensity
1522
+ Class: rviz/PointCloud2
1523
+ Color: 255; 255; 255
1524
+ Color Transformer: RGB8
1525
+ Decay Time: 0
1526
+ Enabled: true
1527
+ Invert Rainbow: false
1528
+ Max Color: 255; 255; 255
1529
+ Min Color: 0; 0; 0
1530
+ Name: raw_color_pcl
1531
+ Position Transformer: XYZ
1532
+ Queue Size: 10
1533
+ Selectable: false
1534
+ Size (Pixels): 1
1535
+ Size (m): 0.019999999552965164
1536
+ Style: Points
1537
+ Topic: /tower_cam3d/depth_registered/points
1538
+ Unreliable: false
1539
+ Use Fixed Frame: true
1540
+ Use rainbow: true
1541
+ Value: true
1542
+ Enabled: true
1543
+ Global Options:
1544
+ Background Color: 48; 48; 48
1545
+ Default Light: true
1546
+ Fixed Frame: base_link
1547
+ Frame Rate: 30
1548
+ Name: root
1549
+ Tools:
1550
+ - Class: rviz/Interact
1551
+ Hide Inactive Objects: true
1552
+ - Class: rviz/MoveCamera
1553
+ - Class: rviz/Select
1554
+ - Class: rviz/FocusCamera
1555
+ - Class: rviz/Measure
1556
+ - Class: rviz/SetInitialPose
1557
+ Theta std deviation: 0.2617993950843811
1558
+ Topic: /initialpose
1559
+ X std deviation: 0.5
1560
+ Y std deviation: 0.5
1561
+ - Class: rviz/SetGoal
1562
+ Topic: /move_base_simple/goal
1563
+ - Class: rviz/PublishPoint
1564
+ Single click: true
1565
+ Topic: /clicked_point
1566
+ Value: true
1567
+ Views:
1568
+ Current:
1569
+ Class: rviz/Orbit
1570
+ Distance: 2.597813129425049
1571
+ Enable Stereo Rendering:
1572
+ Stereo Eye Separation: 0.05999999865889549
1573
+ Stereo Focal Distance: 1
1574
+ Swap Stereo Eyes: false
1575
+ Value: false
1576
+ Field of View: 0.7853981852531433
1577
+ Focal Point:
1578
+ X: 0.2907962501049042
1579
+ Y: -0.21175114810466766
1580
+ Z: -0.0001220703125
1581
+ Focal Shape Fixed Size: true
1582
+ Focal Shape Size: 0.05000000074505806
1583
+ Invert Z Axis: false
1584
+ Name: Current View
1585
+ Near Clip Distance: 0.009999999776482582
1586
+ Pitch: 0.07979757338762283
1587
+ Target Frame: <Fixed Frame>
1588
+ Yaw: 1.5549991130828857
1589
+ Saved: ~
1590
+ Window Geometry:
1591
+ Displays:
1592
+ collapsed: false
1593
+ Height: 1043
1594
+ Hide Left Dock: false
1595
+ Hide Right Dock: false
1596
+ Image:
1597
+ collapsed: false
1598
+ QMainWindow State: 000000ff00000000fd00000004000000000000022500000364fc020000001efb0000001200530065006c0065006300740069006f006e00000001e10000009b0000006e00fffffffb0000001e0054006f006f006c002000500072006f007000650072007400690065007302000001ed000001df00000185000000a3fb000000120056006900650077007300200054006f006f02000001df000002110000018500000122fb000000200054006f006f006c002000500072006f0070006500720074006900650073003203000002880000011d000002210000017afb000000100044006900730070006c006100790073010000004700000364000000f100fffffffb0000002000730065006c0065006300740069006f006e00200062007500660066006500720200000138000000aa0000023a00000294fb00000014005700690064006500530074006500720065006f02000000e6000000d2000003ee0000030bfb0000000c004b0069006e0065006300740200000186000001060000030c00000261fb00000020006c0069006e0065005f00740072006100630069006e0067005f00720067006200000002aa000001130000001900fffffffb0000001600640065006200750067005f0069006d00610067006500000002200000019b0000001900fffffffb000000140032006400200063006f006e0074006f0075007201000002f9000000c20000000000000000fb0000001e004d006f00740069006f006e00200050006c0061006e006e0069006e006700000002b1000002750000000000000000fb0000000a0049006d006100670065000000020a000000ba0000001900fffffffb0000000a0049006d006100670065000000044e000000d80000000000000000fb00000018006300610076006900740079005f00640065006200750067000000028c000000c70000001900fffffffb00000018006d006d005f007200670062005f0064006500620075006700000003410000006a0000001900fffffffb0000000a0049006d0061006700650000000333000001f30000000000000000fb0000000a0049006d00610067006501000002d3000000ca0000000000000000fb0000000a0049006d00610067006501000002f0000000cb0000000000000000fb0000000a0049006d00610067006501000002ce000000ef0000000000000000fb000000140079006f006c006f005f0064006500620075006700000001a7000002040000001900fffffffb00000012007200610077005f0069006d0061006700650000000248000001630000001900fffffffb0000001e0054006f006f006c002000500072006f007000650072007400690065007300000002ff000000ac0000006e00fffffffb0000001200530065006c0065006300740069006f006e00000002ff000000ac0000006e00fffffffb0000002000730071007500650065007a0065004400650074005f0064006500620075006700000002c9000000190000000000000000fb00000018006d006d005f007200670062005f006400650062007500670000000000ffffffff0000000000000000fb00000018006300610076006900740079005f006400650062007500670000000000ffffffff0000000000000000fb00000020006c0069006e0065005f00740072006100630069006e0067005f0072006700620000000000ffffffff0000000000000000fb0000001600640065006200750067005f0069006d0061006700650000000000ffffffff0000000000000000fb00000012007200610077005f0069006d00610067006500000002e2000000c90000000000000000000000010000010f00000364fc0200000003fb0000001e0054006f006f006c002000500072006f00700065007200740069006500730100000041000000780000000000000000fb0000000a00560069006500770073010000004700000364000000c200fffffffb0000001200530065006c0065006300740069006f006e010000025a000000b200000000000000000000000200000490000000a9fc0100000001fb0000000a00560069006500770073030000004e00000080000002e100000197000000030000078000000040fc0100000002fb0000000800540069006d00650100000000000007800000045a00fffffffb0000000800540069006d006501000000000000045000000000000000000000043e0000036400000004000000040000000800000008fc0000000100000002000000010000000a0054006f006f006c00730100000000ffffffff0000000000000000
1599
+ Selection:
1600
+ collapsed: false
1601
+ Time:
1602
+ collapsed: false
1603
+ Tool Properties:
1604
+ collapsed: false
1605
+ Views:
1606
+ collapsed: false
1607
+ Width: 1920
1608
+ X: 1920
1609
+ Y: 0
1610
+ cavity_debug:
1611
+ collapsed: false
1612
+ debug_image:
1613
+ collapsed: false
1614
+ line_tracing_rgb:
1615
+ collapsed: false
1616
+ mm_rgb_debug:
1617
+ collapsed: false
1618
+ raw_image:
1619
+ collapsed: false
1620
+ yolo_debug:
1621
+ collapsed: false
data/docker-compose.yml ADDED
@@ -0,0 +1,9 @@
 
 
 
 
 
 
 
 
 
 
1
+ version: '2'
2
+ services:
3
+ mas_industrial_robotics:
4
+ build:
5
+ dockerfile: images/mas_industrial_robotics/Dockerfile
6
+ context: .
7
+ args:
8
+ ROS_DISTRO: ${ROS_DISTRO}
9
+ image: ghcr.io/b-it-bots/mas_industrial_robotics/industrial-${ROS_DISTRO}:${IMAGE_TAG}
data/docs/Makefile ADDED
@@ -0,0 +1,20 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Minimal makefile for Sphinx documentation
2
+ #
3
+
4
+ # You can set these variables from the command line, and also
5
+ # from the environment for the first two.
6
+ SPHINXOPTS ?=
7
+ SPHINXBUILD ?= sphinx-build
8
+ SOURCEDIR = source
9
+ BUILDDIR = build
10
+
11
+ # Put it first so that "make" without argument is like "make help".
12
+ help:
13
+ @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14
+
15
+ .PHONY: help Makefile
16
+
17
+ # Catch-all target: route all unknown targets to Sphinx using the new
18
+ # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19
+ %: Makefile
20
+ @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
data/docs/make.bat ADDED
@@ -0,0 +1,35 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ @ECHO OFF
2
+
3
+ pushd %~dp0
4
+
5
+ REM Command file for Sphinx documentation
6
+
7
+ if "%SPHINXBUILD%" == "" (
8
+ set SPHINXBUILD=sphinx-build
9
+ )
10
+ set SOURCEDIR=source
11
+ set BUILDDIR=build
12
+
13
+ if "%1" == "" goto help
14
+
15
+ %SPHINXBUILD% >NUL 2>NUL
16
+ if errorlevel 9009 (
17
+ echo.
18
+ echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
19
+ echo.installed, then set the SPHINXBUILD environment variable to point
20
+ echo.to the full path of the 'sphinx-build' executable. Alternatively you
21
+ echo.may add the Sphinx directory to PATH.
22
+ echo.
23
+ echo.If you don't have Sphinx installed, grab it from
24
+ echo.http://sphinx-doc.org/
25
+ exit /b 1
26
+ )
27
+
28
+ %SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
29
+ goto end
30
+
31
+ :help
32
+ %SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
33
+
34
+ :end
35
+ popd
data/docs/requirements.txt ADDED
@@ -0,0 +1,2 @@
 
 
 
1
+ sphinx==7.1.2
2
+ sphinx-rtd-theme==1.3.0rc1
data/docs/source/conf.py ADDED
@@ -0,0 +1,73 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Configuration file for the Sphinx documentation builder.
2
+ #
3
+ # This file only contains a selection of the most common options. For a full
4
+ # list see the documentation:
5
+ # https://www.sphinx-doc.org/en/master/usage/configuration.html
6
+
7
+ # -- Path setup --------------------------------------------------------------
8
+
9
+ # If extensions (or modules to document with autodoc) are in another directory,
10
+ # add these directories to sys.path here. If the directory is relative to the
11
+ # documentation root, use os.path.abspath to make it absolute, like shown here.
12
+ #
13
+ import os
14
+ import subprocess
15
+
16
+ # sys.path.insert(0, os.path.abspath('.'))
17
+
18
+ current_file_dir = os.path.dirname(os.path.realpath(__file__))
19
+
20
+
21
+ def get_git_short_hash():
22
+ rc = subprocess.check_output(["git", "rev-parse", "--short", "HEAD"])
23
+ rc = rc.decode("utf-8").strip()
24
+ return rc
25
+
26
+
27
+ # -- Project information -----------------------------------------------------
28
+ project = "MAS Industrial Robotics"
29
+ copyright = "2022, www.b-it-bots.de"
30
+ author = "www.b-it-bots.de"
31
+
32
+ # The full version, including alpha/beta/rc tags
33
+ # current_hash = get_git_short_hash()
34
+ current_hash = "Noetic"
35
+ version = "latest ({})".format(current_hash)
36
+ release = version
37
+
38
+
39
+ # -- General configuration ---------------------------------------------------
40
+ # Add any Sphinx extension module names here, as strings. They can be
41
+ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
42
+ # ones.
43
+ extensions = ["sphinx.ext.autodoc"]
44
+
45
+ # Add any paths that contain templates here, relative to this directory.
46
+ templates_path = ["_templates"]
47
+
48
+ # List of patterns, relative to source directory, that match files and
49
+ # directories to ignore when looking for source files.
50
+ # This pattern also affects html_static_path and html_extra_path.
51
+ exclude_patterns = []
52
+
53
+
54
+ # -- Options for HTML output -------------------------------------------------
55
+ # The theme to use for HTML and HTML Help pages. See the documentation for
56
+ # a list of builtin themes.
57
+ #
58
+ html_theme = "sphinx_rtd_theme"
59
+ theme_path = os.path.join(
60
+ current_file_dir, "..", "..", "third_party", "sphinx_rtd_theme"
61
+ )
62
+ html_theme_path = [
63
+ theme_path,
64
+ ]
65
+
66
+ # Add any paths that contain custom static files (such as style sheets) here,
67
+ # relative to this directory. They are copied after the builtin static files,
68
+ # so a file named "default.css" will overwrite the builtin "default.css".
69
+ html_static_path = []
70
+
71
+ # Master document should be index.rst instead of contents.rst
72
+ # https://github.com/readthedocs/readthedocs.org/issues/2569#issuecomment-485117471
73
+ master_doc = "index"
data/docs/source/contributing/coding_style.rst ADDED
@@ -0,0 +1,219 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ .. _coding_style:
2
+
3
+ Coding guidelines
4
+ =================
5
+
6
+ .. note::
7
+
8
+ Make sure that your text editor is properly configured to use **spaces** instead of tabs.
9
+ All C/C++ code should be written and formatted according to the **Google style guide** (with an exception to column limit
10
+ and breaking braces.
11
+ See `.clang-format <https://github.com/b-it-bots/mas_industrial_robotics/blob/kinetic/.clang-format>`_ for more details).
12
+ All Python code should adhere to the **PEP-8 style guide**.
13
+
14
+ .. _style-label:
15
+
16
+ Coding style
17
+ ------------
18
+
19
+ C/C++
20
+ ^^^^^
21
+
22
+ * Linting
23
+
24
+ `cpplint <https://github.com/cpplint/cpplint>`_ is used to lint C++ code according to the
25
+ `Google style guide <https://google.github.io/styleguide/cppguide.html>`_.
26
+ cpplint can be installed using pip (in a python 3.7 environment)
27
+
28
+ .. code-block:: bash
29
+
30
+ pip install cpplint
31
+
32
+ Run cpplint on a file/directory as follows
33
+
34
+ .. code-block:: bash
35
+
36
+ cpplint <filename/directory>
37
+
38
+
39
+ * Code formatting
40
+
41
+ `Clang format <https://clang.llvm.org/docs/ClangFormat.html>`_ is used to format C/C++ code.
42
+ Install clang format as follows.
43
+
44
+ .. code-block:: bash
45
+
46
+ sudo apt-get install clang-format
47
+
48
+ All configurations are present in .clang-format file and its is mandatory to use this file to format
49
+ the code in this repository.
50
+ Please note that it is necessary to run clang-format from the repository's root folder so that it
51
+ uses the repository's .clang-format file. To run clang-format on a single C++ file, use
52
+
53
+ .. code-block:: bash
54
+
55
+ clang-format -i <C++ filename>
56
+
57
+ To run clang-format on files inside a directory recursively, use
58
+
59
+ .. code-block:: bash
60
+
61
+ find . -regex '.*\.\(cpp\|hpp\|cu\|c\|h\)' -exec clang-format -i {} \;
62
+
63
+ * Static code analysis
64
+
65
+ `Cppcheck <http://cppcheck.sourceforge.net/>`_ is used for static code analysis in order to detect
66
+ bugs and undefined behaviors due to bad coding constructs. Install cppcheck using
67
+
68
+ .. code-block:: bash
69
+
70
+ sudo apt-get install cppcheck
71
+
72
+ To run cppcheck on a file or directory, run
73
+
74
+ .. code-block:: bash
75
+
76
+ cppcheck <filename/directory>
77
+
78
+
79
+
80
+ Python
81
+ ^^^^^^
82
+
83
+ * Linting
84
+
85
+ Python code should follow the `PEP-8 <https://www.python.org/dev/peps/pep-0008/>`_ style guide.
86
+ Installing linters in your python environment ensures compliance with the PEP-8 style guide.
87
+ The precommit hooks for this repository uses pylint in a **python 3.7 environment** and can lint
88
+ python 2 code. Pylint can
89
+ be easily installed using pip.
90
+
91
+ .. code-block:: bash
92
+
93
+ pip install pylint
94
+
95
+ In order to analyze file/s for linting errors, manually run pylint using the following command.
96
+
97
+ .. code-block:: bash
98
+
99
+ pylint <python filename or directory name>
100
+
101
+ * Sorting imports
102
+
103
+ `isort <https://timothycrosley.github.io/isort/>`_ organizes and sorts imports in python files.
104
+ Install isort using pip.
105
+
106
+ .. code-block:: bash
107
+
108
+ pip install isort
109
+
110
+ To run isort on a python file use
111
+
112
+ .. code-block:: bash
113
+
114
+ isort <python filename>
115
+
116
+ * Code formatter
117
+
118
+ `Black <https://black.readthedocs.io/en/stable/installation_and_usage.html>`_ is used to format python
119
+ code. Please ensure that your code is formatted using black before committing your changes.
120
+ Black can be installed using pip (again in a **python 3.7 environment**).
121
+
122
+ .. code-block:: bash
123
+
124
+ pip install black
125
+
126
+ To format existing python code using black, run the following
127
+
128
+ .. code-block:: bash
129
+
130
+ black <python filename/directory>
131
+
132
+
133
+ .. note::
134
+
135
+ `Pre-commit <https://pre-commit.com/#intro>`_ hooks has been added to this repository.
136
+ Please note that you will not be able to locally commit your changes to git until all the
137
+ checks in the .pre-commit-config.yaml pass. Some serious violations of the standard coding
138
+ guidelines will result in errors while running git commit and have to be manually fixed.
139
+ **Users will not be able to commit their code, until these errors are fixed.**
140
+ Please ensure that **git commit** or **pre-commit hooks** (and not the code itself) is run in a **python 3.7 environment**
141
+ as configured in .pre-commit-config.yaml.
142
+
143
+ .. warning::
144
+
145
+ Alternatively, one could also verify if the pre-commit hooks pass before actually committing
146
+ the code to git. To do so please run the following command after making necessary changes to
147
+ your code.
148
+
149
+ .. code-block:: bash
150
+
151
+ pre-commit run --all-files
152
+
153
+ This is however currently discouraged because there are several linting errors in the whole
154
+ repository yet to be fixed and one doesn't want to end up fixing thousands of errors when
155
+ just trying to add their contribution.
156
+
157
+
158
+ Editors for software development
159
+ --------------------------------
160
+
161
+ * Visual Studio Code
162
+ * Vim
163
+ * Pycharm
164
+
165
+ Install the necessary python, C++ and ROS plugins after installing a desired editor.
166
+ Other editors which support ROS are listed `here <http://wiki.ros.org/IDEs>`_.
167
+
168
+ Configuring editors
169
+ ^^^^^^^^^^^^^^^^^^^
170
+
171
+ It is important to configure your editor settings so that linters, code formatters and
172
+ code checkers check for errors (and solve them if possible) automatically upon saving
173
+ your changes in a file.
174
+ Below is an illustration of the settings configurations that need to modified in Visual Studio Code to avoid
175
+ manually performing the checks described in :ref:`style-label`. Similar configurations can be done in
176
+ other editors too.
177
+
178
+ The settings can be configured through the Settings option in File menu or in
179
+ settings.json.
180
+
181
+ * Python linting
182
+ By default pylint is enabled in Visual Studio Code, however pylint has to be installed
183
+ using pip in your chosen python interpreter path. Please do not enable other linters as
184
+ this could create a conflict while running pre-commit hooks. Please checkout the
185
+ `VS Code website <https://code.visualstudio.com/docs/python/linting>`_ for more information.
186
+
187
+ * Python code formatting
188
+ Since pre-commit hooks uses black to format python code, this can be very conveniently
189
+ added to your editor so that the file is auto-formatted by black upon saving. Add the following
190
+ to your settings.json to enable black code formatting.
191
+
192
+ .. code-block:: bash
193
+
194
+ "python.formatting.blackArgs": [
195
+ "--line-length=79"
196
+ ],
197
+ "python.formatting.provider": "black",
198
+ "[python]": {
199
+ "editor.codeActionsOnSave": {
200
+ "source.organizeImports": true
201
+ }
202
+ },
203
+
204
+ * C++ linting
205
+ Install the cpplint extension to VS Code to enable the cpplinter. This then highlights the linting
206
+ errors in the C++ code with squiggly lines.
207
+
208
+ * C++ code formatting
209
+ Clang-format is used to format C++ code. This can be configured in settings.json
210
+ after installing the official Microsoft C/C++ extension. Add the following lines to your
211
+ settings.json file so that the configurations from .clang-format in the repository are
212
+ used by VS Code to format the C++ files.
213
+
214
+ .. code-block:: bash
215
+
216
+ "C_Cpp.clang_format_style": "file",
217
+ "C_Cpp.formatting": "clangFormat"
218
+
219
+
data/docs/source/contributing/index.rst ADDED
@@ -0,0 +1,10 @@
 
 
 
 
 
 
 
 
 
 
 
1
+ .. _contributing:
2
+
3
+ Contributing
4
+ ############
5
+
6
+ .. toctree::
7
+
8
+ ros
9
+ coding_style
10
+ toolkit
data/docs/source/contributing/ros.rst ADDED
@@ -0,0 +1,187 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ .. _contributing_ros:
2
+
3
+ Robot Operating System (ROS)
4
+ =============================
5
+
6
+ ROS packages naming and structure
7
+ ----------------------------------
8
+
9
+ Creating a new package
10
+ ^^^^^^^^^^^^^^^^^^^^^^^
11
+
12
+ * Naming
13
+
14
+ In order to create a new ROS package for one of the repositories some rules need to be considered:
15
+
16
+ 1. The package name has always the following format:
17
+
18
+ .. code-block:: bash
19
+
20
+ prefix_my_package_name
21
+
22
+ 2. Use the right prefix for every repository:
23
+
24
+ a. mas_domestic_robotics: *mdr_*
25
+ b. mas_industrial_robotics: *mir_*
26
+ c. mas_common_robotics: *mcr_*
27
+
28
+ 3. Use lowercase.
29
+ 4. Separate words in the package name by underscores (_).
30
+
31
+ Examples for creating packages according to the above described rules are as follows:
32
+
33
+ .. code-block:: bash
34
+
35
+ catkin create_pkg mdr_grasp_planning
36
+ catkin create_pkg mir_whole_body_control
37
+ catkin create_pkg mcr_object_detection
38
+
39
+ * Folder structure
40
+
41
+ Every ROS package within our repositories has to strictly match the following structure:
42
+
43
+ .. code-block:: bash
44
+
45
+ .
46
+ ├── common
47
+ │ ├── config
48
+ │ ├── include
49
+ │ │ └── <package_name>
50
+ │ ├── src
51
+ │ │ └── <package_name>
52
+ │ ├── test
53
+ │ └── tools
54
+ ├── ros
55
+ │ ├── config
56
+ │ ├── include
57
+ │ │ └── <package_name>
58
+ │ ├── launch
59
+ │ │ └── <package_name>.launch
60
+ │ ├── rviz
61
+ │ │ └── <package_name>.rviz
62
+ │ ├── scripts
63
+ │ │ └── <package_name>
64
+ │ ├── src
65
+ │ │ └── <package_name>_node
66
+ │ ├── test
67
+ │ └── tools
68
+ ├── CMakeLists.txt
69
+ ├── package.xml
70
+ ├── setup.py
71
+ └── README.md
72
+
73
+ In short:
74
+ * ROS-independent code goes into the `common` folder
75
+ * the `ros` folder contains a ROS-wrapper for the functionality you are adding
76
+
77
+ Meta-packages
78
+ ^^^^^^^^^^^^^^
79
+
80
+ If the package you are creating is meant to contain other packages inside of it, it needs to have instead the following structure:
81
+
82
+ .. code-block:: bash
83
+
84
+ ./<meta_package_name>
85
+ └── <meta_package_name>
86
+ ├── CMakeLists.txt
87
+ ├── package.xml
88
+ └── README.md
89
+
90
+ .. note::
91
+
92
+ It is **extremely** important to maintain your *package.xml* up to date with its dependencies.
93
+ Not doing so results in the need of specialized tools or manual inspection of launch files and
94
+ source code to discover your package dependencies.
95
+
96
+ Messages, services and actions
97
+ -------------------------------
98
+
99
+ Creating a new message, service or action.
100
+ If your package defines its own messages, services or actions you should add them to the corresponding meta-package:
101
+
102
+ .. code-block:: bash
103
+
104
+ ./<package_name>_msgs
105
+ ├── action
106
+ │ ├── MyAction.action
107
+ ├── msg
108
+ │ ├── MyMessage.msg
109
+ ├── srv
110
+ │ └── MyService.srv
111
+ ├── CMakeLists.txt
112
+ ├── package.xml
113
+ └── README.md
114
+
115
+ .. note::
116
+
117
+ The *srv* file name should start with verb i.e. *RecognizeImage.srv*
118
+
119
+ Depending on the repository you are working on, the meta-package is related to the domain, e.g. *mdr_planning_msgs* or *mdr_navigation_actions*
120
+
121
+ Linting
122
+ --------
123
+
124
+ Running **roslint** with catkin
125
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
126
+
127
+ Before merging into the main repository *roslint* is ran on all merge requests.
128
+ Unless all errors are resolved the merge request will be rejected. To test if your changes would pass the *roslint* test locally:
129
+
130
+ * Add the following lines to your `CMakelists.txt`:
131
+
132
+ .. code-block:: bash
133
+
134
+ find_package(catkin REQUIRED COMPONENTS roslint ...)
135
+
136
+ roslint_python() # pep8 linting
137
+ roslint_cpp() # ROS wrapper of Google's cpplint
138
+
139
+ Your *package.xm* should include *roslint* as a build dependency:
140
+
141
+ .. code-block:: bash
142
+
143
+ <build_depend>roslint</build_depend>
144
+
145
+ * Build target roslint:
146
+
147
+ * with `catkin_make`:
148
+
149
+ .. code-block:: bash
150
+
151
+ catkin_make roslint_<package_name>
152
+
153
+ * with `catkin_tools`:
154
+
155
+ .. code-block:: bash
156
+
157
+ catkin build --no-deps <package_name> --make-args roslint_<package_name>
158
+
159
+ * If build fail copy and execute the gray line that looks something like the following to see more detailed errors:
160
+
161
+ .. code-block:: bash
162
+
163
+ cd <package_source_directory>
164
+ catkin build --get-env <package_name> | catkin env -si /usr/bin/make roslint --jobserver-fds=6,7 -j; cd -
165
+
166
+
167
+ Running **catkin_lint**
168
+ ^^^^^^^^^^^^^^^^^^^^^^^^^
169
+
170
+ You should also make sure that the *catkin_lint* tests pass;
171
+ running it from the root of your catkin workspace you can run:
172
+
173
+ .. code-block:: bash
174
+
175
+ catkin_lint --strict --ignore CRITICAL_VAR_APPEND,LINK_DIRECTORY src/mas_domestic_robotics
176
+
177
+
178
+ See Also:
179
+
180
+ * `roslint <http://wiki.ros.org/roslint>`_
181
+ * `catkin_lint <http://fkie.github.io/catkin_lint/>`_
182
+
183
+ Proposed linters:
184
+
185
+ * `C++ <https://github.com/cpplint/cpplint>`_
186
+ * `Python <https://www.pylint.org/>`_
187
+ * `ROS <http://wiki.ros.org/roslint>`_
data/docs/source/contributing/toolkit.rst ADDED
@@ -0,0 +1,4 @@
 
 
 
 
 
1
+ .. _toolkit:
2
+
3
+ Toolkit
4
+ ========
data/docs/source/docker.rst ADDED
@@ -0,0 +1,130 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ .. _docker:
2
+
3
+ Docker
4
+ ######
5
+
6
+ The latest versions of docker-engine and docker-compose have to be installed
7
+ before getting started. Please have a look at `docker's official website <https://docs.docker.com/get-started/overview/>`_
8
+ for more insights into the working and usage of docker images and docker containers.
9
+
10
+ It is highly recommended that you use docker containers to build and run your
11
+ nodes rather than directly installing ROS and working with the MAS industrial software on your PC.
12
+
13
+ .. _using_mir_docker_images:
14
+
15
+ Using Our Images
16
+ ================
17
+
18
+ Our docker images are available `here <https://github.com/orgs/b-it-bots/packages>`_.
19
+ The images provide a proper development environment -with ros pre-installed and without
20
+ any missing dependencies- for the MAS industrial software. Additionally, the images
21
+ also contain src packages which are prebuilt.
22
+
23
+ Directory structure in the image:
24
+
25
+ .. code-block:: bash
26
+
27
+ /home/robocup/<ros_distro>/catkin_ws
28
+ ├── build
29
+ ├── devel
30
+ ├── logs
31
+ ├── src
32
+ ├── mas_industrial_robotics
33
+ ├── mas_perception_msgs
34
+ ├── mas_navigation
35
+ ├── ...
36
+
37
+ Where `ros_distro` corresponds to the ros distribution i.e. `kinetic, melodic`.
38
+
39
+ The main github branch of the each ros distro should always reflect `latest`
40
+ tag in the github registry, for example `kinetic` branch reflects
41
+ `mas_industrial_robotics/industrial-kinetic:latest`, while the `devel` branch
42
+ always reflects `devel` tag, for example `kinetic` branch reflects `mas_industrial_robotics/industrial-kinetic:devel`
43
+
44
+ * **Start the container**
45
+
46
+ To start the container, `docker-compose <https://docs.docker.com/compose/install/>`_
47
+ is required, with which it is easier to define the environment and volumes from
48
+ the host PC to the container.
49
+
50
+ .. code-block:: bash
51
+
52
+ docker-compose -f start-container.yaml up industrial_<ros_distro>
53
+
54
+ If there is no local image, docker will automatically pull from MIR github
55
+ container registry.
56
+
57
+ The images can also be pulled manually without docker-compose.
58
+
59
+ .. code-block:: bash
60
+
61
+ #kinetic image
62
+ docker pull ghcr.io/b-it-bots/mas_industrial_robotics/industrial-kinetic:latest
63
+
64
+ #melodic image
65
+ docker pull ghcr.io/b-it-bots/mas_industrial_robotics/industrial-melodic:latest
66
+
67
+ * **Log in to the container**
68
+
69
+ .. code-block:: bash
70
+
71
+ docker exec -it mas_industrial_robotics_industrial_kinetic_1 /bin/bash
72
+
73
+ .. tip::
74
+
75
+ The container is set up to use `host` network, and therefore when you run
76
+ roscore or ros packages in either host or container, and both will have access
77
+ to ros communication infrastructure such as topics and services.
78
+
79
+
80
+ .. _mounting_volumes:
81
+
82
+ Mounting Local Volumes
83
+ ======================
84
+
85
+ Since the codes in the image are not persistent, which means they will be
86
+ removed when the images are rebuilt, it is recommended to mount your local disk
87
+ containing the repository to the container.
88
+
89
+ To mount your local disk to the container, you need to modify `start-container.yaml`
90
+ under `mas_industrial_robotics` repository. The following example shows how you
91
+ can mount your `rviz` configuration and `mas_industrial_robotics` repository which
92
+ is mounted to `/home/robocup/<ros_distro>/catkin_ws/src/external` in the container.
93
+
94
+ .. code-block:: yaml
95
+
96
+ # under volume add your local disk
97
+ volumes:
98
+ - $HOME/.rviz:/home/robocup/.rviz
99
+ - $HOME/catkin_ws/mas_industrial_robotics:/home/robocup/<ros_distro>/catkin_ws/src/external/mas_industrial_robotics
100
+
101
+ Since there are now two `mas_industrial_robotics` repositories, you have to do
102
+ the followings to make the build successful:
103
+
104
+ * Remove or `CATKIN_IGNORE` the repository that comes with the image under `src/mas_industrial_robotics`.
105
+ * `catkin clean` to remove the prebuilt packages from the image
106
+ * Rebuild the package e.g. `catkin build mir_object_recognition`
107
+
108
+ Now, you can make changes locally in your PC using your favourite IDE, and build
109
+ the package inside the container.
110
+
111
+ .. note::
112
+
113
+ This was only tested with Linux.
114
+
115
+
116
+ .. _creating_own_image:
117
+
118
+ Creating Your Own Image
119
+ =======================
120
+
121
+ You can create your own image by using b-it-bots image as base:
122
+
123
+ .. code-block:: bash
124
+
125
+ FROM ghcr.io/b-it-bots/mas_industrial_robotics/industrial-melodic:latest
126
+
127
+ USER robocup
128
+
129
+ # add your modification e.g. install tensorflow
130
+ RUN pip install tensorflow
data/docs/source/getting_started.rst ADDED
@@ -0,0 +1,205 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ .. _getting_started:
2
+
3
+ Getting started
4
+ ###############
5
+
6
+ .. _install_ubuntu:
7
+
8
+ Install Ubuntu
9
+ ==============
10
+
11
+ The repository and its related components have been tested under the following Ubuntu distributions:
12
+
13
+ - ROS Kinetic: Ubuntu 16.04
14
+ - ROS Melodic: Ubuntu 18.04
15
+ - ROS Noetic: Ubuntu 20.04
16
+
17
+ If you do not have a Ubuntu distribution on your computer you can download it `here <http://www.ubuntu.com/download>`_.
18
+
19
+ .. _git_version_control:
20
+
21
+ Git - Version Control
22
+ =====================
23
+
24
+ * Install Git Software
25
+
26
+ Install the Git core components and some additional GUI's for the version control:
27
+
28
+ .. code-block:: bash
29
+
30
+ sudo apt-get install git-core gitg gitk
31
+
32
+ * Set Up Git
33
+
34
+ Now it's time to configure your settings. To do this you need to open a new Terminal. First you need to tell git your name, so that it can properly label the commits you make:
35
+
36
+ .. code-block:: bash
37
+
38
+ git config --global user.name "Your Name Here"
39
+
40
+ Git also saves your email address into the commits you make.
41
+
42
+ .. code-block:: bash
43
+
44
+ git config --global user.email "[email protected]"
45
+
46
+
47
+ * GIT Tutorial
48
+ If you have never worked with git before, we recommend to go through the
49
+ `basic git tutorial <http://excess.org/article/2008/07/ogre-git-tutorial/>`_.
50
+
51
+ .. _getting_started_docker:
52
+
53
+ Docker (Recommended)
54
+ ====================
55
+
56
+ To be able to use our software independent of the operating system and/or ROS
57
+ distribution, it is recommended to use docker. You can follow
58
+ :ref:`this tutorial <docker>` to use docker.
59
+
60
+ .. _robot_operating_system:
61
+
62
+ ROS - Robot Operating System
63
+ ============================
64
+
65
+ * Install ROS
66
+
67
+ The repository has been tested successfully with the following ROS distributions.
68
+ Use the link behind a ROS distribution to get to the particular
69
+ `ROS Kinetic installation instructions <http://wiki.ros.org/noetic/Installation/Ubuntu>`_.
70
+
71
+ .. note::
72
+ Do not forget to update your .bashrc!
73
+
74
+ * ROS Tutorials
75
+
76
+ If you have never worked with ROS before, we recommend to go through
77
+ `the beginner tutorials provided by ROS <http://wiki.ros.org/ROS/Tutorials>`_.
78
+
79
+ In order to understand at least the different core components of ROS, you have to start from tutorial 1 ("Installing and Configuring Your ROS Environment") till tutorial 7 ("Understanding ROS Services and Parameters").
80
+
81
+ .. _setup_catkin_workspace:
82
+
83
+ Setup catkin workspace
84
+ =========================
85
+
86
+ * Create a catkin workspace
87
+
88
+ .. code-block:: bash
89
+
90
+ source /opt/ros/noetic/setup.bash
91
+ mkdir -p ~/noetic/src; cd ~/noetic/src
92
+ catkin_init_workspace
93
+ catkin build
94
+
95
+ * Clone and compile the MAS industrial robotics software
96
+
97
+ First of all you have to clone the repository.
98
+
99
+ .. code-block:: bash
100
+
101
+ cd ~/noetic/src;
102
+ git clone [email protected]:b-it-bots/mas_industrial_robotics.git
103
+
104
+ Then go on with installing further external dependencies:
105
+
106
+ .. code-block:: bash
107
+
108
+ cd ~/noetic/src/mas_industrial_robotics
109
+ ./repository.debs
110
+ source ~/noetic/devel/setup.bash
111
+
112
+ The last command should be added to the ~/.bashrc file so that they do not need to be executed everytime you open a new terminal.
113
+
114
+ And finally compile the repository:
115
+
116
+ .. code-block:: bash
117
+
118
+ cd ~/noetic
119
+ catkin build
120
+
121
+ If no errors appear everything is ready to use. Great job!
122
+
123
+ * Setting the Environment Variables
124
+
125
+ * ROBOT variable
126
+
127
+ With the ROBOT variable you can choose which hardware configuration should be loaded when starting the robot. The following line will add the variable to your .bashrc:
128
+
129
+ .. code-block:: bash
130
+
131
+ echo "export ROBOT=youbot-brsu-1" >> ~/.bashrc
132
+ source ~/.bashrc
133
+
134
+ * ROBOT_ENV Variable
135
+
136
+ The ROBOT_ENV variable can be used to switch between different environments. The following line will add the variable to your .bashrc:
137
+
138
+ * Real robot
139
+
140
+ .. code-block:: bash
141
+
142
+ echo "export ROBOT_ENV=brsu-c025" >> ~/.bashrc
143
+ source ~/.bashrc
144
+
145
+ * Simulation
146
+
147
+ .. code-block:: bash
148
+
149
+ echo "export ROBOT_ENV=brsu-c025-sim" >> ~/.bashrc
150
+ source ~/.bashrc
151
+
152
+ .. _bringup_robot:
153
+
154
+ Bring up the robot and its basic components
155
+ ===========================================
156
+
157
+ * In Simulation
158
+
159
+ .. code-block:: bash
160
+
161
+ roslaunch mir_bringup_sim robot.launch
162
+
163
+ In a new terminal you can open the Gazebo GUI to see the environment and the robot
164
+
165
+ .. code-block:: bash
166
+
167
+ rosrun gazebo_ros gzclient
168
+
169
+ * At the Real Robot
170
+
171
+ .. code-block:: bash
172
+
173
+ roslaunch mir_bringup robot.launch
174
+
175
+
176
+ * Test the base
177
+
178
+ .. code-block:: bash
179
+
180
+ roslaunch mir_teleop teleop_keyboard.launch
181
+
182
+
183
+ * Visualize the robot state and sensor data
184
+
185
+ .. code-block:: bash
186
+
187
+ rosrun rviz rviz
188
+
189
+
190
+ * Build a map for base navigation
191
+
192
+ .. code-block:: bash
193
+
194
+ roslaunch mir_2dslam 2dslam.launch
195
+
196
+
197
+ * Use autonomous navigation
198
+
199
+ * Omni-directional navigation
200
+
201
+ .. code-block:: bash
202
+
203
+ roslaunch mir_2dnav 2dnav.launch nav_mode:=dwa
204
+
205
+ Click on the menu bar "File -> Open Config", navigate to "~/noetic/src/mas_industrial_robotics" and select the "youbot.rviz" file.
data/docs/source/images/youbot_annotated.png ADDED

Git LFS Details

  • SHA256: 439de6728f4ad048c68956abf059be3847c9f9a9a0cb74972ec1586fa021b713
  • Pointer size: 131 Bytes
  • Size of remote file: 619 kB
data/docs/source/index.rst ADDED
@@ -0,0 +1,42 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ .. MAS Industrial Robotics documentation master file, created by
2
+ sphinx-quickstart on Mon Dec 2 09:12:52 2019.
3
+ You can adapt this file completely to your liking, but it should at least
4
+ contain the root `toctree` directive.
5
+
6
+ MAS Industrial Robotics
7
+ =======================
8
+
9
+ .. toctree::
10
+ :maxdepth: 2
11
+
12
+ introduction
13
+ getting_started
14
+ contributing/index.rst
15
+
16
+ .. toctree::
17
+ :maxdepth: 2
18
+ :caption: Tutorial
19
+
20
+ docker
21
+ mir_perception/index.rst
22
+ mir_manipulation/index.rst
23
+ mir_navigation/index.rst
24
+ mir_planning/index.rst
25
+ mir_simulation/index.rst
26
+ infrastructure
27
+
28
+ .. toctree::
29
+ :maxdepth: 2
30
+ :caption: Task
31
+
32
+ tasks/bmt/bmt_demo.rst
33
+
34
+ .. toctree::
35
+ :maxdepth: 2
36
+ :caption: Documentation
37
+
38
+ mir_perception/docstring/index.rst
39
+ mir_manipulation/docstring/index.rst
40
+ mir_navigation/docstring/index.rst
41
+ mir_planning/docstring/index.rst
42
+ mir_simulation/docstring/index.rst
data/docs/source/infrastructure.rst ADDED
@@ -0,0 +1,73 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ .. _infrastructure:
2
+
3
+ Infrastructure
4
+ ##############
5
+
6
+
7
+ C025 Hub Server
8
+ ===============
9
+
10
+ You can use our workstation in C025 lab if you need computing facilities such as
11
+ GPU, but the available resouces are limited with 24 cores of CPU, 40GB RAM, and 2x
12
+ Nvidia 3090 with 24 GB GPU memory each. However, if you need more resources, please request
13
+ access to `the university HPC cluster <https://wr0.wr.inf.h-brs.de/wr/index.html>`_.
14
+
15
+ We also provide a JupyterHub server on the workstation so that you do not have to
16
+ setup the environment.
17
+
18
+ Hub Server
19
+ ----------
20
+
21
+ The address of the JupyterHub server is `https://10.20.118.78:32025 <https://10.20.118.78:32025>`_ and
22
+ LDAP is used for the login.
23
+
24
+ Multiple environments can be provided and is described in `here <https://github.com/b-it-bots/docker>`_.
25
+ You can choose the one that meets your needs or PR to the aforementioned repository
26
+ if you need to update the libraries. We can, of course, provide more environment
27
+ options as per request.
28
+
29
+ `Deep Learning env with Tensorflow and Pytorch` is default environment and contains
30
+ several deep learning libraries defined in `gpu-notebook <https://github.com/b-it-bots/docker/tree/master/gpu-notebook>`_.
31
+ The GPUs are accessible by all authorized users and there is no individual GPU resouce
32
+ allocation.
33
+
34
+ Access
35
+ ------
36
+
37
+ In order to get access to the hub, we need to add your LDAP username.
38
+
39
+ .. hint::
40
+
41
+ Admins can add new users by going to admin page `https://10.20.118.78:32025/hub/admin <https://10.20.118.78:32025/hub/admin>`_.
42
+
43
+ * Within the university network:
44
+
45
+ You can access the hub directly from the university network.
46
+
47
+ * Remote access
48
+
49
+ * University VPN
50
+
51
+ Follow `this instruction <https://faq.infcs.de/vpn>`_ to setup VPN
52
+ in your local machine. Once you are connected to the university VPN, you can
53
+ open the Hub address.
54
+
55
+ * SSH tunnel
56
+
57
+ If you do not want to use VPN, you can port forward from your FB02 account to
58
+ C025 workstation
59
+
60
+ .. code-block:: bash
61
+
62
+ # replace account2s with your FBUID
63
+ ssh -L 32025:10.20.118.78:32025 [email protected]
64
+
65
+ Then, open browser and go to `https://localhost:32025 <https://localhost:32025>`_.
66
+
67
+ .. note::
68
+
69
+ SSH access to the workstation is only possible with ssh key, so if you need it,
70
+ please send us your ssh key.
71
+
72
+ University Cluster
73
+ ==================
data/docs/source/introduction.rst ADDED
@@ -0,0 +1,5 @@
 
 
 
 
 
 
1
+ .. _introduction:
2
+
3
+ About
4
+ ########
5
+
data/docs/source/mir_manipulation/docstring/index.rst ADDED
@@ -0,0 +1,10 @@
 
 
 
 
 
 
 
 
 
 
 
1
+ .. _mir_manipulation_docs:
2
+
3
+ Manipulation Documentation
4
+ ##########################
5
+
6
+ .. toctree::
7
+ :maxdepth: 1
8
+
9
+ mir_moveit_scene_ros.rst
10
+ mir_pregrasp_planning_ros.rst
data/docs/source/mir_manipulation/docstring/mir_moveit_scene_ros.rst ADDED
@@ -0,0 +1,20 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ .. _mir_moveit_scene_ros_docs:
2
+
3
+ mir\_moveit\_scene\_ros
4
+ =======================
5
+
6
+ mir\_moveit\_scene\_ros.attach\_grasped\_object module
7
+ ------------------------------------------------------
8
+
9
+ .. automodule:: mir_moveit_scene_ros.attach_grasped_object
10
+ :members:
11
+ :undoc-members:
12
+ :show-inheritance:
13
+
14
+ mir\_moveit\_scene\_ros.restrict\_arm\_workspace module
15
+ -------------------------------------------------------
16
+
17
+ .. automodule:: mir_moveit_scene_ros.restrict_arm_workspace
18
+ :members:
19
+ :undoc-members:
20
+ :show-inheritance:
data/docs/source/mir_manipulation/docstring/mir_pregrasp_planning_ros.rst ADDED
@@ -0,0 +1,28 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ .. _mir_pregrasp_planning_ros_docs:
2
+
3
+ mir\_pregrasp\_planning\_ros
4
+ ============================
5
+
6
+ mir\_pregrasp\_planning\_ros.pose\_mock\_up\_gui module
7
+ -------------------------------------------------------
8
+
9
+ .. automodule:: mir_pregrasp_planning_ros.pose_mock_up_gui
10
+ :members:
11
+ :undoc-members:
12
+ :show-inheritance:
13
+
14
+ mir\_pregrasp\_planning\_ros.pregrasp\_planner\_node module
15
+ -----------------------------------------------------------
16
+
17
+ .. automodule:: mir_pregrasp_planning_ros.pregrasp_planner_node
18
+ :members:
19
+ :undoc-members:
20
+ :show-inheritance:
21
+
22
+ mir\_pregrasp\_planning\_ros.simple\_pregrasp\_planner\_utils module
23
+ --------------------------------------------------------------------
24
+
25
+ .. automodule:: mir_pregrasp_planning_ros.simple_pregrasp_planner_utils
26
+ :members:
27
+ :undoc-members:
28
+ :show-inheritance:
data/docs/source/mir_manipulation/index.rst ADDED
@@ -0,0 +1,6 @@
 
 
 
 
 
 
 
1
+ .. _mir_manipulation:
2
+
3
+ Manipulation
4
+ ##############
5
+
6
+ MAS industrial robotics - manipulation tutorial
data/docs/source/mir_navigation/docstring/index.rst ADDED
@@ -0,0 +1,10 @@
 
 
 
 
 
 
 
 
 
 
 
1
+ .. _mir_navigation_docs:
2
+
3
+ Navigation Documentation
4
+ ########################
5
+
6
+ .. toctree::
7
+ :maxdepth: 1
8
+
9
+ mir_move_base_ros
10
+
data/docs/source/mir_navigation/docstring/mir_move_base_ros.rst ADDED
@@ -0,0 +1,12 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ .. _mir_move_base_ros_docs:
2
+
3
+ mir\_move\_base\_ros
4
+ ====================
5
+
6
+ mir\_move\_base\_ros.move\_base module
7
+ --------------------------------------
8
+
9
+ .. automodule:: mir_move_base_ros.move_base
10
+ :members:
11
+ :undoc-members:
12
+ :show-inheritance:
data/docs/source/mir_navigation/index.rst ADDED
@@ -0,0 +1,217 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ .. _mir_navigation:
2
+
3
+ Navigation
4
+ #############
5
+
6
+ On workstation or your PC
7
+ ==========================
8
+
9
+ * To shh the youbot (in all terminals):
10
+
11
+ .. code-block:: bash
12
+
13
+ yb4
14
+
15
+ .. note::
16
+
17
+ alias yb4=ssh -X robocup@youbot-brsu-4-pc2
18
+
19
+ * Export the youbot ssh alias
20
+
21
+ .. code-block:: bash
22
+
23
+ export_yb4
24
+
25
+ .. note::
26
+
27
+ alias export_yb4=export ROS_MASTER_URI=http://youbot-brsu-4-pc2:11311
28
+
29
+ * Run rviz
30
+
31
+ .. code-block:: bash
32
+
33
+ rosrun rviz rviz
34
+
35
+ Set the global frame to `base_link`
36
+
37
+ .. _2d_slam:
38
+
39
+ 2D SLAM
40
+ ========
41
+
42
+ * Run roscore
43
+
44
+ .. code-block:: bash
45
+
46
+ roscore
47
+
48
+ * Launch the robot
49
+
50
+ .. code-block:: bash
51
+
52
+ roslaunch mir_bringup robot.launch
53
+
54
+ * Run 2D SLAM
55
+
56
+ .. code-block:: bash
57
+
58
+ roslaunch mir_2dslam 2dslam.launch
59
+
60
+ .. note::
61
+
62
+ The map is built using the front laser's only
63
+
64
+ * Run the map saver
65
+
66
+ Go to the map configuration directory
67
+
68
+ .. code-block:: bash
69
+
70
+ roscd mcr_default_env_config
71
+
72
+ By using `ls` you can see several folders corresponding to existing environments.
73
+ You can either use an existing map or create a new one:
74
+
75
+ .. code-block:: bash
76
+
77
+ mkdir [map_name]
78
+ cd [map_name]
79
+
80
+ And then run:
81
+
82
+ .. code-block:: bash
83
+
84
+ rosrun map_server map_saver
85
+
86
+ This will create two files: a `map.pgm` and `map.yml`.
87
+
88
+ Finally, to use the map that you just created you need to check which map will be loaded by the navigation stack:
89
+
90
+ .. code-block:: bash
91
+
92
+ echo $ROBOT_ENV
93
+
94
+ If you need to change it:
95
+
96
+ .. code-block:: bash
97
+
98
+ export ROBOT_ENV=[map_name]
99
+
100
+ .. note::
101
+
102
+ Usually the `.rosc` script is used to set the environment, among other variables.
103
+
104
+ .. _2d_navigation:
105
+
106
+ 2D Navigation
107
+ ================
108
+
109
+ * Bringup the robot
110
+
111
+ First export the environment to be used:
112
+
113
+ .. code-block:: bash
114
+
115
+ export ROBOT_ENV=brsu-C025
116
+
117
+ Launch the robot:
118
+
119
+ .. code-block:: bash
120
+
121
+ roslaunch mir_bringup robot.launch
122
+
123
+ * Launch the navigation node
124
+
125
+ .. code-block:: bash
126
+
127
+ roslaunch mir_2dnav 2dnav.launch
128
+
129
+ * Launch the planning bringup
130
+
131
+ .. code-block:: bash
132
+
133
+ roslaunch mir_planning_bringup robot.launch
134
+
135
+ * Create navigation goals and orientations
136
+
137
+ First you need to create the files where goals will be saved:
138
+
139
+ .. code-block:: bash
140
+
141
+ touch navigation_goals.yaml
142
+ touch orientation_goals.yaml
143
+
144
+ * Localize the robot
145
+
146
+ In rviz:
147
+
148
+ 1. Select the 2D pose estimate
149
+ 2. Click the position near the robot
150
+ 3. Move with joystick
151
+ 4. Launch navigation tools in yb2
152
+
153
+ * Save the navigation and orientation goals
154
+
155
+ .. code-block:: bash
156
+
157
+ roscd mcr_default_env_config
158
+ cd brsu-C025
159
+ rosrun mcr_navigation_tools save_base_map_poses_to_file
160
+
161
+ * Test navigation goal using move_base
162
+
163
+ .. code-block:: bash
164
+
165
+ rosrun mir_move_base_safe move_base_safe_server.py
166
+ rosrun mir_move_base_safe move_base_safe_client_test.py [dest]
167
+
168
+ * Navigation test using refbox
169
+
170
+ .. code-block:: bash
171
+
172
+ roslaunch mir_basic_navigation_test refbox_parser.py
173
+
174
+ .. _Direct_robot_control:
175
+
176
+ Direct base controller
177
+ ======================
178
+
179
+ The direct base controller is used to perform relative motions of the robot with respect to a reference frame. It has an optional feature to stop the motions when obstacles are detected with the laser scanners.
180
+
181
+ * Bringup the robot
182
+
183
+ .. code-block:: bash
184
+
185
+ roslaunch mir_bringup robot.launch
186
+
187
+ * Launch the direct base controller
188
+
189
+ .. code-block:: bash
190
+
191
+ roslaunch mir_direct_base_controller direct_base_controller.launch
192
+
193
+
194
+ * Launch the pose mockup GUI on your PC:
195
+ .. code-block:: bash
196
+
197
+ export ROS_MASTER_URI=http://<robot_ip_address>:11311
198
+ roslaunch mir_direct_base_controller pose_mock_up_gui.launch
199
+
200
+ A GUI pop up window will appear.
201
+ Set the relative pose accordingly in the window (e.g. 0.1 in X to move forward 10 cm).
202
+
203
+ * Run rviz on your PC:
204
+
205
+ .. code-block:: bash
206
+
207
+ export ROS_MASTER_URI=http://<robot_ip_address>:11311
208
+ rviz
209
+
210
+ Set the 'Fixed Frame' to `odom`
211
+ Add a 'Pose' display and set the topic to '/mcr_navigation/direct_base_controller/input_pose'
212
+
213
+
214
+ * Publish an `e_start` event to the direct base controller node
215
+ .. code-block:: bash
216
+
217
+ rostopic pub /mcr_navigation/direct_base_controller/coordinator/event_in std_msgs/String "data: 'e_start'"
data/docs/source/mir_perception/barrier_tape.rst ADDED
@@ -0,0 +1,4 @@
 
 
 
 
 
1
+ .. _barrier_tape:
2
+
3
+ Barrier tape detection
4
+ ======================
data/docs/source/mir_perception/camera.rst ADDED
@@ -0,0 +1,207 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ .. _camera:
2
+
3
+ Camera
4
+ =======
5
+
6
+ Tower-mount camera calibration
7
+ -----------------------
8
+
9
+ On workstation or your PC
10
+
11
+ 1. To shh the youbot (in all terminals):
12
+
13
+ .. code-block:: bash
14
+
15
+ yb2
16
+
17
+ .. note::
18
+
19
+ alias yb2=ssh -X robocup@youbot-brsu-2-pc2
20
+
21
+ 2. Export the youbot ssh alias
22
+
23
+ .. code-block:: bash
24
+
25
+ export_yb2
26
+
27
+ .. note::
28
+
29
+ alias export_yb2=export ROS_MASTER_URI=http://youbot-brsu-2-pc2:11311
30
+
31
+ On robot
32
+
33
+ 3. Launch the robot
34
+
35
+ .. code-block:: bash
36
+
37
+ roslaunch mir_bringup robot.launch
38
+
39
+ 4. Launch Nav2d (to visualize the robot in Rviz)
40
+
41
+ .. code-block:: bash
42
+
43
+ roslaunch mir_2dnav 2dnav.launch
44
+
45
+ 4. Run calibration
46
+
47
+ .. code-block:: bash
48
+
49
+ roslaunch mir_calibrate_pick calibrate_pick.launch
50
+
51
+ A small gui window to adjust the pose of the end-effector in terms of XYZRPY will appear.
52
+
53
+ 5. Place a small round object on the ground (at approx. 25 cm from the center of the front wheel)
54
+
55
+ On workstation or your PC
56
+
57
+ 6. Run rviz
58
+
59
+ .. code-block:: bash
60
+
61
+ rosrun rviz rviz
62
+
63
+ 7. Load the camera_calibration_config.rviz config and set the global frame to `base_link`
64
+
65
+ Ensure to enable `raw_color_pcl` and `camera_calibration_obj_pose`. You can see an arrow pointing away from the robot.
66
+
67
+ 8. Adjust the values in the pose mockup gui, so that the beginning of the arrow matches the center of the round object.
68
+
69
+ .. note::
70
+
71
+ Make sure the object is not too far away from the robot and the Z value is slightly above the object.
72
+
73
+
74
+ .. figure:: images/camera_calib_side.png
75
+ :align: center
76
+
77
+ Camera calibration example side view
78
+
79
+
80
+ .. figure:: images/camera_calib_top.png
81
+ :align: center
82
+
83
+ Camera calibration example top view
84
+
85
+ On robot
86
+
87
+ 9. Test the calibration in another terminal
88
+
89
+ .. code-block:: bash
90
+
91
+ rosrun mir_calibrate_pick calibrate_pick_client_test.py
92
+
93
+ The robot will move towards the gripper and move the end-effector of the arm close the object based on the given offset.
94
+
95
+ 10. If the final end-effector position is not properly aligned to the desired goal position, in the robot navigate to the robot urdf configuration and edit the `robot.urdf.xacro`
96
+
97
+ .. code-block:: bash
98
+
99
+ /ros/noetic/robocup/src/mas_industrial_robotics/mir_robots/mir_hardware_config/youbot-brsu-2/urdf/robot.urdf.xacro
100
+
101
+ .. code-block:: bash
102
+
103
+ <xacro:realsense_d435 name="arm_cam3d" parent="base_link">
104
+ <origin xyz="0.30 -0.05 0.80" rpy="0.00 1.137 0.0" />
105
+ </xacro:realsense_d435>
106
+
107
+ Adjust the values of xyz and rpy to account for the offset according to the values set in step 8 and repeat from step 8.
108
+
109
+ 11. If the final end-effector position is properly aligned to the desired goal position, the camera calibration is complete.
110
+
111
+ 12. Terminate all operations and relaunch the robot to continue.
112
+
113
+
114
+ .. _realsense2_camera:
115
+
116
+ RealSense2 camera
117
+ ------------------
118
+
119
+ How to use the RealSense2 camera
120
+
121
+ 1. Installation
122
+
123
+ Go to the intel-ros github page. Clone the realsense repository in your catkin workspace inside src:
124
+
125
+ .. code-block:: bash
126
+
127
+ git clone [email protected]:intel-ros/realsense.git
128
+
129
+ 2. Camera Output
130
+
131
+ Run the following to get access to the camera:
132
+
133
+ .. code-block:: bash
134
+
135
+ roslaunch realsense2_camera rs_rgbd.launch
136
+
137
+ Open rviz to visualize the camera output.
138
+
139
+ 3. Configure camera output (OPTIONAL)
140
+
141
+ Run the following to open the rviz configuration window:
142
+
143
+ .. code-block:: bash
144
+
145
+ rosrun rqt_reconfigure rqt_reconfigure
146
+
147
+ You can also try to change the "octree_resolution" value:
148
+
149
+ .. code-block:: bash
150
+
151
+ cd *catkin workspace*/src/mas_perception/mcr_scene_segmentation/ros/config
152
+
153
+ 4. Setup Base Frame
154
+
155
+ Run the following:
156
+
157
+ .. code-block:: bash
158
+
159
+ rosrun tf static_transform_publisher x y z roll pitch yaw base_link camera_link 100
160
+
161
+ where x, y, z are the distances and roll, pitch, yaw are the rotations from the base_link to the camera_link.
162
+
163
+ To visualize your frames in rzviz, add the TF feature in the rviz menu.
164
+
165
+ 5. Save Point Clouds
166
+
167
+ If it's your first time saving point clouds, you need to choose where you want to save them and enable data collection:
168
+
169
+ .. code-block:: bash
170
+
171
+ cd *catkin workspace*/src/mas_perception/mcr_scene_segmentation/ros/launch
172
+
173
+ Change the value of "dataset_collection" from "false" to "true". Change value of "logdir" from "/temp/
174
+ to the path in your computer where you want to save the files.
175
+
176
+ Run the following to get access to the point clouds given by the camera:
177
+
178
+ .. code-block:: bash
179
+
180
+ roslaunch mcr_scene_segmentation scene_segmentation.launch input_pointcloud_topic:=/camera/depth_registered/points
181
+
182
+ Publish the message 'e-start':
183
+
184
+ .. code-block:: bash
185
+
186
+ rostopic pub /mcr_perception/scene_segmentation/event_in std_msgs/String "data: 'e_start'"
187
+
188
+ Publish the message 'e-add-cloud-start':
189
+
190
+ .. code-block:: bash
191
+
192
+ rostopic pub /mcr_perception/scene_segmentation/event_in std_msgs/String "data: 'e_add_cloud_start'"
193
+
194
+ This last one will save the current point cloud of the observed object in your system.
195
+
196
+ .. warning::
197
+
198
+ Sometimes the camera won't save the point cloud (don't worry, not your fault).
199
+ Just try a different position for the object until it works.
200
+
201
+ 6. Visualize Point Cloud
202
+
203
+ Run the following in the folder where you saved the point clouds:
204
+
205
+ .. code-block:: bash
206
+
207
+ pcl_viewer *.pcd file you want to open*
data/docs/source/mir_perception/cavity_detection.rst ADDED
@@ -0,0 +1,4 @@
 
 
 
 
 
1
+ .. _cavity_detection:
2
+
3
+ Cavity detection
4
+ ================
data/docs/source/mir_perception/dataset.rst ADDED
@@ -0,0 +1,124 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ .. _dataset:
2
+
3
+ Dataset
4
+ ========
5
+
6
+ .. _dataset_collection:
7
+
8
+ Dataset collection
9
+ ----------------------
10
+
11
+ .. _3d_dataset_collection:
12
+
13
+ 3D dataset collection
14
+ ^^^^^^^^^^^^^^^^^^^^^^
15
+
16
+ Objects are placed on a rotating table such that it can capture the objects from
17
+ different angle. However, this can be done manually on a normal table and change
18
+ the object orientation manually.
19
+
20
+ .. note::
21
+
22
+ This only works with a single object.
23
+
24
+ Setup:
25
+
26
+ 1. Using external camera
27
+
28
+ * Launch the camera
29
+
30
+ Go to :ref:`realsense2_camera` for more information about the camera.
31
+
32
+ * Apply static transform from camera_frame to base_link as explained in :ref:`realsense2_camera`
33
+
34
+ Make sure the pointcloud of the plane is parallel to the gorund on rviz by transforming/rotating it.
35
+
36
+ .. note::
37
+
38
+ Passthrough filter will not work if it's not parallel to the ground
39
+
40
+ * Launch multimodal object recognition
41
+
42
+ .. code-block:: bash
43
+
44
+ roslaunch mir_object_recognition multimodal_object_recognition.launch debug_mode:=true
45
+
46
+ .. note::
47
+
48
+ To enable dataset collection, it requires to be in *debug_mode*. You can also
49
+ point to a specifi logdir to save the data e.g. logdir:=/home/robocup/cloud_dataset.
50
+
51
+ * Start collectiong dataset
52
+
53
+ .. code-block:: bash
54
+
55
+ rostopic pub /mir_perception/multimodal_object_recognition/event_in std_msgs/String e_start
56
+
57
+
58
+ 2. Using robot arm camera
59
+
60
+ * Bringup the robot
61
+
62
+ * Start `multimodal_object_recognition` and continue with the next steps as described previously.
63
+
64
+ .. note::
65
+
66
+ The segemented point clouds are saved in the `logdir`.
67
+
68
+ .. _2d_dataset_collection:
69
+
70
+ 2D dataset collection
71
+ ^^^^^^^^^^^^^^^^^^^^^^
72
+
73
+ Images can be collected using the robot camera or external camera.
74
+ They can also be collected using `easy augment too <https://github.com/santoshreddy254/easy_augment>`_
75
+ which use Intel Realsense D435 camera to capture the image and automatically
76
+ annotate them for 2D object detection.
77
+
78
+
79
+ .. _dataset_preprocessing:
80
+
81
+ Dataset preprocessing
82
+ -----------------------
83
+
84
+ Before training training the model, the data should be preprocessed, and this
85
+ includes but not limited to *removing bad data*, *normalization*, and converting
86
+ it to the required format such as *h5* for point clouds and *VOC* or *KITTI* for
87
+ images.
88
+
89
+ .. _3d_dataset_preprocessing:
90
+
91
+ 3D dataset preprocessing
92
+ ^^^^^^^^^^^^^^^^^^^^^^^^
93
+
94
+ An example of the data directory structure:
95
+
96
+ .. code-block:: bash
97
+
98
+ b-it-bots_atwork_dataset
99
+ ├── train
100
+ │   ├── AXIS
101
+ | ├── axis_0001.pcd
102
+ | ├── ...
103
+ │   ├── ...
104
+ ├── test
105
+ │   ├── AXIS
106
+ | ├── axis_0001.pcd
107
+ | ├── ...
108
+ │   ├── ...
109
+
110
+ The dataset preprocessing can be found in `this notebook
111
+ <https://github.com/mhwasil/pointcloud_classification/blob/master/dataset/b-it-bots_dataset_preprocessing.ipynb>`_.
112
+
113
+ It will generate `pgz` files containing a dictionary of objects consisting of `x y z r g b` and label.
114
+
115
+
116
+ .. _2d_dataset_preprocessing:
117
+
118
+ 2D dataset preprocessing
119
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^
120
+
121
+ * Create semantic labels using `labelme <https://github.com/wkentaro/labelme>`_.
122
+ * Convert the semantic labels using `labelme2voc <https://github.com/mhwasil/labelme/blob/master/examples/bbox_detection/labelme2voc.py>`_.
123
+ * If KITTI dataset is required, convert VOC dataset to KITTI using
124
+ `vod-converter <https://github.com/umautobots/vod-converter>`_
data/docs/source/mir_perception/docstring/index.rst ADDED
@@ -0,0 +1,7 @@
 
 
 
 
 
 
 
 
1
+ .. _mir_perception_docs:
2
+
3
+ Perception Documentation
4
+ ########################
5
+
6
+ .. toctree::
7
+ :maxdepth: 1
data/docs/source/mir_perception/images/camera_calib_side.png ADDED

Git LFS Details

  • SHA256: dbcb7b01de507d1e749004031695644654f861744c34bacc9135aea3998fffe4
  • Pointer size: 131 Bytes
  • Size of remote file: 946 kB
data/docs/source/mir_perception/images/camera_calib_top.png ADDED

Git LFS Details

  • SHA256: 7ae9f24e0c0ef96ea13b2702a699a8f77590efdbffb2c8acfdc2ea38a47c9c76
  • Pointer size: 132 Bytes
  • Size of remote file: 1.4 MB
data/docs/source/mir_perception/images/perception_architecture.png ADDED

Git LFS Details

  • SHA256: 3585b88f3d1c9582f468efa7114bd8641945b3621586ac9d93707ee6fcbe5f35
  • Pointer size: 131 Bytes
  • Size of remote file: 622 kB
data/docs/source/mir_perception/index.rst ADDED
@@ -0,0 +1,21 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ .. _mir_perception:
2
+
3
+ Perception
4
+ ##########
5
+
6
+ Robot perception architecture
7
+
8
+ .. figure:: images/perception_architecture.png
9
+ :align: center
10
+
11
+ Robot perception architecture
12
+
13
+ .. toctree::
14
+
15
+ camera
16
+ dataset
17
+ training
18
+ object_segmentation
19
+ object_recognition
20
+ barrier_tape
21
+ cavity_detection
data/docs/source/mir_perception/object_recognition.rst ADDED
@@ -0,0 +1,106 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ .. _object_recognition:
2
+
3
+ Object recognition
4
+ ==================
5
+
6
+ Our object recognition comes from two different modalities, namely 3D based object recognition and
7
+ 2D object detection and recognition.
8
+
9
+ .. _3d_object_recognition_model:
10
+
11
+ 3D object recognition models
12
+ ----------------------------
13
+
14
+ `Our 3D object recognition node <https://github.com/b-it-bots/mas_industrial_robotics/blob/melodic/mir_perception/mir_object_recognition/ros/script/pc_object_recognizer_node>`_
15
+ uses segmented point clouds described in :ref:`3d_object_segmentation` as the input
16
+ to the models. These segemented point clouds are published from
17
+ `mir_object_recognition node <https://github.com/b-it-bots/mas_industrial_robotics/blob/melodic/mir_perception/mir_object_recognition/ros/src/multimodal_object_recognition_node.cpp>`_.
18
+
19
+ The tutorial for training the model is described in :ref:`training`.
20
+
21
+ We use two models for the 3D object recognition, namely:
22
+
23
+ * Random forest with Radial density distribution and 3D modified Fisher vector
24
+ (3DmFV) as features as described in `our paper <https://link.springer.com/chapter/10.1007/978-3-030-35699-6_48>`_.
25
+ * `Dynamic Graph CNN <https://github.com/WangYueFt/dgcnn>`_: an end-to-end point
26
+ cloud classification. However, in addition to points, we also incorporate colors as inputs.
27
+
28
+ You can change the classifier in the launch file
29
+
30
+ .. literalinclude:: ../../../mir_perception/mir_object_recognition/ros/launch/pc_object_recognition.launch
31
+ :language: xml
32
+ :lineno-start: 0
33
+ :linenos:
34
+
35
+ Where:
36
+
37
+ * `model`: whether it is CNN based (`cnn_based`) or traditional ML estimators (`feature_based`)
38
+ * `model_id`: the actual name of the model, available model ids:
39
+
40
+ * `cnn_based`: `dgcnn`
41
+ * `feature_based`: `fvrdd`
42
+ * `dataset`: the dataset name where the model was trained on
43
+
44
+ .. _2d_object_recognition_model:
45
+
46
+ 2D object recognition models
47
+ ----------------------------
48
+
49
+ We use `squeezeDet <https://github.com/BichenWuUCB/squeezeDet>`_ for out 2D object detection model.
50
+ This is lightweight, one-shot object detection and classification.
51
+ The model can be changed in the `rgb_object_recognition.launch`
52
+
53
+ .. literalinclude:: ../../../mir_perception/mir_object_recognition/ros/launch/rgb_object_recognition.launch
54
+ :language: xml
55
+ :lineno-start: 0
56
+ :linenos:
57
+
58
+ Where:
59
+
60
+ * `classifier`: the model used to detect and classify objects
61
+ * `dataset`: the dataset used to train the model
62
+
63
+ .. _mutlimodal_object_recognition:
64
+
65
+ Multimodal object recognition
66
+ -----------------------------
67
+
68
+ `multimodal_object_recognition_node <https://github.com/b-it-bots/mas_industrial_robotics/blob/melodic/mir_perception/mir_object_recognition/ros/src/multimodal_object_recognition_node.cpp>`_
69
+ coordinates the whole perception pipeline as described in the following items:
70
+
71
+ * Subscribes to rgb and point cloud topics
72
+ * Transforms point cloud to the target fram
73
+ * Finds 3D object clusters from the point cloud using `mir_object_segementation`
74
+ * Sends the 3D clusters to point cloud object recognizer (`pc_object_recognizer_node`)
75
+ * Sends the image to rgb object detection and recognition node (`rgb_object_recognized_node`)
76
+ * Waits until it gets results from both classifiers or if the timeout is reached
77
+ * Posts processing of the recognized objects
78
+
79
+ * Applies filters for the objects
80
+ * Sends object_list to object_list_merger
81
+
82
+ **Trigger multimodal_object_recognition**
83
+
84
+ .. code-block:: bash
85
+
86
+ rostopic pub /mir_perception/multimodal_object_recognition/event_in std_msgs/String e_start
87
+
88
+ **Outputs**
89
+
90
+ .. code-block:: bash
91
+
92
+ /mcr_perception/object_detector/object_list
93
+ /mir_perception/multimodal_object_recognition/output/workspace_height
94
+
95
+ **Visualization outputs**
96
+
97
+ .. code-block:: bash
98
+
99
+ /mir_perception/multimodal_object_recognition/output/bounding_boxes
100
+ /mir_perception/multimodal_object_recognition/output/debug_cloud_plane
101
+ /mir_perception/multimodal_object_recognition/output/pc_labels
102
+ /mir_perception/multimodal_object_recognition/output/pc_object_pose_array
103
+ /mir_perception/multimodal_object_recognition/output/rgb_labels
104
+ /mir_perception/multimodal_object_recognition/output/rgb_object_pose_array
105
+ /mir_perception/multimodal_object_recognition/output/tabletop_cluster_pc
106
+ /mir_perception/multimodal_object_recognition/output/tabletop_cluster_rgb
data/docs/source/mir_perception/object_segmentation.rst ADDED
@@ -0,0 +1,143 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ .. _object_segmentation:
2
+
3
+ Object Segmentation
4
+ ===================
5
+
6
+ .. _3d_object_segmentation:
7
+
8
+ 3D object segmentation
9
+ -------------------------
10
+
11
+ Our scene segmentation works with the assumption that the table has to be parallel
12
+ to the ground as we use
13
+ `SampleConsensusModelPerpendicularPlane <https://pointclouds.org/documentation/classpcl_1_1_sample_consensus_model_perpendicular_plane.html>`_
14
+ from PCL library. We keep points which are perpendicular to `z` axis.
15
+
16
+ There are two packages you can launch in order to segment table top point clouds:
17
+
18
+ *mir_object_segmentation* package
19
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
20
+
21
+ `mir_object_segmentation <https://github.com/b-it-bots/mas_industrial_robotics/tree/melodic/mir_perception/mir_object_segmentation>`_
22
+ package can be used to accumulate clouds from different views (if necessary),
23
+ register them, and then segment the objects above the table.
24
+
25
+ **Usage**
26
+
27
+ * Find plane height
28
+
29
+ To find the object height, you have to send the following messages to `event_in`
30
+ topic:
31
+
32
+ .. code-block:: bash
33
+
34
+ rostopic pub /mir_perception/scene_segmentation/event_in std_msgs/String e_start
35
+ rostopic pub /mir_perception/scene_segmentation/event_in std_msgs/String e_add_cloud_start
36
+ rostopic pub /mir_perception/scene_segmentation/event_in std_msgs/String e_find_plane
37
+
38
+ The plane height will be published to `workspace_height` topic:
39
+
40
+ .. code-block:: bash
41
+
42
+ /mir_perception/scene_segmentation/output/workspace_height
43
+
44
+
45
+ * Segment objects from one view point
46
+
47
+ .. code-block:: bash
48
+
49
+ rostopic pub /mir_perception/scene_segmentation/event_in std_msgs/String e_start
50
+ rostopic pub /mir_perception/scene_segmentation/event_in std_msgs/String e_add_cloud_start
51
+ rostopic pub /mir_perception/scene_segmentation/event_in std_msgs/String e_segment
52
+ rostopic pub /mir_perception/scene_segmentation/event_in std_msgs/String e_stop
53
+
54
+ * Segment objects from one view point
55
+
56
+ You can segment table top objects from multiple viewpoints. You can do this by
57
+ manually moving the camera position to a new view point, and then register
58
+ the cloud with the existing ones.
59
+
60
+ .. code-block:: bash
61
+
62
+ # accumulate point cloud from the 1st view point
63
+ rostopic pub /mir_perception/scene_segmentation/event_in std_msgs/String e_start
64
+ rostopic pub /mir_perception/scene_segmentation/event_in std_msgs/String e_add_cloud_start
65
+ rostopic pub /mir_perception/scene_segmentation/event_in std_msgs/String e_add_cloud_stop
66
+
67
+ # accumulate point cloud from the 2nd view point
68
+ rostopic pub /mir_perception/scene_segmentation/event_in std_msgs/String e_add_cloud_start
69
+ rostopic pub /mir_perception/scene_segmentation/event_in std_msgs/String e_add_cloud_stop
70
+
71
+ # segment accumulated cloud and stop segmentation
72
+ rostopic pub /mir_perception/scene_segmentation/event_in std_msgs/String e_segment
73
+ rostopic pub /mir_perception/scene_segmentation/event_in std_msgs/String e_stop
74
+
75
+
76
+ .. hint:: Published msgs from mir_object_segmentation
77
+
78
+ * Object list
79
+
80
+ .. code-block:: bash
81
+
82
+ /mir_perception/scene_segmentation/output/object_list
83
+
84
+ * Bounding Boxes (for visualization in Rviz)
85
+
86
+ .. code-block:: bash
87
+
88
+ /mir_perception/scene_segmentation/output/bounding_boxes
89
+
90
+ * Object labels (for visualization in Rviz)
91
+
92
+ .. code-block:: bash
93
+
94
+ /mir_perception/scene_segmentation/output/labels
95
+
96
+ * Debug pointcloud (shows filtered input to plane segmentation)
97
+
98
+ .. code-block:: bash
99
+
100
+ /mir_perception/scene_segmentation/output/debug_cloud
101
+
102
+ * Object clusters: segmented point clouds
103
+
104
+ .. code-block:: bash
105
+
106
+ /mir_perception/scene_segmentation/output/tabletop_clusters
107
+
108
+ * Workspace height:
109
+
110
+ .. code-block:: bash
111
+
112
+ /mir_perception/scene_segmentation/output/workspace_height
113
+
114
+
115
+ *mir_object_recognition* package
116
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
117
+
118
+ `mir_object_recognition` uses the same `scene_segmentation` method
119
+ as in `mir_object_segmentation`, but it does not accumulate point clouds. It only
120
+ takes one view and then segment table top objects.
121
+
122
+ **Usage**
123
+
124
+ * Segment objects
125
+
126
+ .. code-block:: bash
127
+
128
+ rostopic pub /mir_perception/multimodal_object_recognition/event_in std_msgs/String e_start
129
+
130
+ **Published messages**
131
+
132
+ .. code-block:: bash
133
+
134
+ /mcr_perception/object_detector/object_list
135
+ /mir_perception/multimodal_object_recognition/output/bounding_boxes
136
+ /mir_perception/multimodal_object_recognition/output/debug_cloud_plane
137
+ /mir_perception/multimodal_object_recognition/output/pc_labels
138
+ /mir_perception/multimodal_object_recognition/output/pc_object_pose_array
139
+ /mir_perception/multimodal_object_recognition/output/rgb_labels
140
+ /mir_perception/multimodal_object_recognition/output/rgb_object_pose_array
141
+ /mir_perception/multimodal_object_recognition/output/tabletop_cluster_pc
142
+ /mir_perception/multimodal_object_recognition/output/tabletop_cluster_rgb
143
+ /mir_perception/multimodal_object_recognition/output/workspace_height
data/docs/source/mir_perception/training.rst ADDED
@@ -0,0 +1,47 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ .. _training:
2
+
3
+ Training models
4
+ ===============
5
+
6
+ .. _training_pointcloud_classification:
7
+
8
+ Traning point cloud classification
9
+ ----------------------------------
10
+
11
+ Collect point cloud dataset as describe in :ref:`3d_dataset_collection`, and
12
+ preprocess them as explained in :ref:`3d_dataset_preprocessing`.
13
+
14
+ To train the models, you need to clone `this repo <https://github.com/mhwasil/pointcloud_classification>`_, and
15
+ install the requirements to train the model.
16
+
17
+ Training deep learning model
18
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
19
+
20
+ The supported models are available under `config/config.yaml`.
21
+
22
+ .. code-block:: bash
23
+
24
+ #python trainer.py --model <model_name> --train
25
+ #an example for training DGCNN with color (DGCNNC)
26
+
27
+ python trainer.py --model DGCNNC --train
28
+
29
+
30
+ Adding new model
31
+ ^^^^^^^^^^^^^^^^
32
+
33
+ ToDo
34
+
35
+
36
+ .. _training_2d_object_detection:
37
+
38
+ Training 2D object detection
39
+ ----------------------------
40
+
41
+ ToDo
42
+
43
+ .. note::
44
+
45
+ You can train the model on `H-BRS Scientific Computing Cluster <https://wr0.wr.inf.h-brs.de/wr/index.html>`_,
46
+ provided that you have access to it. The tutorial on how to submit job and train
47
+ your model on the cluster can be found `here <https://github.com/mhwasil/pointcloud_classification/blob/master/hbrs_cluster_usage.md>`_.
data/docs/source/mir_planning/actions/insert_cavity.rst ADDED
@@ -0,0 +1,15 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ .. _mir_insert_cavity:
2
+
3
+ Insert cavity
4
+ =============
5
+
6
+ Insert an object into a cavity on a precision placement workstation after picking
7
+ it from robot's back platform.
8
+
9
+
10
+ Goal parameter description
11
+ --------------------------
12
+
13
+ - ``peg``: name of object which needs to be inserted (e.g. ``M30``, ``F20_20_B``)
14
+ - ``platform``: name of robot's back platform (e.g. ``PLATFORM_MIDDLE``, ``PLATFORM_LEFT``)
15
+ - ``hole``: name of container on workstation (e.g. ``PP01``, ``PP02``)
data/docs/source/mir_planning/actions/insert_object.rst ADDED
@@ -0,0 +1,12 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ .. _mir_insert_object:
2
+
3
+ Insert object
4
+ =============
5
+
6
+ Insert an object into a container on a workstation after picking it from robot's back platform.
7
+
8
+ Goal parameter description
9
+ --------------------------
10
+
11
+ - ``platform``: name of robot's back platform (e.g. ``PLATFORM_MIDDLE``, ``PLATFORM_LEFT``)
12
+ - ``hole``: name of container on workstation (e.g. ``CONTAINER_BOX_BLUE``)
data/docs/source/mir_planning/actions/move_base_safe.rst ADDED
@@ -0,0 +1,17 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ .. _mir_move_base_safe:
2
+
3
+ Move base safe
4
+ ==============
5
+
6
+ Move robot base from a known/mapped location to another known/mapped location while
7
+ looking for barrier tape.
8
+
9
+
10
+ Goal parameter description
11
+ --------------------------
12
+
13
+ - ``destination_location``: name of known/mapped location (e.g. ``WS01``, ``SH02``, ``PP01``)
14
+ - ``dont_be_safe``: bool determining if barrier tape detection should be used or
15
+ not (e.g. ``true``, ``false``)
16
+ - ``arm_safe_position``: joint configuration name for arm while the base is in
17
+ motion. This is used for barrier tape detection. (e.g. ``barrier_tape``, ``folded``)
data/docs/source/mir_planning/actions/perceive_cavity.rst ADDED
@@ -0,0 +1,11 @@
 
 
 
 
 
 
 
 
 
 
 
 
1
+ .. _mir_perceive_cavity:
2
+
3
+ Perceive cavity
4
+ ===============
5
+
6
+ Perceive a precision placement workstation and detect and classify cavities in it.
7
+
8
+ Goal parameter description
9
+ --------------------------
10
+
11
+ - ``location``: name of known/mapped location (e.g. ``PP01``, ``PP02``)
data/docs/source/mir_planning/actions/perceive_location.rst ADDED
@@ -0,0 +1,11 @@
 
 
 
 
 
 
 
 
 
 
 
 
1
+ .. _mir_perceive_location:
2
+
3
+ Perceive location
4
+ =================
5
+
6
+ Perceive a workstation and detect and classify objects on it.
7
+
8
+ Goal parameter description
9
+ --------------------------
10
+
11
+ - ``location``: name of known/mapped location (e.g. ``WS01``, ``SH02``, ``PP01``)
data/docs/source/mir_planning/actions/perceive_mock.rst ADDED
@@ -0,0 +1,23 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ .. _mir_perceive_aruco:
2
+
3
+ Perceive mock
4
+ =============
5
+
6
+ Perceive an aruco cube on a workstation
7
+
8
+ Related to: ``mir_perceive_aruco_cube``
9
+
10
+ Goal parameter description
11
+ --------------------------
12
+
13
+ - ``location``: name of known/mapped location (e.g. ``WS01``, ``SH02``, ``PP01``)
14
+
15
+ Usage
16
+ -----
17
+
18
+ Make sure :ref:`mir_planning_bringup`'s launch file is already launched.
19
+
20
+ .. code-block:: bash
21
+
22
+ roslaunch mir_perceive_mock perceive_aruco_server.launch
23
+ rosrun mir_perceive_mock perceive_aruco_client_test
data/docs/source/mir_planning/actions/pick_object.rst ADDED
@@ -0,0 +1,12 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ .. _mir_pick_object:
2
+
3
+ Pick object
4
+ ===========
5
+
6
+ Pick an object from a workstation at a known/mapped location
7
+
8
+ Goal parameter description
9
+ --------------------------
10
+
11
+ - ``location``: name of known/mapped location (e.g. ``WS01``, ``SH02``)
12
+ - ``object``: name of object to be picked (e.g. ``M20``, ``S40_40_G``)
data/docs/source/mir_planning/actions/place_object.rst ADDED
@@ -0,0 +1,11 @@
 
 
 
 
 
 
 
 
 
 
 
 
1
+ .. _mir_place_object:
2
+
3
+ Place object
4
+ ============
5
+
6
+ Place object in gripper on a workstation at a known/mapped location
7
+
8
+ Goal parameter description
9
+ --------------------------
10
+
11
+ - ``location``: name of known/mapped location (e.g. ``WS01``, ``SH02``)