Home > atmlab > arts > scenegen > asgG.m

asgG

PURPOSE ^

ASGG Returns an empty ASG structure

SYNOPSIS ^

function [G,I] = asgG

DESCRIPTION ^

 ASGG   Returns an empty ASG structure

    To create an empty structure:
       G = asgG;

    To obtain information of the fields of G:
       qinfo( @asgG )

 FORMAT   [G,I] = asgG
        
 OUT   G   An empty ASG structure.
       I   Includes same fields as G, where the content of each field
           is a description string (used by *qinfo*).

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

DOWNLOAD ^

asgG.m

SOURCE CODE ^

0001 % ASGG   Returns an empty ASG structure
0002 %
0003 %    To create an empty structure:
0004 %       G = asgG;
0005 %
0006 %    To obtain information of the fields of G:
0007 %       qinfo( @asgG )
0008 %
0009 % FORMAT   [G,I] = asgG
0010 %
0011 % OUT   G   An empty ASG structure.
0012 %       I   Includes same fields as G, where the content of each field
0013 %           is a description string (used by *qinfo*).
0014 
0015 % 2007-10-19   Created by Patrick Eriksson
0016 
0017 function [G,I] = asgG
0018 
0019 %------------------------------------------------------------------------------
0020 G.NAME = []; 
0021 I.NAME = [
0022 'Type ''help gformat'' for obtaining the definition of this field.'
0023 ];
0024 %------------------------------------------------------------------------------
0025 G.DIMS = []; 
0026 I.DIMS = [
0027 'Type ''help gformat'' for obtaining the definition of this field.'
0028 ];
0029 %------------------------------------------------------------------------------
0030 G.DATA = []; 
0031 I.DATA = [
0032 'Type ''help gformat'' for obtaining the definition of this field.',...
0033 'Inside this ASG, this field can be initialized to a scalar for any ', ...
0034 'variable having pressure as first dimension (such as atmospheric fields, ',...
0035 'but not e.g. the geoid radius).'
0036 ];
0037 %------------------------------------------------------------------------------
0038 G.DATA_NAME = '-'; 
0039 I.DATA_NAME = [
0040 'Type ''help gformat'' for obtaining the definition of this field.'
0041 ];
0042 %------------------------------------------------------------------------------
0043 G.DATA_UNIT = '-'; 
0044 I.DATA_UNIT = [
0045 'Type ''help gformat'' for obtaining the definition of this field.'
0046 ];
0047 %------------------------------------------------------------------------------
0048 G.GRID1 = []; 
0049 I.GRID1 = [
0050 'Type ''help gformat'' for obtaining the definition of this field. ', ...
0051 'And type ''qinfo(@asgD)'' for definition of data inside ASG.'
0052 ];
0053 %------------------------------------------------------------------------------
0054 G.GRID2 = []; 
0055 I.GRID2 = [
0056 'Type ''help gformat'' for obtaining the definition of this field.', ...
0057 'And type ''qinfo(@asgD)'' for definition of data inside ASG.'
0058 ];
0059 %------------------------------------------------------------------------------
0060 G.GRID3 = []; 
0061 I.GRID3 = [
0062 'Type ''help gformat'' for obtaining the definition of this field.', ...
0063 'And type ''qinfo(@asgD)'' for definition of data inside ASG.'
0064 ];
0065 %------------------------------------------------------------------------------
0066 G.GRID4 = []; 
0067 I.GRID4 = [
0068 'Type ''help gformat'' for obtaining the definition of this field.', ...
0069 'And type ''qinfo(@asgD)'' for definition of data inside ASG.'
0070 ];
0071 %------------------------------------------------------------------------------
0072 G.SOURCE = 'Set by user'; 
0073 I.SOURCE = [
0074 'Type ''help gformat'' for obtaining the definition of this field.'
0075 ];
0076 %------------------------------------------------------------------------------
0077 G.PROPS = []; 
0078 I.PROPS = [
0079 'ASG field. Used to store description of basic proporties of the ',...
0080 'quantities. The field is defined as follows:',...
0081 '#   Absorption species : Absorption tag data, such as ',...
0082 '{''H2O-*-495e9-510e9'',''H2O-MPM89''}',...
0083 '#   Cloud particles : Name of file with single scattering data.'
0084 ];
0085 %------------------------------------------------------------------------------
0086 G.DIMADD        = [];
0087 G.DIMADD.METHOD = 'expand'; 
0088 I.DIMADD        = [
0089 'ASG field. Describes how data are expanded to higher ',...
0090 'dimensionality, or is interpolated or binned to lower dimension. ',...
0091 'The field is a structure described in *asg_dimadd*.'
0092 ];
0093 %------------------------------------------------------------------------------
0094 G.RNDMZ = []; 
0095 I.RNDMZ = [
0096 'ASG field. Describes how data are "randomized". ',...
0097 'The field is a structure described in *asg_rndmz*.'
0098 ];
0099 %------------------------------------------------------------------------------
0100 G.SPCFC = []; 
0101 I.SPCFC = [
0102 'ASG field. Describes quantity specific operations. Used by varoius',...
0103 'functions, such as *asg_hydrostat*.'
0104 ];
0105 %------------------------------------------------------------------------------
0106 G.SURFACE = false; 
0107 I.SURFACE = [
0108 'ASG field. False for atmospheric fields. True for "surfaces", which ',...
0109 'that the pressure dimensions not is used.'
0110 ];
0111 %------------------------------------------------------------------------------

Generated on Mon 15-Sep-2014 13:31:28 by m2html © 2005