Revision as of 16:15, 30 March 2020

Introduction

One of the features of AnyWave is to run some processes in batch.
This means that you can use a dedicated GUI to program several processing on many files and execute all this processing
This feature is accessible from here:

Make my plugin compatible

This is quite simple. First, you need to edit the desc.txt and add the CanRunFromCommandLine flag:

edit desc.txt

Note: you can also use the NoDataRequired if your plugin does not a file to be open in AnyWave to run.
In this case the flags line will be: flags = CanRunFromCommandLine:NoDataRequired

name = MyPlugin
description = do something in MATLAB
category = Process:Test:MyPlugin
flags = CanRunFromCommandLine

JSON Files

After you've modified the desc.txt you will need to create two json files and place them in your plugin folder.

ui.json

There are some impotant things to setup in ui.json file:
There is a key describing the input parameters of the plugin. Suppose that you want to compute something on several files, you must then set several input_keys in the json file.
This is done by creating the input_keys key.
This key will hold the names of all the other keys that must be considered as files that AnyWave will provide to our plugin when running it.
In our example below, there is only ONE file key, that we called input_file which is the default key name for the file argument.
Hence, AnyWave will bring a GUI to pick up all the files we want, and run our plugin on all those files.
Once you setup the FILES entries keys, you must also describe them in the file by setting two values to the corresponding key.
The first value is always the decorated readable name of the key that will be used to create the GUI.
The second value is a string. If you set "check" as the value, that will tell AnyWave to check that the file setup is a data file and not a side car file.

Let's setup an example using one input file and two parameters:

{
"input_keys" : [ "input_file"],
"input_file" : ["Input File", "check"],
"hp" : ["High Pass Filter", "double"],
"lp" : ["Low Pass Filter", "double"],
"fields_ordering" : ["hp", "lp"]
}

input_keys : mandatory key. Here, we setup only one input file, and the key is called "input_file".
Then we must describe that key:

• "Input File" is the name used in the GUI to describe the parameter.
• "check" indicates that the file MUST be a data file that AnyWave can read.

fields_ordering: mandatory key. Describe the GUI fields order. Here we set up HP before LP in the GUI.

Between the mandatory keys, you have the other parameters:

• hp described as High Pass Filter, and "double" indicates this parameter is a double value.
• lp described as Low Pass Filter, and "double" indicates this parameter is a double value.

Others possible parameter values:

default.json

This file comes to se the default values for parameters described in ui.json.
So you need to define the same keys and set a default value for them.
In our skeleton that will be:

{
"input_file" : "", 
"hp" : 0.,
"lp" : 0.
}