octave_packages/octcdf-1.1.4/ncbyte.m

   1 ## Copyright (C) 2005 Alexander Barth
   2 ##
   3 ## This program is free software; you can redistribute it and/or modify
   4 ## it under the terms of the GNU General Public License as published by
   5 ## the Free Software Foundation; either version 2 of the License, or
   6 ## (at your option) any later version.
   7 ##
   8 ## This program is distributed in the hope that it will be useful,
   9 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11 ## GNU General Public License for more details.
  12 ##
  13 ## You should have received a copy of the GNU General Public License
  14 ## along with this program; If not, see <http://www.gnu.org/licenses/>.
  15
  16 ## -*- texinfo -*-
  17 ## @deftypefn {Loadable Function} {@var{ncvar} = } ncbyte(@var{dimname_1},...,@var{dimname_N})
  18 ## creates a netcdf variable of type ncbyte. @var{dimname_1} is the name
  19 ## of the 1st netcdf dimension, and so on. The return value is a netcdf
  20 ## variable object and must be affected to a netcdf file, before its content
  21 ## can be defined.
  22 ##
  23 ## Example:
  24 ## @example
  25 ## nc = netcdf('test.nc','w');
  26 ## nc('lon') = 360;
  27 ## nc('lat') = 180;
  28 ## nc@{'var'@} =  ncbyte('lon','lat');
  29 ## @end example
  30 ## A new 360 by 180 netcdf variable named 'var' of type byte is
  31 ## created in file 'test.nc'.
  32 ## @end deftypefn
  33 ## @seealso{netcdf}
  34
  35 ## Author: Alexander Barth <barth.alexander@gmail.com>
  36
  37 function c = ncbyte(varargin);
  38
  39 c = {'byte' varargin{:}};
  40