Mercurial > octave-antonio
view scripts/image/imagesc.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 ## ## 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} {} imagesc (@var{img}) ## @deftypefnx {Function File} {} imagesc (@var{x}, @var{y}, @var{img}) ## @deftypefnx {Function File} {} imagesc (@dots{}, @var{climits}) ## @deftypefnx {Function File} {} imagesc (@dots{}, "@var{prop}", @var{val}, @dots{}) ## @deftypefnx {Function File} {} imagesc ("@var{prop1}", @var{val1}, @dots{}) ## @deftypefnx {Function File} {} imagesc (@var{hax}, @dots{}) ## @deftypefnx {Function File} {@var{h} =} imagesc (@dots{}) ## Display a scaled version of the matrix @var{img} as a color image. ## ## The colormap is scaled so that the entries of the matrix occupy the entire ## colormap. If @code{@var{climits} = [@var{lo}, @var{hi}]} is given, then ## that range is set to the @qcode{"clim"} of the current axes. ## ## The axis values corresponding to the matrix elements are specified in ## @var{x} and @var{y}, either as pairs giving the minimum and maximum ## values for the respective axes, or as values for each row and column ## of the matrix @var{img}. ## ## The optional return value @var{h} is a graphics handle to the image. ## ## Calling Forms: The @code{imagesc} function can be called in two forms: ## High-Level and Low-Level. When invoked with normal options, the High-Level ## form is used which first calls @code{newplot} to prepare the graphic figure ## and axes. When the only inputs to @code{image} are property/value pairs ## the Low-Level form is used which creates a new instance of an image object ## and inserts it in the current axes. ## ## @seealso{image, imshow, caxis} ## @end deftypefn ## Author: Tony Richardson <arichard@stark.cc.oh.us> ## Created: July 1994 ## Adapted-By: jwe function h = imagesc (varargin) [hax, varargin, nargin] = __plt_get_axis_arg__ ("imagesc", varargin{:}); chararg = find (cellfun ("isclass", varargin, "char"), 1, "first"); do_new = true; if (nargin == 0) print_usage (); elseif (chararg == 1) ## Low-Level syntax do_new = false; img = x = y = climits = []; elseif (nargin == 1 || chararg == 2) img = varargin{1}; x = y = climits = []; elseif (nargin == 2 || chararg == 3) img = varargin{1}; climits = varargin{2}; x = y = []; elseif (nargin == 3 || chararg == 4) x = varargin{1}; y = varargin{2}; img = varargin{3}; climits = []; elseif (nargin == 4 || chararg == 5) x = varargin{1}; y = varargin{2}; img = varargin{3}; climits = varargin{4}; endif oldfig = []; if (! isempty (hax)) oldfig = get (0, "currentfigure"); endif unwind_protect if (do_new) hax = newplot (hax); elseif (isempty (hax)) hax = gca (); endif if (do_new) htmp = image (x, y, img, "cdatamapping", "scaled", varargin{chararg:end}); else htmp = image ("cdatamapping", "scaled", varargin{:}); endif if (do_new && ! ishold (hax)) ## use given climits or guess them from the matrix if (numel (climits) == 2 && climits(1) <= climits(2)) set (hax, "clim", climits); elseif (! isempty (climits)) error ("imagesc: CLIMITS must be in form [lo, hi]"); endif endif unwind_protect_cleanup if (! isempty (oldfig)) set (0, "currentfigure", oldfig); endif end_unwind_protect if (nargout > 0) h = htmp; endif endfunction %!demo %! clf; %! colormap ("default"); %! img = 1 ./ hilb (11); %! x = y = -5:5; %! subplot (2,2,1); %! h = imagesc (x, y, img); %! ylabel ("limits = [-5.5, 5.5]"); %! title ("imagesc (x, y, img)"); %! subplot (2,2,2); %! h = imagesc (-x, y, img); %! title ("imagesc (-x, y, img)"); %! subplot (2,2,3); %! h = imagesc (x, -y, img); %! title ("imagesc (x, -y, img)"); %! ylabel ("limits = [-5.5, 5.5]"); %! subplot (2,2,4); %! h = imagesc (-x, -y, img); %! title ("imagesc (-x, -y, img)"); %!demo %! clf; %! colormap ("default"); %! g = 0.1:0.1:10; %! h = g'*g; %! imagesc (g, g, sin (h)); %! hold on; %! imagesc (g, g+12, cos (h/2)); %! axis ([0 10 0 22]); %! hold off; %! title ("two consecutive images"); %!demo %! clf; %! colormap ("default"); %! g = 0.1:0.1:10; %! h = g'*g; %! imagesc (g, g, sin (h)); %! hold all; %! plot (g, 11.0 * ones (size (g))); %! imagesc (g, g+12, cos (h/2)); %! axis ([0 10 0 22]); %! hold off; %! title ("image, line, image"); %!demo %! clf; %! colormap ("default"); %! g = 0.1:0.1:10; %! h = g'*g; %! plot (g, 10.5 * ones (size (g))); %! hold all; %! imagesc (g, g, sin (h)); %! plot (g, 11.0 * ones (size (g))); %! imagesc (g, g+12, cos (h/2)); %! plot (g, 11.5 * ones (size (g))); %! axis ([0 10 0 22]); %! hold off; %! title ("line, image, line, image, line");