Differences

This shows you the differences between two versions of the page.

--- visual3d:documentation:pipeline:signal_commands:moving_rms [2024/06/19 12:53] – sgranger
+++ visual3d:documentation:pipeline:signal_commands:moving_rms [2026/04/27 17:59] (current) – [Pipeline Command] wikisysop
@@ Line 1: / Line 1: @@
-{{the **moving_rms** command computes the linear envelope of a signal (typically an emg signal) by calculating the rms value within a moving window. the rms is described [[http://en.wikipedia.org/wiki/root_mean_square|here]]
+====== Moving RMS ======
+The **Moving_RMS** command computes the linear envelope of a signal (typically an EMG signal) by calculating the RMS value within a moving window. The RMS is described [[http://en.wikipedia.org/wiki/Root_mean_square|here]]
-the number of frames in the window must be an odd number. the output value at each frame is the rms of the window centered on that frame.
+The number of frames in the window must be an odd number. The output value at each frame is the RMS of the window centered on that frame.
+====Pipeline Command====
+The **Moving RMS** command can be found in the Pipeline Workshop within the Signal Filter folder as so:
 <code>
-moving_rms
+Moving_RMS
-! /signal_types=
+! /Signal_Types=
-! /signal_folder=original
+! /Signal_Folder=ORIGINAL
-! /signal_names=
+! /Signal_Names=
-! /result_types=
+! /RESULT_TYPES=
-! /result_folders=processed
+! /RESULT_FOLDERS=PROCESSED
-! /result_name=
+! /RESULT_NAME=
-! /apply_as_suffix_to_signal_name=
+! /APPLY_AS_SUFFIX_TO_SIGNAL_NAME=
-! /num_window_frames=3
+! /NUM_WINDOW_FRAMES=3
+! /IF_EVEN_FRAMES_INCREMENT_1=FALSE
 ;
 </code>
-moving_rms.png
+====Command Parameters====
+The parameters that can be modified for this command are as follows:
+|**Signal Types**|The type of signal to be processed|
+|**Signal Folder**|The name of the origin signal folder|
+|**Signal Names**|The names of the signals to be processed|
+|**Signal Components**|Which components of the signal to be filtered|
+|**Result Types**|The signal type of the resulting signals|
+|**Result Folder**|The data tree folder in which the resulting signal is placed|
+|**Result Name**|The name of the resulting signal that is produced|
+|**Apply As Suffix To Signal Name**|True or False: Apply Result Name as a suffix to the original signal name|
+|**Num Window Frames**|Number of frames included in moving window|
+|**If Even Frames Increment 1**|True or False: If frame window is an even number add 1 to make it odd and centered around middle frame|
+====Dialog====
+The command can be defined by editing as text using the parameter definitions above, or using the dialog box:\\
+{{:Moving_RMS.png}}
-===== frame window =====
+==== Frame Window ====
-the command moving_rms computes the rms of a signal by calculating the rms value for short successive time periods (the time period is described as a moving window). in visual3d the windows overlap. the output value at each frame is the rms of the window centered on that frame (e.g. the rms value for each window is plotted at the time corresponding to its center) so the number of frames in the window must be an odd number.
+The command Moving_RMS computes the RMS of a signal by calculating the RMS value for short successive time periods (the time period is described as a moving window). In Visual3D the windows overlap. The output value at each frame is the RMS of the window centered on that frame (e.g. the RMS value for each window is plotted at the time corresponding to its center) so the number of frames in the window must be an odd number.
-so, if the window was 11 frames.
+So, if the window was 11 frames.
-  * the first output frame is frame 6 computed from frames 1-11.
+  * The first output frame is frame 6 computed from frames 1-11.
-  * the second output frame is frame 7 computed from frames 2-12 etc.
+  * The second output frame is frame 7 computed from frames 2-12 Etc.
-typically, this window is reported as a time. since the number of frames is dependent on the sampling rate, you must convert the time (in seconds) to frames. the sampling rate is specified in the c3d file under parameter::analog::rate.
+Typically, this window is reported as a time. Since the number of frames is dependent on the sampling rate, you must convert the time (in seconds) to frames. The sampling rate is specified in the C3D file under PARAMETER::ANALOG::RATE.
-to convert time to frames, you must multiply the time by the sampling rate and add 1 (time 0.0 is equal to frame 1). this as an expression is:\\
+To convert time to frames, you must multiply the time by the sampling rate and add 1 (time 0.0 is equal to frame 1). This as an expression is:\\
-( time * parameter::analog::rate ) + 1\\
+( time * PARAMETER::ANALOG::RATE ) + 1\\
 \\
-to specify a frame window of 100 ms (0.1 seconds), would be specified as:\\
+To specify a frame window of 100 ms (0.1 seconds), would be specified as:\\
-/num_window_frames=( 0.1 * parameter::analog::rate ) + 1\\
+/NUM_WINDOW_FRAMES=( 0.1 * PARAMETER::ANALOG::RATE ) + 1\\
 \\
-===== pipeline commands for specifying a window of 100 ms =====
+====Example: Pipeline commands for specifying a window of 100 ms ====
-a more typical window for the rms filter is 100 ms, which can be achieved as follows:
+A more typical window for the RMS filter is 100 ms, which can be achieved as follows:
 <code>
@@ Line 46: / Line 63: @@
 ! --------------------------------------------
-moving_rms
+Moving_RMS
-/signal_types=analog
+/SIGNAL_TYPES=ANALOG
-/signal_folder=original
+/SIGNAL_FOLDER=ORIGINAL
-/signal_names=emg1+emg2
+/SIGNAL_NAMES=EMG1+EMG2
-/result_types=analog
+/RESULT_TYPES=ANALOG
-/result_folders=rms
+/RESULT_FOLDERS=RMS
-/result_name=
+/RESULT_NAME=
-/apply_as_suffix_to_signal_name=true
+/APPLY_AS_SUFFIX_TO_SIGNAL_NAME=TRUE
-/num_window_frames=(0.1*parameter::analog::rate)+1
+/NUM_WINDOW_FRAMES=(0.1*PARAMETER::ANALOG::RATE)+1
+! /IF_EVEN_FRAMES_INCREMENT_1=FALSE
 ;
 </code>
-===== pipeline commands for specifying a window of 150 ms =====
+====Example: Pipeline commands for specifying a window of 150 ms ====
-to specify a 150 ms (0.15 seconds) window for the rms, the commands are as follows:
+To specify a 150 ms (0.15 seconds) window for the RMS, the commands are as follows:
 <code>
@@ Line 67: / Line 85: @@
 ! --------------------------------------------
-moving_rms
+Moving_RMS
-/signal_types=analog
+/SIGNAL_TYPES=ANALOG
-/signal_folder=original
+/SIGNAL_FOLDER=ORIGINAL
-/signal_names=emg1+emg2
+/SIGNAL_NAMES=EMG1+EMG2
-/result_types=analog
+/RESULT_TYPES=ANALOG
-/result_folders=rms
+/RESULT_FOLDERS=RMS
-/result_name=
+/RESULT_NAME=
-/apply_as_suffix_to_signal_name=true
+/APPLY_AS_SUFFIX_TO_SIGNAL_NAME=TRUE
-/num_window_frames=(0.15*parameter::analog::rate)+1
+/NUM_WINDOW_FRAMES=(0.15*PARAMETER::ANALOG::RATE)+1
+! /IF_EVEN_FRAMES_INCREMENT_1=FALSE
 ;
 </code>
-}}