User Tools

Site Tools


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 [2025/04/10 17:08] wikisysopvisual3d: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 ====+===== 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. 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.
   * The result will be one maximum value over the range.   * The result will be one maximum value over the range.
Line 8: Line 8:
  
  
-==== Pipeline Command ====+===== Pipeline Command =====
 The following command shows the most recent update, **Version 6**. The following command shows the most recent update, **Version 6**.
  
Line 32: Line 32:
 Older versions of the command are listed in the notes section at the end of this page. Older versions of the command are listed in the notes section at the end of this page.
  
-==== Command Parameters ====+===== Command Parameters =====
 The following table shows the command parameters and descriptions: The following table shows the command parameters and descriptions:
  
Line 38: Line 38:
 |**/RESULT_EVENT_NAME=**           | Name of the event that will be created at the frame where the signal reaches its global maximum. | |**/RESULT_EVENT_NAME=**           | Name of the event that will be created at the frame where the signal reaches its global maximum. |
 |**!/SIGNAL_TYPES=**               | The type of signal being analyzed (e.g., `ANALOG`, `LINK_MODEL_BASED`, `TARGET`). | |**!/SIGNAL_TYPES=**               | The type of signal being analyzed (e.g., `ANALOG`, `LINK_MODEL_BASED`, `TARGET`). |
-|**!/SIGNAL_FOLDER=**              | Folder the signal is pulled frome.g., `ORIGINAL`, `PROCESSED`, etc. |+|**!/SIGNAL_FOLDER=**              | Folder the signal is pulled from (e.g., `ORIGINAL`, `PROCESSED`, etc.). |
 |**!/SIGNAL_NAMES=**               | Label(s) of the signal(s) to analyze (e.g., `Left_Knee_Angle`). | |**!/SIGNAL_NAMES=**               | Label(s) of the signal(s) to analyze (e.g., `Left_Knee_Angle`). |
 |**!/SIGNAL_COMPONENTS=**          | Specific components (X, Y, Z) or index of the signal vector to use. | |**!/SIGNAL_COMPONENTS=**          | Specific components (X, Y, Z) or index of the signal vector to use. |
Line 52: Line 52:
  
  
-==== Dialog ====+===== Dialog =====
 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 in the pipeline workshop or double-click on the command. The dialog box is shown below: 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 in the pipeline workshop or double-click on the command. The dialog box is shown below:
  
 {{:visual3d:documentation:pipeline:event_commands:egm_dialog.png?500|}} {{:visual3d:documentation:pipeline:event_commands:egm_dialog.png?500|}}
  
 +  * **New Event Label Name**: Name for the event that will be created at the global maximum.
 +  * **Signal Component**: Signal direction selection (X, Y, Z).
 +  * **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**: Min. signal value required to accept a maximum.
 +  * **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.
  
-==== Examples ====+ 
 +===== Examples =====
 The following example will go through the use of the **Event_Global_Maximum** command in the Visual3D application. 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, 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:+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:
 \\ \\
  
Line 75: Line 83:
  
  
-=== Example 1: Simple Use Case ===+==== Example 1: Simple Use Case ====
 This example will be done showing both the dialog box and corresponding command text. This example will be done showing both the dialog box and corresponding command text.
  
Line 123: Line 131:
 ---- ----
  
-=== Example 2: Exclude Sequence ===+==== 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** 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**
Line 152: Line 160:
 ---- ----
  
-=== Example 3: Subsequence ===+==== Example 3: Subsequence ====
  
 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.
  
-In this example **RKFlex_Max** was created as the maximum value between **LTO + LHS** when these events feel between the **RHS** events.+In this example **RKFlex_Max** was created as the maximum value between **LTO + LHS** when these events fall between the **RHS** events.
  
 Using the same parameters as the previous example, set the **Subsqeuence** parameter to **LTO + LHS** Using the same parameters as the previous example, set the **Subsqeuence** parameter to **LTO + LHS**
visual3d/documentation/pipeline/event_commands/event_global_maximum.1744304887.txt.gz · Last modified: 2025/04/10 17:08 by wikisysop