Skip to content

Commit 40c3c3f

Browse files
committed
deploy: 7922040
1 parent 8b1e4b7 commit 40c3c3f

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

pull/130/index.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

pull/130/introduction/introduction/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@
6161
<a href=glossary/#module>Modules</a> are the basic entities the MeVisLab concept is built upon.<br>They provide the functionalities to process, display, and interact with images.</div></div><p>The three existing module types (ML, <a href=glossary/#open-inventor>Open Inventor</a>, and <a href=glossary/#macro-module>macro module</a>) can be distinguished by their colors:</p><div class=table-responsive><table class="table table-striped"><thead><tr><th><div style=width:230px>Type</div></th><th><div style=width:430px>Appearance</div></th><th>Characteristics</th></tr></thead><tbody><tr><td>ML module (blue)</td><td><p class=page-image><a data-modal=bs-lightbox href=images/tutorials/introduction/MLMModuleML.png title="ML module"><img id="ML module" class="img-fluid rounded" src=images/tutorials/introduction/MLMModuleML.png alt="ML module" title="ML module"></a><figcaption class=figure-caption>ML module</figcaption></p></td><td>Page-based, demand-driven processing of voxels.</td></tr><tr><td>Open Inventor module (green)</td><td><p class=page-image><a data-modal=bs-lightbox href=images/tutorials/introduction/MLMModuleSo.png title="Open Inventor module"><img id="Open Inventor module" class="img-fluid rounded" src=images/tutorials/introduction/MLMModuleSo.png alt="Open Inventor module" title="Open Inventor module"></a><figcaption class=figure-caption>Open Inventor module</figcaption></p></td><td>Visual scene graphs (3D). Usually starting with <em>So</em> (for <strong>S</strong>cene <strong>o</strong>bject) as a naming convention.</td></tr><tr><td>Macro module (brown)</td><td><p class=page-image><a data-modal=bs-lightbox href=images/tutorials/introduction/MLMModuleMacro.png title="Macro module"><img id="Macro module" class="img-fluid rounded" src=images/tutorials/introduction/MLMModuleMacro.png alt="Macro module" title="Macro module"></a><figcaption class=figure-caption>Macro module</figcaption></p></td><td>Combination of other module types, allowing the implementation of hierarchies and scripted interaction.</td></tr></tbody></table></div><h3 id=invalid-modules>Invalid Modules</h3><p>If a module is invalid, it is displayed in bright red. This might happen if the module itself is not available for your system.</p><div class=table-responsive><table class="table table-striped"><thead><tr><th><div style=width:330px>Appearance</div></th><th>Explanation</th></tr></thead><tbody><tr><td><p class=page-image><a data-modal=bs-lightbox href=images/tutorials/introduction/MLMModuleStateInvalid.png title="Invalid module"><img id="Invalid module" class="img-fluid rounded" src=images/tutorials/introduction/MLMModuleStateInvalid.png alt="Invalid module" title="Invalid module"></a><figcaption class=figure-caption>Invalid module</figcaption></p></td><td>Invalid module</td></tr><tr><td><p class=page-image><a data-modal=bs-lightbox href=images/tutorials/introduction/MLMModuleStateMacroInvalidModule.png title="Macro State Invalid"><img id="Macro State Invalid" class="img-fluid rounded" src=images/tutorials/introduction/MLMModuleStateMacroInvalidModule.png alt="Macro State Invalid" title="Macro State Invalid"></a><figcaption class=figure-caption>Macro State Invalid</figcaption></p></td><td>Macro containing an invalid module</td></tr></tbody></table></div><p>As you can see, the number of warning and error messages that are being printed to the
6262
debug console are listed in the upper right corner of the module. This is intentional, as it enables the developer to quickly find the module causing the errors.</p><svg style="display:none"><symbol id="check-fill" fill="currentColor" viewBox="0 0 16 16"><path d="M16 8A8 8 0 110 8a8 8 0 0116 0zm-3.97-3.03a.75.75.0 00-1.08.022L7.477 9.417 5.384 7.323a.75.75.0 00-1.06 1.06L6.97 11.03a.75.75.0 001.079-.02l3.992-4.99a.75.75.0 00-.01-1.05z"/></symbol><symbol id="info-fill" fill="currentColor" viewBox="0 0 16 16"><path d="M8 16A8 8 0 108 0a8 8 0 000 16zm.93-9.412-1 4.705c-.07.34.029.533.304.533.194.0.487-.07.686-.246l-.088.416c-.287.346-.92.598-1.465.598-.703.0-1.002-.422-.808-1.319l.738-3.468c.064-.293.006-.399-.287-.47l-.451-.081.082-.381 2.29-.287zM8 5.5a1 1 0 110-2 1 1 0 010 2z"/></symbol><symbol id="warning-fill" fill="currentColor" viewBox="0 0 16 16"><path d="M8.982 1.566a1.13 1.13.0 00-1.96.0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889.0 1.438-.99.98-1.767L8.982 1.566zM8 5c.535.0.954.462.9.995l-.35 3.507a.552.552.0 01-1.1.0L7.1 5.995A.905.905.0 018 5zm.002 6a1 1 0 110 2 1 1 0 010-2z"/></symbol><symbol id="danger-fill" fill="currentColor" viewBox="0 0 16 16"><path d="M8.982 1.566a1.13 1.13.0 00-1.96.0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889.0 1.438-.99.98-1.767L8.982 1.566zM8 5c.535.0.954.462.9.995l-.35 3.507a.552.552.0 01-1.1.0L7.1 5.995A.905.905.0 018 5zm.002 6a1 1 0 110 2 1 1 0 010-2z"/></symbol></svg><div class="alert alert-primary alert-check d-flex align-items-center" role=alert><svg class="bi flex-shrink-0 me-2" width="24" height="24" role="img" aria-label="Check:"><use xlink:href="#check-fill"/></svg><div><b>Check:&nbsp;</b>
6363
Once the debug console is cleared, the warning and error indicators next to the
64-
module are also cleared.</div></div><p>Informational messages are indicated in a similar matter on the same spot, but in a subtle gray color.</p><h3 id=module-interactions-through-the-context-menu>Module Interactions Through the Context Menu</h3><p>Each module has a context menu, providing the following options:</p><p><p class=page-image><a data-modal=bs-lightbox href=images/tutorials/introduction/ModuleContextMenu.png title="Context Menu of a module"><img id="Context Menu of a module" class="img-fluid rounded" src=images/tutorials/introduction/ModuleContextMenu.png alt="Context Menu of a module" title="Context Menu of a module"></a><figcaption class=figure-caption>Context Menu of a module</figcaption></p></p><ul><li><strong>Show Internal Network:</strong> <a href=glossary/#macro-module>Macro modules</a> provide an entry to open the internal network. You can see what happens inside a macro module. The internal network may also contain other macro modules. Changes in the internal network are applied to the currently running instance of yor module but not saved permanently.</li><li><strong>Show Window:</strong> If a module does not provide an User Interface, you will see the automatic panel, showing the module&rsquo;s name. Modules may additionally have one or more windows which can be opened. You can also open the Scripting Console of a module to integrate Python.</li><li><strong>Instance Name:</strong> You can edit or copy the instance name. Renaming can be useful if the same module appears more than once in one network and/or if you want to access and distinguish the modules in your Python script.</li><li><strong>Help:</strong> The menu entry Help provides access to the Module Help pages and to an example network where the module is used. This example network often helps to understand which additional modules can be added to create your desired effect.</li><li><strong>Extras:</strong> Automated tests written for the specific module can be executed here. You can also run this module in a separate process.</li><li><strong>Reload Definition:</strong> In case you are currently working on a module, you may need to reload the definition so that your changes are applied on the module (for example attached Python scripts).</li><li><strong>Related Files:</strong> Related files allows a quick access to the modules <em>*.script</em> or <em>*.py</em> files. The files are automatically opened in <a href=glossary/#mevislab-mate>MATE</a> for editing. Changes on the .mlab file are applied permanently for your module.</li><li><strong>Show Enclosing Folder:</strong> This entry opens the directory where your module is stored.</li><li><strong>Grouping:</strong> Multiple modules can be clustered and the groups can be named. This adds clarity to the structure of your network. In addition to that, grouped modules can be converted to local or global macro modules easily.</li></ul><h3 id=Module_Connectors>Input and Output Connectors</h3><p>As the creation of a network requires connected modules, each module has input and output connectors, located on their top and bottom side. Data is transmitted from the output connector on the top side of one module to the input connector on another module&rsquo;s bottom side.</p><p>Once again, three types can be distinguished:</p><div class=table-responsive><table class="table table-striped"><thead><tr><th><div style=width:330px>Appearance</div></th><th><div style=width:130px>Shape</div></th><th>Definition</th></tr></thead><tbody><tr><td><p class=page-image><a data-modal=bs-lightbox href=images/tutorials/introduction/MLMConnectorTriangle.png title="Triangle - ML Image"><img id="Triangle - ML Image" class="img-fluid rounded" src=images/tutorials/introduction/MLMConnectorTriangle.png alt=Triangle title="Triangle - ML Image"></a><figcaption class=figure-caption>Triangle - ML Image</figcaption></p></td><td>triangle</td><td>ML images</td></tr><tr><td><p class=page-image><a data-modal=bs-lightbox href=images/tutorials/introduction/MLMConnectorHalfCircle.png title="Circle - Inventor Scene"><img id="Circle - Inventor Scene" class="img-fluid rounded" src=images/tutorials/introduction/MLMConnectorHalfCircle.png alt=Circle title="Circle - Inventor Scene"></a><figcaption class=figure-caption>Circle - Inventor Scene</figcaption></p></td><td>half-circle</td><td>Inventor scene</td></tr><tr><td><p class=page-image><a data-modal=bs-lightbox href=images/tutorials/introduction/MLMConnectorSquare.png title="Square - Base Object"><img id="Square - Base Object" class="img-fluid rounded" src=images/tutorials/introduction/MLMConnectorSquare.png alt=Square title="Square - Base Object"></a><figcaption class=figure-caption>Square - Base Object</figcaption></p></td><td>square</td><td>Base objects: Pointers to data structures</td></tr></tbody></table></div><svg style="display:none"><symbol id="check-fill" fill="currentColor" viewBox="0 0 16 16"><path d="M16 8A8 8 0 110 8a8 8 0 0116 0zm-3.97-3.03a.75.75.0 00-1.08.022L7.477 9.417 5.384 7.323a.75.75.0 00-1.06 1.06L6.97 11.03a.75.75.0 001.079-.02l3.992-4.99a.75.75.0 00-.01-1.05z"/></symbol><symbol id="info-fill" fill="currentColor" viewBox="0 0 16 16"><path d="M8 16A8 8 0 108 0a8 8 0 000 16zm.93-9.412-1 4.705c-.07.34.029.533.304.533.194.0.487-.07.686-.246l-.088.416c-.287.346-.92.598-1.465.598-.703.0-1.002-.422-.808-1.319l.738-3.468c.064-.293.006-.399-.287-.47l-.451-.081.082-.381 2.29-.287zM8 5.5a1 1 0 110-2 1 1 0 010 2z"/></symbol><symbol id="warning-fill" fill="currentColor" viewBox="0 0 16 16"><path d="M8.982 1.566a1.13 1.13.0 00-1.96.0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889.0 1.438-.99.98-1.767L8.982 1.566zM8 5c.535.0.954.462.9.995l-.35 3.507a.552.552.0 01-1.1.0L7.1 5.995A.905.905.0 018 5zm.002 6a1 1 0 110 2 1 1 0 010-2z"/></symbol><symbol id="danger-fill" fill="currentColor" viewBox="0 0 16 16"><path d="M8.982 1.566a1.13 1.13.0 00-1.96.0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889.0 1.438-.99.98-1.767L8.982 1.566zM8 5c.535.0.954.462.9.995l-.35 3.507a.552.552.0 01-1.1.0L7.1 5.995A.905.905.0 018 5zm.002 6a1 1 0 110 2 1 1 0 010-2z"/></symbol></svg><div class="alert alert-primary alert-info d-flex align-items-center" role=alert><svg class="bi flex-shrink-0 me-2" width="24" height="24" role="img" aria-label="Info:"><use xlink:href="#info-fill"/></svg><div><b>Info:&nbsp;</b>
64+
module are also cleared.</div></div><p>Informational messages are indicated in a similar matter on the same spot, but in a subtle gray color.</p><h3 id=module-interactions-through-the-context-menu>Module Interactions Through the Context Menu</h3><p>Each module has a context menu, providing the following options:</p><p><p class=page-image><a data-modal=bs-lightbox href=images/tutorials/introduction/ModuleContextMenu.png title="Context Menu of a module"><img id="Context Menu of a module" class="img-fluid rounded" src=images/tutorials/introduction/ModuleContextMenu.png alt="Context Menu of a module" title="Context Menu of a module"></a><figcaption class=figure-caption>Context Menu of a module</figcaption></p></p><ul><li><strong>Show Internal Network:</strong> <a href=glossary/#macro-module>Macro modules</a> provide an entry to open the internal network. You can see what happens inside a macro module. The internal network may also contain other macro modules. Changes in the internal network are applied to the currently running instance of yor module but not saved permanently.</li><li><strong>Show Window:</strong> If a module does not provide a User Interface, you will see the automatic panel, showing the module&rsquo;s name. Modules may additionally have one or more windows that can be opened. You can also open the Scripting Console of a module to integrate Python.</li><li><strong>Instance Name:</strong> You can edit or copy the instance name. Renaming can be useful if the same module appears more than once in one network and/or if you want to access and distinguish the modules in your Python script.</li><li><strong>Help:</strong> The menu entry Help provides access to the Module Help pages and to an example network where the module is used. This example network often helps to understand which additional modules can be added to create your desired effect.</li><li><strong>Extras:</strong> Automated tests written for the specific module can be executed here. You can also run this module in a separate process.</li><li><strong>Reload Definition:</strong> In the case you are currently working on a module, you may need to reload the definition so that your changes are applied on the module (for example, attached Python scripts).</li><li><strong>Related Files:</strong> Related files allows a quick access to the modules <em>*.script</em> or <em>*.py</em> files. The files are automatically opened in <a href=glossary/#mevislab-mate>MATE</a> for editing. Changes on the .mlab file are applied permanently for your module.</li><li><strong>Show Enclosing Folder:</strong> This entry opens the directory where your module is stored.</li><li><strong>Grouping:</strong> Multiple modules can be clustered and the groups can be named. This adds clarity to the structure of your network. In addition to that, grouped modules can be converted to local or global macro modules easily.</li></ul><h3 id=Module_Connectors>Input and Output Connectors</h3><p>As the creation of a network requires connected modules, each module has input and output connectors, located on their top and bottom side. Data is transmitted from the output connector on the top side of one module to the input connector on another module&rsquo;s bottom side.</p><p>Once again, three types can be distinguished:</p><div class=table-responsive><table class="table table-striped"><thead><tr><th><div style=width:330px>Appearance</div></th><th><div style=width:130px>Shape</div></th><th>Definition</th></tr></thead><tbody><tr><td><p class=page-image><a data-modal=bs-lightbox href=images/tutorials/introduction/MLMConnectorTriangle.png title="Triangle - ML Image"><img id="Triangle - ML Image" class="img-fluid rounded" src=images/tutorials/introduction/MLMConnectorTriangle.png alt=Triangle title="Triangle - ML Image"></a><figcaption class=figure-caption>Triangle - ML Image</figcaption></p></td><td>triangle</td><td>ML images</td></tr><tr><td><p class=page-image><a data-modal=bs-lightbox href=images/tutorials/introduction/MLMConnectorHalfCircle.png title="Circle - Inventor Scene"><img id="Circle - Inventor Scene" class="img-fluid rounded" src=images/tutorials/introduction/MLMConnectorHalfCircle.png alt=Circle title="Circle - Inventor Scene"></a><figcaption class=figure-caption>Circle - Inventor Scene</figcaption></p></td><td>half-circle</td><td>Inventor scene</td></tr><tr><td><p class=page-image><a data-modal=bs-lightbox href=images/tutorials/introduction/MLMConnectorSquare.png title="Square - Base Object"><img id="Square - Base Object" class="img-fluid rounded" src=images/tutorials/introduction/MLMConnectorSquare.png alt=Square title="Square - Base Object"></a><figcaption class=figure-caption>Square - Base Object</figcaption></p></td><td>square</td><td>Base objects: Pointers to data structures</td></tr></tbody></table></div><svg style="display:none"><symbol id="check-fill" fill="currentColor" viewBox="0 0 16 16"><path d="M16 8A8 8 0 110 8a8 8 0 0116 0zm-3.97-3.03a.75.75.0 00-1.08.022L7.477 9.417 5.384 7.323a.75.75.0 00-1.06 1.06L6.97 11.03a.75.75.0 001.079-.02l3.992-4.99a.75.75.0 00-.01-1.05z"/></symbol><symbol id="info-fill" fill="currentColor" viewBox="0 0 16 16"><path d="M8 16A8 8 0 108 0a8 8 0 000 16zm.93-9.412-1 4.705c-.07.34.029.533.304.533.194.0.487-.07.686-.246l-.088.416c-.287.346-.92.598-1.465.598-.703.0-1.002-.422-.808-1.319l.738-3.468c.064-.293.006-.399-.287-.47l-.451-.081.082-.381 2.29-.287zM8 5.5a1 1 0 110-2 1 1 0 010 2z"/></symbol><symbol id="warning-fill" fill="currentColor" viewBox="0 0 16 16"><path d="M8.982 1.566a1.13 1.13.0 00-1.96.0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889.0 1.438-.99.98-1.767L8.982 1.566zM8 5c.535.0.954.462.9.995l-.35 3.507a.552.552.0 01-1.1.0L7.1 5.995A.905.905.0 018 5zm.002 6a1 1 0 110 2 1 1 0 010-2z"/></symbol><symbol id="danger-fill" fill="currentColor" viewBox="0 0 16 16"><path d="M8.982 1.566a1.13 1.13.0 00-1.96.0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889.0 1.438-.99.98-1.767L8.982 1.566zM8 5c.535.0.954.462.9.995l-.35 3.507a.552.552.0 01-1.1.0L7.1 5.995A.905.905.0 018 5zm.002 6a1 1 0 110 2 1 1 0 010-2z"/></symbol></svg><div class="alert alert-primary alert-info d-flex align-items-center" role=alert><svg class="bi flex-shrink-0 me-2" width="24" height="24" role="img" aria-label="Info:"><use xlink:href="#info-fill"/></svg><div><b>Info:&nbsp;</b>
6565
A connection can be established by dragging one module close to the other.</div></div><p>Some modules even contain hidden connectors in addition to the ones displayed on the module&rsquo;s surface. Click on the workspace and press
6666
<kbd>SPACE
6767
</kbd>to see the hidden connectors as well as the internal networks of each module. You can now also use the hidden connectors for building connections.</p><p>For more information about connectors and different types of connections, click

0 commit comments

Comments
 (0)