HAS-Motion Software Documentation

User Tools

Site Tools

You are here: Main Page » visual3d » documentation » pipeline » event_commands » Event Maximum
visual3d:documentation:pipeline:event_commands:event_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_maximum [2025/04/11 16:25] – [Notes] wikisysopvisual3d:documentation:pipeline:event_commands:event_maximum [2025/04/29 19:04] (current) – wikisysop
Line 1: Line 1:
 ====== Event Maximum ====== ====== Event Maximum ======
  
-==== Overview ==== +===== Overview ===== 
-The **Event_Maximum** command is used to detect the maximum value of a specified signal within a defined event sequence or range and create an event at that location. This command can evaluate different components of a signal (X, Y, Z, Residual) and can apply offsets to shift the detected event if needed.+The **Event_Maximum** command is used to detect the maximum value of a specified signal within a defined event sequence or range, and create an event at that location. This command can evaluate different components of a signal (X, Y, Z, Residual) and can apply offsets to shift the detected event if needed.
   * Useful for identifying peak forces, peak joint angles, or maximum accelerations during specific phases of a motion, such as between initial contact and toe-off during gait.   * Useful for identifying peak forces, peak joint angles, or maximum accelerations during specific phases of a motion, such as between initial contact and toe-off during gait.
   * If the global maxima are needed, see the [[Visual3D:Documentation:Pipeline:Event_Commands:Event_Global_Maximum|Event_Global_Maximum]] command   * If the global maxima are needed, see the [[Visual3D:Documentation:Pipeline:Event_Commands:Event_Global_Maximum|Event_Global_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]]   * To review the difference between local and global maximum values please see [[Visual3D:Documentation:Pipeline:General_Information:Global_vs_Loca_Max_and_Min|here]]
  
-==== Pipeline Command ====+===== Pipeline Command =====
 The command below is as seen in the Visual3D application: The command below is as seen in the Visual3D application:
  
Line 31: Line 31:
 </code> </code>
  
-==== Command Parameters ====+===== Command Parameters =====
 The following table shows the command parameters and descriptions: The following table shows the command parameters and descriptions:
  
Line 53: Line 53:
  
  
-==== Dialog ====+===== Dialog =====
 The command can be edited in a text editor or in the dialog. To edit in the dialog, click on the **Edit** button in the pipeline workshop or double-click on the pipeline command. The dialog is shown below: The command can be edited in a text editor or in the dialog. To edit in the dialog, click on the **Edit** button in the pipeline workshop or double-click on the pipeline command. The dialog is shown below:
  
 {{:visual3d:documentation:pipeline:event_commands:event_max_dialog.png?400|}} {{:visual3d:documentation:pipeline:event_commands:event_max_dialog.png?400|}}
 +
 +  * **New Event Label Name**: Name of event created at the local maximum points.
 +  * **Signal Component**: Which direction of the signal to analyze.
 +  * **Frame Window**: Size of window to look for a local maximum around each frame.
 +  * **Frame Offset**: Shift the resulting event by a number of frames.
 +  * **Time Offset**: Move the event by a time shift (in seconds)
 +  * **Threshold**: Only create an event if the maximum exceeds this value.
 +  * **Event Instance to Create**: Choose which maximum to create if there are multiple peaks in a search window
 +  * **Event Sequence and Instance for Range**: Limits where to search for maxima
 +  * **Subsequence and Instance within Event Sequence**: Further limits search inside smaller phase within main event range.
 +
  
 ---- ----
-==== Examples ====+===== Examples =====
 The following examples will go through the use of the **Event_Maximum** command in the Visual3D application. The following examples will go through the use of the **Event_Maximum** command in the Visual3D application.
  
-=== Example 1: Simple Use Case ===+==== Example 1: Simple Use Case ====
 The first example will cover the command using the dialog as well as the command text. To create the RKFlex_MaxLocal event using the Event_Maximum dialog box: The first example will cover the command using the dialog as well as the command text. To create the RKFlex_MaxLocal event using the Event_Maximum dialog box:
  
Line 70: Line 81:
 **Select Frame Offset:** 0\\ **Select Frame Offset:** 0\\
 **Signal Components:** X\\ **Signal Components:** X\\
