Differences

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

--- visual3d:documentation:pipeline:metric_commands:metric_time_of_global_minimum_from_event [2024/07/17 15:46] – created sgranger
+++ visual3d:documentation:pipeline:metric_commands:metric_time_of_global_minimum_from_event [2025/09/19 15:20] (current) – wikisysop
@@ Line 1: / Line 1: @@
 ====== Metric Time of Global Minimum from Event ======
+====Overview====
+The **Metric Time of Global Minimum from Event** command can be used to record the time or value of a global min in relation to a defined event. For example, one could record the time to minimum knee flexion in a jump in relation to to their takeoff/landing. The command can be found in the **Pipeline Workshop** under **Metric**.
-Event_Labels are defined by the c3d format. Event_Labels exist only at Motion Capture frames (e.g. at Point Rate). For model based kinematic and kinetic calculations this is fine, because these signals only exist at Motion Capture frames.
+====Pipeline Command====
-For measures of timing that involve signals that are at ANALOG rate (e.g. Force Platform data) the motion capture rate isn't sufficient.
+The command syntax is as follows:
-In Version 5 a series of metric commands were introduced to identify the time of a threshold crossing or maximum at the analog rate.
+<code>
+Metric_Time_Of_Global_Minimum_From_Event
-{{:MetricTimeofGlobalMinfromEvent.png}}
+! /RESULT_METRIC_TIME=
+! /RESULT_METRIC_VALUE=
-**Metric_Time_Of_Global_Minimum_From_Event**
+! /RESULT_FOLDER=PROCESSED
-/RESULT_EVENT_NAME=
+! /RESULT_COMPONENTS=ALL
 ! /SIGNAL_TYPES=
-! /SIGNAL_NAMES=
 ! /SIGNAL_FOLDER=ORIGINAL
+! /SIGNAL_NAMES=
 ! /SIGNAL_COMPONENTS=
 ! /FRAME_OFFSET=0
@@ Line 24: / Line 26: @@
 ! /EVENT_SUBSEQUENCE_INSTANCE=0
 ! /EVENT_INSTANCE=0
-! /SELECT_X=
+! /THRESHOLD=
-! /SELECT_Y=
+;
-! /SELECT_Z=
+</code>
-! /SELECT_RESIDUAL=
-! /START_AT_EVENT=
+====Command Parameters====
-! /END_AT_EVENT=
-**;**
+The following table shows the command parameters seen above and their descriptions:
+|**/RESULT_METRIC_TIME=**                                                                               |Time of minimum from event.                                                                      |
+|**/RESULT_METRIC_VALUE=**                                                                              |Value of minimum after event.                                                                    |
+|**/RESULT_FOLDER=**                                                                                    |Name of folder designated for results.                                                           |
+|**/RESULT_COMPONENTS=**                                                                                |Components to be included in results.                                                            |
+|**/SIGNAL_TYPES=**                                                                                     |The type of signal to be processed                                                               |
+|**/SIGNAL_NAMES=**                                                                                     |The name of the signal to be processed                                                           |
+|**/SIGNAL_FOLDER**                                                                                     |The folder of the signal to be processed                                                         |
+|**/SIGNAL_COMPONENTS=**                                                                                |The component of the signal to be processed                                                      |
+|**/FRAME_OFFSET=**                                                                                     |The offset (in frames) to apply to the event.                                                    |
+|**/TIME_OFFSET=**                                                                                      |The time offset (in seconds) to apply to the event.                                              |
+|**/EVENT_SEQUENCE=**                                                                                   |A list of events (separated by “+” signs).                                                       |
+|**/EXCLUDE_EVENTS=**                                                                                   |This Event_Sequence must not be during the sequence requested.                                   |
+|**/EVENT_SEQUENCE_INSTANCE=**                                                                          |Index of the sequence instance to evaluate (0 = all, 1 = first, etc.).                           |
+|**/EVENT_SUBSEQUENCE=**                                                                                |Optional inner event window within a broader sequence.                                           |
+|**/SUBSEQUENCE_EXCLUDE_EVENTS=**                                                                       |This Event subsequence must not be during the sequence requested.                                |
+|**/EVENT_SUBSEQUENCE_INSTANCE=**                                                                       |Index of the subsequence instance to evaluate (0 = all, 1 = first, etc.).                        |
+|**/EVENT_INSTANCE=**                                                                                   |Defines how many event occurrences to consider.                                                  |
+|**THRESHOLD**                                                                                          |Threshold value to trigger event detection.                                                      |
+====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.
+{{:MetricTimeofGlobalMinfromEvent.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). 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 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.
+====Examples====