HAS-Motion Software Documentation

User Tools

Site Tools

You are here: Main Page » visual3d » documentation » pipeline » event_commands » Event Global Maximum
visual3d:documentation:pipeline:event_commands:event_global_maximum

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:event_commands:event_global_maximum [2024/06/19 12:49] – sgrangervisual3d:documentation:pipeline:event_commands:event_global_maximum [2025/02/20 20:59] (current) – wikisysop
Line 1: Line 1:
-{{{{{{{{{{{{{{{{{{{{\\ +====== Event Global Maximum ======
-**specify an event label(s) at the global maximum of a signal.**+
  
-**the result will be one maximum value over the range.**+==== 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.
  
-**if the local maxima are needed, see the [[visual3d:documentation:pipeline:event_commands:event_maximum|event_maximum]] command\\ +==== Pipeline Command ==== 
-**\\ +The following command shows the most recent update, **Version 6**.
-to review the difference between local and global maximum values please see [[visual3d:documentation:pipeline:general_information:global_vs_loca_max_and_min|here]].+
  
-====== 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)|
  
-the **event_global_maximum** command may be used to place an event at the global maximum value of a signal. if threshold has a value or expression only global maximum greater than the threshold will be identified. 
  
 \\ \\
-event_global_maximum_v6.png+**Specify an Event Label(s) at the Global Maximum of a signal.**
  
-====== version 5 ======+**The result will be one maximum value over the range.**
  
-the **event_global_maximum** command may be used to place an event label at the global maximum value of a signal.+**If the local maxima are needed, see the [[Visual3D:Documentation:Pipeline:Event_Commands:Event_Maximum|Event_Maximum]] command\\ 
 +**\\ 
 +To review the difference between local and global maximum values please see [[Visual3D:Documentation:Pipeline:General_Information:Global_vs_Loca_Max_and_Min|here]].
  
-|<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|+===== Version 6 =====
  
 +The **Event_Global_Maximum** command may be used to place an event at the Global maximum value of a signal. If Threshold has a value or expression only global maximum greater than the threshold will be identified.
  
-----+\\ 
 +{{:Event_Global_Maximum_v6.png}}
  
-===== examples =====+===== Version 5 =====
  
-this command may be used to create an event, **rkflex_max**, at the global maximum value of a signal.\\ +The **Event_Global_Maximum** command may be used to place an event label at the Global Maximum value of a signal. 
-1) the maximum value of the signal may be over the entire signal\\ + 
-2) the maximum value of the signal may be during an event sequence\\ +<code> 
-3) a specific event sequence may be excluded\\+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 ==== 
 + 
 +This command may be used to create an event, **RKFlex_Max**, at the GLOBAL maximum value of a signal.\\ 
 +1) The maximum value of the signal may be over the entire signal\\ 
 +2) The maximum value of the signal may be during an event sequence\\ 
 +3) A specific event sequence may be excluded\\
  
  
 \\ \\
-create an event rkflex_max at the maximum knee flexion angle during the gait cycle. the gait cycle is indicated by the rhs events.\\ +Create an event RKFlex_Max at the maximum knee flexion angle during the gait cycle. The gait cycle is indicated by the RHS events.\\ 
-**note:** if no events are specified in the event sequence, a global maximum over the whole trial will be created.\\+**NOTE:** If no events are specified in the Event Sequence, a global maximum over the whole trial will be created.\\
 \\ \\
-one event will be created during each gait cycle.\\ +One event will be created during each gait cycle.\\ 
-event_maximum command may be used to create multiple maximum events during an event sequence.\\+Event_Maximum command may be used to create multiple maximum events during an event sequence.\\
  
  
-==== example - dialog box ====+=== Example - Dialog Box ===
  
-to create the rkflex_max event using the event_global_maximum dialog box:+To create the RKFlex_Max event using the Event_Global_Maximum dialog box:
  
 \\ \\
  
  
-|**1. enter information into dialog box:**\\ \\ **event_name:** rkflex_max\\ \\ **select frame offset:**0\\ \\ **signal components:**x\\ \\ **select an event sequence and instance for the range:**\\ \\ **event sequence instance:**0\\ \\ **defined events:**rhs + rhs\\ \\ click **ok**  |  event_global_max_rkflex_max.jpg|+|**1. Enter information into dialog box:**\\ \\ **Event_Name:** RKFlex_Max\\ \\ **Select Frame Offset:**0\\ \\ **Signal Components:**X\\ \\ **Select an event sequence and Instance for the range:**\\ \\ **Event Sequence Instance:**0\\ \\ **Defined Events:**RHS + RHS\\ \\ Click **OK**  |  {{:Event_Global_Max_RKFlex_Max.jpg}}|
  
 \\ \\
  
  
-|**2. select desired signal:**\\ \\ select **signal from data tree** right_knee_angle\\ \\ click **import selected signals**  |  event_global_max_rkflex_max_import.jpg|+|**2. Select desired signal:**\\ \\ Select **signal from data tree** Right_Knee_Angle\\ \\ Click **Import Selected Signals**  |  {{:Event_Global_Max_RKFlex_Max_Import.jpg}}|
  
-two instances of **rkflex_max** were created, one in between each sequence of **rhs+rhs**.\\+Two instances of **RKFlex_Max** were created, one in between each sequence of **RHS+RHS**.\\
  
  
-|  event_global_max_rkflex_max_graph.jpg  |+|  {{:Event_Global_Max_RKFlex_Max_Graph.jpg}}  |
  
 \\ \\
Line 65: Line 124:
 ---- ----
  
-==== example - exclude sequence ====+=== Example - Exclude Sequence ===
  
-|exclude sequences containing these events can be used to exclude a specific sequence. in this example an event **bad** was created between one sequence of **rhs + rhs**.\\ \\ using the same parameters as the previous example, set the **exclude sequences containing events** parameter to **bad**\\   |  event_global_max_rkflex_max_exclude.jpg|+|Exclude Sequences containing these events can be used to exclude a specific sequence. In this example an event **BAD** was created between one sequence of **RHS + RHS**.\\ \\ Using the same parameters as the previous example, set the **Exclude Sequences containing events** parameter to **BAD**\\   |  {{:Event_Global_Max_RKFlex_Max_Exclude.jpg}}|
  
-only one rkflex_max event was created because the second sequence containing the event **bad** was excluded:+Only one RKFlex_Max event was created because the second sequence containing the event **BAD** was excluded:
  
-|  event_global_max_rkflex_max_exclude_graph.jpg  |+|  {{:Event_Global_Max_RKFlex_Max_Exclude_Graph.jpg}}  |
  
 \\ \\
Line 79: Line 138:
 ---- ----
  
-==== example - subsequence ====+=== Example - Subsequence ===
  
-|subsequences can be used to create an event that occurs within a sequence within a sequence. in this example **rkflex_max** was created as the maximum value between **lto + lhs** when these events feel between the **rhs** events.\\ \\ using the same parameters as the previous example, set the **subsqeuence** parameter to **lto + lhs**\\   |  event_global_max_rkflex_max_subsequence.jpg|+|Subsequences can be used to create an event that occurs within a sequence within a sequence. In this example **RKFlex_Max** was created as the maximum value between **LTO + LHS** when these events feel between the **RHS** events.\\ \\ Using the same parameters as the previous example, set the **Subsqeuence** parameter to **LTO + LHS**\\   |  {{:Event_Global_Max_RKFlex_Max_Subsequence.jpg}}|
  
-**rkflex_max** event was created between **rhs** events that contained the **lto to lhs** subsequence.+**RKFlex_Max** event was created between **RHS** events that contained the **LTO to LHS** subsequence.
  
-|  event_global_max_rkflex_max_subsequence_graph.jpg  |+|  {{:Event_Global_Max_RKFlex_Max_Subsequence_Graph.jpg}}  |
  
 \\ \\
Line 93: Line 152:
 ---- ----
  
-====== version 4 ======+===== 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\\ | 
  
  
-}}}}}}}}}}}}}}}}}}}} 
visual3d/documentation/pipeline/event_commands/event_global_maximum.1718801376.txt.gz · Last modified: 2024/06/19 12:49 by sgranger