Integer, Intent (In)	::	m, nw, nq, liq, lrq
Integer, Intent (Inout)	::	ifail
Integer, Intent (Out)	::	iq(liq)
Real (Kind=nag_wp), Intent (In)	::	x(m), y(m), z(m), f(m)
Real (Kind=nag_wp), Intent (Out)	::	rq(lrq)

C Header Interface

#include <nag.h>

void	e01tgf_ (const Integer m, const double x[], const double y[], const double z[], const double f[], const Integer nw, const Integer nq, Integer iq[], const Integer liq, double rq[], const Integer lrq, Integer ifail)

The routine may be called by the names e01tgf or nagf_interp_dim3_scat_shep.

3 Description

e01tgf constructs a smooth function

Q (x, y, z)

which interpolates a set of

m

scattered data points

(x_{r}, y_{r}, z_{r}, f_{r})

, for

r = 1, 2, \dots, m

, using a modification of Shepard's method. The surface is continuous and has continuous first partial derivatives.

The basic Shepard method, which is a generalization of the two-dimensional method described in Shepard (1968), interpolates the input data with the weighted mean

Q (x, y, z) = \frac{\sum_{r = 1}^{m} w_{r} (x, y, z) q_{r}}{\sum_{r = 1}^{m} w_{r} (x, y, z)},

where

q_{r} = f_{r} ​ and ​ w_{r} (x, y, z) = \frac{1}{d_{r}^{2}} ​ and ​ d_{r}^{2} = {(x - x_{r})}^{2} + {(y - y_{r})}^{2} + {(z - z_{r})}^{2} .

The basic method is global in that the interpolated value at any point depends on all the data, but this routine uses a modification (see Franke and Nielson (1980) and Renka (1988a)), whereby the method becomes local by adjusting each

w_{r} (x, y, z)

to be zero outside a sphere with centre

(x_{r}, y_{r}, z_{r})

and some radius

R_{w}

. Also, to improve the performance of the basic method, each

q_{r}

above is replaced by a function

q_{r} (x, y, z)

, which is a quadratic fitted by weighted least squares to data local to

(x_{r}, y_{r}, z_{r})

and forced to interpolate

(x_{r}, y_{r}, z_{r}, f_{r})

. In this context, a point

(x, y, z)

is defined to be local to another point if it lies within some distance

R_{q}

of it. Computation of these quadratics constitutes the main work done by this routine.

The efficiency of the routine is further enhanced by using a cell method for nearest neighbour searching due to Bentley and Friedman (1979).

The radii

R_{w}

and

R_{q}

are chosen to be just large enough to include

N_{w}

and

N_{q}

data points, respectively, for user-supplied constants

N_{w}

and

N_{q}

. Default values of these arguments are provided by the routine, and advice on alternatives is given in Section 9.2.

This routine is derived from the routine QSHEP3 described by Renka (1988b).

Values of the interpolant

Q (x, y, z)

generated by this routine, and its first partial derivatives, can subsequently be evaluated for points in the domain of the data by a call to e01thf.

4 References

Bentley J L and Friedman J H (1979) Data structures for range searching ACM Comput. Surv. 11 397–409

Franke R and Nielson G (1980) Smooth interpolation of large sets of scattered data Internat. J. Num. Methods Engrg. 15 1691–1704

Renka R J (1988a) Multivariate interpolation of large sets of scattered data ACM Trans. Math. Software 14 139–148

Renka R J (1988b) Algorithm 661: QSHEP3D: Quadratic Shepard method for trivariate interpolation of scattered data ACM Trans. Math. Software 14 151–152

Shepard D (1968) A two-dimensional interpolation function for irregularly spaced data Proc. 23rd Nat. Conf. ACM 517–523 Brandon/Systems Press Inc., Princeton

5 Arguments

1: $m$ – Integer Input: On entry: $m$ , the number of data points.

Constraint: $m \geq 10$ .
2: $x (m)$ – Real (Kind=nag_wp) array Input
3: $y (m)$ – Real (Kind=nag_wp) array Input
4: $z (m)$ – Real (Kind=nag_wp) array Input: On entry: $x (r)$ , $y (r)$ , $z (r)$ must be set to the Cartesian coordinates of the data point $(x_{r}, y_{r}, z_{r})$ , for $r = 1, 2, \dots, m$ .

Constraint: these coordinates must be distinct, and must not all be coplanar.
5: $f (m)$ – Real (Kind=nag_wp) array Input: On entry: $f (r)$ must be set to the data value $f_{r}$ , for $r = 1, 2, \dots, m$ .
6: $nw$ – Integer Input: On entry: the number $N_{w}$ of data points that determines each radius of influence $R_{w}$ , appearing in the definition of each of the weights $w_{r}$ , for $r = 1, 2, \dots, m$ (see Section 3). Note that $R_{w}$ is different for each weight. If $nw \leq 0$ the default value $nw = \min (32, m - 1)$ is used instead.

Constraint: $nw \leq \min (40, m - 1)$ .
7: $nq$ – Integer Input: On entry: the number $N_{q}$ of data points to be used in the least squares fit for coefficients defining the nodal functions $q_{r} (x, y, z)$ (see Section 3). If $nq \leq 0$ the default value $nq = \min (17, m - 1)$ is used instead.

Constraint: $nq \leq 0$ or $9 \leq nq \leq \min (40, m - 1)$ .
8: $iq (liq)$ – Integer array Output: On exit: integer data defining the interpolant $Q (x, y, z)$ .
9: $liq$ – Integer Input: On entry: the dimension of the array iq as declared in the (sub)program from which e01tgf is called.

