Actions

ZEITRIO: Difference between revisions

From BAWiki

(adding input file types 18-20)
mNo edit summary
 
(3 intermediate revisions by the same user not shown)
Line 2: Line 2:
|name_de=ZEITRIO
|name_de=ZEITRIO
|name=ZEITRIO
|name=ZEITRIO
|version=February 2020
|version=April 2021
|version_descr=February 2020
|version_descr=April 2021
|catchwords=preprocessor<br />
|catchwords=preprocessor<br />
time series<br />
time series<br />
concatenation
concatenation
|shortdescription=The program ZEITRIO reads and writes data files, that contain time series in different formats. It is possible to read the file-types listed below. They can be wrote as boewrt.dat, as ASCII columns or CSV format afterwards. Concatenation of multible files is supported.
|shortdescription=The program ZEITRIO reads and writes data files, that contain time series in different formats. It is possible to read the file-types listed below. They can be wrote as boewrt.dat, as ASCII columns or CSV format afterwards. Concatenation of multible files is supported. A BOEWRT status flag is eventually be generated or transported.
|inputfiles=
|inputfiles=
# data file(s) with time series of type [[BOEWRT.DAT|boewrt.dat]].
# data file(s) with time series of type [[BOEWRT.DAT|boewrt.dat]]. A list of several files can be concatenated by the command line argument ''-srclist=<file>''.
# data file(s) with time series of type [[SOLWRT.DAT|solwrt.dat]].
# data file(s) with time series of type [[SOLWRT.DAT|solwrt.dat]].
# data file(s) with time series of type 6dph.dat.
# data file(s) with time series of type 6dph.dat.
Line 37: Line 37:
# printer protocol file (zeitrio.sdr).
# printer protocol file (zeitrio.sdr).
# (optional) terminal input protocol of type gkslog.dat.   
# (optional) terminal input protocol of type gkslog.dat.   
|methodology=After defining a reference date, which is important when reading or writing a file with relative time information (e.g. solwrt.dat) a time series file is read. Please note, that only one time series at one knot can be read and proccessed at the same time. Optionally further time series files can be concatenated then. The file type can be swiched for each file to read. After reading process has finished, the time series wil be ordered chonologically and double as well as unvalid times are rejected.
|methodology=After defining a reference date, which is important when reading or writing a file with relative time information (e.g. solwrt.dat) a time series file is read. Please note, that only one time series at one knot can be read and processed at the same time. Optionally further time series files can be concatenated then. The file type can be switched for each file to read. After reading process has finished, the time series will be ordered chronologically and double as well as unvalid times are rejected.


The time series are wrote to a file using the format defined by the user. If writing [[BOEWRT.DAT|boewrt.dat]]  there is the additional possiblity to write defined time intervalls (e.g. days) into seperate files. The date of the day is part of the file name.  
The time series are wrote to a file using the format defined by the user. If writing [[BOEWRT.DAT|boewrt.dat]]  there is the additional option to write defined time intervals (e.g. days) into separate files. The date of the day is part of the file name. Measured values additionally get the BOEWRT status flag 2 ("untested") where the flag data are not read from the input file. Calculated values ("knoerg.bin") get the status "good" (1).


Optionally the time series will be interpolated to equidistant time steps. Larger time gaps can optionally filled with a dummy value (fill value, output mode 1) or eliminated (output mode 2) on output. The printer protocol file provides information about significant gaps in time axis. Interpolation of smaller gaps is be done alternatevly by spline or linear interpolation.
Optionally the time series will be interpolated to equidistant time steps. Larger time gaps can optionally filled with a dummy value (fill value, output mode 1) or eliminated (output mode 2) on output. The user defines a minmal value for time gaps to be recognized large. The printer protocol file provides information about significant gaps in time axis. Interpolation of smaller gaps is be done alternatively by spline or linear interpolation. The BOEWRT status flag indicates whether the values are interpolated. Those values get the flags "untested", "interpolated" and eventually "good" or "suspicious".


The output time period is determined by the interactive user input. If several input files are read during one cycle, the first start time and last end time determine the output period. If output mode 1 is choosen, eventually fill values are added during equidistant interpolation.  
The output time period is determined by the interactive user input. If several input files are read during one cycle, the first start time and last end time determine the output period. If output mode 1 is chosen, eventually fill values are added during equidistant interpolation before the first valid measurement time and after the last valid measurement time. Unlike Versions before February 2020, the program doesent stop with an error, if the time period, specified by the user is not completely covered.
Check output files and standard output for warnings!
 
'''Attention:''' Versions before February 2020 were not able to correctly deal with fill values during interpolation of more than one physical quantity at once. Now this functionality is implemented. But still check your results! BOEWRT timeseries for input can start with empty data records ("fill_values") since version 2020_10_15 to be processed anyway.


