Mercurial > octave

comparison scripts/image/imagesc.m @ 17689:dd8db3f1c1da

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Add information about High-Level/Low-Level calling forms for image, imagesc. * scripts/image/image.m: Add info about High-Level/Low-Level calling forms to docstring. * scripts/image/imagesc.m: Add info about High-Level/Low-Level calling forms to docstring. Add @deftypefnx showing how to call function with prop/val pairs.
author Rik <rik@octave.org>
date Fri, 18 Oct 2013 14:19:18 -0700
parents bc924baa2c4e
children 38cf56b77274
comparison
equal deleted inserted replaced
17688:8031fc73f291 17689:dd8db3f1c1da
18 18
19 ## -*- texinfo -*- 19 ## -*- texinfo -*-
20 ## @deftypefn {Function File} {} imagesc (@var{img}) 20 ## @deftypefn {Function File} {} imagesc (@var{img})
21 ## @deftypefnx {Function File} {} imagesc (@var{x}, @var{y}, @var{img}) 21 ## @deftypefnx {Function File} {} imagesc (@var{x}, @var{y}, @var{img})
22 ## @deftypefnx {Function File} {} imagesc (@dots{}, @var{climits}) 22 ## @deftypefnx {Function File} {} imagesc (@dots{}, @var{climits})
23 ## @deftypefnx {Function File} {} imagesc (@dots{}, "@var{prop}", @var{val}, @dots{})
24 ## @deftypefnx {Function File} {} imagesc ("@var{prop1}", @var{val1}, @dots{})
23 ## @deftypefnx {Function File} {} imagesc (@var{hax}, @dots{}) 25 ## @deftypefnx {Function File} {} imagesc (@var{hax}, @dots{})
24 ## @deftypefnx {Function File} {@var{h} =} imagesc (@dots{}) 26 ## @deftypefnx {Function File} {@var{h} =} imagesc (@dots{})
25 ## Display a scaled version of the matrix @var{img} as a color image. The 27 ## Display a scaled version of the matrix @var{img} as a color image. The
26 ## colormap is scaled so that the entries of the matrix occupy the entire 28 ## colormap is scaled so that the entries of the matrix occupy the entire
27 ## colormap. If @code{@var{climits} = [@var{lo}, @var{hi}]} is given, then that 29 ## colormap. If @code{@var{climits} = [@var{lo}, @var{hi}]} is given, then that
31 ## @var{x} and @var{y}, either as pairs giving the minimum and maximum 33 ## @var{x} and @var{y}, either as pairs giving the minimum and maximum
32 ## values for the respective axes, or as values for each row and column 34 ## values for the respective axes, or as values for each row and column
33 ## of the matrix @var{img}. 35 ## of the matrix @var{img}.
34 ## 36 ##
35 ## The optional return value @var{h} is a graphics handle to the image. 37 ## The optional return value @var{h} is a graphics handle to the image.
38 ##
39 ## Calling Forms: The @code{imagesc} function can be called in two forms:
40 ## High-Level and Low-Level. When invoked with normal options, the High-Level
41 ## form is used which first calls @code{newplot} to prepare the graphic figure
42 ## and axes. When the only inputs to @code{image} are property/value pairs
43 ## the Low-Level form is used which creates a new instance of an image object
44 ## and inserts it in the current axes.
45 ##
36 ## @seealso{image, imshow, caxis} 46 ## @seealso{image, imshow, caxis}
37 ## @end deftypefn 47 ## @end deftypefn
38 48
39 ## Author: Tony Richardson <arichard@stark.cc.oh.us> 49 ## Author: Tony Richardson <arichard@stark.cc.oh.us>
40 ## Created: July 1994 50 ## Created: July 1994