Actions

NC2TABLE.DAT: Difference between revisions

From BAWiki

imported>Lang Guenther
(Version mit deutschem Text)
m (update version)
 
(11 intermediate revisions by one other user not shown)
Line 2: Line 2:
|name_de=NC2TABLE.DAT
|name_de=NC2TABLE.DAT
|filetype=nc2table.dat
|filetype=nc2table.dat
|version=July 2017
|version=October 2024
|version_descr=July 2016
|version_descr=October 2017
|significance=contains general steering data for the program [[NC2TABLE]].
|significance=contains general steering data for the program [[NC2TABLE]].
|filecontents=
|filecontents=
'''steering data'''
'''steering data'''


* Block '''Program_Parameters''': Allgemeine Steuerdaten
* Block '''Program_Parameters''': general steering data
*# '''ASCII_Output_Format''': Format der Ergebnisdatei(en)
*# '''ASCII_Output_Format''': format for output file(s)
*## ''csv'' : [[NC2TABLE.CSV|nc2table.csv]], Ergebnisse im [https://de.wikipedia.org/wiki/CSV_(Dateiformat) CSV-Format]
*## ''csv'' : [[NC2TABLE.CSV|nc2table.csv]], store results in [https://en.wikipedia.org/wiki/Comma-separated_values CSV format]
*# '''Max_Read_Storage''': Maximale Anzahl der vom Programm in einem READ-Zyklus gespiecherten Datenwerte.
*# '''Max_Read_Storage''': maximum number of data values stored in one READ cycle.
*# (optional) '''Create_Missing_Variables''': Automatische Erzeugung fehlender Variablen, z. B. für D-Flow FM Ergebnisse.
*# (optional) '''Create_Missing_Variables''': enable automatic creation of missing variables, e. g. for D-Flow FM result files.
*## ''0'' : Es wird nicht versucht, zusätzliche Variablen zu erzeugen (Default);
*## ''0'' : disabled (Default);
*## ''1'' : Es wird versucht, zusätzliche Variablen aus den vorhandenen Variablen abzuleiten.
*## ''1'' : enabled.
*# (optional) '''Fortran_Format''': Fortran-Format, z. B. '''F10.3'''.
*# (optional) '''Fortran_Format''': Fortran-Format, e.g. '''F10.3'''.
*## Falls dieser ''Key'' angegeben wird, wird dieser als Default-Wert für alle auszugebenden Variablen benutzt.
*## In case this key is specified, this value will be used as default for all output variables.
*## Falls dieser ''Key'' nicht angegeben wird, so wird der programmintern eingestellte Wert '''G15.8''' benutzt.
*## In case this key is not specified, program default '''G15.8''' will be used.
*## Es dürfen nur in nc2table_dico.dat mit FixValue zugelassene Formate verwendet werden.
*## Only valid formats defined in nc2table_dico.dat are allowed to be used.
*# (optional) '''Min_Water_Depth''': Minimale Wasserbedeckung in [m], bis zu der Daten als gültig betrachtet werden.  
*# (optional) '''Min_Water_Depth''': minimum water coverage in [m], up to which data values are considered being valid.  
*## Falls dieser ''Key'' angegeben wird, wird dieser als Default-Wert für alle auszugebenden Variablen benutzt.
*## In case this key is specified, this value will be used as default for all output variables.
*## Falls dieser ''Key'' nicht angegeben wird, so wird der programmintern eingestellte Wert 0.0 benutzt.
*## In case this key is not specified, program default 0.0 will be applied.
*## Funktioniert nur, falls den Variablen die Hilfsvariable ''Gesamtwassertiefe'' zugeordnet ist.
*## Works only for variables which have an auxiliary variable of type ''total water depth''.
*# (optional) '''NOBS_Filter''': Bezeichnung des ''Filtertyps'' und des ''Filterwerts''.
*# (optional) '''NOBS_Filter''': description of ''filter type'' and ''filter value''.
*## ''Filtertypen'':
*## ''filter type'':
*### ''EQ'' : Darstellung nur an Positionen, an denen die Anzahl der zur Berechnung benutzten Eingangsdaten genau einem bestimmten Wert entspricht.
*### ''EQ'' : results will be only shown as long as the number of observations are identical to a prescribed value.
*### ''LE'' : Darstellung nur an Positionen, an denen die Anzahl der zur Berechnung benutzten Eingangsdaten kleiner oder gleich einem bestimmten Wert ist.
*### ''LE'' : results will be only shown when the number of observations is less or equal to a prescribed value.
*### ''GE'' : Darstellung nur an Positionen, an denen die Anzahl der zur Berechnung benutzten Eingangsdaten groeßer oder gleich einem bestimmten Wert ist.
*### ''GE'' : results will be only shown when the number of observations is greater or equal to a prescribed value.
*## ''Filterwert'':                                       
*## ''filter value'':                                       
*### ''N'' : 0 := maximale Anzahl;  N := Anzahl N; -M := maximale Anzahl minus M.
*### ''N'' : 0 := maximum number of observations;  N := number of observations N; -M := maximum number of observations minus M.
*## Falls dieser ''Key' angegeben wird, wird dieser als Default-Wert für alle auszugebenden Variablen benutzt.
*## In case this key is specified, this filter will be used as default for all output variables..
*## Falls dieser ''Key'' nicht angegeben wird, so wird der programmintern eingestellte Wert "kein Filter" benutzt.
*## In case this key is not specified, program default ''no filter'' will be used.
*## Funktioniert nur, falls einer Variablen eine Hilfsvariable ''Anzahl der Ereignisse'' zugeordnet ist.
*## Works only for variables which have an auxiliary variable of type ''number of observations''.
*# (optional) '''Undefined_String'''  
*# (optional) '''Undefined_String'''  
*## Falls dieser ''Key'' angegeben wird, wird dieser als Default-Wert für alle auszugebenden Variablen benutzt.
*## In case this key is specified, this value will be used as default for all output variables.
*## Falls dieser ''Key'' nicht angegeben wird, so wird der programmintern eingestellte Wert''--undefined-'' benutzt.
*## In case this key is not specified, program default ''--undefined-'' will be used.
*# (optional) '''Date_Time_Format''': String zur Beschreibung des Ausgabeformats für Datum und Uhrzeit.
*# (optional) '''Date_Time_Format''': string definition for date and time output format.
*## Falls dieser ''Key'' nicht angegeben wird, so wird der programmintern eingestellte Wert ISO8601 (siehe [https://de.wikipedia.org/wiki/ISO_8601 ISO 8601] )benutzt.
*## In case this key is not specified, program default ISO8601 (see [https://en.wikipedia.org/wiki/ISO_8601 ISO 8601]) will be used.
*## Falls dieser ''Key''  angegeben wird, so darf er sich aus folgenden Komponenten zusammensetzen
*## In case this key is specified, the following components may be used
*##: ''YYYY'' : Jahr
*##: ''YYYY'' : year
*##: ''MM'' : Monat
*##: ''MM'' : month
*##: ''DD'' : Tag
*##: ''DD'' : day
*##: ''hh'' : Stunde
*##: ''hh'' : hour
*##: ''mm'' : Minute
*##: ''mm'' : minute
*##: ''ss'' : Sekunde
*##: ''ss'' : second
*##: n : Sekundenbruchteile, von "n" (1/10 Sek) bis "nnnnnnn" (1/100000000 Sek)
*##: ''n'' : parts of a second, from ''n'' (1/10 sec) to ''nnnnnnn'' (1/100000000 sec)
*##: ZZZZ : Zeitzone (als Text)
*##: ZZZZ : time zone (as text)
*##: zzzz : Zeitzone als ganze Zahl (INTEGER)
*##: zzzz : time zone as integer number
*##: Des weiteren die Zeichen ".", ":", "-" oder " ".
*##: Further characters <nowiki>''.'', '':'', ''-'' or '' ''</nowiki>.
*##: Beispiele: YYYY-MM-DD hh:mm:ss ; YYYY-MM-DD hh:mm:ss.nnn ZZZZ.
*##: examples: 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)
*# (optional) '''Time_Diff_Format''': string definition for time differences output format.
*# '''Name''': Kurzbezeichnung
*## In case this key is not specified, program default ISO8601 (see [https://en.wikipedia.org/wiki/ISO_8601 ISO 8601]) will be used.
*## Frei wählbare Bezeichnung, mit dem die Variable später ''angesprochen'' werden kann.
*## In case this key is specified, the following components may be used
*## Werden mehrere IVI-Blöcke angegeben, so muss der Name ein-eindeutig sein.
*##: ''V'' : sign
*## Bei Extraktionen mit mehreren IVIs je Tabelle wird dieser Wert zur Bezeichnung der Spalte/Zeile verwendet.
*##: ''D'' : day, from ''D'' to ''DDDDDD''
*# '''File''': Dateiname und Dateityp
*##: ''hh'' : hour
*## Name der Datei mit den zu extrahierenden Daten, Typ [[CF-NETCDF.NC|cf-netcdf.nc]].
*##: ''mm'' : minute
*## Typ der Datei ''NETCDF''.
*##: ''ss'' : second
*# '''Variable''': Name der in der Datei abgelegten Variable. Muss in '''File''' enthalten sein.
*##: ''n'' : parts of a second, from ''n'' (1/10 sec) to ''nnnnnnn'' (1/100000000 sec)
*# (optional) '''Fortran_Format''': Fortran-Format.
*##: Further characters <nowiki>''.'', '':'', ''-'' or '' ''</nowiki>.
*## Übersteuert den programminternen Default-Wert oder den in Block '''Program_Parameters''' angegebenen Wert. Siehe Block '''Program_Parameters'''.
*##: examples: Vhh:mm:ss .
*# (optional) '''Display_Unit''': Einheit, in welcher die Variable in die Tabelle extrahiert werden soll.  
*# (optional) '''Hor_Coord_Format''': Output format for (geographical) coordinates.
*## Muss in $PROGHOME/cfg/phydef.cfg.si.dat bekannt sein.
*## Format '''XY''': local coordinates as real numbers.
*## Derzeit wird ''nur'' eine Umrechnung unter Beibehaltung der SI-Basis unterstuetzt, z. B. von ''m'' nach ''cm''.
*## Format '''GEO_LON_LAT''': geographical coordinates as real number (in degree).
*## Fehlt dieser ''Key'', so wird die Variable in ihrer originalen Einheit extrahiert.
*## Format '''GEO_DEGREE''': geographical coordinates in degree, minute, second (and fractions of a second) plus specification of direction '''N''', '''S''', '''E''' or '''W''' (default).
*# '''Min_Water_Depth''': Minimale Wasserbedeckung in [m], bis zu der Daten als gültig betrachtet werden.
*# (optional) '''Table_Datetime_Zone''': time zone used for date and time table data.
*## Übersteuert den programminternen Default-Wert oder den in Block '''Program_Parameters''' angegebenen Wert.Siehe Block '''Program_Parameters'''.
*## '''UTC''' or '''GMT''': [https://en.wikipedia.org/wiki/Coordinated_Universal_Time ''Universal Time Coordinated''] (Default);
*# (optional) '''NOBS_Filter''': Bezeichnung des ''Filtertyps'' und des ''Filterwerts''.
*## '''CET''' or '''MEZ''': [https://www.timeanddate.com/time/zones/cet ''Central European Time''];
*## Übersteuert den programminternen Default-Wert oder den in Block '''Program_Parameters''' angegebenen Wert. Siehe Block '''Program_Parameters'''.
*## '''CEST''' or '''MESZ''': [https://www.timeanddate.com/time/zones/cest ''Central European Summer Time''].
* Block '''Coordinate_Space_Info''' (CSI): Angaben zu Dimensionen (kann mehrfach angegeben werden)
* Block '''Input_Variable_Info''' (IVI): informations about variables (can be specified more than once)
*# '''Name''': Kurzbezeichnung
*# '''Name''': short name.
*## Frei wählbare Bezeichnung, mit der die Dimension später ''angesprochen'' werden kann.
*## In case several IVI blocks are specified, ''Name'' must be unique.
*## Werden mehrere CSI-Blöcke angegeben, so muss der Name ein-eindeutig sein.
*## In case several IVIs are extracted to one table ''Name'' is used as column/row header.
*# '''Dim_Name''': Name der Dimension
*# '''File''': file name and file type
*## Muss eine gültige Dimension aus den in den in IVI-Blöcken referenzierten Dateien sein.
*## name of file from which data shall be extracted, type [[CF-NETCDF.NC|cf-netcdf.nc]].
*## Für alle in IVI-Bloecken benutzten Variablen sollten möglichst alle Dimensionen in CSI-Bloecken spezifiziert werden.
*## file type ''NETCDF''.
*## 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.
*# '''Variable''': name of variable to be extracted. Must be contained in '''File'''.
*# '''Dim_Space''': Wertebereich
*# (optional) '''Fortran_Format''': Fortran format.
*## '':'' : alle Werte (in dieser Koordinaten-Richtung).
*## Overrides program default or value specified in  Block '''Program_Parameters''' . See block '''Program_Parameters'''.
*## ''<startindex>:<endindex>:<schrittweite>'' : äquidistante Auswahl.
*## For variables with time, special format ''TI'' may be specified. In this case '''Date_Time_Format''' will be used for output.
*## ''indices=<index1>,<index2>,<index3>,...,<indexN>'' : Liste
*## For variables with time differences (periods), special format ''DT'' may be specified. In this case '''Time_Diff_Format''' will be used for output.
* Block '''Table_Design_Info''' (TDI): Grundsätzlicher Aufbau der Tabelle (kann mehrfach angegeben werden).
*# (optional) '''Display_Unit''': physical unit to be used during data extraction.
*# ''Name'': Kurzbezeichnung.
*## Must be known in $PROGHOME/cfg/phydef.cfg.si.dat.
*## Frei wählbare Bezeichnung, mit dem das Table-Design später ''angesprochen'' werden kann.
*## Actually transformation is only supported in case the SI base doesn't change, e.g. from ''m'' to ''cm''.
*## Werden mehrere TDI-Blöcke angegeben, so muss der Name eineindeutig sein.
*## In case this key is missing, original variable units are used.
*# '''First_Column_IVI''': Gültiger ''Name'' aus Block '''Input_Variable_Info'''.  
*# '''Min_Water_Depth''': minimum water coverage in [m], up to which data values are considered being valid.  
*## Wird zur ''Gestaltung'' der ersten ''Spalte'' einer Tabelle ausgewertet. Hinweis: Die erste Spalte enthält typischer Weise Informationen zu den Koordinaten in dieser Richtung.
*## Overrides program default or value specified in block '''Program_Parameters'''. See block '''Program_Parameters'''.
*# '''First_Row_IVI''':  Gültiger ''Name'' aus Block '''Input_Variable_Info'''.  
*# (optional) '''NOBS_Filter''': description of ''filter type'' and ''filter value''.
*## Wird zur ''Gestaltung'' der ersten ''Zeile'' einer Tabelle ausgewertet. Hinweis: Die erste Zeile enthält typischer Weise Informationen zu den Koordinaten in dieser Richtung.
*## Overrides program default or value specified in block '''Program_Parameters'''. See block '''Program_Parameters'''.
*# (optional) '''Row_CSI''': Gültiger ''Name'' aus Block '''Coordinate_Space_Info'''
* Block '''Coordinate_Space_Info''' (CSI): informations about coordinate dimensions (can be specified more than once)
*## Bezeichnet die Koordinate (Dimension) für die ''Zeilen'' der Tabelle.
*# '''Name''': short name.
*# (optional) '''Column_CSI''': Gültiger ''Name'' aus Block '''Coordinate_Space_Info'''
*## In case several CSI blocks are specified, ''Name'' must be unique.
*## Bezeichnet die Koordinate (Dimension) für die ''Spalten'' der Tabelle.
*# '''Dim_Name''': name of coordinate dimension.
*## Die ''Column_CSI'' darf nicht mehr als 34 Werte (= Spalten) aufweisen.
*## Must be a valid dimension of variables referenced in IVI blocks.
*# (optional) '''Other_CSI''': Gültiger ''Name'' aus Block '''Coordinate_Space_Info'''
*## For all the variables listed in IVI blocks all of their used dimensions should be specified in CSI blocks.
*## Es können mehrere CSI angegeben werden.
*## Dimensions not specified but in use are considered being used with full dimension. This can result in a rather large number of tables to be extracted.
*## Damit wird der Wertebereich der anderen Koordinaten (Dimensionen) festgelegt.
*# '''Dim_Space''': range of (coordinate) values (four different options)
*## Die Anzahl der erzeugten Tabellen entspricht typischer Weise dem Produkt der in den Other_CSI enthaltenen Schritte.
*## '':'' : all values.
*# '''Hinweise''' zu ''Row_CSI'' und ''Column_CSI''
*## ''<startindex>:<endindex>:<schrittweite>'' : equidistant selection.
*## 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.
*## ''indices=<index1>,<index2>,<index3>,...,<indexN>'' : list of individual coordinate values.
*## 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.
*## ''names=<name1>,<name2>,<name3>,...,<nameN>'' : list of names. Must be defined in a respective label coordinate variable.
*## 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.
*## ''xy=(<x1>,<y1>),(<x2>,<y2>),(<x3>,<y3>),...,(<xN>,<yN>)'': list of coordinate value pairs (local coordinates). The respective dimension must be part of a coordinate variable. Remark: In case the coordinate variable has more than one horizontal space dimension, for all of these dimensions the very same coordinate value pairs have to be specified.
* Block '''Table_Contents_Info''' (TCI): Aufbau und Inhalt einer (Serie von) Tabelle(n) (kann mehrfach angegeben werden).
*## ''geo=(<lon1>,<lat1>),(<lon2>,<lat2>),(<lon3>,<lat3>),...,(<lonN>,<latN>)'': list of coordinate value pairs (geographic coordinates). The respective dimension must be part of a coordinate variable. Remark: In case the coordinate variable has more than one horizontal space dimension, for all of these dimensions the very same coordinate value pairs have to be specified.
*# '''Name''': Kurzbezeichnung.
*## ''file=<[[CF-NETCDF.NC|cf-netcdf.nc]]>,NETCDF,<x_or_lon>,<y_or_lat>'': file name, file type (currently NETCDF only) as well as variable for x coordinate or geographic longitude and y coordinate or geographic latitude. Potential input files can be generated using program [[GRIDCONVERT]]. Remark: In case the coordinate variable has more than one horizontal space dimension, for all of these dimensions the very same input data have to be specified.
*## Frei wählbare Bezeichnung, mit welchem der ''Table-Contents'' verbunden wird.
*# '''Dim_EPSG''': (optional) EPSG code (see [https://www.epsg-registry.org/ EPSG Geodetic Parameter Registry]) for local coordinates prescribed in Dim_Space.  If not present it is assumed that coordinates in Dim_Space are given in the same coordinate system as those specified in the data file.
*## Die für diese Tabelle(n) erzeugte(n) Datei(en) lauten auf
* Block '''Table_Design_Info''' (TDI): basic design of a table (can be specified more than once).
*##: ''<tci:name>_<nnnnnn>.csv'' (Daten)
*# '''Name''': short name.
*##: ''<tci_name>_<nnnnnn>.txt'' (Metadaten)
*## In case several TDI blocks are specified, ''Name'' must be unique.
*## Werden mehrere TCI-Blöcke angegeben, so muss der Name ein-eindeutig sein.
*# '''First_Column_IVI''': valid ''Name'' from block '''Input_Variable_Info'''.
*## Namensgleiche Dateien dürfen nicht in dem Verzeichnis vorhanden sein! Vorher unbedingt verschieben oder löschen!
*## Will be used to construct the first ''column'' of a table.
*# '''TDI''': Gültiger "Name" aus Block '''Table_Design_Info'''
*# '''First_Row_IVI''':  Valid ''Name'' from block '''Input_Variable_Info'''.
*## Wird zur ''Gestaltung'' der Tabelle ausgewertet.
*## Will be used to construct the first ''row'' of a table.
*# '''IVI''': Gültiger ''Name'' aus Block '''Input_Variable_Info'''.
*# (optional) '''Row_CSI''': Valid ''Name'' from block '''Coordinate_Space_Info'''
*## Beschreibt die für die Tabelle benutzten Daten.
*## Defines the coordinate (dimension) for the ''rows'' of the table.
*## Kann mehrfach angegeben werden. In diesem Fall dürfen bei ''TDI'' nur ''Row_CSI'' '''oder''' ''Column_CSI'' angegeben werden.  
*# (optional) '''Column_CSI''': Valid ''Name'' from block '''Coordinate_Space_Info'''
*## Defines the coordinate (dimension) for the ''columns'' of the table.
*## ''Column_CSI'' may not contain more than 34 values (= columns).
*# (optional) '''Other_CSI''': Valid ''Name'' from block '''Coordinate_Space_Info'''
*## Several CSIs can be specified in one line.
*## Defines the reach of all other dimensions.
*## The number of tables generated is typically equal to the product of the number of entries in the ''other'' coordinates.
*# '''Remarks''' with respect to ''Row_CSI'' and ''Column_CSI''
*## If in a block of type '''Table_Contents_Info''' a table consists out of only ''one'' IVI, both dimensions, ''Column_CSI'' '''and''' ''Row_CSI'' must be specified in the TDI used.
*## If in a block of type '''Table_Contents_Info''' a table consists out of ''multiple'' IVIs, '''either''' ''Column_CSI'' '''or''' ''Row_CSI'' must be specified.
*## Large dimensions, e.g. number of time steps, can only be processed as ''Row_CSI'', because the maximum number of columns is limited.
* Block '''Table_Contents_Info''' (TCI): design and contents for a (series of) table(s) (can be specified more than once).
*# '''Name''': short name.
*## The folowing file(s) is (are) created for this type of table:
*##: ''<tci:name>_<nnnnnn>.csv'' (data)
*##: ''<tci_name>_<nnnnnn>.txt'' (metadata)
*##  In case several TCI blocks are specified, ''Name'' must be unique.
*# '''TDI''': Valid ''Name'' from block '''Table_Design_Info'''
*## Will be used to ''design'' the table.
*# '''IVI''': Valid ''Name'' from block '''Input_Variable_Info'''.
*## Is used to define the ''contents'' of the table.
*## Can be specified more than once. In this case the respective ''TDI'' may contain '''either''' a ''Row_CSI'' '''or''' a ''Column_CSI''.
===General Remarks===
===General Remarks===
# Dictionary file used from directory '''''$PROGHOME/dic/''''':
# Dictionary file used from directory '''''$PROGHOME/dic/''''':

