annotate scripts/image/loadimage.m @ 4960:ce01dbd7e026 ss-2-1-58

[project @ 2004-09-02 03:47:49 by jwe]
author jwe
date Thu, 02 Sep 2004 03:47:49 +0000
parents e031284eea27
children c08cb1098afc
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2847
8b262e771614 [project @ 1997-03-27 16:18:26 by jwe]
jwe
parents: 2650
diff changeset
1 ## Copyright (C) 1996, 1997 John W. Eaton
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
2 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
3 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
4 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
5 ## 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
6 ## under the terms of the GNU General Public License as published by
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
7 ## the Free Software Foundation; either version 2, or (at your option)
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
8 ## any later version.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
9 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
10 ## 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
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
12 ## 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
13 ## General Public License for more details.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
14 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
15 ## You should have received a copy of the GNU General Public License
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
16 ## along with Octave; see the file COPYING. If not, write to the Free
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
17 ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
18 ## 02111-1307, USA.
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 -*-
3373
36405da8e173 [project @ 1999-11-23 20:54:17 by jwe]
jwe
parents: 3202
diff changeset
21 ## @deftypefn {Function File} {[@var{x}, @var{map}] =} loadimage (@var{file})
36405da8e173 [project @ 1999-11-23 20:54:17 by jwe]
jwe
parents: 3202
diff changeset
22 ## Load an image file and it's associated color map from the specified
36405da8e173 [project @ 1999-11-23 20:54:17 by jwe]
jwe
parents: 3202
diff changeset
23 ## @var{file}. The image must be stored in Octave's image format.
36405da8e173 [project @ 1999-11-23 20:54:17 by jwe]
jwe
parents: 3202
diff changeset
24 ## @end deftypefn
3457
e031284eea27 [project @ 2000-01-19 08:49:56 by jwe]
jwe
parents: 3400
diff changeset
25 ## @seealso{saveimage, load, and save}
904
3470f1e25a79 [project @ 1994-11-09 21:22:15 by jwe]
jwe
parents: 686
diff changeset
26
3202
44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe]
jwe
parents: 2847
diff changeset
27 ## Author: Tony Richardson <arichard@stark.cc.oh.us>
2312
204cc7db6f4a [project @ 1996-07-11 21:20:36 by jwe]
jwe
parents: 2311
diff changeset
28 ## Created: July 1994
204cc7db6f4a [project @ 1996-07-11 21:20:36 by jwe]
jwe
parents: 2311
diff changeset
29 ## Adapted-By: jwe
559
4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe]
jwe
parents:
diff changeset
30
2650
64aff25e8be3 [project @ 1997-01-31 16:16:53 by jwe]
jwe
parents: 2325
diff changeset
31 function [img_retval, map_retval] = loadimage (filename)
1024
56520a75b5b3 [project @ 1995-01-11 20:30:04 by jwe]
jwe
parents: 904
diff changeset
32
56520a75b5b3 [project @ 1995-01-11 20:30:04 by jwe]
jwe
parents: 904
diff changeset
33 if (nargin != 1)
2650
64aff25e8be3 [project @ 1997-01-31 16:16:53 by jwe]
jwe
parents: 2325
diff changeset
34 usage ("[img, map] = loadimage (filename)");
1024
56520a75b5b3 [project @ 1995-01-11 20:30:04 by jwe]
jwe
parents: 904
diff changeset
35 elseif (! isstr (filename))
56520a75b5b3 [project @ 1995-01-11 20:30:04 by jwe]
jwe
parents: 904
diff changeset
36 error ("loadimage: expecting filename as a string");
686
0faebdd7df57 [project @ 1994-09-09 21:09:24 by jwe]
jwe
parents: 559
diff changeset
37 endif
0faebdd7df57 [project @ 1994-09-09 21:09:24 by jwe]
jwe
parents: 559
diff changeset
38
0faebdd7df57 [project @ 1994-09-09 21:09:24 by jwe]
jwe
parents: 559
diff changeset
39 file = file_in_path (IMAGEPATH, filename);
0faebdd7df57 [project @ 1994-09-09 21:09:24 by jwe]
jwe
parents: 559
diff changeset
40
0faebdd7df57 [project @ 1994-09-09 21:09:24 by jwe]
jwe
parents: 559
diff changeset
41 if (isempty (file))
0faebdd7df57 [project @ 1994-09-09 21:09:24 by jwe]
jwe
parents: 559
diff changeset
42 error ("loadimage: unable to find image file");
0faebdd7df57 [project @ 1994-09-09 21:09:24 by jwe]
jwe
parents: 559
diff changeset
43 endif
0faebdd7df57 [project @ 1994-09-09 21:09:24 by jwe]
jwe
parents: 559
diff changeset
44
2650
64aff25e8be3 [project @ 1997-01-31 16:16:53 by jwe]
jwe
parents: 2325
diff changeset
45 ## The file is assumed to have variables img and map, or X and map.
2325
b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe]
jwe
parents: 2313
diff changeset
46
3400
18366d37e7dd [project @ 1999-12-22 23:36:09 by jwe]
jwe
parents: 3381
diff changeset
47 eval (sprintf ("load %s", file));
559
4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe]
jwe
parents:
diff changeset
48
2650
64aff25e8be3 [project @ 1997-01-31 16:16:53 by jwe]
jwe
parents: 2325
diff changeset
49 if (exist ("img"))
64aff25e8be3 [project @ 1997-01-31 16:16:53 by jwe]
jwe
parents: 2325
diff changeset
50 img_retval = img;
64aff25e8be3 [project @ 1997-01-31 16:16:53 by jwe]
jwe
parents: 2325
diff changeset
51 elseif (exist ("X"))
64aff25e8be3 [project @ 1997-01-31 16:16:53 by jwe]
jwe
parents: 2325
diff changeset
52 img_retval = X;
64aff25e8be3 [project @ 1997-01-31 16:16:53 by jwe]
jwe
parents: 2325
diff changeset
53 else
64aff25e8be3 [project @ 1997-01-31 16:16:53 by jwe]
jwe
parents: 2325
diff changeset
54 error ("loadimage: invalid image file found");
64aff25e8be3 [project @ 1997-01-31 16:16:53 by jwe]
jwe
parents: 2325
diff changeset
55 endif
64aff25e8be3 [project @ 1997-01-31 16:16:53 by jwe]
jwe
parents: 2325
diff changeset
56
64aff25e8be3 [project @ 1997-01-31 16:16:53 by jwe]
jwe
parents: 2325
diff changeset
57 if (exist ("map"))
64aff25e8be3 [project @ 1997-01-31 16:16:53 by jwe]
jwe
parents: 2325
diff changeset
58 map_retval = map;
64aff25e8be3 [project @ 1997-01-31 16:16:53 by jwe]
jwe
parents: 2325
diff changeset
59 else
64aff25e8be3 [project @ 1997-01-31 16:16:53 by jwe]
jwe
parents: 2325
diff changeset
60 error ("loadimage: invalid image file found");
64aff25e8be3 [project @ 1997-01-31 16:16:53 by jwe]
jwe
parents: 2325
diff changeset
61 endif
64aff25e8be3 [project @ 1997-01-31 16:16:53 by jwe]
jwe
parents: 2325
diff changeset
62
559
4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe]
jwe
parents:
diff changeset
63 endfunction