Mercurial > octave-nkf
diff scripts/image/colormap.m @ 3373:36405da8e173
[project @ 1999-11-23 20:54:17 by jwe]
author | jwe |
---|---|
date | Tue, 23 Nov 1999 20:54:31 +0000 |
parents | 041ea33fbbf4 |
children | 69b167451491 |
line wrap: on
line diff
--- a/scripts/image/colormap.m Tue Nov 23 19:07:18 1999 +0000 +++ b/scripts/image/colormap.m Tue Nov 23 20:54:31 1999 +0000 @@ -17,17 +17,20 @@ ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA ## 02111-1307, USA. +## @deftypefn {Function File} {} colormap (@var{map}) +## @deftypefnx {Function File} {} colormap ("default") ## Set the current colormap. -## -## colormap (map) sets the current colormap to map. map should be an n -## row by 3 column matrix. The columns contain red, green, and blue -## intensities respectively. All entries should be between 0 and 1 -## inclusive. The new colormap is returned. -## -## colormap ("default") restores the default colormap (a gray scale -## colormap with 64 entries). The default colormap is returned. -## -## colormap with no arguments returns the current colormap. +## +## @code{colormap (@var{map})} sets the current colormap to @var{map}. The +## color map should be an @var{n} row by 3 column matrix. The columns +## contain red, green, and blue intensities respectively. All entries +## should be between 0 and 1 inclusive. The new colormap is returned. +## +## @code{colormap ("default")} restores the default colormap (a gray scale +## colormap with 64 entries). The default colormap is returned. +## +## With no arguments, @code{colormap} returns the current color map. +## @end deftypefn ## Author: Tony Richardson <arichard@stark.cc.oh.us> ## Created: July 1994