comparison scripts/plot/draw/slice.m @ 17572:7bb76a22cde1

maint: Split scripts/plot directory into 4 pieces. scripts/gui : user-interface functions scripts/plot/appearance : functions controlling plot appearance scripts/plot/draw : plotting functions which produce graphs scripts/plot/util : low-level plotting functions and utilities. * scripts/gui/guidata.m, scripts/gui/guihandles.m, scripts/gui/module.mk, scripts/gui/private/__file_filter__.m, scripts/gui/private/__fltk_file_filter__.m, scripts/gui/private/__is_function__.m, scripts/gui/private/__uigetdir_fltk__.m, scripts/gui/private/__uigetfile_fltk__.m, scripts/gui/private/__uiobject_split_args__.m, scripts/gui/private/__uiputfile_fltk__.m, scripts/gui/uicontextmenu.m, scripts/gui/uicontrol.m, scripts/gui/uigetdir.m, scripts/gui/uigetfile.m, scripts/gui/uimenu.m, scripts/gui/uipanel.m, scripts/gui/uipushtool.m, scripts/gui/uiputfile.m, scripts/gui/uiresume.m, scripts/gui/uitoggletool.m, scripts/gui/uitoolbar.m, scripts/gui/uiwait.m, scripts/gui/waitbar.m, scripts/gui/waitforbuttonpress.m: Moved from scripts/plot to scripts/gui * scripts/plot/appearance/__clabel__.m, scripts/plot/appearance/__getlegenddata__.m, scripts/plot/appearance/axis.m, scripts/plot/appearance/box.m, scripts/plot/appearance/caxis.m, scripts/plot/appearance/clabel.m, scripts/plot/appearance/daspect.m, scripts/plot/appearance/diffuse.m, scripts/plot/appearance/grid.m, scripts/plot/appearance/gtext.m, scripts/plot/appearance/hidden.m, scripts/plot/appearance/legend.m, scripts/plot/appearance/orient.m, scripts/plot/appearance/pbaspect.m, scripts/plot/appearance/private/__axis_label__.m, scripts/plot/appearance/private/__axis_limits__.m, scripts/plot/appearance/shading.m, scripts/plot/appearance/specular.m, scripts/plot/appearance/text.m, scripts/plot/appearance/title.m, scripts/plot/appearance/view.m, scripts/plot/appearance/whitebg.m, scripts/plot/appearance/xlabel.m, scripts/plot/appearance/xlim.m, scripts/plot/appearance/ylabel.m, scripts/plot/appearance/ylim.m, scripts/plot/appearance/zlabel.m, scripts/plot/appearance/zlim.m: Moved from scripts/plot to subdir appearance. * scripts/plot/draw/area.m, scripts/plot/draw/bar.m, scripts/plot/draw/barh.m, scripts/plot/draw/colorbar.m, scripts/plot/draw/comet.m, scripts/plot/draw/comet3.m, scripts/plot/draw/compass.m, scripts/plot/draw/contour.m, scripts/plot/draw/contour3.m, scripts/plot/draw/contourc.m, scripts/plot/draw/contourf.m, scripts/plot/draw/cylinder.m, scripts/plot/draw/ellipsoid.m, scripts/plot/draw/errorbar.m, scripts/plot/draw/ezcontour.m, scripts/plot/draw/ezcontourf.m, scripts/plot/draw/ezmesh.m, scripts/plot/draw/ezmeshc.m, scripts/plot/draw/ezplot.m, scripts/plot/draw/ezplot3.m, scripts/plot/draw/ezpolar.m, scripts/plot/draw/ezsurf.m, scripts/plot/draw/ezsurfc.m, scripts/plot/draw/feather.m, scripts/plot/draw/fill.m, scripts/plot/draw/fplot.m, scripts/plot/draw/hist.m, scripts/plot/draw/isocolors.m, scripts/plot/draw/isonormals.m, scripts/plot/draw/isosurface.m, scripts/plot/draw/line.m, scripts/plot/draw/loglog.m, scripts/plot/draw/loglogerr.m, scripts/plot/draw/mesh.m, scripts/plot/draw/meshc.m, scripts/plot/draw/meshz.m, scripts/plot/draw/pareto.m, scripts/plot/draw/patch.m, scripts/plot/draw/pcolor.m, scripts/plot/draw/peaks.m, scripts/plot/draw/pie.m, scripts/plot/draw/pie3.m, scripts/plot/draw/plot.m, scripts/plot/draw/plot3.m, scripts/plot/draw/plotmatrix.m, scripts/plot/draw/plotyy.m, scripts/plot/draw/polar.m, scripts/plot/draw/private/__add_datasource__.m, scripts/plot/draw/private/__bar__.m, scripts/plot/draw/private/__contour__.m, scripts/plot/draw/private/__errcomm__.m, scripts/plot/draw/private/__errplot__.m, scripts/plot/draw/private/__ezplot__.m, scripts/plot/draw/private/__interp_cube__.m, scripts/plot/draw/private/__line__.m, scripts/plot/draw/private/__marching_cube__.m, scripts/plot/draw/private/__patch__.m, scripts/plot/draw/private/__pie__.m, scripts/plot/draw/private/__plt__.m, scripts/plot/draw/private/__quiver__.m, scripts/plot/draw/private/__scatter__.m, scripts/plot/draw/private/__stem__.m, scripts/plot/draw/quiver.m, scripts/plot/draw/quiver3.m, scripts/plot/draw/rectangle.m, scripts/plot/draw/ribbon.m, scripts/plot/draw/rose.m, scripts/plot/draw/scatter.m, scripts/plot/draw/scatter3.m, scripts/plot/draw/semilogx.m, scripts/plot/draw/semilogxerr.m, scripts/plot/draw/semilogy.m, scripts/plot/draw/semilogyerr.m, scripts/plot/draw/shrinkfaces.m, scripts/plot/draw/slice.m, scripts/plot/draw/sombrero.m, scripts/plot/draw/sphere.m, scripts/plot/draw/stairs.m, scripts/plot/draw/stem.m, scripts/plot/draw/stem3.m, scripts/plot/draw/stemleaf.m, scripts/plot/draw/surf.m, scripts/plot/draw/surface.m, scripts/plot/draw/surfc.m, scripts/plot/draw/surfl.m, scripts/plot/draw/surfnorm.m, scripts/plot/draw/tetramesh.m, scripts/plot/draw/trimesh.m, scripts/plot/draw/triplot.m, scripts/plot/draw/trisurf.m, scripts/plot/draw/waterfall.m: Moved from plot/ to subdir draw. * scripts/plot/util/__actual_axis_position__.m, scripts/plot/util/__default_plot_options__.m, scripts/plot/util/__gnuplot_drawnow__.m, scripts/plot/util/__next_line_color__.m, scripts/plot/util/__next_line_style__.m, scripts/plot/util/__plt_get_axis_arg__.m, scripts/plot/util/__pltopt__.m, scripts/plot/util/allchild.m, scripts/plot/util/ancestor.m, scripts/plot/util/axes.m, scripts/plot/util/cla.m, scripts/plot/util/clf.m, scripts/plot/util/close.m, scripts/plot/util/closereq.m, scripts/plot/util/colstyle.m, scripts/plot/util/copyobj.m, scripts/plot/util/figure.m, scripts/plot/util/findall.m, scripts/plot/util/findfigs.m, scripts/plot/util/findobj.m, scripts/plot/util/gca.m, scripts/plot/util/gcbf.m, scripts/plot/util/gcbo.m, scripts/plot/util/gcf.m, scripts/plot/util/gco.m, scripts/plot/util/ginput.m, scripts/plot/util/gnuplot_binary.in, scripts/plot/util/graphics_toolkit.m, scripts/plot/util/hdl2struct.m, scripts/plot/util/hggroup.m, scripts/plot/util/hold.m, scripts/plot/util/isaxes.m, scripts/plot/util/isfigure.m, scripts/plot/util/ishghandle.m, scripts/plot/util/ishold.m, scripts/plot/util/isprop.m, scripts/plot/util/linkprop.m, scripts/plot/util/meshgrid.m, scripts/plot/util/ndgrid.m, scripts/plot/util/newplot.m, scripts/plot/util/print.m, scripts/plot/util/printd.m, scripts/plot/util/private/__add_default_menu__.m, scripts/plot/util/private/__fltk_ginput__.m, scripts/plot/util/private/__fltk_print__.m, scripts/plot/util/private/__ghostscript__.m, scripts/plot/util/private/__gnuplot_get_var__.m, scripts/plot/util/private/__gnuplot_ginput__.m, scripts/plot/util/private/__gnuplot_has_feature__.m, scripts/plot/util/private/__gnuplot_has_terminal__.m, scripts/plot/util/private/__gnuplot_open_stream__.m, scripts/plot/util/private/__gnuplot_print__.m, scripts/plot/util/private/__gnuplot_version__.m, scripts/plot/util/private/__go_draw_axes__.m, scripts/plot/util/private/__go_draw_figure__.m, scripts/plot/util/private/__print_parse_opts__.m, scripts/plot/util/private/__tight_eps_bbox__.m, scripts/plot/util/refresh.m, scripts/plot/util/refreshdata.m, scripts/plot/util/saveas.m, scripts/plot/util/shg.m, scripts/plot/util/struct2hdl.m, scripts/plot/util/subplot.m: Moved from plot to subdir util. * etc/HACKING: Updated directory structure info. * scripts/Makefile.am, scripts/plot/appearance/module.mk, scripts/plot/draw/module.mk, scripts/plot/util/module.mk: Added new directories to build system.
author Rik <rik@octave.org>
date Fri, 04 Oct 2013 17:09:08 -0700
parents scripts/plot/slice.m@68bcac3c043a
children d63878346099
comparison
equal deleted inserted replaced
17571:6e4ea5c8a4bb 17572:7bb76a22cde1
1 ## Copyright (C) 2007-2012 Kai Habel, David Bateman
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 -*-
20 ## @deftypefn {Function File} {} slice (@var{x}, @var{y}, @var{z}, @var{v}, @var{sx}, @var{sy}, @var{sz})
21 ## @deftypefnx {Function File} {} slice (@var{x}, @var{y}, @var{z}, @var{v}, @var{xi}, @var{yi}, @var{zi})
22 ## @deftypefnx {Function File} {} slice (@var{v}, @var{sx}, @var{sy}, @var{sz})
23 ## @deftypefnx {Function File} {} slice (@var{v}, @var{xi}, @var{yi}, @var{zi})
24 ## @deftypefnx {Function File} {} slice (@dots{}, @var{method})
25 ## @deftypefnx {Function File} {} slice (@var{hax}, @dots{})
26 ## @deftypefnx {Function File} {@var{h} =} slice (@dots{})
27 ## Plot slices of 3-D data/scalar fields.
28 ##
29 ## Each element of the 3-dimensional array @var{v} represents a scalar value at
30 ## a location given by the parameters @var{x}, @var{y}, and @var{z}. The
31 ## parameters @var{x}, @var{x}, and @var{z} are either 3-dimensional arrays of
32 ## the same size as the array @var{v} in the @qcode{"meshgrid"} format or
33 ## vectors. The parameters @var{xi}, etc. respect a similar format to
34 ## @var{x}, etc., and they represent the points at which the array @var{vi}
35 ## is interpolated using interp3. The vectors @var{sx}, @var{sy}, and
36 ## @var{sz} contain points of orthogonal slices of the respective axes.
37 ##
38 ## If @var{x}, @var{y}, @var{z} are omitted, they are assumed to be
39 ## @code{x = 1:size (@var{v}, 2)}, @code{y = 1:size (@var{v}, 1)} and
40 ## @code{z = 1:size (@var{v}, 3)}.
41 ##
42 ## @var{method} is one of:
43 ##
44 ## @table @asis
45 ## @item @qcode{"nearest"}
46 ## Return the nearest neighbor.
47 ##
48 ## @item @qcode{"linear"}
49 ## Linear interpolation from nearest neighbors.
50 ##
51 ## @item @qcode{"cubic"}
52 ## Cubic interpolation from four nearest neighbors (not implemented yet).
53 ##
54 ## @item @qcode{"spline"}
55 ## Cubic spline interpolation---smooth first and second derivatives
56 ## throughout the curve.
57 ## @end table
58 ##
59 ## The default method is @qcode{"linear"}.
60 ##
61 ## If the first argument @var{hax} is an axes handle, then plot into this axis,
62 ## rather than the current axes returned by @code{gca}.
63 ##
64 ## The optional return value @var{h} is a graphics handle to the created
65 ## surface object.
66 ##
67 ## Examples:
68 ##
69 ## @example
70 ## @group
71 ## [x, y, z] = meshgrid (linspace (-8, 8, 32));
72 ## v = sin (sqrt (x.^2 + y.^2 + z.^2)) ./ (sqrt (x.^2 + y.^2 + z.^2));
73 ## slice (x, y, z, v, [], 0, []);
74 ##
75 ## [xi, yi] = meshgrid (linspace (-7, 7));
76 ## zi = xi + yi;
77 ## slice (x, y, z, v, xi, yi, zi);
78 ## @end group
79 ## @end example
80 ## @seealso{interp3, surface, pcolor}
81 ## @end deftypefn
82
83 ## Author: Kai Habel <kai.habel@gmx.de>
84
85 function h = slice (varargin)
86
87 [hax, varargin, nargs] = __plt_get_axis_arg__ ("slice", varargin{:});
88
89 method = "linear";
90
91 if (ischar (varargin{end}))
92 method = varargin{end};
93 nargs -= 1;
94 endif
95
96 if (nargs == 4)
97 v = varargin{1};
98 if (ndims (v) != 3)
99 error ("slice: V must be a 3-dimensional array of values");
100 endif
101 [nx, ny, nz] = size (v);
102 [x, y, z] = meshgrid (1:nx, 1:ny, 1:nz);
103 sx = varargin{2};
104 sy = varargin{3};
105 sz = varargin{4};
106 elseif (nargs == 7)
107 v = varargin{4};
108 if (ndims (v) != 3)
109 error ("slice: V must be a 3-dimensional array of values");
110 endif
111 x = varargin{1};
112 y = varargin{2};
113 z = varargin{3};
114 if (isvector (x) && isvector (y) && isvector (z))
115 [x, y, z] = meshgrid (x, y, z);
116 elseif (ndims (x) == 3 && size_equal (x, y, z))
117 ## Do nothing.
118 else
119 error ("slice: X, Y, Z size mismatch");
120 endif
121 sx = varargin{5};
122 sy = varargin{6};
123 sz = varargin{7};
124 else
125 print_usage ();
126 endif
127
128 if (any ([isvector(sx), isvector(sy), isvector(sz)]))
129 have_sval = true;
130 elseif (ndims (sx) == 2 && size_equal (sx, sy, sz))
131 have_sval = false;
132 else
133 error ("slice: dimensional mismatch for (XI, YI, ZI) or (SX, SY, SZ)");
134 endif
135
136 oldfig = [];
137 if (! isempty (hax))
138 oldfig = get (0, "currentfigure");
139 endif
140 unwind_protect
141 hax = newplot (hax);
142
143 sidx = 1;
144 minv = min (v(:));
145 maxv = max (v(:));
146 set (hax, "clim", [minv, maxv]);
147
148 if (have_sval)
149 ns = length (sx) + length (sy) + length (sz);
150 hs = zeros (ns,1);
151 [ny, nx, nz] = size (v);
152 if (length (sz) > 0)
153 for i = 1:length (sz)
154 [xi, yi, zi] = meshgrid (squeeze (x(1,:,1)),
155 squeeze (y(:,1,1)), sz(i));
156 vz = squeeze (interp3 (x, y, z, v, xi, yi, zi, method));
157 htmp(sidx++) = surface (xi, yi, sz(i) * ones (size (yi)), vz);
158 endfor
159 endif
160
161 if (length (sy) > 0)
162 for i = length (sy):-1:1
163 [xi, yi, zi] = meshgrid (squeeze (x(1,:,1)), sy(i), squeeze (z(1,1,:)));
164 vy = squeeze (interp3 (x, y, z, v, xi, yi, zi, method));
165 htmp(sidx++) = surface (squeeze (xi),
166 squeeze (sy(i) * ones (size (zi))),
167 squeeze (zi), vy);
168 endfor
169 endif
170
171 if (length (sx) > 0)
172 for i = length (sx):-1:1
173 [xi, yi, zi] = meshgrid (sx(i), squeeze (y(:,1,1)), squeeze (z(1,1,:)));
174 vx = squeeze (interp3 (x, y, z, v, xi, yi, zi, method));
175 htmp(sidx++) = surface (squeeze (sx(i) * ones (size (zi))),
176 squeeze (yi), squeeze(zi), vx);
177 endfor
178 endif
179 else
180 vi = interp3 (x, y, z, v, sx, sy, sz);
181 htmp = surface (sx, sy, sz, vi);
182 endif
183
184 if (! ishold ())
185 set (hax, "view", [-37.5, 30.0], "box", "off",
186 "xgrid", "on", "ygrid", "on", "zgrid", "on");
187 endif
188
189 unwind_protect_cleanup
190 if (! isempty (oldfig))
191 set (0, "currentfigure", oldfig);
192 endif
193 end_unwind_protect
194
195 if (nargout > 0)
196 h = htmp;
197 endif
198
199 endfunction
200
201
202 %!demo
203 %! clf;
204 %! colormap ('default');
205 %! [x, y, z] = meshgrid (linspace (-8, 8, 32));
206 %! v = sin (sqrt (x.^2 + y.^2 + z.^2)) ./ (sqrt (x.^2 + y.^2 + z.^2));
207 %! slice (x, y, z, v, [], 0, []);
208
209 %!demo
210 %! clf;
211 %! colormap ('default');
212 %! [x, y, z] = meshgrid (linspace (-8, 8, 32));
213 %! v = sin (sqrt (x.^2 + y.^2 + z.^2)) ./ (sqrt (x.^2 + y.^2 + z.^2));
214 %! [xi, yi] = meshgrid (linspace (-7, 7));
215 %! zi = xi + yi;
216 %! slice (x, y, z, v, xi, yi, zi);
217