view scripts/image/lines.m @ 14272:4f8d2931f886

lines.m: Add new colormap corresponding to ColorOrder property. * lines.m: New colormap file * scripts/image/module.mk: Add lines.m to build system. * image.txi: Add lines() to documentation. * NEWS: Add lines() to list of new functions in 3.8 * aspell-octave.en.pws: Add "ColorOrder" to list of spelling exceptions.
author Rik <octave@nomad.inbox5.com>
date Fri, 27 Jan 2012 20:54:15 -0800
parents
children f205d0074687
line wrap: on
line source

## Copyright (C) 2012 Rik Wehbring
##
## 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{map} =} lines ()
## @deftypefnx {Function File} {@var{map} =} lines (@var{n})
## Create color colormap.  This colormap is composed of the list of colors
## in the current axes "ColorOrder" property.  The default is blue,
## green, red, cyan, pink, yellow, and gray.
## The argument @var{n} must be a scalar.
## If unspecified, the length of the current colormap, or 64, is used.
## @seealso{colormap}
## @end deftypefn

function map = lines (n)

  if (nargin == 0)
    n = rows (colormap);
  elseif (nargin == 1)
    if (! isscalar (n))
      error ("lines: argument must be a scalar");
    endif
  else
    print_usage ();
  endif

  c = get (gca, "colororder");
  nr = rows (c);
  map = c(rem (0:(n-1), nr) + 1, :);

endfunction


%!demo
%! ## Show the 'lines' colormap as an image
%! image (1:64, linspace (0, 1, 64), repmat ((1:64)', 1, 64));
%! axis ([1, 64, 0, 1], "ticy", "xy");
%! colormap (lines (64));