visual3d:documentation:pipeline:event_commands:event_maximum
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| visual3d:documentation:pipeline:event_commands:event_maximum [2025/03/03 18:33] – wikisysop | visual3d: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: | ||
| + | * To review the difference between local and global maximum values please see [[Visual3D: | ||
| - | ==== Pipeline Command ==== | + | ===== Pipeline Command ===== |
| + | The command below is as seen in the Visual3D application: | ||
| < | < | ||
| Line 28: | Line 31: | ||
| </ | </ | ||
| - | \\ | + | ===== Command Parameters ===== |
| - | **Specify an Event Label(s) at the specified local Maxima of a signal.** | + | The following table shows the command parameters and descriptions: |
| - | **If the global maxima are needed, see the [[Visual3D: | + | |**Parameter** |
| - | **\\ | + | |**/ |
| - | To review | + | |**!/ |
| + | |**!/ | ||
| + | |**!/ | ||
| + | |**!/ | ||
| + | |**!/ | ||
| + | |**!/ | ||
| + | |**!/ | ||
| + | |**!/ | ||
| + | |**!/ | ||
| + | |**!/ | ||
| + | |**!/ | ||
| + | |**!/ | ||
| + | |**!/ | ||
| + | |**!/ | ||
| + | |**!/ | ||
| - | ==== Visual3D_Version5 ==== | ||
| - | In version 5 the command | + | ===== Dialog ===== |
| + | The command | ||
| - | |**Event_Maximum**\\ \\ / | + | {{:visual3d: |
| - | \\ | + | * **New Event Label Name**: Name of event created at the local maximum points. |
| - | Other options within | + | * **Signal Component**: |
| + | | ||
| + | | ||
| + | * **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. | ||
| - | If /Threshold is empty, all local maximum are identified. | ||
| - | If /Threshold has a value or expression, only local maximum that are greater than the threshold are identified. | + | ---- |
| + | ===== Examples ===== | ||
| + | The following examples will go through | ||
| + | ==== 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: | ||
| - | ---- | + | 1. Add the **Event_Maximum** command to the pipeline. Then, enter information into dialog box: |
| - | \\ | + | **Event_Name: |
| + | **Select Frame Offset:** 0\\ | ||
| + | **Signal Components: | ||
| + | **Event Sequence Instance: | ||
| - | === Example - Dialog Box === | + | |{{: |
| + | Event_Maximum | ||
| + | / | ||
| + | / | ||
| + | / | ||
| + | / | ||
| + | / | ||
| + | ! / | ||
| + | ! / | ||
| + | ! / | ||
| + | ! / | ||
| + | ! / | ||
| + | ! / | ||
| + | ! / | ||
| + | ! / | ||
| + | ! / | ||
| + | / | ||
| + | ! / | ||
| + | ; | ||
| + | </ | ||
| - | To create | + | 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. |
| - | \\ | + | 3. Open the pipeline workshop again, and then click on **Import Selected Signals**.\\ |
| + | {{: | ||
| + | **RKFlex_MaxLocal** will be created at the maximum values during the full gait cycle. As seen below: | ||
| - | |**1. Enter information into dialog box:**\\ \\ **Event_Name:** RKFlex_MaxLocal\\ \\ **Select Frame Offset:**0\\ \\ **Signal Components:**X\\ \\ **Select an event sequence and Instance for the range:**\\ \\ **Event Sequence Instance: | + | |{{:visual3d:documentation:pipeline:event_commands:eventmax_ex1_corrected_graph.png? |
| - | \\ | ||
| + | ==== Example 2: Complex ==== | ||
| - | |**2. Select desired signal:**\\ \\ Select **signal from data tree** Right_Knee_Angle\\ \\ Click **Import Selected Signals** | + | 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 |
| - | **RKFlex_Max** will be created at the minimum value during | + | |
| - | \\ | + | |
| - | Other options within the command such as **Exclude Event**, and **Select Subsequence** are explained in detail on the [[Visual3D: | + | |
| + | The signal used to represent the acceleration was taken from the KINETIC_KINEMATIC folder - RFT (Right Foot) | ||
| - | ---- | + | < |
| + | Event_Maximum | ||
| + | / | ||
| + | / | ||
| + | / | ||
| + | / | ||
| + | / | ||
| + | ! / | ||
| + | ! / | ||
| + | / | ||
| + | ! / | ||
| + | ! / | ||
| + | ! / | ||
| + | ! / | ||
| + | ! / | ||
| + | ! / | ||
| + | / | ||
| + | ! / | ||
| + | ; | ||
| + | </ | ||
| - | ===== Version 4 ===== | + | Then use Metric_Signal_Value_At_Event to extract the actual Y-acceleration values at these peaks for analysis: |
| + | |||
| + | < | ||
| + | Metric_Signal_Value_At_Event | ||
| + | / | ||
| + | / | ||
| + | / | ||
| + | ! / | ||
| + | / | ||
| + | ! / | ||
| + | / | ||
| + | ! / | ||
| + | / | ||
| + | ! / | ||
| + | ! / | ||
| + | ! / | ||
| + | ! / | ||
| + | ! / | ||
| + | ! / | ||
| + | ! / | ||
| + | ; | ||
| + | </ | ||
| + | |||
| + | |||
| + | ===== Notes ===== | ||
| + | |||
| + | === Version 5 === | ||
| + | |||
| + | In version 5 the command has been extended to include the Event_Sequence and Exclude_Events parameters. | ||
| + | |||
| + | |{{: | ||
| + | Event_Maximum | ||
| + | / | ||
| + | / | ||
| + | / | ||
| + | / | ||
| + | / | ||
| + | / | ||
| + | !/ | ||
| + | !/ | ||
| + | !/ | ||
| + | !/ | ||
| + | !/ | ||
| + | !/ | ||
| + | !/ | ||
| + | !/ | ||
| + | / | ||
| + | ; | ||
| + | </ | ||
| + | |||
| + | * Other options within the command such as **Exclude Event**, and **Select Subsequence** are explained in detail on the [[Visual3D: | ||
| + | * If /Threshold is empty, all local maximum are identified. | ||
| + | * If /Threshold has a value or expression, only local maximum that are greater than the threshold are identified. | ||
| + | |||
| + | === Version 4 === | ||
| + | |||
| + | < | ||
| + | Event_Maximum | ||
| + | / | ||
| + | / | ||
| + | / | ||
| + | / | ||
| + | / | ||
| + | / | ||
| + | / | ||
| + | / | ||
| + | / | ||
| + | / | ||
| + | / | ||
| + | ; | ||
| + | </ | ||
| - | |\\ \\ \\ < | + | Dialog that pops up when pipeline selection is edited by double clicking with the left mouse button. |
| - | **Event Instance:** There may be several local maxima. A value of 0 results in all maxima being assigned a label. A positive number indicates the event (in sequence) to select. A negative number indicates the event starting from the last event and progressing to the first event. | + | {{:MinMaxDlg.jpg}} |
visual3d/documentation/pipeline/event_commands/event_maximum.1741026824.txt.gz · Last modified: 2025/03/03 18:33 by wikisysop