Differences

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

--- visual3d:documentation:pipeline:event_commands:event_global_maximum [2024/07/17 15:22] – sgranger
+++ visual3d:documentation:pipeline:event_commands:event_global_maximum [2025/02/20 20:59] (current) – wikisysop
@@ Line 1: / Line 1: @@
 ====== Event Global Maximum ======
+==== Overview ====
+This command identifies the global maximum of a specified signal within a given time range and creates an event at that peak value. This command is useful for detecting peak joint angles, force plate data peaks, or maximum velocity in motion capture trials.
+==== Pipeline Command ====
+The following command shows the most recent update, **Version 6**.
+<code>
+Event_Global_Maximum
+/RESULT_EVENT_NAME=
+! /SIGNAL_TYPES=
+! /SIGNAL_FOLDER=ORIGINAL
+! /SIGNAL_NAMES=
+! /SIGNAL_COMPONENTS=
+! /FRAME_OFFSET=0
+! /TIME_OFFSET=
+! /EVENT_SEQUENCE=
+! /EXCLUDE_EVENTS=
+! /EVENT_SEQUENCE_INSTANCE=0
+! /EVENT_SUBSEQUENCE=
+! /SUBSEQUENCE_EXCLUDE_EVENTS=
+! /EVENT_SUBSEQUENCE_INSTANCE=0
+! /THRESHOLD=
+;
+</code>
+==== Command Parameters ====
+The following table shows the command parameters and descriptions:
+|**/RESULT_EVENT_NAME=**     |Specifies the name of the event created at the peak signal value.|
+|**! /SIGNAL_TYPES=**        |Type of signal from which the maximum value will be extracted (Target, Analog, etc.)|
+|**! /SIGNAL_FOLDER=ORIGINAL**      |Folder within signal type.|
+|**! /SIGNAL_NAMES=**    |Defines the signal from which the maximum value will be extracted.|
+|**! /SIGNAL_COMPONENTS=**    |Component of the named signal which the maximum value will be found in (X, Y, Z)|
 \\
@@ Line 21: / Line 56: @@
 The **Event_Global_Maximum** command may be used to place an event label at the Global Maximum value of a signal.
-|<code>\\ Event_Global_Maximum\\ /RESULT_EVENT_NAME=\\ ! /SIGNAL_TYPES=\\ ! /SIGNAL_NAMES=\\ ! /SIGNAL_FOLDER= ORIGINAL\\ ! /SIGNAL_COMPONENTS=\\ ! /FRAME_OFFSET= 0 \\ ! /TIME_OFFSET= \\ ! /EVENT_SEQUENCE= \\ ! /EXCLUDE_EVENTS= \\ ! /EVENT_SEQUENCE_INSTANCE= 0 \\ ! /EVENT_SUBSEQUENCE= \\ ! /SUBSEQUENCE_EXCLUDE_EVENTS= \\ ! /EVENT_SUBSEQUENCE_INSTANCE= 0 \\ ! /EVENT_INSTANCE=  0 \\ ! /SELECT_X= \\ ! /SELECT_Y= \\ ! /SELECT_Z= \\ ! /SELECT_RESIDUAL= \\ ! /START_AT_EVENT= \\ ! /END_AT_EVENT= \\ ;\\ </code>  |  {{:Event_Global_Maximum.jpg}}|
+<code>
+Event_Global_Maximum
+/RESULT_EVENT_NAME=
+! /SIGNAL_TYPES=
+! /SIGNAL_NAMES=
+! /SIGNAL_FOLDER= ORIGINAL
+! /SIGNAL_COMPONENTS=
+! /FRAME_OFFSET= 0
+! /TIME_OFFSET=
+! /EVENT_SEQUENCE=
+! /EXCLUDE_EVENTS=
+! /EVENT_SEQUENCE_INSTANCE= 0
+! /EVENT_SUBSEQUENCE=
+! /SUBSEQUENCE_EXCLUDE_EVENTS=
+! /EVENT_SUBSEQUENCE_INSTANCE= 0
+! /EVENT_INSTANCE=  0
+! /SELECT_X=
+! /SELECT_Y=
+! /SELECT_Z=
+! /SELECT_RESIDUAL=
+! /START_AT_EVENT=
+! /END_AT_EVENT=
+;
+</code>
+{{:Event_Global_Maximum.jpg}}
-----
 ==== Examples ====
@@ Line 97: / Line 154: @@
 ===== Version 4 =====
-|<code>\\ Event_Global_Maximum\\ /Signal_Types= The type of signal to be evaluated\\ /Signal_Names= The names of the signals to be evaluated\\ /Signal_Folder= The name of the signal folder\\ /Event_Name= The name to be given to the threshold event\\ /Select_X= (True or False)Use this component of the signal\\ /Select_Y= (True or False)Use this component of the signal\\ /Select_Z= (True or False)Use this component of the signal\\ /Radius= The range of frames of data that must be below the maximum\\ /Start_At_Event= The search begins from the start event\\ /End_At_Event= The search ends at the end event\\ </code>  |  Dialog that pops up when pipeline selection is edited by double clicking with the left mouse button.\\ {{:Eventglobalminmaxdlg.gif}}\\ |
+<code>
+Event_Global_Maximum
+/Signal_Types= The type of signal to be evaluated
+/Signal_Names= The names of the signals to be evaluated
+/Signal_Folder= The name of the signal folder
+/Event_Name= The name to be given to the threshold event
+/Select_X= (True or False)Use this component of the signal
+/Select_Y= (True or False)Use this component of the signal
+/Select_Z= (True or False)Use this component of the signal
+/Radius= The range of frames of data that must be below the maximum
+/Start_At_Event= The search begins from the start event
+/End_At_Event= The search ends at the end event
+</code>
+Dialog that pops up when pipeline selection is edited by double clicking with the left mouse button.
+{{:Eventglobalminmaxdlg.gif}}