-dimensional space, that is defined by a set of gridded data points. It offers three methods to interpolate the data: Linear Interpolation, Cubic Interpolation and Weighted Average.

2 Specification

Fortran Interface

Subroutine e01zaf (

d, narr, uniform, axis, lx, v, point, method, k, wf, ans, ifail)

Integer, Intent (In)	::	d, narr(d), lx, method, k
Integer, Intent (Inout)	::	ifail
Real (Kind=nag_wp), Intent (In)	::	axis(lx), v(*), point(d), wf
Real (Kind=nag_wp), Intent (Out)	::	ans
Logical, Intent (In)	::	uniform

C Header Interface

#include <nag.h>

void	e01zaf_ (const Integer d, const Integer narr[], const logical uniform, const double axis[], const Integer lx, const double v[], const double point[], const Integer method, const Integer k, const double wf, double ans, Integer ifail)

The routine may be called by the names e01zaf or nagf_interp_dimn_grid.

3 Description

e01zaf interpolates an

n

-dimensional point within a set of gridded data points,

Z = {z_{1 j_{1}}, z_{2 j_{2}}, \dots, z_{d j_{d}}}

, with corresponding data values

F = {f_{1 j_{1}}, f_{2 j_{2}}, \dots, f_{d j_{d}}}

where, for the

i

th dimension,

j_{i} = 1, \dots, n_{i}

and

n_{i}

is the number of ordinates in the

i

th dimension.

A hypercube of

{(2 k)}^{d}

data points

[h_{1}, h_{2}, \dots, h_{{(2 k)}^{d}}] \subset Z

, where

h_{i} = (h_{i 1}, h_{i 2}, \dots, h_{i d})

and the corresponding data values are

f (h_{i}) \in F

, around the given point,

x = (x_{1}, x_{2}, \dots, x_{d})

, is found and then used to interpolate using one of the following three methods.

(i)Weighted Average, that is a modification of Shepard's method (Shepard (1968)) as used for scattered data in e01zmf. This method interpolates the data with the weighted mean

$Q (x) = \frac{\sum_{r = 1}^{{(2 k)}^{d}} w_{r} (x) f_{r}}{\sum_{r = 1}^{{(2 k)}^{d}} w_{r} (x)},$

where $f_{r} = f (h_{r})$ , $w_{r} (x) = \frac{1}{D (| x - h_{r} |)}$ and $D (y) = y_{1}^{ρ} + y_{2}^{ρ} + \dots + y_{d}^{ρ}$ , for a given value of $ρ$ .
(ii)Linear Interpolation, which takes $2^{d}$ surrounding data points ( $k = 1$ ) and performs two one-dimensional linear interpolations in each dimension on data points $h_{a}$ and $h_{b}$ , reducing the dimension every iteration until it has reached an answer. The formula for linear interpolation in dimension $i$ is simply

$f = f_{a} + (x_{i} - h_{a i}) \frac{f_{b} - f_{a}}{h_{b i} - h_{a i}},$

where $f_{r} = f (h_{r})$ and $h_{a i} < x_{i} < h_{b i}$ .

(iii)Cubic Interpolation, based on cubic convolution (Keys (1981)). In a similar way to the Linear Interpolation method, it performs the interpolations in one dimension reducing it each time, however it requires four surrounding data points in each dimension (

k = 2

), two in each direction

(h_{−1}, h_{0}, h_{1}, h_{2})

. The following is used to calculate the one-dimensional interpolant in dimension

i

f = \frac{1}{2} (\begin{matrix} 1 & t & t^{2} & t^{3} \end{matrix}) (\begin{matrix} 0 & 2 & 0 & 0 \\ −1 & 0 & 1 & 0 \\ 2 & −5 & 4 & −1 \\ −1 & 3 & −3 & 1 \end{matrix}) (\begin{matrix} f_{−1} \\ f_{0} \\ f_{1} \\ f_{2} \end{matrix})

where

t = x_{i} - h_{0 i}

and

f_{r} = f (h_{r})

4 References

Keys R (1981) Cubic Convolution Interpolation for Digital Image Processing IEEE Transactions on Acoutstics, Speech, and Signal Processing Vol ASSP-29 No. 6 1153–1160 http://hmi.stanford.edu/doc/Tech_Notes/HMI-TN-2004-004-Interpolation/Keys_cubic_interp.pdf

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: $d$ – Integer Input

On entry:

d

, the number of dimensions.

Constraint:

d \geq 2

2: $narr (d)$ – Integer array Input

On entry: the number of data ordinates in each dimension, with

narr (i) = n_{i}

, for

i = 1, 2, \dots, d

Constraint:

narr (i) \geq 2

3: $uniform$ – Logical Input

On entry: states whether the data points are uniformly spaced.

$uniform = .TRUE.$: The data points are uniformly spaced.
$uniform = .FALSE.$: The data points are not uniformly spaced.

Constraint: if

method = 3

, uniform must be .TRUE..

4: $axis (lx)$ – Real (Kind=nag_wp) array Input

On entry: defines the axis. If the data points are uniformly spaced (see argument uniform) axis should contain the start and end of each dimension

(x_{1 1}, x_{1 n_{1}}, \dots, x_{d 1}, x_{d n_{d}})

If the data points are not uniformly spaced, axis should contain all the data ordinates for each dimension

