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 [2025/09/22 18:18] (current) – wikisysop
@@ Line 1: / Line 1: @@
-{{fit a signal to a line
+====== Metric To Fit Signal To Line ======
+====Overview====
+This command can be used to fit a signal to a line.
+Y = mX + b
+and create Metrics for Slope (a), Intercept (b), Sigma m, Sigma b, CHI2, and Q (R^2)
-y = mx + b
+It can be found within the **Pipeline Workshop** under **Metric**.
-and create metrics for slope (a), intercept (b), sigma m, sigma b, chi2, and q (r^2)
-metrictofitsignaltoline.png
+====Pipeline Command====
-===== command =====
+The syntax for the function is as follows:
 <code>
-metric_to_fit_signal_to_line
+Metric_To_Fit_Signal_To_Line
-/result_metric_name= the resulting name of the metric
+! /RESULT_METRIC_FOLDER=PROCESSED
-/result_metric_folder= the resulting folder of the metric
+/RESULT_METRIC_NAME=
-/signal_types= the signal type for the dependent variable
+/SIGNAL_TYPES=
-/signal_names= the signal name for the dependent variable
+! /SIGNAL_FOLDER=ORIGINAL
-/signal_folder= the signal folder for the dependent variable
+! /SIGNAL_NAMES=
-/signal_component= the signal component for the dependent variable
+/SIGNAL_COMPONENTS=
-/x_signal_type= the signal type for the independent variable
+/X_SIGNAL_TYPE=FRAME_NUMBERS
-/x_signal_name= the signal name for the independent variable
+! /X_SIGNAL_FOLDER=ORIGINAL
-/x_signal_folder= the signal folder for the independent variable
+! /X_SIGNAL_NAME=TIME
-/x_signal_component= the signal component for the independent variable
+/X_SIGNAL_COMPONENT=0
-/generate_mean_and_stddev= calculate the mean and standard deviation
+! /EVENT_SEQUENCE=
-/append_to_existing_values= append values to the existing result signal
+! /EXCLUDE_EVENTS=
+! /GENERATE_MEAN_AND_STDDEV=FALSE
+! /APPEND_TO_EXISTING_VALUES=FALSE
 ;
 </code>
-===== result =====
+====Command Parameters====
-**the resulting signal has 6 components:**
+The following table shows the command parameters seen above and their descriptions:
+|**/RESULT_METRIC_NAME=**                                                                               |The resulting name of the metric                                                                 |
+|**/RESULT_METRIC_FOLDER=**                                                                             |The resulting folder of the metric                                                               |
+|**/SIGNAL_TYPES=**                                                                                     |The type of signal to be processed                                                               |
+|**/SIGNAL_NAMES=**                                                                                     |The name of the signal to be processed                                                           |
+|**/SIGNAL_FOLDER**                                                                                     |The folder of the signal to be processed                                                         |
+|**/SIGNAL_COMPONENT=**                                                                                 |The component of the signal to be processed                                                      |
+|**/X_SIGNAL_TYPE=**                                                                                    |The signal type 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_COMPONENT=**                                                                               |The signal component for the independent variable                                                |
+|**/GENERATE_MEAN_AND_STDDEV=**                                                                         |Calculate the mean and standard deviation                                                        |
+|**/APPEND_TO_EXISTING_VALUES=**                                                                        |Append values to the existing result signal                                                      |
-**slope = m** -> component 1\\
+====Dialog====
-**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\\
+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.
-===== legacy parameters =====
+{{:MetrictoFitSignaltoLine.png}}
-**prior to visual3dv5.02.28:**\\
+The dialog box allows you to assign values to the command parameters outlined above.
-**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:
-**/start_event=**
-**/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.
+====Examples====
+====Notes====
+**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\\
+==== 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:
+**/START_EVENT=**
+**/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.
-}}