Mercurial > hg > octave-lyh
annotate scripts/image/ind2gray.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 | 72c96de7a403 |
| children | 806ea52af230 14b7679891dd |
| rev | line source |
|---|---|
|
14138
72c96de7a403
maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents:
11523
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/>. | |
| 1024 | 18 |
| 3381 | 19 ## -*- texinfo -*- |
|
14260
1f911333ed3d
doc: Update docstrings for functions in image/ directory
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
20 ## @deftypefn {Function File} {} ind2gray (@var{x}) |
|
1f911333ed3d
doc: Update docstrings for functions in image/ directory
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
21 ## @deftypefnx {Function File} {} ind2gray (@var{x}, @var{map}) |
|
1f911333ed3d
doc: Update docstrings for functions in image/ directory
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
22 ## Convert a color indexed image to a gray scale intensity image. |
| 3373 | 23 ## If @var{map} is omitted, the current colormap is used to determine the |
| 24 ## intensities. | |
|
14260
1f911333ed3d
doc: Update docstrings for functions in image/ directory
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
25 ## @seealso{gray2ind, ind2rgb} |
| 3373 | 26 ## @end deftypefn |
| 904 | 27 |
| 3202 | 28 ## Author: Tony Richardson <arichard@stark.cc.oh.us> |
| 2312 | 29 ## Created: July 1994 |
| 30 ## Adapted-By: jwe | |
| 559 | 31 |
|
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
7017
diff
changeset
|
32 function y = ind2gray (x, map) |
| 1024 | 33 |
| 34 if (nargin < 1 || nargin > 2) | |
| 6046 | 35 print_usage (); |
| 1024 | 36 elseif (nargin == 1) |
| 37 map = colormap (); | |
| 559 | 38 endif |
| 39 | |
|
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
7017
diff
changeset
|
40 [rows, cols] = size (x); |
| 917 | 41 |
| 3486 | 42 ## Convert colormap to intensity values (the first column of the |
| 43 ## result of the call to rgb2ntsc) and then replace indices in | |
| 44 ## the input matrix with indexed values in the output matrix (indexed | |
| 6653 | 45 ## values are the result of indexing the intensity values by the |
|
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
7017
diff
changeset
|
46 ## elements of x(:)). |
| 559 | 47 |
|
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
7017
diff
changeset
|
48 y = reshape (((rgb2ntsc (map))(:,1))(x(:)), rows, cols); |
| 559 | 49 |
| 50 endfunction |