Difference between revisions of "AnyWave:Faq"

From WikiMEG
Jump to: navigation, search
Line 1: Line 1:
 
'''Frequently asked questions (FAQ)''' about '''AnyWave'''. If you don't have an answer to your question reading the Documentation, you may find useful information here.
 
'''Frequently asked questions (FAQ)''' about '''AnyWave'''. If you don't have an answer to your question reading the Documentation, you may find useful information here.
 
=[[AnyWave:documentation|Where to get the documentation]]=
 
=[[AnyWave:documentation|Where to get the documentation]]=
−
=[[AnyWave::plugins|Plug-ins]]=
+
=Plug-ins=
−
=How to install a plug-in=
+
The application is provided with plug-ins which allow for example to read and write several data file formats, apply Time/Frequency representation to a signal, etc.
−
When installing '''AnyWave''' some plug-ins are also installed, allowing to read file formats and allowing to do processing on data.<br/>
+
==How to install a plug-in==
−
Those plug-ins are located in a Plugin folder:
+
The user may add custom plug-ins to AnyWave. Depending on the plug-in type (MATLAB, Python or Native) the location where to put the plug-in may vary.<br />
−
* On Windows and Linux systems the folder is called ''Plugins'' and is located in the AnyWave folder.
+
We strongly recommend NOT to add plug-ins in the Application directory, as it may require administrative privileges and it also make the plug-ins available to all the users on the computer.<br />
−
* On Mac systems, the folder is called ''Anywave_Plugins'' and is installed in the '''/Applications''' folder.
+
We suggest to install plug-in in the user home directory where AnyWave created special folders to place custom files.<br />
−
 
+
On the Windows platform, the base directory for plug-ins should be: "My Documents\AnyWave\Plugins".<br />
−
Adding a plug-in is done by copying the plug-in file in that folder. However, that will required administrator privileges.
+
On the Mac OS X and Linux platforms, the base directory for plug-ins should be: "AnyWave/Plugins" in the user's home directory.<br />
−
 
+
There are several types of plug-ins:
−
===How to install user plug-ins===
+
* An AnyWave native plug-in is a file (a C++ library) that must be copied directly in the root plugins directory.
−
One other way to install plug-ins is to copy them into the user's home directory.  
+
* A MATLAB plug-in is a directory containing several files and must be copied in the MATLAB sub-directory.
−
 
+
* A Python plug-in is also a directory containing several files and must be copied in the Python sub-directory.
−
Indeed, AnyWave will create a AnyWave folder in the user's home directory:
+
<br />
−
* On Windows that will be someting like: "My Documents\AnyWave" or "Documents\AnyWave".
+
===MATLAB Exception===
−
* On Linux it can be at /home/user/AnyWave
+
MATLAB plug-ins can be distributed as MATLAB .m files and thus require that MATLAB is available on the computer.<br />
−
* on Mac systems it will be located at /Users/user/AnyWave
+
AnyWave will call the MATLAB execution engine to run those files.<br />
−
 
+
<br />
−
This AnyWave folder will contain several other folders. The one usefull here is called Plugins.
+
MATLAB plug-ins can also be compiled and distributed as a standalone application.<br />
−
 
+
This will required the MATLAB Runtime to be installed on the computer. The Runtime is freely available from the Mathworks web site.
−
Copy user plug-ins file in that directory and AnyWave will load them the next time the user launches it.
+
−
 
+
−
==MATLAB plug-in==
+
−
'''AnyWave''' offers the possibility to run signal processing plug-ins written with the '''MATLAB''' programming language.<br/>
+
−
There are two ways to run MATLAB code as plug-ins:
+
−
* You may have a MATLAB Compiled code as a standalone application.
+
−
* You may have a MATLAB scripted plug-in which is simply MATLAB code.
+
−
 
+
−
===MATLAB Compiled Plugin===
+
−
A MATLAB Compiled plugin is a standalone application that AnyWave could launch and communicate with.<br />
+
−
To build that application the MATLAB Compiler is required as well as a C++ Compiler.<br />
+
−
Follow the instructions on the developer's corner page to see how to write a MATLAB plugin for AnyWave.<br />
+
−
 
