1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158
|
########################################################################
##
## Copyright (C) 1994-2024 The Octave Project Developers
##
## See the file COPYRIGHT.md in the top-level directory of this
## distribution or <https://octave.org/copyright/>.
##
## This file is part of Octave.
##
## Octave is free software: you can redistribute it and/or modify it
## under the terms of the GNU General Public License as published by
## the Free Software Foundation, either version 3 of the License, or
## (at your option) any later version.
##
## Octave is distributed in the hope that it will be useful, but
## WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
## GNU General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with Octave; see the file COPYING. If not, see
## <https://www.gnu.org/licenses/>.
##
########################################################################
## -*- texinfo -*-
## @deftypefn {} {[@var{x}, @var{map}] =} rgb2ind (@var{rgb})
## @deftypefnx {} {[@var{x}, @var{map}] =} rgb2ind (@var{R}, @var{G}, @var{B})
## Convert an image in red-green-blue (RGB) color space to an indexed image.
##
## The input image @var{rgb} can be specified as a single matrix of size
## @nospell{MxNx3}, or as three separate variables, @var{R}, @var{G}, and
## @var{B}, its three color channels, red, green, and blue.
##
## It outputs an indexed image @var{x} and a colormap @var{map} to interpret
## an image exactly the same as the input. No dithering or other form of color
## quantization is performed. The output class of the indexed image @var{x}
## can be uint8, uint16 or double, whichever is required to specify the
## number of unique colors in the image (which will be equal to the number
## of rows in @var{map}) in order.
##
## Multi-dimensional indexed images (of size @nospell{MxNx3xK}) are also
## supported, both via a single input (@var{rgb}) or its three color channels
## as separate variables.
##
## @seealso{ind2rgb, rgb2hsv, rgb2gray}
## @end deftypefn
## FIXME: This function has a very different syntax than the Matlab
## one of the same name.
## Octave function does not support N, MAP, DITHER, or TOL arguments.
function [x, map] = rgb2ind (R, G, B)
if (nargin != 1 && nargin != 3)
print_usage ();
endif
if (nargin == 1)
rgb = R;
if (ndims (rgb) > 4 || size (rgb, 3) != 3)
error ("rgb2ind: argument is not an RGB image");
else
R = rgb(:,:,1,:);
G = rgb(:,:,2,:);
B = rgb(:,:,3,:);
endif
elseif (! size_equal (R, G, B))
error ("rgb2ind: R, G, and B must have the same size");
endif
x = reshape (1:numel (R), size (R));
map = unique ([R(:) G(:) B(:)], "rows");
[~, x] = ismember ([R(:) G(:) B(:)], map, "rows");
x = reshape (x, size (R));
## a colormap is of class double and values between 0 and 1
switch (class (R))
case {"single", "double", "logical"}
## do nothing, return the same
case {"uint8", "uint16"}
map = double (map) / double (intmax (R));
case "int16"
map = (double (im) + 32768) / 65535;
otherwise
error ("rgb2ind: unsupported image class %s", im_class);
endswitch
## we convert to the smallest class necessary to encode the image. Matlab
## documentation does not mention what it does when uint16 is not enough...
## When an indexed image is of integer class, there's a -1 offset to the
## colormap, hence the adjustment
if (rows (map) < 256)
x = uint8 (x - 1);
elseif (rows (map) < 65536)
x = uint16 (x - 1);
else
## leave it as double
endif
endfunction
## Test input validation
%!error <Invalid call> rgb2ind ()
%!error <Invalid call> rgb2ind (1,2)
%!error <RGB> rgb2ind (rand (10, 10, 4))
## FIXME: the following tests simply make sure that rgb2ind and ind2rgb
## reverse each other. We should have better tests for this.
## Typical usage
%!test
%! rgb = rand (10, 10, 3);
%! [ind, map] = rgb2ind (rgb);
%! assert (ind2rgb (ind, map), rgb);
%!
%! ## test specifying the RGB channels separated
%! [ind, map] = rgb2ind (rgb(:,:,1), rgb(:,:,2), rgb(:,:,3));
%! assert (ind2rgb (ind, map), rgb);
## Test N-dimensional images
%!test
%! rgb = rand (10, 10, 3, 10);
%! [ind, map] = rgb2ind (rgb);
%! assert (ind2rgb (ind, map), rgb);
%! [ind, map] = rgb2ind (rgb(:,:,1,:), rgb(:,:,2,:), rgb(:,:,3,:));
%! assert (ind2rgb (ind, map), rgb);
## Test output class
%!test
%! ## this should have more than 65535 unique colors
%! rgb = nchoosek (0:80, 3) / 80;
%! nr = rows (rgb);
%! assert (nr > 65535);
%! rgb = reshape (rgb, [1, nr, 3]);
%! [ind, map] = rgb2ind (rgb);
%! assert (class (ind), "double");
%! assert (class (map), "double");
%!
%! ## and this should have between 256 and 65535 unique colors
%! rgb = nchoosek (0:40, 3) / 80;
%! nr = rows (rgb);
%! assert (nr >= 256 && nr <= 65535);
%! rgb = reshape (rgb, [1, nr, 3]);
%! [ind, map] = rgb2ind (rgb);
%! assert (class (ind), "uint16");
%! assert (class (map), "double");
%!
%! ## and this one should have fewer than than 256 unique colors
%! rgb = nchoosek (0:10, 3) / 80;
%! nr = rows (rgb);
%! assert (nr < 256);
%! rgb = reshape (rgb, [1, nr, 3]);
%! [ind, map] = rgb2ind (rgb);
%! assert (class (ind), "uint8");
%! assert (class (map), "double");
|