File: coda_description.m

package info (click to toggle)
coda 2.25.5-1
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 10,168 kB
  • sloc: ansic: 121,489; javascript: 6,788; java: 2,369; python: 1,695; yacc: 1,007; makefile: 598; lex: 204; sh: 105; fortran: 60; xml: 5
file content (19 lines) | stat: -rw-r--r-- 837 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
function varargout = coda_description(varargin)
% CODA_DESCRIPTION  Retrieve field description.
%
%   DESC = CODA_DESCRIPTION(CODA_FILE_ID, <DATA SPEC ARGS>) returns a
%   string containing the description in the product format definition of
%   the specified data element. If the last item of the data specifier
%   argument list equals a fieldname then you will get the description
%   from the product format definition for this field.
%
%   The coda_file_id parameter must be a valid CODA file handle that was
%   retrieved with coda_open. The format for the data specification
%   argument list <data spec args> is described in the help page for
%   coda_param.
%
%   See also CODA_FETCH, CODA_OPEN, CODA_PARAM
%

% Call CODA_MATLAB.MEX to do the actual work.
[varargout{1:max(1,nargout)}] = coda_matlab('DESCRIPTION',varargin{:});