+
−
===MATLAB Scripted Plugin===
+
−
If you are a mighty MATLAB programmer and thus have MATLAB installed on your computer, you may use and develop a MATLAB Scripted plugin.<br/>
+
−
A MATLAB Scripted plugin is a MATLAB function that will be called by AnyWave.<br/>
+
−
It is possible to use a MATLAB Scripted plugin written by someone else just by installing it in AnyWave.<br/>
+
−
 
+
−
===How to install a MATLAB Plugin===
+
−
There are two locations where AnyWave will look for MATLAB plug-ins during startup:<br />
+
−
First, AnyWave will look for plugins into the Plugins (Anywave_plugins on Mac OS X) folder. <br />
+
−
As this folder is installed along with AnyWave in the system default application path, it is not advised to add user plug-ins into that folder.<br />
+
−
The easier way to add user plug-ins is to use the User folder created by AnyWave at first launch.<br />
+
−
 
+
−
====Find the user plugins directory====
+
−
Look at the use home directory of your operating system and you should see a folder called AnyWave.<br />
+
−
Within that folder, some other folders should be present. The Plugins directory holds the different C++ plug-ins you want to add to AnyWave.<br />
+
−
For MATLAB plugins, you may have to create a subfolder named MATLAB into Plugins. Thus, on Unices system the path to MATLAB plugin should be like:<br />
+
−
''/home/user/AnyWave/Plugins/MATLAB''<br />
+
−
where on Windows the path should be:<br />
+
−
''My Documents\AnyWave\Plugins\MATLAB''
+
−
 
+
−
Copy your MATLAB plugins into the right directory and launch AnyWave.<br />
+
−
A MATLAB plugin is a directory containing several files. For more detail see the section [[AnyWave:WriteMatlabScripted|How to write a MATLAB plug-in]]
+
−
 
+
−
==Python plug-ins==
+
−
This feature is under complete re-development. Please, subscribe to the google group to keep in touch.
+
  
 
=File formats=
 
=File formats=

Revision as of 15:59, 6 January 2017

Frequently asked questions (FAQ) about AnyWave. If you don't have an answer to your question reading the Documentation, you may find useful information here.

Where to get the documentation

Plug-ins

The application is provided with plug-ins which allow for example to read and write several data file formats, apply Time/Frequency representation to a signal, etc.

How to install a plug-in

The user may add custom plug-ins to AnyWave. Depending on the plug-in type (MATLAB, Python or Native) the location where to put the plug-in may vary.
We strongly recommend NOT to add plug-ins in the Application directory, as it may require administrative privileges and it also make the plug-ins available to all the users on the computer.
We suggest to install plug-in in the user home directory where AnyWave created special folders to place custom files.
On the Windows platform, the base directory for plug-ins should be: "My Documents\AnyWave\Plugins".
On the Mac OS X and Linux platforms, the base directory for plug-ins should be: "AnyWave/Plugins" in the user's home directory.
There are several types of plug-ins:

  • An AnyWave native plug-in is a file (a C++ library) that must be copied directly in the root plugins directory.
  • A MATLAB plug-in is a directory containing several files and must be copied in the MATLAB sub-directory.
  • A Python plug-in is also a directory containing several files and must be copied in the Python sub-directory.


MATLAB Exception

MATLAB plug-ins can be distributed as MATLAB .m files and thus require that MATLAB is available on the computer.
AnyWave will call the MATLAB execution engine to run those files.

MATLAB plug-ins can also be compiled and distributed as a standalone application.
This will required the MATLAB Runtime to be installed on the computer. The Runtime is freely available from the Mathworks web site.

File formats

AnyWave can read and/or write to different file formats depending on the available plug-ins.

For EEG data the following formats are supported for reading:

  • Micromed (.trc)
  • Electrode Array (.eab)
  • EDF+/BDF+ (.eeg)
  • Brainvision Analyser (.vhdr)
  • ANT EEProbe (.cnt)
  • Neuroscan old format (.cnt)
  • ADES (.ades) AnyWave simple format.

For MEG data the following formats are supported for reading:

  • 4DNI
  • CTF
  • ADES (.ades) AnyWave simple format.

It is also possible to export to the following formats:

  • Brainvision Analyser (.vhdr)
  • ADES (.ades) AnyWave simple format.

ADES format

This is a simple file format used mostly to exchange data between different software. This is NOT the official AnyWave format but just a media used for exchanging between software.

Here is a complete documentation of the ADES file format

Retrieved from "https://meg.univ-amu.fr/index.php?title=AnyWave:Faq&oldid=24899"