Basis Functions

This topic describes how to write your own basis functions. For those applications where the built-in polynomial and hyperplane are not applicable, this method allows you to use a custom basis function written in a script. To use a custom basis function, simply declare the function in the script and register its name using CLsqfit:SetBasisFunc . In combination with calling this method, your script must call CLsqFit:SetNumCoefs to specify the number of terms being fit in each coordinate.

NOTE: As with the built-in basis functions, the custom basis function is fit about the mean value in each coordinate dimension. The calculated means are automatically included when evaluating the fit using CLsqfit:Eval and other methods in the CLsqFit class. See the CLsqFit: Fit method.

What is a Basis Function?

Before getting into the details of writing a custom basis function, let's review the role of the basis function in least squares fitting. Nowhere in your script will you specify the function being fit. Instead, you realize the function being fit through a basis function that returns a vector whose elements each represent one term being fit.

In computing the linear least squares solution, the input data are accrued in a so-called "product-sum" matrix consisting of a functional evaluation of the each coordinate being fit. These terms are calculated by a basis function that returns a vector consisting of 1 element corresponding to evaluation of the coordinate for each term of the fitting function. For example, consider fitting a 2-dimensional polynomial with 4 terms in x and 2 terms in y. Then the least squares fit has 8 terms in total, and the basis vector likewise has 8 elements. The job of the basis function is to accrue the elements of the product-sum matrix by evaluating each point in the function being fit. Although the function may fit multiple coordinate dimensions, the basis vector is always returned by the basis function as a 1-dimensional array.

Note that the basis functions may include cross terms you do not want to fit, for example, with a multidimensional polynomial. For example, you may not want to fit the xy cross term when fitting the 2-dimensional polynomial f(x,y) = a[1] + a[2]x + a[3]y + a[4]xy. In this case, there are still 4 coefficients in the fit, but one of them is to be disregarded by forcing its value to 0. Any term in the basis function that you do not wish to fit can be excluded by calling CLsqFit: ForceCoef.

Creating a Custom Basis Function

Writing a custom basis function requires understanding what it must do. In essence, the basis function turns the coordinate values of a point into a vector of basis values corresponding to each term of the fit. Your custom basis function is declared in the script asfunction MyFunc( n, v ), and is called to process each point used in the fit.

The basis function returns a 1-dimensional array containing the evaluation of each point for each element of the fit. Even If fitting more than 1 dimension (i.e., more than 1 variable), the basis vector is accrued as a flat 1-dimensional array. This flattening is done in hierarchical order from the lowest order term to the highest order term, in order of the fit coefficients.

Example: Creating a 4x2 Term Polynomial Basis Function

Using a 4x2 term (i.e., 2-dimensional) polynomial fit as an example, the coefficientsa[] are fit to the following function:

f(x,y) = a[1] + a[2]x + a[3]x^2 + a[4]x^3 + a[5]y + a[6]xy + a[7]x^2y + a[8]x^3y.

The number of coefficients are expressed as the number of terms in the basis vectorb[]. Hence the basis vector involves 8 elements in the following order:

b[1]=1, b[2]=x, b[3]=x^2, b[4]=x^3, b[5]=y, b[6]=xy, b[7]=x^2y, b[8]=x^3y

The basis functions of a general n-dimensional polynomial can be written as a matrix or tensor. For the case of a 2-dimensional polynomial, the basis functions can be shown as a matrix with the x-axis terms in the top row and the y-axis terms in the left column. Each of the other elements is obtained by multiplying the marginal column and row terms as follows:

Notice that the top row and left column do not change. But the second row is filled-in by multiplying the marginal terms. These basis functions are returned with the matrix rows flattened into a 1-dimensional vector containing 8 elements.

Taking the 4x2 polynomial example further, suppose you wish to add a y^3 term to the fit. This would add another row to the matrix, making 12 elements in total. The third row elements are given as the top row multiplied by the new y^3 term in the left column of the 3rd row. This third row would also be added to the basis vector b[] as elements b[9] throughb[12].

