octave-libtiff: scripts/image/imwrite.m annotate

annotate scripts/image/imwrite.m @ 31211:edbd725ee76c

imwrite: fixed tests to reflect alpha channel behavior for Tiff images * scripts/image/imwrite.m: modified tests to correctly handled the new behavior for alpha channel in Tiff images. * scripts/image/imread.m: added a note in the function documentation about the alpha channel behavior for Tiff images.

author	magedrifaat <magedrifaat@gmail.com>
date	Tue, 06 Sep 2022 21:12:29 +0200
parents	796f54d4ddbf
children

rev	line source
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	1 ########################################################################
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	2 ##
30564 796f54d4ddbf update Octave Project Developers copyright for the new year John W. Eaton <jwe@octave.org> parents: 29359 diff changeset	3 ## Copyright (C) 2008-2022 The Octave Project Developers
27918 b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 27216 diff changeset	4 ##
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	5 ## See the file COPYRIGHT.md in the top-level directory of this
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	6 ## distribution or <https://octave.org/copyright/>.
7987 4a423a042971 add imwrite.m John W. Eaton <jwe@octave.org> parents: diff changeset	7 ##
4a423a042971 add imwrite.m John W. Eaton <jwe@octave.org> parents: diff changeset	8 ## This file is part of Octave.
4a423a042971 add imwrite.m John W. Eaton <jwe@octave.org> parents: diff changeset	9 ##
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23573 diff changeset	10 ## Octave is free software: you can redistribute it and/or modify it
7987 4a423a042971 add imwrite.m John W. Eaton <jwe@octave.org> parents: diff changeset	11 ## under the terms of the GNU General Public License as published by
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23573 diff changeset	12 ## the Free Software Foundation, either version 3 of the License, or
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22489 diff changeset	13 ## (at your option) any later version.
7987 4a423a042971 add imwrite.m John W. Eaton <jwe@octave.org> parents: diff changeset	14 ##
4a423a042971 add imwrite.m John W. Eaton <jwe@octave.org> parents: diff changeset	15 ## Octave is distributed in the hope that it will be useful, but
4a423a042971 add imwrite.m John W. Eaton <jwe@octave.org> parents: diff changeset	16 ## WITHOUT ANY WARRANTY; without even the implied warranty of
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22489 diff changeset	17 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22489 diff changeset	18 ## GNU General Public License for more details.
7987 4a423a042971 add imwrite.m John W. Eaton <jwe@octave.org> parents: diff changeset	19 ##
4a423a042971 add imwrite.m John W. Eaton <jwe@octave.org> parents: diff changeset	20 ## You should have received a copy of the GNU General Public License
4a423a042971 add imwrite.m John W. Eaton <jwe@octave.org> parents: diff changeset	21 ## along with Octave; see the file COPYING. If not, see
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23573 diff changeset	22 ## <https://www.gnu.org/licenses/>.
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	23 ##
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	24 ########################################################################
7987 4a423a042971 add imwrite.m John W. Eaton <jwe@octave.org> parents: diff changeset	25
4a423a042971 add imwrite.m John W. Eaton <jwe@octave.org> parents: diff changeset	26 ## -- texinfo --
20852 516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 20719 diff changeset	27 ## @deftypefn {} {} imwrite (@var{img}, @var{filename})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 20719 diff changeset	28 ## @deftypefnx {} {} imwrite (@var{img}, @var{filename}, @var{ext})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 20719 diff changeset	29 ## @deftypefnx {} {} imwrite (@var{img}, @var{map}, @var{filename})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 20719 diff changeset	30 ## @deftypefnx {} {} imwrite (@dots{}, @var{param1}, @var{val1}, @dots{})
7987 4a423a042971 add imwrite.m John W. Eaton <jwe@octave.org> parents: diff changeset	31 ## Write images in various file formats.
4a423a042971 add imwrite.m John W. Eaton <jwe@octave.org> parents: diff changeset	32 ##
17170 d6499c14021c doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 17086 diff changeset	33 ## 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	34 ## 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	35 ## 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	36 ## 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	37 ## indexed image, the colormap @var{map} must also be specified.
54b75bed4bc7 imwrite: implement WriteMode option. Carnë Draug <carandraug@octave.org> parents: 16948 diff changeset	38 ##
16944 1b3b3ee88284 Add optional extension argument to image IO functions. Carnë Draug <carandraug@octave.org> parents: 16916 diff changeset	39 ## 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	40 ## 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	41 ## 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	42 ## the support of the different image formats.
7987 4a423a042971 add imwrite.m John W. Eaton <jwe@octave.org> parents: diff changeset	43 ##
20158 7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	44 ## Depending on the file format, it is possible to configure the writing of
7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	45 ## images with @var{param}, @var{val} pairs. The following options are
7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	46 ## supported:
8148 213dd524f96b Improve documentation for image I/O. sh@sh-laptop parents: 8054 diff changeset	47 ##
213dd524f96b Improve documentation for image I/O. sh@sh-laptop parents: 8054 diff changeset	48 ## @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	49 ## @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	50 ## 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	51 ## 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	52 ## multipage image, the size of the 4th dimension must also match and the third
20158 7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	53 ## dimension must be a singleton. By default, image will be completely opaque.
17332 eb7e9a991ffb Implement writing of CMYK and fix writing of image alpha channel (bug #32986). Carnë Draug <carandraug@octave.org> parents: 17281 diff changeset	54 ##
20406 5b8e4f668c53 Add compression option to imwrite and default to "none" (bug #45565) Carnë Draug <carandraug@octave.org> parents: 20158 diff changeset	55 ## @item Compression
5b8e4f668c53 Add compression option to imwrite and default to "none" (bug #45565) Carnë Draug <carandraug@octave.org> parents: 20158 diff changeset	56 ## Compression to use one the image. Can be one of the following: "none"
5b8e4f668c53 Add compression option to imwrite and default to "none" (bug #45565) Carnë Draug <carandraug@octave.org> parents: 20158 diff changeset	57 ## (default), "bzip", "fax3", "fax4", "jpeg", "lzw", "rle", or "deflate".
5b8e4f668c53 Add compression option to imwrite and default to "none" (bug #45565) Carnë Draug <carandraug@octave.org> parents: 20158 diff changeset	58 ## Note that not all compression types are available for all image formats
20719 d903cccb8de8 doc: Periodic spellcheck of documentation. Rik <rik@octave.org> parents: 20406 diff changeset	59 ## in which it defaults to your @nospell{Magick} library.
20406 5b8e4f668c53 Add compression option to imwrite and default to "none" (bug #45565) Carnë Draug <carandraug@octave.org> parents: 20158 diff changeset	60 ##
17854 adb0ba0d0c13 imwrite: implement DelayTime option. Carnë Draug <carandraug@octave.org> parents: 17853 diff changeset	61 ## @item DelayTime
adb0ba0d0c13 imwrite: implement DelayTime option. Carnë Draug <carandraug@octave.org> parents: 17853 diff changeset	62 ## For formats that accept animations (such as GIF), controls for how long a
18815 19a140e93b1f doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 18552 diff changeset	63 ## frame is displayed until it moves to the next one. The value must be scalar
17854 adb0ba0d0c13 imwrite: implement DelayTime option. Carnë Draug <carandraug@octave.org> parents: 17853 diff changeset	64 ## (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	65 ## 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	66 ## 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	67 ##
17855 bfbe5dcc9943 imwrite: implement DisposalMethod option. Carnë Draug <carandraug@octave.org> parents: 17854 diff changeset	68 ## @item DisposalMethod
20158 7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	69 ## For formats that accept animations (such as GIF), controls what happens to
7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	70 ## a frame before drawing the next one. Its value can be one of the
17855 bfbe5dcc9943 imwrite: implement DisposalMethod option. Carnë Draug <carandraug@octave.org> parents: 17854 diff changeset	71 ## following strings: "doNotSpecify" (default); "leaveInPlace"; "restoreBG";
bfbe5dcc9943 imwrite: implement DisposalMethod option. Carnë Draug <carandraug@octave.org> parents: 17854 diff changeset	72 ## 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	73 ## to the number of frames in @var{img}.
bfbe5dcc9943 imwrite: implement DisposalMethod option. Carnë Draug <carandraug@octave.org> parents: 17854 diff changeset	74 ##
17853 aacb9da13df6 imwrite: implement LoopCount option. Carnë Draug <carandraug@octave.org> parents: 17744 diff changeset	75 ## @item LoopCount
aacb9da13df6 imwrite: implement LoopCount option. Carnë Draug <carandraug@octave.org> parents: 17744 diff changeset	76 ## 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	77 ## 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	78 ## 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	79 ## 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	80 ## 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	81 ## 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	82 ##
8148 213dd524f96b Improve documentation for image I/O. sh@sh-laptop parents: 8054 diff changeset	83 ## @item Quality
20158 7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	84 ## Set the quality of the compression. The value should be an integer
7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	85 ## between 0 and 100, with larger values indicating higher visual quality and
7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	86 ## lower compression. Defaults to 75.
16988 54b75bed4bc7 imwrite: implement WriteMode option. Carnë Draug <carandraug@octave.org> parents: 16948 diff changeset	87 ##
54b75bed4bc7 imwrite: implement WriteMode option. Carnë Draug <carandraug@octave.org> parents: 16948 diff changeset	88 ## @item WriteMode
20158 7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	89 ## Some file formats, such as TIFF and GIF, are able to store multiple images
7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	90 ## in a single file. This option specifies if @var{img} should be appended
7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	91 ## to the file (if it exists) or if a new file should be created for it
7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	92 ## (possibly overwriting an existing file). The value should be the string
7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	93 ## @qcode{"Overwrite"} (default), or @qcode{"Append"}.
16988 54b75bed4bc7 imwrite: implement WriteMode option. Carnë Draug <carandraug@octave.org> parents: 16948 diff changeset	94 ##
54b75bed4bc7 imwrite: implement WriteMode option. Carnë Draug <carandraug@octave.org> parents: 16948 diff changeset	95 ## Despite this option, the most efficient method of writing a multipage
20158 7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	96 ## image is to pass a 4 dimensional @var{img} to @code{imwrite}, the same
7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	97 ## matrix that could be expected when using @code{imread} with the option
7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	98 ## @qcode{"Index"} set to @qcode{"all"}.
16988 54b75bed4bc7 imwrite: implement WriteMode option. Carnë Draug <carandraug@octave.org> parents: 16948 diff changeset	99 ##
8148 213dd524f96b Improve documentation for image I/O. sh@sh-laptop parents: 8054 diff changeset	100 ## @end table
213dd524f96b Improve documentation for image I/O. sh@sh-laptop parents: 8054 diff changeset	101 ##
16944 1b3b3ee88284 Add optional extension argument to image IO functions. Carnë Draug <carandraug@octave.org> parents: 16916 diff changeset	102 ## @seealso{imread, imfinfo, imformats}
7987 4a423a042971 add imwrite.m John W. Eaton <jwe@octave.org> parents: diff changeset	103 ## @end deftypefn
4a423a042971 add imwrite.m John W. Eaton <jwe@octave.org> parents: diff changeset	104
16916 59f575e504dc Connect imwrite with imformats. Carnë Draug <carandraug@octave.org> parents: 15714 diff changeset	105 function imwrite (varargin)
21758 ffad2baa90f7 maint: Use newlines to make code more readable. Rik <rik@octave.org> parents: 21751 diff changeset	106
16916 59f575e504dc Connect imwrite with imformats. Carnë Draug <carandraug@octave.org> parents: 15714 diff changeset	107 if (nargin < 2)
10891 ff94219746bd imwrite.m: Allow writing of 1-bit (B&W) images. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	108 print_usage ();
ff94219746bd imwrite.m: Allow writing of 1-bit (B&W) images. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	109 endif
21758 ffad2baa90f7 maint: Use newlines to make code more readable. Rik <rik@octave.org> parents: 21751 diff changeset	110
16948 ee2166121a28 imwrite: clean up finding of filename and its connection to imformats. Carnë Draug <carandraug@octave.org> parents: 16944 diff changeset	111 [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	112
16948 ee2166121a28 imwrite: clean up finding of filename and its connection to imformats. Carnë Draug <carandraug@octave.org> parents: 16944 diff changeset	113 fmt = imformats (ext);
ee2166121a28 imwrite: clean up finding of filename and its connection to imformats. Carnë Draug <carandraug@octave.org> parents: 16944 diff changeset	114 ## When there is no match, fmt will be a 1x1 structure with
27216 823b4bcf79fc unless necessary for formatting or code, use ' instead of ` John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	115 ## 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	116 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	117 if (isempty (ext))
ee2166121a28 imwrite: clean up finding of filename and its connection to imformats. Carnë Draug <carandraug@octave.org> parents: 16944 diff changeset	118 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	119 filename);
ee2166121a28 imwrite: clean up finding of filename and its connection to imformats. Carnë Draug <carandraug@octave.org> parents: 16944 diff changeset	120 endif
21751 b571fc85953f maint: Use two spaces after period to indicate sentence break. Rik <rik@octave.org> parents: 21580 diff changeset	121 warning ("imwrite: unlisted image format %s (see imformats). Trying to save anyway.",
16948 ee2166121a28 imwrite: clean up finding of filename and its connection to imformats. Carnë Draug <carandraug@octave.org> parents: 16944 diff changeset	122 ext);
17086 3db796f89695 Rename private core_imfnc functions to follow the __fnc__ convention style. Carnë Draug <carandraug@octave.org> parents: 16988 diff changeset	123 __imwrite__ (varargin{:});
7987 4a423a042971 add imwrite.m John W. Eaton <jwe@octave.org> parents: diff changeset	124 else
16948 ee2166121a28 imwrite: clean up finding of filename and its connection to imformats. Carnë Draug <carandraug@octave.org> parents: 16944 diff changeset	125 fmt.write (varargin{:});
16944 1b3b3ee88284 Add optional extension argument to image IO functions. Carnë Draug <carandraug@octave.org> parents: 16916 diff changeset	126 endif
7987 4a423a042971 add imwrite.m John W. Eaton <jwe@octave.org> parents: diff changeset	127
4a423a042971 add imwrite.m John W. Eaton <jwe@octave.org> parents: diff changeset	128 endfunction
10891 ff94219746bd imwrite.m: Allow writing of 1-bit (B&W) images. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	129
21758 ffad2baa90f7 maint: Use newlines to make code more readable. Rik <rik@octave.org> parents: 21751 diff changeset	130
19833 9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions. Rik <rik@octave.org> parents: 19697 diff changeset	131 ## Test input validation
28896 90fea9cc9caa test: Add expected error message <Invalid call> to BIST tests for nargin. Rik <rik@octave.org> parents: 27923 diff changeset	132 %!error <Invalid call> imwrite () # Wrong # of args
90fea9cc9caa test: Add expected error message <Invalid call> to BIST tests for nargin. Rik <rik@octave.org> parents: 27923 diff changeset	133 %!error <Invalid call> imwrite (1) # Wrong # of args
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	134 %!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	135 %!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	136 %!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	137 %!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	138 %!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	139 %!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	140 %!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	141
19695 a4f6fbd1af77 imwrite: add tests for jpeg writing (bugs #41673, #44118, #42474) Carnë Draug <carandraug@octave.org> parents: 19278 diff changeset	142 %!function [r, cmap, a] = write_and_read (format, varargin)
a4f6fbd1af77 imwrite: add tests for jpeg writing (bugs #41673, #44118, #42474) Carnë Draug <carandraug@octave.org> parents: 19278 diff changeset	143 %! filename = [tempname() format];
18543 0bfbfb05b158 imwrite.m: simplify test blocks by make use of shared %!function. Carnë Draug <carandraug@octave.org> parents: 18542 diff changeset	144 %! unwind_protect
0bfbfb05b158 imwrite.m: simplify test blocks by make use of shared %!function. Carnë Draug <carandraug@octave.org> parents: 18542 diff changeset	145 %! imwrite (varargin{1}, filename, varargin{2:end});
0bfbfb05b158 imwrite.m: simplify test blocks by make use of shared %!function. Carnë Draug <carandraug@octave.org> parents: 18542 diff changeset	146 %! [r, cmap, a] = imread (filename, "Index", "all");
0bfbfb05b158 imwrite.m: simplify test blocks by make use of shared %!function. Carnë Draug <carandraug@octave.org> parents: 18542 diff changeset	147 %! unwind_protect_cleanup
0bfbfb05b158 imwrite.m: simplify test blocks by make use of shared %!function. Carnë Draug <carandraug@octave.org> parents: 18542 diff changeset	148 %! unlink (filename);
0bfbfb05b158 imwrite.m: simplify test blocks by make use of shared %!function. Carnë Draug <carandraug@octave.org> parents: 18542 diff changeset	149 %! end_unwind_protect
0bfbfb05b158 imwrite.m: simplify test blocks by make use of shared %!function. Carnë Draug <carandraug@octave.org> parents: 18542 diff changeset	150 %!endfunction
17338 1c89599167a6 maint: End m-files with 1 blank line. Rik <rik@octave.org> parents: 17332 diff changeset	151
18543 0bfbfb05b158 imwrite.m: simplify test blocks by make use of shared %!function. Carnë Draug <carandraug@octave.org> parents: 18542 diff changeset	152 ## typical usage with grayscale uint8 images
18542 30aa4e85f8d5 Fix writing and reading of multipage images. Carnë Draug <carandraug@octave.org> parents: 17855 diff changeset	153 %!testif HAVE_MAGICK
21568 3d60ed163b70 maint: Eliminate bad spacing around '='. Rik <rik@octave.org> parents: 20852 diff changeset	154 %! gray = randi (255, 10, 10, 1, "uint8");
3d60ed163b70 maint: Eliminate bad spacing around '='. Rik <rik@octave.org> parents: 20852 diff changeset	155 %! r = write_and_read (".tif", gray);
21580 ecce63c99c3f maint: Add semicolons to terminate code in %! blocks. Rik <rik@octave.org> parents: 21568 diff changeset	156 %! assert (r, gray);
18544 e0cc67d5a462 Fix writing of grayscale images when there is an alpha channel. Carnë Draug <carandraug@octave.org> parents: 18543 diff changeset	157
e0cc67d5a462 Fix writing of grayscale images when there is an alpha channel. Carnë Draug <carandraug@octave.org> parents: 18543 diff changeset	158 ## grayscale uint8 images with alpha channel
e0cc67d5a462 Fix writing of grayscale images when there is an alpha channel. Carnë Draug <carandraug@octave.org> parents: 18543 diff changeset	159 %!testif HAVE_MAGICK
e0cc67d5a462 Fix writing of grayscale images when there is an alpha channel. Carnë Draug <carandraug@octave.org> parents: 18543 diff changeset	160 %! gray = randi (255, 10, 10, 1, "uint8");
e0cc67d5a462 Fix writing of grayscale images when there is an alpha channel. Carnë Draug <carandraug@octave.org> parents: 18543 diff changeset	161 %! alpha = randi (255, 10, 10, 1, "uint8");
19695 a4f6fbd1af77 imwrite: add tests for jpeg writing (bugs #41673, #44118, #42474) Carnë Draug <carandraug@octave.org> parents: 19278 diff changeset	162 %! [r, ~, a] = write_and_read (".tif", gray, "Alpha", alpha);
31211 edbd725ee76c imwrite: fixed tests to reflect alpha channel behavior for Tiff images magedrifaat <magedrifaat@gmail.com> parents: 30564 diff changeset	163 %! assert (r, cat (3, gray, alpha));
edbd725ee76c imwrite: fixed tests to reflect alpha channel behavior for Tiff images magedrifaat <magedrifaat@gmail.com> parents: 30564 diff changeset	164 %! assert (a, []);
18543 0bfbfb05b158 imwrite.m: simplify test blocks by make use of shared %!function. Carnë Draug <carandraug@octave.org> parents: 18542 diff changeset	165
0bfbfb05b158 imwrite.m: simplify test blocks by make use of shared %!function. Carnë Draug <carandraug@octave.org> parents: 18542 diff changeset	166 ## multipage grayscale uint8 images
0bfbfb05b158 imwrite.m: simplify test blocks by make use of shared %!function. Carnë Draug <carandraug@octave.org> parents: 18542 diff changeset	167 %!testif HAVE_MAGICK
21568 3d60ed163b70 maint: Eliminate bad spacing around '='. Rik <rik@octave.org> parents: 20852 diff changeset	168 %! gray = randi (255, 10, 10, 1, 5, "uint8");
3d60ed163b70 maint: Eliminate bad spacing around '='. Rik <rik@octave.org> parents: 20852 diff changeset	169 %! r = write_and_read (".tif", gray);
21580 ecce63c99c3f maint: Add semicolons to terminate code in %! blocks. Rik <rik@octave.org> parents: 21568 diff changeset	170 %! assert (r, gray);
18544 e0cc67d5a462 Fix writing of grayscale images when there is an alpha channel. Carnë Draug <carandraug@octave.org> parents: 18543 diff changeset	171
e0cc67d5a462 Fix writing of grayscale images when there is an alpha channel. Carnë Draug <carandraug@octave.org> parents: 18543 diff changeset	172 ## multipage RGB uint8 images with alpha channel
e0cc67d5a462 Fix writing of grayscale images when there is an alpha channel. Carnë Draug <carandraug@octave.org> parents: 18543 diff changeset	173 %!testif HAVE_MAGICK
e0cc67d5a462 Fix writing of grayscale images when there is an alpha channel. Carnë Draug <carandraug@octave.org> parents: 18543 diff changeset	174 %! gray = randi (255, 10, 10, 3, 5, "uint8");
e0cc67d5a462 Fix writing of grayscale images when there is an alpha channel. Carnë Draug <carandraug@octave.org> parents: 18543 diff changeset	175 %! alpha = randi (255, 10, 10, 1, 5, "uint8");
19695 a4f6fbd1af77 imwrite: add tests for jpeg writing (bugs #41673, #44118, #42474) Carnë Draug <carandraug@octave.org> parents: 19278 diff changeset	176 %! [r, ~, a] = write_and_read (".tif", gray, "Alpha", alpha);
31211 edbd725ee76c imwrite: fixed tests to reflect alpha channel behavior for Tiff images magedrifaat <magedrifaat@gmail.com> parents: 30564 diff changeset	177 %! assert (r, cat (3, gray, alpha));
edbd725ee76c imwrite: fixed tests to reflect alpha channel behavior for Tiff images magedrifaat <magedrifaat@gmail.com> parents: 30564 diff changeset	178 %! assert (a, []);
18542 30aa4e85f8d5 Fix writing and reading of multipage images. Carnë Draug <carandraug@octave.org> parents: 17855 diff changeset	179
18543 0bfbfb05b158 imwrite.m: simplify test blocks by make use of shared %!function. Carnë Draug <carandraug@octave.org> parents: 18542 diff changeset	180 ## typical usage with RGB uint8 images
18542 30aa4e85f8d5 Fix writing and reading of multipage images. Carnë Draug <carandraug@octave.org> parents: 17855 diff changeset	181 %!testif HAVE_MAGICK
18543 0bfbfb05b158 imwrite.m: simplify test blocks by make use of shared %!function. Carnë Draug <carandraug@octave.org> parents: 18542 diff changeset	182 %! rgb = randi (255, 10, 10, 3, "uint8");
19695 a4f6fbd1af77 imwrite: add tests for jpeg writing (bugs #41673, #44118, #42474) Carnë Draug <carandraug@octave.org> parents: 19278 diff changeset	183 %! r = write_and_read (".tif", rgb);
21580 ecce63c99c3f maint: Add semicolons to terminate code in %! blocks. Rik <rik@octave.org> parents: 21568 diff changeset	184 %! assert (r, rgb);
18542 30aa4e85f8d5 Fix writing and reading of multipage images. Carnë Draug <carandraug@octave.org> parents: 17855 diff changeset	185
18544 e0cc67d5a462 Fix writing of grayscale images when there is an alpha channel. Carnë Draug <carandraug@octave.org> parents: 18543 diff changeset	186 ## RGB uint8 images with alpha channel
e0cc67d5a462 Fix writing of grayscale images when there is an alpha channel. Carnë Draug <carandraug@octave.org> parents: 18543 diff changeset	187 %!testif HAVE_MAGICK
e0cc67d5a462 Fix writing of grayscale images when there is an alpha channel. Carnë Draug <carandraug@octave.org> parents: 18543 diff changeset	188 %! rgb = randi (255, 10, 10, 3, "uint8");
e0cc67d5a462 Fix writing of grayscale images when there is an alpha channel. Carnë Draug <carandraug@octave.org> parents: 18543 diff changeset	189 %! alpha = randi (255, 10, 10, 1, "uint8");
19695 a4f6fbd1af77 imwrite: add tests for jpeg writing (bugs #41673, #44118, #42474) Carnë Draug <carandraug@octave.org> parents: 19278 diff changeset	190 %! [r, ~, a] = write_and_read (".tif", rgb, "Alpha", alpha);
31211 edbd725ee76c imwrite: fixed tests to reflect alpha channel behavior for Tiff images magedrifaat <magedrifaat@gmail.com> parents: 30564 diff changeset	191 %! assert (r, cat (3, rgb, alpha));
edbd725ee76c imwrite: fixed tests to reflect alpha channel behavior for Tiff images magedrifaat <magedrifaat@gmail.com> parents: 30564 diff changeset	192 %! assert (a, []);
18544 e0cc67d5a462 Fix writing of grayscale images when there is an alpha channel. Carnë Draug <carandraug@octave.org> parents: 18543 diff changeset	193
18543 0bfbfb05b158 imwrite.m: simplify test blocks by make use of shared %!function. Carnë Draug <carandraug@octave.org> parents: 18542 diff changeset	194 ## multipage RGB uint8 images
0bfbfb05b158 imwrite.m: simplify test blocks by make use of shared %!function. Carnë Draug <carandraug@octave.org> parents: 18542 diff changeset	195 %!testif HAVE_MAGICK
0bfbfb05b158 imwrite.m: simplify test blocks by make use of shared %!function. Carnë Draug <carandraug@octave.org> parents: 18542 diff changeset	196 %! rgb = randi (255, 10, 10, 3, 5, "uint8");
19695 a4f6fbd1af77 imwrite: add tests for jpeg writing (bugs #41673, #44118, #42474) Carnë Draug <carandraug@octave.org> parents: 19278 diff changeset	197 %! r = write_and_read (".tif", rgb);
21580 ecce63c99c3f maint: Add semicolons to terminate code in %! blocks. Rik <rik@octave.org> parents: 21568 diff changeset	198 %! assert (r, rgb);
18543 0bfbfb05b158 imwrite.m: simplify test blocks by make use of shared %!function. Carnë Draug <carandraug@octave.org> parents: 18542 diff changeset	199
18544 e0cc67d5a462 Fix writing of grayscale images when there is an alpha channel. Carnë Draug <carandraug@octave.org> parents: 18543 diff changeset	200 ## multipage RGB uint8 images with alpha channel
e0cc67d5a462 Fix writing of grayscale images when there is an alpha channel. Carnë Draug <carandraug@octave.org> parents: 18543 diff changeset	201 %!testif HAVE_MAGICK
e0cc67d5a462 Fix writing of grayscale images when there is an alpha channel. Carnë Draug <carandraug@octave.org> parents: 18543 diff changeset	202 %! rgb = randi (255, 10, 10, 3, 5, "uint8");
e0cc67d5a462 Fix writing of grayscale images when there is an alpha channel. Carnë Draug <carandraug@octave.org> parents: 18543 diff changeset	203 %! alpha = randi (255, 10, 10, 1, 5, "uint8");
19695 a4f6fbd1af77 imwrite: add tests for jpeg writing (bugs #41673, #44118, #42474) Carnë Draug <carandraug@octave.org> parents: 19278 diff changeset	204 %! [r, ~, a] = write_and_read (".tif", rgb, "Alpha", alpha);
31211 edbd725ee76c imwrite: fixed tests to reflect alpha channel behavior for Tiff images magedrifaat <magedrifaat@gmail.com> parents: 30564 diff changeset	205 %! assert (r, cat (3, rgb, alpha));
edbd725ee76c imwrite: fixed tests to reflect alpha channel behavior for Tiff images magedrifaat <magedrifaat@gmail.com> parents: 30564 diff changeset	206 %! assert (a, []);
18544 e0cc67d5a462 Fix writing of grayscale images when there is an alpha channel. Carnë Draug <carandraug@octave.org> parents: 18543 diff changeset	207
19695 a4f6fbd1af77 imwrite: add tests for jpeg writing (bugs #41673, #44118, #42474) Carnë Draug <carandraug@octave.org> parents: 19278 diff changeset	208 %!testif HAVE_MAGICK
19833 9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions. Rik <rik@octave.org> parents: 19697 diff changeset	209 %! gray = repmat (uint8 (0:255), 100, 1);
19695 a4f6fbd1af77 imwrite: add tests for jpeg writing (bugs #41673, #44118, #42474) Carnë Draug <carandraug@octave.org> parents: 19278 diff changeset	210 %! [g] = write_and_read (".jpeg", gray);
21580 ecce63c99c3f maint: Add semicolons to terminate code in %! blocks. Rik <rik@octave.org> parents: 21568 diff changeset	211 %! assert (g, gray, 2);
19695 a4f6fbd1af77 imwrite: add tests for jpeg writing (bugs #41673, #44118, #42474) Carnë Draug <carandraug@octave.org> parents: 19278 diff changeset	212
a4f6fbd1af77 imwrite: add tests for jpeg writing (bugs #41673, #44118, #42474) Carnë Draug <carandraug@octave.org> parents: 19278 diff changeset	213 %!testif HAVE_MAGICK
19833 9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions. Rik <rik@octave.org> parents: 19697 diff changeset	214 %! gray = repmat (uint8 (0:255), 100, 1);
19695 a4f6fbd1af77 imwrite: add tests for jpeg writing (bugs #41673, #44118, #42474) Carnë Draug <carandraug@octave.org> parents: 19278 diff changeset	215 %! [g] = write_and_read (".jpeg", gray, "quality", 100);
21580 ecce63c99c3f maint: Add semicolons to terminate code in %! blocks. Rik <rik@octave.org> parents: 21568 diff changeset	216 %! assert (g, gray);
19695 a4f6fbd1af77 imwrite: add tests for jpeg writing (bugs #41673, #44118, #42474) Carnë Draug <carandraug@octave.org> parents: 19278 diff changeset	217
24930 16155531bda4 maint: Don't use brackets around a single output variable in a function declaration. Rik <rik@octave.org> parents: 24534 diff changeset	218 %!function compression = get_bmp_compression (ext, cmap = [], varargin)
20406 5b8e4f668c53 Add compression option to imwrite and default to "none" (bug #45565) Carnë Draug <carandraug@octave.org> parents: 20158 diff changeset	219 %! gray = repmat (uint8 (0:255), 100, 1);
5b8e4f668c53 Add compression option to imwrite and default to "none" (bug #45565) Carnë Draug <carandraug@octave.org> parents: 20158 diff changeset	220 %! filename = [tempname() ext];
5b8e4f668c53 Add compression option to imwrite and default to "none" (bug #45565) Carnë Draug <carandraug@octave.org> parents: 20158 diff changeset	221 %! unwind_protect
5b8e4f668c53 Add compression option to imwrite and default to "none" (bug #45565) Carnë Draug <carandraug@octave.org> parents: 20158 diff changeset	222 %! if (isempty (cmap))
5b8e4f668c53 Add compression option to imwrite and default to "none" (bug #45565) Carnë Draug <carandraug@octave.org> parents: 20158 diff changeset	223 %! imwrite (gray, filename, varargin{1:end});
5b8e4f668c53 Add compression option to imwrite and default to "none" (bug #45565) Carnë Draug <carandraug@octave.org> parents: 20158 diff changeset	224 %! else
5b8e4f668c53 Add compression option to imwrite and default to "none" (bug #45565) Carnë Draug <carandraug@octave.org> parents: 20158 diff changeset	225 %! imwrite (gray, cmap, filename, varargin{1:end});
5b8e4f668c53 Add compression option to imwrite and default to "none" (bug #45565) Carnë Draug <carandraug@octave.org> parents: 20158 diff changeset	226 %! endif
5b8e4f668c53 Add compression option to imwrite and default to "none" (bug #45565) Carnë Draug <carandraug@octave.org> parents: 20158 diff changeset	227 %! fid = fopen (filename);
5b8e4f668c53 Add compression option to imwrite and default to "none" (bug #45565) Carnë Draug <carandraug@octave.org> parents: 20158 diff changeset	228 %! unwind_protect
5b8e4f668c53 Add compression option to imwrite and default to "none" (bug #45565) Carnë Draug <carandraug@octave.org> parents: 20158 diff changeset	229 %! compression = fread (fid, 31)(end);
5b8e4f668c53 Add compression option to imwrite and default to "none" (bug #45565) Carnë Draug <carandraug@octave.org> parents: 20158 diff changeset	230 %! unwind_protect_cleanup
5b8e4f668c53 Add compression option to imwrite and default to "none" (bug #45565) Carnë Draug <carandraug@octave.org> parents: 20158 diff changeset	231 %! fclose (fid);
5b8e4f668c53 Add compression option to imwrite and default to "none" (bug #45565) Carnë Draug <carandraug@octave.org> parents: 20158 diff changeset	232 %! end_unwind_protect
5b8e4f668c53 Add compression option to imwrite and default to "none" (bug #45565) Carnë Draug <carandraug@octave.org> parents: 20158 diff changeset	233 %! unwind_protect_cleanup
5b8e4f668c53 Add compression option to imwrite and default to "none" (bug #45565) Carnë Draug <carandraug@octave.org> parents: 20158 diff changeset	234 %! unlink (filename);
5b8e4f668c53 Add compression option to imwrite and default to "none" (bug #45565) Carnë Draug <carandraug@octave.org> parents: 20158 diff changeset	235 %! end_unwind_protect
5b8e4f668c53 Add compression option to imwrite and default to "none" (bug #45565) Carnë Draug <carandraug@octave.org> parents: 20158 diff changeset	236 %!endfunction
5b8e4f668c53 Add compression option to imwrite and default to "none" (bug #45565) Carnë Draug <carandraug@octave.org> parents: 20158 diff changeset	237
22489 93ea313301f9 test: Add bug ids (<#####>) to BIST tests. Rik <rik@octave.org> parents: 22323 diff changeset	238 ## BMP images must be saved uncompressed by default
23573 1b4f4ec53b4a use new script to tag fixed bugs in tests John W. Eaton <jwe@octave.org> parents: 23572 diff changeset	239 %!testif HAVE_MAGICK <*45565>
21580 ecce63c99c3f maint: Add semicolons to terminate code in %! blocks. Rik <rik@octave.org> parents: 21568 diff changeset	240 %! assert (get_bmp_compression ("", [], "BMP"), 0);
ecce63c99c3f maint: Add semicolons to terminate code in %! blocks. Rik <rik@octave.org> parents: 21568 diff changeset	241 %! assert (get_bmp_compression ("", [], "bmp"), 0);
ecce63c99c3f maint: Add semicolons to terminate code in %! blocks. Rik <rik@octave.org> parents: 21568 diff changeset	242 %! assert (get_bmp_compression (".BMP"), 0);
ecce63c99c3f maint: Add semicolons to terminate code in %! blocks. Rik <rik@octave.org> parents: 21568 diff changeset	243 %! assert (get_bmp_compression (".bmp"), 0);
ecce63c99c3f maint: Add semicolons to terminate code in %! blocks. Rik <rik@octave.org> parents: 21568 diff changeset	244 %! assert (get_bmp_compression (".bmp", [], "bmp"), 0);
ecce63c99c3f maint: Add semicolons to terminate code in %! blocks. Rik <rik@octave.org> parents: 21568 diff changeset	245 %! assert (get_bmp_compression ("", gray (256), "bmp"), 0);
ecce63c99c3f maint: Add semicolons to terminate code in %! blocks. Rik <rik@octave.org> parents: 21568 diff changeset	246 %! assert (get_bmp_compression (".bmp", gray (256), "Compression", "rle"), 1);

Mercurial > octave-libtiff

annotate scripts/image/imwrite.m @ 31211:edbd725ee76c