Differences

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

--- visual3d:documentation:emg:processing:onset [2024/06/19 12:47] – sgranger
+++ visual3d:documentation:emg:processing:onset [2024/07/17 15:45] (current) – created sgranger
@@ Line 1: / Line 1: @@
-{{||
+====== Onset ======
-computing the onset of an emg signal can be quite tricky. in this example, we describe a pipeline for a straightforward estimation of emg onset based on the the [[visual3d:documentation:pipeline:signal_commands:teager_kaiser_energy|teager-kaiser energy]] operator and [[visual3d:documentation:pipeline:event_commands:event_threshold|event_threshold]]. this is not a definitive definition, but simply a starting point for the user.
+||
-teager_kaiser.jpg
+Computing the onset of an EMG signal can be quite tricky. In this example, we describe a pipeline for a straightforward estimation of EMG onset based on the the [[Visual3D:Documentation:Pipeline:Signal_Commands:Teager_Kaiser_Energy|Teager-Kaiser Energy]] Operator and [[Visual3D:Documentation:Pipeline:Event_Commands:Event_Threshold|Event_Threshold]]. This is not a definitive definition, but simply a starting point for the user.
+{{:Teager_Kaiser.jpg}}
 \\
 <code>
-!apply a high pass and low pass filter assuming that the surface emg signal contains information
+!Apply a high pass and low pass filter assuming that the surface emg signal contains information
-!from 20 to 500 hz
+!from 20 to 500 Hz
-highpass_filter
+Highpass_Filter
-/signal_types=analog
+/SIGNAL_TYPES=ANALOG
-/signal_names=emg_c
+/SIGNAL_NAMES=EMG_C
-! /signal_folder=original
+! /SIGNAL_FOLDER=ORIGINAL
-! /result_suffix=
+! /RESULT_SUFFIX=
-/result_folder=processed
+/RESULT_FOLDER=PROCESSED
-! /filter_class=butterworth
+! /FILTER_CLASS=BUTTERWORTH
-/frequency_cutoff=20
+/FREQUENCY_CUTOFF=20
-/num_reflected=0
+/NUM_REFLECTED=0
-/total_buffer_size=100
+/TOTAL_BUFFER_SIZE=100
-! /num_bidirectional_passes=1
+! /NUM_BIDIRECTIONAL_PASSES=1
 ;
-!apply the teager-kaiser operator
+!Apply the Teager-Kaiser Operator
-teager_kaiser_energy
+Teager_Kaiser_Energy
-/signal_types=analog
+/SIGNAL_TYPES=ANALOG
-/signal_names=emg_c
+/SIGNAL_NAMES=EMG_C
-/signal_folder=processed
+/SIGNAL_FOLDER=PROCESSED
-! /signal_components=
+! /SIGNAL_COMPONENTS=
-! /result_folder=processed
+! /RESULT_FOLDER=PROCESSED
-! /event_sequence=
+! /EVENT_SEQUENCE=
-! /exclude_events=
+! /EXCLUDE_EVENTS=
 ;
-!create events that define the resting baseline of the muscle
+!Create events that define the resting baseline of the muscle
-event_explicit
+Event_Explicit
-/event_name=rest1
+/EVENT_NAME=REST1
-/frame=1
+/FRAME=1
-! /time=
+! /TIME=
 ;
-event_explicit
+Event_Explicit
-/event_name=rest2
+/EVENT_NAME=REST2
-/frame=150
+/FRAME=150
-! /time=
+! /TIME=
 ;
-!compute the median and standard deviation of the tko envelope during rest
+!Compute the median and standard deviation of the TKO envelope during rest
-metric_median
+Metric_Median
-/result_metric_name=_med
+/RESULT_METRIC_NAME=_MED
-/apply_as_suffix_to_signal_name=true
+/APPLY_AS_SUFFIX_TO_SIGNAL_NAME=TRUE
-/result_metric_folder=emg
+/RESULT_METRIC_FOLDER=EMG
-/signal_types=analog
+/SIGNAL_TYPES=ANALOG
-/signal_names=emg_c
+/SIGNAL_NAMES=EMG_C
-/signal_folder=processed
+/SIGNAL_FOLDER=PROCESSED
-! /signal_components=all_components
+! /SIGNAL_COMPONENTS=ALL_COMPONENTS
-/event_sequence=rest1+rest2
+/EVENT_SEQUENCE=REST1+REST2
-/exclude_events=
+/EXCLUDE_EVENTS=
-/generate_mean_and_stddev=false
+/GENERATE_MEAN_AND_STDDEV=FALSE
-! /append_to_existing_values=false
+! /APPEND_TO_EXISTING_VALUES=FALSE
 ;
-metric_stddev
+Metric_StdDev
-/result_metric_name=_sd
+/RESULT_METRIC_NAME=_SD
-/apply_as_suffix_to_signal_name=true
+/APPLY_AS_SUFFIX_TO_SIGNAL_NAME=TRUE
-/result_metric_folder=emg
+/RESULT_METRIC_FOLDER=EMG
-/signal_types=analog
+/SIGNAL_TYPES=ANALOG
-/signal_names=emg_c
+/SIGNAL_NAMES=EMG_C
-/signal_folder=processed
+/SIGNAL_FOLDER=PROCESSED
-! /signal_components=all_components
+! /SIGNAL_COMPONENTS=ALL_COMPONENTS
-/event_sequence=rest1+rest2
+/EVENT_SEQUENCE=REST1+REST2
-/exclude_events=
+/EXCLUDE_EVENTS=
-/generate_mean_and_stddev=false
+/GENERATE_MEAN_AND_STDDEV=FALSE
-! /append_to_existing_values=false
+! /APPEND_TO_EXISTING_VALUES=FALSE
 ;
-!identify the event emg_c_on based on a threshold crossing
+!Identify the event EMG_C_ON based on a threshold crossing
 !of the median + 3 * standard deviation
-event_threshold
+Event_Threshold
-/signal_types=analog
+/SIGNAL_TYPES=ANALOG
-/signal_names=emg_c
+/SIGNAL_NAMES=EMG_C
-/signal_folder=procesed
+/SIGNAL_FOLDER=PROCESED
-/event_name=emg_c_on
+/EVENT_NAME=EMG_C_ON
-/select_x=true
+/SELECT_X=TRUE
-! /select_y=false
+! /SELECT_Y=FALSE
-! /select_z=false
+! /SELECT_Z=FALSE
-! /select_residual=false
+! /SELECT_RESIDUAL=FALSE
-/threshold=metric::emg::emg2_med+3*metric::emg::emg2_sd
+/THRESHOLD=METRIC::EMG::EMG2_MED+3*METRIC::EMG::EMG2_SD
-! /frame_window=8
+! /FRAME_WINDOW=8
-! /frame_offset=0
+! /FRAME_OFFSET=0
-/ascending=true
+/ASCENDING=TRUE
-! /descending=false
+! /DESCENDING=FALSE
-! /ensure_range_frames_before_threshold_crossing=false
+! /ENSURE_RANGE_FRAMES_BEFORE_THRESHOLD_CROSSING=FALSE
-/ensure_range_frames_after_threshold_crossing=true
+/ENSURE_RANGE_FRAMES_AFTER_THRESHOLD_CROSSING=TRUE
-! /start_at_event=
+! /START_AT_EVENT=
-! /end_at_event=
+! /END_AT_EVENT=
-/event_instance=1
+/EVENT_INSTANCE=1
 ;
 </code>
-}}