Example: Creating A 3x3 Term Polynomial with Missing Orders

The next example shows a polynomial fit with 9 coefficients a[] consisting of 3 terms in x and 3 terms in y, but with several of the polynomial orders missing.

Consider this function:

f(x,y) = a[1] + a[2]x^2 + a[3]x^4 + a[4]y + a[5]x^2y + a[6]x^4y + a[7]y^3 + a[8]x^2y^3 + a[9]x^4y^3.

Written as a matrix, the terms are organized like this:

The elements of basis vector b[] are then

     b[1] = 1, b[2] = x^2, b[3] = x^4, b[4] = y, b[5] = x^2y, b[6] = x^4y, b[7] = y^3, b[8] = x^2y^3, b[9] = x^4y^3.

Fitting Arbitrary Orders in Arbitrary Dimensions

Finally, there is the general case of fitting basis functions that do not follow any symmetric rules, such as fitting 5 coefficients to 3 coordinate values. An example of such a function would be a fit to f(x,y,z) using the function

     f = a[1] + a[2]x + a[3]xy + a[4]z + a[5]z^2.

In this case, the basis functions are b[1] = 1, b[2] = x, b[3] = xy, b[4] = z, and b[5] = z^2. For each point (x,y,z,f), your custom basis function would receive the values x, y, and z as a 3 element vector. It would then return a 5 element basis vector with each of the terms b[i] evaluated in the basis function.

Here are some final considerations for writing your own basis functions: When a constant term is part of the fit, as in the examples above, the basis vector requires a "1" at the coefficient index. This constant term is part of both the polynomial and hyperplane functions provided in the CLsqFit class. However, the constant term is not required when writing your own basis function. In that case, your basis vector does not need to return "1" for one of the basis functions. Likewise, the polynomials described above include cross terms. However, your custom multi-dimensional basis function is not required to use cross terms.

Implementing your Basis Function in a Script

In your script, the basis function takes the following form:

Note: Always declare the basis vector b as local inside the function to avoid the name b being confused with any other nameb used outside the basis function.

Examples of Basis Functions

Several examples of a scripted basis function are given below. Always remember that coordinate vector element V[1] is used for b[2], and so on. This is required because b[1] is always the constant term.

Fitting a line

To fit a line, the basis function would look like this:

Fitting a quadratic

To fit a quadratic about the origin, the basis function would look like this:

Fitting a polynomial of 1 independent variable

To see how the parameter n might be used, consider fitting a polynomial of order n-1 (the order of a polynomial is the highest power in the polynomial). Including the "constant" term, the polynomial of order n-1 has n coefficients. Here is the basis function:

Fitting a warped plane to 2 independent variables

Note that the table V can contain many elements for fitting as many as 100 coefficients and 10 independent variables, or "basis dimensions". For example, if fitting to x,y coordinates, the table V has 2 elements, V[1] for the x coordinate and V[2] for the y coordinate. The following basis function fits a warped plan to an f(x,y) surface:

This case is handled by the built-in, n-dimensional polynomial basis function selected using SetBasisFunc("polynomial"). Mira defaults to this basis function if you do not explicitly select a basis function in the script. In this example, you would then specify a 2x2 coefficient fit using SetNumCoefs( {2,2} ). Notice that the multiple coefficient numbers are combined into a table using {}.

Fitting a hyperplane to n independent variables

As a final example, consider the provided "hyperplane" function which has the form f = a[1] + a[2] x + a[3] y + a[4] z + ... The hyperplane fits n+1 coefficients for n coordinate dimensions plus the constant term a[1]. The hyperplane is selected using SetBasisFunc("hyperplane"). Here is how you would create a hyperplane as a user-provided script function:

The General Case: Fitting n Coefficients to m Dimensions

This script example uses the n= 5, m=3 fit described above, at the end of the section Creating a Custom Basis Function. This script example is also used for the SetNumCoefs method. The function being fit is f = a[1] + a[2] x + a[3] xy + a[4] z + a[5] z^2:

Related Topics

CLsqFit class

SetBasisFunc

SetNumCoefs

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