Skip to content

GitLab

  • Menu
Projects Groups Snippets
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in
  • D Documentation
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 0
    • Issues 0
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 0
    • Merge requests 0
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Monitor
    • Monitor
    • Incidents
  • Packages & Registries
    • Packages & Registries
    • Package Registry
    • Container Registry
    • Infrastructure Registry
  • Analytics
    • Analytics
    • CI/CD
    • Repository
    • Value Stream
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • anywave
  • Documentation
  • Wiki
  • MATLAB_API

MATLAB_API · Changes

Page history
Update MATLAB_API authored Jul 10, 2024 by Bruno Colombet's avatar Bruno Colombet
Hide whitespace changes
Inline Side-by-side
Showing with 8 additions and 17 deletions
+8 -17
  • MATLAB_API.md MATLAB_API.md +8 -17
  • No files found.
MATLAB_API.md
View page @ 22f755ca
......@@ -4,29 +4,20 @@ Documents\AnyWave\Plugins\MATLAB on Windows.
/users/username/AnyWave/Plugins/MATLAB on MacOS.
# Requirements
MATLAB shoulb be installed if you plan to run scripted plugins, obviously.
AnyWave should detect the MATLAB installation when starting but it is also possible to set the path to the MATLAB installation in the Edit->Preferences menu.
MATLAB.
AnyWave will detect the MATLAB installation when starting but it is also possible to set the path to the MATLAB installation in the Edit->Preferences menu.
About standalone (compiled) plugins: The matching MATLAB runtime must be installed in your system.
On Windows there is nothing special to do, if the Runtime is in the current system PATH, then the standalone plugin will find it.
On MacOS and Linux however, you must SET the path to the MATLAB Runtime installation in the Edit->Preferences of AnyWave.
That will allow AnyWave to run the standalone versions of your plugins.
# 1. Use the Plugin Creation Assistant
![image](uploads/23e581415d4eb9424cb054041ccf3fce/image.png)
# 1. Starting with anywave v2105 you can use the Plugin Creation Tool to create a new plugin.
![image](uploads/01116de2544c9f699dac89bacd3adeca/image.png)
# 1.1 Make it by your own
Create a folder in AnyWave/Plugins/MATLAB directory.
In that directory, create two files:
- *desc.txt*
- *main.m*
# 1.1.1 desc.txt
# 1.1 desc.txt
This file is a simple text file that must contain the following lines:
*name = My Plugin*
*description = Do something on data*
# 1.1.1.1 optional lines
# 1.1.1 optional lines
To tune up the behavior of your plugin you may add some flags to tell AnyWave what you plugin can do:
*flags=nodatarequired* -> this line will inform anywave that your plugin can run even if no data file is open.
*flags=canrunfromcommandline* -> this flag indicates that your plugin can be run from the command line.
......@@ -37,12 +28,12 @@ Put your plugin in a submenu, by adding the following line:
*category=Process:MyCategory:My plugin*
This line will create a sub menu called MyCategory in the Processes Menu of AnyWave and a link to launch the plugin.
# 1.1.2 main.m
# 1.2 main.m
This is a MATLAB function you can create within MATLAB.
````matlab
function main(varargin)
args = anywave('init', varargin);
% args contains all the proporties related to AnyWave current data file and the plugin context.
% args contains all the properties related to AnyWave current data file and the plugin context.
% my plugin code starts here
````
......
Clone repository
  • Build_AnyWave
  • CLI
  • CLI_List
  • Changes
  • ExportData
  • MATLAB_API
  • MATLAB_BIDS
  • MATLAB_debug
  • MATLAB_functions
  • MATLAB_get_data
  • MATLAB_get_data_ex
  • MATLAB_get_markers
  • MATLAB_get_props
  • MATLAB_init
  • MATLAB_run
View All Pages