Mercurial > octave-antonio
view scripts/image/colormap.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) 1994-2015 John W. Eaton ## Copyright (C) 2012 Carnë Draug ## ## 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{cmap} =} colormap () ## @deftypefnx {Function File} {@var{cmap} =} colormap (@var{map}) ## @deftypefnx {Function File} {@var{cmap} =} colormap ("default") ## @deftypefnx {Function File} {@var{cmap} =} colormap ("@var{map_name}") ## @deftypefnx {Function File} {@var{cmap} =} colormap (@var{hax}, @dots{}) ## @deftypefnx {Command} {} colormap @var{map_name} ## @deftypefnx {Function File} {@var{cmaps} =} colormap ("list") ## @deftypefnx {Function File} {} colormap ("register", "@var{name}") ## @deftypefnx {Function File} {} colormap ("unregister", "@var{name}") ## Query or set the current colormap. ## ## With no input arguments, @code{colormap} returns the current color map. ## ## @code{colormap (@var{map})} sets the current colormap to @var{map}. The ## colormap should be an @var{n} row by 3 column matrix. The columns ## contain red, green, and blue intensities respectively. All entries ## must be between 0 and 1 inclusive. The new colormap is returned. ## ## @code{colormap ("default")} restores the default colormap (the ## @code{jet} map with 64 entries). The default colormap is returned. ## ## The map may also be specified by a string, @qcode{"@var{map_name}"}, where ## @var{map_name} is the name of a function that returns a colormap. ## ## If the first argument @var{hax} is an axes handle, then the colormap for ## the parent figure of @var{hax} is queried or set. ## ## For convenience, it is also possible to use this function with the ## command form, @code{colormap @var{map_name}}. ## ## @code{colormap ("list")} returns a cell array with all of the available ## colormaps. The options @qcode{"register"} and @qcode{"unregister"} ## add or remove the colormap @var{name} from this list. ## ## @seealso{jet} ## @end deftypefn ## Author: Tony Richardson <arichard@stark.cc.oh.us> ## Created: July 1994 ## Adapted-By: jwe function cmap = colormap (varargin) mlock; # prevent map_list to be cleared by "clear all" persistent map_list = cell (); [hax, varargin, nargin] = __plt_get_axis_arg__ ("colormap", varargin{:}); if (nargin > 2) print_usage (); endif if (! isempty (hax)) cf = ancestor (hax, "figure"); else cf = get (0, "currentfigure"); endif if (nargin == 1) map = varargin{1}; if (ischar (map)) if (strcmp (map, "default")) map = jet (64); elseif (strcmp (map, "list")) cmap = map_list; return; else map = feval (map); endif endif if (! isempty (map)) if (! (isnumeric (map) && isreal (map) && ndims (map) == 2 && columns (map) == 3)) error ("colormap: MAP must be a real-valued N x 3 ([R,G,B]) matrix"); endif if (any (map(:) < 0) || any (map(:) > 1)) error ("colormap: all MAP values must be in the range [0,1]"); endif if (isempty (cf)) cf = gcf (); endif ## Set the new color map set (cf, "colormap", map); endif elseif (nargin == 2) opt = varargin{1}; name = varargin{2}; if (! ischar (opt) || ! any (strcmp (opt, {"register", "unregister"}))) print_usage (); elseif (! ischar (name)) error ("colormap: to register/unregister a colormap, NAME must be a string"); elseif (strcmp (opt, "register")) map_list{end+1} = name; elseif (strcmp (opt, "unregister")) map_list(strcmp (name, map_list)) = []; endif endif ## Return current color map. if (nargout > 0 || (nargout == 0 && nargin == 0)) if (isempty (cf)) cf = gcf (); endif cmap = get (cf, "colormap"); endif endfunction %!demo %! ## Create an image for displaying a colormap %! image (1:64, linspace (0, 1, 64), repmat ((1:64)', 1, 64)); %! axis ([1, 64, 0, 1], "ticy", "xy"); %! ## Show 'jet' colormap %! colormap (jet (64)); %! title "colormap (jet (64))" %! disp ("Press a key to continue"); %! pause (); %! ## Show 'colorcube' colormap %! colormap (colorcube (64)); %! title "colormap (colorcube (64))" %!test %! hf = figure ("visible", "off"); %! unwind_protect %! cmaptst = [0 1 0; 1 0 1; 1 1 1]; %! cmap = colormap (cmaptst); %! assert (cmap, cmaptst); %! cmap = colormap (); %! assert (cmap, cmaptst); %! cmap = (get (gcf, "colormap")); %! assert (cmap, cmaptst); %! colormap ("default"); %! assert (colormap (), jet (64)); %! colormap ("ocean"); %! assert (colormap, ocean (64)); %! unwind_protect_cleanup %! close (hf); %! end_unwind_protect %!test %! hf = figure ("visible", "off"); %! unwind_protect %! cmaplst = colormap ("list"); %! assert (iscell (cmaplst)); %! colormap ("register", "__mycmap__"); %! cmaplst2 = colormap ("list"); %! assert (numel (cmaplst2), numel (cmaplst) + 1); %! assert (any (strcmp (cmaplst2, "__mycmap__"))); %! colormap ("unregister", "__mycmap__"); %! cmaplst2 = colormap ("list"); %! assert (numel (cmaplst2), numel (cmaplst)); %! assert (! any (strcmp (cmaplst2, "__mycmap__"))); %! ## Unregister again and verify that nothing has happened %! colormap ("unregister", "__mycmap__"); %! cmaplst3 = colormap ("list"); %! assert (isequal (cmaplst2, cmaplst3)); %! unwind_protect_cleanup %! close (hf); %! end_unwind_protect ## Test input validation %!error colormap (1,2,3) %!error <MAP must be a real-valued N x 3> colormap ({1,2,3}) %!error <MAP must be a real-valued N x 3> colormap ([1 i 1]) %!error <MAP must be a real-valued N x 3> colormap (ones(3,3,3)) %!error <MAP must be a real-valued N x 3> colormap ([1 0 1 0]) %!error <all MAP values must be in the range> colormap ([-1 0 0]) %!error <all MAP values must be in the range> colormap ([2 0 0]) %!error colormap ("invalid", "name") %!error <NAME must be a string> colormap ("register", 1)