octave_packages/m/image/ocean.m

   1 ## Copyright (C) 1994-2012 John W. Eaton
   2 ##
   3 ## This file is part of Octave.
   4 ##
   5 ## Octave is free software; you can redistribute it and/or modify it
   6 ## under the terms of the GNU General Public License as published by
   7 ## the Free Software Foundation; either version 3 of the License, or (at
   8 ## your option) any later version.
   9 ##
  10 ## Octave is distributed in the hope that it will be useful, but
  11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
  12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 ## General Public License for more details.
  14 ##
  15 ## You should have received a copy of the GNU General Public License
  16 ## along with Octave; see the file COPYING.  If not, see
  17 ## <http://www.gnu.org/licenses/>.
  18
  19 ## -*- texinfo -*-
  20 ## @deftypefn  {Function File} {@var{map} =} ocean ()
  21 ## @deftypefnx {Function File} {@var{map} =} ocean (@var{n})
  22 ## Create color colormap.  This colormap varies from black to white with shades
  23 ## of blue.
  24 ## The argument @var{n} must be a scalar.
  25 ## If unspecified, the length of the current colormap, or 64, is used.
  26 ## @end deftypefn
  27
  28 ## Author: Tony Richardson <arichard@stark.cc.oh.us>
  29 ## Created: July 1994
  30 ## Adapted-By: jwe
  31
  32 function map = ocean (n)
  33
  34   if (nargin == 0)
  35     n = rows (colormap);
  36   elseif (nargin == 1)
  37     if (! isscalar (n))
  38       error ("ocean: argument must be a scalar");
  39     endif
  40   else
  41     print_usage ();
  42   endif
  43
  44   cutin = fix (n/3);
  45
  46   dr = (n - 1) / cutin;
  47
  48   r = prepad ([0:dr:(n-1)], n)';
  49
  50   dg = (n - 1) / (2 * cutin);
  51
  52   g = prepad([0:dg:(n-1)], n)';
  53
  54   b = [0:(n-1)]';
  55
  56   map = [ r, g, b ] / (n - 1);
  57
  58 endfunction
  59
  60 %!demo
  61 %! ## Show the 'ocean' colormap as an image
  62 %! image (1:64, linspace (0, 1, 64), repmat (1:64, 64, 1)')
  63 %! axis ([1, 64, 0, 1], "ticy", "xy")
  64 %! colormap (ocean (64))
  65