Actions

NC2TABLE.DAT

From BAWiki

Revision as of 14:04, 4 July 2017 by imported>Lang Guenther (Version mit deutschem Text)

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
    1. ASCII_Output_Format: Format der Ergebnisdatei(en)
      1. csv : nc2table.csv, Ergebnisse im CSV-Format
    2. Max_Read_Storage: Maximale Anzahl der vom Programm in einem READ-Zyklus gespiecherten Datenwerte.
    3. (optional) Create_Missing_Variables: Automatische Erzeugung fehlender Variablen, z. B. für D-Flow FM Ergebnisse.
      1. 0 : Es wird nicht versucht, zusätzliche Variablen zu erzeugen (Default);
      2. 1 : Es wird versucht, zusätzliche Variablen aus den vorhandenen Variablen abzuleiten.
    4. (optional) Fortran_Format: Fortran-Format, z. B. F10.3.
      1. Falls dieser Key angegeben wird, wird dieser als Default-Wert für alle auszugebenden Variablen benutzt.
      2. Falls dieser Key nicht angegeben wird, so wird der programmintern eingestellte Wert G15.8 benutzt.
      3. Es dürfen nur in nc2table_dico.dat mit FixValue zugelassene Formate verwendet werden.
    5. (optional) Min_Water_Depth: Minimale Wasserbedeckung in [m], bis zu der Daten als gültig betrachtet werden.
      1. Falls dieser Key angegeben wird, wird dieser als Default-Wert für alle auszugebenden Variablen benutzt.
      2. Falls dieser Key nicht angegeben wird, so wird der programmintern eingestellte Wert 0.0 benutzt.
      3. Funktioniert nur, falls den Variablen die Hilfsvariable Gesamtwassertiefe zugeordnet ist.
    6. (optional) NOBS_Filter: Bezeichnung des Filtertyps und des Filterwerts.
      1. Filtertypen:
        1. EQ : Darstellung nur an Positionen, an denen die Anzahl der zur Berechnung benutzten Eingangsdaten genau einem bestimmten Wert entspricht.
        2. LE : Darstellung nur an Positionen, an denen die Anzahl der zur Berechnung benutzten Eingangsdaten kleiner oder gleich einem bestimmten Wert ist.
        3. GE : Darstellung nur an Positionen, an denen die Anzahl der zur Berechnung benutzten Eingangsdaten groeßer oder gleich einem bestimmten Wert ist.
      2. Filterwert:
        1. N : 0 := maximale Anzahl; N := Anzahl N; -M := maximale Anzahl minus M.
      3. Falls dieser Key' angegeben wird, wird dieser als Default-Wert für alle auszugebenden Variablen benutzt.
      4. Falls dieser Key nicht angegeben wird, so wird der programmintern eingestellte Wert "kein Filter" benutzt.
      5. Funktioniert nur, falls einer Variablen eine Hilfsvariable Anzahl der Ereignisse zugeordnet ist.
    7. (optional) Undefined_String
      1. Falls dieser Key angegeben wird, wird dieser als Default-Wert für alle auszugebenden Variablen benutzt.
      2. Falls dieser Key nicht angegeben wird, so wird der programmintern eingestellte Wert--undefined- benutzt.
    8. (optional) Date_Time_Format: String zur Beschreibung des Ausgabeformats für Datum und Uhrzeit.
      1. Falls dieser Key nicht angegeben wird, so wird der programmintern eingestellte Wert ISO8601 (siehe ISO 8601 )benutzt.
      2. 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)
    1. Name: Kurzbezeichnung
      1. Frei wählbare Bezeichnung, mit dem die Variable später angesprochen werden kann.
      2. Werden mehrere IVI-Blöcke angegeben, so muss der Name ein-eindeutig sein.
      3. Bei Extraktionen mit mehreren IVIs je Tabelle wird dieser Wert zur Bezeichnung der Spalte/Zeile verwendet.
    2. File: Dateiname und Dateityp
      1. Name der Datei mit den zu extrahierenden Daten, Typ cf-netcdf.nc.
      2. Typ der Datei NETCDF.
    3. Variable: Name der in der Datei abgelegten Variable. Muss in File enthalten sein.
    4. (optional) Fortran_Format: Fortran-Format.
      1. Übersteuert den programminternen Default-Wert oder den in Block Program_Parameters angegebenen Wert. Siehe Block Program_Parameters.
    5. (optional) Display_Unit: Einheit, in welcher die Variable in die Tabelle extrahiert werden soll.
      1. Muss in $PROGHOME/cfg/phydef.cfg.si.dat bekannt sein.
      2. Derzeit wird nur eine Umrechnung unter Beibehaltung der SI-Basis unterstuetzt, z. B. von m nach cm.
      3. Fehlt dieser Key, so wird die Variable in ihrer originalen Einheit extrahiert.
    6. Min_Water_Depth: Minimale Wasserbedeckung in [m], bis zu der Daten als gültig betrachtet werden.
      1. Übersteuert den programminternen Default-Wert oder den in Block Program_Parameters angegebenen Wert.Siehe Block Program_Parameters.
    7. (optional) NOBS_Filter: Bezeichnung des Filtertyps und des Filterwerts.
      1. Ü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)
    1. Name: Kurzbezeichnung
      1. Frei wählbare Bezeichnung, mit der die Dimension später angesprochen werden kann.
      2. Werden mehrere CSI-Blöcke angegeben, so muss der Name ein-eindeutig sein.
    2. Dim_Name: Name der Dimension
      1. Muss eine gültige Dimension aus den in den in IVI-Blöcken referenzierten Dateien sein.
      2. Für alle in IVI-Bloecken benutzten Variablen sollten möglichst alle Dimensionen in CSI-Bloecken spezifiziert werden.
      3. 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.
    3. Dim_Space: Wertebereich
      1. : : alle Werte (in dieser Koordinaten-Richtung).
      2. <startindex>:<endindex>:<schrittweite> : äquidistante Auswahl.
      3. indices=<index1>,<index2>,<index3>,...,<indexN> : Liste
  • Block Table_Design_Info (TDI): Grundsätzlicher Aufbau der Tabelle (kann mehrfach angegeben werden).
    1. Name: Kurzbezeichnung.
      1. Frei wählbare Bezeichnung, mit dem das Table-Design später angesprochen werden kann.
      2. Werden mehrere TDI-Blöcke angegeben, so muss der Name eineindeutig sein.
    2. First_Column_IVI: Gültiger Name aus Block Input_Variable_Info.
      1. Wird zur Gestaltung der ersten Spalte einer Tabelle ausgewertet. Hinweis: Die erste Spalte enthält typischer Weise Informationen zu den Koordinaten in dieser Richtung.
    3. First_Row_IVI: Gültiger Name aus Block Input_Variable_Info.
      1. Wird zur Gestaltung der ersten Zeile einer Tabelle ausgewertet. Hinweis: Die erste Zeile enthält typischer Weise Informationen zu den Koordinaten in dieser Richtung.
    4. (optional) Row_CSI: Gültiger Name aus Block Coordinate_Space_Info
      1. Bezeichnet die Koordinate (Dimension) für die Zeilen der Tabelle.
    5. (optional) Column_CSI: Gültiger Name aus Block Coordinate_Space_Info
      1. Bezeichnet die Koordinate (Dimension) für die Spalten der Tabelle.
      2. Die Column_CSI darf nicht mehr als 34 Werte (= Spalten) aufweisen.
    6. (optional) Other_CSI: Gültiger Name aus Block Coordinate_Space_Info
      1. Es können mehrere CSI angegeben werden.
      2. Damit wird der Wertebereich der anderen Koordinaten (Dimensionen) festgelegt.
      3. Die Anzahl der erzeugten Tabellen entspricht typischer Weise dem Produkt der in den Other_CSI enthaltenen Schritte.
    7. Hinweise zu Row_CSI und Column_CSI
      1. 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.
      2. 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.
      3. 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).
    1. Name: Kurzbezeichnung.
      1. Frei wählbare Bezeichnung, mit welchem der Table-Contents verbunden wird.
      2. Die für diese Tabelle(n) erzeugte(n) Datei(en) lauten auf
        <tci:name>_<nnnnnn>.csv (Daten)
        <tci_name>_<nnnnnn>.txt (Metadaten)
      3. Werden mehrere TCI-Blöcke angegeben, so muss der Name ein-eindeutig sein.
      4. Namensgleiche Dateien dürfen nicht in dem Verzeichnis vorhanden sein! Vorher unbedingt verschieben oder löschen!
    2. TDI: Gültiger "Name" aus Block Table_Design_Info
      1. Wird zur Gestaltung der Tabelle ausgewertet.
    3. IVI: Gültiger Name aus Block Input_Variable_Info.
      1. Beschreibt die für die Tabelle benutzten Daten.
      2. Kann mehrfach angegeben werden. In diesem Fall dürfen bei TDI nur Row_CSI oder Column_CSI angegeben werden.

General Remarks

  1. Dictionary file used from directory $PROGHOME/dic/:
    • nc2table_dico.dat.

Programs using this Type of File

NC2TABLE

Example-File

$PROGHOME/examples/nc2table/nc2table.dat


back to: File Descriptions


Overview