NC2TABLE.DAT: Difference between revisions
From BAWiki
imported>Lang Guenther (first version (text not upt to date yet)) |
imported>Lang Guenther (Version mit deutschem Text) |
||
Line 8: | Line 8: | ||
'''steering data''' | '''steering data''' | ||
* Block '''Program_Parameters''': | * Block '''Program_Parameters''': Allgemeine Steuerdaten | ||
*# ''' | *# '''ASCII_Output_Format''': Format der Ergebnisdatei(en) | ||
*# ''' | *## ''csv'' : [[NC2TABLE.CSV|nc2table.csv]], Ergebnisse im [https://de.wikipedia.org/wiki/CSV_(Dateiformat) CSV-Format] | ||
*# ''' | *# '''Max_Read_Storage''': Maximale Anzahl der vom Programm in einem READ-Zyklus gespiecherten Datenwerte. | ||
*# ''' | *# (optional) '''Create_Missing_Variables''': Automatische Erzeugung fehlender Variablen, z. B. für D-Flow FM Ergebnisse. | ||
*# (optional) ''' | *## ''0'' : Es wird nicht versucht, zusätzliche Variablen zu erzeugen (Default); | ||
*# (optional) ''' | *## ''1'' : Es wird versucht, zusätzliche Variablen aus den vorhandenen Variablen abzuleiten. | ||
*# ( | *# (optional) '''Fortran_Format''': Fortran-Format, z. B. '''F10.3'''. | ||
*#: | *## Falls dieser ''Key'' angegeben wird, wird dieser als Default-Wert für alle auszugebenden Variablen benutzt. | ||
*#: | *## Falls dieser ''Key'' nicht angegeben wird, so wird der programmintern eingestellte Wert '''G15.8''' benutzt. | ||
*# ( | *## Es dürfen nur in nc2table_dico.dat mit FixValue zugelassene Formate verwendet werden. | ||
*# (optional) ''' | *# (optional) '''Min_Water_Depth''': Minimale Wasserbedeckung in [m], bis zu der Daten als gültig betrachtet werden. | ||
*# (optional) ''' | *## Falls dieser ''Key'' angegeben wird, wird dieser als Default-Wert für alle auszugebenden Variablen benutzt. | ||
* | *## Falls dieser ''Key'' nicht angegeben wird, so wird der programmintern eingestellte Wert 0.0 benutzt. | ||
*# ''' | *## Funktioniert nur, falls den Variablen die Hilfsvariable ''Gesamtwassertiefe'' zugeordnet ist. | ||
* (optional) Block ''' | *# (optional) '''NOBS_Filter''': Bezeichnung des ''Filtertyps'' und des ''Filterwerts''. | ||
*# ''' | *## ''Filtertypen'': | ||
* ( | *### ''EQ'' : Darstellung nur an Positionen, an denen die Anzahl der zur Berechnung benutzten Eingangsdaten genau einem bestimmten Wert entspricht. | ||
*# ''' | *### ''LE'' : Darstellung nur an Positionen, an denen die Anzahl der zur Berechnung benutzten Eingangsdaten kleiner oder gleich einem bestimmten Wert ist. | ||
*# ''' | *### ''GE'' : Darstellung nur an Positionen, an denen die Anzahl der zur Berechnung benutzten Eingangsdaten groeßer oder gleich einem bestimmten Wert ist. | ||
*## ''Filterwert'': | |||
*### ''N'' : 0 := maximale Anzahl; N := Anzahl N; -M := maximale Anzahl minus M. | |||
*## Falls dieser ''Key' angegeben wird, wird dieser als Default-Wert für alle auszugebenden Variablen benutzt. | |||
*## Falls dieser ''Key'' nicht angegeben wird, so wird der programmintern eingestellte Wert "kein Filter" benutzt. | |||
*## Funktioniert nur, falls einer Variablen eine Hilfsvariable ''Anzahl der Ereignisse'' zugeordnet ist. | |||
*# (optional) '''Undefined_String''' | |||
*## Falls dieser ''Key'' angegeben wird, wird dieser als Default-Wert für alle auszugebenden Variablen benutzt. | |||
*## Falls dieser ''Key'' nicht angegeben wird, so wird der programmintern eingestellte Wert''--undefined-'' benutzt. | |||
*# (optional) '''Date_Time_Format''': String zur Beschreibung des Ausgabeformats für Datum und Uhrzeit. | |||
*## Falls dieser ''Key'' nicht angegeben wird, so wird der programmintern eingestellte Wert ISO8601 (siehe [https://de.wikipedia.org/wiki/ISO_8601 ISO 8601] )benutzt. | |||
*## Falls dieser ''Key'' angegeben wird, so darf er sich aus folgenden Komponenten zusammensetzen | |||
*##: ''YYYY'' : Jahr | |||
*##: ''MM'' : Monat | |||
*##: ''DD'' : Tag | |||
*##: ''hh'' : Stunde | |||
*##: ''mm'' : Minute | |||
*##: ''ss'' : Sekunde | |||
*##: n : Sekundenbruchteile, von "n" (1/10 Sek) bis "nnnnnnn" (1/100000000 Sek) | |||
*##: ZZZZ : Zeitzone (als Text) | |||
*##: zzzz : Zeitzone als ganze Zahl (INTEGER) | |||
*##: Des weiteren die Zeichen ".", ":", "-" oder " ". | |||
*##: Beispiele: YYYY-MM-DD hh:mm:ss ; YYYY-MM-DD hh:mm:ss.nnn ZZZZ. | |||
* Block '''Input_Variable_Info''' (IVI): Informationen zu Variablen (kann mehrfach angegeben werden) | |||
*# '''Name''': Kurzbezeichnung | |||
*## Frei wählbare Bezeichnung, mit dem die Variable später ''angesprochen'' werden kann. | |||
*## Werden mehrere IVI-Blöcke angegeben, so muss der Name ein-eindeutig sein. | |||
*## Bei Extraktionen mit mehreren IVIs je Tabelle wird dieser Wert zur Bezeichnung der Spalte/Zeile verwendet. | |||
*# '''File''': Dateiname und Dateityp | |||
*## Name der Datei mit den zu extrahierenden Daten, Typ [[CF-NETCDF.NC|cf-netcdf.nc]]. | |||
*## Typ der Datei ''NETCDF''. | |||
*# '''Variable''': Name der in der Datei abgelegten Variable. Muss in '''File''' enthalten sein. | |||
*# (optional) '''Fortran_Format''': Fortran-Format. | |||
*## Übersteuert den programminternen Default-Wert oder den in Block '''Program_Parameters''' angegebenen Wert. Siehe Block '''Program_Parameters'''. | |||
*# (optional) '''Display_Unit''': Einheit, in welcher die Variable in die Tabelle extrahiert werden soll. | |||
*## Muss in $PROGHOME/cfg/phydef.cfg.si.dat bekannt sein. | |||
*## Derzeit wird ''nur'' eine Umrechnung unter Beibehaltung der SI-Basis unterstuetzt, z. B. von ''m'' nach ''cm''. | |||
*## Fehlt dieser ''Key'', so wird die Variable in ihrer originalen Einheit extrahiert. | |||
*# '''Min_Water_Depth''': Minimale Wasserbedeckung in [m], bis zu der Daten als gültig betrachtet werden. | |||
*## Übersteuert den programminternen Default-Wert oder den in Block '''Program_Parameters''' angegebenen Wert.Siehe Block '''Program_Parameters'''. | |||
*# (optional) '''NOBS_Filter''': Bezeichnung des ''Filtertyps'' und des ''Filterwerts''. | |||
*## Übersteuert den programminternen Default-Wert oder den in Block '''Program_Parameters''' angegebenen Wert. Siehe Block '''Program_Parameters'''. | |||
* Block '''Coordinate_Space_Info''' (CSI): Angaben zu Dimensionen (kann mehrfach angegeben werden) | |||
*# '''Name''': Kurzbezeichnung | |||
*## Frei wählbare Bezeichnung, mit der die Dimension später ''angesprochen'' werden kann. | |||
*## Werden mehrere CSI-Blöcke angegeben, so muss der Name ein-eindeutig sein. | |||
*# '''Dim_Name''': Name der Dimension | |||
*## Muss eine gültige Dimension aus den in den in IVI-Blöcken referenzierten Dateien sein. | |||
*## Für alle in IVI-Bloecken benutzten Variablen sollten möglichst alle Dimensionen in CSI-Bloecken spezifiziert werden. | |||
*## Nicht näher spezifizierte, aber in Gebrauch befindliche Dimensionen, werden mit vollem Wertebereich berücksichtigt. Dies kann zu einer sehr großen Zahl extrahierter Tabellen führen. | |||
*# '''Dim_Space''': Wertebereich | |||
*## '':'' : alle Werte (in dieser Koordinaten-Richtung). | |||
*## ''<startindex>:<endindex>:<schrittweite>'' : äquidistante Auswahl. | |||
*## ''indices=<index1>,<index2>,<index3>,...,<indexN>'' : Liste | |||
* Block '''Table_Design_Info''' (TDI): Grundsätzlicher Aufbau der Tabelle (kann mehrfach angegeben werden). | |||
*# ''Name'': Kurzbezeichnung. | |||
*## Frei wählbare Bezeichnung, mit dem das Table-Design später ''angesprochen'' werden kann. | |||
*## Werden mehrere TDI-Blöcke angegeben, so muss der Name eineindeutig sein. | |||
*# '''First_Column_IVI''': Gültiger ''Name'' aus Block '''Input_Variable_Info'''. | |||
*## Wird zur ''Gestaltung'' der ersten ''Spalte'' einer Tabelle ausgewertet. Hinweis: Die erste Spalte enthält typischer Weise Informationen zu den Koordinaten in dieser Richtung. | |||
*# '''First_Row_IVI''': Gültiger ''Name'' aus Block '''Input_Variable_Info'''. | |||
*## Wird zur ''Gestaltung'' der ersten ''Zeile'' einer Tabelle ausgewertet. Hinweis: Die erste Zeile enthält typischer Weise Informationen zu den Koordinaten in dieser Richtung. | |||
*# (optional) '''Row_CSI''': Gültiger ''Name'' aus Block '''Coordinate_Space_Info''' | |||
*## Bezeichnet die Koordinate (Dimension) für die ''Zeilen'' der Tabelle. | |||
*# (optional) '''Column_CSI''': Gültiger ''Name'' aus Block '''Coordinate_Space_Info''' | |||
*## Bezeichnet die Koordinate (Dimension) für die ''Spalten'' der Tabelle. | |||
*## Die ''Column_CSI'' darf nicht mehr als 34 Werte (= Spalten) aufweisen. | |||
*# (optional) '''Other_CSI''': Gültiger ''Name'' aus Block '''Coordinate_Space_Info''' | |||
*## Es können mehrere CSI angegeben werden. | |||
*## Damit wird der Wertebereich der anderen Koordinaten (Dimensionen) festgelegt. | |||
*## Die Anzahl der erzeugten Tabellen entspricht typischer Weise dem Produkt der in den Other_CSI enthaltenen Schritte. | |||
*# '''Hinweise''' zu ''Row_CSI'' und ''Column_CSI'' | |||
*## Falls in dem Block '''Table_Contents_Info''' eine Tabelle nur aus ''einer'' IVI aufgebaut wird, müssen beide Dimensionen, also ''Column_CSI'' '''und''' ''Row_CSI'' spezifiziert werden. | |||
*## Falls in dem Block '''Table_Contents_Info''' eine Tabelle aus ''mehreren'' IVI aufgebaut wird, darf nur eine der Dimensionen, also ''Column_CSI'' '''oder''' ''Row_CSI'' spezifiziert werden. | |||
*## Große Dimensionen, z. B. Anzahl der Termine in einer Zeitserie, können nur als ''Row_CSI'' verarbeitet werden, da die Anzahl der Spalten begrenzt ist. | |||
* Block '''Table_Contents_Info''' (TCI): Aufbau und Inhalt einer (Serie von) Tabelle(n) (kann mehrfach angegeben werden). | |||
*# '''Name''': Kurzbezeichnung. | |||
*## Frei wählbare Bezeichnung, mit welchem der ''Table-Contents'' verbunden wird. | |||
*## Die für diese Tabelle(n) erzeugte(n) Datei(en) lauten auf | |||
*##: ''<tci:name>_<nnnnnn>.csv'' (Daten) | |||
*##: ''<tci_name>_<nnnnnn>.txt'' (Metadaten) | |||
*## Werden mehrere TCI-Blöcke angegeben, so muss der Name ein-eindeutig sein. | |||
*## Namensgleiche Dateien dürfen nicht in dem Verzeichnis vorhanden sein! Vorher unbedingt verschieben oder löschen! | |||
*# '''TDI''': Gültiger "Name" aus Block '''Table_Design_Info''' | |||
*## Wird zur ''Gestaltung'' der Tabelle ausgewertet. | |||
*# '''IVI''': Gültiger ''Name'' aus Block '''Input_Variable_Info'''. | |||
*## Beschreibt die für die Tabelle benutzten Daten. | |||
*## Kann mehrfach angegeben werden. In diesem Fall dürfen bei ''TDI'' nur ''Row_CSI'' '''oder''' ''Column_CSI'' angegeben werden. | |||
===General Remarks=== | ===General Remarks=== | ||
# Dictionary file used from directory '''''$PROGHOME/dic/''''': | # Dictionary file used from directory '''''$PROGHOME/dic/''''': |
Revision as of 14:04, 4 July 2017
Basic Information
File-Type
nc2table.dat
File-Form
FORMATTED
Version
July 2017
Description-Date
July 2016
Significance of the File
contains general steering data for the program NC2TABLE.
File-Contents (in Catchwords)
steering data
- Block Program_Parameters: Allgemeine Steuerdaten
- ASCII_Output_Format: Format der Ergebnisdatei(en)
- csv : nc2table.csv, Ergebnisse im CSV-Format
- Max_Read_Storage: Maximale Anzahl der vom Programm in einem READ-Zyklus gespiecherten Datenwerte.
- (optional) Create_Missing_Variables: Automatische Erzeugung fehlender Variablen, z. B. für D-Flow FM Ergebnisse.
- 0 : Es wird nicht versucht, zusätzliche Variablen zu erzeugen (Default);
- 1 : Es wird versucht, zusätzliche Variablen aus den vorhandenen Variablen abzuleiten.
- (optional) Fortran_Format: Fortran-Format, z. B. F10.3.
- Falls dieser Key angegeben wird, wird dieser als Default-Wert für alle auszugebenden Variablen benutzt.
- Falls dieser Key nicht angegeben wird, so wird der programmintern eingestellte Wert G15.8 benutzt.
- Es dürfen nur in nc2table_dico.dat mit FixValue zugelassene Formate verwendet werden.
- (optional) Min_Water_Depth: Minimale Wasserbedeckung in [m], bis zu der Daten als gültig betrachtet werden.
- Falls dieser Key angegeben wird, wird dieser als Default-Wert für alle auszugebenden Variablen benutzt.
- Falls dieser Key nicht angegeben wird, so wird der programmintern eingestellte Wert 0.0 benutzt.
- Funktioniert nur, falls den Variablen die Hilfsvariable Gesamtwassertiefe zugeordnet ist.
- (optional) NOBS_Filter: Bezeichnung des Filtertyps und des Filterwerts.
- Filtertypen:
- EQ : Darstellung nur an Positionen, an denen die Anzahl der zur Berechnung benutzten Eingangsdaten genau einem bestimmten Wert entspricht.
- LE : Darstellung nur an Positionen, an denen die Anzahl der zur Berechnung benutzten Eingangsdaten kleiner oder gleich einem bestimmten Wert ist.
- GE : Darstellung nur an Positionen, an denen die Anzahl der zur Berechnung benutzten Eingangsdaten groeßer oder gleich einem bestimmten Wert ist.
- Filterwert:
- N : 0 := maximale Anzahl; N := Anzahl N; -M := maximale Anzahl minus M.
- Falls dieser Key' angegeben wird, wird dieser als Default-Wert für alle auszugebenden Variablen benutzt.
- Falls dieser Key nicht angegeben wird, so wird der programmintern eingestellte Wert "kein Filter" benutzt.
- Funktioniert nur, falls einer Variablen eine Hilfsvariable Anzahl der Ereignisse zugeordnet ist.
- Filtertypen:
- (optional) Undefined_String
- Falls dieser Key angegeben wird, wird dieser als Default-Wert für alle auszugebenden Variablen benutzt.
- Falls dieser Key nicht angegeben wird, so wird der programmintern eingestellte Wert--undefined- benutzt.
- (optional) Date_Time_Format: String zur Beschreibung des Ausgabeformats für Datum und Uhrzeit.
- Falls dieser Key nicht angegeben wird, so wird der programmintern eingestellte Wert ISO8601 (siehe ISO 8601 )benutzt.
- Falls dieser Key angegeben wird, so darf er sich aus folgenden Komponenten zusammensetzen
- YYYY : Jahr
- MM : Monat
- DD : Tag
- hh : Stunde
- mm : Minute
- ss : Sekunde
- n : Sekundenbruchteile, von "n" (1/10 Sek) bis "nnnnnnn" (1/100000000 Sek)
- ZZZZ : Zeitzone (als Text)
- zzzz : Zeitzone als ganze Zahl (INTEGER)
- Des weiteren die Zeichen ".", ":", "-" oder " ".
- Beispiele: YYYY-MM-DD hh:mm:ss ; YYYY-MM-DD hh:mm:ss.nnn ZZZZ.
- ASCII_Output_Format: Format der Ergebnisdatei(en)
- Block Input_Variable_Info (IVI): Informationen zu Variablen (kann mehrfach angegeben werden)
- Name: Kurzbezeichnung
- Frei wählbare Bezeichnung, mit dem die Variable später angesprochen werden kann.
- Werden mehrere IVI-Blöcke angegeben, so muss der Name ein-eindeutig sein.
- Bei Extraktionen mit mehreren IVIs je Tabelle wird dieser Wert zur Bezeichnung der Spalte/Zeile verwendet.
- File: Dateiname und Dateityp
- Name der Datei mit den zu extrahierenden Daten, Typ cf-netcdf.nc.
- Typ der Datei NETCDF.
- Variable: Name der in der Datei abgelegten Variable. Muss in File enthalten sein.
- (optional) Fortran_Format: Fortran-Format.
- Übersteuert den programminternen Default-Wert oder den in Block Program_Parameters angegebenen Wert. Siehe Block Program_Parameters.
- (optional) Display_Unit: Einheit, in welcher die Variable in die Tabelle extrahiert werden soll.
- Muss in $PROGHOME/cfg/phydef.cfg.si.dat bekannt sein.
- Derzeit wird nur eine Umrechnung unter Beibehaltung der SI-Basis unterstuetzt, z. B. von m nach cm.
- Fehlt dieser Key, so wird die Variable in ihrer originalen Einheit extrahiert.
- Min_Water_Depth: Minimale Wasserbedeckung in [m], bis zu der Daten als gültig betrachtet werden.
- Übersteuert den programminternen Default-Wert oder den in Block Program_Parameters angegebenen Wert.Siehe Block Program_Parameters.
- (optional) NOBS_Filter: Bezeichnung des Filtertyps und des Filterwerts.
- Übersteuert den programminternen Default-Wert oder den in Block Program_Parameters angegebenen Wert. Siehe Block Program_Parameters.
- Name: Kurzbezeichnung
- Block Coordinate_Space_Info (CSI): Angaben zu Dimensionen (kann mehrfach angegeben werden)
- Name: Kurzbezeichnung
- Frei wählbare Bezeichnung, mit der die Dimension später angesprochen werden kann.
- Werden mehrere CSI-Blöcke angegeben, so muss der Name ein-eindeutig sein.
- Dim_Name: Name der Dimension
- Muss eine gültige Dimension aus den in den in IVI-Blöcken referenzierten Dateien sein.
- Für alle in IVI-Bloecken benutzten Variablen sollten möglichst alle Dimensionen in CSI-Bloecken spezifiziert werden.
- Nicht näher spezifizierte, aber in Gebrauch befindliche Dimensionen, werden mit vollem Wertebereich berücksichtigt. Dies kann zu einer sehr großen Zahl extrahierter Tabellen führen.
- Dim_Space: Wertebereich
- : : alle Werte (in dieser Koordinaten-Richtung).
- <startindex>:<endindex>:<schrittweite> : äquidistante Auswahl.
- indices=<index1>,<index2>,<index3>,...,<indexN> : Liste
- Name: Kurzbezeichnung
- Block Table_Design_Info (TDI): Grundsätzlicher Aufbau der Tabelle (kann mehrfach angegeben werden).
- Name: Kurzbezeichnung.
- Frei wählbare Bezeichnung, mit dem das Table-Design später angesprochen werden kann.
- Werden mehrere TDI-Blöcke angegeben, so muss der Name eineindeutig sein.
- First_Column_IVI: Gültiger Name aus Block Input_Variable_Info.
- Wird zur Gestaltung der ersten Spalte einer Tabelle ausgewertet. Hinweis: Die erste Spalte enthält typischer Weise Informationen zu den Koordinaten in dieser Richtung.
- First_Row_IVI: Gültiger Name aus Block Input_Variable_Info.
- Wird zur Gestaltung der ersten Zeile einer Tabelle ausgewertet. Hinweis: Die erste Zeile enthält typischer Weise Informationen zu den Koordinaten in dieser Richtung.
- (optional) Row_CSI: Gültiger Name aus Block Coordinate_Space_Info
- Bezeichnet die Koordinate (Dimension) für die Zeilen der Tabelle.
- (optional) Column_CSI: Gültiger Name aus Block Coordinate_Space_Info
- Bezeichnet die Koordinate (Dimension) für die Spalten der Tabelle.
- Die Column_CSI darf nicht mehr als 34 Werte (= Spalten) aufweisen.
- (optional) Other_CSI: Gültiger Name aus Block Coordinate_Space_Info
- Es können mehrere CSI angegeben werden.
- Damit wird der Wertebereich der anderen Koordinaten (Dimensionen) festgelegt.
- Die Anzahl der erzeugten Tabellen entspricht typischer Weise dem Produkt der in den Other_CSI enthaltenen Schritte.
- Hinweise zu Row_CSI und Column_CSI
- Falls in dem Block Table_Contents_Info eine Tabelle nur aus einer IVI aufgebaut wird, müssen beide Dimensionen, also Column_CSI und Row_CSI spezifiziert werden.
- Falls in dem Block Table_Contents_Info eine Tabelle aus mehreren IVI aufgebaut wird, darf nur eine der Dimensionen, also Column_CSI oder Row_CSI spezifiziert werden.
- Große Dimensionen, z. B. Anzahl der Termine in einer Zeitserie, können nur als Row_CSI verarbeitet werden, da die Anzahl der Spalten begrenzt ist.
- Name: Kurzbezeichnung.
- Block Table_Contents_Info (TCI): Aufbau und Inhalt einer (Serie von) Tabelle(n) (kann mehrfach angegeben werden).
- Name: Kurzbezeichnung.
- Frei wählbare Bezeichnung, mit welchem der Table-Contents verbunden wird.
- Die für diese Tabelle(n) erzeugte(n) Datei(en) lauten auf
- <tci:name>_<nnnnnn>.csv (Daten)
- <tci_name>_<nnnnnn>.txt (Metadaten)
- Werden mehrere TCI-Blöcke angegeben, so muss der Name ein-eindeutig sein.
- Namensgleiche Dateien dürfen nicht in dem Verzeichnis vorhanden sein! Vorher unbedingt verschieben oder löschen!
- TDI: Gültiger "Name" aus Block Table_Design_Info
- Wird zur Gestaltung der Tabelle ausgewertet.
- IVI: Gültiger Name aus Block Input_Variable_Info.
- Beschreibt die für die Tabelle benutzten Daten.
- Kann mehrfach angegeben werden. In diesem Fall dürfen bei TDI nur Row_CSI oder Column_CSI angegeben werden.
- Name: Kurzbezeichnung.
General Remarks
- Dictionary file used from directory $PROGHOME/dic/:
- nc2table_dico.dat.
Programs using this Type of File
Example-File
$PROGHOME/examples/nc2table/nc2table.dat
back to: File Descriptions