-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathplugins.html
457 lines (426 loc) · 19.6 KB
/
plugins.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
<!DOCTYPE html>
<html lang="en" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1.0,user-scalable=no, shrink-to-fit=no">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<link href="https://fonts.googleapis.com/icon?family=Material+Icons" rel="stylesheet">
<link href="https://fonts.googleapis.com/css?family=Roboto:200,400,500,700" rel="stylesheet">
<title>Plugins — itom</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/MDL_theme.css?v=e3b579a1" />
<link rel="stylesheet" href="_static/MDL/material.itom.min.em.css" type="text/css" />
<link rel="stylesheet" href="_static/AnimHeader.css" type="text/css" />
<link rel="stylesheet" href="_static/modalPopup.css" type="text/css" />
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=d0ae6d56"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/MDL/material.min.js"></script>
<script src="_static/MDL_theme.js"></script>
<script src="_static/AnimHeader.js"></script>
<script src="_static/modalPopup.js"></script>
<link rel="icon" href="_static/ITOMfavicon.ico"/>
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Examples" href="examples.html" />
<link rel="prev" title="Documentation" href="documentation.html" />
</head><body>
<!--
-->
<div class="mdl-layout mdl-js-layout mdl-layout--fixed-header mdl-layout--fixed-drawer">
<header class="mdl-layout__header mdl-layout__header--waterfall ">
<div class="mdl-layout__header-row">
<nav class="mdl-navigation breadcrumb">
<a class="mdl-navigation__link is-active">Plugins</a>
</nav>
<div class="mdl-layout-spacer"></div>
<a href="https://sourceforge.net/projects/itom/" target="_blank" alt="Download ITOM" class="mdl-button mdl-js-button mdl-button--raised mdl-button--accent hideSmall" style="margin-right: 20px;">
<span class="mdl-color-text--white">Download</span>
<i class="material-icons mdl-color-text--white"></i>
</a>
<a href="examples.html" alt="Next" class="mdl-button mdl-js-button mdl-button--icon mdl-button--raised mdl-button--accent" style="margin-right: 10px;">
<i class="material-icons mdl-color-text--white" ></i>
</a>
<label class="mdl-button mdl-js-button mdl-button--icon mdl-button--colored">
<a href="index.html" alt="Home">
<i class="material-icons">home</i>
</a>
</label>
<label class="mdl-button mdl-js-button mdl-button--icon mdl-button--colored">
<a href="https://github.com/itom-project" alt="Github">
<img src="_static/github-mark.svg" alt="GitHub" width="24" height="24" style="margin:0px 0px">
</a>
</label>
<form class="form-inline pull-sm-right" action="search.html" method="get">
<div class="mdl-textfield mdl-js-textfield mdl-textfield--expandable mdl-textfield--floating-label mdl-textfield--align-right">
<label class="mdl-button mdl-js-button mdl-button--icon" for="waterfall-exp">
<i class="material-icons">search</i>
</label>
<div class="mdl-textfield__expandable-holder">
<input class="mdl-textfield__input" type="text" name="q" id="waterfall-exp" placeholder="Search" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</div>
</div>
</form>
<!-- Title -->
</div>
<!--
<div class="mdl-layout__header-row header-links">
<div class="mdl-layout-spacer"></div>
<nav class="mdl-navigation">
</nav>
</div>-->
</header>
<header class="mdl-layout__drawer">
<!-- Title -->
<span class="mdl-layout-title">
<a class="brand" href="index.html">
<img class="logo" src="_static/itomlogo.png" alt="itom"/>
</a>
</span>
<nav class="mdl-navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="start.html">Get Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="features.html">Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="download.html">Downloads</a></li>
<li class="toctree-l1"><a class="reference internal" href="documentation.html">Documentation</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Plugins</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
<li class="toctree-l1"><a class="reference internal" href="collaboration.html">Collaboration</a></li>
</ul>
</nav>
</header>
<main class="mdl-layout__content">
<div class="page-content">
<section id="plugins">
<span id="sec-plugins"></span><h1>Plugins<a class="headerlink" href="#plugins" title="Link to this heading">¶</a></h1>
<p>One of the most important features of <strong>itom</strong> is its plugin system. Using plugins, <strong>itom</strong> is able to communicate with many hardware components, such as framegrabbers, cameras, motor stages or other devices.
Furthermore it is possible to develop user defined algorithms in C/C++ and put them into an algorithm plugin. The call to these algorithms is then possible via the Python scripting language or other plugins.</p>
<div class="mdl-grid docutils container">
<a target="_blank" href=".\plugindoc\index.html" class="mdl-cell mdl-button mdl-button--accent mdl-button--raised mdl-js-button mdl-js-ripple-effect">Plugin Documentation</a></div>
<p>The <strong>itom</strong> setup already comes with many exemplary plugins. Other plugins are available as source files in the corresponding <a class="reference external" href="https://github.com/itom-project/plugins">Plugins repository</a>.
Furthermore, the SDK of <strong>itom</strong> provide some template files for creating your own plugin using CMake and the development environment of your choice (see <a class="reference external" href="https://itom-project.github.io/latest/docs/07_plugins/development/plugin-development.html?highlight=plugin+create+cmake">CMake Plugin</a>).</p>
<section id="add-a-plugin-to-itom">
<h2>Add a plugin to itom<a class="headerlink" href="#add-a-plugin-to-itom" title="Link to this heading">¶</a></h2>
<p>Requirements to load a plugin library at startup of <strong>itom</strong>:</p>
<ol class="arabic simple">
<li><p>The plugin library is contained in any subfolder of the folder <strong>plugin</strong> contained in the application (root) directory of <strong>itom</strong></p></li>
<li><p>If <strong>itom</strong> is build in debug, the plugin must be compiled in debug as well. The same holds for the default release versions.</p></li>
<li><p>If the plugin depends on further 3rd party libraries, these libraries must be accessible by your operating system (on Windows: Their path must be contained in the PATH environment variable OR the necessary DLLs must be in the <strong>lib</strong> subfolder of <strong>itom</strong> or in the root directory of <strong>itom</strong>). Only if the plugin is able to load further libraries by means of a delay load mechanism, it is possible to also put 3rd party libraries in arbitrary folders.</p></li>
<li><p>If your plugin depends on 3rd party libraries, please make sure that all plugins use exactly the same version of the same library.</p></li>
</ol>
</section>
<section id="available-plugins">
<h2>Available plugins<a class="headerlink" href="#available-plugins" title="Link to this heading">¶</a></h2>
<p>The following plugins are contained in the open source <a class="reference external" href="https://github.com/itom-project/plugins">Plugins repository</a> (and some of them are also already included in the setup of <strong>itom</strong>):</p>
<table class="mdl-table docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Cameras</p></th>
<th class="head"></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>AndorSDK3</p></td>
<td><p>Andor Cameras supported by their SDK3</p></td>
</tr>
<tr class="row-odd"><td><p>AvantesAvaSpec</p></td>
<td><p>Avantes AvaSpec Spectrometer</p></td>
</tr>
<tr class="row-even"><td><p>AvtVimba</p></td>
<td><p>AVT Cameras driven by Vimba interface</p></td>
</tr>
<tr class="row-odd"><td><p>CMU1394</p></td>
<td><p>Firewire cameras supported by CMU1394 driver</p></td>
</tr>
<tr class="row-even"><td><p>CommonVisionBlox</p></td>
<td><p>GenICam via Common Vision Blox</p></td>
</tr>
<tr class="row-odd"><td><p>DummyGrabber</p></td>
<td><p>Virtual camera providing random noise images</p></td>
</tr>
<tr class="row-even"><td><p>FileGrabber</p></td>
<td><p>Virtual file camera (grabbing from image files)</p></td>
</tr>
<tr class="row-odd"><td><p>FireGrabber</p></td>
<td><p>Cameras supported by FirePackage from Allied Vision</p></td>
</tr>
<tr class="row-even"><td><p>Genicam</p></td>
<td><p>Camera control of devices that support the GenICam standard</p></td>
</tr>
<tr class="row-odd"><td><p>IDSuEyeCamera</p></td>
<td><p>All IDS Imaging cameras</p></td>
</tr>
<tr class="row-even"><td><p>MSMediaFoundation</p></td>
<td><p>USB Plug&Play Cameras, Webcams, including cameras from The Imaging Source</p></td>
</tr>
<tr class="row-odd"><td><p>NITWidySWIR</p></td>
<td><p>Cameras from company NIT (tested with USB2 WidySWIR 640U-S)</p></td>
</tr>
<tr class="row-even"><td><p>OceanOpticsSpec</p></td>
<td><p>OceanOptics Spectrometer</p></td>
</tr>
<tr class="row-odd"><td><p>OpenCVGrabber</p></td>
<td><p>USB Plug&Play Cameras and further cameras supported by OpenCV</p></td>
</tr>
<tr class="row-even"><td><p>PCOCamera</p></td>
<td><p>PCO Cameras supported by the pco.sdk</p></td>
</tr>
<tr class="row-odd"><td><p>PCOPixelFly</p></td>
<td><p>PCO Pixelfly qet cameras with frame grabber board</p></td>
</tr>
<tr class="row-even"><td><p>PCOSensicam</p></td>
<td><p>PCO Cameras supported by the pco.sensicam SDK</p></td>
</tr>
<tr class="row-odd"><td><p>PGRFlyCapture</p></td>
<td><p>Point Grey cameras (USB3) supported by Fly Capture driver</p></td>
</tr>
<tr class="row-even"><td><p>PmdPico</p></td>
<td><p>pico flexx, pico maxx, pico monster</p></td>
</tr>
<tr class="row-odd"><td><p>QCam</p></td>
<td><p>Cameras from company QImaging</p></td>
</tr>
<tr class="row-even"><td><p>ThorlabsCCS</p></td>
<td></td>
</tr>
<tr class="row-odd"><td><p>Vistek</p></td>
<td><p>Cameras from company Vistek</p></td>
</tr>
<tr class="row-even"><td><p>VRMagic</p></td>
<td><p>USB Cameras from company VRMagic (tested with framegrabber VRmAVC-2)</p></td>
</tr>
<tr class="row-odd"><td><p>Ximea</p></td>
<td><p>Cameras from company Ximea (tested with various xiQ USB3 cameras, mono & color)</p></td>
</tr>
</tbody>
</table>
<table class="mdl-table docutils align-default">
<colgroup>
<col style="width: 42.9%" />
<col style="width: 57.1%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Motors/Actuators</p></th>
<th class="head"></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>AerotechEnsemble</p></td>
<td><p>Axes from company Aerotech that can be driven using the Aerotech Ensemble interface</p></td>
</tr>
<tr class="row-odd"><td><p>DummyMotor</p></td>
<td><p>Virtual dummy motor with axis</p></td>
</tr>
<tr class="row-even"><td><p>FirgelliLAC</p></td>
<td><p>One axis motor controller FirgelliLAC</p></td>
</tr>
<tr class="row-odd"><td><p>LeicaMotorFocus</p></td>
<td><p>Z-stage controller of Leica MZ12 or MZ12.5</p></td>
</tr>
<tr class="row-even"><td><p>NanotecStepMotor</p></td>
<td><p>Motor-Controller Nanotec SMCP</p></td>
</tr>
<tr class="row-odd"><td><p>PiezosystemJena_NV40_1</p></td>
<td><p>One axis piezo actuator from Piezosystem Jena (NV 40/1 CLE)</p></td>
</tr>
<tr class="row-even"><td><p>PI GCS2</p></td>
<td><p>Piezo controllers from Physik Instrumente - controlled by GCS2 commands (e.g. E753)</p></td>
</tr>
<tr class="row-odd"><td><p>PI PiezoCtrl</p></td>
<td><p>Piezo controller E662, E-816, E-621, E-625, E665 from Physik Instrumente</p></td>
</tr>
<tr class="row-even"><td><p>ST8SMC4USB (Standa)</p></td>
<td><p>Motor-Controller STANDA 8SMC4-USB-B8-1</p></td>
</tr>
<tr class="row-odd"><td><p>ThorlabsBP</p></td>
<td><p>One or multi-axis piezo controllers of type Thorlabs Benchtop Piezo</p></td>
</tr>
<tr class="row-even"><td><p>ThorlabsISM</p></td>
<td><p>Control Thorlabs Integrated Stepper Motors, e.g. K10CR1 Rotation Stage</p></td>
</tr>
<tr class="row-odd"><td><p>ThorlabsKCubeIM</p></td>
<td><p>Thorlabs KCube Motion Controller</p></td>
</tr>
<tr class="row-even"><td><p>UhlRegister</p></td>
<td><p>Stages from Uhl (also compatible with Lang)</p></td>
</tr>
<tr class="row-odd"><td><p>UhlText</p></td>
<td><p>Stages from Uhl (also compatible with Lang and Merzhaeuser)</p></td>
</tr>
<tr class="row-even"><td><p>usbMotion3XIII</p></td>
<td><p>USB Motion 3x III controller from COPTONIX GmbH (www.coptonix.com)</p></td>
</tr>
</tbody>
</table>
<table class="mdl-table docutils align-default">
<colgroup>
<col style="width: 42.9%" />
<col style="width: 57.1%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>DataIO</p></th>
<th class="head"></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>CyUSB</p></td>
<td><p>Any generic USB devices</p></td>
</tr>
<tr class="row-odd"><td><p>DispWindow</p></td>
<td><p>OpenGL based widget to show cosine and graycode sequences</p></td>
</tr>
<tr class="row-even"><td><p>GLDisplay</p></td>
<td><p>OpenGL based widget to show any textures given by dataObjects</p></td>
</tr>
<tr class="row-odd"><td><p>GWInstekPSP</p></td>
<td><p>Power supplies PSP-405, PSP-603, PSP-2010 of company GWInstek</p></td>
</tr>
<tr class="row-even"><td><p>hidApi</p></td>
<td><p>Any generic HID device</p></td>
</tr>
<tr class="row-odd"><td><p>libUSB</p></td>
<td><p>Any generic USB devices</p></td>
</tr>
<tr class="row-even"><td><p>LibModBus</p></td>
<td><p>Modbus communication over TCP/IP and RTU</p></td>
</tr>
<tr class="row-odd"><td></td>
<td></td>
</tr>
<tr class="row-even"><td><p>SerialIO</p></td>
<td><p>COM-Ports (Windows), ttySx and ttyUSBx (Linux)</p></td>
</tr>
<tr class="row-odd"><td><p>SuperlumBL</p></td>
<td><p>Lightsource from company Superlum</p></td>
</tr>
<tr class="row-even"><td><p>SuperlumBS</p></td>
<td><p>Lightsource from company SuperlumBS</p></td>
</tr>
<tr class="row-odd"><td></td>
<td></td>
</tr>
<tr class="row-even"><td><p>ThorlabsFF</p></td>
<td></td>
</tr>
</tbody>
</table>
<table class="mdl-table docutils align-default">
<colgroup>
<col style="width: 42.9%" />
<col style="width: 57.1%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>AD-Converter</p></th>
<th class="head"></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>MeasurementComputing</p></td>
<td><p>Access to USB digital to analog converter</p></td>
</tr>
<tr class="row-odd"><td><p>NI-DAQmx</p></td>
<td><p>NI-ADDA Converter (requires NI-DAQmx Lib and DLL)</p></td>
</tr>
<tr class="row-even"><td><p>OphirPowermeter</p></td>
<td><p>Control Powermeters from Ophir/MKS</p></td>
</tr>
<tr class="row-odd"><td><p>ThorlabsPowerMeter</p></td>
<td><p>Thorlabs Power and Energy Meter Consoles PM100x</p></td>
</tr>
</tbody>
</table>
<table class="mdl-table docutils align-default">
<colgroup>
<col style="width: 42.9%" />
<col style="width: 57.1%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Algorithm/Filter</p></th>
<th class="head"></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>basicFilters</p></td>
<td><p>Many filters for dataObject</p></td>
</tr>
<tr class="row-odd"><td><p>basicGPLFilters</p></td>
<td><p>Basic filter for dataObject (Despeckle,…)</p></td>
</tr>
<tr class="row-even"><td><p>dataObjectArithmetic</p></td>
<td><p>Arithmetic calculations for dataObject</p></td>
</tr>
<tr class="row-odd"><td><p>dataObjectIO</p></td>
<td><p>Import/Export functions for dataObject</p></td>
</tr>
<tr class="row-even"><td><p>fittingFilters</p></td>
<td><p>Fitting planes and surfaces</p></td>
</tr>
<tr class="row-odd"><td><p>FFTWfilters</p></td>
<td><p>Filter for FFT calculations</p></td>
</tr>
<tr class="row-even"><td><p>FringeProj</p></td>
<td><p>Fringe projections methods</p></td>
</tr>
<tr class="row-odd"><td><p>OpenCV Filters</p></td>
<td><p>Wrapped algos for image processing</p></td>
</tr>
<tr class="row-even"><td><p>PclTools</p></td>
<td><p>pointClouds and polygonMesh methods</p></td>
</tr>
<tr class="row-odd"><td><p>RawImport</p></td>
<td><p>Loading raw image format</p></td>
</tr>
<tr class="row-even"><td><p>Roughness</p></td>
<td><p>Algo for roughness evaluation</p></td>
</tr>
<tr class="row-odd"><td><p>X3P IO</p></td>
<td><p>Load and Save x3p files</p></td>
</tr>
</tbody>
</table>
</section>
<section id="plugin-development">
<h2>Plugin Development<a class="headerlink" href="#plugin-development" title="Link to this heading">¶</a></h2>
<p>If you have any hardware component that is not yet supported by <strong>itom</strong> or if you need to have a specific algorithm implemented as algorithm plugin, you have the following possibilities:</p>
<ul class="simple">
<li><p>Start to develop your own plugin library and make this plugin available to anybody if you want to. More information about this can be found under <a class="reference external" href="https://itom-project.github.io/latest/docs/07_plugins/development/plugin-development.html?highlight=plugin+create+cmake">Plugin Development</a></p></li>
<li><p>Since not all plugins are already available in the internet, ask us if for instance we already have the plugin you need.</p></li>
<li><p>Feel also free to contact us if you want us to develop a plugin for you.</p></li>
<li><p>Register to the <a class="reference external" href="https://lists.sourceforge.net/lists/listinfo/itom-discussions">mailing list</a> and write further questions.</p></li>
</ul>
</section>
</section>
<div class="pagenation">
<a id="button-prev" href="documentation.html" class="mdl-button mdl-js-button mdl-button--raised mdl-js-ripple-effect mdl-button--accent" role="botton" accesskey="P">
<i class="material-icons">arrow_back</i>PREVIOUS
</a>
<div class="mdl-tooltip" data-mdl-for="button-prev">
Documentation
</div>
<a id="button-next" href="examples.html" class="mdl-button mdl-js-button mdl-button--raised mdl-js-ripple-effect mdl-button--accent" role="botton" accesskey="N">
NEXT <i class="material-icons">arrow_forward</i>
</a>
<div class="mdl-tooltip" data-mdl-for="button-next">
Examples
</div>
</div>
</div>
<footer class="mdl-mini-footer">
<div class="mdl-mini-footer__right-section">
<div>© Copyright 2011-2024, Institut für Technische Optik, Universität Stuttgart.</div>
<div>Generated by <a href="http://sphinx.pocoo.org/">Sphinx</a> 8.1.3 using <a href="https://www.getmdl.io">MDL</a></div>
<div>This page uses <a href="http://analytics.google.com/">Google Analytics</a>.
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)})(window,document,'script','https://www.google-analytics.com/analytics.js','ga'); ga('create', 'UA-51395951-1', 'auto');ga('send', 'pageview');
</script>
</div>
</div>
</footer>
</main>
</div>
</body>
</html>