HAS-Motion Software Documentation

User Tools

Site Tools

You are here: Main Page » visual3d » documentation » pipeline » metric_commands » Metric To Fit Signal To Line
visual3d:documentation:pipeline:metric_commands:metric_to_fit_signal_to_line

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
visual3d:documentation:pipeline:metric_commands:metric_to_fit_signal_to_line [2024/06/17 18:20] – created sgrangervisual3d:documentation:pipeline:metric_commands:metric_to_fit_signal_to_line [2025/09/22 18:18] (current) – wikisysop
Line 1: Line 1:
- +====== Metric To Fit Signal To Line ====== 
- +====Overview==== 
- +This command can be used to fit a signal to a line.
- +
-Fit a signal to a line +
 Y = mX + b Y = mX + b
 and create Metrics for Slope (a), Intercept (b), Sigma m, Sigma b, CHI2, and Q (R^2) and create Metrics for Slope (a), Intercept (b), Sigma m, Sigma b, CHI2, and Q (R^2)
  
-[[MetrictoFitSignaltoLine.png]]+It can be found within the **Pipeline Workshop** under **Metric**.
  
-===== Command =====+====Pipeline Command==== 
 + 
 +The syntax for the function is as follows:
  
 <code> <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> </code>
  
-===== Result =====+====Command Parameters==== 
 + 
 +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                                                      | 
 + 
 +====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. 
 + 
 +{{:MetrictoFitSignaltoLine.png}} 
 + 
 +The dialog box allows you to assign values to the command parameters outlined above. 
 + 
 + 
 +====Examples==== 
 + 
 +====Notes====
  
 **The resulting signal has 6 components:** **The resulting signal has 6 components:**
Line 41: Line 69:
  
  
-===== Legacy Parameters =====+==== Legacy Parameters ====
  
 **Prior to Visual3Dv5.02.28:**\\ **Prior to Visual3Dv5.02.28:**\\
Line 51: Line 79:
  
 In version 6 these parameters are converted into an Event Sequence. In version 6 these parameters are converted into an Event Sequence.
- 
- 
  
  
visual3d/documentation/pipeline/metric_commands/metric_to_fit_signal_to_line.1718648449.txt.gz · Last modified: 2024/06/17 18:20 by sgranger