Differences

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

--- visual3d:documentation:pipeline:metric_commands:metric_time_of_maximum_from_event [2024/06/26 20:27] – created sgranger
+++ visual3d:documentation:pipeline:metric_commands:metric_time_of_maximum_from_event [2025/09/19 14:14] (current) – wikisysop
@@ Line 1: / Line 1: @@
-====== Metric_Time_of_Maximum_from_Event ======
+====== Metric Time of Maximum from Event ======
+====Overview====
+The **Metric Time of Maximum from Event** command can be used to compute the time between an event and a maximum signal. For example, this command could be used to determine the time between initial foot contact with the ground and max grf. 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.
-{{MetricTimeofMaximumfromEvent.png}}
+<code>
 **Metric_Time_Of_Maximum_From_Event**
 /RESULT_EVENT_NAME=
@@ Line 32: / Line 31: @@
 ! /FRAME_WINDOW=8
 **;**
+</code>
+====Command Parameters====
+The following table shows the command parameters seen above and their descriptions:
+|**/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.                                                  |
+|**/SELECT_X/Y/Z=**                                                                                     |Select signal direction to consider.                                                             |
+|**/SELECT_RESIDUAL=**                                                                                  |True/False select residual signal component.                                                     |
+|**START_AT_EVENT=**                                                                                    |Select event at which to start computation.                                                      |
+|**/END_AT_EVENT=**                                                                                     |Event to end command at.                                                                         |
+|**FRAME_WINDOW**                                                                                       |Size of the frame window to search around each point.                                            |
+====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.
+{{:MetricTimeofMaximumfromEvent.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====