Mercurial > octave-nkf
annotate scripts/image/ocean.m @ 14260:1f911333ed3d
doc: Update docstrings for functions in image/ directory
* aspell-octave.en.pws, brighten.m, colormap.m, contrast.m, flag.m, gmap40.m
gray.m, gray2ind.m, hsv2rgb.m, image.m, ind2gray.m, ind2rgb.m, ntsc2rgb.m,
ocean.m, rgb2hsv.m, rgb2ind.m, rgb2ntsc.m: Update docstrings.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Tue, 24 Jan 2012 09:51:48 -0800 |
parents | 11949c9795a0 |
children | f205d0074687 |
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 | 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 | |
7016 | 7 ## the Free Software Foundation; either version 3 of the License, or (at |
8 ## your option) any later version. | |
2313 | 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 | |
7016 | 16 ## along with Octave; see the file COPYING. If not, see |
17 ## <http://www.gnu.org/licenses/>. | |
559 | 18 |
3381 | 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 | 27 ## @end deftypefn |
1024 | 28 |
3202 | 29 ## Author: Tony Richardson <arichard@stark.cc.oh.us> |
2312 | 30 ## Created: July 1994 |
31 ## Adapted-By: jwe | |
1024 | 32 |
11420
466ba499eff5
Update docstrings for colormap files.
Rik <octave@nomad.inbox5.com>
parents:
9751
diff
changeset
|
33 function map = ocean (n) |
1024 | 34 |
35 if (nargin == 0) | |
11420
466ba499eff5
Update docstrings for colormap files.
Rik <octave@nomad.inbox5.com>
parents:
9751
diff
changeset
|
36 n = rows (colormap); |
1024 | 37 elseif (nargin == 1) |
11420
466ba499eff5
Update docstrings for colormap files.
Rik <octave@nomad.inbox5.com>
parents:
9751
diff
changeset
|
38 if (! isscalar (n)) |
1024 | 39 error ("ocean: argument must be a scalar"); |
40 endif | |
41 else | |
6046 | 42 print_usage (); |
559 | 43 endif |
44 | |
11420
466ba499eff5
Update docstrings for colormap files.
Rik <octave@nomad.inbox5.com>
parents:
9751
diff
changeset
|
45 cutin = fix (n/3); |
2325 | 46 |
11420
466ba499eff5
Update docstrings for colormap files.
Rik <octave@nomad.inbox5.com>
parents:
9751
diff
changeset
|
47 dr = (n - 1) / cutin; |
1024 | 48 |
11420
466ba499eff5
Update docstrings for colormap files.
Rik <octave@nomad.inbox5.com>
parents:
9751
diff
changeset
|
49 r = prepad ([0:dr:(n-1)], n)'; |
1024 | 50 |
11420
466ba499eff5
Update docstrings for colormap files.
Rik <octave@nomad.inbox5.com>
parents:
9751
diff
changeset
|
51 dg = (n - 1) / (2 * cutin); |
1024 | 52 |
11420
466ba499eff5
Update docstrings for colormap files.
Rik <octave@nomad.inbox5.com>
parents:
9751
diff
changeset
|
53 g = prepad([0:dg:(n-1)], n)'; |
1024 | 54 |
11420
466ba499eff5
Update docstrings for colormap files.
Rik <octave@nomad.inbox5.com>
parents:
9751
diff
changeset
|
55 b = [0:(n-1)]'; |
559 | 56 |
11420
466ba499eff5
Update docstrings for colormap files.
Rik <octave@nomad.inbox5.com>
parents:
9751
diff
changeset
|
57 map = [ r, g, b ] / (n - 1); |
559 | 58 |
59 endfunction | |
9751
2b0cc0b6db61
Add demos for colormap functions
Soren Hauberg <hauberg@gmail.com>
parents:
7017
diff
changeset
|
60 |
14237
11949c9795a0
Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
61 |
9751
2b0cc0b6db61
Add demos for colormap functions
Soren Hauberg <hauberg@gmail.com>
parents:
7017
diff
changeset
|
62 %!demo |
2b0cc0b6db61
Add demos for colormap functions
Soren Hauberg <hauberg@gmail.com>
parents:
7017
diff
changeset
|
63 %! ## 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
|
64 %! 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
|
65 %! 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
|
66 %! colormap (ocean (64)); |
9751
2b0cc0b6db61
Add demos for colormap functions
Soren Hauberg <hauberg@gmail.com>
parents:
7017
diff
changeset
|
67 |