Table Of Contents

Fit Line (G Dataflow)

Last Modified: October 26, 2017

Finds the line of such quality that best represents a set of points. The resulting line may only take into account a subset of the input points.

connector_pane_image
datatype_icon

points

Array of point-coordinate clusters.

This array must contain two or more point-coordinate clusters corresponding to two or more points on the line.

datatype_icon

minimum score

minimum score specifies the required quality of the fitted line.

The score can vary from 0 to 1000, where 1000 represents a perfect line. The default is 900.

datatype_icon

pixel radius

Neighborhood pixel relationship for the initial subset of points being used.

datatype_icon

error in

error in describes the error status before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node.

datatype_icon

status

status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE.

datatype_icon

code

code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.

datatype_icon

source

source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.

datatype_icon

maximum iterations

maximum iterations specifies the maximum number of refining steps the algorithm takes to ensure that the quality of the fit is better than Minimum Score.

datatype_icon

line equation

Cluster of three coefficients A, B, and C of the equation in the normal form (Ax + By + C=0) of the best fit line.

datatype_icon

line

line represents the intersection of the line equation and the bounding rectangle of the input points.

datatype_icon

residual

residual represents the least-square error of the fitted line to the entire set of points.

Residual = where e i is the distance from the i th input point to the fit line.

datatype_icon

valid fit?

valid fit? specifies whether the Minimum Score was attained within the given Maximum Iterations.

datatype_icon

error out

error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out indicator on the front panel and select Explain Error from the shortcut menu for more information about the error.

datatype_icon

status

status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.

datatype_icon

code

code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.

datatype_icon

source

source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.

datatype_icon

indexes of points used

indexes of points used is an array that returns the indexes of points in the Points array that were used to fit the line.

Some points may be excluded based on the Minimum Score and Pixel Radius specified.

Where This Node Can Run:

Desktop OS: Windows

FPGA: Not supported

Web Server: Not supported in VIs that run in a web application


Recently Viewed Topics