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 Commands Overview =====

==== Metrics ====

Metrics are discrete quantitative values of signals such as maximum value, median value, value at a specified frame. In other words, metrics do not have a time-base like the other signals.

====Metric Computation====

=== Metric_Compute_DFT_Coefficients ===
[[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:metric_commands:Metric_Compute_DFT_Coefficients|Metric_Compute_DFT_Coefficients]]

This command computes a metric signal containing the Discrete Fourier Transform of a Signal coefficients and the Base Frequency. 

=== Metric_Compute_Gait_Signal_Stats ===
[[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:metric_commands:Metric_Compute_Gait_Signal_Stats|Metric_Compute_Gait_Signal_Stats]]

Compute discrete gain metrics that are part of the common cohort of [[https://www.sciencedirect.com/science/article/abs/pii/0167945796000061 | Gait Parameters]].

=== Metric_Compute_Power_From_DFT_Coefficients ===
[[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:metric_commands:Metric_Compute_Power_From_DFT_Coefficients|Metric_Compute_Power_From_DFT_Coefficients]]

=== Metric_Compute_Temporal_Distance ===
[[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:metric_commands:Metric_Compute_Temporal_Distance|Metric_Compute_Temporal_Distance]]

=== Temporal_distance_calculations_for_gait ===
Compute the Gait Temporal Distance values consistent with the Visual3D report item

[[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:metric_commands:temporal_distance_calculations_for_gait|Gait Temporal Distance]]

=== Compute_Volume_of_a_Convex_Hull_Across_Frames ===
[[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:metric_commands:Compute_Volume_of_a_Convex_Hull_Across_Frames|Compute_Volume_of_a_Convex_Hull_Across_Frames]]

=== Metric_Compute_95Confidence_Ellipse ===
[[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:metric_commands:Metric_Compute_95Confidence_Ellipse|Metric_Compute_95Confidence_Ellipse]]

==== Metric Math ====

=== Metric_Cross_Product ===
[[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:metric_commands:Metric_Cross_Product|Metric_Cross_Product]]

=== Metric_Dot_Product ===
[[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:metric_commands:Metric_Dot_Product|Metric_Dot_Product]]

=== Metric_Integrate ===
[[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:metric_commands:Metric_Integrate|Metric_Integrate]]

=== Metric_Maximum ===
[[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:metric_commands:Metric_Maximum|Metric_Maximum]]

=== Metric_Mean ===
[[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:metric_commands:Metric_Mean|Metric_Mean]]

=== Metric_Median ===
[[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:metric_commands:Metric_Median|Metric_Median]]

=== Metric_Minimum ===
[[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:metric_commands:Metric_Minimum|Metric_Minimum]]

=== Metric_Root_Mean_Squared ===
[[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:metric_commands:Metric_Root_Mean_Squared|Metric_Root_Mean_Squared]]

=== Metric_StdDev ===
[[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:metric_commands:Metric_StdDev|Metric_StdDev]]

=== Metric_Sum ===
[[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:metric_commands:Metric_Sum|Metric_Sum]]

==== Metric Events ====

=== Metric_Event_Count ===
[[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:metric_commands:Metric_Event_Count|Metric_Event_Count]]

=== Metric_Event_Sequence_Count ===
[[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:metric_commands:Metric_Event_Sequence_Count|Metric_Event_Sequence_Count]]

=== Metric_Explicit ===
[[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:metric_commands:Metric_Explicit|Metric_Explicit]]

=== Metric_Frames_Between_Events ===
[[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:metric_commands:Metric_Frames_Between_Events|Metric_Frames_Between_Events]]

=== Metric_Time_Between_Events ===
[[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:metric_commands:Metric_Time_Between_Events|Metric_Time_Between_Events]]

=== Metric_Time_of_Maximum_from_Event ===
[[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:metric_commands:Metric_Time_of_Maximum_from_Event|Metric_Time_of_Maximum_from_Event]]

=== Metric_Time_of_Minimum_from_Event ===
[[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:metric_commands:Metric_Time_of_Minimum_from_Event|Metric_Time_of_Minimum_from_Event]]

=== Metric_Time_of_Global_Maximum_from_Event ===
[[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:metric_commands:Metric_Time_of_Global_Maximum_from_Event|Metric_Time_of_Global_Maximum_from_Event]]

=== Metric_Time_of_Global_Minimum_from_Event ===
[[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:metric_commands:Metric_Time_of_Global_Minimum_from_Event|Metric_Time_of_Global_Minimum_from_Event]]

=== Metric_Time_of_Threshold_from_Event ===
[[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:metric_commands:Metric_Time_of_Threshold_from_Event|Metric_Time_of_Threshold_from_Event]]

=== Metric_Vector_Between_Events ===
[[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:metric_commands:Metric_Vector_Between_Events|Metric_Vector_Between_Events]]

=== Metric_Signal_Value_At_Event ===
[[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:metric_commands:Metric_Signal_Value_At_Event|Metric_Signal_Value_At_Event]]

The value of the specified signal at the specified frame of data.
=== Metric_Signal_Values_in_Sequence ===
[[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:metric_commands:Metric_Signal_Values_in_Sequence|Metric_Signal_Values_in_Sequence]]
==== Miscellaneous ====

=== Metric_To_Fit_Signal_To_Line ===
[[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:metric_commands:Metric_To_Fit_Signal_To_Line|Metric_To_Fit_Signal_To_Line]]

=== Remove_Metrics_By_Threshold ===
[[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:metric_commands:Remove_Metrics_By_Threshold|Remove_Metrics_By_Threshold]]

=== Metric_Golf_Swing_Plane ===
[[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:metric_commands:Metric_Golf_Swing_Plane|Metric_Golf_Swing_Plane]]

=== Metric_From_C3D_Parameter ===
[[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:metric_commands:Metric_From_C3D_Parameter|Metric_From_C3D_Parameter]]

==== Examples ====

This collection of examples gives you an overview of the types of calculations that can be done using metric pipeline commands.

=== Metrics Example 1 ===
[[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:metric_commands:Metrics_Example1|Metrics_Example1]]

Computing the metrics SI and DPSI defined in the following Journal Article.
Wikstrom EA, Tillman MD, Kline KJ, Borsa PA (2006) Gender and Limb Differences in Dynamic Postural Stability During Landing. Clin J Sport Med
=== Metrics Example 2 ===
[[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:metric_commands:Metrics_Example1|Metrics_Example2]]

Given a file with multiple walking strides for which the events LON and RON have been created represent left and right contacts with an instrumented treadmill.
Create one metric signal containing the value of the right knee angle at the event RON interleaved with the left knee angle at the event LON.
=== Metrics Example 3 ===
[[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:metric_commands:Metrics_Example1|Metrics_Example3]]

=== Metrics Example 4 ===
[[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:metric_commands:Metrics_Example1|Metrics_Example4]]

Create a meta-command that computes a linear regression. See also Metrics Example 5
=== Metrics Example 5 ===
[[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:metric_commands:Metrics_Example1|Metrics_Example5]]

Create a meta-command that computes a linear regression. See also Metrics Example 4
This example uses Event_Labels to define the range
=== Metrics_Example_20 ===

[[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:metric_commands:Metrics_Example1|Metrics_Example20]]

Create a metric for each of a series of event labels containing the frame number of the event