User Tools

Site Tools


visual3d:documentation:pipeline:signal_commands:moving_rms

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
visual3d:documentation:pipeline:signal_commands:moving_rms [2024/07/12 14:07] – created sgrangervisual3d:documentation:pipeline:signal_commands:moving_rms [2026/04/27 17:59] (current) – [Pipeline Command] wikisysop
Line 1: Line 1:
-====== Moving_RMS ====== +====== 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 **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> <code>
 Moving_RMS Moving_RMS
Line 15: Line 15:
 ! /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> </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 ====
Line 39: Line 54:
  
  
-==== 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:
Line 57: Line 72:
 /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> </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:
Line 78: Line 94:
 /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> </code>
visual3d/documentation/pipeline/signal_commands/moving_rms.1720793228.txt.gz · Last modified: by sgranger