attnc.m

matlacb程序包

function [att_val, att_name_list] = attnc(file, var_name, att_name, verbose)
%attnc returns selected attributes of a netcdf file or DODS/OPEnDAP dataset.
%--------------------------------------------------------------------
% DESCRIPTION:
%
% [att_val, att_name_list] = attnc(file, var_name, att_name, verbose)
%       INPUT
% file:  may be the name of a netCDF file with or without the .cdf or .nc
%   extent. file may also be the URL of a DODS/OPEnDAP dataset.
% var_name: a string containing the name of the variable whose
%   attribute is required.  A global attribute may be specified by
%   passing the string 'global'.
% att_name: a string containing the name of the attribute that is
%   required.  If att_name is not specified then it is assumed that the
%   user wants all of the attributes.
% verbose: if == 0 (the default) then no messages about the attributes are
%   displayed. Otherwise some simple messages will be displayed.
%       OUTPUT
% att_val: If att_name is specified then its value is returned in att_val.
%   If att_name is not specified then the values of all of the attributes
%   are returned in the cell att_val.
% att_name_list: If att_name is specified then the same name is returned in
%   att_name_list provided that the attribute is found (otherwise it is
%   empty).  If att_name is not specified then the names of all of the
%   attributes are returned in the cell att_name_list.
%
% Note 1) If only 2 arguments are passed to attnc then all of the
%   attributes and their names (for the specified variable) are returned.
% Note 2) If only 1 argument is passed to attnc then all of the global
%   attributes and their names are returned.
% Note 3) If "file" is a compressed netcdf file then the user will be
%   given an option for automatic uncompression. Of course, the
%   uncompressiion can only occur if the user has appropriate write
%   permission.
%
% This function calls: check_nc.m, loaddap or loaddods, mexnc, pos_cds.m,
%                      uncmp_nc.m
% This function is called by: NONE
%
% AUTHOR:   J. V. Mansbridge, CSIRO
%---------------------------------------------------------------------

%     Copyright (C), 1992, J.V. Mansbridge, 
%     Commonwealth Scientific and Industrial Research Organisation
%     $Id: attnc.m Mon, 03 Jul 2006 17:16:40 $
% 
%--------------------------------------------------------------------

% Check the number of arguments and put in the defaults

if ( (nargin < 1) || (nargin > 4) )
   help attnc
   return
end
if nargin == 0
   help attnc
   return  
elseif nargin == 1
  var_name = 'global';
  att_name = [];
  verbose = 0;
elseif nargin == 2
  att_name = [];
  verbose = 0;
elseif nargin == 3
  verbose = 0;
end
if isempty(var_name)
  var_name = 'global';
end

% Do some initialisation.

err_opt = 1;
CSIRO_add_jar_file_maybe;
[mex_name, full_name, desc_das] = choose_mexnc_opendap(file);

