Home > atmlab > retrieval > qpack2 > qp2_y.m

qp2_y

PURPOSE ^

QP2_Y Defines recognised fields for qpack2 measurement data

SYNOPSIS ^

function [Q,I] = qp2_y

DESCRIPTION ^

 QP2_Y   Defines recognised fields for qpack2 measurement data

    This function is organised in such way that *qcheck* and *qinfo*
    can be used. To list all existing fields:
       qinfo( @qp2_y );

    Allowed formats differ between the fields. For information about a 
    specific field, type e.g.:
       qinfo( @qp2_y, 'Y' );

 FORMAT   [Q,I] = qp2_y
        
 OUT   Q  Setting structure with default values for all recognised fields.
       I  Includes same fields as Q, 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 ^

qp2_y.m

SOURCE CODE ^

0001 % QP2_Y   Defines recognised fields for qpack2 measurement data
0002 %
0003 %    This function is organised in such way that *qcheck* and *qinfo*
0004 %    can be used. To list all existing fields:
0005 %       qinfo( @qp2_y );
0006 %
0007 %    Allowed formats differ between the fields. For information about a
0008 %    specific field, type e.g.:
0009 %       qinfo( @qp2_y, 'Y' );
0010 %
0011 % FORMAT   [Q,I] = qp2_y
0012 %
0013 % OUT   Q  Setting structure with default values for all recognised fields.
0014 %       I  Includes same fields as Q, where the content of each field
0015 %          is a description string (used by *qinfo*).
0016 
0017 % 2009-07-01   Created by Patrick Eriksson.
0018 
0019 
0020 function [Q,I] = qp2_y
0021   
0022 %-----------------------------------------------------------------------------
0023 Q.AA = {};
0024 I.AA = [ ...
0025 'Line-of-sight azimuth angle for the measurement. Only considered if ',...
0026 'ATMOSPERE_DIM set to 3. A scalar value, or a ',...
0027 'vector. See further *ZA*.',...'
0028 ];
0029 %-----------------------------------------------------------------------------
0030 Q.DAY = {};
0031 I.DAY = [ ...
0032 'Measurement time information. All these fields (YEAR, MONTH, ...) are ',...
0033 'numeric scalars. This information is primarily used to extract data from ',...
0034 'the climatology databases.'
0035 ];
0036 %-----------------------------------------------------------------------------
0037 Q.F = {};
0038 I.F = [ ...
0039 'Frequency for each value of Y. Not required information. Qpack2 uses ', ...
0040 'this field only for consistency checks.'
0041 ];
0042 %-----------------------------------------------------------------------------
0043 Q.HOUR = {};
0044 I.HOUR = [ ...
0045 'Optional data. Allows a more detailed specification of measurement time. ',...
0046 'Otherwise as field DAY.'
0047 ];
0048 %-----------------------------------------------------------------------------
0049 Q.HSE_P = {};
0050 I.HSE_P = [ ...
0051 'The reference point when enforcing hydrostatic equilibrium. The ',...
0052 'geometrical altitude (HSE_Z) is given for one presssure (HSE_P).'
0053 ];
0054 %-----------------------------------------------------------------------------
0055 Q.HSE_Z = {};
0056 I.HSE_Z = [ ...
0057 'The reference point when enforcing hydrostatic equilibrium. The ',...
0058 'geometrical altitude (HSE_Z) is given for one presssure (HSE_P).'
0059 ];
0060 %-----------------------------------------------------------------------------
0061 Q.LATITUDE = {};
0062 I.LATITUDE = [ ...
0063 'The geographical position of the measurement.'
0064 ];
0065 %-----------------------------------------------------------------------------
0066 Q.LONGITUDE = {};
0067 I.LONGITUDE = [ ...
0068 'The geographical position of the measurement. '
0069 ];
0070 %-----------------------------------------------------------------------------
0071 Q.MINUTE = {};
0072 I.MINUTE = [ ...
0073 'Optional data. Allows a more detailed specification of measurement time. ',...
0074 'Otherwise as field DAY.'
0075 ];
0076 %-----------------------------------------------------------------------------
0077 Q.MONTH = {};
0078 I.MONTH = [ ...
0079 'Measurement time information. All these fields (YEAR, MONTH, ...) are ',...
0080 'numeric scalars. This information is primarily used to extract data from ',...
0081 'the climatology databases.'
0082 ];
0083 %-----------------------------------------------------------------------------
0084 Q.SECOND = {};
0085 I.SECOND = [ ...
0086 'Optional data. Allows a more detailed specification of measurement time. ',...
0087 'Otherwise as field DAY.'
0088 ];
0089 %-----------------------------------------------------------------------------
0090 Q.TNOISE = {};
0091 I.TNOISE = [ ...
0092 'Magnitude of thermal noise, given as 1 standard devation. A scalar or a ',...
0093 'column vector having the same length as y. If a scalar, the value is ',...
0094 'applied for all spectrometer channels. If the measurement consists of ',...
0095 'several spectra (see *ZA*), this field must be a matrix (or row vector) ',...
0096 'where the columns give the noise for each spectrum.'
0097 ];
0098 %-----------------------------------------------------------------------------
0099 Q.Y = {};
0100 I.Y = [ ...
0101 'The spectrum. If multiple spectra, all data appended into a column vector.'
0102 ];
0103 %-----------------------------------------------------------------------------
0104 Q.YEAR = {};
0105 I.YEAR = [ ...
0106 'Measurement time information. All these fields (YEAR, MONTH, ...) are ',...
0107 'numeric scalars. This information is primarily used to extract data from ',...
0108 'the climatology databases.'
0109 ];
0110 %-----------------------------------------------------------------------------
0111 Q.ZA = {};
0112 I.ZA = [ ...
0113 'Line-of-sight zenith angle for the measurement. A scalar value, or a ',...
0114 'vector. The fields *Z_PLATFORM* and *ZA*, as well as *AA* for 3D case, ',...
0115 'must have the same size. If these fields have a length > 1, the ',...
0116 'measurement will consist of several spectra (having same *LAT* and *LON). ',...
0117 'In ARTS, these spectra are simulated as seperate measurement blocks. ',...
0118 'Further, *TNOISE* must have a matching size, where the numbers of columns ',...
0119 'shall match length of *ZA*.'
0120 ];
0121 %-----------------------------------------------------------------------------
0122 Q.Z_PLATFORM = {};
0123 I.Z_PLATFORM = [ ...
0124 'Altitude (above geoid) of observation platform. A scalar value, or a ',...
0125 'vector. See further *ZA*.',...'
0126 ];
0127 %-----------------------------------------------------------------------------

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