HAS-Motion Software Documentation

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Metric Time of Threshold from Event ======
====Overview====
The **Metric Time of Threshold from Event** command can be used to record the time it takes for a signal to reach a threshold, like a joint angle reaching 90 degrees, in relation to a defined event. The command can be found in the **Pipeline Workshop** under **Metric**.

====Pipeline Command====

The command syntax is as follows:

<code>
Metric_Time_Of_Threshold_From_Event
! /RESULT_METRIC_TIME=
! /RESULT_METRIC_VALUE=
! /RESULT_FOLDER=PROCESSED
! /THRESHOLD=
! /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
! /ON_ASCENT=TRUE
! /ON_DESCENT=
! /FRAME_WINDOW=8
! /ENSURE_FRAMES_BEFORE=
! /ENSURE_FRAMES_AFTER=
;
</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.                                                           |
|**THRESHOLD**                                                                                          |Threshold value to be reached.                                                                   |
|**/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.                                                  |
|**ON_ASCENT**                                                                                          |Determine if the event is detected when the signal crosses the threshold in an upward direction. |
|**ON_DESCENT**                                                                                         |Determines if the event is detected when the signal crosses the threshold in a downward direction.|
|**FRAME_WINDOW**                                                                                       |The range of frames that must satisfy the threshold crossing condition.                          |
|**ENSURE_FRAMES_BEFORE**                                                                               |(True or False) Radius frames of data before crossing must lie on the same side of the threshold.|
|**ENSURE_FRAMES_AFTER**                                                                                |(True or False) Radius frames of data after crossing must lie on the same side of the threshold. |


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

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