annotate FIXES/imagesc.m @ 0:6b33357c7561 octave-forge

Initial revision
author pkienzle
date Wed, 10 Oct 2001 19:54:49 +0000
parents
children b93249567aa0
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
1 ## Copyright (C) 1996, 1997 John W. Eaton
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
2 ##
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
3 ## This file is part of Octave.
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
4 ##
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
7 ## the Free Software Foundation; either version 2, or (at your option)
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
8 ## any later version.
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
9 ##
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
13 ## General Public License for more details.
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
14 ##
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, write to the Free
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
17 ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
18 ## 02111-1307, USA.
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
19
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
20 ## -*- texinfo -*-
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
21 ## @deftypefn {Function File} {} imagesc (@var{A}, @var{zoom})
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
22 ## @deftypefnx {Function File} {} imagesc (@var{x}, @var{y}, @var{A}, @var{zoom})
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
23 ## Display a scaled version of the matrix @var{A} as a color image. The
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
24 ## matrix is scaled so that its entries are indices into the current
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
25 ## colormap. The scaled matrix is returned. If @var{zoom} is omitted, a
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
26 ## comfortable size is chosen.
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
27 ##
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
28 ## The axis values corresponding to the matrix elements are specified in
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
29 ## @var{x} and @var{y}. At present they are ignored.
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
30 ## @end deftypefn
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
31 ## @seealso{image and imshow}
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
32
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
33 ## Author: Tony Richardson <arichard@stark.cc.oh.us>
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
34 ## Created: July 1994
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
35 ## Adapted-By: jwe
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
36
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
37 function ret = imagesc (x, y, A, zoom)
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
38
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
39 if (nargin < 1 || nargin > 4)
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
40 usage ("imagesc (matrix, zoom) or imagesc (x, y, matrix, zoom)");
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
41 elseif (nargin == 1)
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
42 A = x;
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
43 zoom = [];
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
44 x = y = [];
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
45 elseif (nargin == 2)
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
46 A = x;
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
47 zoom = y;
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
48 x = y = [];
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
49 elseif (nargin == 3)
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
50 zoom = [];
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
51 endif
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
52
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
53 ## Rescale values to between 1 and length (colormap) inclusive.
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
54 maxval = max (A (:));
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
55 minval = min (A (:));
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
56 if (maxval == minval)
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
57 B = ones ( size (A) );
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
58 else
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
59 B = round ((A - minval) / (maxval - minval) * (rows (colormap) - 1)) + 1;
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
60 endif
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
61
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
62 if ( nargout > 0 )
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
63 ret = B;
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
64 else
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
65 image (x, y, B, zoom);
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
66 endif
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
67
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
68 endfunction