Constraint: $liq \geq 2 \times m + 1$ .
10: $rq (lrq)$ – Real (Kind=nag_wp) array Output: On exit: real data defining the interpolant $Q (x, y, z)$ .
11: $lrq$ – Integer Input: On entry: the dimension of the array rq as declared in the (sub)program from which e01tgf is called.

Constraint: $lrq \geq 10 \times m + 7$ .
12: $ifail$ – Integer Input/Output: On entry: ifail must be set to $0$ , $−1$ or $1$ to set behaviour on detection of an error; these values have no effect when no error is detected.
A value of $0$ causes the printing of an error message and program execution will be halted; otherwise program execution continues. A value of $−1$ means that an error message is printed while a value of $1$ means that it is not.

If halting is not appropriate, the value $−1$ or $1$ is recommended. If message printing is undesirable, then the value $1$ is recommended. Otherwise, the value $0$ is recommended. When the value $- 1$ or $1$ is used it is essential to test the value of ifail on exit.

On exit: $ifail = 0$ unless the routine detects an error or a warning has been flagged (see Section 6).

6 Error Indicators and Warnings

If on entry

ifail = 0

−1

, explanatory error messages are output on the current error message unit (as defined by x04aaf).

Errors or warnings detected by the routine:

$ifail = 1$: On entry, liq is too small: $liq = ⟨ value ⟩$ .

On entry, lrq is too small: $lrq = ⟨ value ⟩$ .

On entry, $m = ⟨ value ⟩$ .
Constraint: $m \geq 10$ .

On entry, $nq = ⟨ value ⟩$ .
Constraint: $nq \leq 0$ or $nq \geq 9$ .

On entry, $nq = ⟨ value ⟩$ and $m = ⟨ value ⟩$ .
Constraint: $nq \leq \min (40, m - 1)$ .

On entry, $nw = ⟨ value ⟩$ and $m = ⟨ value ⟩$ .
Constraint: $nw \leq \min (40, m - 1)$ .

$ifail = 2$: There are duplicate nodes in the dataset. $(x (I), y (I), z (I)) = (x (J), y (J), z (J))$ for: $I = ⟨ value ⟩$ and $J = ⟨ value ⟩$ . The interpolant cannot be derived.

$ifail = 3$: All nodes are coplanar. There is no unique solution.

$ifail = - 99$: An unexpected error has been triggered by this routine. Please contact NAG.
See Section 7 in the Introduction to the NAG Library FL Interface for further information.

$ifail = - 399$: Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library FL Interface for further information.

$ifail = - 999$: Dynamic memory allocation failed.
See Section 9 in the Introduction to the NAG Library FL Interface for further information.

7 Accuracy

On successful exit, the function generated interpolates the input data exactly and has quadratic accuracy.

8 Parallelism and Performance

e01tgf is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.

e01tgf makes calls to BLAS and/or LAPACK routines, which may be threaded within the vendor library used by this implementation. Consult the documentation for the vendor library for further information.

Please consult the X06 Chapter Introduction for information on how to control and interrogate the OpenMP environment used within this routine. Please also consult the Users' Note for your implementation for any additional implementation-specific information.

9 Further Comments

9.1 Timing

The time taken for a call to e01tgf will depend in general on the distribution of the data points. If x, y and z are uniformly randomly distributed, then the time taken should be O(m). At worst

O (m^{2})

time will be required.

9.2 Choice of $N_{w}$ and $N_{q}$

Default values of the arguments

N_{w}

and

N_{q}

may be selected by calling e01tgf with

nw \leq 0

and

nq \leq 0

. These default values may well be satisfactory for many applications.

If non-default values are required they must be supplied to e01tgf through positive values of nw and nq. Increasing these arguments makes the method less local. This may increase the accuracy of the resulting interpolant at the expense of increased computational cost. The default values

nw = \min (32, m - 1)

and

nq = \min (17, m - 1)

have been chosen on the basis of experimental results reported in Renka (1988a). In these experiments the error norm was found to vary smoothly with

N_{w}

and

N_{q}

, generally increasing monotonically and slowly with distance from the optimal pair. The method is not, therefore, thought to be particularly sensitive to the argument values. For further advice on the choice of these arguments see Renka (1988a).

9.3 Internal Changes

Internal changes have been made to this routine as follows:

At Mark 26.0: The algorithm used by this routine, based on a Modified Shepard method, was changed to produce more reliable results for some data sets which were previously not well handled. In addition, handling of evaluation points which are far away from the original data points was improved by use of an extrapolation method which returns useful results rather than just an error message as was done at earlier Marks.
At Mark 26.1: The algorithm underwent further changes which enable it to work better on certain data sets, for example data presented on a regular grid. The results returned when evaluating the function at points which are not in the original data set used to construct the interpolating function are now likely to be slightly different from those returned at previous Marks of the Library, but the function still interpolates the original data.

For details of all known issues which have been reported for the NAG Library please refer to the Known Issues.

10 Example

This program reads in a set of

30

data points and calls e01tgf to construct an interpolating function

Q (x, y, z)

. It then calls e01thf to evaluate the interpolant at a set of points.

Note that this example is not typical of a realistic problem: the number of data points would normally be larger.

e01tg: FL CL CPP AD

NAG FL Interfacee01tgf (dim3_​scat_​shep)

▸▿ Contents

1 Purpose

2 Specification

3 Description

4 References

5 Arguments

6 Error Indicators and Warnings

7 Accuracy

8 Parallelism and Performance

9 Further Comments

9.1 Timing

9.2 Choice of Nw and Nq

9.3 Internal Changes

10 Example

10.1 Program Text

10.2 Program Data

10.3 Program Results

NAG FL Interface
e01tgf (dim3_scat_shep)

9.2 Choice of $N_{w}$ and $N_{q}$