annotate doc/interpreter/interp.txi @ 8920:eb63fbe60fab

update copyright notices
author John W. Eaton <jwe@octave.org>
date Sat, 07 Mar 2009 10:41:27 -0500
parents 8463d1a2e544
children e9dc2ed2ec0f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8920
eb63fbe60fab update copyright notices
John W. Eaton <jwe@octave.org>
parents: 8828
diff changeset
1 @c Copyright (C) 2007, 2008, 2009 John W. Eaton
7018
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6939
diff changeset
2 @c
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6939
diff changeset
3 @c This file is part of Octave.
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6939
diff changeset
4 @c
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6939
diff changeset
5 @c Octave is free software; you can redistribute it and/or modify it
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6939
diff changeset
6 @c under the terms of the GNU General Public License as published by the
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6939
diff changeset
7 @c Free Software Foundation; either version 3 of the License, or (at
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6939
diff changeset
8 @c your option) any later version.
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6939
diff changeset
9 @c
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6939
diff changeset
10 @c Octave is distributed in the hope that it will be useful, but WITHOUT
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6939
diff changeset
11 @c ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6939
diff changeset
12 @c FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6939
diff changeset
13 @c for more details.
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6939
diff changeset
14 @c
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6939
diff changeset
15 @c You should have received a copy of the GNU General Public License
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6939
diff changeset
16 @c along with Octave; see the file COPYING. If not, see
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6939
diff changeset
17 @c <http://www.gnu.org/licenses/>.
6549
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents:
diff changeset
18
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents:
diff changeset
19 @node Interpolation
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents:
diff changeset
20 @chapter Interpolation
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents:
diff changeset
21
6702
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
22 @menu
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
23 * One-dimensional Interpolation::
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
24 * Multi-dimensional Interpolation::
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
25 @end menu
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
26
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
27 @node One-dimensional Interpolation
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
28 @section One-dimensional Interpolation
6549
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents:
diff changeset
29
6850
9398f6a81bdf [project @ 2007-08-31 17:29:22 by jwe]
jwe
parents: 6750
diff changeset
30 Octave supports several methods for one-dimensional interpolation, most
9398f6a81bdf [project @ 2007-08-31 17:29:22 by jwe]
jwe
parents: 6750
diff changeset
31 of which are described in this section. @ref{Polynomial Interpolation}
8347
fa78cb8d8a5c corrections for typos
Brian Gough<bjg@network-theory.co.uk>
parents: 8325
diff changeset
32 and @ref{Interpolation on Scattered Data} describe further methods.
6850
9398f6a81bdf [project @ 2007-08-31 17:29:22 by jwe]
jwe
parents: 6750
diff changeset
33
6549
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents:
diff changeset
34 @DOCSTRING(interp1)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents:
diff changeset
35
6721
01036667884a [project @ 2007-06-14 06:56:41 by dbateman]
dbateman
parents: 6702
diff changeset
36 There are some important differences between the various interpolation
01036667884a [project @ 2007-06-14 06:56:41 by dbateman]
dbateman
parents: 6702
diff changeset
37 methods. The 'spline' method enforces that both the first and second
01036667884a [project @ 2007-06-14 06:56:41 by dbateman]
dbateman
parents: 6702
diff changeset
38 derivatives of the interpolated values have a continuous derivative,
6743
f11fec9c06b0 [project @ 2007-06-18 19:12:48 by dbateman]
dbateman
parents: 6723
diff changeset
39 whereas the other methods do not. This means that the results of the
f11fec9c06b0 [project @ 2007-06-18 19:12:48 by dbateman]
dbateman
parents: 6723
diff changeset
40 'spline' method are generally smoother. If the function to be
f11fec9c06b0 [project @ 2007-06-18 19:12:48 by dbateman]
dbateman
parents: 6723
diff changeset
41 interpolated is in fact smooth, then 'spline' will give excellent
f11fec9c06b0 [project @ 2007-06-18 19:12:48 by dbateman]
dbateman
parents: 6723
diff changeset
42 results. However, if the function to be evaluated is in some manner
f11fec9c06b0 [project @ 2007-06-18 19:12:48 by dbateman]
dbateman
parents: 6723
diff changeset
43 discontinuous, then 'pchip' interpolation might give better results.
f11fec9c06b0 [project @ 2007-06-18 19:12:48 by dbateman]
dbateman
parents: 6723
diff changeset
44
f11fec9c06b0 [project @ 2007-06-18 19:12:48 by dbateman]
dbateman
parents: 6723
diff changeset
45 This can be demonstrated by the code
6721
01036667884a [project @ 2007-06-14 06:56:41 by dbateman]
dbateman
parents: 6702
diff changeset
46
01036667884a [project @ 2007-06-14 06:56:41 by dbateman]
dbateman
parents: 6702
diff changeset
47 @example
01036667884a [project @ 2007-06-14 06:56:41 by dbateman]
dbateman
parents: 6702
diff changeset
48 @group
6743
f11fec9c06b0 [project @ 2007-06-18 19:12:48 by dbateman]
dbateman
parents: 6723
diff changeset
49 t = -2:2;
f11fec9c06b0 [project @ 2007-06-18 19:12:48 by dbateman]
dbateman
parents: 6723
diff changeset
50 dt = 1;
f11fec9c06b0 [project @ 2007-06-18 19:12:48 by dbateman]
dbateman
parents: 6723
diff changeset
51 ti =-2:0.025:2;
f11fec9c06b0 [project @ 2007-06-18 19:12:48 by dbateman]
dbateman
parents: 6723
diff changeset
52 dti = 0.025;
f11fec9c06b0 [project @ 2007-06-18 19:12:48 by dbateman]
dbateman
parents: 6723
diff changeset
53 y = sign(t);
f11fec9c06b0 [project @ 2007-06-18 19:12:48 by dbateman]
dbateman
parents: 6723
diff changeset
54 ys = interp1(t,y,ti,'spline');
f11fec9c06b0 [project @ 2007-06-18 19:12:48 by dbateman]
dbateman
parents: 6723
diff changeset
55 yp = interp1(t,y,ti,'pchip');
f11fec9c06b0 [project @ 2007-06-18 19:12:48 by dbateman]
dbateman
parents: 6723
diff changeset
56 ddys = diff(diff(ys)./dti)./dti;
f11fec9c06b0 [project @ 2007-06-18 19:12:48 by dbateman]
dbateman
parents: 6723
diff changeset
57 ddyp = diff(diff(yp)./dti)./dti;
f11fec9c06b0 [project @ 2007-06-18 19:12:48 by dbateman]
dbateman
parents: 6723
diff changeset
58 figure(1);
f11fec9c06b0 [project @ 2007-06-18 19:12:48 by dbateman]
dbateman
parents: 6723
diff changeset
59 plot (ti, ys,'r-', ti, yp,'g-');
f11fec9c06b0 [project @ 2007-06-18 19:12:48 by dbateman]
dbateman
parents: 6723
diff changeset
60 legend('spline','pchip',4);
f11fec9c06b0 [project @ 2007-06-18 19:12:48 by dbateman]
dbateman
parents: 6723
diff changeset
61 figure(2);
f11fec9c06b0 [project @ 2007-06-18 19:12:48 by dbateman]
dbateman
parents: 6723
diff changeset
62 plot (ti, ddys,'r+', ti, ddyp,'g*');
f11fec9c06b0 [project @ 2007-06-18 19:12:48 by dbateman]
dbateman
parents: 6723
diff changeset
63 legend('spline','pchip');
6721
01036667884a [project @ 2007-06-14 06:56:41 by dbateman]
dbateman
parents: 6702
diff changeset
64 @end group
01036667884a [project @ 2007-06-14 06:56:41 by dbateman]
dbateman
parents: 6702
diff changeset
65 @end example
01036667884a [project @ 2007-06-14 06:56:41 by dbateman]
dbateman
parents: 6702
diff changeset
66
01036667884a [project @ 2007-06-14 06:56:41 by dbateman]
dbateman
parents: 6702
diff changeset
67 @ifnotinfo
01036667884a [project @ 2007-06-14 06:56:41 by dbateman]
dbateman
parents: 6702
diff changeset
68 @noindent
6743
f11fec9c06b0 [project @ 2007-06-18 19:12:48 by dbateman]
dbateman
parents: 6723
diff changeset
69 The result of which can be seen in @ref{fig:interpderiv1} and
f11fec9c06b0 [project @ 2007-06-18 19:12:48 by dbateman]
dbateman
parents: 6723
diff changeset
70 @ref{fig:interpderiv2}.
6721
01036667884a [project @ 2007-06-14 06:56:41 by dbateman]
dbateman
parents: 6702
diff changeset
71
6743
f11fec9c06b0 [project @ 2007-06-18 19:12:48 by dbateman]
dbateman
parents: 6723
diff changeset
72 @float Figure,fig:interpderiv1
f11fec9c06b0 [project @ 2007-06-18 19:12:48 by dbateman]
dbateman
parents: 6723
diff changeset
73 @image{interpderiv1,8cm}
f11fec9c06b0 [project @ 2007-06-18 19:12:48 by dbateman]
dbateman
parents: 6723
diff changeset
74 @caption{Comparison of 'phcip' and 'spline' interpolation methods for a
f11fec9c06b0 [project @ 2007-06-18 19:12:48 by dbateman]
dbateman
parents: 6723
diff changeset
75 step function}
f11fec9c06b0 [project @ 2007-06-18 19:12:48 by dbateman]
dbateman
parents: 6723
diff changeset
76 @end float
f11fec9c06b0 [project @ 2007-06-18 19:12:48 by dbateman]
dbateman
parents: 6723
diff changeset
77
f11fec9c06b0 [project @ 2007-06-18 19:12:48 by dbateman]
dbateman
parents: 6723
diff changeset
78 @float Figure,fig:interpderiv2
f11fec9c06b0 [project @ 2007-06-18 19:12:48 by dbateman]
dbateman
parents: 6723
diff changeset
79 @image{interpderiv2,8cm}
8325
b93ac0586e4b spelling corrections
Brian Gough<bjg@network-theory.co.uk>
parents: 7984
diff changeset
80 @caption{Comparison of the second derivative of the 'phcip' and 'spline'
6743
f11fec9c06b0 [project @ 2007-06-18 19:12:48 by dbateman]
dbateman
parents: 6723
diff changeset
81 interpolation methods for a step function}
6721
01036667884a [project @ 2007-06-14 06:56:41 by dbateman]
dbateman
parents: 6702
diff changeset
82 @end float
01036667884a [project @ 2007-06-14 06:56:41 by dbateman]
dbateman
parents: 6702
diff changeset
83 @end ifnotinfo
01036667884a [project @ 2007-06-14 06:56:41 by dbateman]
dbateman
parents: 6702
diff changeset
84
7984
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7018
diff changeset
85 A simplified version of @code{interp1} that performs only linear
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7018
diff changeset
86 interpolation is available in @code{interp1q}. This argument is slightly
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7018
diff changeset
87 faster than @code{interp1} as to performs little error checking.
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7018
diff changeset
88
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7018
diff changeset
89 @DOCSTRING(interp1q)
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7018
diff changeset
90
6702
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
91 Fourier interpolation, is a resampling technique where a signal is
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
92 converted to the frequency domain, padded with zeros and then
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
93 reconverted to the time domain.
6549
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents:
diff changeset
94
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents:
diff changeset
95 @DOCSTRING(interpft)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents:
diff changeset
96
6702
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
97 There are two significant limitations on Fourier interpolation. Firstly,
8495
e7b4de25ecb6 [docs] non periodic => non-periodic
Brian Gough <bjg@gnu.org>
parents: 8347
diff changeset
98 the function signal is assumed to be periodic, and so non-periodic
6702
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
99 signals will be poorly represented at the edges. Secondly, both the
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
100 signal and its interpolation are required to be sampled at equispaced
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
101 points. An example of the use of @code{interpft} is
6549
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents:
diff changeset
102
6702
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
103 @example
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
104 @group
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
105 t = 0 : 0.3 : pi; dt = t(2)-t(1);
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
106 n = length (t); k = 100;
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
107 ti = t(1) + [0 : k-1]*dt*n/k;
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
108 y = sin (4*t + 0.3) .* cos (3*t - 0.1);
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
109 yp = sin (4*ti + 0.3) .* cos (3*ti - 0.1);
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
110 plot (ti, yp, 'g', ti, interp1(t, y, ti, 'spline'), 'b', ...
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
111 ti, interpft (y, k), 'c', t, y, 'r+');
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
112 legend ('sin(4t+0.3)cos(3t-0.1','spline','interpft','data');
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
113 @end group
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
114 @end example
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
115
8828
8463d1a2e544 Doc fixes.
Brian Gough <bjg@network-theory.co.uk>
parents: 8495
diff changeset
116 @noindent
6721
01036667884a [project @ 2007-06-14 06:56:41 by dbateman]
dbateman
parents: 6702
diff changeset
117 @ifinfo
8495
e7b4de25ecb6 [docs] non periodic => non-periodic
Brian Gough <bjg@gnu.org>
parents: 8347
diff changeset
118 which demonstrates the poor behavior of Fourier interpolation for non-periodic functions.
6721
01036667884a [project @ 2007-06-14 06:56:41 by dbateman]
dbateman
parents: 6702
diff changeset
119 @end ifinfo
01036667884a [project @ 2007-06-14 06:56:41 by dbateman]
dbateman
parents: 6702
diff changeset
120 @ifnotinfo
8495
e7b4de25ecb6 [docs] non periodic => non-periodic
Brian Gough <bjg@gnu.org>
parents: 8347
diff changeset
121 which demonstrates the poor behavior of Fourier interpolation for non-periodic functions, as can be seen in @ref{fig:interpft}.
6721
01036667884a [project @ 2007-06-14 06:56:41 by dbateman]
dbateman
parents: 6702
diff changeset
122
01036667884a [project @ 2007-06-14 06:56:41 by dbateman]
dbateman
parents: 6702
diff changeset
123 @float Figure,fig:interpft
01036667884a [project @ 2007-06-14 06:56:41 by dbateman]
dbateman
parents: 6702
diff changeset
124 @image{interpft,8cm}
8495
e7b4de25ecb6 [docs] non periodic => non-periodic
Brian Gough <bjg@gnu.org>
parents: 8347
diff changeset
125 @caption{Comparison of @code{interp1} and @code{interpft} for non-periodic data}
6721
01036667884a [project @ 2007-06-14 06:56:41 by dbateman]
dbateman
parents: 6702
diff changeset
126 @end float
01036667884a [project @ 2007-06-14 06:56:41 by dbateman]
dbateman
parents: 6702
diff changeset
127 @end ifnotinfo
6702
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
128
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
129 In additional the support function @code{spline} and @code{lookup} that
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
130 underlie the @code{interp1} function can be called directly.
6549
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents:
diff changeset
131
6558
e0e1c6df5ab2 [project @ 2007-04-20 19:33:24 by jwe]
jwe
parents: 6549
diff changeset
132 @DOCSTRING(spline)
e0e1c6df5ab2 [project @ 2007-04-20 19:33:24 by jwe]
jwe
parents: 6549
diff changeset
133
8347
fa78cb8d8a5c corrections for typos
Brian Gough<bjg@network-theory.co.uk>
parents: 8325
diff changeset
134 The @code{lookup} function is used by other interpolation functions to identify
6702
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
135 the points of the original data that are closest to the current point
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
136 of interest.
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
137
6549
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents:
diff changeset
138 @DOCSTRING(lookup)
6702
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
139
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
140 @node Multi-dimensional Interpolation
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
141 @section Multi-dimensional Interpolation
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
142
6939
46d1ad37d943 [project @ 2007-10-01 16:12:20 by jwe]
jwe
parents: 6850
diff changeset
143 There are three multi-dimensional interpolation functions in Octave, with
6850
9398f6a81bdf [project @ 2007-08-31 17:29:22 by jwe]
jwe
parents: 6750
diff changeset
144 similar capabilities. Methods using Delaunay tessellation are described
9398f6a81bdf [project @ 2007-08-31 17:29:22 by jwe]
jwe
parents: 6750
diff changeset
145 in @ref{Interpolation on Scattered Data}.
6702
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
146
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
147 @DOCSTRING(interp2)
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
148
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
149 @DOCSTRING(interp3)
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
150
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
151 @DOCSTRING(interpn)
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
152
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
153 A significant difference between @code{interpn} and the other two
6939
46d1ad37d943 [project @ 2007-10-01 16:12:20 by jwe]
jwe
parents: 6850
diff changeset
154 multidimensional interpolation functions is the fashion in which the
6702
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
155 dimensions are treated. For @code{interp2} and @code{interp3}, the 'y'
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
156 axis is considered to be the columns of the matrix, whereas the 'x'
6939
46d1ad37d943 [project @ 2007-10-01 16:12:20 by jwe]
jwe
parents: 6850
diff changeset
157 axis corresponds to the rows of the array. As Octave indexes arrays in
6702
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
158 column major order, the first dimension of any array is the columns, and
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
159 so @code{interpn} effectively reverses the 'x' and 'y' dimensions.
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
160 Consider the example
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
161
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
162 @example
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
163 @group
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
164 x = y = z = -1:1;
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
165 f = @@(x,y,z) x.^2 - y - z.^2;
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
166 [xx, yy, zz] = meshgrid (x, y, z);
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
167 v = f (xx,yy,zz);
6721
01036667884a [project @ 2007-06-14 06:56:41 by dbateman]
dbateman
parents: 6702
diff changeset
168 xi = yi = zi = -1:0.1:1;
6702
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
169 [xxi, yyi, zzi] = meshgrid (xi, yi, zi);
6721
01036667884a [project @ 2007-06-14 06:56:41 by dbateman]
dbateman
parents: 6702
diff changeset
170 vi = interp3(x, y, z, v, xxi, yyi, zzi, 'spline');
6702
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
171 [xxi, yyi, zzi] = ndgrid (xi, yi, zi);
6721
01036667884a [project @ 2007-06-14 06:56:41 by dbateman]
dbateman
parents: 6702
diff changeset
172 vi2 = interpn(x, y, z, v, xxi, yyi, zzi, 'spline');
6723
8bfb4ff637e1 [project @ 2007-06-14 10:16:35 by dbateman]
dbateman
parents: 6721
diff changeset
173 mesh (zi, yi, squeeze (vi2(1,:,:)));
6702
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
174 @end group
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
175 @end example
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
176
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
177 @noindent
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
178 where @code{vi} and @code{vi2} are identical. The reversal of the
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
179 dimensions is treated in the @code{meshgrid} and @code{ndgrid} functions
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
180 respectively.
6721
01036667884a [project @ 2007-06-14 06:56:41 by dbateman]
dbateman
parents: 6702
diff changeset
181 @ifnotinfo
01036667884a [project @ 2007-06-14 06:56:41 by dbateman]
dbateman
parents: 6702
diff changeset
182 The result of this code can be seen in @ref{fig:interpn}.
01036667884a [project @ 2007-06-14 06:56:41 by dbateman]
dbateman
parents: 6702
diff changeset
183
01036667884a [project @ 2007-06-14 06:56:41 by dbateman]
dbateman
parents: 6702
diff changeset
184 @float Figure,fig:interpn
01036667884a [project @ 2007-06-14 06:56:41 by dbateman]
dbateman
parents: 6702
diff changeset
185 @image{interpn,8cm}
01036667884a [project @ 2007-06-14 06:56:41 by dbateman]
dbateman
parents: 6702
diff changeset
186 @caption{Demonstration of the use of @code{interpn}}
01036667884a [project @ 2007-06-14 06:56:41 by dbateman]
dbateman
parents: 6702
diff changeset
187 @end float
01036667884a [project @ 2007-06-14 06:56:41 by dbateman]
dbateman
parents: 6702
diff changeset
188 @end ifnotinfo
6702
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
189
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
190 In additional the support function @code{bicubic} that underlies the
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
191 cubic interpolation of @code{interp2} function can be called directly.
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
192
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6558
diff changeset
193 @DOCSTRING(bicubic)