Mercurial > octave-nkf
annotate scripts/image/imwrite.m @ 18539:7b60d0d9f0f2
imwrite.m: Fix bug with numfields introduction in cset fcd87f68af4f.
imwrite.m: Change sense of if test from > 0 to == 0.
author | Rik <rik@octave.org> |
---|---|
date | Mon, 03 Mar 2014 07:07:06 -0800 |
parents | fcd87f68af4f |
children | b83fca22bb4c |
rev | line source |
---|---|
17744
d63878346099
maint: Update copyright notices for release.
John W. Eaton <jwe@octave.org>
parents:
17338
diff
changeset
|
1 ## Copyright (C) 2008-2013 John W. Eaton |
16948
ee2166121a28
imwrite: clean up finding of filename and its connection to imformats.
Carnë Draug <carandraug@octave.org>
parents:
16944
diff
changeset
|
2 ## Copyright (C) 2013 Carnë Draug |
7987 | 3 ## |
4 ## This file is part of Octave. | |
5 ## | |
6 ## Octave is free software; you can redistribute it and/or modify it | |
7 ## under the terms of the GNU General Public License as published by | |
8 ## the Free Software Foundation; either version 3 of the License, or (at | |
9 ## your option) any later version. | |
10 ## | |
11 ## Octave is distributed in the hope that it will be useful, but | |
12 ## WITHOUT ANY WARRANTY; without even the implied warranty of | |
13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
14 ## General Public License for more details. | |
15 ## | |
16 ## You should have received a copy of the GNU General Public License | |
17 ## along with Octave; see the file COPYING. If not, see | |
18 ## <http://www.gnu.org/licenses/>. | |
19 | |
20 ## -*- texinfo -*- | |
10891
ff94219746bd
imwrite.m: Allow writing of 1-bit (B&W) images.
Rik <octave@nomad.inbox5.com>
parents:
10793
diff
changeset
|
21 ## @deftypefn {Function File} {} imwrite (@var{img}, @var{filename}) |
16944
1b3b3ee88284
Add optional extension argument to image IO functions.
Carnë Draug <carandraug@octave.org>
parents:
16916
diff
changeset
|
22 ## @deftypefnx {Function File} {} imwrite (@var{img}, @var{filename}, @var{ext}) |
16988
54b75bed4bc7
imwrite: implement WriteMode option.
Carnë Draug <carandraug@octave.org>
parents:
16948
diff
changeset
|
23 ## @deftypefnx {Function File} {} imwrite (@var{img}, @var{map}, @var{filename}) |
54b75bed4bc7
imwrite: implement WriteMode option.
Carnë Draug <carandraug@octave.org>
parents:
16948
diff
changeset
|
24 ## @deftypefnx {Function File} {} imwrite (@dots{}, @var{param1}, @var{val1}, @dots{}) |
7987 | 25 ## Write images in various file formats. |
26 ## | |
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17086
diff
changeset
|
27 ## The image @var{img} can be a binary, grayscale, RGB, or multi-dimensional |
16988
54b75bed4bc7
imwrite: implement WriteMode option.
Carnë Draug <carandraug@octave.org>
parents:
16948
diff
changeset
|
28 ## image. The size and class of @var{img} should be the same as what should |
54b75bed4bc7
imwrite: implement WriteMode option.
Carnë Draug <carandraug@octave.org>
parents:
16948
diff
changeset
|
29 ## be expected when reading it with @code{imread}: the 3rd and 4th dimensions |
17171
c3bd7314643c
doc: Periodic spellcheck of documentation.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
30 ## reserved for color space, and multiple pages respectively. If it's an |
16988
54b75bed4bc7
imwrite: implement WriteMode option.
Carnë Draug <carandraug@octave.org>
parents:
16948
diff
changeset
|
31 ## indexed image, the colormap @var{map} must also be specified. |
54b75bed4bc7
imwrite: implement WriteMode option.
Carnë Draug <carandraug@octave.org>
parents:
16948
diff
changeset
|
32 ## |
16944
1b3b3ee88284
Add optional extension argument to image IO functions.
Carnë Draug <carandraug@octave.org>
parents:
16916
diff
changeset
|
33 ## If @var{ext} is not supplied, the file extension of @var{filename} is used |
1b3b3ee88284
Add optional extension argument to image IO functions.
Carnë Draug <carandraug@octave.org>
parents:
16916
diff
changeset
|
34 ## to determine the format. The actual supported formats are dependent on |
1b3b3ee88284
Add optional extension argument to image IO functions.
Carnë Draug <carandraug@octave.org>
parents:
16916
diff
changeset
|
35 ## options made during the build of Octave. Use @code{imformats} to check |
1b3b3ee88284
Add optional extension argument to image IO functions.
Carnë Draug <carandraug@octave.org>
parents:
16916
diff
changeset
|
36 ## the support of the different image formats. |
7987 | 37 ## |
16988
54b75bed4bc7
imwrite: implement WriteMode option.
Carnë Draug <carandraug@octave.org>
parents:
16948
diff
changeset
|
38 ## Depending on the file format, it is possible to configure the writing |
54b75bed4bc7
imwrite: implement WriteMode option.
Carnë Draug <carandraug@octave.org>
parents:
16948
diff
changeset
|
39 ## of images with @var{param}, @var{val} pairs. The following options |
54b75bed4bc7
imwrite: implement WriteMode option.
Carnë Draug <carandraug@octave.org>
parents:
16948
diff
changeset
|
40 ## are supported: |
8148 | 41 ## |
42 ## @table @samp | |
17332
eb7e9a991ffb
Implement writing of CMYK and fix writing of image alpha channel (bug #32986).
Carnë Draug <carandraug@octave.org>
parents:
17281
diff
changeset
|
43 ## @item Alpha |
eb7e9a991ffb
Implement writing of CMYK and fix writing of image alpha channel (bug #32986).
Carnë Draug <carandraug@octave.org>
parents:
17281
diff
changeset
|
44 ## Alpha (transparency) channel for the image. This must be a matrix with |
eb7e9a991ffb
Implement writing of CMYK and fix writing of image alpha channel (bug #32986).
Carnë Draug <carandraug@octave.org>
parents:
17281
diff
changeset
|
45 ## same class, and number of rows and columns of @var{img}. In case of a |
eb7e9a991ffb
Implement writing of CMYK and fix writing of image alpha channel (bug #32986).
Carnë Draug <carandraug@octave.org>
parents:
17281
diff
changeset
|
46 ## multipage image, the size of the 4th dimension must also match and the third |
eb7e9a991ffb
Implement writing of CMYK and fix writing of image alpha channel (bug #32986).
Carnë Draug <carandraug@octave.org>
parents:
17281
diff
changeset
|
47 ## dimension must be a singleton. By default, image will be completely |
eb7e9a991ffb
Implement writing of CMYK and fix writing of image alpha channel (bug #32986).
Carnë Draug <carandraug@octave.org>
parents:
17281
diff
changeset
|
48 ## opaque. |
eb7e9a991ffb
Implement writing of CMYK and fix writing of image alpha channel (bug #32986).
Carnë Draug <carandraug@octave.org>
parents:
17281
diff
changeset
|
49 ## |
17854
adb0ba0d0c13
imwrite: implement DelayTime option.
Carnë Draug <carandraug@octave.org>
parents:
17853
diff
changeset
|
50 ## @item DelayTime |
adb0ba0d0c13
imwrite: implement DelayTime option.
Carnë Draug <carandraug@octave.org>
parents:
17853
diff
changeset
|
51 ## For formats that accept animations (such as GIF), controls for how long a |
adb0ba0d0c13
imwrite: implement DelayTime option.
Carnë Draug <carandraug@octave.org>
parents:
17853
diff
changeset
|
52 ## frame is displayed until it moves to the next one. The value must be scalar |
adb0ba0d0c13
imwrite: implement DelayTime option.
Carnë Draug <carandraug@octave.org>
parents:
17853
diff
changeset
|
53 ## (which will applied to all frames in @var{img}), or a vector of length |
adb0ba0d0c13
imwrite: implement DelayTime option.
Carnë Draug <carandraug@octave.org>
parents:
17853
diff
changeset
|
54 ## equal to the number of frames in @var{im}. The value is in seconds, must |
adb0ba0d0c13
imwrite: implement DelayTime option.
Carnë Draug <carandraug@octave.org>
parents:
17853
diff
changeset
|
55 ## be between 0 and 655.35, and defaults to 0.5. |
adb0ba0d0c13
imwrite: implement DelayTime option.
Carnë Draug <carandraug@octave.org>
parents:
17853
diff
changeset
|
56 ## |
17855
bfbe5dcc9943
imwrite: implement DisposalMethod option.
Carnë Draug <carandraug@octave.org>
parents:
17854
diff
changeset
|
57 ## @item DisposalMethod |
bfbe5dcc9943
imwrite: implement DisposalMethod option.
Carnë Draug <carandraug@octave.org>
parents:
17854
diff
changeset
|
58 ## For formats that accept animations (such as GIF), controls what happens |
bfbe5dcc9943
imwrite: implement DisposalMethod option.
Carnë Draug <carandraug@octave.org>
parents:
17854
diff
changeset
|
59 ## to a frame before drawing the next one. Its value can be one of the |
bfbe5dcc9943
imwrite: implement DisposalMethod option.
Carnë Draug <carandraug@octave.org>
parents:
17854
diff
changeset
|
60 ## following strings: "doNotSpecify" (default); "leaveInPlace"; "restoreBG"; |
bfbe5dcc9943
imwrite: implement DisposalMethod option.
Carnë Draug <carandraug@octave.org>
parents:
17854
diff
changeset
|
61 ## and "restorePrevious", or a cell array of those string with length equal |
bfbe5dcc9943
imwrite: implement DisposalMethod option.
Carnë Draug <carandraug@octave.org>
parents:
17854
diff
changeset
|
62 ## to the number of frames in @var{img}. |
bfbe5dcc9943
imwrite: implement DisposalMethod option.
Carnë Draug <carandraug@octave.org>
parents:
17854
diff
changeset
|
63 ## |
17853
aacb9da13df6
imwrite: implement LoopCount option.
Carnë Draug <carandraug@octave.org>
parents:
17744
diff
changeset
|
64 ## @item LoopCount |
aacb9da13df6
imwrite: implement LoopCount option.
Carnë Draug <carandraug@octave.org>
parents:
17744
diff
changeset
|
65 ## For formats that accept animations (such as GIF), controls how many times |
aacb9da13df6
imwrite: implement LoopCount option.
Carnë Draug <carandraug@octave.org>
parents:
17744
diff
changeset
|
66 ## the sequence is repeated. A value of Inf means an infinite loop (default), |
aacb9da13df6
imwrite: implement LoopCount option.
Carnë Draug <carandraug@octave.org>
parents:
17744
diff
changeset
|
67 ## a value of 0 or 1 that the sequence is played only once (loops zero times), |
aacb9da13df6
imwrite: implement LoopCount option.
Carnë Draug <carandraug@octave.org>
parents:
17744
diff
changeset
|
68 ## while a value of 2 or above loops that number of times (looping twice means |
aacb9da13df6
imwrite: implement LoopCount option.
Carnë Draug <carandraug@octave.org>
parents:
17744
diff
changeset
|
69 ## it plays the complete sequence 3 times). This option is ignored when there |
aacb9da13df6
imwrite: implement LoopCount option.
Carnë Draug <carandraug@octave.org>
parents:
17744
diff
changeset
|
70 ## is only a single image at the end of writing the file. |
aacb9da13df6
imwrite: implement LoopCount option.
Carnë Draug <carandraug@octave.org>
parents:
17744
diff
changeset
|
71 ## |
8148 | 72 ## @item Quality |
10891
ff94219746bd
imwrite.m: Allow writing of 1-bit (B&W) images.
Rik <octave@nomad.inbox5.com>
parents:
10793
diff
changeset
|
73 ## Set the quality of the compression. The value should be an |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
74 ## integer between 0 and 100, with larger values indicating higher visual |
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17086
diff
changeset
|
75 ## quality and lower compression. Defaults to 75. |
16988
54b75bed4bc7
imwrite: implement WriteMode option.
Carnë Draug <carandraug@octave.org>
parents:
16948
diff
changeset
|
76 ## |
54b75bed4bc7
imwrite: implement WriteMode option.
Carnë Draug <carandraug@octave.org>
parents:
16948
diff
changeset
|
77 ## @item WriteMode |
54b75bed4bc7
imwrite: implement WriteMode option.
Carnë Draug <carandraug@octave.org>
parents:
16948
diff
changeset
|
78 ## Some file formats, such as TIFF and GIF, are able to store multiple |
54b75bed4bc7
imwrite: implement WriteMode option.
Carnë Draug <carandraug@octave.org>
parents:
16948
diff
changeset
|
79 ## images in a single file. This option specifies if @var{img} should be |
54b75bed4bc7
imwrite: implement WriteMode option.
Carnë Draug <carandraug@octave.org>
parents:
16948
diff
changeset
|
80 ## appended to the file (if it exists) or if a new file should be created |
54b75bed4bc7
imwrite: implement WriteMode option.
Carnë Draug <carandraug@octave.org>
parents:
16948
diff
changeset
|
81 ## for it (possibly overwriting an existing file). The value should be |
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17267
diff
changeset
|
82 ## the string @qcode{"Overwrite"} (default), or @qcode{"Append"}. |
16988
54b75bed4bc7
imwrite: implement WriteMode option.
Carnë Draug <carandraug@octave.org>
parents:
16948
diff
changeset
|
83 ## |
54b75bed4bc7
imwrite: implement WriteMode option.
Carnë Draug <carandraug@octave.org>
parents:
16948
diff
changeset
|
84 ## Despite this option, the most efficient method of writing a multipage |
54b75bed4bc7
imwrite: implement WriteMode option.
Carnë Draug <carandraug@octave.org>
parents:
16948
diff
changeset
|
85 ## image is to pass a 4 dimensional @var{img} to @code{imwrite}, the |
54b75bed4bc7
imwrite: implement WriteMode option.
Carnë Draug <carandraug@octave.org>
parents:
16948
diff
changeset
|
86 ## same matrix that could be expected when using @code{imread} with the |
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17267
diff
changeset
|
87 ## option @qcode{"Index"} set to @qcode{"all"}. |
16988
54b75bed4bc7
imwrite: implement WriteMode option.
Carnë Draug <carandraug@octave.org>
parents:
16948
diff
changeset
|
88 ## |
8148 | 89 ## @end table |
90 ## | |
16944
1b3b3ee88284
Add optional extension argument to image IO functions.
Carnë Draug <carandraug@octave.org>
parents:
16916
diff
changeset
|
91 ## @seealso{imread, imfinfo, imformats} |
7987 | 92 ## @end deftypefn |
93 | |
16916
59f575e504dc
Connect imwrite with imformats.
Carnë Draug <carandraug@octave.org>
parents:
15714
diff
changeset
|
94 function imwrite (varargin) |
59f575e504dc
Connect imwrite with imformats.
Carnë Draug <carandraug@octave.org>
parents:
15714
diff
changeset
|
95 if (nargin < 2) |
10891
ff94219746bd
imwrite.m: Allow writing of 1-bit (B&W) images.
Rik <octave@nomad.inbox5.com>
parents:
10793
diff
changeset
|
96 print_usage (); |
ff94219746bd
imwrite.m: Allow writing of 1-bit (B&W) images.
Rik <octave@nomad.inbox5.com>
parents:
10793
diff
changeset
|
97 endif |
16948
ee2166121a28
imwrite: clean up finding of filename and its connection to imformats.
Carnë Draug <carandraug@octave.org>
parents:
16944
diff
changeset
|
98 [filename, ext] = imwrite_filename (varargin{2:end}); |
10891
ff94219746bd
imwrite.m: Allow writing of 1-bit (B&W) images.
Rik <octave@nomad.inbox5.com>
parents:
10793
diff
changeset
|
99 |
16948
ee2166121a28
imwrite: clean up finding of filename and its connection to imformats.
Carnë Draug <carandraug@octave.org>
parents:
16944
diff
changeset
|
100 fmt = imformats (ext); |
ee2166121a28
imwrite: clean up finding of filename and its connection to imformats.
Carnë Draug <carandraug@octave.org>
parents:
16944
diff
changeset
|
101 ## When there is no match, fmt will be a 1x1 structure with |
ee2166121a28
imwrite: clean up finding of filename and its connection to imformats.
Carnë Draug <carandraug@octave.org>
parents:
16944
diff
changeset
|
102 ## no fields, so we can't just use `isempty (fmt)'. |
18539
7b60d0d9f0f2
imwrite.m: Fix bug with numfields introduction in cset fcd87f68af4f.
Rik <rik@octave.org>
parents:
18538
diff
changeset
|
103 if (numfields (fmt) == 0) |
16948
ee2166121a28
imwrite: clean up finding of filename and its connection to imformats.
Carnë Draug <carandraug@octave.org>
parents:
16944
diff
changeset
|
104 if (isempty (ext)) |
ee2166121a28
imwrite: clean up finding of filename and its connection to imformats.
Carnë Draug <carandraug@octave.org>
parents:
16944
diff
changeset
|
105 error ("imwrite: no extension found for %s to identify the image format", |
ee2166121a28
imwrite: clean up finding of filename and its connection to imformats.
Carnë Draug <carandraug@octave.org>
parents:
16944
diff
changeset
|
106 filename); |
ee2166121a28
imwrite: clean up finding of filename and its connection to imformats.
Carnë Draug <carandraug@octave.org>
parents:
16944
diff
changeset
|
107 endif |
ee2166121a28
imwrite: clean up finding of filename and its connection to imformats.
Carnë Draug <carandraug@octave.org>
parents:
16944
diff
changeset
|
108 warning ("imwrite: unlisted image format %s (see imformats). Trying to save anyway.", |
ee2166121a28
imwrite: clean up finding of filename and its connection to imformats.
Carnë Draug <carandraug@octave.org>
parents:
16944
diff
changeset
|
109 ext); |
17086
3db796f89695
Rename private core_imfnc functions to follow the __fnc__ convention style.
Carnë Draug <carandraug@octave.org>
parents:
16988
diff
changeset
|
110 __imwrite__ (varargin{:}); |
7987 | 111 else |
16948
ee2166121a28
imwrite: clean up finding of filename and its connection to imformats.
Carnë Draug <carandraug@octave.org>
parents:
16944
diff
changeset
|
112 fmt.write (varargin{:}); |
16944
1b3b3ee88284
Add optional extension argument to image IO functions.
Carnë Draug <carandraug@octave.org>
parents:
16916
diff
changeset
|
113 endif |
7987 | 114 |
115 endfunction | |
10891
ff94219746bd
imwrite.m: Allow writing of 1-bit (B&W) images.
Rik <octave@nomad.inbox5.com>
parents:
10793
diff
changeset
|
116 |
17338
1c89599167a6
maint: End m-files with 1 blank line.
Rik <rik@octave.org>
parents:
17332
diff
changeset
|
117 |
10891
ff94219746bd
imwrite.m: Allow writing of 1-bit (B&W) images.
Rik <octave@nomad.inbox5.com>
parents:
10793
diff
changeset
|
118 %% Test input validation |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
119 %!error imwrite () # Wrong # of args |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
120 %!error imwrite (1) # Wrong # of args |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
121 %!error imwrite ({"cell"}, "filename.jpg") # Wrong class for img |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
122 %!error imwrite (1, [], "filename.jpg") # Empty image map |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
123 %!error imwrite (1, 2, 3) # No filename specified |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
124 %!error imwrite (1, "filename") # No fmt specified |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
125 %!error imwrite (1, "filename", "junk") # Invalid fmt specified |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
126 %!error imwrite ([], "filename.jpg") # Empty img matrix |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
127 %!error imwrite (spones (2), "filename.jpg") # Invalid sparse img |
10891
ff94219746bd
imwrite.m: Allow writing of 1-bit (B&W) images.
Rik <octave@nomad.inbox5.com>
parents:
10793
diff
changeset
|
128 |
17267
27800ef1f7d2
imwrite: add simple test for actual successfully writing
Carnë Draug <carandraug@octave.org>
parents:
17171
diff
changeset
|
129 %!testif HAVE_MAGICK |
27800ef1f7d2
imwrite: add simple test for actual successfully writing
Carnë Draug <carandraug@octave.org>
parents:
17171
diff
changeset
|
130 %! imw = randi (255, 100, "uint8"); |
27800ef1f7d2
imwrite: add simple test for actual successfully writing
Carnë Draug <carandraug@octave.org>
parents:
17171
diff
changeset
|
131 %! filename = [tmpnam() ".png"]; |
27800ef1f7d2
imwrite: add simple test for actual successfully writing
Carnë Draug <carandraug@octave.org>
parents:
17171
diff
changeset
|
132 %! unwind_protect |
27800ef1f7d2
imwrite: add simple test for actual successfully writing
Carnë Draug <carandraug@octave.org>
parents:
17171
diff
changeset
|
133 %! imwrite (imw, filename); |
27800ef1f7d2
imwrite: add simple test for actual successfully writing
Carnë Draug <carandraug@octave.org>
parents:
17171
diff
changeset
|
134 %! imr = imread (filename); |
27800ef1f7d2
imwrite: add simple test for actual successfully writing
Carnë Draug <carandraug@octave.org>
parents:
17171
diff
changeset
|
135 %! unwind_protect_cleanup |
27800ef1f7d2
imwrite: add simple test for actual successfully writing
Carnë Draug <carandraug@octave.org>
parents:
17171
diff
changeset
|
136 %! unlink (filename); |
27800ef1f7d2
imwrite: add simple test for actual successfully writing
Carnë Draug <carandraug@octave.org>
parents:
17171
diff
changeset
|
137 %! end_unwind_protect |
27800ef1f7d2
imwrite: add simple test for actual successfully writing
Carnë Draug <carandraug@octave.org>
parents:
17171
diff
changeset
|
138 %! assert (imw, imr) |
17338
1c89599167a6
maint: End m-files with 1 blank line.
Rik <rik@octave.org>
parents:
17332
diff
changeset
|
139 |