Difference between revisions of "Documentation/Nightly/Modules/MatlabCommander"
(Created page with 'test') |
m (Text replacement - "https?:\/\/(?:www|wiki)\.slicer\.org\/slicerWiki\/index\.php\/([^ ]+) " to "https://www.slicer.org/wiki/$1 ") |
||
| (3 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
| − | + | <noinclude>{{documentation/versioncheck}}</noinclude> | |
| + | <!-- ---------------------------- --> | ||
| + | {{documentation/{{documentation/version}}/module-header}} | ||
| + | <!-- ---------------------------- --> | ||
| + | |||
| + | <!-- ---------------------------- --> | ||
| + | {{documentation/{{documentation/version}}/module-section|Introduction and Acknowledgements}} | ||
| + | {{documentation/{{documentation/version}}/module-introduction-start|{{documentation/modulename}}}} | ||
| + | {{documentation/{{documentation/version}}/module-introduction-row}} | ||
| + | This work is part of the SparKit project, funded by An Applied Cancer Research Unit of Cancer Care Ontario with funds provided by the Ministry of Health and Long-Term Care and the Ontario Consortium for Adaptive Interventions in Radiation Oncology (OCAIRO) to provide free, open-source toolset for radiotherapy and related image-guided interventions.<br> | ||
| + | Author: Andras Lasso (PerkLab, Queen's University), Jean-Christophe Fillion-Robin (Kitware), Kevin Wang (Radiation Medicine Program, Princess Margaret Hospital, University Health Network Toronto)<br> | ||
| + | Contact: Andras Lasso, <email>lasso@cs.queensu.ca</email><br> | ||
| + | {{documentation/{{documentation/version}}/module-introduction-row}} | ||
| + | {{documentation/{{documentation/version}}/module-introduction-logo-gallery | ||
| + | |{{collaborator|logo|cco}}|{{collaborator|longname|cco}} | ||
| + | |{{collaborator|logo|sparkit}}|{{collaborator|longname|sparkit}} | ||
| + | }} | ||
| + | {{documentation/{{documentation/version}}/module-introduction-end}} | ||
| + | |||
| + | <!-- ---------------------------- --> | ||
| + | {{documentation/{{documentation/version}}/module-section|Module Description}} | ||
| + | The {{documentation/modulename}} module is used for running Matlab functions from within Slicer. | ||
| + | |||
| + | It may be necessary to manually add an exception to the firewall to allow Slicer to communicate with the Matlab server on port 4100. | ||
| + | |||
| + | <!-- ---------------------------- --> | ||
| + | {{documentation/{{documentation/version}}/module-section|Use Cases}} | ||
| + | The main use of this module is allowing any Slicer module to run Matlab commands, but the module can be also used for manual testing of the Matlab connection or running simple commands and observe the results without switching to Matlab. | ||
| + | <!-- ---------------------------- --> | ||
| + | {{documentation/{{documentation/version}}/module-section|Tutorials}} | ||
| + | See [[Documentation/{{documentation/version}}/Extensions/MatlabBridge|Matlab Bridge extension page]] | ||
| + | |||
| + | <!-- ---------------------------- --> | ||
| + | {{documentation/{{documentation/version}}/module-section|Panels and their use}} | ||
| + | |||
| + | <!-- | ||
| + | Update this page with the new revision of the module to update the parameter description: | ||
| + | https://www.slicer.org/wiki/Documentation/Nightly/ModulesMetadata | ||
| + | --> | ||
| + | {{documentation/{{documentation/version}}/module-parametersdescription}} <!-- ---------------------------- | ||
| + | {{documentation/{{documentation/version}}/module-section|Similar Modules}} | ||
| + | --> | ||
| + | <!-- ---------------------------- | ||
| + | {{documentation/{{documentation/version}}/module-section|References}} | ||
| + | --> | ||
| + | |||
| + | <!-- ---------------------------- --> | ||
| + | {{documentation/{{documentation/version}}/module-section|Information for Developers}} | ||
| + | The module requires the following environment variables (set by Matlab Module Generator module, as it is a loadable module with access to all configuration settings): | ||
| + | * SLICER_MATLAB_EXECUTABLE_PATH: path to Matlab.exe | ||
| + | * SLICER_MATLAB_COMMAND_SERVER_SCRIPT_PATH: path to commandserver.m | ||
| + | |||
| + | The module communicates with Matlab using OpenIGTLink. The commandserver script implements an OpenIGTLink server, which accepts STRING commands (requests should be sent to the CMD or CMD_someuid device and response will be sent from a device named ACK or ACK_someuid) | ||
| + | <!-- | ||
| + | {{documentation/{{documentation/version}}/module-developerinfo}} | ||
| + | --> | ||
| + | |||
| + | <!-- ---------------------------- --> | ||
| + | {{documentation/{{documentation/version}}/module-footer}} | ||
| + | <!-- ---------------------------- --> | ||
Latest revision as of 13:15, 27 November 2019
Home < Documentation < Nightly < Modules < MatlabCommander
|
For the latest Slicer documentation, visit the read-the-docs. |
Introduction and Acknowledgements
|
This work is part of the SparKit project, funded by An Applied Cancer Research Unit of Cancer Care Ontario with funds provided by the Ministry of Health and Long-Term Care and the Ontario Consortium for Adaptive Interventions in Radiation Oncology (OCAIRO) to provide free, open-source toolset for radiotherapy and related image-guided interventions. | |||||
|
Module Description
The MatlabCommander module is used for running Matlab functions from within Slicer.
It may be necessary to manually add an exception to the firewall to allow Slicer to communicate with the Matlab server on port 4100.
Use Cases
The main use of this module is allowing any Slicer module to run Matlab commands, but the module can be also used for manual testing of the Matlab connection or running simple commands and observe the results without switching to Matlab.
Tutorials
See Matlab Bridge extension page
Panels and their use
Parameters:
()
* ':
** ':
*** ':
List of parameters generated transforming this XML file using this XSL file. To update the URL of the XML file, edit this page.
Information for Developers
The module requires the following environment variables (set by Matlab Module Generator module, as it is a loadable module with access to all configuration settings):
- SLICER_MATLAB_EXECUTABLE_PATH: path to Matlab.exe
- SLICER_MATLAB_COMMAND_SERVER_SCRIPT_PATH: path to commandserver.m
The module communicates with Matlab using OpenIGTLink. The commandserver script implements an OpenIGTLink server, which accepts STRING commands (requests should be sent to the CMD or CMD_someuid device and response will be sent from a device named ACK or ACK_someuid)
