Mercurial > octave-antonio
view scripts/image/gray2ind.m @ 20158:7503499a252b stable
doc: Update docstrings to have one sentence summary as first line.
Update scripts in audio, elfun, general, geometry, and image directories.
* scripts/audio/@audioplayer/__get_properties__.m,
scripts/audio/@audioplayer/audioplayer.m, scripts/audio/@audioplayer/get.m,
scripts/audio/@audioplayer/isplaying.m, scripts/audio/@audioplayer/play.m,
scripts/audio/@audioplayer/playblocking.m, scripts/audio/@audioplayer/set.m,
scripts/audio/@audioplayer/subsasgn.m, scripts/audio/@audioplayer/subsref.m,
scripts/audio/@audiorecorder/audiorecorder.m,
scripts/audio/@audiorecorder/get.m,
scripts/audio/@audiorecorder/getaudiodata.m,
scripts/audio/@audiorecorder/getplayer.m,
scripts/audio/@audiorecorder/isrecording.m,
scripts/audio/@audiorecorder/play.m, scripts/audio/@audiorecorder/record.m,
scripts/audio/@audiorecorder/recordblocking.m,
scripts/audio/@audiorecorder/set.m, scripts/audio/@audiorecorder/stop.m,
scripts/audio/@audiorecorder/subsasgn.m,
scripts/audio/@audiorecorder/subsref.m, scripts/audio/lin2mu.m,
scripts/audio/mu2lin.m, scripts/audio/record.m, scripts/audio/sound.m,
scripts/audio/soundsc.m, scripts/audio/wavread.m, scripts/audio/wavwrite.m,
scripts/elfun/cosd.m, scripts/elfun/sind.m, scripts/elfun/tand.m,
scripts/general/accumarray.m, scripts/general/accumdim.m,
scripts/general/bitcmp.m, scripts/general/bitget.m, scripts/general/bitset.m,
scripts/general/blkdiag.m, scripts/general/cart2pol.m,
scripts/general/cart2sph.m, scripts/general/cell2mat.m,
scripts/general/celldisp.m, scripts/general/chop.m,
scripts/general/circshift.m, scripts/general/common_size.m,
scripts/general/cplxpair.m, scripts/general/cumtrapz.m,
scripts/general/dblquad.m, scripts/general/deal.m, scripts/general/del2.m,
scripts/general/display.m, scripts/general/divergence.m,
scripts/general/fieldnames.m, scripts/general/flip.m,
scripts/general/flipdim.m, scripts/general/fliplr.m, scripts/general/flipud.m,
scripts/general/gradient.m, scripts/general/interp3.m,
scripts/general/interpft.m, scripts/general/interpn.m,
scripts/general/loadobj.m, scripts/general/logspace.m,
scripts/general/methods.m, scripts/general/nargchk.m,
scripts/general/narginchk.m, scripts/general/nargoutchk.m,
scripts/general/nextpow2.m, scripts/general/nthargout.m,
scripts/general/num2str.m, scripts/general/pol2cart.m,
scripts/general/polyarea.m, scripts/general/postpad.m,
scripts/general/prepad.m, scripts/general/profile.m, scripts/general/quadgk.m,
scripts/general/quadl.m, scripts/general/quadv.m, scripts/general/randi.m,
scripts/general/rat.m, scripts/general/repmat.m, scripts/general/rot90.m,
scripts/general/rotdim.m, scripts/general/saveobj.m, scripts/general/shift.m,
scripts/general/shiftdim.m, scripts/general/sortrows.m,
scripts/general/sph2cart.m, scripts/general/structfun.m,
scripts/general/subsindex.m, scripts/general/trapz.m,
scripts/general/triplequad.m, scripts/geometry/delaunayn.m,
scripts/geometry/dsearch.m, scripts/geometry/dsearchn.m,
scripts/geometry/griddata.m, scripts/geometry/griddata3.m,
scripts/geometry/griddatan.m, scripts/geometry/inpolygon.m,
scripts/geometry/rectint.m, scripts/geometry/tsearchn.m,
scripts/geometry/voronoi.m, scripts/geometry/voronoin.m,
scripts/help/__unimplemented__.m, scripts/help/doc.m,
scripts/help/doc_cache_create.m, scripts/help/get_first_help_sentence.m,
scripts/help/help.m, scripts/help/lookfor.m, scripts/help/print_usage.m,
scripts/help/type.m, scripts/help/which.m, scripts/image/autumn.m,
scripts/image/bone.m, scripts/image/brighten.m, scripts/image/cmpermute.m,
scripts/image/colorcube.m, scripts/image/contrast.m, scripts/image/cool.m,
scripts/image/copper.m, scripts/image/cubehelix.m, scripts/image/flag.m,
scripts/image/gmap40.m, scripts/image/gray.m, scripts/image/gray2ind.m,
scripts/image/hot.m, scripts/image/hsv.m, scripts/image/image.m,
scripts/image/imagesc.m, scripts/image/imfinfo.m, scripts/image/imformats.m,
scripts/image/imread.m, scripts/image/imshow.m, scripts/image/imwrite.m,
scripts/image/iscolormap.m, scripts/image/jet.m, scripts/image/lines.m,
scripts/image/ntsc2rgb.m, scripts/image/ocean.m, scripts/image/pink.m,
scripts/image/prism.m, scripts/image/rainbow.m, scripts/image/rgb2ntsc.m,
scripts/image/spinmap.m, scripts/image/spring.m, scripts/image/summer.m,
scripts/image/white.m, scripts/image/winter.m:
Update docstrings to have one sentence summary as first line.
Re-structure to have line lengths <= 80 chars.
author | Rik <rik@octave.org> |
---|---|
date | Sun, 03 May 2015 09:36:20 -0700 |
parents | 9fc020886ae9 |
children |
line wrap: on
line source
## Copyright (C) 1994-2015 John W. Eaton ## ## 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 ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- ## @deftypefn {Function File} {@var{img} =} gray2ind (@var{I}) ## @deftypefnx {Function File} {@var{img} =} gray2ind (@var{I}, @var{n}) ## @deftypefnx {Function File} {@var{img} =} gray2ind (@var{BW}) ## @deftypefnx {Function File} {@var{img} =} gray2ind (@var{BW}, @var{n}) ## @deftypefnx {Function File} {[@var{img}, @var{map}] =} gray2ind (@dots{}) ## Convert a grayscale or binary intensity image to an indexed image. ## ## The indexed image will consist of @var{n} different intensity values. ## If not given @var{n} defaults to 64 for grayscale images or 2 for binary ## black and white images. ## ## The output @var{img} is of class uint8 if @var{n} is less than or equal to ## 256; Otherwise the return class is uint16. ## @seealso{ind2gray, rgb2ind} ## @end deftypefn ## Author: Tony Richardson <arichard@stark.cc.oh.us> ## Created: July 1994 ## Adapted-By: jwe function [I, map] = gray2ind (I, n = 64) if (nargin < 1 || nargin > 2) print_usage (); elseif (! isreal (I) || issparse (I)) error ("gray2ind: I must be a grayscale or binary image"); elseif (! isscalar (n) || n < 1 || n > 65536) error ("gray2ind: N must be a positive integer in the range [1, 65536]"); elseif (! ismatrix (I) || ndims (I) < 2) error ("gray2ind: I must be a grayscale or binary image"); endif ## default n is different if image is logical if (nargin == 1 && islogical (I)) n = 2; endif cls = class (I); if (! any (strcmp (cls, {"logical", "uint8", "uint16", "int16", ... "single", "double"}))) error ("gray2ind: invalid data type '%s'", cls); elseif (isfloat (I) && (min (I(:) < 0) || max (I(:) > 1))) error ("gray2ind: floating point images may only contain values between 0 and 1"); endif map = gray (n); ## Set up scale factor if (isinteger (I)) low = double (intmin (cls)); scale = double (intmax (cls)) - low; I = double (I) - low; else scale = 1; endif I *= (n-1)/scale; ## Note: no separate call to round () necessary because ## type conversion does that automatically. if (n <= 256) I = uint8 (I); else I = uint16 (I); endif endfunction %!assert (gray2ind ([0 0.25 0.5 1]), uint8 ([0 16 32 63])) %!assert (gray2ind ([0 0.25 0.5 1], 400), uint16 ([0 100 200 399])) %!assert (gray2ind (logical ([1 0 0 1])), uint8 ([1 0 0 1])) %!assert (gray2ind (uint8 ([0 64 128 192 255])), uint8 ([0 16 32 47 63])) %!test %! i2g = ind2gray (1:100, gray (100)); %! g2i = gray2ind (i2g, 100); %! assert (g2i, uint8 (0:99)); %!assert (gray2ind ([0 0.25 0.5 1], 256), uint8 ([0 64 128 255])) %!assert (gray2ind ([0 (1/511) (1/510) 1-(1/509) 1-(1/510) 1], 256), %! uint8 ([0 0 1 254 255 255])) %!test %! assert (class (gray2ind ([0.0 0.5 1.0], 255)), "uint8") %! assert (class (gray2ind ([0.0 0.5 1.0], 256)), "uint8") %! assert (class (gray2ind ([0.0 0.5 1.0], 257)), "uint16") ## Test input validation %!error gray2ind () %!error gray2ind (1,2,3) %!error <I must be a grayscale or binary image> gray2ind ({1}) %!error <I must be a grayscale or binary image> gray2ind ([1+i]) %!error <I must be a grayscale or binary image> gray2ind (sparse ([1])) %!error <N must be a positive integer> gray2ind (1, ones (2,2)) %!error <N must be a positive integer> gray2ind (1, 0) %!error <N must be a positive integer> gray2ind (1, 65537) %!error <invalid data type> gray2ind (uint32 (1)) %!error <values between 0 and 1> gray2ind (-1) %!error <values between 0 and 1> gray2ind (2)