Mercurial > octave-nkf
annotate scripts/image/gray2ind.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 | 5d3a684236b0 |
| 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/>. | |
| 559 | 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} {[@var{img} =} gray2ind (@var{I}) |
|
1f911333ed3d
doc: Update docstrings for functions in image/ directory
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
21 ## @deftypefnx {Function File} {[@var{img} =} gray2ind (@var{I}, @var{n}) |
|
1f911333ed3d
doc: Update docstrings for functions in image/ directory
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
22 ## @deftypefnx {Function File} {[@var{img}, @var{map} =} gray2ind (@dots{}) |
| 3373 | 23 ## Convert a gray scale intensity image to an Octave indexed image. |
|
14260
1f911333ed3d
doc: Update docstrings for functions in image/ directory
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
24 ## The indexed image will consist of @var{n} different intensity values. |
|
1f911333ed3d
doc: Update docstrings for functions in image/ directory
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
25 ## If not given @var{n} defaults to 64. |
|
1f911333ed3d
doc: Update docstrings for functions in image/ directory
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
26 ## @seealso{ind2gray, rgb2ind} |
| 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 |
| 7375 | 33 function [X, map] = gray2ind (I, n = 64) |
| 34 ## Check input | |
| 1024 | 35 if (nargin < 1 || nargin > 2) |
| 6046 | 36 print_usage (); |
| 7375 | 37 endif |
| 38 C = class(I); | |
| 39 if (! ismatrix (I) || ndims (I) != 2) | |
| 40 error ("gray2ind: first input argument must be a gray scale image"); | |
| 41 endif | |
| 42 if (! isscalar (n) || n < 0) | |
| 43 error ("gray2ind: second input argument must be a positive integer"); | |
| 44 endif | |
| 45 ints = {"uint8", "uint16", "int8", "int16"}; | |
| 46 floats = {"double", "single"}; | |
| 47 if (! ismember (C, {ints{:}, floats{:}})) | |
| 48 error ("gray2ind: invalid data type '%s'", C); | |
| 49 endif | |
| 50 if (ismember (C, floats) && (min (I(:)) < 0 || max (I(:)) > 1)) | |
| 51 error ("gray2ind: floating point images may only contain values between 0 and 1"); | |
| 559 | 52 endif |
| 53 | |
| 7375 | 54 ## Convert data |
| 1024 | 55 map = gray (n); |
| 7375 | 56 ## If @var{I} is an integer matrix convert it to a double matrix with values in [0, 1] |
| 57 if (ismember (C, ints)) | |
| 58 low = double (intmin (C)); | |
| 59 high = double (intmax (C)); | |
| 60 I = (double (I) - low) / (high - low); | |
| 61 endif | |
| 1024 | 62 X = round (I*(n-1)) + 1; |
| 559 | 63 |
| 64 endfunction |