Mercurial > octave
view scripts/image/iscolormap.m @ 20991:3ec8332e0e01
maint: Use two newlines between endfunction and start of BIST tests.
* im2double.m, imread.m, iscolormap.m, ntsc2rgb.m:
Use two newlines between endfunction and start of BIST tests.
author | Rik <rik@octave.org> |
---|---|
date | Sat, 26 Dec 2015 20:41:49 -0800 |
parents | 516bb87ea72e |
children | bac0d6f07a3e |
line wrap: on
line source
## Copyright (C) 2012-2015 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 {} {} iscolormap (@var{cmap}) ## Return true if @var{cmap} is a colormap. ## ## A colormap is a real matrix, of class single or double, with 3 columns. ## Each row represents a single color. The 3 columns contain red, green, ## and blue intensities respectively. ## ## All values in a colormap should be in the [0 1] range but this is not ## enforced. Each function must decide what to do for values outside this ## range. ## ## @seealso{colormap, rgbplot} ## @end deftypefn ## Author: Carnë Draug <carandraug+dev@gmail.com> function retval = iscolormap (cmap) if (nargin != 1) print_usage; endif retval = (isnumeric (cmap) && isreal (cmap) && ndims (cmap) == 2 && columns (cmap) == 3 && isfloat (cmap)); endfunction %!assert (iscolormap (jet (64))) %!assert (iscolormap ({0 1 0}), false) %!assert (iscolormap ([0 1i 0]), false) %!assert (iscolormap (ones (3,3,3)), false) %!assert (iscolormap (ones (3,4)), false)