The basics
Constructing the signal chain
The processing pipeline is built by dragging names of modules from the list on the left and dropping them onto the signal chain. A couple of rules must be obeyed:
- Every signal chain must contain a source. Sources feed data into the signal chain; without them, the signal chain has nothing to do. Currently, acquisition won't work unless a source is present in every signal chain. It's fine to have a signal chain with nothing but a source, if all you want to do is stream data to disk.
- Sources may only be placed at the start of a signal chain, and sinks may only be placed at the end. If a source or sink is dropped in the middle of the signal chain, the chain will automatically split in two.
Otherwise, you can have an arbitrary number of signal chains, which can branch an arbitrary number of times. However, be wary of bugs with loading and saving complex, branching signal chains.
Modules can be removed by clicking on their titles and pressing the "delete" key. Their order can be rearranged by dragging and dropping modules within the signal chain.
Pressing Cmd-Delete (OS X) or Ctrl-Delete (Linux and Window) will clear all modules from all signal chains.
Setting parameters
Most modules have a straightforward set of parameters that appear in the editor. Although the signal chain becomes locked while data acquisition is active, it's possible to edit parameters at any time. Parameter changes are not currently tracked, so be careful about changing parameters while you're recording.
Opening/saving the signal chain.
Use Cmd-S/Ctrl-S (or the "File" drop-down menu) to save the signal chain. It must have an .xml extension.
Use Cmd-O/Ctrl-O (or the "File" drop-down menu) to open a previously saved signal chain. It must have an .xml extension in order to load.
Most, but not all, modules will save their internal settings. For safety purposes, assume that any module will not reload its settings until you confirm that it does. If settings are not being loaded properly for a particular module, feel free to submit an issue on GitHub.