annotate scripts/image/loadimage.m @ 2847:8b262e771614

[project @ 1997-03-27 16:18:26 by jwe]
author jwe
date Thu, 27 Mar 1997 16:19:58 +0000
parents 64aff25e8be3
children 44d82b369c78
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
2311
2b5788792cad [project @ 1996-07-11 20:18:38 by jwe]
jwe
parents: 2303
diff changeset
20 ## Load an image file.
2b5788792cad [project @ 1996-07-11 20:18:38 by jwe]
jwe
parents: 2303
diff changeset
21 ##
2650
64aff25e8be3 [project @ 1997-01-31 16:16:53 by jwe]
jwe
parents: 2325
diff changeset
22 ## [img, map] = loadimage (img_file) loads an image and it's associated
2311
2b5788792cad [project @ 1996-07-11 20:18:38 by jwe]
jwe
parents: 2303
diff changeset
23 ## color map from file img_file. The image must be in stored in
2b5788792cad [project @ 1996-07-11 20:18:38 by jwe]
jwe
parents: 2303
diff changeset
24 ## octave's image format.
2b5788792cad [project @ 1996-07-11 20:18:38 by jwe]
jwe
parents: 2303
diff changeset
25 ##
2b5788792cad [project @ 1996-07-11 20:18:38 by jwe]
jwe
parents: 2303
diff changeset
26 ## SEE ALSO: saveimage, load, save
904
3470f1e25a79 [project @ 1994-11-09 21:22:15 by jwe]
jwe
parents: 686
diff changeset
27
2312
204cc7db6f4a [project @ 1996-07-11 21:20:36 by jwe]
jwe
parents: 2311
diff changeset
28 ## Author: Tony Richardson <amr@mpl.ucsd.edu>
204cc7db6f4a [project @ 1996-07-11 21:20:36 by jwe]
jwe
parents: 2311
diff changeset
29 ## Created: July 1994
204cc7db6f4a [project @ 1996-07-11 21:20:36 by jwe]
jwe
parents: 2311
diff changeset
30 ## Adapted-By: jwe
559
4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe]
jwe
parents:
diff changeset
31
2650
64aff25e8be3 [project @ 1997-01-31 16:16:53 by jwe]
jwe
parents: 2325
diff changeset
32 function [img_retval, map_retval] = loadimage (filename)
1024
56520a75b5b3 [project @ 1995-01-11 20:30:04 by jwe]
jwe
parents: 904
diff changeset
33
56520a75b5b3 [project @ 1995-01-11 20:30:04 by jwe]
jwe
parents: 904
diff changeset
34 if (nargin != 1)
2650
64aff25e8be3 [project @ 1997-01-31 16:16:53 by jwe]
jwe
parents: 2325
diff changeset
35 usage ("[img, map] = loadimage (filename)");
1024
56520a75b5b3 [project @ 1995-01-11 20:30:04 by jwe]
jwe
parents: 904
diff changeset
36 elseif (! isstr (filename))
56520a75b5b3 [project @ 1995-01-11 20:30:04 by jwe]
jwe
parents: 904
diff changeset
37 error ("loadimage: expecting filename as a string");
686
0faebdd7df57 [project @ 1994-09-09 21:09:24 by jwe]
jwe
parents: 559
diff changeset
38 endif
0faebdd7df57 [project @ 1994-09-09 21:09:24 by jwe]
jwe
parents: 559
diff changeset
39
0faebdd7df57 [project @ 1994-09-09 21:09:24 by jwe]
jwe
parents: 559
diff changeset
40 file = file_in_path (IMAGEPATH, filename);
0faebdd7df57 [project @ 1994-09-09 21:09:24 by jwe]
jwe
parents: 559
diff changeset
41
0faebdd7df57 [project @ 1994-09-09 21:09:24 by jwe]
jwe
parents: 559
diff changeset
42 if (isempty (file))
0faebdd7df57 [project @ 1994-09-09 21:09:24 by jwe]
jwe
parents: 559
diff changeset
43 error ("loadimage: unable to find image file");
0faebdd7df57 [project @ 1994-09-09 21:09:24 by jwe]
jwe
parents: 559
diff changeset
44 endif
0faebdd7df57 [project @ 1994-09-09 21:09:24 by jwe]
jwe
parents: 559
diff changeset
45
2650
64aff25e8be3 [project @ 1997-01-31 16:16:53 by jwe]
jwe
parents: 2325
diff changeset
46 ## 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
47
1024
56520a75b5b3 [project @ 1995-01-11 20:30:04 by jwe]
jwe
parents: 904
diff changeset
48 eval (['load ', file]);
559
4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe]
jwe
parents:
diff changeset
49
2650
64aff25e8be3 [project @ 1997-01-31 16:16:53 by jwe]
jwe
parents: 2325
diff changeset
50 if (exist ("img"))
64aff25e8be3 [project @ 1997-01-31 16:16:53 by jwe]
jwe
parents: 2325
diff changeset
51 img_retval = img;
64aff25e8be3 [project @ 1997-01-31 16:16:53 by jwe]
jwe
parents: 2325
diff changeset
52 elseif (exist ("X"))
64aff25e8be3 [project @ 1997-01-31 16:16:53 by jwe]
jwe
parents: 2325
diff changeset
53 img_retval = X;
64aff25e8be3 [project @ 1997-01-31 16:16:53 by jwe]
jwe
parents: 2325
diff changeset
54 else
64aff25e8be3 [project @ 1997-01-31 16:16:53 by jwe]
jwe
parents: 2325
diff changeset
55 error ("loadimage: invalid image file found");
64aff25e8be3 [project @ 1997-01-31 16:16:53 by jwe]
jwe
parents: 2325
diff changeset
56 endif
64aff25e8be3 [project @ 1997-01-31 16:16:53 by jwe]
jwe
parents: 2325
diff changeset
57
64aff25e8be3 [project @ 1997-01-31 16:16:53 by jwe]
jwe
parents: 2325
diff changeset
58 if (exist ("map"))
64aff25e8be3 [project @ 1997-01-31 16:16:53 by jwe]
jwe
parents: 2325
diff changeset
59 map_retval = map;
64aff25e8be3 [project @ 1997-01-31 16:16:53 by jwe]
jwe
parents: 2325
diff changeset
60 else
64aff25e8be3 [project @ 1997-01-31 16:16:53 by jwe]
jwe
parents: 2325
diff changeset
61 error ("loadimage: invalid image file found");
64aff25e8be3 [project @ 1997-01-31 16:16:53 by jwe]
jwe
parents: 2325
diff changeset
62 endif
64aff25e8be3 [project @ 1997-01-31 16:16:53 by jwe]
jwe
parents: 2325
diff changeset
63
559
4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe]
jwe
parents:
diff changeset
64 endfunction