File: surfc.m

package info (click to toggle)
octave 11.0.92-1
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 148,624 kB
  • sloc: cpp: 347,499; ansic: 85,112; fortran: 20,693; objc: 10,276; sh: 8,747; lex: 4,496; yacc: 4,406; perl: 1,544; java: 1,365; awk: 1,282; makefile: 666; xml: 192
file content (145 lines) | stat: -rw-r--r-- 4,809 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
########################################################################
##
## Copyright (C) 1996-2026 The Octave Project Developers
##
## See the file COPYRIGHT.md in the top-level directory of this
## distribution or <https://octave.org/copyright/>.
##
## This file is part of Octave.
##
## Octave is free software: you can redistribute it and/or modify it
## under the terms of the GNU General Public License as published by
## the Free Software Foundation, either version 3 of the License, or
## (at your option) any later version.
##
## Octave is distributed in the hope that it will be useful, but
## WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
## GNU General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with Octave; see the file COPYING.  If not, see
## <https://www.gnu.org/licenses/>.
##
########################################################################

## -*- texinfo -*-
## @deftypefn  {} {} surfc (@var{x}, @var{y}, @var{z})
## @deftypefnx {} {} surfc (@var{z})
## @deftypefnx {} {} surfc (@dots{}, @var{c})
## @deftypefnx {} {} surfc (@dots{}, @var{prop}, @var{val}, @dots{})
## @deftypefnx {} {} surfc (@var{hax}, @dots{})
## @deftypefnx {} {@var{h} =} surfc (@dots{})
## Plot a 3-D surface mesh with underlying contour lines.
##
## The surface mesh is plotted using shaded rectangles.  The vertices of the
## rectangles [@var{x}, @var{y}] are typically the output of @code{meshgrid}.
## over a 2-D rectangular region in the x-y plane.  @var{z} determines the
## height above the plane of each vertex.  If only a single @var{z} matrix is
## given, then it is plotted over the meshgrid
## @code{@var{x} = 1:columns (@var{z}), @var{y} = 1:rows (@var{z})}.
## Thus, columns of @var{z} correspond to different @var{x} values and rows
## of @var{z} correspond to different @var{y} values.
##
## The color of the surface is computed by linearly scaling the @var{z} values
## to fit the range of the current colormap.  Use @code{clim} and/or
## change the colormap to control the appearance.
##
## Optionally, the color of the surface can be specified independently of
## @var{z} by supplying a color matrix, @var{c}.
##
## Any property/value pairs are passed directly to the underlying surface
## object.  The full list of properties is documented at
## @ref{Surface Properties}.
##
## If the first argument @var{hax} is an axes handle, then plot into this axes,
## rather than the current axes returned by @code{gca}.
##
## The optional return value @var{h} is a graphics handle to the created
## surface object.
##
## Note: The exact appearance of the surface can be controlled with the
## @code{shading} command or by using @code{set} to control surface object
## properties.
## @seealso{ezsurfc, surf, surfl, surfnorm, trisurf, contour, mesh, surface,
## meshgrid, hidden, shading, colormap, clim}
## @end deftypefn

function h = surfc (varargin)

  [hax, varargin, nargin] = __plt_get_axis_arg__ ("surfc", varargin{:});

  if (nargin < 1)
    print_usage ();
  endif

  hax = newplot (hax);

  surfc_props = {"facecolor", "flat"};
  chararg = find (cellfun ("isclass", varargin, "char"), 1);
  if (isempty (chararg))
    htmp = surface (hax, varargin{:}, surfc_props{:});
  else
    htmp = surface (hax, varargin{1:chararg-1}, surfc_props{:},
                         varargin{chararg:end});
  endif

  if (! ishold (hax))
    set (hax, "view", [-37.5, 30],
              "xgrid", "on", "ygrid", "on", "zgrid", "on",
              "xlimmode", "manual", "ylimmode", "manual");
  endif

  drawnow ();

  ## don't pass string arguments to __contour__()
  stop_idx = find (cellfun ("isclass", varargin, "char"), 1);
  if (isempty (stop_idx))
    stop_idx = nargin;
  else
    stop_idx -= 1;
  endif

  if (stop_idx - 1 == 1 || stop_idx - 1 == 3)
    ## Don't pass a color matrix c to __contour__
    stop_idx -= 1;
  endif

  zmin = get (hax, "zlim")(1);
  [~, htmp2] = __contour__ (hax, zmin, varargin{1:stop_idx});

  htmp = [htmp; htmp2];

  if (nargout > 0)
    h = htmp;
  endif

endfunction


%!demo
%! clf;
%! colormap ("default");
%! Z = peaks ();
%! surfc (Z);
%! title ("surfc() combines surf/contour plots");

%!demo
%! clf;
%! colormap ("default");
%! Z = sombrero ();
%! [Fx,Fy] = gradient (Z);
%! surfc (Z, Fx+Fy);
%! shading interp;
%! title ({"surfc() plot of sombrero() function"; ...
%!         "facecolor is interpolated, color determined by gradient of Z"});

%!demo
%! clf;
%! colormap ("default");
%! [X,Y,Z] = sombrero ();
%! [~,Fy] = gradient (Z);
%! surfc (X,Y,Z,Fy);
%! shading interp;
%! title ({"surfc() plot of peaks() function"; ...
%!         "facecolor is interpolated, color determined by Y-gradient of Z"});