visual3d:documentation:pipeline:event_commands:event_global_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_global_maximum [2024/10/02 19:44] – [Version 5] wikisysop | visual3d:documentation:pipeline:event_commands:event_global_maximum [2025/04/28 17:39] (current) – [Dialog] wikisysop | ||
---|---|---|---|
Line 1: | Line 1: | ||
====== Event Global Maximum ====== | ====== Event Global Maximum ====== | ||
- | \\ | + | ===== Overview ===== |
- | **Specify an Event Label(s) at the Global Maximum | + | This command identifies |
- | + | * The result will be one maximum value over the range. | |
- | **The result will be one maximum value over the range.** | + | * If the local maxima are needed, see the [[Visual3D: |
- | + | * To review the difference between local and global maximum values please see [[Visual3D: | |
- | **If the local maxima are needed, see the [[Visual3D: | + | |
- | **\\ | + | |
- | To review the difference between local and global maximum values please see [[Visual3D: | + | |
- | + | ||
- | ===== 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. | + | |
- | + | ||
- | \\ | + | |
- | {{: | + | |
- | ===== Version 5 ===== | ||
- | The **Event_Global_Maximum** command may be used to place an event label at the Global Maximum value of a signal. | + | ===== Pipeline Command ===== |
+ | The following command shows the most recent update, | ||
< | < | ||
Line 25: | Line 15: | ||
/ | / | ||
! / | ! / | ||
+ | ! / | ||
! / | ! / | ||
- | ! / | ||
! / | ! / | ||
- | ! / | + | ! / |
! / | ! / | ||
! / | ! / | ||
! / | ! / | ||
- | ! / | + | ! / |
! / | ! / | ||
! / | ! / | ||
- | ! / | + | ! / |
- | ! /EVENT_INSTANCE= | + | ! /THRESHOLD= |
- | ! /SELECT_X= | + | |
- | ! /SELECT_Y= | + | |
- | ! /SELECT_Z= | + | |
- | ! / | + | |
- | ! / | + | |
- | ! / | + | |
; | ; | ||
</ | </ | ||
- | {{: | + | Older versions of the command are listed in the notes section at the end of this page. |
- | ==== Examples | + | ===== Command Parameters |
+ | The following table shows the command parameters and descriptions: | ||
- | This command may be used to create an event, | + | |**Parameter** |**Description**| |
- | 1) The maximum value of the signal | + | |**/ |
- | 2) The maximum | + | |**!/ |
- | 3) A specific | + | |**!/ |
+ | |**!/ | ||
+ | |**!/ | ||
+ | |**!/ | ||
+ | |**!/ | ||
+ | |**!/ | ||
+ | |**!/ | ||
+ | |**!/ | ||
+ | |**!/ | ||
+ | |**!/ | ||
+ | |**!/ | ||
+ | |**!/ | ||
- | \\ | + | ===== Dialog ===== |
- | Create an event RKFlex_Max at the maximum knee flexion angle during | + | The command can be edited in a text editor or in a dialog form. To edit in the dialog pop-up form either click on the **Edit** button |
- | **NOTE:** If no events are specified | + | |
- | \\ | + | |
- | One event will be created during each gait cycle.\\ | + | |
- | Event_Maximum | + | |
+ | {{: | ||
- | === Example | + | * **New Event Label Name**: Name for the event that will be created at the global maximum. |
+ | * **Signal Component**: | ||
+ | * **Frame Offset**: Number of frames to shift the created event forward or backward from the maximum point. | ||
+ | * **Time Offset**: Shifts event by time (in seconds). | ||
+ | * **Threshold**: | ||
+ | * **Event Sequence and Instance for range**: Search for maximum based on event ranges. | ||
+ | * **Subsequence and Instance within the Event Sequence**: Search inside a sub-range within the event sequence. | ||
- | To create the RKFlex_Max event using the Event_Global_Maximum dialog box: | ||
+ | ===== Examples ===== | ||
+ | The following example will go through the use of the **Event_Global_Maximum** command in the Visual3D application. | ||
+ | |||
+ | This command may be used to create an event RKFlex_Max at the maximum knee flexion angle during the gait cycle. The gait cycle is indicated by the RHS events. This example will go through different use cases of this command: | ||
\\ | \\ | ||
- | |**1. Enter information into dialog box:**\\ \\ **Event_Name: | + | **Example |
\\ | \\ | ||
+ | **Example 2)** The maximum value of the signal may be during an event sequence | ||
+ | \\ | ||
+ | **Example 3)** A specific event sequence may be excluded | ||
- | |**2. Select desired signal:**\\ \\ Select **signal from data tree** Right_Knee_Angle\\ \\ Click **Import Selected Signals** | + | **NOTE:** If no events are specified in the Event Sequence, a global maximum over the whole trial will be created.\\ |
- | Two instances of **RKFlex_Max** were created, one in between each sequence of **RHS+RHS**.\\ | ||
+ | ==== Example 1: Simple Use Case ==== | ||
+ | This example will be done showing both the dialog box and corresponding command text. | ||
- | | {{:Event_Global_Max_RKFlex_Max_Graph.jpg}} | + | To create the RKFlex_Max event using the Event_Global_Maximum dialog box: |
+ | \\ | ||
+ | **1. Enter information into dialog box:** | ||
\\ | \\ | ||
+ | * **Event_Name: | ||
+ | * **Select Frame Offset:** 0 | ||
+ | * **Signal Components: | ||
+ | * **Event Sequence Instance:** 0 | ||
+ | * **Defined Events:** RHS + RHS | ||
+ | * Click **OK** | ||
+ | |{{: | ||
+ | Event_Global_Maximum | ||
+ | / | ||
+ | ! / | ||
+ | ! / | ||
+ | ! / | ||
+ | / | ||
+ | ! / | ||
+ | ! / | ||
+ | / | ||
+ | ! / | ||
+ | ! / | ||
+ | ! / | ||
+ | ! / | ||
+ | ! / | ||
+ | ! /THRESHOLD= | ||
+ | ; | ||
+ | </ | ||
- | ---- | + | **2. Select desired signal:** |
+ | \\ | ||
+ | * Select **signal from data tree** Right_Knee_Angle | ||
+ | * Click **Import Selected Signals** | ||
- | === 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 | + | Two instances of **RKFlex_Max** were created, one in between |
- | Only one RKFlex_Max event was created because the second sequence containing the event **BAD** was excluded: | + | {{:Event_Global_Max_RKFlex_Max_Graph.jpg? |
- | | {{: | + | ---- |
- | \\ | + | ==== Example 2: Exclude 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_Maximum | ||
+ | / | ||
+ | ! / | ||
+ | ! / | ||
+ | ! / | ||
+ | / | ||
+ | ! / | ||
+ | ! / | ||
+ | / | ||
+ | / | ||
+ | ! / | ||
+ | ! / | ||
+ | ! / | ||
+ | ! / | ||
+ | ! /THRESHOLD= | ||
+ | ; | ||
+ | </ | ||
+ | |||
+ | Only one RKFlex_Max event was created because the second sequence containing the event **BAD** was excluded: | ||
+ | {{: | ||
---- | ---- | ||
- | === Example | + | ==== Example |
- | |Subsequences can be used to create an event that occurs within a sequence within a sequence. | + | Subsequences can be used to create an event that occurs within a sequence within a sequence. |
- | **RKFlex_Max** | + | In this example |
- | | {{: | + | Using the same parameters as the previous example, set the **Subsqeuence** parameter to **LTO + LHS** |
- | \\ | + | |{{: |
+ | Event_Global_Maximum | ||
+ | / | ||
+ | ! / | ||
+ | ! / | ||
+ | ! / | ||
+ | / | ||
+ | ! / | ||
+ | ! / | ||
+ | / | ||
+ | ! / | ||
+ | ! / | ||
+ | / | ||
+ | ! / | ||
+ | ! / | ||
+ | ! / | ||
+ | ; | ||
+ | </ | ||
+ | **RKFlex_Max** event was created between **RHS** events that contained the **LTO to LHS** subsequence. | ||
+ | {{: | ||
---- | ---- | ||
- | + | ====Notes==== | |
- | ===== Version 4 ===== | + | === Version 4 === |
< | < |
visual3d/documentation/pipeline/event_commands/event_global_maximum.1727898273.txt.gz · Last modified: 2024/10/02 19:44 by wikisysop