Mercurial > hg > octave-lyh
diff scripts/image/jet.m @ 11420:466ba499eff5
Update docstrings for colormap files.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Tue, 28 Dec 2010 13:08:23 -0800 |
parents | 2b0cc0b6db61 |
children | fd0a3ac60b0e |
line wrap: on
line diff
--- a/scripts/image/jet.m +++ b/scripts/image/jet.m @@ -17,31 +17,33 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} jet (@var{n}) -## Create color colormap. This colormap is dark blue through blue, cyan, -## green, yellow, red to dark red. The argument @var{n} should be a scalar. -## If it is omitted, the length of the current colormap or 64 is assumed. +## @deftypefn {Function File} {@var{map} =} jet () +## @deftypefnx {Function File} {@var{map} =} jet (@var{n}) +## Create color colormap. This colormap ranges from dark blue through blue, +## cyan, green, yellow, red, to dark red. +## The argument @var{n} must be a scalar. +## If unspecified, the length of the current colormap, or 64, is used. ## @seealso{colormap} ## @end deftypefn ## Author: Kai Habel <kai.habel@gmx.de> -function map = jet (number) +function map = jet (n) if (nargin == 0) - number = rows (colormap); + n = rows (colormap); elseif (nargin == 1) - if (! isscalar (number)) + if (! isscalar (n)) error ("jet: argument must be a scalar"); endif else print_usage (); endif - if (number == 1) + if (n == 1) map = [0, 0, 0.5]; - elseif (number > 1) - x = linspace(0, 1, number)'; + elseif (n > 1) + x = linspace(0, 1, n)'; r = (x >= 3/8 & x < 5/8) .* (4 * x - 3/2)\ + (x >= 5/8 & x < 7/8) + (x >= 7/8) .* (-4 * x + 9/2); g = (x >= 1/8 & x < 3/8) .* (4 * x - 1/2)\ @@ -59,5 +61,5 @@ %! ## Show the 'jet' colormap as an image %! image (1:64, linspace (0, 1, 64), repmat (1:64, 64, 1)') %! axis ([1, 64, 0, 1], "ticy", "xy") -%! colormap jet +%! colormap (jet (64))