octave-nkf: scripts/image/ocean.m annotate

annotate scripts/image/ocean.m @ 14641:5f1d4def40e1

improve compatibility of colormap functions * autumn.m, bone.m, cool.m, copper.m, flag.m, gmap40.m, gray.m, hot.m, hsv.m, jet.m, lines.m, ocean.m, pink.m, prism.m, rainbow.m, spring.m, summer.m, winter: Always size and return 0x3 when size < 1. Return same values as Matlab when size == 1.

author	Carnë Draug <carandraug+dev@gmail.com>
date	Wed, 16 May 2012 16:52:44 -0400
parents	b9c02ee24de1
children	1a800034d443

rev	line source
14138 72c96de7a403 maint: update copyright notices for 2012 John W. Eaton <jwe@octave.org> parents: 11587 diff changeset	1 ## Copyright (C) 1994-2012 John W. Eaton
2313 5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	2 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	3 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	4 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	5 ## Octave is free software; you can redistribute it and/or modify it
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	6 ## under the terms of the GNU General Public License as published by
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6791 diff changeset	7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6791 diff changeset	8 ## your option) any later version.
2313 5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	9 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	10 ## Octave is distributed in the hope that it will be useful, but
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	13 ## General Public License for more details.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	14 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	15 ## You should have received a copy of the GNU General Public License
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6791 diff changeset	16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6791 diff changeset	17 ## <http://www.gnu.org/licenses/>.
559 4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe] jwe parents: diff changeset	18
3381 69b167451491 [project @ 1999-12-15 20:48:10 by jwe] jwe parents: 3373 diff changeset	19 ## -- texinfo --
11420 466ba499eff5 Update docstrings for colormap files. Rik <octave@nomad.inbox5.com> parents: 9751 diff changeset	20 ## @deftypefn {Function File} {@var{map} =} ocean ()
466ba499eff5 Update docstrings for colormap files. Rik <octave@nomad.inbox5.com> parents: 9751 diff changeset	21 ## @deftypefnx {Function File} {@var{map} =} ocean (@var{n})
466ba499eff5 Update docstrings for colormap files. Rik <octave@nomad.inbox5.com> parents: 9751 diff changeset	22 ## Create color colormap. This colormap varies from black to white with shades
466ba499eff5 Update docstrings for colormap files. Rik <octave@nomad.inbox5.com> parents: 9751 diff changeset	23 ## of blue.
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	24 ## The argument @var{n} must be a scalar.
11420 466ba499eff5 Update docstrings for colormap files. Rik <octave@nomad.inbox5.com> parents: 9751 diff changeset	25 ## If unspecified, the length of the current colormap, or 64, is used.
14260 1f911333ed3d doc: Update docstrings for functions in image/ directory Rik <octave@nomad.inbox5.com> parents: 14237 diff changeset	26 ## @seealso{colormap}
3373 36405da8e173 [project @ 1999-11-23 20:54:17 by jwe] jwe parents: 3202 diff changeset	27 ## @end deftypefn
1024 56520a75b5b3 [project @ 1995-01-11 20:30:04 by jwe] jwe parents: 904 diff changeset	28
3202 44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe] jwe parents: 2847 diff changeset	29 ## Author: Tony Richardson <arichard@stark.cc.oh.us>
2312 204cc7db6f4a [project @ 1996-07-11 21:20:36 by jwe] jwe parents: 2311 diff changeset	30 ## Created: July 1994
204cc7db6f4a [project @ 1996-07-11 21:20:36 by jwe] jwe parents: 2311 diff changeset	31 ## Adapted-By: jwe
1024 56520a75b5b3 [project @ 1995-01-11 20:30:04 by jwe] jwe parents: 904 diff changeset	32
14640 b9c02ee24de1 new colormap options Carnë Draug <carandraug+dev@gmail.com> parents: 14279 diff changeset	33 ## PKG_ADD: colormap ("register", "ocean");
b9c02ee24de1 new colormap options Carnë Draug <carandraug+dev@gmail.com> parents: 14279 diff changeset	34 ## PKG_DEL: colormap ("unregister", "ocean");
b9c02ee24de1 new colormap options Carnë Draug <carandraug+dev@gmail.com> parents: 14279 diff changeset	35
11420 466ba499eff5 Update docstrings for colormap files. Rik <octave@nomad.inbox5.com> parents: 9751 diff changeset	36 function map = ocean (n)
1024 56520a75b5b3 [project @ 1995-01-11 20:30:04 by jwe] jwe parents: 904 diff changeset	37
56520a75b5b3 [project @ 1995-01-11 20:30:04 by jwe] jwe parents: 904 diff changeset	38 if (nargin == 0)
11420 466ba499eff5 Update docstrings for colormap files. Rik <octave@nomad.inbox5.com> parents: 9751 diff changeset	39 n = rows (colormap);
1024 56520a75b5b3 [project @ 1995-01-11 20:30:04 by jwe] jwe parents: 904 diff changeset	40 elseif (nargin == 1)
11420 466ba499eff5 Update docstrings for colormap files. Rik <octave@nomad.inbox5.com> parents: 9751 diff changeset	41 if (! isscalar (n))
1024 56520a75b5b3 [project @ 1995-01-11 20:30:04 by jwe] jwe parents: 904 diff changeset	42 error ("ocean: argument must be a scalar");
56520a75b5b3 [project @ 1995-01-11 20:30:04 by jwe] jwe parents: 904 diff changeset	43 endif
56520a75b5b3 [project @ 1995-01-11 20:30:04 by jwe] jwe parents: 904 diff changeset	44 else
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 5307 diff changeset	45 print_usage ();
559 4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe] jwe parents: diff changeset	46 endif
4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe] jwe parents: diff changeset	47
14641 5f1d4def40e1 improve compatibility of colormap functions Carnë Draug <carandraug+dev@gmail.com> parents: 14640 diff changeset	48 if (n == 1)
5f1d4def40e1 improve compatibility of colormap functions Carnë Draug <carandraug+dev@gmail.com> parents: 14640 diff changeset	49 map = [0, 0, 0];
5f1d4def40e1 improve compatibility of colormap functions Carnë Draug <carandraug+dev@gmail.com> parents: 14640 diff changeset	50 elseif (n > 1)
5f1d4def40e1 improve compatibility of colormap functions Carnë Draug <carandraug+dev@gmail.com> parents: 14640 diff changeset	51 cutin = fix (n/3);
2325 b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe] jwe parents: 2313 diff changeset	52
14641 5f1d4def40e1 improve compatibility of colormap functions Carnë Draug <carandraug+dev@gmail.com> parents: 14640 diff changeset	53 dr = (n - 1) / cutin;
5f1d4def40e1 improve compatibility of colormap functions Carnë Draug <carandraug+dev@gmail.com> parents: 14640 diff changeset	54 r = prepad ([0:dr:(n-1)], n)';
1024 56520a75b5b3 [project @ 1995-01-11 20:30:04 by jwe] jwe parents: 904 diff changeset	55
14641 5f1d4def40e1 improve compatibility of colormap functions Carnë Draug <carandraug+dev@gmail.com> parents: 14640 diff changeset	56 dg = (n - 1) / (2 * cutin);
5f1d4def40e1 improve compatibility of colormap functions Carnë Draug <carandraug+dev@gmail.com> parents: 14640 diff changeset	57 g = prepad ([0:dg:(n-1)], n)';
5f1d4def40e1 improve compatibility of colormap functions Carnë Draug <carandraug+dev@gmail.com> parents: 14640 diff changeset	58
5f1d4def40e1 improve compatibility of colormap functions Carnë Draug <carandraug+dev@gmail.com> parents: 14640 diff changeset	59 b = [0:(n-1)]';
1024 56520a75b5b3 [project @ 1995-01-11 20:30:04 by jwe] jwe parents: 904 diff changeset	60
14641 5f1d4def40e1 improve compatibility of colormap functions Carnë Draug <carandraug+dev@gmail.com> parents: 14640 diff changeset	61 map = [r, g, b] / (n - 1);
5f1d4def40e1 improve compatibility of colormap functions Carnë Draug <carandraug+dev@gmail.com> parents: 14640 diff changeset	62 else
5f1d4def40e1 improve compatibility of colormap functions Carnë Draug <carandraug+dev@gmail.com> parents: 14640 diff changeset	63 map = zeros (0, 3);
5f1d4def40e1 improve compatibility of colormap functions Carnë Draug <carandraug+dev@gmail.com> parents: 14640 diff changeset	64 endif
559 4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe] jwe parents: diff changeset	65
4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe] jwe parents: diff changeset	66 endfunction
9751 2b0cc0b6db61 Add demos for colormap functions Soren Hauberg <hauberg@gmail.com> parents: 7017 diff changeset	67
14237 11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	68
9751 2b0cc0b6db61 Add demos for colormap functions Soren Hauberg <hauberg@gmail.com> parents: 7017 diff changeset	69 %!demo
2b0cc0b6db61 Add demos for colormap functions Soren Hauberg <hauberg@gmail.com> parents: 7017 diff changeset	70 %! ## Show the 'ocean' colormap as an image
14237 11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	71 %! image (1:64, linspace (0, 1, 64), repmat ((1:64)', 1, 64));
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	72 %! axis ([1, 64, 0, 1], "ticy", "xy");
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	73 %! colormap (ocean (64));
9751 2b0cc0b6db61 Add demos for colormap functions Soren Hauberg <hauberg@gmail.com> parents: 7017 diff changeset	74

Mercurial > octave-nkf

annotate scripts/image/ocean.m @ 14641:5f1d4def40e1