-**Event Sequence:**RHS -> RHS (use arrows to move from defined events list into sequence.) \\ 
 **Event Sequence Instance:**0\\ **Event Sequence Instance:**0\\
  
  
-{{:Event_Max_RKFlex_MaxLocal.jpg?400}}+|{{:visual3d:documentation:pipeline:event_commands:eventmax_ex1_dialogbox.png?600|}}|<code> 
 +Event_Maximum 
 +/RESULT_EVENT_NAME=RKFlex_MaxLocal 
 +/SIGNAL_TYPES=KINETIC_KINEMATIC 
 +/SIGNAL_FOLDER=RFT 
 +/SIGNAL_NAMES=AngAcc 
 +/SIGNAL_COMPONENTS=X 
 +! /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 
 +/FRAME_WINDOW=40 
 +! /THRESHOLD= 
 +; 
 +</code>|
  
 2. Close the dialog, on the Signals and Events tab, select the desired signal from the data tree, in this case **Right_Knee_Angle**. Navigate into the LINK_MODEL_BASED items folder, and select the checkbox beside the signal. 2. Close the dialog, on the Signals and Events tab, select the desired signal from the data tree, in this case **Right_Knee_Angle**. Navigate into the LINK_MODEL_BASED items folder, and select the checkbox beside the signal.
Line 81: Line 110:
 {{:Event_Max_RKFlex_MaxLocal_Import.jpg?600}} {{:Event_Max_RKFlex_MaxLocal_Import.jpg?600}}
  
-**RKFlex_Max** will be created at the minimum value during the gait cycle within the specified frame window.+**RKFlex_MaxLocal** will be created at the maximum values during the full gait cycle. As seen below:
  
 +|{{:visual3d:documentation:pipeline:event_commands:eventmax_ex1_corrected_graph.png?600|}}|
  
----- + 
-==== Notes ====+==== Example 2: Complex ==== 
 + 
 +In this example, the local maxima of the right foot angular acceleration during the full trial is identified. Then, the values of this event are extracted. 
 + 
 +Use the Event_Maximum command to find the peaks in the acceleration signal, the component is set to Y and frame window is increased to 60. 
 + 
 +The signal used to represent the acceleration was taken from the KINETIC_KINEMATIC folder - RFT (Right Foot) 
 + 
 +<code> 
 +Event_Maximum 
 +/RESULT_EVENT_NAME=Right_Accel_Peak_Stance 
 +/SIGNAL_TYPES=KINETIC_KINEMATIC 
 +/SIGNAL_FOLDER=RFT 
 +/SIGNAL_NAMES=AngAcc 
 +/SIGNAL_COMPONENTS=Y 
 +! /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 
 +/FRAME_WINDOW=60 
 +! /THRESHOLD= 
 +; 
 +</code> 
 + 
 +Then use Metric_Signal_Value_At_Event to extract the actual Y-acceleration values at these peaks for analysis: 
 + 
 +<code> 
 +Metric_Signal_Value_At_Event 
 +/SIGNAL_TYPES=KINETIC_KINEMATIC 
 +/SIGNAL_FOLDER=RFT 
 +/SIGNAL_NAMES=AngAcc 
 +! /RESULT_METRIC_FOLDER=PROCESSED 
 +/RESULT_METRIC_NAME=Right_Accel_Peak_Stance_Times 
 +! /APPLY_AS_SUFFIX_TO_SIGNAL_NAME=FALSE 
 +/SIGNAL_COMPONENTS=Y 
 +! /COMPONENT_SEQUENCE= 
 +/EVENT_NAME=Right_Accel_Peak_Stance 
 +! /EVENT_INSTANCE=0 
 +! /SCALE_FACTORS=1 
 +! /GENERATE_GLOBAL_MEAN_AND_STDDEV=TRUE 
 +! /GENERATE_LOCAL_MEAN_AND_STDDEV=TRUE 
 +! /APPEND_TO_EXISTING_VALUES=FALSE 
 +! /GENERATE_VECTOR_LENGTH_METRIC=FALSE 
 +! /RETAIN_NO_DATA_VALUES=FALSE 
 +; 
 +</code> 
 + 
 + 
 +===== Notes =====
  
 === Version 5 === === Version 5 ===
visual3d/documentation/pipeline/event_commands/event_maximum.1744388725.txt.gz · Last modified: 2025/04/11 16:25 by wikisysop