Differences

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

--- visual3d:documentation:pipeline:metric_commands:metric_compute_confidence_ellipse [2024/06/17 18:20] – created sgranger
+++ visual3d:documentation:pipeline:metric_commands:metric_compute_confidence_ellipse [2025/09/19 15:55] (current) – wikisysop
@@ Line 1: / Line 1: @@
-Compute the 95 % confidence ellipse in 2 or more dimensions.
+====== Metric Compute Confidence Ellipse ======
+====Overview====
-The smallest ellipse that will cover 95 % of the data points.
+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.
-Compute the area or volume of an ellipse based on PCA. Does not require all vertices to be present for all frames.
+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**.
-\\
+=====Pipeline Command=====
+The syntax for the function is as follows:
-**Metric_Compute_Trajectory_Ellipse**
+<code>
+Metric_Compute_Confidence_Ellipse
 /SIGNAL_TYPES=
 ! /SIGNAL_FOLDER=ORIGINAL
@@ Line 19: / Line 22: @@
 ! /START_FRAME=
 ! /END_FRAME=
-**;**
+;
-\\
+</code>
+=====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=====
+====Notes====
 [[http://www.real-statistics.com/multivariate-statistics/multivariate-normal-distribution/confidence-hyper-ellipse-eigenvalues/|For more information see]]
@@ Line 28: / Line 59: @@
 Starting at frame 2
 one frame for each dimension containing the eigenvalue and eigenvector (e.g. scale and unit vector)