Mercurial > octave-antonio
view scripts/image/cmpermute.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 | 4197fc428c7d |
children |
line wrap: on
line source
## Copyright (C) 2004 Josep Mones i Teixidor ## Copyright (C) 2012-2015 Rik Wehbring ## ## 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{Y}, @var{newmap}] =} cmpermute (@var{X}, @var{map}) ## @deftypefnx {Function File} {[@var{Y}, @var{newmap}] =} cmpermute (@var{X}, @var{map}, @var{index}) ## Reorder colors in a colormap. ## ## When called with only two arguments, @code{cmpermute} randomly rearranges ## the colormap @var{map} and returns a new colormap @var{newmap}. It also ## returns the indexed image @var{Y} which is the equivalent of the original ## input image @var{X} when displayed using @var{newmap}. ## ## When called with an optional third argument the order of colors in the new ## colormap is defined by @var{index}. ## ## @strong{Caution:} @code{index} should not have repeated elements or the ## function will fail. ## ## @end deftypefn ## Author: Josep Mones i Teixidor <jmones@puntbarra.com> function [Y, newmap] = cmpermute (X, map, index) if (nargin < 2 || nargin > 3) print_usage (); endif cls = class (X); if (! any (strcmp (cls, {"uint8", "uint16", "single", "double"}))) error ("cmpermute: invalid data type '%s'", cls); endif if (! isreal (X) || issparse (X) || (isfloat (X) && (any (X(:) < 1 || any (X(:) != fix (X(:))))))) error ("cmpermute: X must be an indexed image"); endif if (! iscolormap (map)) error ("cmpermute: MAP must be a valid colormap"); endif if (nargin < 3) index = randperm (rows (map)); elseif (! isvector (index) || length (index) != rows (map)) error ("cmpermute: invalid parameter INDEX"); endif ## new colormap newmap = map(index,:); ## build reverse index rindex = zeros (size (index)); rindex(index) = 1:length (index); ## preserve class of input image in output if (strcmp (cls, "double")) Y = rindex(X); elseif (strcmp (cls, "single")) rindex = single (rindex); Y = rindex(X); else ## adapt indices rindex = feval (cls, rindex - 1); ## 0-based indices Y = rindex(single (X) + 1); endif endfunction %!demo %! [Y, newmap] = cmpermute ([1:4], hot (4), 4:-1:1) %! ## colormap will be arranged in reverse order (so will image) %!shared X, map %! X = uint8 (magic (16)); %! [X, map] = cmunique (X); %!test # random permutation, 0-based index %! [Y, newmap] = cmpermute (X, map); %! ## test we didn't lose colors %! assert (sort (map), sortrows (newmap)); %! ## test if images are equal %! assert (map(double (X)+1), newmap(double (Y)+1)); %!test # reverse map, 0-based index %! [Y, newmap] = cmpermute (X, map, rows (map):-1:1); %! ## we expect a reversed colormap %! assert (flipud (newmap), map); %! ## we expect reversed indices in image %! assert (X, max (Y(:)) - Y); %!shared X,map %! X = uint16 (magic (20)); %! [X, map] = cmunique (X); %!test # random permutation, 1-based index %! [Y, newmap] = cmpermute (X, map); %! ## test we didn't lose colors %! assert (sort (map), sortrows (newmap)); %! ## test if images are equal %! assert (map(X), newmap(Y)); %!test # reverse map, 1-based index %! [Y, newmap] = cmpermute (X, map, rows (map):-1:1); %! ## we expect a reversed colormap %! assert (newmap (rows (newmap):-1:1,:), map); %! ## we expect reversed indices in image %! assert (X, max (Y(:)) + 1 - Y); ## Test input validation %!error cmpermute () %!error cmpermute (1,2,3,4) %!error <invalid data type 'uint32'> cmpermute (uint32 (magic (16)), jet (256)) %!error <X must be an indexed image> cmpermute (1+i, jet (256)) %!error <X must be an indexed image> cmpermute (sparse (1), jet (256)) %!error <X must be an indexed image> cmpermute (0, jet (256)) %!error <X must be an indexed image> cmpermute (1.5, jet (256)) %!error <MAP must be a valid colormap> cmpermute (1, "a") %!error <MAP must be a valid colormap> cmpermute (1, i) %!error <MAP must be a valid colormap> cmpermute (1, ones (3,3,3)) %!error <MAP must be a valid colormap> cmpermute (1, ones (3,2)) %!error <MAP must be a valid colormap> cmpermute (1, [-1 1 1]) %!error <MAP must be a valid colormap> cmpermute (1, [2 1 1]) %!error <invalid parameter INDEX> cmpermute (1, [0 1 0;1 0 1], ones (3)) %!error <invalid parameter INDEX> cmpermute (1, [0 1 0;1 0 1], 1:3)