Mercurial > octave-antonio
annotate scripts/image/iscolormap.m @ 20158:7503499a252b stable
doc: Update docstrings to have one sentence summary as first line.
Update scripts in audio, elfun, general, geometry, and image directories.
* scripts/audio/@audioplayer/__get_properties__.m,
scripts/audio/@audioplayer/audioplayer.m, scripts/audio/@audioplayer/get.m,
scripts/audio/@audioplayer/isplaying.m, scripts/audio/@audioplayer/play.m,
scripts/audio/@audioplayer/playblocking.m, scripts/audio/@audioplayer/set.m,
scripts/audio/@audioplayer/subsasgn.m, scripts/audio/@audioplayer/subsref.m,
scripts/audio/@audiorecorder/audiorecorder.m,
scripts/audio/@audiorecorder/get.m,
scripts/audio/@audiorecorder/getaudiodata.m,
scripts/audio/@audiorecorder/getplayer.m,
scripts/audio/@audiorecorder/isrecording.m,
scripts/audio/@audiorecorder/play.m, scripts/audio/@audiorecorder/record.m,
scripts/audio/@audiorecorder/recordblocking.m,
scripts/audio/@audiorecorder/set.m, scripts/audio/@audiorecorder/stop.m,
scripts/audio/@audiorecorder/subsasgn.m,
scripts/audio/@audiorecorder/subsref.m, scripts/audio/lin2mu.m,
scripts/audio/mu2lin.m, scripts/audio/record.m, scripts/audio/sound.m,
scripts/audio/soundsc.m, scripts/audio/wavread.m, scripts/audio/wavwrite.m,
scripts/elfun/cosd.m, scripts/elfun/sind.m, scripts/elfun/tand.m,
scripts/general/accumarray.m, scripts/general/accumdim.m,
scripts/general/bitcmp.m, scripts/general/bitget.m, scripts/general/bitset.m,
scripts/general/blkdiag.m, scripts/general/cart2pol.m,
scripts/general/cart2sph.m, scripts/general/cell2mat.m,
scripts/general/celldisp.m, scripts/general/chop.m,
scripts/general/circshift.m, scripts/general/common_size.m,
scripts/general/cplxpair.m, scripts/general/cumtrapz.m,
scripts/general/dblquad.m, scripts/general/deal.m, scripts/general/del2.m,
scripts/general/display.m, scripts/general/divergence.m,
scripts/general/fieldnames.m, scripts/general/flip.m,
scripts/general/flipdim.m, scripts/general/fliplr.m, scripts/general/flipud.m,
scripts/general/gradient.m, scripts/general/interp3.m,
scripts/general/interpft.m, scripts/general/interpn.m,
scripts/general/loadobj.m, scripts/general/logspace.m,
scripts/general/methods.m, scripts/general/nargchk.m,
scripts/general/narginchk.m, scripts/general/nargoutchk.m,
scripts/general/nextpow2.m, scripts/general/nthargout.m,
scripts/general/num2str.m, scripts/general/pol2cart.m,
scripts/general/polyarea.m, scripts/general/postpad.m,
scripts/general/prepad.m, scripts/general/profile.m, scripts/general/quadgk.m,
scripts/general/quadl.m, scripts/general/quadv.m, scripts/general/randi.m,
scripts/general/rat.m, scripts/general/repmat.m, scripts/general/rot90.m,
scripts/general/rotdim.m, scripts/general/saveobj.m, scripts/general/shift.m,
scripts/general/shiftdim.m, scripts/general/sortrows.m,
scripts/general/sph2cart.m, scripts/general/structfun.m,
scripts/general/subsindex.m, scripts/general/trapz.m,
scripts/general/triplequad.m, scripts/geometry/delaunayn.m,
scripts/geometry/dsearch.m, scripts/geometry/dsearchn.m,
scripts/geometry/griddata.m, scripts/geometry/griddata3.m,
scripts/geometry/griddatan.m, scripts/geometry/inpolygon.m,
scripts/geometry/rectint.m, scripts/geometry/tsearchn.m,
scripts/geometry/voronoi.m, scripts/geometry/voronoin.m,
scripts/help/__unimplemented__.m, scripts/help/doc.m,
scripts/help/doc_cache_create.m, scripts/help/get_first_help_sentence.m,
scripts/help/help.m, scripts/help/lookfor.m, scripts/help/print_usage.m,
scripts/help/type.m, scripts/help/which.m, scripts/image/autumn.m,
scripts/image/bone.m, scripts/image/brighten.m, scripts/image/cmpermute.m,
scripts/image/colorcube.m, scripts/image/contrast.m, scripts/image/cool.m,
scripts/image/copper.m, scripts/image/cubehelix.m, scripts/image/flag.m,
scripts/image/gmap40.m, scripts/image/gray.m, scripts/image/gray2ind.m,
scripts/image/hot.m, scripts/image/hsv.m, scripts/image/image.m,
scripts/image/imagesc.m, scripts/image/imfinfo.m, scripts/image/imformats.m,
scripts/image/imread.m, scripts/image/imshow.m, scripts/image/imwrite.m,
scripts/image/iscolormap.m, scripts/image/jet.m, scripts/image/lines.m,
scripts/image/ntsc2rgb.m, scripts/image/ocean.m, scripts/image/pink.m,
scripts/image/prism.m, scripts/image/rainbow.m, scripts/image/rgb2ntsc.m,
scripts/image/spinmap.m, scripts/image/spring.m, scripts/image/summer.m,
scripts/image/white.m, scripts/image/winter.m:
Update docstrings to have one sentence summary as first line.
Re-structure to have line lengths <= 80 chars.
author | Rik <rik@octave.org> |
---|---|
date | Sun, 03 May 2015 09:36:20 -0700 |
parents | e9f89866074c |
children |
rev | line source |
---|---|
19697
4197fc428c7d
maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents:
17744
diff
changeset
|
1 ## Copyright (C) 2012-2015 Carnë Draug |
15513
7a0a202fedfe
iscolormap: new function for image
Carnë Draug <carandraug+dev@gmail.com>
parents:
diff
changeset
|
2 ## |
7a0a202fedfe
iscolormap: new function for image
Carnë Draug <carandraug+dev@gmail.com>
parents:
diff
changeset
|
3 ## This file is part of Octave. |
7a0a202fedfe
iscolormap: new function for image
Carnë Draug <carandraug+dev@gmail.com>
parents:
diff
changeset
|
4 ## |
7a0a202fedfe
iscolormap: new function for image
Carnë Draug <carandraug+dev@gmail.com>
parents:
diff
changeset
|
5 ## Octave is free software; you can redistribute it and/or modify it |
7a0a202fedfe
iscolormap: new function for image
Carnë Draug <carandraug+dev@gmail.com>
parents:
diff
changeset
|
6 ## under the terms of the GNU General Public License as published by |
7a0a202fedfe
iscolormap: new function for image
Carnë Draug <carandraug+dev@gmail.com>
parents:
diff
changeset
|
7 ## the Free Software Foundation; either version 3 of the License, or (at |
7a0a202fedfe
iscolormap: new function for image
Carnë Draug <carandraug+dev@gmail.com>
parents:
diff
changeset
|
8 ## your option) any later version. |
7a0a202fedfe
iscolormap: new function for image
Carnë Draug <carandraug+dev@gmail.com>
parents:
diff
changeset
|
9 ## |
7a0a202fedfe
iscolormap: new function for image
Carnë Draug <carandraug+dev@gmail.com>
parents:
diff
changeset
|
10 ## Octave is distributed in the hope that it will be useful, but |
7a0a202fedfe
iscolormap: new function for image
Carnë Draug <carandraug+dev@gmail.com>
parents:
diff
changeset
|
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of |
7a0a202fedfe
iscolormap: new function for image
Carnë Draug <carandraug+dev@gmail.com>
parents:
diff
changeset
|
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
7a0a202fedfe
iscolormap: new function for image
Carnë Draug <carandraug+dev@gmail.com>
parents:
diff
changeset
|
13 ## General Public License for more details. |
7a0a202fedfe
iscolormap: new function for image
Carnë Draug <carandraug+dev@gmail.com>
parents:
diff
changeset
|
14 ## |
7a0a202fedfe
iscolormap: new function for image
Carnë Draug <carandraug+dev@gmail.com>
parents:
diff
changeset
|
15 ## You should have received a copy of the GNU General Public License |
7a0a202fedfe
iscolormap: new function for image
Carnë Draug <carandraug+dev@gmail.com>
parents:
diff
changeset
|
16 ## along with Octave; see the file COPYING. If not, see |
7a0a202fedfe
iscolormap: new function for image
Carnë Draug <carandraug+dev@gmail.com>
parents:
diff
changeset
|
17 ## <http://www.gnu.org/licenses/>. |
7a0a202fedfe
iscolormap: new function for image
Carnë Draug <carandraug+dev@gmail.com>
parents:
diff
changeset
|
18 |
7a0a202fedfe
iscolormap: new function for image
Carnë Draug <carandraug+dev@gmail.com>
parents:
diff
changeset
|
19 ## -*- texinfo -*- |
15516
271f0a2d15ab
iscolormap.m: Eliminate unnecessary ismatrix() test in code.
Rik <rik@octave.org>
parents:
15514
diff
changeset
|
20 ## @deftypefn {Function File} {} iscolormap (@var{cmap}) |
271f0a2d15ab
iscolormap.m: Eliminate unnecessary ismatrix() test in code.
Rik <rik@octave.org>
parents:
15514
diff
changeset
|
21 ## Return true if @var{cmap} is a colormap. |
15513
7a0a202fedfe
iscolormap: new function for image
Carnë Draug <carandraug+dev@gmail.com>
parents:
diff
changeset
|
22 ## |
20158
7503499a252b
doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19865
diff
changeset
|
23 ## A colormap is a real matrix with @var{n} rows and 3 columns. Each row |
7503499a252b
doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19865
diff
changeset
|
24 ## represents a single color. The columns contain red, green, and blue |
7503499a252b
doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19865
diff
changeset
|
25 ## intensities respectively. All entries must be between 0 and 1 inclusive. |
15513
7a0a202fedfe
iscolormap: new function for image
Carnë Draug <carandraug+dev@gmail.com>
parents:
diff
changeset
|
26 ## @seealso{colormap, rgbplot} |
7a0a202fedfe
iscolormap: new function for image
Carnë Draug <carandraug+dev@gmail.com>
parents:
diff
changeset
|
27 ## @end deftypefn |
7a0a202fedfe
iscolormap: new function for image
Carnë Draug <carandraug+dev@gmail.com>
parents:
diff
changeset
|
28 |
7a0a202fedfe
iscolormap: new function for image
Carnë Draug <carandraug+dev@gmail.com>
parents:
diff
changeset
|
29 ## Author: Carnë Draug <carandraug+dev@gmail.com> |
7a0a202fedfe
iscolormap: new function for image
Carnë Draug <carandraug+dev@gmail.com>
parents:
diff
changeset
|
30 |
15516
271f0a2d15ab
iscolormap.m: Eliminate unnecessary ismatrix() test in code.
Rik <rik@octave.org>
parents:
15514
diff
changeset
|
31 function retval = iscolormap (cmap) |
15513
7a0a202fedfe
iscolormap: new function for image
Carnë Draug <carandraug+dev@gmail.com>
parents:
diff
changeset
|
32 |
7a0a202fedfe
iscolormap: new function for image
Carnë Draug <carandraug+dev@gmail.com>
parents:
diff
changeset
|
33 if (nargin != 1) |
7a0a202fedfe
iscolormap: new function for image
Carnë Draug <carandraug+dev@gmail.com>
parents:
diff
changeset
|
34 print_usage; |
7a0a202fedfe
iscolormap: new function for image
Carnë Draug <carandraug+dev@gmail.com>
parents:
diff
changeset
|
35 endif |
7a0a202fedfe
iscolormap: new function for image
Carnë Draug <carandraug+dev@gmail.com>
parents:
diff
changeset
|
36 |
19865
e9f89866074c
maint: Cleanup some .m files to follow Octave coding conventions.
John W. Eaton <jwe@octave.org>
parents:
19697
diff
changeset
|
37 retval = (isnumeric (cmap) && isreal (cmap) && ndims (cmap) == 2 |
e9f89866074c
maint: Cleanup some .m files to follow Octave coding conventions.
John W. Eaton <jwe@octave.org>
parents:
19697
diff
changeset
|
38 && columns (cmap) == 3 && isa (cmap, "double") |
e9f89866074c
maint: Cleanup some .m files to follow Octave coding conventions.
John W. Eaton <jwe@octave.org>
parents:
19697
diff
changeset
|
39 && min (cmap(:)) >= 0 && max (cmap(:)) <= 1); |
15513
7a0a202fedfe
iscolormap: new function for image
Carnë Draug <carandraug+dev@gmail.com>
parents:
diff
changeset
|
40 |
7a0a202fedfe
iscolormap: new function for image
Carnë Draug <carandraug+dev@gmail.com>
parents:
diff
changeset
|
41 endfunction |
7a0a202fedfe
iscolormap: new function for image
Carnë Draug <carandraug+dev@gmail.com>
parents:
diff
changeset
|
42 |
15516
271f0a2d15ab
iscolormap.m: Eliminate unnecessary ismatrix() test in code.
Rik <rik@octave.org>
parents:
15514
diff
changeset
|
43 |
15513
7a0a202fedfe
iscolormap: new function for image
Carnë Draug <carandraug+dev@gmail.com>
parents:
diff
changeset
|
44 %!assert (iscolormap (jet (64))) |
15514
8d64e87c00cf
iscolormap: more tests
Carnë Draug <carandraug+dev@gmail.com>
parents:
15513
diff
changeset
|
45 %!assert (iscolormap ({0 1 0}), false) |
15516
271f0a2d15ab
iscolormap.m: Eliminate unnecessary ismatrix() test in code.
Rik <rik@octave.org>
parents:
15514
diff
changeset
|
46 %!assert (iscolormap ([0 1i 0]), false) |
15714
b1cd65881592
Clean up scripts in image directory.
Rik <rik@octave.org>
parents:
15516
diff
changeset
|
47 %!assert (iscolormap (ones (3,3,3)), false) |
15516
271f0a2d15ab
iscolormap.m: Eliminate unnecessary ismatrix() test in code.
Rik <rik@octave.org>
parents:
15514
diff
changeset
|
48 %!assert (iscolormap (ones (3,4)), false) |
271f0a2d15ab
iscolormap.m: Eliminate unnecessary ismatrix() test in code.
Rik <rik@octave.org>
parents:
15514
diff
changeset
|
49 %!assert (iscolormap (single (jet (64))), false) |
15514
8d64e87c00cf
iscolormap: more tests
Carnë Draug <carandraug+dev@gmail.com>
parents:
15513
diff
changeset
|
50 %!assert (iscolormap ([0 0 -2]), false) |
8d64e87c00cf
iscolormap: more tests
Carnë Draug <carandraug+dev@gmail.com>
parents:
15513
diff
changeset
|
51 %!assert (iscolormap ([0 0 2]), false) |
15714
b1cd65881592
Clean up scripts in image directory.
Rik <rik@octave.org>
parents:
15516
diff
changeset
|
52 |