annotate scripts/image/image.m @ 7074:87151f298e6a

[project @ 2007-10-26 17:57:34 by jwe]
author jwe
date Fri, 26 Oct 2007 17:57:34 +0000
parents a1dbe9d80eee
children e8d953d03f6a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7017
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
1 ## Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2002, 2003,
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
2 ## 2004, 2005, 2006, 2007 John W. Eaton
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
3 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
4 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
5 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
6 ## Octave is free software; you can redistribute it and/or modify it
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
7 ## under the terms of the GNU General Public License as published by
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6368
diff changeset
8 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6368
diff changeset
9 ## your option) any later version.
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
10 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
11 ## Octave is distributed in the hope that it will be useful, but
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
12 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
14 ## General Public License for more details.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
15 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
16 ## You should have received a copy of the GNU General Public License
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6368
diff changeset
17 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6368
diff changeset
18 ## <http://www.gnu.org/licenses/>.
1024
56520a75b5b3 [project @ 1995-01-11 20:30:04 by jwe]
jwe
parents: 904
diff changeset
19
3381
69b167451491 [project @ 1999-12-15 20:48:10 by jwe]
jwe
parents: 3373
diff changeset
20 ## -*- texinfo -*-
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6164
diff changeset
21 ## @deftypefn {Function File} {} image (@var{img})
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6164
diff changeset
22 ## @deftypefnx {Function File} {} image (@var{x}, @var{y}, @var{img})
3373
36405da8e173 [project @ 1999-11-23 20:54:17 by jwe]
jwe
parents: 3202
diff changeset
23 ## Display a matrix as a color image. The elements of @var{x} are indices
36405da8e173 [project @ 1999-11-23 20:54:17 by jwe]
jwe
parents: 3202
diff changeset
24 ## into the current colormap and should have values between 1 and the
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6164
diff changeset
25 ## length of the colormap.
3651
c2305b99fbd7 [project @ 2000-03-31 07:12:29 by jwe]
jwe
parents: 3457
diff changeset
26 ##
6164
d90b16110095 [project @ 2006-11-14 21:08:00 by jwe]
jwe
parents: 6088
diff changeset
27 ## It first tries to use @code{gnuplot}, then @code{display} from
d90b16110095 [project @ 2006-11-14 21:08:00 by jwe]
jwe
parents: 6088
diff changeset
28 ## @code{ImageMagick}, then @code{xv}, and then @code{xloadimage}.
d90b16110095 [project @ 2006-11-14 21:08:00 by jwe]
jwe
parents: 6088
diff changeset
29 ## The actual program used can be changed using the @code{image_viewer}
d90b16110095 [project @ 2006-11-14 21:08:00 by jwe]
jwe
parents: 6088
diff changeset
30 ## function.
3714
38ff09748e26 [project @ 2000-08-25 06:10:30 by jwe]
jwe
parents: 3651
diff changeset
31 ##
3651
c2305b99fbd7 [project @ 2000-03-31 07:12:29 by jwe]
jwe
parents: 3457
diff changeset
32 ## The axis values corresponding to the matrix elements are specified in
6164
d90b16110095 [project @ 2006-11-14 21:08:00 by jwe]
jwe
parents: 6088
diff changeset
33 ## @var{x} and @var{y}. If you're not using gnuplot 4.2 or later, these
d90b16110095 [project @ 2006-11-14 21:08:00 by jwe]
jwe
parents: 6088
diff changeset
34 ## variables are ignored.
d90b16110095 [project @ 2006-11-14 21:08:00 by jwe]
jwe
parents: 6088
diff changeset
35 ## @seealso{imshow, imagesc, colormap, image_viewer}
3373
36405da8e173 [project @ 1999-11-23 20:54:17 by jwe]
jwe
parents: 3202
diff changeset
36 ## @end deftypefn
559
4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe]
jwe
parents:
diff changeset
37
3202
44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe]
jwe
parents: 2847
diff changeset
38 ## Author: Tony Richardson <arichard@stark.cc.oh.us>
2312
204cc7db6f4a [project @ 1996-07-11 21:20:36 by jwe]
jwe
parents: 2311
diff changeset
39 ## Created: July 1994
204cc7db6f4a [project @ 1996-07-11 21:20:36 by jwe]
jwe
parents: 2311
diff changeset
40 ## Adapted-By: jwe
904
3470f1e25a79 [project @ 1994-11-09 21:22:15 by jwe]
jwe
parents: 686
diff changeset
41
7074
87151f298e6a [project @ 2007-10-26 17:57:34 by jwe]
jwe
parents: 7017
diff changeset
42 function h = image (x, y, img)
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6164
diff changeset
43
6368
ec2a523713b5 [project @ 2007-02-28 22:07:24 by jwe]
jwe
parents: 6309
diff changeset
44 ## Deprecated zoom. Remove this hunk of code if old zoom argument
ec2a523713b5 [project @ 2007-02-28 22:07:24 by jwe]
jwe
parents: 6309
diff changeset
45 ## is outmoded.
ec2a523713b5 [project @ 2007-02-28 22:07:24 by jwe]
jwe
parents: 6309
diff changeset
46 if ((nargin == 2 && isscalar (y)) || nargin == 4)
ec2a523713b5 [project @ 2007-02-28 22:07:24 by jwe]
jwe
parents: 6309
diff changeset
47 warning ("image: zoom argument ignored -- use GUI features");
ec2a523713b5 [project @ 2007-02-28 22:07:24 by jwe]
jwe
parents: 6309
diff changeset
48 endif
ec2a523713b5 [project @ 2007-02-28 22:07:24 by jwe]
jwe
parents: 6309
diff changeset
49 if (nargin == 4)
ec2a523713b5 [project @ 2007-02-28 22:07:24 by jwe]
jwe
parents: 6309
diff changeset
50 nargin = 3;
ec2a523713b5 [project @ 2007-02-28 22:07:24 by jwe]
jwe
parents: 6309
diff changeset
51 endif
ec2a523713b5 [project @ 2007-02-28 22:07:24 by jwe]
jwe
parents: 6309
diff changeset
52 if (nargin == 2 && isscalar (y))
ec2a523713b5 [project @ 2007-02-28 22:07:24 by jwe]
jwe
parents: 6309
diff changeset
53 nargin = 1;
ec2a523713b5 [project @ 2007-02-28 22:07:24 by jwe]
jwe
parents: 6309
diff changeset
54 endif
559
4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe]
jwe
parents:
diff changeset
55
4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe]
jwe
parents:
diff changeset
56 if (nargin == 0)
2303
5cffc4b8de57 [project @ 1996-06-24 09:15:24 by jwe]
jwe
parents: 1887
diff changeset
57 ## Load Bobbie Jo Richardson (Born 3/16/94)
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6164
diff changeset
58 img = loadimage ("default.img");
6088
32ea759ea27e [project @ 2006-10-25 19:39:00 by jwe]
jwe
parents: 6046
diff changeset
59 x = y = [];
6368
ec2a523713b5 [project @ 2007-02-28 22:07:24 by jwe]
jwe
parents: 6309
diff changeset
60 elseif (nargin == 1)
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6164
diff changeset
61 img = x;
3651
c2305b99fbd7 [project @ 2000-03-31 07:12:29 by jwe]
jwe
parents: 3457
diff changeset
62 x = y = [];
6368
ec2a523713b5 [project @ 2007-02-28 22:07:24 by jwe]
jwe
parents: 6309
diff changeset
63 elseif (nargin == 2 || nargin > 3)
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6164
diff changeset
64 print_usage ();
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6164
diff changeset
65 endif
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6164
diff changeset
66
6309
6a60e68fc4b1 [project @ 2007-02-15 09:49:27 by jwe]
jwe
parents: 6262
diff changeset
67 tmp = __img__ (x, y, img);
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6164
diff changeset
68
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6164
diff changeset
69 if (nargout > 0)
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6164
diff changeset
70 h = tmp;
6088
32ea759ea27e [project @ 2006-10-25 19:39:00 by jwe]
jwe
parents: 6046
diff changeset
71 endif
559
4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe]
jwe
parents:
diff changeset
72
4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe]
jwe
parents:
diff changeset
73 endfunction