Difference between revisions of "Documentation/Nightly/Modules/MatlabCommander"

From Slicer Wiki
Jump to: navigation, search
(Created page with 'test')
 
Line 1: Line 1:
−
test
+
<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.
 +
 
 +
<!-- ---------------------------- -->
 +
{{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}}
 +
* Matlab configuration
 +
** Matlab executable: Path to the Matlab executable (e.g., F:/Program Files/MATLAB/R2013a/bin/matlab.exe)
 +
** Matlab script directory: For information only, the default path for new generated Matlab modules
 +
* Matlab module generation
 +
** Module name: Name of the matlab module, as it should appear in the module list. Module file names are created by removing spaces from the name.
 +
** Generate module: generates module files in the Matlab script directory
 +
** Status box: result of the module generation is shown in this textbox
 +
<!--
 +
{{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 is responsible for setting the following environment variables (used by the Module Proxy and MatlabCommander):
 +
* SLICER_MATLAB_EXECUTABLE_PATH: path to Matlab.exe
 +
* SLICER_MATLAB_COMMANDER_PATH: path to MatlabCommander.exe (determines automatically by using relative paths)
 +
* SLICER_MATLAB_COMMAND_SERVER_SCRIPT_PATH: path to commandserver.m (determines automatically by using relative paths)
 +
The module stores the following information in settings file:
 +
* Slicer.ini: [Matlab]/MatlabExecutablePath
 +
* Slicer-NNN.ini: [Modules]/AdditionalPaths (adds the Matlab script directory so that the generated modules are found by Slicer)
 +
<!--
 +
{{documentation/{{documentation/version}}/module-developerinfo}}
 +
-->
 +
 
 +
<!-- ---------------------------- -->
 +
{{documentation/{{documentation/version}}/module-footer}}
 +
<!-- ---------------------------- -->

Revision as of 12:20, 29 June 2013

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.
Author: Andras Lasso (PerkLab, Queen's University), Jean-Christophe Fillion-Robin (Kitware), Kevin Wang (Radiation Medicine Program, Princess Margaret Hospital, University Health Network Toronto)
Contact: Andras Lasso, <email>lasso@cs.queensu.ca</email>

Cancer Care Ontario  
Software Platform and Adaptive Radiotherapy Kit  

Module Description

The MatlabCommander module is used for running Matlab functions from within Slicer.

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

  • Matlab configuration
    • Matlab executable: Path to the Matlab executable (e.g., F:/Program Files/MATLAB/R2013a/bin/matlab.exe)
    • Matlab script directory: For information only, the default path for new generated Matlab modules
  • Matlab module generation
    • Module name: Name of the matlab module, as it should appear in the module list. Module file names are created by removing spaces from the name.
    • Generate module: generates module files in the Matlab script directory
    • Status box: result of the module generation is shown in this textbox


Information for Developers

The module is responsible for setting the following environment variables (used by the Module Proxy and MatlabCommander):

  • SLICER_MATLAB_EXECUTABLE_PATH: path to Matlab.exe
  • SLICER_MATLAB_COMMANDER_PATH: path to MatlabCommander.exe (determines automatically by using relative paths)
  • SLICER_MATLAB_COMMAND_SERVER_SCRIPT_PATH: path to commandserver.m (determines automatically by using relative paths)

The module stores the following information in settings file:

  • Slicer.ini: [Matlab]/MatlabExecutablePath
  • Slicer-NNN.ini: [Modules]/AdditionalPaths (adds the Matlab script directory so that the generated modules are found by Slicer)


Retrieved from "https://www.slicer.org/w/index.php?title=Documentation/Nightly/Modules/MatlabCommander&oldid=33647"