CLsqFit:GetPtX


The GetPtX method returns the values of the independent variables for an existing sample point. The value(s) are returned in a 1-dimensional array.

Syntax

tableX = CLsqFit:GetPtX( nIndex )

tableX = CLsqFit:GetPtX( nIndex, nDimension )

bullet.gif    nIndex is the index of the point in the sample, beginning at index 1.

bullet.gif    nDimension is an optional parameter that specifies the basis dimension (index of the independent variable) when the fit involves more than 1 basis dimension.

bullet.gif    tableX is a 1-dimensional array holding values of the independent variable(s).

Remarks

This method returns the x value or values in a 1-dimensional array even if the fit uses only 1 independent variable, or "basis dimension". The values at different basis dimensions are accessed as elements 1, 2, and so on. The number of elements in the table equals the number of basis dimensions used in the fit. Since Mira supports up to 10 dimensions, the table may caontain 1 to 10 elements. The number of table elements may be obtained using the # operator, like #tbl, or by calling the GetBasisDim method.

The GetPtX method uses the index of the target point. The value of nIndex must either be known from the order that points were added to the sample, or by matching the target point's values using FindPt.

Example

The following example illustrates how to change the x coordinate of an existing point. The target point's index is found by matching its values:

L = new_lsqfit()

-- create a CLsqFit object

L:SetNumCoefs( 2 )

-- set 2 coefficients

L:AddPt( 3.5, 5.15 )

-- add a point for x = 3.5, y = 5.15, weight = 1

-- add more points to the fit

 

L:Fit()

-- Fit the line

-- do something with the fit results

 

n = L:FindPt( 3.5, 5.15 )

-- find the point (if we don't know it was index 1)

t = L:GetPtX(n)

-- coordinate(s) returned in array t

t[1] = t[1] + 0.1

-- add 0.1 to the first index of the table (x coordinate)

L:SetPtX( n, t )

-- send the table to replace the 1st coordinate value

L:Fit()

-- get a new fit result using the new value

Related Topics

CLsqFit class, SetPtX, AddPt, FindPt


Mira Pro x64 Script User's Guide, Copyright Ⓒ 2023 Mirametrics, Inc. All Rights Reserved.