Time series of type MATLAB matrix, ZRX or "exctab.dat" can be filtered and recalculated with an offset and scaling for the data values. Absolute date and time will always be calculated by special operators with high accuracy.
Time series of type MATLAB matrix, ZRX or "exctab.dat" can be filtered and recalculated with an offset and scaling for the data values. Absolute date and time will always be calculated by special operators with high accuracy.
During reading and interpolation, eventually a BOEWRT status flag is created. Check correctness of those flags befor further processing the files.
Since Version June 2020 interpolation of BOEWRT status flags takes the neighbouring flag values into account. If both neighbours are "good", the interpolated value becomes "good" too. If one of them is "suspicious", the interpolated flag becomes "suspicious". Interpolated values are always "untested"!
The number of interactiv dialogs can be reduced by giving command line arguments. This feature is available since version 2020_10_15. The command '''''zeitrio[.i18] -h''''' helps in using this feature.


An executable is available for LINUX as well as WINDOWS platforms.
An executable is available for LINUX as well as WINDOWS platforms.


|preprocessor=[[FFT]], [[GVIEW2D]], [[TSCALC]], [http://www.mathworks.co.uk/products/matlab/index.html?s_tid=gn_loc_drop MATLAB], [http://www.scilab.org/ SCILAB], [[TRIM-2D]], [[TRIM-3D]]
|preprocessor=spreadsheet software (e.g. [https://en.wikipedia.org/wiki/Microsoft_Excel MS Office EXCEL], [https://en.wikipedia.org/wiki/LibreOffice_Calc LibreOffice Calc] ),[[FFT]], [[FRQ2ZEITR]], [[GVIEW2D]], [http://www.mathworks.co.uk/products/matlab/index.html?s_tid=gn_loc_drop MATLAB], [[MESKOR]], [http://www.scilab.org/ SCILAB], [[TSCALC]], [[TRIM-2D]], [[TRIM-3D]], [[XTRDATA]]
|postprocessor=[[BOERND]], [[DATACONVERT]], [[EXCELENZ]], [[FFT]], [[FRQWF]], [[GVIEW2D]], [[ROSE]], [[TIDKEN]], [[TSCALC]], [[UTRRND]], [http://www.mathworks.co.uk/products/matlab/index.html?s_tid=gn_loc_drop MATLAB], [http://www.scilab.org/ SCILAB], [http://www.deltares.nl/en/software/479962/delft-fews Delft-FEWS]
|postprocessor=[[BOERND]], [[DATACONVERT]], [[EXCELENZ]], [[FFT]], [[FRQWF]], [[GVIEW2D]], [http://www.mathworks.co.uk/products/matlab/index.html?s_tid=gn_loc_drop MATLAB], [[MESKOR]], [[ROSE]], [http://www.scilab.org/ SCILAB], [[TIDKEN]], [[TSCALC]], [[UTRRND]], [http://www.deltares.nl/en/software/479962/delft-fews Delft-FEWS]
|language=Fortran95
|language=Fortran2003
|add_software= NTv2 mesh files for coordinate transformation (see also [[GEOTRANSFORMER]]).  
|add_software= libgeodesy, NTv2 mesh files for coordinate transformation (see also [[GEOTRANSFORMER]]).  
|contact_original=[mailto:jens.juerges@baw.de J. Jürges]
|contact_original=J. Jürges
|contact_maintenance=[mailto:jens.juerges@baw.de J. Jürges] [mailto:guntram.seiss@baw.de G. Seiß]
|contact_maintenance=[mailto:pre.proghome@baw.de working group PRE]
|documentation=$PROGHOME/examples/zeitrio  
|documentation=$PROGHOME/examples/zeitrio  
}}
}}

Latest revision as of 07:43, 11 October 2022

Basic Information

Name of Program

ZEITRIO

Version-Date

April 2021

Description-Date

April 2021

Catchwords

preprocessor
time series
concatenation

Short Description of Functionality

The program ZEITRIO reads and writes data files, that contain time series in different formats. It is possible to read the file-types listed below. They can be wrote as boewrt.dat, as ASCII columns or CSV format afterwards. Concatenation of multible files is supported. A BOEWRT status flag is eventually be generated or transported.

Input-Files

  1. data file(s) with time series of type boewrt.dat. A list of several files can be concatenated by the command line argument -srclist=<file>.
  2. data file(s) with time series of type solwrt.dat.
  3. data file(s) with time series of type 6dph.dat.
  4. data file(s) with time series of type trbnk.dat.
  5. data file(s) with time series of type aander.dat.
  6. data file(s) with time series of type dwdwin.dat.
  7. data file(s) with time series of type WSA Bremen.
  8. data file(s) with time series of type peg.dat.
  9. data file(s) with time series of type pegel.his.
  10. data file(s) with time series of type extab.dat (Excel table with separators Blanks, Tabs, comma, semicolon).
  11. data file(s) with time series of type WSA Emden.
  12. data file(s) with time series of type column oriented MATLAB matrix.
  13. data file(s) with time series of type ZRX.
  14. data file(s) with time series of type WOCE gauge data.
  15. data file(s) with time series of type knoerg.bin.
  16. data file(s) with time series of type CSV of the BfG "Pegel-Online" Service.
  17. data file(s) with time series of type CSV provided by ftp://ftp-cdc.dwd.de/pub/CDC/
  18. data file(s) with time series of type ALL (Kisters export of WISKI database)
  19. netCDF files with timeseries from http://www.marineinsitu.eu/dashboard/
  20. generic CSV file interface allowing free choice of columns .
  21. optional input data of type zeitrio.dat. This file defines time intervals in case that the output (boewrt.dat only) should be devided into several seperate files of a certain length.

Output-Files

The number of output file types was limited to really useful standard formats.

  1. data file with time series of type boewrt.dat (output modes 1 and 2)..
  2. data file with time series as ASCII-columns and a separate header file (a format which can be used with MATLAB, SCILAB or Mathematica)
  3. data file with time series of type CSV with an one line header of type (Zeitpunkt; property 1; property 2; ....) for Delft-FEWS (output mode 4).
  4. printer protocol file (zeitrio.sdr).
  5. (optional) terminal input protocol of type gkslog.dat.

Methodology

After defining a reference date, which is important when reading or writing a file with relative time information (e.g. solwrt.dat) a time series file is read. Please note, that only one time series at one knot can be read and processed at the same time. Optionally further time series files can be concatenated then. The file type can be switched for each file to read. After reading process has finished, the time series will be ordered chronologically and double as well as unvalid times are rejected.

The time series are wrote to a file using the format defined by the user. If writing boewrt.dat there is the additional option to write defined time intervals (e.g. days) into separate files. The date of the day is part of the file name. Measured values additionally get the BOEWRT status flag 2 ("untested") where the flag data are not read from the input file. Calculated values ("knoerg.bin") get the status "good" (1).

Optionally the time series will be interpolated to equidistant time steps. Larger time gaps can optionally filled with a dummy value (fill value, output mode 1) or eliminated (output mode 2) on output. The user defines a minmal value for time gaps to be recognized large. The printer protocol file provides information about significant gaps in time axis. Interpolation of smaller gaps is be done alternatively by spline or linear interpolation. The BOEWRT status flag indicates whether the values are interpolated. Those values get the flags "untested", "interpolated" and eventually "good" or "suspicious".

The output time period is determined by the interactive user input. If several input files are read during one cycle, the first start time and last end time determine the output period. If output mode 1 is chosen, eventually fill values are added during equidistant interpolation before the first valid measurement time and after the last valid measurement time. Unlike Versions before February 2020, the program doesent stop with an error, if the time period, specified by the user is not completely covered. Check output files and standard output for warnings!

Attention: Versions before February 2020 were not able to correctly deal with fill values during interpolation of more than one physical quantity at once. Now this functionality is implemented. But still check your results! BOEWRT timeseries for input can start with empty data records ("fill_values") since version 2020_10_15 to be processed anyway.

Time series of type MATLAB matrix, ZRX or "exctab.dat" can be filtered and recalculated with an offset and scaling for the data values. Absolute date and time will always be calculated by special operators with high accuracy.

During reading and interpolation, eventually a BOEWRT status flag is created. Check correctness of those flags befor further processing the files.

Since Version June 2020 interpolation of BOEWRT status flags takes the neighbouring flag values into account. If both neighbours are "good", the interpolated value becomes "good" too. If one of them is "suspicious", the interpolated flag becomes "suspicious". Interpolated values are always "untested"!

The number of interactiv dialogs can be reduced by giving command line arguments. This feature is available since version 2020_10_15. The command zeitrio[.i18] -h helps in using this feature.

An executable is available for LINUX as well as WINDOWS platforms.

Program(s) to run before this Program

spreadsheet software (e.g. MS Office EXCEL, LibreOffice Calc ),FFT, FRQ2ZEITR, GVIEW2D, MATLAB, MESKOR, SCILAB, TSCALC, TRIM-2D, TRIM-3D, XTRDATA

Program(s) to run after this Program

BOERND, DATACONVERT, EXCELENZ, FFT, FRQWF, GVIEW2D, MATLAB, MESKOR, ROSE, SCILAB, TIDKEN, TSCALC, UTRRND, Delft-FEWS

Additional Information

Language

Fortran2003

Additional software

libgeodesy, NTv2 mesh files for coordinate transformation (see also GEOTRANSFORMER).

Original Version

J. Jürges

Maintenance

working group PRE

Documentation/Literature

$PROGHOME/examples/zeitrio


back to Program Descriptions


Overview