File: ncreadatt.m

package info (click to toggle)
octave-netcdf 1.0.18-1
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 1,756 kB
  • sloc: sh: 2,943; cpp: 1,812; python: 438; makefile: 223; awk: 51; xml: 20
file content (52 lines) | stat: -rw-r--r-- 1,704 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
## Copyright (C) 2013-2022 Alexander Barth
##
## This program is free software; you can redistribute it and/or modify
## it under the terms of the GNU General Public License as published by
## the Free Software Foundation; either version 3 of the License, or
## (at your option) any later version.
##
## This program is distributed in the hope that it will be useful,
## but WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
## GNU General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with this program; If not, see <http://www.gnu.org/licenses/>.

## -*- texinfo -*-
## @deftypefn  {Function File} {@var{val} =} ncreadatt(@var{filename},@var{varname},@var{attname})
##
## Return the attribute @var{attname} of the variable @var{varname} in the file
## @var{filename}.
##
## Global attributes can be accessed by using "/" or the group name as 
## @var{varname}. The type of attribute is mapped to the Octave data types.
## (see @code{ncinfo}).
##
## @subsubheading Example
## Read global attribute 'creation_date'
## @example
## d = ncreadatt('test.nc','/','creation_date')
## @end example
## Read atribute 'myattr' assigned to variable mydata.
## @example
## d = ncreadattr('test.nc', 'mydata', 'myattr');
## @end example
## @seealso{ncinfo,ncwriteatt}
## @end deftypefn

function val = ncreadatt(filename,varname,attname)

  ncid = netcdf_open(filename,'NC_NOWRITE');

  [gid,varid] = ncloc(ncid,varname);

  if isempty(varid)
    varid = netcdf_getConstant('NC_GLOBAL');
  endif

  val = netcdf_getAtt(gid,varid,attname);

  netcdf_close(ncid);

endfunction