Home > atmlab > arts > qartsBatch.m

qartsBatch

PURPOSE ^

QARTSBATCH Defines setting fields for ARTS batch calculations

SYNOPSIS ^

function [B,I] = qartsBatch

DESCRIPTION ^

 QARTSBATCH   Defines setting fields for ARTS batch calculations

    The function provides default values for all recognised fields and a
    description of each field. To list default values just type 'qartsBatch'.

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

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

qartsBatch.m

SOURCE CODE ^

0001 % QARTSBATCH   Defines setting fields for ARTS batch calculations
0002 %
0003 %    The function provides default values for all recognised fields and a
0004 %    description of each field. To list default values just type 'qartsBatch'.
0005 %
0006 %    This function is organised in such way that *qcheck* and *qinfo*
0007 %    can be used.
0008 %
0009 % FORMAT   [B,I] = qartsBatch
0010 %
0011 % OUT   B  Setting structure with default values for all recognised fields.
0012 %       I  Includes same fields as B, where the content of each field
0013 %          is a description string (used by *qinfo*).
0014 
0015 % 2005-05-26   Created by Patrick Eriksson.
0016 
0017 
0018 function [B,I] = qartsBatch
0019  
0020 
0021 %-----------------------------------------------------------------------------
0022 B.DATA = {};
0023 I.DATA = [ ...
0024 'Batch data. This field is a cell array where each element shall have the ',...
0025 'the fields:', ...
0026 '#   WSV  : The ARTS WSV to which the data shall be transfered.', ...
0027 '#   TYPE : The ARTS data type of the WSV.', ...
0028 '#   X    : The actual batch data. This variable shall accordingly be of ', ...
0029 'one dimension higher than the WSV type. ', ...
0030 '# For example, if *sensor_los* shall be modified, then you do something ', ...
0031 'like:', ...
0032 '#   Q.BATCH.DATA{1}.WSV  = ''sensor_los'';', ...
0033 '#   Q.BATCH.DATA{1}.TYPE = ''Matrix'';', ...
0034 '#   Q.BATCH.DATA{1}.X    = 113.3+randn(5,1,1)*0.05;'
0035 ];
0036 %-----------------------------------------------------------------------------
0037 B.N = {};
0038 I.N = [ ...
0039 'Number of batch cases to run.'
0040 ];
0041 %-----------------------------------------------------------------------------
0042 B.WSM = {};
0043 I.WSM = [ ...
0044 'Series of WSM calls to finish *ybatch_calc_agenda*.'
0045 ];
0046 %-----------------------------------------------------------------------------
0047

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