====== 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**.

====Pipeline Command====

The command syntax is as follows:

<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>

====Command Parameters====

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.

{{: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.

====Example: Time Between Foot On and Max GRF====
Here we use the **Metric Time Of Global Maximum from Event** command to find how long it takes a baseball player to reach max GRF in their lead leg after planting their food. 

<code>
Metric_Time_Of_Global_Maximum_From_Event
/RESULT_METRIC_TIME=MAX_L_GRF_TIME
/RESULT_METRIC_VALUE=MAX_L_GRF_VALUE
! /RESULT_FOLDER=PROCESSED
! /RESULT_COMPONENTS=ALL
/SIGNAL_TYPES=FORCE
 /SIGNAL_FOLDER=ORIGINAL
 /SIGNAL_NAMES=FP1
/SIGNAL_COMPONENTS=Z
! /FRAME_OFFSET=0
! /TIME_OFFSET=
/EVENT_SEQUENCE=LON+END
! /EXCLUDE_EVENTS=
! /EVENT_SEQUENCE_INSTANCE=0
! /EVENT_SUBSEQUENCE=
! /SUBSEQUENCE_EXCLUDE_EVENTS=
! /EVENT_SUBSEQUENCE_INSTANCE=0
! /EVENT_INSTANCE=0
! /THRESHOLD=
;
</code>

====Example 2: Comparing Lead Foot GRF to Bat Speed====
Here we use **Metric Time Of Global Maximum from Event** along with **Metric Time Between Events** to perform analysis on lead leg loading and bat speed in the baseball swing. 

First we will find the amount of time it takes the hitter to make their stride before the pitch arrives, this can vary hitter to hitter depending on individual mechanics, the pitch variety, and situation. Some hitters won't make a stride at all. 

<code>
Metric_Time_Between_Events
/RESULT_METRIC_NAME=Lead leg plant time
! /RESULT_METRIC_FOLDER=PROCESSED
/EVENT_SEQUENCE=LOFF+LON
/EXCLUDE_EVENTS=
! /SCALE_FACTOR=1
/GENERATE_MEAN_AND_STDDEV=FALSE
! /APPEND_TO_EXISTING_VALUES=FALSE
;
</code>

Next we will find the time between planting the lead foot and reaching max GRF as well as max bat speed in the z axis. 

<code>
Metric_Time_Of_Global_Maximum_From_Event
/RESULT_METRIC_TIME=MAX_L_GRF_TIME
/RESULT_METRIC_VALUE=MAX_L_GRF_VALUE
! /RESULT_FOLDER=PROCESSED
! /RESULT_COMPONENTS=ALL
/SIGNAL_TYPES=FORCE
 /SIGNAL_FOLDER=ORIGINAL
 /SIGNAL_NAMES=FP1
/SIGNAL_COMPONENTS=Z
! /FRAME_OFFSET=0
! /TIME_OFFSET=
/EVENT_SEQUENCE=LON+END
! /EXCLUDE_EVENTS=
! /EVENT_SEQUENCE_INSTANCE=0
! /EVENT_SUBSEQUENCE=
! /SUBSEQUENCE_EXCLUDE_EVENTS=
! /EVENT_SUBSEQUENCE_INSTANCE=0
! /EVENT_INSTANCE=0
! /THRESHOLD=
;

Metric_Time_Of_Global_Maximum_From_Event
/RESULT_METRIC_TIME=MAX_BSpeed_TIME
/RESULT_METRIC_VALUE=MAX_BSpeed_VALUE
! /RESULT_FOLDER=PROCESSED
! /RESULT_COMPONENTS=ALL
/SIGNAL_TYPES=LINK_MODEL_BASED
 /SIGNAL_FOLDER=ORIGINAL
 /SIGNAL_NAMES=BAT_ANGULAR_VELOCITY
/SIGNAL_COMPONENTS=Z
! /FRAME_OFFSET=0
! /TIME_OFFSET=
/EVENT_SEQUENCE=LON+END
! /EXCLUDE_EVENTS=
! /EVENT_SEQUENCE_INSTANCE=0
! /EVENT_SUBSEQUENCE=
! /SUBSEQUENCE_EXCLUDE_EVENTS=
! /EVENT_SUBSEQUENCE_INSTANCE=0
! /EVENT_INSTANCE=0
! /THRESHOLD=
;
</code>

5 new metrics have now been created; Lead Leg Plant Time, Time to max bat speed from plant, max bat speed value, time to max GRF from plant, and max GRF value.

Compare the time to max bat speed and time to max GRF:

{{:visual3d:documentation:pipeline:metric_commands:time_to_bat.png?400|}}{{:visual3d:documentation:pipeline:metric_commands:time_to_grf.png?400|}}

For this individual's swing we see that the fastest bat speed is reached shortly after the greatest lead leg GRF is achieved. This relationship is shown in the graph below:

{{:visual3d:documentation:pipeline:metric_commands:grf_speed.png?600|}}