switch mex_name
 case 'mexnc'

  % Open the netcdf file.
  
  [cdfid, rcode] = mexnc('ncopen', full_name, 'nowrite');

  % don't print out netcdf warning messages

  mexnc('setopts',0);

  if rcode < 0
    error(['mexnc: ncopen: rcode = ' int2str(rcode)])
  end

  % Find the values of the attributes.

  att_val = [];
  att_name_list = [];
  if strcmp(var_name, 'global')
    %Collect information about the cdf file.

    [num_dims, nvars, ngatts, recdim, rcode] =  mexnc('ncinquire', cdfid);
    if rcode < 0
      error([ 'mexnc: ncinquire: rcode = ' int2str(rcode) ])
    end
    if isempty(att_name)
      if ngatts > 0
	for i = 0:ngatts-1
	  [attnam, rcode] = mexnc('attname', cdfid, 'global', i);
	  [attype, attlen, rcode] = mexnc('ncattinq', cdfid, 'global', attnam);
	  [values, rcode] = mexnc('ncattget', cdfid, 'global', attnam);
	  att_val{i+1} = values;
	  att_name_list{i+1} = attnam;
	end
      else
	if verbose
	  disp('   ---  There are no Global attributes  ---')
	end
      end
    else
      if ngatts > 0
	found_it = 0;
	for i = 0:ngatts-1
	  [attnam, rcode] = mexnc('attname', cdfid, 'global', i);
	  if strcmp(attnam, att_name)
	    found_it = 1;
	    [attype, attlen, rcode] = mexnc('ncattinq', cdfid, 'global', attnam);
	    [values, rcode] = mexnc('ncattget', cdfid, 'global', attnam);
	    att_val = values;
	    att_name_list = attnam;
	    break
	  end
	end
	if found_it == 0
	  warning(['the attribute ' att_name ' was not found'])
	end
      else
	warning(['the attribute ' att_name ' was not found'])
      end
    end
  else
    varid = mexnc('VARID', cdfid, var_name);
    if varid == -1
      error([ 'mexnc: varid: ' var_name ' is not a variable' ])
    end

    [varname, datatype, num_dims, dim, natts, rcode] = ...
	mexnc('VARINQ', cdfid, varid);

    % Now find the attributes and store them. Note that there was previous
    % code to turn a numeric row vector into a column vector. This code was
    % taken out for simplicity and backwards compatibility.
    
    if isempty(att_name)
      if natts > 0
	for i = 0:natts-1
	  [attnam, rcode] = mexnc('attname', cdfid, varid, i);
	  [attype, attlen, rcode] = mexnc('ncattinq', cdfid, varid, attnam);
	  [values, rcode] = mexnc('ncattget', cdfid, varid, attnam);
	  att_val{i+1} = values;
	  att_name_list{i+1} = attnam;
	end
      else
	if verbose
	  disp(['   ---   ' varid ' has no attributes  ---'])
	end
      end
    else
      if natts > 0
	found_it = 0;
	for i = 0:natts-1
	  [attnam, rcode] = mexnc('attname', cdfid, varid, i);
	  if strcmp(attnam, att_name)
	    found_it = 1;
	    [attype, attlen, rcode] = mexnc('ncattinq', cdfid, varid, attnam);
	    [values, rcode] = mexnc('ncattget', cdfid, varid, attnam);
	    att_val = values;
	    att_name_list = attnam;
	    break
	  end
	end
	if found_it == 0
	  warning(['the attribute ' att_name ' was not found'])
	end
      else
	warning(['the attribute ' att_name ' was not found'])
      end
    end
  end

  % Close the netcdf file.

  [rcode] = mexnc('ncclose', cdfid);
  if rcode < 0
    error(['** ERROR ** ncclose: rcode = ' num2str(rcode)])
  end
  
 case {'loaddap', 'loaddods'}
  
  % Dealing with a dods file

  % Special case. This fiddle is presumably necessary because matlab names
  % cannot start with _ .

  if ~isempty(att_name)
    if strcmp(att_name(1), '_')
      att_name = ['ml_' att_name];
    end
  end

  att_val = [];
  att_name_list = [];

  % Find and store all of the global attributes of the dods file or only one
  % specific value.

  if strcmp(var_name, 'global')
    
    % Find and print out the global attributes of the dods file. We use the
    % information about the DAS that was previously obtained by a call to
    % loaddap or loaddods.

    try
      %desc_das_down_1 = desc_das.('Global_Attributes');
      desc_das_down_1 = getfield(desc_das, 'Global_Attributes');
    catch
      error('desc_das does not have a field Global_Attributes')
    end
    
    fnames_1 = fieldnames(desc_das_down_1);
    found_global = 0;
    for ii = 1:length(fnames_1)
      if length(fnames_1{ii}) > 7
	if strcmpi(fnames_1{ii}(end-6:end), '_global')
	  ii_1 = ii;
	  found_global = 1;
	  break
	end
      end
    end
    
    if found_global
      
      % Find values for all attributes or a specified one.
      
      if isempty(att_name)
	
	% Find values for all attributes.
	
	ngatts = 0;
	%desc_das_down_2 = desc_das_down_1.(fnames_1{ii_1});  
	desc_das_down_2 = getfield(desc_das_down_1, fnames_1{ii_1});  
	if isstruct(desc_das_down_2)
	  list_gatts = fieldnames(desc_das_down_2);
	  for ii = 1:length(list_gatts)
	    if ((strcmp(list_gatts(ii), 'DODS_ML_Real_Name') == 0) && ...
		(strcmp(list_gatts(ii), 'DODS_ML_Type') == 0))
	      ngatts = ngatts + 1;
	      att_name_list{ngatts} = list_gatts{ii};
	      %att_val{ngatts} = desc_das_down_2.(att_name_list{ngatts});
	      att_val{ngatts} = getfield(desc_das_down_2,att_name_list{ngatts});
	    end
	  end
	end
      else
	
	% Find values for a specified attribute.
	
	%desc_das_down_2 = desc_das_down_1.(fnames_1{ii_1});
	desc_das_down_2 = getfield(desc_das_down_1, fnames_1{ii_1});
	if isfield(desc_das_down_2, att_name)
	  %att_val = desc_das_down_2.(att_name);
	  att_val = getfield(desc_das_down_2, att_name);
	  att_name_list = att_name;
	else
	  if verbose
	    warning([ 'the attribute ' att_name ' was not found'])
	  end
	end
      end 
    else
      if verbose
	disp('   ---  There are no Global attributes  ---')
      end