Differences

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

--- visual3d:documentation:pipeline:metric_commands:metric_to_fit_signal_to_line [2024/06/19 12:51] – sgranger
+++ visual3d:documentation:pipeline:metric_commands:metric_to_fit_signal_to_line [2024/07/17 15:46] (current) – created sgranger
@@ Line 1: / Line 1: @@
-{{fit a signal to a line
+====== Metric To Fit Signal To Line ======
-y = mx + b
+Fit a signal to a line
-and create metrics for slope (a), intercept (b), sigma m, sigma b, chi2, and q (r^2)
-metrictofitsignaltoline.png
+Y = mX + b
+and create Metrics for Slope (a), Intercept (b), Sigma m, Sigma b, CHI2, and Q (R^2)
-===== command =====
+{{:MetrictoFitSignaltoLine.png}}
+==== Command ====
 <code>
-metric_to_fit_signal_to_line
+Metric_To_Fit_Signal_To_Line
-/result_metric_name= the resulting name of the metric
+/RESULT_METRIC_NAME= The resulting name of the metric
-/result_metric_folder= the resulting folder of the metric
+/RESULT_METRIC_FOLDER= The resulting folder of the metric
-/signal_types= the signal type for the dependent variable
+/SIGNAL_TYPES= The signal type for the dependent variable
-/signal_names= the signal name for the dependent variable
+/SIGNAL_NAMES= The signal name for the dependent variable
-/signal_folder= the signal folder for the dependent variable
+/SIGNAL_FOLDER= The signal folder for the dependent variable
-/signal_component= the signal component for the dependent variable
+/SIGNAL_COMPONENT= The signal component for the dependent variable
-/x_signal_type= the signal type for the independent variable
+/X_SIGNAL_TYPE= The signal type for the independent variable
-/x_signal_name= the signal name for the independent variable
+/X_SIGNAL_NAME= The signal name for the independent variable
-/x_signal_folder= the signal folder for the independent variable
+/X_SIGNAL_FOLDER= The signal folder for the independent variable
-/x_signal_component= the signal component for the independent variable
+/X_SIGNAL_COMPONENT= The signal component for the independent variable
-/generate_mean_and_stddev= calculate the mean and standard deviation
+/GENERATE_MEAN_AND_STDDEV= Calculate the mean and standard deviation
-/append_to_existing_values= append values to the existing result signal
+/APPEND_TO_EXISTING_VALUES= Append values to the existing result signal
 ;
 </code>
-===== result =====
+==== Result ====
+**The resulting signal has 6 components:**
-**the resulting signal has 6 components:**
+**Slope = m** -> Component 1\\
+**Intercept = b** -> Component 2\\
+**Siga = uncertainty in m** -> Component 3\\
+**Sigb = uncertainty in b** -> Component 4\\
+**Chi2 = chi square** -> Component 5\\
+**Q = The R^2 statistic** -> Component 6\\
-**slope = m** -> component 1\\
-**intercept = b** -> component 2\\
-**siga = uncertainty in m** -> component 3\\
-**sigb = uncertainty in b** -> component 4\\
-**chi2 = chi square** -> component 5\\
-**q = the r^2 statistic** -> component 6\\
+==== Legacy Parameters ====
-===== legacy parameters =====
+**Prior to Visual3Dv5.02.28:**\\
+**1.** The EVENT_SEQUENCE was defined only using a start/end event. This meant if there were multiple sequences, Visual3D would return NO_DATA. The original event names were:
-**prior to visual3dv5.02.28:**\\
+**/START_EVENT=**
-**1.** the event_sequence was defined only using a start/end event. this meant if there were multiple sequences, visual3d would return no_data. the original event names were:
+**/END_EVENT=**
+**2.** It was not possible to calculate the mean/standard deviation or append values
-**/start_event=**
+In version 6 these parameters are converted into an Event Sequence.
-**/end_event=**
-**2.** it was not possible to calculate the mean/standard deviation or append values
-in version 6 these parameters are converted into an event sequence.
-}}