Documentation/Nightly/Extensions/MatlabBridge - Revision history

Lasso at 04:45, 20 June 2018

2018-06-20T04:45:58Z

Lasso at 02:24, 12 September 2017

2017-09-12T02:24:08Z

Lasso at 18:16, 21 October 2015

2015-10-21T18:16:05Z

Lasso at 13:34, 1 June 2015

2015-06-01T13:34:33Z

Lasso at 15:57, 11 April 2015

2015-04-11T15:57:03Z

Lasso at 15:42, 8 August 2014

2014-08-08T15:42:15Z

Wangk at 17:32, 20 February 2014

2014-02-20T17:32:22Z

Lasso at 14:32, 16 February 2014

2014-02-16T14:32:27Z

Lasso: Added more detailed documentation of running Matlab on a computer without Matlab license

2014-02-16T14:26:31Z

Added more detailed documentation of running Matlab on a computer without Matlab license

Lasso at 15:38, 15 February 2014

2014-02-15T15:38:23Z

@@ Line 32: / Line 32: @@
 Demo videos:
-* [http://screencast.com/t/TgAVE6Wa8mf Creating and using a Matlab module]
+* [https://youtu.be/dFNbt1sIdqQ Creating and using a Matlab module]
-* [http://screencast.com/t/LcdrCx9l0 Editing and debugging a Matlab module]
+* [https://youtu.be/8LijOcv3GDY Editing and debugging a Matlab module]
 Tutorial: [[Media:MatlabBridgeTutorial.pdf|How to create, run, customize Matlab modules]]
@@ Line 61: / Line 61: @@
 *[https://github.com/PerkLab/SlicerMatlabBridge/tree/master/Examples/ A few example modules]
 * [[documentation/{{documentation/version}}/Developers/SlicerExecutionModel#XML_Schema|Specification of module descriptor XML file]]
-* Demo video: [http://screencast.com/t/TgAVE6Wa8mf Creating and using a Matlab module]
+* Demo video: [https://youtu.be/dFNbt1sIdqQ Creating and using a Matlab module]
-* Demo video: [http://screencast.com/t/LcdrCx9l0 Editing and debugging a Matlab module]
+* Demo video: [https://youtu.be/8LijOcv3GDY Editing and debugging a Matlab module]
 <!-- ---------------------------- -->
 <!--

@@ Line 59: / Line 59: @@
 {{documentation/{{documentation/version}}/extension-section|Tutorials}}
 *'''[[Media:MatlabBridgeTutorial.pdf|Comprehensive MatlabBridge tutorial: how to create, run, customize Matlab modules]]'''
-*[https://subversion.assembla.com/svn/slicerrt/trunk/MatlabBridge/src/Examples/ A few example modules]
+*[https://github.com/PerkLab/SlicerMatlabBridge/tree/master/Examples/ A few example modules]
 * [[documentation/{{documentation/version}}/Developers/SlicerExecutionModel#XML_Schema|Specification of module descriptor XML file]]
 * Demo video: [http://screencast.com/t/TgAVE6Wa8mf Creating and using a Matlab module]
@@ Line 74: / Line 74: @@
 <!-- ---------------------------- -->
 {{documentation/{{documentation/version}}/extension-section|Information for Developers}}
-* Source code: https://subversion.assembla.com/svn/slicerrt/trunk/MatlabBridge/
+* Source code: https://github.com/PerkLab/SlicerMatlabBridge/tree/master/
-* Issue tracker:  [https://www.assembla.com/spaces/dG15GuCs4r4l4UeJe5cbCb/tickets/report/u783013 open issues and enhancement requests]
+* Issue tracker:  [https://github.com/PerkLab/SlicerMatlabBridge/issues open issues and enhancement requests]
-* Design overview: [https://subversion.assembla.com/svn/slicerrt/trunk/MatlabBridge/doc/MatlabBridgeDesign.pptx].
+* Design overview: [https://github.com/PerkLab/SlicerMatlabBridge/raw/master/Docs/MatlabBridgeDesign.pptx].
 * Running Matlab modules without accessing a Matlab license: You can run your Matlab modules on a computer that does not have Matlab license by using the Matlab Compiler.
 ** On the development computer (with Matlab and Matlab Compiler license) create an executable (let's call it MyModuleCollection.exe) with the Matlab Compiler:
-*** include all the MatlabBridge CommandServer functions (https://subversion.assembla.com/svn/slicerrt/trunk/MatlabBridge/src/MatlabCommander/commandserver/) as Shared Resources
+*** include all the MatlabBridge CommandServer functions (https://github.com/PerkLab/SlicerMatlabBridge/tree/master/MatlabCommander/commandserver) as Shared Resources
 *** include your custom .m files (including the .m file that the slicer module generator creates) as Shared Resources
 *** choose cli_commandserver.m as "Main File"

@@ Line 60: / Line 60: @@
 *'''[[Media:MatlabBridgeTutorial.pdf|Comprehensive MatlabBridge tutorial: how to create, run, customize Matlab modules]]'''
 *[https://subversion.assembla.com/svn/slicerrt/trunk/MatlabBridge/src/Examples/ A few example modules]
 * Demo video: [http://screencast.com/t/TgAVE6Wa8mf Creating and using a Matlab module]
 * Demo video: [http://screencast.com/t/LcdrCx9l0 Editing and debugging a Matlab module]

@@ Line 81: / Line 81: @@
 *** include your custom .m files (including the .m file that the slicer module generator creates) as Shared Resources
 *** choose cli_commandserver.m as "Main File"
-** Installation on the target computer:
+** Installation on the target computer (a self-contained executable can be created as described on the [[Documentation/Labs/CustomSlicerGenerator]] page):
 *** Copy the MyModuleCollection.exe to the target computer (it can be anywhere, but make sure it's not in a directory that is listed in Slicer additional module paths)
 *** Set the location of your Matlab module proxy (.bat file or shell script) and CLI descriptor (.xml) files as additional module paths in Slicer
 ** Running on the target computer:

@@ Line 110: / Line 110: @@
 **** Where is <SlicerExtensionDirectory>? Open the 'Matlab Module Generator' module in Slicer, it shows ''Matlab script directory''. <SlicerExtensionDirectory> is the parent directory of ''Matlab script directory''.
 *** Run your module in Slicer. Matlab will stop at the specified breakpoints and you can observer variables and do step-by-step debugging.
 <!-- ---------------------------- -->

@@ Line 102: / Line 102: @@
 * Problem: module execution is not completed
 ** Solution: make sure you've selected .../MATLAB/.../bin/matlab.exe as Matlab executable (and not .../MATLAB/.../bin/win64/MATLAB.exe)
 <!-- ---------------------------- -->

@@ Line 4: / Line 4: @@
 <!-- ---------------------------- -->
 {{documentation/{{documentation/version}}/module-section|Introduction and Acknowledgements}}
-Author: Andras Lasso (PerkLab, Queen's University), Jean-Christophe Fillion-Robin (Kitware), Kevin Wang (Radiation Medicine Program, Princess Margaret Hospital, University Health Network Toronto), Gabor Fichtinger (PerkLab, Queen's University)<br>
+Author: Andras Lasso (PerkLab, Queen's University), Jean-Christophe Fillion-Robin (Kitware), Kevin Wang (Princess Margaret Cancer Centre), Gabor Fichtinger (PerkLab, Queen's University)<br>
 Contact: Andras Lasso, <email>lasso@cs.queensu.ca</email><br>
 Project website: http://www.slicerrt.org<br>
@@ Line 12: / Line 12: @@
 |{{collaborator|logo|namic}}|NA-MIC
 |{{collaborator|logo|perklab}}|PerkLab
 }}

@@ Line 79: / Line 79: @@
 *** include all the MatlabBridge CommandServer functions (https://subversion.assembla.com/svn/slicerrt/trunk/MatlabBridge/src/MatlabCommander/commandserver/) as Shared Resources
 *** include your custom .m files (including the .m file that the slicer module generator creates) as Shared Resources
-*** choose cli_commandserver.m as "Main File". To run the Matlab modules just start the compiled MCR executable before running your module
+*** choose cli_commandserver.m as "Main File"
 ** Installation on the target computer:
-*** Copy the MyModuleCollection.exe to the target computer, make sure it's not in the additional module paths
+*** Copy the MyModuleCollection.exe to the target computer (it can be anywhere, but make sure it's not in a directory that is listed in Slicer additional module paths)
-*** Set the location of the .bat and .xml files as additional module paths in Slicer
+*** Set the location of your Matlab module proxy (.bat file or shell script) and CLI descriptor (.xml) files as additional module paths in Slicer
 ** Running on the target computer:
-*** Start MyModuleCollection.exe (anytime _before_ you start Slicer)
+*** Start MyModuleCollection.exe (anytime ''before'' you start Slicer)
 *** Start Slicer
 * Tested with Matlab R2009b, R2012a, and R2013a on Windows7.