Mercurial > jwe > octave
view scripts/image/white.m @ 20852:516bb87ea72e
2015 Code Sprint: remove class of function from docstring for all m-files.
author | Rik <rik@octave.org> |
---|---|
date | Sat, 12 Dec 2015 07:31:00 -0800 |
parents | 0338dc274ec5 |
children | 894239974868 |
line wrap: on
line source
## Copyright (C) 1999-2015 Kai Habel ## ## 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 {} {@var{map} =} white () ## @deftypefnx {} {@var{map} =} white (@var{n}) ## Create color colormap. This colormap is completely white. ## ## The argument @var{n} must be a scalar. ## If unspecified, the length of the current colormap, or 64, is used. ## @seealso{colormap} ## @end deftypefn ## Author: Kai Habel <kai.habel@gmx.de> ## PKG_ADD: colormap ("register", "white"); ## PKG_DEL: colormap ("unregister", "white"); function map = white (n = rows (colormap ())) if (nargin > 1) print_usage (); elseif (! isscalar (n)) error ("white: N must be a scalar"); endif map = ones (n, 3); endfunction %!demo %! ## Show the 'white' colormap profile and as an image %! cmap = white (256); %! subplot (2, 1, 1); %! rgbplot (cmap, "composite"); %! subplot (2, 1, 2); %! rgbplot (cmap);