annotate scripts/plot/sphere.m @ 10549:95c3e38098bf

Untabify .m scripts
author Rik <code@nomad.inbox5.com>
date Fri, 23 Apr 2010 11:28:50 -0700
parents 16f53d29049f
children be55736a0783
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
9245
16f53d29049f update copyright notices
John W. Eaton <jwe@octave.org>
parents: 9040
diff changeset
1 ## Copyright (C) 2007, 2009 Michael Goffioul
7189
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
2 ##
7224
a3435f7017c4 [project @ 2007-11-30 06:40:37 by jwe]
jwe
parents: 7215
diff changeset
3 ## This file is part of Octave.
7189
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
4 ##
7224
a3435f7017c4 [project @ 2007-11-30 06:40:37 by jwe]
jwe
parents: 7215
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
a3435f7017c4 [project @ 2007-11-30 06:40:37 by jwe]
jwe
parents: 7215
diff changeset
6 ## under the terms of the GNU General Public License as published by
a3435f7017c4 [project @ 2007-11-30 06:40:37 by jwe]
jwe
parents: 7215
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
a3435f7017c4 [project @ 2007-11-30 06:40:37 by jwe]
jwe
parents: 7215
diff changeset
8 ## your option) any later version.
a3435f7017c4 [project @ 2007-11-30 06:40:37 by jwe]
jwe
parents: 7215
diff changeset
9 ##
a3435f7017c4 [project @ 2007-11-30 06:40:37 by jwe]
jwe
parents: 7215
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
a3435f7017c4 [project @ 2007-11-30 06:40:37 by jwe]
jwe
parents: 7215
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
a3435f7017c4 [project @ 2007-11-30 06:40:37 by jwe]
jwe
parents: 7215
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
a3435f7017c4 [project @ 2007-11-30 06:40:37 by jwe]
jwe
parents: 7215
diff changeset
13 ## General Public License for more details.
7189
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
14 ##
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
7224
a3435f7017c4 [project @ 2007-11-30 06:40:37 by jwe]
jwe
parents: 7215
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
a3435f7017c4 [project @ 2007-11-30 06:40:37 by jwe]
jwe
parents: 7215
diff changeset
17 ## <http://www.gnu.org/licenses/>.
7189
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
18
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
19 ## -*- texinfo -*-
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
20 ## @deftypefn {Function File} {[@var{x}, @var{y}, @var{z}] =} sphere (@var{n})
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
21 ## @deftypefnx {Function File} {} sphere (@var{h}, @dots{})
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
22 ## Generates three matrices in @code{meshgrid} format, such that
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
23 ## @code{surf (@var{x}, @var{y}, @var{z})} generates a unit sphere.
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 7224
diff changeset
24 ## The matrices of @code{@var{n}+1}-by-@code{@var{n}+1}. If @var{n} is
7189
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
25 ## omitted then a default value of 20 is assumed.
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
26 ##
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
27 ## Called with no return arguments, @code{sphere} call directly
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 7224
diff changeset
28 ## @code{surf (@var{x}, @var{y}, @var{z})}. If an axes handle is passed
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 7224
diff changeset
29 ## as the first argument, the surface is plotted to this set of axes.
7189
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
30 ## @seealso{peaks}
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
31 ## @end deftypefn
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
32
7215
dd88d61d443f [project @ 2007-11-29 16:44:45 by jwe]
jwe
parents: 7191
diff changeset
33 function [xx, yy, zz] = sphere (varargin)
7189
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
34
7215
dd88d61d443f [project @ 2007-11-29 16:44:45 by jwe]
jwe
parents: 7191
diff changeset
35 [h, varargin, nargin] = __plt_get_axis_arg__ ((nargout > 0), "sphere",
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9245
diff changeset
36 varargin{:});
7215
dd88d61d443f [project @ 2007-11-29 16:44:45 by jwe]
jwe
parents: 7191
diff changeset
37 if (nargin > 1)
dd88d61d443f [project @ 2007-11-29 16:44:45 by jwe]
jwe
parents: 7191
diff changeset
38 print_usage ();
7191
b48a21816f2e [project @ 2007-11-26 21:24:32 by jwe]
jwe
parents: 7189
diff changeset
39 elseif (nargin == 1)
7215
dd88d61d443f [project @ 2007-11-29 16:44:45 by jwe]
jwe
parents: 7191
diff changeset
40 n = varargin{1};
7189
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
41 else
7191
b48a21816f2e [project @ 2007-11-26 21:24:32 by jwe]
jwe
parents: 7189
diff changeset
42 n = 20;
7189
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
43 endif
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
44
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
45 theta = linspace (0, 2*pi, n+1);
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
46 phi = linspace (-pi/2, pi/2, n+1);
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
47 [theta,phi] = meshgrid (theta, phi);
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
48
7191
b48a21816f2e [project @ 2007-11-26 21:24:32 by jwe]
jwe
parents: 7189
diff changeset
49 x = cos (phi) .* cos (theta);
b48a21816f2e [project @ 2007-11-26 21:24:32 by jwe]
jwe
parents: 7189
diff changeset
50 y = cos (phi) .* sin (theta);
b48a21816f2e [project @ 2007-11-26 21:24:32 by jwe]
jwe
parents: 7189
diff changeset
51 z = sin (phi);
7189
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
52
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
53 if (nargout > 0)
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
54 xx = x;
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
55 yy = y;
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
56 zz = z;
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
57 else
7215
dd88d61d443f [project @ 2007-11-29 16:44:45 by jwe]
jwe
parents: 7191
diff changeset
58 surf (h, x, y, z);
7189
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
59 endif
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
60
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
61 endfunction