visual3d:documentation:pipeline:signal_commands:moving_stddev
Table of Contents
Moving_STDDEV
Overview
The Moving_STDDEV command allows users to calculate the standard deviation of a moving window for a specified window length.
Pipeline Command
Moving_STDDEV ! /SIGNAL_TYPES= ! /SIGNAL_FOLDER=ORIGINAL ! /SIGNAL_NAMES= ! /RESULT_TYPES= ! /RESULT_FOLDERS=PROCESSED ! /RESULT_NAME= ! /APPLY_AS_SUFFIX_TO_SIGNAL_NAME= ! /NUM_WINDOW_FRAMES=3 ! /IF_EVEN_FRAMES_INCREMENT_1=FALSE ;
Command Parameters
| Parameter Name | Parameter Description |
|---|---|
| Signal Types | The signal type(s) of the input signal(s). |
| Signal Folders | The folder(s) for the input signal(s). Default value is ORIGINAL. |
| Signal Names | The name(s) of the input signal(s). |
| Result Types | Resulting signals are stored as this signal type. By default these will mirror the input signal types. |
| Result Folders | Resulting signals are stored in this folder. Default value is PROCESSED. |
| Result Names | Resulting signals are stored with this name. NOTE: The Apply_Suffix_to_Signal_Name parameter modifies the behaviour of this parameter. |
| Apply as Suffix to Signal Name | If true, then the value in /Result_Names is affixed to the input signal's name as a suffix. |
| Num Window Frames | The size of the moving window in frames. Default value is 3. |
| If Even Frames Increment 1 | If true, then window sizes with an even number of frames have their size increased by one. If false, then these windows have their size decreased by 1. Default value is False. |
Dialog
The command can be edited in a text editor or in the dialog. To edit in the dialog, click on the Edit button in the pipeline workshop or double-click on the pipeline command. The dialog is shown below:
- Result Folder: Resulting signals are stored in this folder.
- Result Name: Resulting signals are stored with this name. NOTE: The Append Result Name as Suffix check box modifies the behaviour of this parameter.
- Append Result Name as Suffix: If checked, then the value in Result Name is affixed to the input signal's name as a suffix.
- NUM_WINDOW_FRAMES: The size of the moving window in frames.
- If NUM_WINDOW_FRAMES is even Increment by 1: If checked, even values for NUM_WINDOW_FRAMES are increased by one. If unchecked, then even values for NUM_WINDOW_FRAMES are decreased by 1.
Examples
This is a simple example for calculating the standard deviation of a right-hand marker's position in the Z-axis (inferior-superior) to detect movement onset.
Moving_STDDEV /SIGNAL_TYPES=TARGET /SIGNAL_FOLDER=ORIGINAL /SIGNAL_NAMES=RHA1 /RESULT_TYPES=TARGET /RESULT_FOLDERS=STDDEV /RESULT_NAME=RHA1 ! /APPLY_AS_SUFFIX_TO_SIGNAL_NAME= /NUM_WINDOW_FRAMES=9 ! /IF_EVEN_FRAMES_INCREMENT_1=FALSE ; Event_Threshold /RESULT_EVENT_NAME=Movement_Onset /SIGNAL_TYPES=TARGET /SIGNAL_FOLDER=STDDEV /SIGNAL_NAMES=RHA1 /SIGNAL_COMPONENTS=Z ! /FRAME_OFFSET=0 ! /TIME_OFFSET= /EVENT_SEQUENCE=START+END ! /EXCLUDE_EVENTS= ! /EVENT_SEQUENCE_INSTANCE=0 ! /EVENT_SUBSEQUENCE= ! /SUBSEQUENCE_EXCLUDE_EVENTS= ! /EVENT_SUBSEQUENCE_INSTANCE=0 ! /EVENT_INSTANCE=0 /THRESHOLD=0.2 /ON_ASCENT= TRUE ! /ON_DESCENT= ! /FRAME_WINDOW=8 ! /ENSURE_FRAMES_BEFORE=FALSE ! /ENSURE_FRAMES_AFTER=FALSE ;
Notes
The value of each frame in the output signal represents the standard deviation of the the frames in the window of size /NUM_WINDOW_FRAMES centered on that frame. This is why the window's size must be an odd number.
visual3d/documentation/pipeline/signal_commands/moving_stddev.txt · Last modified: by wikisysop