Differences

This shows you the differences between two versions of the page.

--- visual3d:documentation:pipeline:metric_commands:metric_time_of_global_maximum_from_event [2024/06/19 12:51] – sgranger
+++ visual3d:documentation:pipeline:metric_commands:metric_time_of_global_maximum_from_event [2025/09/19 15:15] (current) – wikisysop
@@ Line 1: / Line 1: @@
-{{event_labels are defined by the c3d format. event_labels exist only at motion capture frames (e.g. at point rate or video rate). for model based kinematic and kinetic calculations this is fine, because these signals only exist at motion capture frames.
+====== Metric Time of Global Maximum from Event ======
+====Overview====
+The **Metric Time of Global Maximum from Event** command can be used to record the time or value of a global max in relation to a defined event. For example, one could record the time to max ground force in a jump in relation to to their knee flexion. The command can be found in the **Pipeline Workshop** under **Metric**.
-for measures of timing that involve signals that are at **analog** rate (e.g. force platform data) the motion capture rate (or point rate) isn't sufficient.
+====Pipeline Command====
-in version 5 a series of metric commands were introduced to identify the time of a threshold crossing or maximum at the analog rate.
+The command syntax is as follows:
-this page details the command **metric_time_of_global_maximum_from_event** that will calculate the global maximum timing from an event at the analog rate.
+<code>
+Metric_Time_Of_Global_Maximum_From_Event
+! /RESULT_METRIC_TIME=
+! /RESULT_METRIC_VALUE=
+! /RESULT_FOLDER=PROCESSED
+! /RESULT_COMPONENTS=ALL
+! /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
+! /EVENT_INSTANCE=0
+! /THRESHOLD=
+;
+</code>
-metrictimeofglobalmaxfromevent.png
+====Command Parameters====
-**metric_time_of_global_maximum_from_event**
+The following table shows the command parameters seen above and their descriptions:
-/result_event_name=
+|**/RESULT_METRIC_TIME=**                                                                               |Time of minimum from event.                                                                      |
-! /signal_types=
+|**/RESULT_METRIC_VALUE=**                                                                              |Value of minimum after event.                                                                    |
-! /signal_names=
+|**/RESULT_FOLDER=**                                                                                    |Name of folder designated for results.                                                           |
-! /signal_folder=original
+|**/RESULT_COMPONENTS=**                                                                                |Components to be included in results.                                                            |
-! /signal_components=
+|**/SIGNAL_TYPES=**                                                                                     |The type of signal to be processed                                                               |
-! /frame_offset=0
+|**/SIGNAL_NAMES=**                                                                                     |The name of the signal to be processed                                                           |
-! /time_offset=
+|**/SIGNAL_FOLDER**                                                                                     |The folder of the signal to be processed                                                         |
-! /event_sequence=
+|**/SIGNAL_COMPONENTS=**                                                                                |The component of the signal to be processed                                                      |
-! /exclude_events=
+|**/FRAME_OFFSET=**                                                                                     |The offset (in frames) to apply to the event.                                                    |
-! /event_sequence_instance=0
+|**/TIME_OFFSET=**                                                                                      |The time offset (in seconds) to apply to the event.                                              |
-! /event_subsequence=
+|**/EVENT_SEQUENCE=**                                                                                   |A list of events (separated by “+” signs).                                                       |
-! /subsequence_exclude_events=
+|**/EXCLUDE_EVENTS=**                                                                                   |This Event_Sequence must not be during the sequence requested.                                   |
-! /event_subsequence_instance=0
+|**/EVENT_SEQUENCE_INSTANCE=**                                                                          |Index of the sequence instance to evaluate (0 = all, 1 = first, etc.).                           |
-! /event_instance=0
+|**/EVENT_SUBSEQUENCE=**                                                                                |Optional inner event window within a broader sequence.                                           |
-! /select_x=
+|**/SUBSEQUENCE_EXCLUDE_EVENTS=**                                                                       |This Event subsequence must not be during the sequence requested.                                |
-! /select_y=
+|**/EVENT_SUBSEQUENCE_INSTANCE=**                                                                       |Index of the subsequence instance to evaluate (0 = all, 1 = first, etc.).                        |
-! /select_z=
+|**/EVENT_INSTANCE=**                                                                                   |Defines how many event occurrences to consider.                                                  |
-! /select_residual=
+|**THRESHOLD**                                                                                          |Threshold value to trigger event detection.                                                      |
-! /start_at_event=
-! /end_at_event=
-**;**
+====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 pipeline command. The dialog is shown below.
+{{:MetricTimeofGlobalMaxfromEvent.png}}
+The dialog box allows you to assign values to the command parameters outlined above.
+====Notes====
+Event_Labels are defined by the C3D format. Event_Labels exist only at Motion Capture frames (e.g. at Point Rate or video rate). For model based kinematic and kinetic calculations this is fine, because these signals only exist at Motion Capture frames.
+For measures of timing that involve signals that are at **ANALOG** rate (e.g. Force Platform data) the motion capture rate (or point rate) isn't sufficient.
+In Version 5 a series of metric commands were introduced to identify the time of a threshold crossing or maximum at the analog rate.
+This page details the command **Metric_Time_Of_Global_Maximum_From_Event** that will calculate the Global Maximum timing from an Event at the analog rate.
+====Examples====
-}}