In the framework NDManager is part of the data processing is accomplished by a set of programs launch by scripts (e.g a program would convert data from the recording system format to the format used by NeuroScope). To centralize all the information for a given experiment, the parameter file contains all the parameters used to view/process/analyze your data, this includes the parameters needed by the scripts.
Each script is described by its name, the list of its parameters and their default values, and a small help text (describing the goals of the script and explaining its parameters).
How does NDManager get its information about the scripts, in order to present a nice graphical interface? The information for each script can be stored in small (xml) description file and loaded into NDManager. Some programs and their corresponding scripts are provided as part of the framework. To load a script description, go to the Scripts Page and press the button and navigate to the desire file. You can load several files at a time using Shift or Control while selecting the files in the dialog (the order of the scripts in NDManager does not matter). Upon loading, a new page with a set of three tabs (Parameters, Help and Script) containing the information corresponding to the script will be created.
The framework provides some programs and their corresponding scripts, but you will certainly need to do specific processing on your data. You will therefore need to write your own programs and scripts. The scripts should read the parameters from the xml parameter file and then call the programs.
Try to keep the programs and scripts modular (one task per script/program) and separate (independent).
Once you have written your script and program, you will need to create a new script description. This is very easy to do with NDManager. First, be sure to be in Expert Mode (select ->) and go to the Scripts Page and press the button; a new page with a set of three tabs (Parameters, Help and Script) will be created. Use this page to describe your new script.
The Parameters tab allows you to specify the parameters used by the script. To add a parameter, press the button; and, in the newly created row provide the parameter name, default value and status. To remove parameters, select the corresponding rows and press the button.
The Help tab contains a simple text editor which allows you to describe the aim of the script and provide information about the parameters. This description is saved in the parameter file.
The Script tab contains an advanced text editor with syntax highlighting (it is a Kate Part) which allows you to easily edit your script (if the script is in your path, it will be automatically loaded when you specify its name in the Parameters tab). To save the modification done to your scrip, press the button.
Using the application -> entry will save the parameter file (including the script descriptions) but not the script itself.
Using the application -> entry will save your new script description in the current parameter file. To save your new script description to file (the containts of the Parameters and Help tabs), press the button. Creating a script description file, allows you to reuse the same script for different kind of experiments and to share it with other researchers.
To remove a script description from a given parameter file, simply press the button.
Would you like to make a comment or contribute an update to this page?
Send feedback to the KDE Docs Team