https://www.slicer.org/w/index.php?action=history&feed=atom&title=Documentation%2F4.10%2FModules%2FMatlabModuleGeneratorDocumentation/4.10/Modules/MatlabModuleGenerator - Revision history2026-04-08T06:52:13ZRevision history for this page on the wikiMediaWiki 1.33.0https://www.slicer.org/w/index.php?title=Documentation/4.10/Modules/MatlabModuleGenerator&diff=60203&oldid=prevUpdateBot: Nightly -> 4.102018-10-19T00:46:52Z<p>Nightly -> 4.10</p>
<p><b>New page</b></p><div><noinclude>{{documentation/versioncheck}}</noinclude><br />
<!-- ---------------------------- --><br />
{{documentation/{{documentation/version}}/module-header}}<br />
<!-- ---------------------------- --><br />
<br />
<!-- ---------------------------- --><br />
{{documentation/{{documentation/version}}/module-section|Introduction and Acknowledgements}}<br />
{{documentation/{{documentation/version}}/module-introduction-start|{{documentation/modulename}}}}<br />
{{documentation/{{documentation/version}}/module-introduction-row}}<br />
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><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><br />
Contact: Andras Lasso, <email>lasso@cs.queensu.ca</email><br><br />
{{documentation/{{documentation/version}}/module-introduction-row}}<br />
{{documentation/{{documentation/version}}/module-introduction-logo-gallery<br />
|{{collaborator|logo|cco}}|{{collaborator|longname|cco}}<br />
|{{collaborator|logo|sparkit}}|{{collaborator|longname|sparkit}}<br />
}}<br />
{{documentation/{{documentation/version}}/module-introduction-end}}<br />
<br />
<!-- ---------------------------- --><br />
{{documentation/{{documentation/version}}/module-section|Module Description}}<br />
The {{documentation/modulename}} module is used for generating a skeleton Matlab module that the user can further customize to implement the intended functionality. The module also allows the user to specify the location of the Matlab executable.<br />
<br />
<!-- ---------------------------- --><br />
{{documentation/{{documentation/version}}/module-section|Use Cases}}<br />
* Specify path to the Matlab executable (Matlab.exe)<br />
* Generate a skeleton module. Each module consists of the following three files:<br />
** Matlab script (ModuleName.m): Matlab function implementation, performs the actual computations<br />
** Command-line interface definition (ModuleName.xml): defines the input and output of the algorithm, Slicer uses this file to generate the graphical user interface of the module<br />
** Module proxy (ModuleName.bat or ModuleName.sh): automatically generated executable file, it is responsible for calling Matlab (by using the MatlabCommander module)<br />
<!-- ---------------------------- --><br />
{{documentation/{{documentation/version}}/module-section|Tutorials}}<br />
See [[Documentation/{{documentation/version}}/Extensions/MatlabBridge|Matlab Bridge extension page]]<br />
<br />
<!-- ---------------------------- --><br />
{{documentation/{{documentation/version}}/module-section|Panels and their use}}<br />
* Matlab configuration<br />
** Matlab executable: Path to the Matlab executable (e.g., F:/Program Files/MATLAB/R2013a/bin/matlab.exe)<br />
** Matlab script directory: For information only, the default path for new generated Matlab modules<br />
* Matlab module generation<br />
** 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.<br />
** Generate module: generates module files in the Matlab script directory<br />
** Status box: result of the module generation is shown in this textbox<br />
<!--<br />
{{documentation/{{documentation/version}}/module-parametersdescription}}<br />
--><br />
<br />
<!-- ---------------------------- <br />
{{documentation/{{documentation/version}}/module-section|Similar Modules}}<br />
--><br />
<!-- ---------------------------- <br />
{{documentation/{{documentation/version}}/module-section|References}}<br />
--><br />
<br />
<!-- ---------------------------- --><br />
{{documentation/{{documentation/version}}/module-section|Information for Developers}}<br />
The module is responsible for setting the following environment variables (used by the Module Proxy and MatlabCommander):<br />
* SLICER_MATLAB_EXECUTABLE_PATH: path to Matlab.exe<br />
* SLICER_MATLAB_COMMANDER_PATH: path to MatlabCommander.exe (determines automatically by using relative paths)<br />
* SLICER_MATLAB_COMMAND_SERVER_SCRIPT_PATH: path to commandserver.m (determines automatically by using relative paths)<br />
The module stores the following information in settings file:<br />
* Slicer.ini: [Matlab]/MatlabExecutablePath<br />
* Slicer-NNN.ini: [Modules]/AdditionalPaths (adds the Matlab script directory so that the generated modules are found by Slicer)<br />
<!--<br />
{{documentation/{{documentation/version}}/module-developerinfo}}<br />
--><br />
<br />
<!-- ---------------------------- --><br />
{{documentation/{{documentation/version}}/module-footer}}<br />
<!-- ---------------------------- --></div>UpdateBot