BOEWRT.DAT: Unterschied zwischen den Versionen

Version vom 7. Mai 2014, 09:30 Uhr

Basisinformationen

Datei-Typ

boewrt.dat

Datei-Form

FORMATTED

Version

Mai 2014, klassische Version September 2001

Beschreibung

Mai 2014

Bedeutung der Datei

enthält Zeitserien gemessener oder berechneter Daten als ASCII für die Benutzung in verschiedenen Programmen.

Allgemeines

Die Datei hat einen Header in dem Metadaten anhand ihrer Position in der Datei identifiziert werden, die erste Datenzeile beginnt bspw. mit der Knotennummer. Diese klassischen boewrt.dat Dateien können mit den den Methoden der BAW-Bibliothek io verarbeitet werden. Seit Mai 2014 kann der neue boewrt.dat Header Key-Value Paare mit zusätzlichen Metadaten enthalten, der Key Fill_Value wird z.B. mit einer reellen Zahl als Value verbunden. Programme, die die klassische io- oder die neue io_dataset-Bibliothek benutzen, können beide Dateiversionen fehlerfrei lesen.Die zusätzlichen Metainformationen werden aber nur von io_dataset ausgewertet.

Der eigentliche Datenteil zeichnet sich durch flexible Datums- und Zeitangaben aus. Zweistellige Jahreszahlen sollten allerdings nicht weiter verwendet werden. Ein Semikolon empfiehlt sich zum Trennen von Datum- und Zeitangaben von den Werten der physikalischen Größen.

Gerade die Metadaten werden von den beiden Libraries unterschiedlich interpretiert.

Io-Bibliothek vorzugsweise für klassische boewrt.dat-Dateien mit Unterstützung von Umgebungsvariablen

Diese Bibliothek kann Umgebungsvariablen auswerten.

$BAWCRS: Wenn die Umgebungsvariable $BAWCRS auf einen gültigen Wert (EPSG code) gesetzt wurde, wird die enthaltene Koordinate von dem in der Datei enthaltenen CRS in das durch $BAWCRS gesetzte System "on the fly" konvertiert. Enthält die Datei kein sinnvolles CRS, so wird die Koordinate nicht transformiert. Der Nutzer sollte daher beim Aufruf der untenstehenden Programme immer die Variable BAWCRS gezielt setzen!

$BAWCENTURY: Falls im Datenteil zweistellige Jahreszahlen verwendet werden, wird das ab $BAWCENTURY einschließlich folgende Jahrhundert implizit angenommen. Der Nutzer sollte $BAWCENTURY innerhalb seiner Umgebung spezifizieren (DEFAULT: 1900).

Die Zeitzone wird nur interpretiert, wenn das gewünschte Anfangs- oder Enddatum eine definierte Zeitzone besitzt.
Besitzt die Datei in diesem Fall eine undefinierte Zeitzone, so wird MEZ angenommen!

Io_dataset-Bibliothek vorzugsweise für neue boewrt.dat-Dateien

Wenn vom io_dataset-Package aus auf eine Boewrt-Datei zugegriffen wird, muss der Header weitere verpflichtende Metainformationen enthalten um Fehlinterpretationen auszuschließen. Dazu gehören Angaben zu Zeitzone, Koordinatenreferenzsystem und Fill Value, s. Datei-Inhalt. Die o.g. Umgebungsvariablen werden von io_dataset nicht ausgewertet. Metainformationen werden in Objekte der Typen Dimension (dim), Variable (var) and Attribut (att) verpackt, wie es üblicherweise auch für NetCDF-Dateien getan wird. Von außerhalb des Packages wird auf die Daten in generischer Weise zugegriffen, d.h. für unterschiedliche Dateitypen werden die gleichen Methoden verwendet.

Datei-Inhalt

Daten, die sowohl im klassischen als im neuen boewrt.dat-Format enthalten sind:

