Differences

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

--- visual3d:documentation:pipeline:metric_commands:metric_compute_confidence_ellipse [2025/10/03 19:48] – [Command Parameters] wikisysop
+++ visual3d:documentation:pipeline:metric_commands:metric_compute_confidence_ellipse [2025/10/31 19:12] (current) – [Notes] wikisysop
@@ Line 47: / Line 47: @@
 The dialog box allows you to assign values to the command parameters outlined above.
-=====Example=====
+=====Example: Computing Confidence Ellipse for COFP=====
+In this example the **Metric Compute Confidence Ellipse** command is used to compute the values associated with the confidence ellipse for left and right COFP during a balance trial. This analysis can be useful to compare balance consistency between sides using ellipse areas.
+The pipeline command for each side is:
-====Notes====
+<code>
+Metric_Compute_Confidence_Ellipse
+/SIGNAL_TYPES=COFP
+! /SIGNAL_FOLDER=ORIGINAL
+/SIGNAL_NAMES=FP3
+/COMPONENT_SEQUENCE=X + Y
+! /RESULT_FOLDER=PROCESSED
+/RESULT_NAME=Ellipse_Right
+/EVENT_SEQUENCE=START+END
+! /EXCLUDE_EVENTS=
+! /START_FRAME=
+! /END_FRAME=
+;
-[[http://www.real-statistics.com/multivariate-statistics/multivariate-normal-distribution/confidence-hyper-ellipse-eigenvalues/|For more information see]]
+Metric_Compute_Confidence_Ellipse
+/SIGNAL_TYPES=COFP
+! /SIGNAL_FOLDER=ORIGINAL
+/SIGNAL_NAMES=FP4
+/COMPONENT_SEQUENCE=X + Y
+! /RESULT_FOLDER=PROCESSED
+/RESULT_NAME=Ellipse_Left
+/EVENT_SEQUENCE=START+END
+! /EXCLUDE_EVENTS=
+! /START_FRAME=
+! /END_FRAME=
+;
+</code>
-Resulting Signal
+The resulting metric is found in the **METRIC:PROCESSED** folder and should look similar to below.
-Frame 1 contains volume and average value
+{{:visual3d:documentation:pipeline:metric_commands:ellipse_result.png|}}
+The metric for this example contains 3 components, with 3 values for each component. The results are as follows:
+Frame 1:
+|X| Volume|
+|Y| average of all frames of input component 1|
+|Z| average of all frames of input component 2|
+Frame 2: (for input component 1)
+|1| Eigenvalue|
+|2| Eigenvector|
+|3| Eigenvector|
+Frame 3: same as frame 2, but for input component 2
+If you have two input components, frame 1 X is the area, if you have three input components, Frame 1, X is the volume.
+**The ellipse can also be visualized in the reports tab:**
+Add a new 2D Graph to your report with the appropriate X and Y data and make sure to select **Graph Confidence Ellipse**.
+{{:visual3d:documentation:pipeline:metric_commands:ellipse_command.png|}}
+The resulting graph should look similar to below:
+{{:visual3d:documentation:pipeline:metric_commands:ellipse_graph.png|}}
+====Notes====
-Starting at frame 2
+For more information see, [[http://www.real-statistics.com/multivariate-statistics/multivariate-normal-distribution/confidence-hyper-ellipse-eigenvalues/|confidence hyper ellipse eigenvalues]].
-one frame for each dimension containing the eigenvalue and eigenvector (e.g. scale and unit vector)