Differences

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

--- visual3d:documentation:pipeline:metric_commands:metric_compute_confidence_ellipse [2024/07/17 15:23] – sgranger
+++ visual3d:documentation:pipeline:metric_commands:metric_compute_confidence_ellipse [2025/10/31 19:12] (current) – [Notes] wikisysop
@@ Line 1: / Line 1: @@
 ====== Metric Compute Confidence Ellipse ======
+====Overview====
-Compute the 95 % confidence ellipse in 2 or more dimensions.
+The **Metric Compute Confidence Ellipse** command can be used to compute the 95 % confidence ellipse in 2 or more dimensions. This is the smallest ellipse that will cover 95 % of the data points.
-The smallest ellipse that will cover 95 % of the data points.
+Can also be used to compute the area or volume of an ellipse based on PCA. Does not require all vertices to be present for all frames. It can be found within the **Pipeline Workshop** under **Metric**.
-Compute the area or volume of an ellipse based on PCA. Does not require all vertices to be present for all frames.
+=====Pipeline Command=====
-\\
+The syntax for the function is as follows:
+<code>
-**Metric_Compute_Trajectory_Ellipse**
+Metric_Compute_Confidence_Ellipse
 /SIGNAL_TYPES=
 ! /SIGNAL_FOLDER=ORIGINAL
@@ Line 21: / Line 22: @@
 ! /START_FRAME=
 ! /END_FRAME=
-**;**
+;
-\\
+</code>
-[[http://www.real-statistics.com/multivariate-statistics/multivariate-normal-distribution/confidence-hyper-ellipse-eigenvalues/|For more information see]]
+=====Command Parameters=====
+The Parameters for the function are as follows:
+|**/SIGNAL_TYPES=**                                                                                    | **Specify signal type**                                                                        |
+|**/SIGNAL_NAMES=**                                                                                     |**Specify signal name**                                                                      |
+|**/SIGNAL_FOLDER=**                                                                                    |**Specify signal folder**                                                                      |
+|**/COMPONENT_SEQUENCE**                                                                                |**Which component of the signal will be used for statistical analysis of the sequence.**       |
+|**/RESULT_FOLDER**                                                                                     |**Name of folder holding resulting processed data**       |
+|**/[[Visual3D:Documentation:C3D_Signal_Types:EVENT_LABEL_Data_Type#Event_Sequence|EVENT_SEQUENCE]]=**  |**Specify the sequence of Events. Any number of Events can be entered (separated by +). This specific sequence of events must be true for a metric to be computed. The metric is computed from the first event in the sequence to the last event in the sequence**                                                                    |
+|**/[[Visual3D:Documentation:C3D_Signal_Types:EVENT_LABEL_Data_Type#Exclude_Events|EXCLUDE_EVENTS]]=**  |**If this event occurs before the first and last event, do not compute a metric** |
+|**/START_FRAME=**                                                                                      |**The frame at which to start recording data.**                                  |
+|**END_FRAME=**                                                                                         |**The frame at which to stop recording data.**                                   |
+====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.
+{{:visual3d:documentation:pipeline:metric_commands:ellipse_dlg.png?400|}}
+The dialog box allows you to assign values to the command parameters outlined above.
+=====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:
+<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=
+;
+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>
+The resulting metric is found in the **METRIC:PROCESSED** folder and should look similar to below.
+{{: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====
-Resulting Signal
+For more information see, [[http://www.real-statistics.com/multivariate-statistics/multivariate-normal-distribution/confidence-hyper-ellipse-eigenvalues/|confidence hyper ellipse eigenvalues]].
-Frame 1 contains volume and average value
-Starting at frame 2
-one frame for each dimension containing the eigenvalue and eigenvector (e.g. scale and unit vector)