octave-antonio: scripts/image/ind2rgb.m annotate

annotate scripts/image/ind2rgb.m @ 15689:14b7679891dd

ind2sub ind2gray: merge common code in private function, expanding fix for images when integers, input check, and expansion of colormap to ind2gray.

author	Carnë Draug <carandraug+dev@gmail.com>
date	Mon, 12 Nov 2012 04:53:42 +0000
parents	4db08f52a6ed
children	a1b634240352

rev	line source
14138 72c96de7a403 maint: update copyright notices for 2012 John W. Eaton <jwe@octave.org> parents: 13279 diff changeset	1 ## Copyright (C) 1994-2012 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
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6247 diff changeset	7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6247 diff changeset	8 ## your option) any later version.
2313 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
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6247 diff changeset	16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6247 diff changeset	17 ## <http://www.gnu.org/licenses/>.
1024 56520a75b5b3 [project @ 1995-01-11 20:30:04 by jwe] jwe parents: 917 diff changeset	18
3381 69b167451491 [project @ 1999-12-15 20:48:10 by jwe] jwe parents: 3373 diff changeset	19 ## -- texinfo --
14260 1f911333ed3d doc: Update docstrings for functions in image/ directory Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	20 ## @deftypefn {Function File} {@var{rgb} =} ind2rgb (@var{x})
1f911333ed3d doc: Update docstrings for functions in image/ directory Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	21 ## @deftypefnx {Function File} {@var{rgb} =} ind2rgb (@var{x}, @var{map})
1f911333ed3d doc: Update docstrings for functions in image/ directory Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	22 ## @deftypefnx {Function File} {[@var{R}, @var{G}, @var{B}] =} ind2rgb (@dots{})
2311 2b5788792cad [project @ 1996-07-11 20:18:38 by jwe] jwe parents: 2303 diff changeset	23 ## Convert an indexed image to red, green, and blue color components.
6247 7b04118f04df [project @ 2007-01-19 03:21:16 by jwe] jwe parents: 6046 diff changeset	24 ## If the colormap doesn't contain enough colors, pad it with the
7b04118f04df [project @ 2007-01-19 03:21:16 by jwe] jwe parents: 6046 diff changeset	25 ## last color in the map.
3373 36405da8e173 [project @ 1999-11-23 20:54:17 by jwe] jwe parents: 3202 diff changeset	26 ## If @var{map} is omitted, the current colormap is used for the conversion.
14260 1f911333ed3d doc: Update docstrings for functions in image/ directory Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	27 ## @seealso{rgb2ind, ind2gray, hsv2rgb, ntsc2rgb}
3373 36405da8e173 [project @ 1999-11-23 20:54:17 by jwe] jwe parents: 3202 diff changeset	28 ## @end deftypefn
904 3470f1e25a79 [project @ 1994-11-09 21:22:15 by jwe] jwe parents: 559 diff changeset	29
3202 44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe] jwe parents: 2847 diff changeset	30 ## Author: Tony Richardson <arichard@stark.cc.oh.us>
2312 204cc7db6f4a [project @ 1996-07-11 21:20:36 by jwe] jwe parents: 2311 diff changeset	31 ## Created: July 1994
204cc7db6f4a [project @ 1996-07-11 21:20:36 by jwe] jwe parents: 2311 diff changeset	32 ## Adapted-By: jwe
559 4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe] jwe parents: diff changeset	33
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	34 function [R, G, B] = ind2rgb (x, map)
1024 56520a75b5b3 [project @ 1995-01-11 20:30:04 by jwe] jwe parents: 917 diff changeset	35
6247 7b04118f04df [project @ 2007-01-19 03:21:16 by jwe] jwe parents: 6046 diff changeset	36 ## Do we have the right number of inputs?
1024 56520a75b5b3 [project @ 1995-01-11 20:30:04 by jwe] jwe parents: 917 diff changeset	37 if (nargin < 1 \|\| nargin > 2)
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 5775 diff changeset	38 print_usage ();
1024 56520a75b5b3 [project @ 1995-01-11 20:30:04 by jwe] jwe parents: 917 diff changeset	39 elseif (nargin == 1)
56520a75b5b3 [project @ 1995-01-11 20:30:04 by jwe] jwe parents: 917 diff changeset	40 map = colormap ();
559 4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe] jwe parents: diff changeset	41 endif
4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe] jwe parents: diff changeset	42
15689 14b7679891dd ind2sub ind2gray: merge common code in private function, expanding fix for images when integers, input check, and expansion of colormap to ind2gray. Carnë Draug <carandraug+dev@gmail.com> parents: 15688 diff changeset	43 [x, map] = ind2x ("ind2rgb", x, map);
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	44
6247 7b04118f04df [project @ 2007-01-19 03:21:16 by jwe] jwe parents: 6046 diff changeset	45 ## Compute result
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	46 [hi, wi] = size (x);
c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	47 R = reshape (map (x(:), 1), hi, wi);
c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	48 G = reshape (map (x(:), 2), hi, wi);
c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	49 B = reshape (map (x(:), 3), hi, wi);
559 4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe] jwe parents: diff changeset	50
6247 7b04118f04df [project @ 2007-01-19 03:21:16 by jwe] jwe parents: 6046 diff changeset	51 ## Use 3D array if only one output is requested.
7b04118f04df [project @ 2007-01-19 03:21:16 by jwe] jwe parents: 6046 diff changeset	52 if (nargout <= 1)
7b04118f04df [project @ 2007-01-19 03:21:16 by jwe] jwe parents: 6046 diff changeset	53 R(:,:,3) = B;
7b04118f04df [project @ 2007-01-19 03:21:16 by jwe] jwe parents: 6046 diff changeset	54 R(:,:,2) = G;
7b04118f04df [project @ 2007-01-19 03:21:16 by jwe] jwe parents: 6046 diff changeset	55 endif
559 4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe] jwe parents: diff changeset	56 endfunction
15688 4db08f52a6ed ind2rgb: correction for indexes when image is uint class. Added tests block. Carnë Draug <carandraug+dev@gmail.com> parents: 15515 diff changeset	57
4db08f52a6ed ind2rgb: correction for indexes when image is uint class. Added tests block. Carnë Draug <carandraug+dev@gmail.com> parents: 15515 diff changeset	58 %!shared img, map, ergb, rgb, r, g, b
4db08f52a6ed ind2rgb: correction for indexes when image is uint class. Added tests block. Carnë Draug <carandraug+dev@gmail.com> parents: 15515 diff changeset	59 %! img = [2 4 5; 3 2 5; 1 2 4];
4db08f52a6ed ind2rgb: correction for indexes when image is uint class. Added tests block. Carnë Draug <carandraug+dev@gmail.com> parents: 15515 diff changeset	60 %! map = [0.0 0.0 0.0
4db08f52a6ed ind2rgb: correction for indexes when image is uint class. Added tests block. Carnë Draug <carandraug+dev@gmail.com> parents: 15515 diff changeset	61 %! 0.2 0.4 0.6
4db08f52a6ed ind2rgb: correction for indexes when image is uint class. Added tests block. Carnë Draug <carandraug+dev@gmail.com> parents: 15515 diff changeset	62 %! 0.4 0.4 0.5
4db08f52a6ed ind2rgb: correction for indexes when image is uint class. Added tests block. Carnë Draug <carandraug+dev@gmail.com> parents: 15515 diff changeset	63 %! 0.3 0.7 1.0
4db08f52a6ed ind2rgb: correction for indexes when image is uint class. Added tests block. Carnë Draug <carandraug+dev@gmail.com> parents: 15515 diff changeset	64 %! 0.1 0.5 0.8];
4db08f52a6ed ind2rgb: correction for indexes when image is uint class. Added tests block. Carnë Draug <carandraug+dev@gmail.com> parents: 15515 diff changeset	65 %! ergb(:,:,1) = [0.2 0.3 0.1; 0.4 0.2 0.1; 0.0 0.2 0.3];
4db08f52a6ed ind2rgb: correction for indexes when image is uint class. Added tests block. Carnë Draug <carandraug+dev@gmail.com> parents: 15515 diff changeset	66 %! ergb(:,:,2) = [0.4 0.7 0.5; 0.4 0.4 0.5; 0.0 0.4 0.7];
4db08f52a6ed ind2rgb: correction for indexes when image is uint class. Added tests block. Carnë Draug <carandraug+dev@gmail.com> parents: 15515 diff changeset	67 %! ergb(:,:,3) = [0.6 1.0 0.8; 0.5 0.6 0.8; 0.0 0.6 1.0];
4db08f52a6ed ind2rgb: correction for indexes when image is uint class. Added tests block. Carnë Draug <carandraug+dev@gmail.com> parents: 15515 diff changeset	68 %! ## test basic usage with 1 and 3 outputs
4db08f52a6ed ind2rgb: correction for indexes when image is uint class. Added tests block. Carnë Draug <carandraug+dev@gmail.com> parents: 15515 diff changeset	69 %! [rgb] = ind2rgb (img, map);
4db08f52a6ed ind2rgb: correction for indexes when image is uint class. Added tests block. Carnë Draug <carandraug+dev@gmail.com> parents: 15515 diff changeset	70 %! [r, g, b] = ind2rgb (img, map);
4db08f52a6ed ind2rgb: correction for indexes when image is uint class. Added tests block. Carnë Draug <carandraug+dev@gmail.com> parents: 15515 diff changeset	71 %!assert (ergb, rgb);
4db08f52a6ed ind2rgb: correction for indexes when image is uint class. Added tests block. Carnë Draug <carandraug+dev@gmail.com> parents: 15515 diff changeset	72 %!assert (ergb, reshape ([r(:) g(:) b(:)], [size(img) 3]));
4db08f52a6ed ind2rgb: correction for indexes when image is uint class. Added tests block. Carnë Draug <carandraug+dev@gmail.com> parents: 15515 diff changeset	73 %! ## test correction for integers
4db08f52a6ed ind2rgb: correction for indexes when image is uint class. Added tests block. Carnë Draug <carandraug+dev@gmail.com> parents: 15515 diff changeset	74 %! img = uint8 (img -1);
4db08f52a6ed ind2rgb: correction for indexes when image is uint class. Added tests block. Carnë Draug <carandraug+dev@gmail.com> parents: 15515 diff changeset	75 %! [rgb] = ind2rgb (img, map);
4db08f52a6ed ind2rgb: correction for indexes when image is uint class. Added tests block. Carnë Draug <carandraug+dev@gmail.com> parents: 15515 diff changeset	76 %!assert (ergb, rgb);
4db08f52a6ed ind2rgb: correction for indexes when image is uint class. Added tests block. Carnë Draug <carandraug+dev@gmail.com> parents: 15515 diff changeset	77 %! ## check it fails when image is a float with an index value of 0
4db08f52a6ed ind2rgb: correction for indexes when image is uint class. Added tests block. Carnë Draug <carandraug+dev@gmail.com> parents: 15515 diff changeset	78 %!fail("[rgb] = ind2rgb (double(img), map)")

Mercurial > octave-antonio

annotate scripts/image/ind2rgb.m @ 15689:14b7679891dd