Mercurial > octave-nkf
annotate scripts/image/flag.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) 1999-2012 Kai Habel |
6793 | 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. | |
6793 | 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/>. | |
6793 | 18 |
19 ## -*- texinfo -*- | |
11420
466ba499eff5
Update docstrings for colormap files.
Rik <octave@nomad.inbox5.com>
parents:
9751
diff
changeset
|
20 ## @deftypefn {Function File} {@var{map} =} flag () |
466ba499eff5
Update docstrings for colormap files.
Rik <octave@nomad.inbox5.com>
parents:
9751
diff
changeset
|
21 ## @deftypefnx {Function File} {@var{map} =} flag (@var{n}) |
14260
1f911333ed3d
doc: Update docstrings for functions in image/ directory
Rik <octave@nomad.inbox5.com>
parents:
14237
diff
changeset
|
22 ## Create color colormap. This colormap cycles through red, white, blue, |
11420
466ba499eff5
Update docstrings for colormap files.
Rik <octave@nomad.inbox5.com>
parents:
9751
diff
changeset
|
23 ## and black with each index change. |
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. |
6793 | 26 ## @seealso{colormap} |
27 ## @end deftypefn | |
28 | |
29 ## Author: Kai Habel <kai.habel@gmx.de> | |
30 | |
11420
466ba499eff5
Update docstrings for colormap files.
Rik <octave@nomad.inbox5.com>
parents:
9751
diff
changeset
|
31 function map = flag (n) |
6793 | 32 |
33 if (nargin == 0) | |
11420
466ba499eff5
Update docstrings for colormap files.
Rik <octave@nomad.inbox5.com>
parents:
9751
diff
changeset
|
34 n = rows (colormap); |
6793 | 35 elseif (nargin == 1) |
11420
466ba499eff5
Update docstrings for colormap files.
Rik <octave@nomad.inbox5.com>
parents:
9751
diff
changeset
|
36 if (! isscalar (n)) |
6793 | 37 error ("flag: argument must be a scalar"); |
38 endif | |
39 else | |
40 print_usage (); | |
41 endif | |
42 | |
43 p = [1, 0, 0; 1, 1, 1; 0, 0, 1; 0, 0, 0]; | |
11420
466ba499eff5
Update docstrings for colormap files.
Rik <octave@nomad.inbox5.com>
parents:
9751
diff
changeset
|
44 if (rem(n,4) == 0) |
466ba499eff5
Update docstrings for colormap files.
Rik <octave@nomad.inbox5.com>
parents:
9751
diff
changeset
|
45 map = kron (ones (n / 4, 1), p); |
6793 | 46 else |
11420
466ba499eff5
Update docstrings for colormap files.
Rik <octave@nomad.inbox5.com>
parents:
9751
diff
changeset
|
47 m1 = kron (ones (fix (n / 4), 1), p); |
466ba499eff5
Update docstrings for colormap files.
Rik <octave@nomad.inbox5.com>
parents:
9751
diff
changeset
|
48 m2 = p(1:rem (n, 4), :); |
7017 | 49 map = [m1; m2]; |
6793 | 50 endif |
51 | |
52 endfunction | |
9751
2b0cc0b6db61
Add demos for colormap functions
Soren Hauberg <hauberg@gmail.com>
parents:
9245
diff
changeset
|
53 |
14237
11949c9795a0
Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
54 |
9751
2b0cc0b6db61
Add demos for colormap functions
Soren Hauberg <hauberg@gmail.com>
parents:
9245
diff
changeset
|
55 %!demo |
2b0cc0b6db61
Add demos for colormap functions
Soren Hauberg <hauberg@gmail.com>
parents:
9245
diff
changeset
|
56 %! ## Show the 'flag' 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
|
57 %! 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
|
58 %! 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
|
59 %! colormap (flag (64)); |
9751
2b0cc0b6db61
Add demos for colormap functions
Soren Hauberg <hauberg@gmail.com>
parents:
9245
diff
changeset
|
60 |