Mercurial > hg > octave-lyh
annotate scripts/plot/surfnorm.m @ 14327:4d917a6a858b stable
doc: Use Octave coding conventions in @example blocks of docstrings.
* accumarray.m, accumdim.m, bar.m, base2dec.m, bincoeff.m, bitcmp.m, bitset.m,
celldisp.m, chop.m, clabel.m, cloglog.m, colon.m, compass.m, computer.m,
contour3.m, contourc.m, corr.m, cstrcat.m, ctime.m, cylinder.m, date.m,
dec2base.m, demo.m, dir.m, dlmwrite.m, expm.m, ezcontourf.m, ezcontour.m,
ezmeshc.m, ezmesh.m, ezplot.m, ezsurfc.m, ezsurf.m, feather.m, findobj.m,
flipdim.m, fplot.m, genvarname.m, getfield.m, hankel.m, hilb.m, hist.m,
idivide.m, index.m, int2str.m, interp1.m, is_leap_year.m, ismember.m,
isocolors.m, isonormals.m, isosurface.m, kurtosis.m, legendre.m, linkprop.m,
logit.m, logm.m, __makeinfo__.m, __marching_cube__.m, median.m, mkoctfile.m,
moment.m, mpoles.m, orderfields.m, pcg.m, pcr.m, plot3.m, plotmatrix.m,
polyaffine.m, polygcd.m, poly.m, polyout.m, print.m, qp.m, quadgk.m, qzhess.m,
randi.m, rat.m, refreshdata.m, residue.m, rose.m, rot90.m, saveas.m, saveobj.m,
shiftdim.m, skewness.m, spaugment.m, spdiags.m, sqp.m, stem.m, str2num.m,
strcat.m, strjust.m, strread.m, strsplit.m, structfun.m, subplot.m,
subsindex.m, substruct.m, surfl.m, surfnorm.m, svds.m, uimenu.m, union.m,
voronoi.m, warning_ids.m, wblpdf.m: Use Octave coding conventions in
@example blocks of docstrings.
| author | Rik <octave@nomad.inbox5.com> |
|---|---|
| date | Sat, 04 Feb 2012 22:12:50 -0800 |
| parents | 72c96de7a403 |
| children | ce2b59a6d0e5 |
| rev | line source |
|---|---|
|
14138
72c96de7a403
maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents:
14092
diff
changeset
|
1 ## Copyright (C) 2007-2012 David Bateman |
| 7189 | 2 ## |
| 3 ## This file is part of Octave. | |
| 4 ## | |
| 5 ## Octave is free software; you can redistribute it and/or modify it | |
| 6 ## under the terms of the GNU General Public License as published by | |
| 7 ## the Free Software Foundation; either version 3 of the License, or (at | |
| 8 ## your option) any later version. | |
| 9 ## | |
| 10 ## Octave is distributed in the hope that it will be useful, but | |
| 11 ## WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 13 ## General Public License for more details. | |
| 14 ## | |
| 15 ## You should have received a copy of the GNU General Public License | |
| 16 ## along with Octave; see the file COPYING. If not, see | |
| 17 ## <http://www.gnu.org/licenses/>. | |
| 18 | |
| 19 ## -*- texinfo -*- | |
|
10793
be55736a0783
Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents:
10634
diff
changeset
|
20 ## @deftypefn {Function File} {} surfnorm (@var{x}, @var{y}, @var{z}) |
| 7189 | 21 ## @deftypefnx {Function File} {} surfnorm (@var{z}) |
| 22 ## @deftypefnx {Function File} {[@var{nx}, @var{ny}, @var{nz}] =} surfnorm (@dots{}) | |
| 23 ## @deftypefnx {Function File} {} surfnorm (@var{h}, @dots{}) | |
|
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
24 ## Find the vectors normal to a meshgridded surface. The meshed gridded |
|
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
25 ## surface is defined by @var{x}, @var{y}, and @var{z}. If @var{x} and |
| 7189 | 26 ## @var{y} are not defined, then it is assumed that they are given by |
| 27 ## | |
| 28 ## @example | |
|
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
9040
diff
changeset
|
29 ## @group |
|
14327
4d917a6a858b
doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
30 ## [@var{x}, @var{y}] = meshgrid (1:size (@var{z}, 1), |
|
4d917a6a858b
doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
31 ## 1:size (@var{z}, 2)); |
|
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
9040
diff
changeset
|
32 ## @end group |
| 7189 | 33 ## @end example |
| 34 ## | |
|
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
35 ## If no return arguments are requested, a surface plot with the normal |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
36 ## vectors to the surface is plotted. Otherwise the components of the normal |
| 7189 | 37 ## vectors at the mesh gridded points are returned in @var{nx}, @var{ny}, |
| 38 ## and @var{nz}. | |
| 39 ## | |
|
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
40 ## The normal vectors are calculated by taking the cross product of the |
|
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
41 ## diagonals of each of the quadrilaterals in the meshgrid to find the |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
42 ## normal vectors of the centers of these quadrilaterals. The four nearest |
|
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
43 ## normal vectors to the meshgrid points are then averaged to obtain the |
| 7189 | 44 ## normal to the surface at the meshgridded points. |
| 45 ## | |
| 46 ## An example of the use of @code{surfnorm} is | |
| 47 ## | |
| 48 ## @example | |
| 49 ## surfnorm (peaks (25)); | |
| 50 ## @end example | |
| 51 ## @seealso{surf, quiver3} | |
| 52 ## @end deftypefn | |
| 53 | |
| 7215 | 54 function [Nx, Ny, Nz] = surfnorm (varargin) |
| 7189 | 55 |
|
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
56 [h, varargin, nargin] = __plt_get_axis_arg__ ((nargout != 0), "surfnorm", |
| 10549 | 57 varargin{:}); |
| 7215 | 58 |
| 59 if (nargin != 1 && nargin != 3) | |
| 60 print_usage (); | |
| 7189 | 61 endif |
| 62 | |
| 7215 | 63 if (nargin == 1) |
| 7189 | 64 z = varargin{1}; |
| 65 [x, y] = meshgrid (1:size(z,1), 1:size(z,2)); | |
| 66 ioff = 2; | |
| 67 else | |
| 68 x = varargin{1}; | |
| 69 y = varargin{2}; | |
| 70 z = varargin{3}; | |
| 71 ioff = 4; | |
| 72 endif | |
| 73 | |
|
10634
60542efcfa2c
Check input arguments for size and type (bug #29861).
Rik <octave@nomad.inbox5.com>
parents:
10549
diff
changeset
|
74 if (!ismatrix (z) || isvector (z) || isscalar (z)) |
|
11472
1740012184f9
Use uppercase for variable names in error() strings to match Info documentation. Only m-files done.
Rik <octave@nomad.inbox5.com>
parents:
10793
diff
changeset
|
75 error ("surfnorm: Z argument must be a matrix"); |
| 7189 | 76 endif |
|
10634
60542efcfa2c
Check input arguments for size and type (bug #29861).
Rik <octave@nomad.inbox5.com>
parents:
10549
diff
changeset
|
77 if (! size_equal (x, y, z)) |
|
11472
1740012184f9
Use uppercase for variable names in error() strings to match Info documentation. Only m-files done.
Rik <octave@nomad.inbox5.com>
parents:
10793
diff
changeset
|
78 error ("surfnorm: X, Y, and Z must have the same dimensions"); |
|
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
79 endif |
| 7189 | 80 |
| 81 ## Make life easier, and avoid having to do the extrapolation later, do | |
| 82 ## a simpler linear extrapolation here. This is approximative, and works | |
| 83 ## badly for closed surfaces like spheres. | |
| 84 xx = [2 .* x(:,1) - x(:,2), x, 2 .* x(:,end) - x(:,end-1)]; | |
| 85 xx = [2 .* xx(1,:) - xx(2,:); xx; 2 .* xx(end,:) - xx(end-1,:)]; | |
| 86 yy = [2 .* y(:,1) - y(:,2), y, 2 .* y(:,end) - y(:,end-1)]; | |
| 87 yy = [2 .* yy(1,:) - yy(2,:); yy; 2 .* yy(end,:) - yy(end-1,:)]; | |
| 88 zz = [2 .* z(:,1) - z(:,2), z, 2 .* z(:,end) - z(:,end-1)]; | |
| 89 zz = [2 .* zz(1,:) - zz(2,:); zz; 2 .* zz(end,:) - zz(end-1,:)]; | |
| 90 | |
| 91 u.x = xx(1:end-1,1:end-1) - xx(2:end,2:end); | |
| 92 u.y = yy(1:end-1,1:end-1) - yy(2:end,2:end); | |
| 93 u.z = zz(1:end-1,1:end-1) - zz(2:end,2:end); | |
| 94 v.x = xx(1:end-1,2:end) - xx(2:end,1:end-1); | |
| 95 v.y = yy(1:end-1,2:end) - yy(2:end,1:end-1); | |
| 96 v.z = zz(1:end-1,2:end) - zz(2:end,1:end-1); | |
| 97 | |
| 98 c = cross ([u.x(:), u.y(:), u.z(:)], [v.x(:), v.y(:), v.z(:)]); | |
| 99 w.x = reshape (c(:,1), size(u.x)); | |
| 100 w.y = reshape (c(:,2), size(u.y)); | |
| 101 w.z = reshape (c(:,3), size(u.z)); | |
| 102 | |
| 103 ## Create normal vectors as mesh vectices from normals at mesh centers | |
| 104 nx = (w.x(1:end-1,1:end-1) + w.x(1:end-1,2:end) + | |
|
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
105 w.x(2:end,1:end-1) + w.x(2:end,2:end)) ./ 4; |
| 7189 | 106 ny = (w.y(1:end-1,1:end-1) + w.y(1:end-1,2:end) + |
|
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
107 w.y(2:end,1:end-1) + w.y(2:end,2:end)) ./ 4; |
| 7189 | 108 nz = (w.z(1:end-1,1:end-1) + w.z(1:end-1,2:end) + |
|
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
109 w.z(2:end,1:end-1) + w.z(2:end,2:end)) ./ 4; |
| 7189 | 110 |
| 111 ## Normalize the normal vectors | |
| 112 len = sqrt (nx.^2 + ny.^2 + nz.^2); | |
| 113 nx = nx ./ len; | |
| 114 ny = ny ./ len; | |
| 115 nz = nz ./ len; | |
| 116 | |
| 117 if (nargout == 0) | |
| 7215 | 118 oldh = gca (); |
| 119 unwind_protect | |
| 120 axes (h); | |
| 121 newplot (); | |
| 122 surf (x, y, z, varargin{ioff:end}); | |
|
8241
1e1e88bcc733
surfnorm.m: save and restore hold state
John W. Eaton <jwe@octave.org>
parents:
7216
diff
changeset
|
123 old_hold_state = get (h, "nextplot"); |
|
1e1e88bcc733
surfnorm.m: save and restore hold state
John W. Eaton <jwe@octave.org>
parents:
7216
diff
changeset
|
124 unwind_protect |
| 10549 | 125 set (h, "nextplot", "add"); |
| 126 plot3 ([x(:)'; x(:).' + nx(:).' ; NaN(size(x(:).'))](:), | |
| 127 [y(:)'; y(:).' + ny(:).' ; NaN(size(y(:).'))](:), | |
|
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
128 [z(:)'; z(:).' + nz(:).' ; NaN(size(z(:).'))](:), |
| 10549 | 129 varargin{ioff:end}); |
|
8241
1e1e88bcc733
surfnorm.m: save and restore hold state
John W. Eaton <jwe@octave.org>
parents:
7216
diff
changeset
|
130 unwind_protect_cleanup |
| 10549 | 131 set (h, "nextplot", old_hold_state); |
|
8241
1e1e88bcc733
surfnorm.m: save and restore hold state
John W. Eaton <jwe@octave.org>
parents:
7216
diff
changeset
|
132 end_unwind_protect |
| 7215 | 133 unwind_protect_cleanup |
| 134 axes (oldh); | |
| 135 end_unwind_protect | |
| 7189 | 136 else |
| 137 Nx = nx; | |
| 138 Ny = ny; | |
| 139 Nz = nz; | |
| 140 endif | |
| 7216 | 141 |
| 7189 | 142 endfunction |
| 143 | |
| 144 %!demo | |
|
14092
22c50cbad2ce
Add clf() to all plot demos.
Ben Abbott <bpabbott@mac.com>
parents:
11587
diff
changeset
|
145 %! clf |
|
8790
a013ff655ca4
Trivial changes to demos to produce a more pleasant output for octave+gnuplot+aquaterm.
Ben Abbott <bpabbott@mac.com>
parents:
8241
diff
changeset
|
146 %! colormap (jet (64)) |
| 7189 | 147 %! [x, y, z] = peaks(10); |
| 148 %! surfnorm (x, y, z); | |
| 149 | |
| 150 %!demo | |
|
14092
22c50cbad2ce
Add clf() to all plot demos.
Ben Abbott <bpabbott@mac.com>
parents:
11587
diff
changeset
|
151 %! clf |
| 7189 | 152 %! surfnorm (peaks(10)); |
|
8790
a013ff655ca4
Trivial changes to demos to produce a more pleasant output for octave+gnuplot+aquaterm.
Ben Abbott <bpabbott@mac.com>
parents:
8241
diff
changeset
|
153 |
|
a013ff655ca4
Trivial changes to demos to produce a more pleasant output for octave+gnuplot+aquaterm.
Ben Abbott <bpabbott@mac.com>
parents:
8241
diff
changeset
|
154 %!demo |
|
14092
22c50cbad2ce
Add clf() to all plot demos.
Ben Abbott <bpabbott@mac.com>
parents:
11587
diff
changeset
|
155 %! clf |
|
8790
a013ff655ca4
Trivial changes to demos to produce a more pleasant output for octave+gnuplot+aquaterm.
Ben Abbott <bpabbott@mac.com>
parents:
8241
diff
changeset
|
156 %! surfnorm (peaks(32)); |
|
a013ff655ca4
Trivial changes to demos to produce a more pleasant output for octave+gnuplot+aquaterm.
Ben Abbott <bpabbott@mac.com>
parents:
8241
diff
changeset
|
157 %! shading interp |