Home > atmlab > arts > qartsSensor.m

qartsSensor

PURPOSE ^

QARTSSENSOR Defines setting fields for ARTS sensor response calculations

SYNOPSIS ^

function [H,I] = qartsSensor

DESCRIPTION ^

 QARTSSENSOR   Defines setting fields for ARTS sensor response calculations

    The function provides default values for all recognised fields and a 
    description of each field. 

    This function is organised in such way that *qcheck* and *qinfo*
    can be used.

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

qartsSensor.m

SOURCE CODE ^

0001 % QARTSSENSOR   Defines setting fields for ARTS sensor response calculations
0002 %
0003 %    The function provides default values for all recognised fields and a
0004 %    description of each field.
0005 %
0006 %    This function is organised in such way that *qcheck* and *qinfo*
0007 %    can be used.
0008 %
0009 % FORMAT   [H,I] = qartsSensor
0010 %
0011 % OUT   H  Setting structure with default values for all recognised fields.
0012 %       I  Includes same fields as H, where the content of each field
0013 %          is a description string (used by *qinfo*).
0014 
0015 % 2005-01-26   Created by Mattias Ekstr´┐Ż.
0016 
0017 
0018 function [H,I] = qartsSensor
0019  
0020 %-----------------------------------------------------------------------------
0021 H.ANTENNA_DO = {};
0022 I.ANTENNA_DO = [ ...
0023 'Flag to include call of *sensor_responseAntenna* even if not a single ',...
0024 'antenna variable of *qartsSensor* is set.'
0025 ];
0026 %-----------------------------------------------------------------------------
0027 H.ANTENNA_LOS = {};
0028 I.ANTENNA_LOS = [ ...
0029 'As the ARTS WSV with the same name.', ...
0030 ' If the sensor response does not include an antenna this field can', ...
0031 ' be left as {}. If set, call of *sensor_responseAntenna* is added.', ...
0032 '#   Can be given either as the name of a XML file, or as a Matlab',...
0033 ' variable.'
0034 ];
0035 %-----------------------------------------------------------------------------
0036 H.ANTENNA_RESPONSE = {};
0037 I.ANTENNA_RESPONSE = [ ...
0038 'Has the same functionality as the ARTS WSV with the same name.', ...
0039 ' If the sensor response does not include an antenna this field can', ...
0040 ' be left as {}.  If set, call of *sensor_responseAntenna* is added.', ...
0041 '#   Can be given either as the name of a XML file, or as a Matlab',...
0042 ' variable.'
0043 ];
0044 %-----------------------------------------------------------------------------
0045 H.BACKEND_DO = {};
0046 I.BACKEND_DO = [ ...
0047 'Flag to include call of *sensor_responseBackend* even if not a single ',...
0048 'backend variable of *qartsSensor* is set.'
0049 ];
0050 %-----------------------------------------------------------------------------
0051 H.BACKEND_CHANNEL_RESPONSE = {};
0052 I.BACKEND_CHANNEL_RESPONSE = [ ...
0053 'Has the same functionality as the ARTS WSV with the same name.', ...
0054 ' If the sensor response does not include the backend, this variable', ...
0055 ' can be left as {}. If set, call of *sensor_responseBackend * or ', ...
0056 '*sensor_responseMultiMixerBackend* is added. ', ...
0057 '#   Can be given either as the name of a XML file, or as a Matlab',...
0058 ' variable.'
0059 ];
0060 %-----------------------------------------------------------------------------
0061 H.BEAM_SWITCHING = {};
0062 I.BEAM_SWITCHING = [ ...
0063 'Flag to trigger call of *sensor_responseBeamSwitching*.'
0064 ];
0065 %-----------------------------------------------------------------------------
0066 H.F_BACKEND = {};
0067 I.F_BACKEND = [ ...
0068 'Matches the ARTS WSV with the same name or *f_backend_multi*.', ...
0069 ' If the sensor response does not include the backend, this variable', ...
0070 ' can be left as {}. If set, call of *sensor_responseBackend * or ', ...
0071 '*sensor_responseMultiMixerBackend* is added. ', ...
0072 '#   Can be given either as the name of a XML file, or as a Matlab',...
0073 ' variable.'
0074 ];
0075 %-----------------------------------------------------------------------------
0076 H.F_SWITCHING = {};
0077 I.F_SWITCHING = [ ...
0078 'Size of frequency switching. If this field is set ',...
0079 '*sensor_responseBackendFrequencySwitching* is used instead of ', ...
0080 '*sensor_responseBackend*.', ...
0081 '# If set, this field must be a vector of length 2, where the first ',...
0082 'values is the frequency throw for the cycle with negative weight and the ',...
0083 'second value is the throw for the other measurement cycle.'
0084 ];
0085 %-----------------------------------------------------------------------------
0086 H.FILL_FGRID = {};
0087 I.FILL_FGRID = [ ...
0088 'If field is set, *sensor_responseFillFgrid* is used. In short, this ',...
0089 'activates a polynomial interpolation of the spectra to a finer grid. This ',...
0090 'in order to decrease the impact of that the sensor response methods treat ', ...
0091 'the spectra to be piecewise linear functions. This grid filling can improve ',...
0092 'considerable the calculation accaracy for a given length of *f_grid. But ',...
0093 'negative effects can happen for unlucky choices of grid.',...
0094 '# If set, this field must be a vector of length 2, where the first ',...
0095 'values is polynomial order for the interpolation, and the second is the ',...
0096 'number of points to insert in each gap of *f_grid*. See further ',...
0097 '*sensor_responseFillFgrid*.'
0098 ];
0099 %-----------------------------------------------------------------------------
0100 H.IF2RF = {};
0101 I.IF2RF = [ ...
0102 'If set to true, a call of *sensor_responseIF2RF* is made. This call is ',...
0103 'placed between the mixer and backend parts.'
0104 ];
0105 %-----------------------------------------------------------------------------
0106 H.LO = {};
0107 I.LO = [ ...
0108 'Matches the ARTS WSV with the same name or *lo_multi*.', ...
0109 ' If the sensor response does not include the mixer, this variable', ...
0110 ' can be left as {}. If set, call of *sensor_responseBackend * or ', ...
0111 '*sensor_responseMultiMixerBackend* is added. ', ...
0112 '#   Can be given either as the name of a XML file, or as a Matlab',...
0113 ' variable.'
0114 ];
0115 %-----------------------------------------------------------------------------
0116 H.MIXER_DO = {};
0117 I.MIXER_DO = [ ...
0118 'Flag to include call of *sensor_responseMixer* even if not a single ',...
0119 'backend variable of *qartsSensor* is set.'
0120 ];
0121 %-----------------------------------------------------------------------------
0122 H.SENSOR_NORM = {};
0123 I.SENSOR_NORM = [ ...
0124 'As the ARTS WSV with the same name.'
0125 ];
0126 %-----------------------------------------------------------------------------
0127 H.SENSOR_POL = {};
0128 I.SENSOR_POL = [ ...
0129 'Has the same functionality as the ARTS WSV with the same name. If set, ', ...
0130 '*sensor_responsePolarisation* is called as first step in setting up the ', ...
0131 'sensor response matrix.', ...
0132 '#   Can be given either as the name of a XML file, or as a Matlab',...
0133 ' variable.'
0134 ];
0135 %-----------------------------------------------------------------------------
0136 %H.SENSOR_ROT = {};
0137 %I.SENSOR_ROT = [ ...
0138 %'Has the same functionality as the ARTS WSV with the same name.', ...
0139 %' If the sensor response does not include rotation, this variable', ...
0140 %' can be left as {}.', ...
0141 %'#   Can be given either as the name of a XML file, or as a Matlab',...
0142 %' variable.'
0143 %];
0144 %-----------------------------------------------------------------------------
0145 H.SIDEBAND_MODE = {};
0146 I.SIDEBAND_MODE = [ ...
0147 'Matches the ARTS WSV with the same name or *sideband_mode_multi*. ', ...
0148 '#   Can be given either as the name of a XML file, or as a Matlab',...
0149 ' variable.'
0150 ];
0151 %-----------------------------------------------------------------------------
0152 H.SIDEBAND_RESPONSE = {};
0153 I.SIDEBAND_RESPONSE = [ ...
0154 'Matches the ARTS WSV with the same name or *sideband_response_multi*. ', ...
0155 'If the sensor response does not include a mixer and sideband filter, ', ...
0156 'this variable can be left as {}. If set, call of *sensor_responseMixer*',...
0157 ' or *sensor_responseMultiMixerBackend* is added.', ...
0158 '#   Can be given either as the name of a XML file, or as a Matlab',...
0159 ' variable.'
0160 ];
0161 %-----------------------------------------------------------------------------

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