(x_{1 1}, x_{1 2}, \dots, x_{1 n_{1}}, \dots, x_{d 1}, x_{d 2}, \dots, x_{d n_{d}})

Constraint: axis must be strictly increasing in each dimension.

5: $lx$ – Integer Input

On entry: the dimension of the array axis as declared in the (sub)program from which e01zaf is called.

Constraints:

if $uniform = .TRUE.$ , $lx = 2 d$ ;
if $uniform = .FALSE.$ , $lx = \sum_{i = 1}^{d} narr (i)$ .

6: $v (*)$ – Real (Kind=nag_wp) array Input

Note: the dimension of the array v must be at least

\prod_{i = 1}^{d} narr (i)

On entry: holds the values of the data points in such an order that the index of a data value with coordinates

(z_{1}, z_{2}, \dots, z_{d})

\sum_{i = 1}^{d} z_{i} \prod_{n \in S_{i}} n,

where

S_{i} = {narr (l) : l = 1, \dots, i - 1}

e.g.,

((x_{11}, x_{21}, \dots, x_{d 1}), (x_{12}, x_{21}, \dots, x_{d 1}), \dots, (x_{1 n_{d}}, x_{21}, \dots, x_{d 1}), (x_{11}, x_{22}, \dots, x_{d 1}), (x_{12}, x_{22}, \dots, x_{d 1}), \dots, (x_{1 n_{d}}, x_{2 n_{d}}, \dots, x_{d n_{d}}))

7: $point (d)$ – Real (Kind=nag_wp) array Input

On entry:

x

, the point at which the data value is to be interpolated.

Constraint: the point must lie inside the limits of the data values in each dimension supplied in axis.

8: $method$ – Integer Input

On entry: the method to be used.

$method = 1$: Weighted Average.
$method = 2$: Linear Interpolation.
$method = 3$: Cubic Interpolation.

Constraint:

method = 1

2

3

9: $k$ – Integer Input

On entry: if

method = 1

, k controls the number of data points used in the Weighted Average method, with k points used in each dimension, either side of the interpolation point. The total number of data points used for the interpolation will, therefore, be

{(2 k)}^{d}

method \neq 1

, then k is not referenced and need not be set.

Constraint: if

method = 1

k \geq 1

10: $wf$ – Real (Kind=nag_wp) Input

On entry: the power used for the weighted average such that a high power will cause closer points to be more heavily weighted.

Constraint: if

method = 1

1.0 \leq wf \leq 15.0

11: $ans$ – Real (Kind=nag_wp) Output

On exit: holds the result of the interpolation.

12: $ifail$ – Integer Input/Output

On entry: ifail must be set to

0

−1

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

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, $d = ⟨ value ⟩$ .
Constraint: $d \geq 2$ .

$ifail = 2$: On entry, $narr (⟨ value ⟩) = ⟨ value ⟩$ .
Constraint: $narr (i) \geq 2$ .

$ifail = 4$: On entry, axis decreases in dimension $⟨ value ⟩$ .
Constraint: axis definition must be strictly increasing.

$ifail = 5$: On entry, $lx = ⟨ value ⟩$ , $d = ⟨ value ⟩$ .
Constraint: if $uniform = .TRUE.$ , $lx = 2 d$ .

On entry, $lx = ⟨ value ⟩$ , $\sum$ narr $= ⟨ value ⟩$ .
Constraint: if $uniform = .FALSE.$ , $lx = \sum narr$ .

$ifail = 7$: On entry, $k = ⟨ value ⟩$ .
Constraint: if $method = 1$ , $k \geq 1$ .

$ifail = 8$: On entry, $point (⟨ value ⟩) = ⟨ value ⟩$ and data range $= [⟨ value ⟩, ⟨ value ⟩]$ .
Constraint: point must be within the data range.

$ifail = 9$: On entry, $method = ⟨ value ⟩$ .
Constraint: $method = 1$ , $2$ or $3$ .

On entry, $method = 3$ and $uniform = .FALSE.$ .
Constraint: if $method = 3$ , uniform must be .TRUE..

$ifail = 10$: On entry, $wf = ⟨ value ⟩$ .
Constraint: if $method = 1$ , $1.0 \leq wf \leq 15.0$ .

$ifail = 101$: Cubic Interpolation method does not have enough data surrounding point; interpolation not possible.

$ifail = 201$: Warning: the size of k has been reduced, due to too few data points around point.

$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

For most data the Cubic Interpolation method will provide the best interpolation but it is data dependent. If the data is linear, the Linear Interpolation method will be best. For noisy data the Weighted Average method is advised with

wf < 2.0

and

k > 1

. This will include more data points and give them a greater influence to the answer.

8 Parallelism and Performance

Background information to multithreading can be found in the Multithreading documentation.

e01zaf is not threaded in any implementation.

9 Further Comments

None.

10 Example

This program takes a set of uniform three-dimensional grid data points which come from the function

f (x) = x_{1}^{3} - x_{2}^{2} + x_{3} .

e01zaf then interpolates the data at the point

(1.10, 0.25, 0.75)

using all three methods. The answers and the absolute errors are then printed.

e01za: FL CL CPP AD PY MB

NAG FL Interfacee01zaf (dimn_​grid)

▸▿ 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

10 Example

10.1 Program Text

10.2 Program Data

10.3 Program Results

NAG FL Interface
e01zaf (dimn_grid)