configRTFileOptionsSeaExplorer

CONFIGRTFILEOPTIONSSEAEXPLORER  Configure loading options for SeaExplorer files in real time.

  Syntax:
    SEAEXPLORER_OPTIONS = CONFIGRTFILEOPTIONSSEAEXPLORER()

  Description:
    SEAEXPLORER_OPTIONS = CONFIGRTFILEOPTIONSSEAEXPLORER() should return
    a struct with the parameters that control which are the deployment files,
    whether they need to be converted, and which files and data should be used
    in delayed time mode. The returned struct should have the following fields:
      GLI_NAME_PATTERN: string with the name pattern of SeaExplorer glider
        files to be loaded by LOADSEAEXPLORERDATA for processing.
      PLD_NAME_PATTERN: string with the name pattern of SeaExplorer payload
        files to be loaded by LOADSEAEXPLORERDATA for processing.
      GLI_TIME: string with the name of the variable to use as timestamp
        in glider files when combining data from a set of SeaExplorer files.
      PLD_TIME: string with the name of the variable to use as timestamp
        in payload files when combining data from a set of SeaExplorer files.
      VARIABLES: string cell array with the name of the variables to load
        from glider and payload files by LOADSEAEXPLORERDATA. Restricting
        the list of variables to load may reduce the memory footprint.

  Examples:
    seaexplorer_options = configRTFileOptionsSeaExplorer()

  See also:
    MAIN_GLIDER_DATA_PROCESSING_RT
    LOADSEAEXPLORERDATA

  Authors:
    Frederic Cyr  <Frederic.Cyr@mio.osupytheas.fr>
    Joan Pau Beltran  <joanpau.beltran@socib.cat>

0001 function seaexplorer_options = configRTFileOptionsSeaExplorer()
0002 %CONFIGRTFILEOPTIONSSEAEXPLORER  Configure loading options for SeaExplorer files in real time.
0003 %
0004 %  Syntax:
0005 %    SEAEXPLORER_OPTIONS = CONFIGRTFILEOPTIONSSEAEXPLORER()
0006 %
0007 %  Description:
0008 %    SEAEXPLORER_OPTIONS = CONFIGRTFILEOPTIONSSEAEXPLORER() should return
0009 %    a struct with the parameters that control which are the deployment files,
0010 %    whether they need to be converted, and which files and data should be used
0011 %    in delayed time mode. The returned struct should have the following fields:
0012 %      GLI_NAME_PATTERN: string with the name pattern of SeaExplorer glider
0013 %        files to be loaded by LOADSEAEXPLORERDATA for processing.
0014 %      PLD_NAME_PATTERN: string with the name pattern of SeaExplorer payload
0015 %        files to be loaded by LOADSEAEXPLORERDATA for processing.
0016 %      GLI_TIME: string with the name of the variable to use as timestamp
0017 %        in glider files when combining data from a set of SeaExplorer files.
0018 %      PLD_TIME: string with the name of the variable to use as timestamp
0019 %        in payload files when combining data from a set of SeaExplorer files.
0020 %      VARIABLES: string cell array with the name of the variables to load
0021 %        from glider and payload files by LOADSEAEXPLORERDATA. Restricting
0022 %        the list of variables to load may reduce the memory footprint.
0023 %
0024 %  Examples:
0025 %    seaexplorer_options = configRTFileOptionsSeaExplorer()
0026 %
0027 %  See also:
0028 %    MAIN_GLIDER_DATA_PROCESSING_RT
0029 %    LOADSEAEXPLORERDATA
0030 %
0031 %  Authors:
0032 %    Frederic Cyr  <Frederic.Cyr@mio.osupytheas.fr>
0033 %    Joan Pau Beltran  <joanpau.beltran@socib.cat>
0034 
0035 %  Copyright (C) 2016
0036 %  ICTS SOCIB - Servei d'observacio i prediccio costaner de les Illes Balears
0037 %  <http://www.socib.es>
0038 %
0039 %  This program is free software: you can redistribute it and/or modify
0040 %  it under the terms of the GNU General Public License as published by
0041 %  the Free Software Foundation, either version 3 of the License, or
0042 %  (at your option) any later version.
0043 %
0044 %  This program is distributed in the hope that it will be useful,
0045 %  but WITHOUT ANY WARRANTY; without even the implied warranty of
0046 %  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
0047 %  GNU General Public License for more details.
0048 %
0049 %  You should have received a copy of the GNU General Public License
0050 %  along with this program.  If not, see <http://www.gnu.org/licenses/>.
0051 
0052   error(nargchk(0, 0, nargin, 'struct'));
0053   
0054   % Glider (.gli) files to use:
0055   seaexplorer_options.gli_name_pattern = '^.*\.gli(\..*)?$';
0056   
0057   % Payload (.pld) files to use:
0058   % They used to have the suffix '.dat' during the SeaExplorer development.
0059   seaexplorer_options.pld_name_pattern = '^.*\.(pld|dat)(\d*)?(\..*)?$';
0060   
0061   % Time variable column in glider files:
0062   seaexplorer_options.gli_time = 'Timestamp';
0063   
0064   % Time variable column in payload files:
0065   seaexplorer_options.pld_time = 'PLD_REALTIMECLOCK';
0066   
0067   % Variables to load:
0068   seaexplorer_options.variables = 'all';  
0069   
0070 end