Punktnummer und (optional) Kürzel für Zeitzone und Koordinatenreferenzsystem. Diese Zeile ist formatiert im FORTRAN-Format "(I10,1X,A4,1X,A5)" zu schreiben. Vorzugsweise sollten für Zeitzonen die bekannten Kürzel ("MEZ ", "MESZ", "UTC ") und für das Koordinatensystem die in der BAW gebräuchlichen EPSG-Codes (siehe z.B. bei GEOTRANSFORMER) verwendet werden. Einige Kürzel wie as "GK3B" or "SPHW" sind ebenfalls erlaubt.
Stationsname (im FORTRAN-Format "(A)").
Räumliche Position, gegeben durch Rechtswert, Hochwert und optionaler Tiefe, d.h. die positive Achsrichtung zeigt nach unten. (unformatiert, getrennt mit Leerzeichen).
Anzahl n der abgespeicherten physikalischen Größen und deren ICODE-Kennungen (FORTRAN-Format "(I10,nI8)"
Im Datenteil Datum, Uhrzeit und Werte der physikalischen Größen für jeden gespeicherten Zeitpunkt. Vorzugsweise sollte der Datums-String mit einem Semikolon von den physikalischen Werten getrennt werden.

Daten, die ausschließlich im klassischen Format verwendet werden

Minimaler und maximaler Zeitschritt; hier entfällt eine Überprüfung der Zeitreihe auf Monotonie in der Zeit. Sollte das Lesen einer Datei fehlschlagen, sollten sie sicherheitshalber entfernt werden. Werden Dateien per Editor manipuliert, so sollten diese Zeilen immer entfernt werden!
FORTRAN-Format der Datenzeilen. Es dient der Beschleunigung des Lesevorgangs, d.h. eine einheitliche Formatierung der Datenzeilen wird vorausgesetzt. Sollte das Lesen einer Datei fehlschlagen, sollten das Format sicherheitshalber entfernt werden. Werden Dateien per Editor manipuliert, so sollte es immer entfernt werden!

Daten, die ausschließlich im klassischen Format verwendet werden Die folgenden Schlüsselwörter beziehen sich auf die Standard-Attribut-Tabelle der NODC

Fill_Value: eine reelle Zahl, die die ungültigen Werte physikalische Größen festlegt. (verpflichtend)
Instrument_Name (optional)
Instrument_Comment: kommentiert das durch Instrument_Name gekennzeichnete Instrument (optional)
Platform_Name: Name der geophysikalischen Platform, die das Instrument beherbergt (optional)
Platform_Comment: kommentiert die durch Platform_Name gekennzeichnete Platform (optional)
Valid_Range: definiert minimale and maximale Grenzwerte für physikalische Größen, die durch ihr BAW ICODE-Kennung identifiziert werden (optional)
Measure_Comment: Kommentar für jeweils eine physikalische Größe (optional)
Zeilenkommentar: optionaler Kommentar zu den Werten einer Zeile im Datenteil, wie im nachfolgenden Beispiel in dem "!" die Werte der physik. Größen vom Zeilenkommentar "2_QMag 2_QDir" trennt:

         29.02.2004 12:00:31;    0.066  122.010     !2_QMag 2_QDir

Programme, welche diesen Datei-Typ benutzen

klassisch: EVENTFILTER, EXCELENZ, EXKNO, FD2MET, FRQ2ZEITR, FRQWF, GEOTRANSFORMER, GVIEW2D, HVIEW2D, MESKOR, ROSE, TIDKEN, TSCALC, UNTRIM2007MONITOR, UTRRND, VVIEW2D, XTRDATA, ZEITRIO
neu: DATACONVERT

Beispiel-Datei

klassisch: $PROGHOME/examples/zeitrio/boewrt.new.dat und $PROGHOME/examples/zeitrio/boewrt.dat
neu: $PROGHOME/examples/dataconvert/boewrt.optionalheader.dat und $PROGHOME/examples/dataconvert/boewrt.linecomments.dat

zurück zu: Dateikennblätter

Strukturübersicht

@@ Zeile 2: / Zeile 2: @@
 |name_en=BOEWRT.DAT
 |dateityp=boewrt.dat
-|version=May 2014, classic version September 2001
+|version=Mai 2014, klassische Version September 2001
-|version_beschr=May 2014
+|version_beschr=Mai 2014
 |bedeutung=enthält Zeitserien gemessener oder berechneter Daten als ASCII für die Benutzung in verschiedenen Programmen.
 ===Allgemeines===
-Die Datei hat einen Header in dem Metadaten anhand ihrer Position in der Datei identifiziert werden, die erste Datenzeile beginnt bspw. mit der Knotennummer. Dies ist eine klassiche boewrt.dat Datei, die mit den Methoden der io-Library verarbeitet werden kann. Seit Mai 2014 kann der neue boewrt.dat Header Key-Value Paare mit zusätzlichen Metadaten enthalten, der Key Fill_Value wird z.B. mit einer reellen Zahl als Value verbunden. Die zusätzlichen Metainformationen werden nur vom neuen BAW-Software-Package io_dataset ausgewertet.<br/>
+Die Datei hat einen Header in dem Metadaten anhand ihrer Position in der Datei identifiziert werden, die erste Datenzeile beginnt bspw. mit der Knotennummer. Diese klassischen boewrt.dat Dateien können mit den den Methoden der BAW-Bibliothek io verarbeitet werden. Seit Mai 2014 kann der neue boewrt.dat Header Key-Value Paare mit zusätzlichen Metadaten enthalten, der Key Fill_Value wird z.B. mit einer reellen Zahl als Value verbunden. Programme, die die klassische io- oder die neue io_dataset-Bibliothek benutzen, können beide Dateiversionen fehlerfrei lesen.Die zusätzlichen Metainformationen werden aber nur von io_dataset ausgewertet.<br/>
-Programme, die die io- oder die io_dataset-Library benutzen, können sowohl die klassische als auch die neue Version von boewrt.dat lesen. Der eigentliche Datenteil zeichnet sich durch flexible Datums- und Zeitangaben aus. Zweistellige Jahreszahlen sollten allerdings nicht weiter verwendet werden. Ein Semikolon empfiehlt sich zum Trennen von Datum- und Zeitangaben von den Werten der physikalischen Größen.
+Der eigentliche Datenteil zeichnet sich durch flexible Datums- und Zeitangaben aus. Zweistellige Jahreszahlen sollten allerdings nicht weiter verwendet werden. Ein Semikolon empfiehlt sich zum Trennen von Datum- und Zeitangaben von den Werten der physikalischen Größen.
 Gerade die Metadaten werden von den beiden Libraries unterschiedlich interpretiert.
-Das Format der Datei ist ziemlich flexibel:<br />in den Datenzeilen wird jedes der BAW-eigenen Zeit-Formate akzeptiert.<br />Benutze zur Trennung von den physikalischen Werten ein ";"-Zeichen.
+===Io-Bibliothek vorzugsweise für klassische boewrt.dat-Dateien mit Unterstützung von Umgebungsvariablen===
-Das Zeitformat mit 2-stelliger Jahreszahl sollte jedoch nicht mehr verwendet werden.<br /> Falls es benutzt wird, wird das ab $BAWCENTURY einschließlich folgende Jahrhundert implizit angenommen. Der Nutzer sollte $BAWCENTURY innerhalb seiner Umgebung spezifizieren (DEFAULT: 1900).<br />Die Zeitzone wird nur interpretiert, wenn das gewünschte Anfangs- oder Enddatum eine definierte Zeitzone besitzt.<br />Besitzt die Datei in diesem Fall eine undefinierte Zeitzone, so wird MEZ angenommen! <br />
-Die Leseroutine unterstützt das Koordinatenreferenzsystem (CRS) wie folgt: <br />
+Diese Bibliothek kann Umgebungsvariablen auswerten. <BR>
-Ist die Umgebungsvariable $BAWCRS auf einen sinnvollen Wert gesetzt, so wird die enthaltene Koordinate von dem in der Datei enthaltenen CRS in das durch $BAWCRS gesetzte System konvertiert. Enthält die Datei kein sinnvolles CRS, so wird die Koordinate nicht transformiert. Der Nutzer sollte daher beim Aufruf der untenstehenden Programme immer die Variable BAWCRS gezielt setzen!<br />
+* $BAWCRS: Wenn die Umgebungsvariable $BAWCRS auf einen gültigen Wert (EPSG code) gesetzt wurde, wird die enthaltene Koordinate von dem in der Datei enthaltenen CRS in das durch $BAWCRS gesetzte System "on the fly" konvertiert. Enthält die Datei kein sinnvolles CRS, so wird die Koordinate nicht transformiert. Der Nutzer sollte daher beim Aufruf der untenstehenden Programme immer die Variable BAWCRS gezielt setzen!<br />
-Dateien des Typs boewrt.dat können drei Kommentare enthalten, die den minimalen und den maximalen Zeitschritt sowie das FORTRAN-Format der Datenzeilen enthalten. Diese Zeilen dienen der Beschleunigung des Lesevorgangs, d.h. eine Überprüfung der Zeitreihe auf Monotonie in der Zeit entfällt und eine einheitliche Formatierung der Datenzeilen wird vorausgesetzt. Sollte das Lesen einer Datei fehlschlagen, sollten diese Zeilen sicherheitshalber entfernt werden. Werden Dateien per Editor manipuliert, so sollten diese Zeilen immer entfernt werden!
+* $BAWCENTURY: Falls im Datenteil zweistellige Jahreszahlen verwendet werden, wird das ab $BAWCENTURY einschließlich folgende Jahrhundert implizit angenommen. Der Nutzer sollte $BAWCENTURY innerhalb seiner Umgebung spezifizieren (DEFAULT: 1900).
+* Die Zeitzone wird nur interpretiert, wenn das gewünschte Anfangs- oder Enddatum eine definierte Zeitzone besitzt.<br />Besitzt die Datei in diesem Fall eine undefinierte Zeitzone, so wird MEZ angenommen! <br />
+===Io_dataset-Bibliothek vorzugsweise für neue boewrt.dat-Dateien===
+Wenn vom io_dataset-Package aus auf eine Boewrt-Datei zugegriffen wird, muss der Header weitere verpflichtende Metainformationen enthalten um Fehlinterpretationen auszuschließen. Dazu gehören Angaben zu Zeitzone, Koordinatenreferenzsystem und Fill Value, s. Datei-Inhalt. Die o.g. Umgebungsvariablen werden von io_dataset nicht ausgewertet. Metainformationen werden in Objekte der Typen Dimension (dim), Variable (var) and Attribut (att) verpackt, wie es üblicherweise auch für NetCDF-Dateien getan wird. Von außerhalb des Packages wird auf die Daten in generischer Weise zugegriffen, d.h. für unterschiedliche Dateitypen werden die gleichen Methoden verwendet.
 |dateiinhalt=
-# Punktnummer und (optional) Kürzel für Zeitzone und Koordinatenreferenzsystem. Diese Zeile ist FORMATIERT im FORTRAN-Format "(I10,1X,A4,1X,A5)" zu schreiben. Vorzugsweise sollten für Zeitzonen die bekannten Kürzel ("MEZ ", "MESZ", "UTC ") und für das Koordinatensystem die in der BAW gebräuchlichen EPSG-Codes (siehe z.B. bei [[GEOTRANSFORMER]]) verwendet werden.
+Daten, die sowohl im klassischen als im neuen boewrt.dat-Format enthalten sind:
-# Ortsbezeichnung (im FORTRAN-Format "(A)").
+# Punktnummer und (optional) Kürzel für Zeitzone und Koordinatenreferenzsystem. Diese Zeile ist formatiert im FORTRAN-Format "(I10,1X,A4,1X,A5)" zu schreiben. Vorzugsweise sollten für Zeitzonen die bekannten Kürzel ("MEZ ", "MESZ", "UTC ") und für das Koordinatensystem die in der BAW gebräuchlichen EPSG-Codes (siehe z.B. bei [[GEOTRANSFORMER]]) verwendet werden. Einige Kürzel wie as "GK3B" or "SPHW" sind ebenfalls erlaubt.
-# Räumliche Position, gegeben durch Rechtswert, Hochwert und Tiefe (unformatiert, getrennt mit Leerzeichen).
+# Stationsname (im FORTRAN-Format "(A)").
-# Anzahl n der abgespeicherten Größen und deren physikalische Code-Kennungen (FORTRAN-Format "(I10,nI8)"
+# Räumliche Position, gegeben durch Rechtswert, Hochwert und optionaler Tiefe, d.h. die positive Achsrichtung zeigt nach unten. (unformatiert, getrennt mit Leerzeichen).
-# Datum, Uhrzeit und Daten für jeden gespeicherten Zeitpunkt. Vorzugsweise sollte der Datums-String mit einem Semikolon ";" von den physikalischen Werten getrennt werden.
+# Anzahl n der abgespeicherten physikalischen Größen und deren ICODE-Kennungen (FORTRAN-Format "(I10,nI8)"
-|nutzerprogramme=[[EVENTFILTER]], [[EXCELENZ]], [[EXKNO]], [[FD2MET]], [[FRQ2ZEITR]], [[FRQWF]], [[GEOTRANSFORMER]], [[GVIEW2D]], [[HVIEW2D]], [[MESKOR]], [[ROSE]], [[TIDKEN]], [[TSCALC]], [[UNTRIM2007MONITOR]], [[UTRRND]], [[VVIEW2D]], [[XTRDATA]], [[ZEITRIO]]
+# Im Datenteil Datum, Uhrzeit und Werte der physikalischen Größen für jeden gespeicherten Zeitpunkt. Vorzugsweise sollte der Datums-String mit einem Semikolon von den physikalischen Werten getrennt werden.<br />
+Daten, die ausschließlich im klassischen Format verwendet werden
+# Minimaler und maximaler Zeitschritt; hier entfällt eine Überprüfung der Zeitreihe auf Monotonie in der Zeit. Sollte das Lesen einer Datei fehlschlagen, sollten sie sicherheitshalber entfernt werden. Werden Dateien per Editor manipuliert, so sollten diese Zeilen immer entfernt werden!<br>
+# FORTRAN-Format der Datenzeilen. Es dient der Beschleunigung des Lesevorgangs, d.h. eine einheitliche Formatierung der Datenzeilen wird vorausgesetzt. Sollte das Lesen einer Datei fehlschlagen, sollten das Format sicherheitshalber entfernt werden. Werden Dateien per Editor manipuliert, so sollte es immer entfernt werden!
+<br />
+Daten, die ausschließlich im klassischen Format verwendet werden
+Die folgenden Schlüsselwörter beziehen sich  auf die
+[http://www.nodc.noaa.gov/data/formats/netcdf/#guidancetable Standard-Attribut-Tabelle der NODC ]
+# Fill_Value: eine reelle Zahl, die die ungültigen Werte physikalische Größen festlegt. (verpflichtend)
+# Instrument_Name (optional)
+# Instrument_Comment: kommentiert das durch Instrument_Name gekennzeichnete Instrument (optional)
+# Platform_Name: Name der geophysikalischen Platform, die das Instrument beherbergt (optional)
+# Platform_Comment: kommentiert die durch Platform_Name gekennzeichnete Platform (optional)
+# Valid_Range: definiert minimale and maximale Grenzwerte für physikalische Größen, die durch ihr BAW ICODE-Kennung identifiziert werden (optional)
+# Measure_Comment: Kommentar für jeweils eine physikalische Größe (optional)
+# Zeilenkommentar: optionaler Kommentar zu den Werten einer Zeile im Datenteil, wie im nachfolgenden Beispiel in dem "!" die Werte der physik. Größen vom Zeilenkommentar "2_QMag 2_QDir" trennt:<br/>
+.02.2004 12:00:31;    0.066  122.010     !2_QMag 2_QDir<br/>
+|nutzerprogramme=klassisch: [[EVENTFILTER]], [[EXCELENZ]], [[EXKNO]], [[FD2MET]], [[FRQ2ZEITR]], [[FRQWF]], [[GEOTRANSFORMER]], [[GVIEW2D]], [[HVIEW2D]], [[MESKOR]], [[ROSE]], [[TIDKEN]], [[TSCALC]], [[UNTRIM2007MONITOR]], [[UTRRND]], [[VVIEW2D]], [[XTRDATA]], [[ZEITRIO]] <br>
+neu: [[DATACONVERT]]
 |programmiersprache=Fortran95
 |dateiform=FORMATTED
 |dateizugriff=SEQUENTIAL
 |dateiendung=.dat
-|schreibmodule=$PROGHOME/fortran/lib/io/*/mod_boewrt_io.f90:write_boewrt_info
+|schreibmodule=klassisch: $PROGHOME/fortran/lib/io/*/mod_boewrt_io.f90:write_boewrt_info,<BR>
-|lesemodule=$PROGHOME/fortran/lib/io/*/mod_boewrt_io.f90:read_boewrt_info
+neu: -
+|lesemodule=klassisch: $PROGHOME/fortran/lib/io/*/mod_boewrt_io.f90:read_boewrt_info,<BR>
+neu: $PROGHOME/fortran/lib/io_dataset/*/mod_io_dataset_ui.f90, mod_m_dataset_boewrt_info.f90 and mod_m_dataset_boewrt.f90.
 |kontakt_original=[mailto:ingrid.uliczka@baw.de I. Uliczka]
-|kontakt_pflege=[mailto:guntram.seiss@baw.de G. Seiß]
+|kontakt_pflege=[mailto:guntram.seiss@baw.de G. Seiß], [mailto:peter.schade@baw.de P. Schade]
-|beispieldatei=$PROGHOME/examples/zeitrio/boewrt.new.dat<br />
+|beispieldatei=klassisch: $PROGHOME/examples/zeitrio/boewrt.new.dat und $PROGHOME/examples/zeitrio/boewrt.dat<br/>
-$PROGHOME/examples/zeitrio/boewrt.dat
+neu: $PROGHOME/examples/dataconvert/boewrt.optionalheader.dat und $PROGHOME/examples/dataconvert/boewrt.linecomments.dat<br/>
 }}