Mercurial > hg > octave-lyh

annotate scripts/plot/ellipsoid.m @ 17126:eaab03308c0b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Rewrite docstrings for most plot functions. Emphasize clarity, use common "voice", and increase density of seealso links. * doc/interpreter/plot.txi: Add @findex entries that were in xlim.m * scripts/miscellaneous/getappdata.m scripts/miscellaneous/setappdata.m, scripts/plot/allchild.m, scripts/plot/ancestor.m, scripts/plot/area.m, scripts/plot/axes.m, scripts/plot/axis.m, scripts/plot/bar.m, scripts/plot/barh.m, scripts/plot/box.m, scripts/plot/caxis.m, scripts/plot/cla.m, scripts/plot/clabel.m, scripts/plot/clf.m, scripts/plot/close.m, scripts/plot/closereq.m, scripts/plot/colorbar.m, scripts/plot/comet.m, scripts/plot/comet3.m, scripts/plot/compass.m, scripts/plot/contour.m, scripts/plot/contour3.m, scripts/plot/contourc.m, scripts/plot/contourf.m, scripts/plot/copyobj.m, scripts/plot/cylinder.m, scripts/plot/daspect.m, scripts/plot/diffuse.m, scripts/plot/ellipsoid.m, scripts/plot/errorbar.m, scripts/plot/ezcontour.m, scripts/plot/ezcontourf.m, scripts/plot/ezmesh.m, scripts/plot/ezmeshc.m, scripts/plot/ezplot.m, scripts/plot/ezplot3.m, scripts/plot/ezpolar.m, scripts/plot/ezsurf.m, scripts/plot/ezsurfc.m, scripts/plot/feather.m, scripts/plot/figure.m, scripts/plot/fill.m, scripts/plot/findall.m, scripts/plot/findobj.m, scripts/plot/fplot.m, scripts/plot/gca.m, scripts/plot/gcbf.m, scripts/plot/gcbo.m, scripts/plot/gcf.m, scripts/plot/gco.m, scripts/plot/ginput.m, scripts/plot/graphics_toolkit.m, scripts/plot/grid.m, scripts/plot/gtext.m, scripts/plot/guidata.m, scripts/plot/guihandles.m, scripts/plot/hdl2struct.m, scripts/plot/hggroup.m, scripts/plot/hidden.m, scripts/plot/hist.m, scripts/plot/hold.m, scripts/plot/ishghandle.m, scripts/plot/ishold.m, scripts/plot/isocolors.m, scripts/plot/isprop.m, scripts/plot/legend.m, scripts/plot/line.m, scripts/plot/linkprop.m, scripts/plot/loglog.m, scripts/plot/loglogerr.m, scripts/plot/mesh.m, scripts/plot/meshc.m, scripts/plot/meshgrid.m, scripts/plot/meshz.m, scripts/plot/newplot.m, scripts/plot/orient.m, scripts/plot/pareto.m, scripts/plot/patch.m, scripts/plot/pcolor.m, scripts/plot/peaks.m, scripts/plot/pie.m, scripts/plot/pie3.m, scripts/plot/plot.m, scripts/plot/plot3.m, scripts/plot/plotmatrix.m, scripts/plot/plotyy.m, scripts/plot/polar.m, scripts/plot/print.m, scripts/plot/quiver.m, scripts/plot/quiver3.m, scripts/plot/rectangle.m, scripts/plot/refresh.m, scripts/plot/refreshdata.m, scripts/plot/ribbon.m, scripts/plot/rose.m, scripts/plot/saveas.m, scripts/plot/scatter.m, scripts/plot/scatter3.m, scripts/plot/semilogx.m, scripts/plot/semilogxerr.m, scripts/plot/semilogy.m, scripts/plot/semilogyerr.m, scripts/plot/shading.m, scripts/plot/shg.m, scripts/plot/shrinkfaces.m, scripts/plot/slice.m, scripts/plot/specular.m, scripts/plot/sphere.m, scripts/plot/stairs.m, scripts/plot/stem.m, scripts/plot/stem3.m, scripts/plot/struct2hdl.m, scripts/plot/subplot.m, scripts/plot/surf.m, scripts/plot/surface.m, scripts/plot/surfc.m, scripts/plot/surfl.m, scripts/plot/tetramesh.m, scripts/plot/text.m, scripts/plot/title.m, scripts/plot/trimesh.m, scripts/plot/triplot.m, scripts/plot/trisurf.m, scripts/plot/view.m, scripts/plot/waitbar.m, scripts/plot/waitforbuttonpress.m, scripts/plot/waterfall.m, scripts/plot/whitebg.m, scripts/plot/xlabel.m, scripts/plot/xlim.m, scripts/plot/ylabel.m, scripts/plot/ylim.m, scripts/plot/zlabel.m, scripts/plot/zlim.m: Rewrite docstrings for most plot functions. Emphasize clarity, use common "voice", and increase density of seealso links.
author Rik <rik@octave.org>
date Wed, 31 Jul 2013 13:53:30 -0700
parents 3e1b24a2454a
children 26589abbc78d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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 Sylvain Pelissier
7306
e1e9bb54a440 [project @ 2007-12-12 16:47:07 by jwe]
jwe
parents: 7305
diff changeset
2 ##
e1e9bb54a440 [project @ 2007-12-12 16:47:07 by jwe]
jwe
parents: 7305
diff changeset
3 ## This file is part of Octave.
7305
84a2e24c75c8 [project @ 2007-12-12 16:45:02 by jwe]
jwe
parents:
diff changeset
4 ##
7306
e1e9bb54a440 [project @ 2007-12-12 16:47:07 by jwe]
jwe
parents: 7305
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
e1e9bb54a440 [project @ 2007-12-12 16:47:07 by jwe]
jwe
parents: 7305
diff changeset
6 ## under the terms of the GNU General Public License as published by
e1e9bb54a440 [project @ 2007-12-12 16:47:07 by jwe]
jwe
parents: 7305
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
e1e9bb54a440 [project @ 2007-12-12 16:47:07 by jwe]
jwe
parents: 7305
diff changeset
8 ## your option) any later version.
7305
84a2e24c75c8 [project @ 2007-12-12 16:45:02 by jwe]
jwe
parents:
diff changeset
9 ##
7306
e1e9bb54a440 [project @ 2007-12-12 16:47:07 by jwe]
jwe
parents: 7305
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
e1e9bb54a440 [project @ 2007-12-12 16:47:07 by jwe]
jwe
parents: 7305
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
e1e9bb54a440 [project @ 2007-12-12 16:47:07 by jwe]
jwe
parents: 7305
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
e1e9bb54a440 [project @ 2007-12-12 16:47:07 by jwe]
jwe
parents: 7305
diff changeset
13 ## General Public License for more details.
7305
84a2e24c75c8 [project @ 2007-12-12 16:45:02 by jwe]
jwe
parents:
diff changeset
14 ##
84a2e24c75c8 [project @ 2007-12-12 16:45:02 by jwe]
jwe
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
7306
e1e9bb54a440 [project @ 2007-12-12 16:47:07 by jwe]
jwe
parents: 7305
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
e1e9bb54a440 [project @ 2007-12-12 16:47:07 by jwe]
jwe
parents: 7305
diff changeset
17 ## <http://www.gnu.org/licenses/>.
7305
84a2e24c75c8 [project @ 2007-12-12 16:45:02 by jwe]
jwe
parents:
diff changeset
18
84a2e24c75c8 [project @ 2007-12-12 16:45:02 by jwe]
jwe
parents:
diff changeset
19 ## -*- texinfo -*-
17126
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17051
diff changeset
20 ## @deftypefn {Function File} {} ellipsoid (@var{xc}, @var{yc}, @var{zc}, @var{xr}, @var{yr}, @var{zr}, @var{n})
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17051
diff changeset
21 ## @deftypefnx {Function File} {} ellipsoid (@dots{}, @var{n})
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17051
diff changeset
22 ## @deftypefnx {Function File} {} ellipsoid (@var{hax}, @dots{})
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17051
diff changeset
23 ## @deftypefnx {Function File} {[@var{x}, @var{y}, @var{z}] =} ellipsoid (@dots{})
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17051
diff changeset
24 ## Plot a 3-D ellipsoid.
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17051
diff changeset
25 ##
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17051
diff changeset
26 ## The inputs @var{xc}, @var{yc}, @var{zc} specify the center of the ellipsoid.
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17051
diff changeset
27 ## The inputs @var{xr}, @var{yr}, @var{zr} specify the semi-major axis lengths.
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17051
diff changeset
28 ##
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17051
diff changeset
29 ## The optional input @var{n} determines the number of faces around the
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17051
diff changeset
30 ## the circumference of the cylinder. The default value is 20.
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17051
diff changeset
31 ##
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17051
diff changeset
32 ## If the first argument @var{hax} is an axes handle, then plot into this axis,
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17051
diff changeset
33 ## rather than the current axes returned by @code{gca}.
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17051
diff changeset
34 ##
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17051
diff changeset
35 ## If outputs are requested @code{ellipsoid} returns three matrices in
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17051
diff changeset
36 ## @code{meshgrid} format, such that @code{surf (@var{x}, @var{y}, @var{z})}
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17051
diff changeset
37 ## generates the ellipsoid.
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17051
diff changeset
38 ## @seealso{cylinder, rectangle, sphere}
7305
84a2e24c75c8 [project @ 2007-12-12 16:45:02 by jwe]
jwe
parents:
diff changeset
39 ## @end deftypefn
84a2e24c75c8 [project @ 2007-12-12 16:45:02 by jwe]
jwe
parents:
diff changeset
40
7306
e1e9bb54a440 [project @ 2007-12-12 16:47:07 by jwe]
jwe
parents: 7305
diff changeset
41 ## Author: Sylvain Pelissier <sylvain.pelissier@gmail.com>
e1e9bb54a440 [project @ 2007-12-12 16:47:07 by jwe]
jwe
parents: 7305
diff changeset
42
e1e9bb54a440 [project @ 2007-12-12 16:47:07 by jwe]
jwe
parents: 7305
diff changeset
43 function [xx, yy, zz] = ellipsoid (varargin)
7305
84a2e24c75c8 [project @ 2007-12-12 16:45:02 by jwe]
jwe
parents:
diff changeset
44
17051
3e1b24a2454a cylinder.m, ellipsoid.m, rectangle.m, sphere.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14237
diff changeset
45 [hax, varargin, nargin] = __plt_get_axis_arg__ ("ellipsoid", varargin{:});
7305
84a2e24c75c8 [project @ 2007-12-12 16:45:02 by jwe]
jwe
parents:
diff changeset
46
84a2e24c75c8 [project @ 2007-12-12 16:45:02 by jwe]
jwe
parents:
diff changeset
47 if (nargin != 6 && nargin != 7)
84a2e24c75c8 [project @ 2007-12-12 16:45:02 by jwe]
jwe
parents:
diff changeset
48 print_usage ();
84a2e24c75c8 [project @ 2007-12-12 16:45:02 by jwe]
jwe
parents:
diff changeset
49 endif
84a2e24c75c8 [project @ 2007-12-12 16:45:02 by jwe]
jwe
parents:
diff changeset
50
84a2e24c75c8 [project @ 2007-12-12 16:45:02 by jwe]
jwe
parents:
diff changeset
51 xc = varargin{1};
84a2e24c75c8 [project @ 2007-12-12 16:45:02 by jwe]
jwe
parents:
diff changeset
52 yc = varargin{2};
84a2e24c75c8 [project @ 2007-12-12 16:45:02 by jwe]
jwe
parents:
diff changeset
53 zc = varargin{3};
84a2e24c75c8 [project @ 2007-12-12 16:45:02 by jwe]
jwe
parents:
diff changeset
54 xr = varargin{4};
84a2e24c75c8 [project @ 2007-12-12 16:45:02 by jwe]
jwe
parents:
diff changeset
55 yr = varargin{5};
84a2e24c75c8 [project @ 2007-12-12 16:45:02 by jwe]
jwe
parents:
diff changeset
56 zr = varargin{6};
84a2e24c75c8 [project @ 2007-12-12 16:45:02 by jwe]
jwe
parents:
diff changeset
57
8274
967c15c5e265 ellipsoid.m: fix default argument check
Soren Hauberg <hauberg@gmail.com>
parents: 7306
diff changeset
58 if (nargin == 6)
7305
84a2e24c75c8 [project @ 2007-12-12 16:45:02 by jwe]
jwe
parents:
diff changeset
59 n = 20;
84a2e24c75c8 [project @ 2007-12-12 16:45:02 by jwe]
jwe
parents:
diff changeset
60 else
84a2e24c75c8 [project @ 2007-12-12 16:45:02 by jwe]
jwe
parents:
diff changeset
61 n = varargin{7};
84a2e24c75c8 [project @ 2007-12-12 16:45:02 by jwe]
jwe
parents:
diff changeset
62 endif
84a2e24c75c8 [project @ 2007-12-12 16:45:02 by jwe]
jwe
parents:
diff changeset
63
84a2e24c75c8 [project @ 2007-12-12 16:45:02 by jwe]
jwe
parents:
diff changeset
64 theta = linspace (0, 2 * pi, n + 1);
84a2e24c75c8 [project @ 2007-12-12 16:45:02 by jwe]
jwe
parents:
diff changeset
65 phi = linspace (-pi / 2, pi / 2, n + 1);
84a2e24c75c8 [project @ 2007-12-12 16:45:02 by jwe]
jwe
parents:
diff changeset
66 [theta, phi] = meshgrid (theta, phi);
84a2e24c75c8 [project @ 2007-12-12 16:45:02 by jwe]
jwe
parents:
diff changeset
67
84a2e24c75c8 [project @ 2007-12-12 16:45:02 by jwe]
jwe
parents:
diff changeset
68 x = xr .* cos (phi) .* cos (theta) + xc;
84a2e24c75c8 [project @ 2007-12-12 16:45:02 by jwe]
jwe
parents:
diff changeset
69 y = yr .* cos (phi) .* sin (theta) + yc;
84a2e24c75c8 [project @ 2007-12-12 16:45:02 by jwe]
jwe
parents:
diff changeset
70 z = zr .* sin (phi) + zc;
84a2e24c75c8 [project @ 2007-12-12 16:45:02 by jwe]
jwe
parents:
diff changeset
71
84a2e24c75c8 [project @ 2007-12-12 16:45:02 by jwe]
jwe
parents:
diff changeset
72 if (nargout > 0)
84a2e24c75c8 [project @ 2007-12-12 16:45:02 by jwe]
jwe
parents:
diff changeset
73 xx = x;
84a2e24c75c8 [project @ 2007-12-12 16:45:02 by jwe]
jwe
parents:
diff changeset
74 yy = y;
84a2e24c75c8 [project @ 2007-12-12 16:45:02 by jwe]
jwe
parents:
diff changeset
75 zz = z;
84a2e24c75c8 [project @ 2007-12-12 16:45:02 by jwe]
jwe
parents:
diff changeset
76 else
17051
3e1b24a2454a cylinder.m, ellipsoid.m, rectangle.m, sphere.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14237
diff changeset
77 oldfig = ifelse (isempty (hax), [], get (0, "currentfigure"));
3e1b24a2454a cylinder.m, ellipsoid.m, rectangle.m, sphere.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14237
diff changeset
78 unwind_protect
3e1b24a2454a cylinder.m, ellipsoid.m, rectangle.m, sphere.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14237
diff changeset
79 hax = newplot (hax);
3e1b24a2454a cylinder.m, ellipsoid.m, rectangle.m, sphere.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14237
diff changeset
80
3e1b24a2454a cylinder.m, ellipsoid.m, rectangle.m, sphere.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14237
diff changeset
81 surf (hax, x, y, z);
3e1b24a2454a cylinder.m, ellipsoid.m, rectangle.m, sphere.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14237
diff changeset
82
3e1b24a2454a cylinder.m, ellipsoid.m, rectangle.m, sphere.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14237
diff changeset
83 unwind_protect_cleanup
3e1b24a2454a cylinder.m, ellipsoid.m, rectangle.m, sphere.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14237
diff changeset
84 if (! isempty (oldfig))
3e1b24a2454a cylinder.m, ellipsoid.m, rectangle.m, sphere.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14237
diff changeset
85 set (0, "currentfigure", oldfig);
3e1b24a2454a cylinder.m, ellipsoid.m, rectangle.m, sphere.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14237
diff changeset
86 endif
3e1b24a2454a cylinder.m, ellipsoid.m, rectangle.m, sphere.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14237
diff changeset
87 end_unwind_protect
7305
84a2e24c75c8 [project @ 2007-12-12 16:45:02 by jwe]
jwe
parents:
diff changeset
88 endif
84a2e24c75c8 [project @ 2007-12-12 16:45:02 by jwe]
jwe
parents:
diff changeset
89
84a2e24c75c8 [project @ 2007-12-12 16:45:02 by jwe]
jwe
parents:
diff changeset
90 endfunction
84a2e24c75c8 [project @ 2007-12-12 16:45:02 by jwe]
jwe
parents:
diff changeset
91
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
92
7305
84a2e24c75c8 [project @ 2007-12-12 16:45:02 by jwe]
jwe
parents:
diff changeset
93 %!demo
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
94 %! clf;
7305
84a2e24c75c8 [project @ 2007-12-12 16:45:02 by jwe]
jwe
parents:
diff changeset
95 %! ellipsoid (0, 0, 1, 2, 3, 4, 20);
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
96