Latest revision as of 15:19, 21 May 2024

Basic Information

File-Type

nc2table.dat

File-Form

FORMATTED

Version

October 2024

Description-Date

October 2017

Significance of the File

contains general steering data for the program NC2TABLE.

File-Contents (in Catchwords)

steering data

  • Block Program_Parameters: general steering data
    1. ASCII_Output_Format: format for output file(s)
      1. csv : nc2table.csv, store results in CSV format
    2. Max_Read_Storage: maximum number of data values stored in one READ cycle.
    3. (optional) Create_Missing_Variables: enable automatic creation of missing variables, e. g. for D-Flow FM result files.
      1. 0 : disabled (Default);
      2. 1 : enabled.
    4. (optional) Fortran_Format: Fortran-Format, e.g. F10.3.
      1. In case this key is specified, this value will be used as default for all output variables.
      2. In case this key is not specified, program default G15.8 will be used.
      3. Only valid formats defined in nc2table_dico.dat are allowed to be used.
    5. (optional) Min_Water_Depth: minimum water coverage in [m], up to which data values are considered being valid.
      1. In case this key is specified, this value will be used as default for all output variables.
      2. In case this key is not specified, program default 0.0 will be applied.
      3. Works only for variables which have an auxiliary variable of type total water depth.
    6. (optional) NOBS_Filter: description of filter type and filter value.
      1. filter type:
        1. EQ : results will be only shown as long as the number of observations are identical to a prescribed value.
        2. LE : results will be only shown when the number of observations is less or equal to a prescribed value.
        3. GE : results will be only shown when the number of observations is greater or equal to a prescribed value.
      2. filter value:
        1. N : 0 := maximum number of observations; N := number of observations N; -M := maximum number of observations minus M.
      3. In case this key is specified, this filter will be used as default for all output variables..
      4. In case this key is not specified, program default no filter will be used.
      5. Works only for variables which have an auxiliary variable of type number of observations.
    7. (optional) Undefined_String
      1. In case this key is specified, this value will be used as default for all output variables.
      2. In case this key is not specified, program default --undefined- will be used.
    8. (optional) Date_Time_Format: string definition for date and time output format.
      1. In case this key is not specified, program default ISO8601 (see ISO 8601) will be used.
      2. In case this key is specified, the following components may be used
        YYYY : year
        MM : month
        DD : day
        hh : hour
        mm : minute
        ss : second
        n : parts of a second, from n (1/10 sec) to nnnnnnn (1/100000000 sec)
        ZZZZ : time zone (as text)
        zzzz : time zone as integer number
        Further characters ''.'', '':'', ''-'' or '' ''.
        examples: YYYY-MM-DD hh:mm:ss ; YYYY-MM-DD hh:mm:ss.nnn ZZZZ.
    9. (optional) Time_Diff_Format: string definition for time differences output format.
      1. In case this key is not specified, program default ISO8601 (see ISO 8601) will be used.
      2. In case this key is specified, the following components may be used
        V : sign
        D : day, from D to DDDDDD
        hh : hour
        mm : minute
        ss : second
        n : parts of a second, from n (1/10 sec) to nnnnnnn (1/100000000 sec)
        Further characters ''.'', '':'', ''-'' or '' ''.
        examples: Vhh:mm:ss .
    10. (optional) Hor_Coord_Format: Output format for (geographical) coordinates.
      1. Format XY: local coordinates as real numbers.
      2. Format GEO_LON_LAT: geographical coordinates as real number (in degree).
      3. Format GEO_DEGREE: geographical coordinates in degree, minute, second (and fractions of a second) plus specification of direction N, S, E or W (default).
    11. (optional) Table_Datetime_Zone: time zone used for date and time table data.
      1. UTC or GMT: Universal Time Coordinated (Default);
      2. CET or MEZ: Central European Time;
      3. CEST or MESZ: Central European Summer Time.
  • Block Input_Variable_Info (IVI): informations about variables (can be specified more than once)
    1. Name: short name.
      1. In case several IVI blocks are specified, Name must be unique.
      2. In case several IVIs are extracted to one table Name is used as column/row header.
    2. File: file name and file type
      1. name of file from which data shall be extracted, type cf-netcdf.nc.
      2. file type NETCDF.
    3. Variable: name of variable to be extracted. Must be contained in File.
    4. (optional) Fortran_Format: Fortran format.
      1. Overrides program default or value specified in Block Program_Parameters . See block Program_Parameters.
      2. For variables with time, special format TI may be specified. In this case Date_Time_Format will be used for output.
      3. For variables with time differences (periods), special format DT may be specified. In this case Time_Diff_Format will be used for output.
    5. (optional) Display_Unit: physical unit to be used during data extraction.
      1. Must be known in $PROGHOME/cfg/phydef.cfg.si.dat.
      2. Actually transformation is only supported in case the SI base doesn't change, e.g. from m to cm.
      3. In case this key is missing, original variable units are used.
    6. Min_Water_Depth: minimum water coverage in [m], up to which data values are considered being valid.
      1. Overrides program default or value specified in block Program_Parameters. See block Program_Parameters.
    7. (optional) NOBS_Filter: description of filter type and filter value.
      1. Overrides program default or value specified in block Program_Parameters. See block Program_Parameters.
  • Block Coordinate_Space_Info (CSI): informations about coordinate dimensions (can be specified more than once)
    1. Name: short name.
      1. In case several CSI blocks are specified, Name must be unique.
    2. Dim_Name: name of coordinate dimension.
      1. Must be a valid dimension of variables referenced in IVI blocks.
      2. For all the variables listed in IVI blocks all of their used dimensions should be specified in CSI blocks.
      3. Dimensions not specified but in use are considered being used with full dimension. This can result in a rather large number of tables to be extracted.
    3. Dim_Space: range of (coordinate) values (four different options)
      1. : : all values.
      2. <startindex>:<endindex>:<schrittweite> : equidistant selection.
      3. indices=<index1>,<index2>,<index3>,...,<indexN> : list of individual coordinate values.
      4. names=<name1>,<name2>,<name3>,...,<nameN> : list of names. Must be defined in a respective label coordinate variable.
      5. xy=(<x1>,<y1>),(<x2>,<y2>),(<x3>,<y3>),...,(<xN>,<yN>): list of coordinate value pairs (local coordinates). The respective dimension must be part of a coordinate variable. Remark: In case the coordinate variable has more than one horizontal space dimension, for all of these dimensions the very same coordinate value pairs have to be specified.
      6. geo=(<lon1>,<lat1>),(<lon2>,<lat2>),(<lon3>,<lat3>),...,(<lonN>,<latN>): list of coordinate value pairs (geographic coordinates). The respective dimension must be part of a coordinate variable. Remark: In case the coordinate variable has more than one horizontal space dimension, for all of these dimensions the very same coordinate value pairs have to be specified.
      7. file=<cf-netcdf.nc>,NETCDF,<x_or_lon>,<y_or_lat>: file name, file type (currently NETCDF only) as well as variable for x coordinate or geographic longitude and y coordinate or geographic latitude. Potential input files can be generated using program GRIDCONVERT. Remark: In case the coordinate variable has more than one horizontal space dimension, for all of these dimensions the very same input data have to be specified.
    4. Dim_EPSG: (optional) EPSG code (see EPSG Geodetic Parameter Registry) for local coordinates prescribed in Dim_Space. If not present it is assumed that coordinates in Dim_Space are given in the same coordinate system as those specified in the data file.
  • Block Table_Design_Info (TDI): basic design of a table (can be specified more than once).
    1. Name: short name.
      1. In case several TDI blocks are specified, Name must be unique.
    2. First_Column_IVI: valid Name from block Input_Variable_Info.
      1. Will be used to construct the first column of a table.
    3. First_Row_IVI: Valid Name from block Input_Variable_Info.
      1. Will be used to construct the first row of a table.
    4. (optional) Row_CSI: Valid Name from block Coordinate_Space_Info
      1. Defines the coordinate (dimension) for the rows of the table.
    5. (optional) Column_CSI: Valid Name from block Coordinate_Space_Info
      1. Defines the coordinate (dimension) for the columns of the table.
      2. Column_CSI may not contain more than 34 values (= columns).
    6. (optional) Other_CSI: Valid Name from block Coordinate_Space_Info
      1. Several CSIs can be specified in one line.
      2. Defines the reach of all other dimensions.
      3. The number of tables generated is typically equal to the product of the number of entries in the other coordinates.
    7. Remarks with respect to Row_CSI and Column_CSI
      1. If in a block of type Table_Contents_Info a table consists out of only one IVI, both dimensions, Column_CSI and Row_CSI must be specified in the TDI used.
      2. If in a block of type Table_Contents_Info a table consists out of multiple IVIs, either Column_CSI or Row_CSI must be specified.
      3. Large dimensions, e.g. number of time steps, can only be processed as Row_CSI, because the maximum number of columns is limited.
  • Block Table_Contents_Info (TCI): design and contents for a (series of) table(s) (can be specified more than once).
    1. Name: short name.
      1. The folowing file(s) is (are) created for this type of table:
        <tci:name>_<nnnnnn>.csv (data)
        <tci_name>_<nnnnnn>.txt (metadata)
      2. In case several TCI blocks are specified, Name must be unique.
    2. TDI: Valid Name from block Table_Design_Info
      1. Will be used to design the table.
    3. IVI: Valid Name from block Input_Variable_Info.
      1. Is used to define the contents of the table.
      2. Can be specified more than once. In this case the respective TDI may contain either a Row_CSI or a Column_CSI.

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

Retrieved from "http://wiki.baw.de/en/index.php?title=NC2TABLE.DAT&oldid=15378"