BAWiki - User contributions [en]

NCDVAR

2026-05-11T13:29:39Z

Ak3spohr: new version april 2026: Modify_Classification

{{ProgramDescription
|name_de=NCDVAR
|name=NCDVAR
|version=April 2026
|version_descr=May 2026
|catchwords=
postprocessor 
Selective deletion or copying of variables in a [[CF-NETCDF.NC|netcdf.nc]] file 
Delete/Copy coordinate variables of a certain type (X-Y or LON-LAT) 
Delete/Copy variables belonging to a grid (''Mesh'') 
Delete/Copy of individual variables 
Deletion/Copying of individuual dates of synoptic, time-equidistant data records 
Delete/Copy of selected classes of a label dimension 
Creating sum classes for a label dimension 
Automatic setting of the WRITE chunk size 
Storage of the content of the ASCII input control files in [[CF-NETCDF.NC|netcdf.nc]] (as a variable) 
Storage of the [https://en.wikipedia.org/wiki/MD5 MD5 hash] values of input files in [[CF-NETCDF.NC|netcdf.nc]] (as a variable) 
optional use of ''Message Passing Interface'' (MPI, [https://www.mpi-forum.org/ MPI Forum])

Acknowledgment: ''This project took advantage of netCDF software developed by UCAR/Unidata ([http://www.unidata.ucar.edu/software/netcdf/ www.unidata.ucar.edu/software/netcdf/]).''

|shortdescription=
The program enables the selective deletion / copying of variables in a [[CF-NETCDF.NC|netcdf.nc]] input file into an equivalent output file.

|inputfiles=
# '''general input data''' (file type [[NCDVAR.DAT|ncdvar.dat]]);
# '''Input data''', data record to be thinned (file type [[CF-NETCDF.NC|cf-netcdf.nc]]).

|outputfiles=
# '''Output data''' (file type [[CF-NETCDF.NC|netcdf.nc]])
# (optional) informative '''printer file''' of program execution (file type ncdvar.sdr)
# (optional) '''trace''' of program execution (file type ncdvar.trc)

|methodology=
The program is subdivided into the following sections:
# Read, check and print the control data of the user;
# Read metadata of the input data;
# Transfer metadata into internal data objects;
# Classification of all variables of the input file;
# Comparison of the input data specified by the user with the data available in the input file;
# Mark all primary variables that can be selected by the user with '''COPY''' or '''DELETE''';
# Deriving the transfer method (COPY, DELETE) for the variables used by the primary variables (coordinate variable, auxiliary variable, etc.);
# Copy the variables to be transferred from the input to the output file.

|preprocessor=[[DATACONVERT]], [[BOE2NC]], [[NCAGGREGATE]], [[NCANALYSE]], [[NCCHUNKIE]], [[NCCUTOUT]], [[NCRCATMAT]], [[NetCDF Operators]], [[UNK]], [[UNTRIM2007]], [[UNTRIM2]]
|postprocessor=[[DAVIT]], [[NCAUTO]], [[NCAGGREGATE]], [[NCANALYSE]], [[NCCHUNKIE]], [[NCCUTOUT]], [[NCPLOT]], [[NCPOLO]], [[NC2TABLE]], [[UNK]], [[UNTRIM2007]], [[UNTRIM2]]
|language=Fortran95
|add_software=none
|contact_original=G. Lang
|contact_maintenance=[mailto:pos.proghome@baw.de Working group POS]
|documentation=
* Template Files:
** template files available in '''$PROGHOME/examples/ncdvar'''
}}

NCCHUNKIE

2025-12-04T09:58:30Z

Ak3spohr: update version

{{ProgramDescription
|name_de=NCCHUNKIE
|name=NCCHUNKIE
|version=November 2025
|version_descr=September 2022
|catchwords=
data conversion 
postprocessor 
automatic adjustment of number of data READ to chunk size of input data 
automatic computation of chunk sizes for result variables to support orthogonal data access 
parrallelization (''collective'' IO) using [http://de.wikipedia.org/wiki/Message_Passing_Interface MPI] 

Acknowledgment: ''This project took advantage of netCDF software developed by UCAR/Unidata ([http://www.unidata.ucar.edu/software/netcdf/ www.unidata.ucar.edu/software/netcdf/]).''

|shortdescription=
Program NCCHUNKIE can be used to chunk data stored in [[CF-NETCDF.NC|cf-netcdf.nc]] files:
# Chunk sizes are computed automatically, and all dimensions are chunked to support orthogonal data access;
# Resulting chunks sizes lie somewhere between ''Disc Block Size'' and ''Chunk Buffer Size'';
# Online compression is used during storage of data (low level of compression used, level 1);
# A netCDF-4 file is created (serial version creates NetCDF4 ''classic model format'');
# Parameters ''cache size'' and ''cache nelems'' used within netCDF-4 API are automatically determined.

Just in case '''HDF error''' is detected during read of a data record, the program tries to reconstruct the wanted data set from adjacent (in time) records for the same variable. This type of repair works for time dependent variables only.

|inputfiles=
# No input steering data file required (parameters in command line or interactive specification);
# '''UGRID CF NetCDF data set''' (file type [[CF-NETCDF.NC]]).

|outputfiles=
# '''UGRID CF NetCDF data set''' (file type [[CF-NETCDF.NC]]);
# informative '''printer file''' of program execution (file type NCCHUNKIE.sdr) with informations related to program execution, required time for READ and WRITE of data, effective data transfer rates.
# '''trace''' of program execution (file type NCCHUNKIE.trc)

|methodology=
Some concepts published in [https://support.hdfgroup.org/pubs/papers/2008-06_netcdf4_perf_report.pdf https://support.hdfgroup.org/pubs/papers/2008-06_netcdf4_perf_report.pdf] were used.

|preprocessor=[[DATACONVERT]], [[GRIDCONVERT]], [[NCANALYSE]], [[NCAGGREGATE]], [[NCCUTOUT]], [[NCDELTA]], [[NCDVAR]], [[NCMERGE]], [[NetCDF Operators]], [[UNTRIM2007]], [[UNTRIM2]]
|postprocessor=[[NCANALYSE]], [[NCAGGREGATE]], [[NCDELTA]], [[NCDVAR]], [[NCMERGE]], [[NCCHUNKIE]], [[NCCUTOUT]], [[NC2TABLE]], [[NetCDF Operators]]
|language=Fortran95
|add_software=---
|contact_original=G. Lang
|contact_maintenance=[mailto:pos.proghome@baw.de Working group POS]
|documentation=
* [https://izw-campus.baw.de/ ''IZW-Campus''] (Podcast, available in German only)
** 2020-11-02: [https://izw-campus.baw.de/goto.php?target=cat_1832&client_id=iliasclient ''Chunking und NCCHUNKIE''];
** 2019-08-02: [https://izw-campus.baw.de/goto.php?target=cat_1831&client_id=iliasclient ''Anmerkungen zur Chunked I/O mit NetCDF-4 / HDF5''].
* Template file:
** No template files available.
}}

NCPLOT

2025-09-17T15:35:50Z

Ak3spohr: update version

{{ProgramDescription
|name_de=NCPLOT
|name=NCPLOT
|version=September 2025
|version_descr=September 2022
|catchwords=graphical postprocessor 
graphical presentation of CF NetCDF data (unknown attributes are ignored) 
finite element models 
finite difference models 
orthogonal unstructured grid model 
orthogonal unstructured grid model with subgrid information 
conversion or transformation (extensive - intensive) of physical units 
calculation of new quantities (for display) from one or several input data sets 
(optional) filter based on water depth 
(optional) filter based on number of observations 

Acknowledgment: ''This project took advantage of netCDF software developed by UCAR/Unidata ([http://www.unidata.ucar.edu/software/netcdf/ www.unidata.ucar.edu/software/netcdf/]).''

|shortdescription=
The graphical postprocessor NCPLOT can be used for a graphical presentation
of simulation and analysis results, which is stored in CF NetCDF data format.
The data can be defined on nodes, edges or faces. The program works on 2D-data,
3D-data and on data with details scaled on a subgrid. 
[[File:NcplotBspFaceArea.png|thumb|250px|Picture 1: Salinity with underlaid topography.]]

The sample pictures illustrate the capability of the program NCPLOT. 
[[NCPLOT: Example figures|Example figures: NCPLOT]]

Basically, NCPLOT distinguishes linear from areal chart types.
For area charts the symbolization of the data is depending on the data value
(color legend, proportional arrow).
For linear charts, the values of data series are plotted on an axis.
The symbolization of the data series is independent of the data value.
 

[[NCPLOT: Area Charts|Area Charts]]:
* Map, or top view illustration
* Vertical section along profile (3D data)
* Time depth diagram (3D data)
* Hovmöller diagram: Temporal development along profile.
 
[[NCPLOT: Line Charts|Line Charts]]: 
* time series
* profile view
* depth profile
 
NCPLOT allows you to illustrate different diagrams of different types in one picture.
Line diagrams next to areal charts with static and possibly dynamic parts.
 

Picture series: 
Both line and area chart definitions can request the creation of picture series.
A picture can contain static and dynamic image components.
Dynamic components means parts of the image that vary over a picture series.
 

The following rule applies to the program: 
The first read dynamic definition determines the permitted length of the
picture series.
The program aborts, if a further dynamic diagram definition results a
different number of images.
 

Further tests are not carried out.
 

Different series diagrams from dynamic diagram definitions of the same
length are processed by the program. The static picture elements are displayed
on every picture in the series.
 

|inputfiles=
# '''general input data''' (file type [[NCPLOT.DAT|ncplot.dat]])
# '''result files''' (file type [[CF-NETCDF.NC]])
# file with '''interval definitions''' for color legends (file type [[BOUNDS.CFG.DAT|bounds.cfg.dat]]) Hint: (Recommended) Local configuration file or file from the directory ''$PROGHOME/cfg/''.
# file with '''list of definitions of palettes''' (file type [[PALETTES.CFG.DAT|palettes.cfg.dat]]) Hint: (Recommended) Provided file from the directory ''$PROGHOME/cfg/'' or local configuration file.
# file with '''definitions of colors''' (file type [[COLORS.CFG.DAT|colors.cfg.dat]]) Hint: (Recommended) Provided file from the directory ''$PROGHOME/cfg/'' or local configuration file.

For NCPLOT the following standard configuration files from the directory '''''$PROGHOME/cfg/''''' are required:
* GKS parameter file: '''gkssystem.computername.dat'''

|outputfiles=
# '''graphic files''' (format: CGM or SVG)
# (optional) informative '''printer file''' of program execution (file type ncplot.sdr)
# (optional) '''trace''' of program execution (file type ncplot.trc)

|methodology=
NCPLOT is a pure plot program without any user interaction at runtime.
The layout of the picture and the graphical presentation of the data has to be
described in the steering file.
 

NCPLOT creates vector graphics in CGM or SVG format.
 

For special data files it is possible to exclude data at places with low water
coverage from the display. The technic works only on original UnTRIM result files
in CF NetCDF format.
 

Just in case '''HDF error''' is detected during read of a data record,
the program tries to reconstruct the wanted data set from adjacent (in time)
records for the same variable.
This type of repair works for time dependent variables only.
 

|preprocessor=[[BOE2NC]], [[DATACONVERT]], [[GRIDCONVERT]], [[NCAGGREGATE]], [[NCANALYSE]], [[NCCUTOUT]], [[NCDELTA]], [[NCDVAR]], [[NCMERGE]], [[UNK]], [[UNTRIM2007]], [[UNTRIM2]]
|postprocessor=---
|language=Fortran95
|add_software=GKS (by GTS-Gral)
|contact_original=G. Lang, S. Spohr
|contact_maintenance=[mailto:pos.proghome@baw.de Working group POS]
|documentation=
template files available in '''$PROGHOME/examples/ncplot'''
}}

NCAGGREGATE

2025-06-23T15:26:57Z

Ak3spohr: update version

{{ProgramDescription
|name_de=NCAGGREGATE
|name=NCAGGREGATE
|version=June 2025
|version_descr=September 2022
|catchwords=
data analysis 
postprocessor 
synoptic data sets 
[[Analysis_of_Calculated_Results#Tidal_Characteristic_Numbers|tidal characteristic numbers]] 
[[Analysis_of_Calculated_Results#Characteristic_Numbers_.28independent_of_the_presence_of_tides.29|tide-independent characteristic numbers]] 
differences for synoptic data sets 
differences for tidal characteristic numbers 
differences for tide-independent characteristic numbers 
[[NetCDF|CF NetCDF]] format for 2D/3D data 
aggregated data for control volumes and exchanges 
orthogonal unstructured grid model 
support of computational results based on sub-grid bathymetry 
parallelization using [http://openmp.org/wp/ OpenMP] 
support of DMQS metadata and variables 
[[NetCDF#Quality assurance using NetCDF attributes|automatic quality assurance (value range)]] 
automatic adjustment of number of data READ to chunk size of input data 
automatic computation of chunk sizes for result variables to support orthogonal data access 
Storage of the content of the ASCII input control files in [[CF-NETCDF.NC|netcdf.nc]] (as a variable) 
Storage of [https://en.wikipedia.org/wiki/MD5 MD5 hash values] of input files in [[CF-NETCDF.NC|netcdf.nc]] (as a variable) 
optional use of ''Message Passing Interface'' (MPI, [https://www.mpi-forum.org/ MPI Forum])

Acknowledgment: ''This project took advantage of netCDF software developed by UCAR/Unidata ([http://www.unidata.ucar.edu/software/netcdf/ www.unidata.ucar.edu/software/netcdf/]).''

|shortdescription=
Program NCAGGRGATE may be useful in different situations which are listed in the following. For each type of application a list of programs (with sequence of execution) is given:
* aggregation of synoptic transport data for control volumes aiming at a precise balance of transports (water volume, salt, etc.): Attention: To get an input file suitable for INSPECT_CONTROL_VOLUMES, the simulation must be performed at least with salt or temperature. Even if you are only interested in the hydrodynamics, NCAGGREGATE also has to aggregate the salt or temperature values. The aggregated synoptic water volume is otherwise not calculated. However, this physical quantity is required for the calculations performed in INSPECT_CONTROL_VOLUMES.
*# [[UNTRIM2007]] or [[UNTRIM2]],
*# NCAGGREGATE,
*# [[INSPECT_CONTROL_VOLUMES]] (check results),
*# [[NCANALYSE]], and
*# [[DISPLAY_CONTROL_VOLUMES]].
* aggregation of synoptic data (water level, current velocity, salinity, etc.) aiming at the reduction of data complexity:
*# [[UNTRIM2007]] or [[UNTRIM2]],
*# NCAGGREGATE, and
*# [[NCPLOT]].
* aggregation of characteristic numbers aiming at the reduction of data complexity:
*# [[UNTRIM2007]] or [[UNTRIM2]],
*# [[NCANALYSE]],
*# [[NCPLOT]] (check characteristic numbers),
*# NCAGGREGATE, and
*# [[NCPLOT]].
* aggregation of differences for characteristic numbers or synoptic data aiming at the reduction of data complexity:
*# [[UNTRIM2007]] or [[UNTRIM2]] (experimentally also for DFlow FM),
*# [[NCANALYSE]] (computation of characteristic numbers),
*# [[NCPLOT]] (check characteristic numbers),
*# [[NCDELTA]],
*# [[NCPLOT]] (check differences),
*# NCAGGREGATE, and
*# [[NCPLOT]].
During aggragation of classical data ''land binary masks'' (LBM) are automatically added to the result file. LBMs are used to describe the distribution of land and water at aggregation time. LBMs therefore empower visualization programs like [[NCPLOT]] to optimally present aggregated data in combination with a meaningful land-water-distribution.

Optionally the user is able to generate percentiles (0.01, 0.05, 0.50, 0.95 and 0.99) as well as probability distributions in addition to those aggregated data which are ''usually'' created. For further advice see [[NCAGGREGATE.DAT|ncaggregate.dat]].

[[File:ncaggregate_patch.png|thumb|'''Picture ''control volumes and exchanges'''''.]]

|inputfiles=
# '''general input data''' (file type [[NCAGGREGATE.DAT|ncaggregate.dat]]);
# file with '''classifications''' for probability distributions (file type [[BOUNDS.CFG.DAT|bounds.cfg.dat]]) Hint: (Recommended) Local configuration file or file from the directory ''$PROGHOME/cfg/''.
# '''synoptic data sets''' (file type [[CF-NETCDF.NC|cf-netcdf.nc]]);
# '''control volumes''' (file type [[IPDS.DAT|ipds.dat]]);
# for [[NetCDF#Automatic quality assurance using NetCDF attributes|automatic quality assurance]] (file type [[BOUNDS.CFG.DAT|bounds_verify.dat]]).

|outputfiles=
# '''data analysis result files''' (file type [[CF-NETCDF.NC|cf-netcdf.nc]]); see ''[[NetCDF aggregation for unstructured grids]]'' for details about the aggregational grid.
# (optional) informative '''printer file''' of program execution (file type ncaggregate.sdr)
# (optional) '''trace''' of program execution (file type ncaggregate.trc)

|methodology=
Physical data, suitable for aggregation, are collected for different control volumes as well as exchanges between adjacent control volumes.

Just in case '''HDF error''' is detected during read of a data record, the program tries to reconstruct the wanted data set from adjacent (in time) records for the same variable. This type of repair works for time dependent variables only.

|preprocessor=[[NCANALYSE]], [[NCCHUNKIE]], [[NCCUTOUT]], [[NCDELTA]], [[NCDVAR]], [[NCMERGE]], [[UNTRIM2007]], [[UNTRIM2]], [[INSEL2IPDS]]
|postprocessor=[[DAVIT]], [[INSPECT_CONTROL_VOLUMES]], [[NCANALYSE]], [[NCAUTO]], [[NCCHUNKIE]], [[NCDELTA]], [[NCDVAR]], [[NCMERGE]], [[NCPLOT]], [[NC2TABLE]], [[PLOTPROFILZEIT]]
|language=Fortran95
|add_software=---
|contact_original=G. Lang
|contact_maintenance=[mailto:pos.proghome@baw.de Working group POS]
|documentation=
* Presentations (available in German only):
** 2014-03-12: [http://ewisa.baw.de/files/09206_tv12_2014_03_12_aggregation_g_lang.pdf ''Aggregation von Daten''].
* [https://izw-campus.baw.de/ ''IZW-Campus''] (Podcast, available in German only)
**2020-12-07: [https://izw-campus.baw.de/goto.php?target=cat_1830&client_id=iliasclient ''Aggregation und NCAGGREGATE''].
* Template Files:
** template files available in '''$PROGHOME/examples/ncaggregate'''
}}

NCANALYSE

2025-04-11T15:31:35Z

Ak3spohr: update Version

{{ProgramDescription
|name_de=NCANALYSE
|name=NCANALYSE
|version=March 2025
|version_descr=September 2022
|catchwords=
data analysis 
postprocessor 
synoptic data sets 
measured time series data (optionally with [http://cfconventions.org/Data/cf-conventions/cf-conventions-1.6/build/cf-conventions.html#flags flag variables] for a more detailed qualification of data) 
depth averaged (2D) and depth structured data (3D) with z-layers 
[[Tidal Characteristic Numbers of Water Level|tidal characteristic numbers of water level]] 
[[Tidal Characteristic Numbers of Current|tidal characteristic numbers of current]], [[Tidal Characteristic Numbers of Water Transport|tidal characteristic numbers of water transport]] 
[[Tidal Characteristic Numbers of Salinity|tidal characteristic numbers of salinity]], [[Tidal Characteristic Numbers of Salt Transport|tidal characteristic numbers of salt transport]] 
[[Tidal Characteristic Numbers of Temperature|tidal characteristic numbers of temperature]], [[Tidal Characteristic Numbers of Heat Transport|tidal characteristic numbers of heat transport]] 
[[Tidal Characteristic Numbers of Suspended Sediment Transport|tidal characteristic numbers of suspended sediment]],
[[Tidal Characteristic Numbers of Suspended Load Transport|tidal characteristic numbers of suspended load transport]] 
[[Tidal Characteristic Numbers of Tracer Load|tidal characteristic numbers of tracer load]], [[Tidal Characteristic Numbers of Tracer Load Transport|tidal characteristic numbers of tracer load transport]] 
[[Tidal Characteristic Numbers of Eff. Bed Shear Stress Action|tidal characteristic numbers of effective bed shear stress]] 
[[Tidal Characteristic Numbers of Bed Load Transport|tidal characteristic numbers of bed load transport]] 
[[Tidal Characteristic Numbers of Potential Energy Anomaly|tidal characteristic numbers of potential energy anomaly]] 
[[Harmonic Analysis of Water Level|harmonic analysis of water level]] 
[[Harmonic Analysis of Current Velocity|harmonic analysis of current velocity]] 
[[Characteristic Numbers of Water Level (independent of tides)|characteristic numbers of water level (independent of tides)]] 
[[Characteristic Numbers of Current Velocity (independent of tides)|characteristic numbers of current velocity (independent of tides)]] 
[[Characteristic Numbers of Salinity (independent of tides)|characteristic numbers of salinity (independent of tides)]] 
[[Characteristic Numbers of Temperature (independent of tides)|characteristic numbers of temperature (independent of tides)]] 
[[Characteristic Numbers of Suspended Sediment Concentration (independent of tides)|characteristic numbers of suspended sediment concentration (independent of tides)]] 
[[Characteristic Numbers of Tracer Load (independent of tides)|characteristic numbers of tracer load (independent of tides)]] 
[[Characteristic Numbers of Oxygen Concentration (independent of tides)|characteristic numbers of oxygen concentration (independent of tides)]] 
[[Characteristic Numbers of Morphodynamics (independent of tides)|characteristic numbers of morphodynamics (independent of tides)]] 
[[Characteristic Numbers of Bed Load Transport (independent of tides)|characteristic numbers of bedload transport (independent of tides)]] 
[[Characteristic Numbers of Eff. Bed Shear Stress (independent of tides)|characteristic numbers of effective bed shear stress (independent of tides)]] 
[[Characteristic Numbers of Water Transport (independent of tides)|characteristic numbers of water transport (independent of tides)]]
 
[[Characteristic Numbers of Salt Transport (independent of tides)|characteristic numbers of salt transport (independent of tides)]]
 
[[Characteristic Numbers of Heat Transport (independent of tides)|characteristic numbers of heat transport (independent of tides)]]
 
[[Characteristic Numbers of Tracer Transport (independent of tides)|characteristic numbers of tracer transport (independent of tides)]] 
[[Characteristic Numbers of Suspended Sediment Transport (independent of tides)|characteristic numbers of suspended sediment transport (independent of tides)]] 
[[Characteristic Numbers of Sediment Transport (independent of tides)|characteristic numbers of sediment transport (independent of tides)]] (bed and suspended load at the bottom) 
[[Characteristic Numbers of Tidal Energy Transport|characteristic numbers of tidal energy transport]] 
[[Characteristic Numbers of Potential Energy Anomaly (independent of tides)|characteristic numbers of potential energy anomaly]] 
[[Characteristic Numbers of Meteorological Data (independent of tides)|characteristic numbers of meteorological data (wind speed)]] 
[[Characteristic Numbers for Wave and Sea State (independent of tides)|characteristic numbers for wave and sea state (significant wave height)]] 
[[NetCDF|CF NetCDF]] format for 2D/3D data 
orthogonal unstructured grid model 
orthogonal unstructured grid model with subgrid information 
data at individual locations (''Discrete Sampling Geometry'' featureType = '''timeSeriesProfile''') 
data at multiple locations along trajectories (''Discrete Sampling Geometry'' featureType = '''trajectoryProfile''') 
parallelization using [http://openmp.org/wp/ OpenMP] and [http://en.wikipedia.org/wiki/Message_Passing_Interface MPI] 
[[NetCDF#Quality assurance using NetCDF attributes|automatic quality assurance (value range)]] 
automatic adjustment of number of READ data to chunk size of data 
automatic setting of WRITE chunk sizes for written variables 
Storage of the content of the ASCII input control files in [[CF-NETCDF.NC|netcdf.nc]] (as a variable) 
Storage of [https://en.wikipedia.org/wiki/MD5 MD5 hash values] of input files in [[CF-NETCDF.NC|netcdf.nc]] (as a variable) 
optional closing of data gaps at reference positions by interpolation 

Acknowledgment: ''This project took advantage of netCDF software developed by UCAR/Unidata ([http://www.unidata.ucar.edu/software/netcdf/ www.unidata.ucar.edu/software/netcdf/]).''

|shortdescription=
Program NCANALYSE serves as an analysis program for data stored in CF netCDF data files.

|inputfiles=
# '''general input data''' (file type [[NCANALYSE.DAT|ncanalyse.dat]]);
# '''synoptic data sets''' (file type [[CF-NETCDF.NC]]);
# for [[NetCDF#Automatic quality assurance using NetCDF attributes|automatic quality assurance]] (file type [[BOUNDS.CFG.DAT|bounds_verify.dat]]).

|outputfiles=
# '''data analysis result files''' (file type [[CF-NETCDF.NC]])
# (optional) informative '''printer file''' of program execution (file type ncanalyse.sdr)
# (optional) '''trace''' of program execution (file type ncanalyse.trc)

|methodology=
The following data analysis methods are currently available:
* Tidal Characteristic Numbers:
*# [[Tidal Characteristic Numbers of Water Level]];
*# [[Tidal Characteristic Numbers of Current]];
*# [[Tidal Characteristic Numbers of Salinity]];
*# [[Tidal Characteristic Numbers of Temperature]];
*# [[Tidal Characteristic Numbers of Suspended Sediment Transport|Tidal Characteristic Numbers of Suspended Sediment]];
*# [[Tidal Characteristic Numbers of Tracer Load]];
*# [[Tidal Characteristic Numbers of Eff. Bed Shear Stress Action|Tidal Characteristic Numbers of Effective Bed Shear Stress]];
*# [[Tidal Characteristic Numbers of Bed Load Transport]];
*# [[Tidal Characteristic Numbers of Potential Energy Anomaly]].
* Tide-dependent Characteristic Numbers for Transport-Processes (based on ''exact'' integrals):
*# [[Tidal Characteristic Numbers of Water Transport]];
*# [[Tidal Characteristic Numbers of Salt Transport]];
*# [[Tidal Characteristic Numbers of Heat Transport]];
*# [[Tidal Characteristic Numbers of Suspended Load Transport]];
*# [[Tidal Characteristic Numbers of Tracer Load Transport]].
* Harmonic Analysis:
*# [[Harmonic Analysis of Water Level]];
*# [[Harmonic Analysis of Current Velocity]].
* Tide-Independent Characteristic Numbers:
*# [[Characteristic Numbers of Water Level (independent of tides)]];
*# [[Characteristic Numbers of Current Velocity (independent of tides)]];
*# [[Characteristic Numbers of Salinity (independent of tides)]];
*# [[Characteristic Numbers of Temperature (independent of tides)]];
*# [[Characteristic Numbers of Suspended Sediment Concentration (independent of tides)]];
*# [[Characteristic Numbers of Tracer Load (independent of tides)]];
*# [[Characteristic Numbers of Oxygen Concentration (independent of tides)]];
*# [[Characteristic Numbers of Morphodynamics (independent of tides)]];
*# [[Characteristic Numbers of Bed Load Transport (independent of tides)]];
*# [[Characteristic Numbers of Eff. Bed Shear Stress (independent of tides)]];
*# [[Characteristic Numbers of Potential Energy Anomaly (independent of tides)]].
* Tide-Independent Characteristic Numbers for Transport-Processes (based on ''exact'' integrals):
*# [[Characteristic Numbers of Water Transport (independent of tides)]];
*# [[Characteristic Numbers of Water Transport (independent of tides)]];
*# [[Characteristic Numbers of Salt Transport (independent of tides)]];
*# [[Characteristic Numbers of Heat Transport (independent of tides)]];
*# [[Characteristic Numbers of Tracer Transport (independent of tides)]];
*# [[Characteristic Numbers of Suspended Sediment Transport (independent of tides)]];
*# [[Characteristic Numbers of Sediment Transport (independent of tides)]] (bed an suspended load at the bottom).
* Tidal Energy Transport:
*# [[Characteristic Numbers of Tidal Energy Transport]]
* Characteristic Numbers of Meteorological Data:
*# [[Characteristic Numbers of Meteorological Data (independent of tides)|wind speed]].
* Characteristic Numbers for Wave and Sea State:
*# [[Characteristic Numbers for Wave and Sea State (independent of tides)|significant wave height]].

Just in case '''HDF error''' is detected during read of a data record, the program tries to reconstruct the wanted data set from adjacent (in time) records for the same variable. This type of repair works for time dependent variables only.

|preprocessor=[[BOE2NC]], [[DATACONVERT]], [[GRIDCONVERT]], [[NCAGGREGATE]], [[NCCHUNKIE]], [[NCCUTOUT]], [[NCDVAR]], [[NCMERGE]], [[NetCDF Operators]], [[QUICKPLOT]], [[UNTRIM2007]], [[UNTRIM2]]
|postprocessor=[[DAVIT]], [[DISPLAY_CONTROL_VOLUMES]], [[NCAGGREGATE]], [[NCAUTO]], [[NCCHUNKIE]], [[NCCUTOUT]], [[NCDELTA]], [[NCDVAR]], [[NCPLOT]], [[NC2TABLE]], [[PLOTPROFILZEIT]], [[PLOTTS]]
|language=Fortran95
|add_software=---
|contact_original=G. Lang
|contact_maintenance=[mailto:pos.proghome@baw.de Working group POS]
|documentation=
* Presentations (many available in German only):
** 2021-06-16: [http://doi.org/10.13140/RG.2.2.20390.45120 ''Tidal Asymmetry - Classical Parameters vs Skewness''] (DOI: [http://doi.org/10.13140/RG.2.2.20390.45120 http://doi.org/10.13140/RG.2.2.20390.45120]);
** 2015-05-29: [http://ewisa.baw.de/files/12556_tv12_2015_05_29_tide_energie_transport_g_lang.pdf ''Tidewelle und Energietransport''] (DOI: [http://dx.doi.org/10.13140/RG.2.2.31352.14089 http://dx.doi.org/10.13140/RG.2.2.31352.14089]);
** 2014-12-03: [http://ewisa.baw.de/files/11284_tv12_2014_12_03_ncanalyse_lzks_g_lang.pdf ''NCANALYSE - Tideunabhängige Kennwerte des Salzgehalts''];
** 2014-12-03: [http://ewisa.baw.de/files/11285_tv12_2014_12_03_ncanalyse_tdks_g_lang.pdf ''NCANALYSE - Tidekennwerte des Salzgehalts''];
** 2014-10-08: [http://ewisa.baw.de/files/10587_tv12_2014_10_08_ncanalyse_lzkv_g_lang.pdf ''NCANALYSE - Tideunabhängige Kennwerte der Strömung''];
** 2014-09-10: [http://ewisa.baw.de/files/10588_tv12_2014_09_10_allgemein_g_lang.pdf ''NCANALYSE - Tidekennwerte der Strömung''];
** 2013-08-07: [http://ewisa.baw.de/files/08510_speech_2013-08-07.pdf ''NCANALYSE - Tideunabhängige Kennwerte des Wasserstands''];
** 2013-05-15: [http://ewisa.baw.de/files/08500_speech_2013-05-15.pdf ''NCANALYSE - Daten aus CF netCDF Dateien analysieren''].
* [https://izw-campus.baw.de/ ''IZW-Campus''] (Podcast, available in German only)
** 2022-04-25: [https://izw-campus.baw.de/goto.php?target=cat_4105&client_id=iliasclient ''NCANALYSE - Grundlagen am Beispiel der Analyse LZKW (tideunabhängige Kennwerte des Wasserstands)''];
** 2022-03-21: [https://izw-campus.baw.de/goto.php?target=cat_3829&client_id=iliasclient ''Energietransport einer Tidewelle''];
** 2021-11-29: [https://izw-campus.baw.de/goto.php?target=cat_3490&client_id=iliasclient ''NCANALYSE - Grundlagen - Wechselwirkung zwischen Salzgehalt und Schwebstoffgehalt''];
** 2021-10-18: [https://izw-campus.baw.de/goto.php?target=cat_3301&client_id=iliasclient ''NCANALYSE - Grundlagen verschiedener Kennwerte (Einfluss des Salzgehalts auf verschiedene Kenngrößen)''];
** 2021-09-13: [https://izw-campus.baw.de/goto.php?target=cat_3102&client_id=iliasclient ''NCANALYSE - Grundlagen TDKA (Tidekennwerte der Anomalie der Potentiellen Energie)''];
** 2021-08-09: [https://izw-campus.baw.de/goto.php?target=cat_1830&client_id=iliasclient ''NCANALYSE - Grundlagen TDKS (Tidekennwerte des Salzgehalts)''];
** 2021-06-07: [https://izw-campus.baw.de/goto.php?target=cat_2554&client_id=iliasclient ''NCANALYSE Update zu Skewness - aus Partialtiden des Wasserstands und der Strömung''];
** 2021-04-19: [https://izw-campus.baw.de/goto.php?target=cat_2329&client_id=iliasclient ''NCANALYSE - Grundlagen am Beispiel der Analyse FRQV (Harmonische Analyse der Strömung)''];
** 2021-03-08: [https://izw-campus.baw.de/goto.php?target=cat_2224&client_id=iliasclient ''NCANALYSE - Grundlagen am Beispiel der Analyse FRQW (Harmonische Analyse des Wasserstands)''];
** 2021-02-08: [https://izw-campus.baw.de/goto.php?target=cat_1940&client_id=iliasclient ''NCANALYSE - Grundlagen am Beispiel der Analyse TDKV (Tidekennwerte der Strömungsgeschwindigkeit)''];
** 2021-01-11: [https://izw-campus.baw.de/goto.php?target=cat_1853&client_id=iliasclient ''NCANALYSE - Grundlagen am Beispiel der Analyse TDKW (Tidekennwerte des Wasserstands)''].
* Template input files:
** template files available in '''$PROGHOME/examples/ncanalyse'''
}}

NCANALYSE.DAT

2025-04-11T15:28:23Z

Ak3spohr: optional PARameter KEY Type Variant directory Configuration File

{{FileDescription
|name_de=NCANALYSE.DAT
|filetype=ncanalyse.dat
|version=March 2025
|version_descr=March 2025
|significance=contains general steering data for the program [[NCANALYSE]].
|filecontents=
'''steering data'''

* Block '''Program_Parameters''': general input data
*# '''Max_Read_Storage''': maximum number of data items which can be read, stored and processed within one analysis cycle.
*# '''Min_Water_Depth''': minimum water depth up to which analyses are carried through.
*# (optional) '''Create_Missing_Variables''': create additional (virtual) variables
*#: 0 = do not create (default);
*#: 1 = create (actually only "magnitude_of_sea_water_velocity" for DFlow FM UGRID CF NetCDF).
*# (optional) '''NC_Deflate_Level''': level (0 to 9) of online-compression used during write of the result file
*#: 0 = no compression (default);
*#: 5 = good compression (recommendation);
*#: 9 = highest level of compression.
*# (optional) '''FRQ_use_j_v_correction''': nodal correction in tidal constituent analysis
*#: .true. = use nodal correction in computation of tidal constituents (default);
*#: .false. = ''neglect'' nodal correction in computation of tidal constituents.
*# (optional) '''END_after_hrp''': end program execution after analysis at reference locations before entering spatial analysis
*#: .true. = end execution before spatial analysis;
*#: .false. = normal execution of program (default).
*# (optional) '''CU_zero_slack''': critical value for current velocity in [m s-1]. Typically 1 [cm s-1] is predefined in the configuration files. This value is used to determine current slack. Current slack is recognized by the program in case magnitude of current velocity lies above this limit value and the direction of flow has changed.
*# (optional) '''Compute_FE_Ratio''': Compute flood(current):ebb(current) characteristic numbers, in case they are marked using <OPT:COMPUTE_FE_RATIO> in a configuration file.
*#: .true. = F:E-Kenngrößen berechnen
*#: .false. = F:E-Kenngrößen nicht berechnen (Default)
*# (optional) '''CFG_Level''': some configuration files may contain lines including <OPT:CFG_Level_''number''> to allow for a more flexible use for different purposes.
*#: 0 = activate lines including <OPT:CFG_Level_0> (default)
*#: 1 = activate lines including <OPT:CFG_Level_1>
*# (optional) '''Location_XY_EPSG''': EPSG code for X- and Y-coordinates used in '''Location''' blocks. In case this key is missing, EPSG code derived from input data (block '''Input_Files''') will be used.
*# (optional) '''Gap_Fill''': control parameter for filling data gaps at reference locations by interpolation. If this key is not specified, data gaps (water level, current) are not automatically filled.
*#: 0 = data gaps are not filled (default)
*#: 1 = Data gaps are filled by spline interpolation
* Block '''Data_Analysis_Period''': period of data analysis
*# '''Start_Time''': start time of data analysis period.
*# '''End_Time''': end time of data analysis period.
* Block '''Input_Files''': [[NetCDF|CF NetCDF]] file with input data
*# '''Data_File''': name and type (NETCDF) of the input data file (filetype [[CF-NETCDF.NC|cf-netcdf.nc]]). An optional third parameter may be used to choose between MPI COLLECTIVE I/O and MPI INDEPENDENT I/O (relevant for MPI program version only).
* Block '''Location''': reference locations (one block per location)
*# '''Name''': name of reference location.
*# '''Type''': type of reference location:
*#* 0 = reference location ''tide'' (must be specified exactely once);
*#* 1 = reference location ''phase'' (must be specified exactely once);
*#* 2 = auxiliary location (can be specified several times).
*# '''X''': x-coordinate of location(specify either '''X''' and '''Y''' or '''LON''' and '''LAT''').
*# '''Y''': y-coordinate of location (specify either '''X''' and '''Y''' or '''LON''' und '''LAT''').
*# '''LON''': longitude of location (specify either '''X''' and '''Y''' or '''LON''' and '''LAT''').
*# '''LAT''': latitude of location (specify either '''X''' and '''Y''' or '''LON''' and '''LAT''').
*# '''Z''': z-coordinate of location (positive downwards).
*# '''Rank''': ''rank'' of location(not for ''reference location phase'').
*# '''Previous_Rank''': refers to the ''rank'' of the previous location (not for ''reference location tide'' and ''reference location phase'').
* Block '''Input_Variables''': names(s) for variables to be analysed
*# '''Name''': name of variable to be analysed (must be a valid [[NetCDF|CF NetCDF]] variable name from the input data file).
* Block '''Data_Analysis''': type of analysis and [[NetCDF|CF NetCDF]] file for result data
*# '''Type''': type of analysis (and optional Variant directory Config File):
*#* '''TDKW''' = [[Tidal Characteristic Numbers of Water Level]];
*#* '''TDKV''' = [[Tidal Characteristic Numbers of Current]];
*#* '''TDXF''' = [[Tidal Characteristic Numbers of Water Transport]];
*#* '''TDKS''' or '''TDWS''' = [[Tidal Characteristic Numbers of Salinity]];
*#* '''TDXS''' = [[Tidal Characteristic Numbers of Salt Transport]];
*#* '''TDKT''' = [[Tidal Characteristic Numbers of Temperature]];
*#* '''TDXT''' = [[Tidal Characteristic Numbers of Heat Transport]];
*#* '''TDKC''' = [[Tidal Characteristic Numbers of Suspended Sediment Transport|Tidal Characteristic Numbers of Suspended Sediment]];
*#* '''TDXC''' = [[Tidal Characteristic Numbers of Suspended Load Transport]];
*#* '''TDKP''' = [[Tidal Characteristic Numbers of Tracer Load]];
*#* '''TDXP''' = [[Tidal Characteristic Numbers of Tracer Load Transport]];
*#* '''TDKB''' = [[Tidal Characteristic Numbers of Eff. Bed Shear Stress Action|Tidal Characteristic Numbers of Effective Bed Shear Stress]];
*#* '''TDKG''' = [[Tidal Characteristic Numbers of Bed Load Transport]];
*#* '''TDKA''' = [[Tidal Characteristic Numbers of Potential Energy Anomaly]];
*#* '''FRQW''' = [[Harmonic Analysis of Water Level|Harmonic Analysis of Water Level (tidal constituents)]];
*#* '''FRQV''' = [[Harmonic Analysis of Current Velocity|Harmonic Analysis of Current Velocity (tidal constituents)]];
*#* '''LZKW''' = [[Characteristic Numbers of Water Level (independent of tides)]];
*#* '''LZKV''' = [[Characteristic Numbers of Current Velocity (independent of tides)]];
*#* '''LZKS''' = [[Characteristic Numbers of Salinity (independent of tides)]];
*#* '''LZKT''' = [[Characteristic Numbers of Temperature (independent of tides)]];
*#* '''LZKC''' = [[Characteristic Numbers of Suspended Sediment Concentration (independent of tides)]];
*#* '''LZKP''' = [[Characteristic Numbers of Tracer Load (independent of tides)]];
*#* '''LZKO''' = [[Characteristic Numbers of Oxygen Concentration (independent of tides)]];
*#* '''LZKM''' = [[Characteristic Numbers of Morphodynamics (independent of tides)]];
*#* '''LZKG''' = [[Characteristic Numbers of Bed Load Transport (independent of tides)]];
*#* '''LZKB''' = [[Characteristic Numbers of Eff. Bed Shear Stress (independent of tides)]];
*#* '''LZKA''' = [[Characteristic Numbers of Potential Energy Anomaly (independent of tides)]];
*#* '''LZXF''' = [[Characteristic Numbers of Water Transport (independent of tides)]];
*#* '''LZXS''' = [[Characteristic Numbers of Salt Transport (independent of tides)]];
*#* '''LZXT''' = [[Characteristic Numbers of Heat Transport (independent of tides)]];
*#* '''LZXP''' = [[Characteristic Numbers of Tracer Transport (independent of tides)]];
*#* '''LZXC''' = [[Characteristic Numbers of Suspended Sediment Transport (independent of tides)]];
*#* '''LZXG''' = [[Characteristic Numbers of Sediment Transport (independent of tides)]] (bed and suspended load at the bottom);
*#* '''LZXE''' = [[Characteristic Numbers of Tidal Energy Transport]];
*#* '''LZMW''' = [[Characteristic Numbers of Meteorological Data (independent of tides)|Characteristic Numbers of Meteorological Data (Wind Speed)]];
*#* '''LZSS''' = [[Characteristic Numbers for Wave and Sea State (independent of tides)|Characteristic Numbers for Wave and Sea State (significant wave height)]].
*# '''Result_File''': name and type (NETCDF) of the result file (filetype [[CF-NETCDF.NC|cf-netcdf.nc]]).
* '''Optional Input Blocks''' for different analyses
: To specify meaningful ''bounds'', which are the interval boundaries for the various frequency distributions computed, the range of the physical quantity under consideration should be evaluated before, e.g. using program [[NCAUTO]].
:* optional for '''TDKW''':
:** Block '''TDKW_Quantiles''': definition of quantiles.
:**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
:* optional for '''TDKV''':
:** Block '''TDKV_Quantiles''': definition of quantiles.
:**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
:* optional for '''TDKS''' or '''TDWS''':
:** Block '''TDKS_Quantiles''' or '''TDWS_Quantiles''': definition of quantiles.
:**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
:* optional for '''TDKT''':
:** Block '''TDKT_Quantiles''': definition of quantiles.
:**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
:* optional for '''TDKC''':
:** Block '''TDKC_Quantiles''': definition of quantiles.
:**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
:* optional for '''TDKP''':
:** Block '''TDKP_Quantiles''': definition of quantiles.
:**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
:* optional for '''TDKG''':
:** Block '''TDKG_Quantiles''': definition of quantiles.
:**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
:* optional for '''TDKB''':
:** Block '''TDKB_Quantiles''': definition of quantiles.
:**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
:* optional for '''TDKA''':
:** Block '''TDKA_Quantiles''': definition of quantiles.
:**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
:* optional for '''FRQW''' and '''FRQV''':
:** Block '''Tidal_Constituents''': list of tidal constituents
:**# '''Value''': code of tidal constituent, e. g. Mm, Mf, K_1, O_1, S_2, M_2, M_4, M_6, M_8.
* '''Optional Required Input Blocks''' for different analyses
: To specify meaningful ''bounds'', which are the interval boundaries for the various frequency distributions computed, the range of the physical quantity under consideration should be evaluated before, e.g. using program [[NCAUTO]].
:* required for '''LZKW''':
:** Block '''Water_Level_Bounds''': definition of classes for water level.
:**# '''Interval''': lower and upper bound of classes (intervals).
:** Block '''Water_Level_Quantiles''': definition of quantiles.
:**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
:* required for '''LZKV''':
:** Block '''Current_Velocity_Bounds''': definition of classes for current velocity.
:**# '''Interval''': lower and upper bound of classes (intervals).
:** Block '''Current_Velocity_Quantiles''': definition of quantiles.
:**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
:* required for '''LZKS''':
:** Block '''Salinity_Bounds''': definition of classes for salinity.
:**# '''Interval''': lower and upper bound of classes (intervals).
:** Block '''Salinity_Quantiles''': definition of quantiles.
:**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
:* required for '''LZKT''':
:** Block '''Temperature_Bounds''': definition of classes for temperature.
:**# '''Interval''': lower and upper bound of classes (intervals).
:** Block '''Temperature_Quantiles''': definition of quantiles.
:**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
:* required for '''LZKC''':
:** Block '''Suspended_Sediment_Bounds''': definition of classes for suspended sediment concentration.
:**# '''Interval''': lower and upper bound of classes (intervals).
:** Block '''Suspended_Sediment_Quantiles''': definition of quantiles.
:**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
:* required for '''LZKP''':
:** Block '''Tracer_Bounds''': definition of classes for tracer load.
:**# '''Interval''': lower and upper bound of classes (intervals).
:** Block '''Tracer_Quantiles''': definition of quantiles.
:**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
:* required for '''LZKO''':
:** Block '''Oxygen_Bounds''': definition of classes for oxygen concentration.
:**# '''Interval''': lower and upper bound of classes (intervals).
:** Block '''Oxygen_Quantiles''': definition of quantiles.
:**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
:* required for '''LZKM''':
:** Block '''Bathymetry_Bounds''': definition of classes for bathymetry.
:**# '''Interval''': lower and upper bound of classes (intervals).
:** Block '''Bathymetry_Quantiles''': definition of quantiles.
:**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
:* required for '''LZKG''':
:** Block '''Bedload_Bounds''': definition of classes for bedload transport.
:**# '''Interval''': lower and upper bound of classes (intervals).
:** Block '''Bedload_Quantiles''': definition of quantiles.
:**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
:* required for '''LZKB''':
:** Block '''Bedfriction_Bounds''': definition of classes for eff. bed shear stress.
:**# '''Interval''': lower and upper bound of classes (intervals).
:** Block '''Bedfriction_Quantiles''': definition of quantiles.
:**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
:* required for '''LZKA''':
:** Block '''PE_Anomaly_Bounds''': definition of classes for PEA.
:**# '''Interval''': lower and upper bound of classes (intervals).
:** Block '''PE_Anomaly_Quantiles''': definition of quantiles.
:**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
:* required for '''LZMW''':
:** Block '''Wind_Bounds''': definition of classes for wind speed.
:**# '''Interval''': lower and upper bound of classes (intervals).
:** Block '''Wind_Quantiles''': definition of quantiles.
:**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
:* required for '''LZSS''':
:** Block '''Sig_Wave_Bounds''': definition of classes for significant wave height.
:**# '''Interval''': lower and upper bound of classes (intervals).
:** Block '''Sig_Wave_Quantiles''': definition of quantiles.
:**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
===General Remarks===
# Dictionary files used from directory '''''$PROGHOME/dic/''''':
#* '''''ncanalyse_dico.dat''''' and
#* '''''ncanalyse_config_dico.dat'''''.
# Standard configuration files used from directory '''''$PROGHOME/cfg/''''':
#* '''TDKW_ncanalyse_cfg.dat''': definition file for [[Tidal Characteristic Numbers of Water Level]];
#* '''TDKV_ncanalyse_cfg.dat''': definition file for [[Tidal Characteristic Numbers of Current]];
#* '''TDXF_ncanalyse_cfg.dat''': definition file for [[Tidal Characteristic Numbers of Water Transport]];
#* '''TDKS_ncanalyse_cfg.dat''': definition file for [[Tidal Characteristic Numbers of Salinity]];
#* '''TDXS_ncanalyse_cfg.dat''': definition file for [[Tidal Characteristic Numbers of Salt Transport]];
#* '''TDKT_ncanalyse_cfg.dat''': definition file for [[Tidal Characteristic Numbers of Temperature]];
#* '''TDXT_ncanalyse_cfg.dat''': definition file for [[Tidal Characteristic Numbers of Heat Transport]];
#* '''TDKC_ncanalyse_cfg.dat''': definition file for [[Tidal Characteristic Numbers of Suspended Sediment Transport|Tidal Characteristic Numbers of Suspended Sediment]];
#* '''TDXC_ncanalyse_cfg.dat''': definition file for [[Tidal Characteristic Numbers of Suspended Load Transport]];
#* '''TDKP_ncanalyse_cfg.dat''': definition file for [[Tidal Characteristic Numbers of Tracer Load]];
#* '''TDXP_ncanalyse_cfg.dat''': definition file for [[Tidal Characteristic Numbers of Tracer Load Transport]];
#* '''TDKB_ncanalyse_cfg.dat''': definition file for [[Tidal Characteristic Numbers of Eff. Bed Shear Stress Action|Tidal Characteristic Numbers of Effective Bed Shear Stress]];
#* '''TDKG_ncanalyse_cfg.dat''': definition file for [[Tidal Characteristic Numbers of Bed Load Transport]];
#* '''TDKA_ncanalyse_cfg.dat''': definition file for [[Tidal Characteristic Numbers of Potential Energy Anomaly]];
#* '''FRQW_ncanalyse_cfg.dat''': definition file for [[Harmonic Analysis of Water Level]];
#* '''FRQV_ncanalyse_cfg.dat''': definition file for [[Harmonic Analysis of Current Velocity]];
#* '''LZKW_ncanalyse_cfg.dat''': definition file for [[Characteristic Numbers of Water Level (independent of tides)]];
#* '''LZKV_ncanalyse_cfg.dat''': definition file for [[Characteristic Numbers of Current Velocity (independent of tides)]];
#* '''LZKS_ncanalyse_cfg.dat''': definition file for [[Characteristic Numbers of Salinity (independent of tides)]];
#* '''LZKT_ncanalyse_cfg.dat''': definition file for [[Characteristic Numbers of Temperature (independent of tides)]];
#* '''LZKC_ncanalyse_cfg.dat''': definition file for [[Characteristic Numbers of Suspended Sediment Concentration (independent of tides)]];
#* '''LZKP_ncanalyse_cfg.dat''': definition file for [[Characteristic Numbers of Tracer Load (independent of tides)]];
#* '''LZKO_ncanalyse_cfg.dat''': definition file for [[Characteristic Numbers of Oxygen Concentration (independent of tides)]];
#* '''LZKM_ncanalyse_cfg.dat''': definition file for [[Characteristic Numbers of Morphodynamics (independent of tides)]];
#* '''LZKG_ncanalyse_cfg.dat''': definition file for [[Characteristic Numbers of Bed Load Transport (independent of tides)]];
#* '''LZKB_ncanalyse_cfg.dat''': definition file for [[Characteristic Numbers of Eff. Bed Shear Stress (independent of tides)]];
#* '''LZKA_ncanalyse_cfg.dat''': definition file for [[Characteristic Numbers of Potential Energy Anomaly (independent of tides)]];
#* '''LZXF_ncanalyse_cfg.dat''': definition file for [[Characteristic Numbers of Water Transport (independent of tides)]];
#* '''LZXS_ncanalyse_cfg.dat''': definition file for [[Characteristic Numbers of Salt Transport (independent of tides)]];
#* '''LZXT_ncanalyse_cfg.dat''': definition file for [[Characteristic Numbers of Heat Transport (independent of tides)]];
#* '''LZXP_ncanalyse_cfg.dat''': definition file for [[Characteristic Numbers of Tracer Transport (independent of tides)]];
#* '''LZXC_ncanalyse_cfg.dat''': definition file for [[Characteristic Numbers of Suspended Sediment Transport (independent of tides)]];
#* '''LZXG_ncanalyse_cfg.dat''': definition file for [[Characteristic Numbers of Sediment Transport (independent of tides)]] (bed an suspended load at the bottom);
#* '''LZXE_ncanalyse_cfg.dat''': definition file for [[Characteristic Numbers of Tidal Energy Transport]];
#* '''LZMW_ncanalyse_cfg.dat''': definition file for [[Characteristic Numbers of Meteorological Data (independent of tides)|Characteristic Numbers of Meteorological Data (Wind Speed)]];
#* '''LZSS_ncanalyse_cfg.dat''': definition file for [[Characteristic Numbers for Wave and Sea State (independent of tides)|Characteristic Numbers for Wave and Sea State (significant wave height)]].
|nutzerprogramme=[[NCANALYSE]]
|language=Fortran90
|fileform=FORMATTED
|fileaccess=SEQUENTIAL
|fileextension=.dat
|writemodules= ---
|readmodules=$PROGHOME/fortran/prg/ncanalyse/*/mod_m_ncanalyse_steer.f90
|contact_original=[mailto:guenther.lang@baw.de G. Lang]
|contact_maintenance=[mailto:guenther.lang@baw.de G. Lang], [mailto:susanne.spohr@baw.de S. Spohr]
|examplefile=$PROGHOME/examples/ncanalyse/ncanalyse.dat
}}

NCPLOT.DAT

2025-01-03T12:41:10Z

Ak3spohr:

{{FileDescription
|name_de=NCPLOT.DAT
|filetype=ncplot.dat
|version=December 2024
|version_descr=January 2025
|significance=contains general steering data for the program [[NCPLOT]].
|filecontents=

===Block "Program_Parameters"===
The block '''Program_Parameters''' contains general steering data.
* Key '''"Language" :''' Language preference for labels and texts:
:*'''DE''' = German,
:*'''EN''' = English.
* Key '''"Max_Read_Storage" :''' max. read only memory (in bytes) for analysis
* Key '''"Min_Water_Depth" :''' minimum water coverage in [m].
:Hint: The excluding of data from the presentation in case of low water coverage is only possible, if the variable to be displayed points in a certain way to a variable associated with the total water depth. The CF-NetCDF output of UnTRIM programs fulfills this requirement. The page '''''[[NCPLOT: Min_Water_Depth]]''''' illustrates the effect of this control parameter.
* (optional) Key '''"Infobox_Plot_Area" :''' Image area for the metadata infobox.
:If this image area is specified, information about the plot creation will be given to the graphic. This includes information about the underlying data files as well as if neccessary information about used data filtering.
* (optional) Key '''"PLR_Representation" :''' Default setting for line symbols of data curves in line charts.
* (optional) Key '''"PMR_Representation" :''' Default setting for marker symbols of data curves in line charts.
* (optional) Key '''"PLR_Palette" :''' Color palette and start color for line symbols of data curves in line charts.
* (optional) Key '''"PMR_Palette" :''' Color palette and start color for marker symbols of data curves in line charts.
* (optional) Key '''"Picture_Name_Fixum" :''' fixed name part for graphic file(s).
* (optional) Key '''"Phydef_Units" :''' Display physical units as in PHYDEF administration.
:Hint: Without explicit request, the units are displayed according to the BAW Rules.
* (optional) Key '''"Output_Format" :''' Output format for the generated graphics (CGM or SVG).
* (optional) Key '''"Heaven_Hell_Colors" :''' Color names for sky and ground.
* (optional) Key '''"Heaven_Hell_Contour_Style" :''' Color and line thickness of the boundary lines to the water body.

===Block "SVG_Specifications"===
Optional block with attributes for graphic output in SVG format.
* (optional) Key '''"SVG_Maximum_Size" :''' Maximum size of the SVG graphic, i.e. factor for converting NDC space from GKS to SVG space.
* (optional) Key '''"SVG_Font_Family" :''' Font family for text elements.
* (optional) Key '''"SVG_Free_Text_Attributes" :''' Font attribute(s) that are given to ALL texts of the SVG graphic.
* (optional) Key '''"SVG_Axis_Text_by_Char" :''' Write texts on diagram axes character by character (as in CGM format).
* (optional) Key '''"SVG_Legend_Box_by_Char" :''' Write legend texts of line charts character by character (as in CGM format).

===Block "Dataset"===
Description of a data set to be displayed. 
 
For addressing the data to be displayed, either the Start-Step-Stride technique
or the DimSelect method is available. The user has to choose one way or the other,
the procedures exclude each other. Each Start-Step-Stride-Addressing can be copied
by DimSelect, the other way round that is not the case.
DimSelect offers additional options for data selection, with the method
you can also realize non-equidistant index selection.
;Start-Step-Stride technique:
:For each dimension of the variable a start, step and stride value must be specified. The page '''''[[NCPLOT: Define DataSet]]''''' gives instructions for addressing the desired data.
;DimSelect method:
:DimSelect also requires the addressing of the indices for each dimension of the data variables to be displayed. But this can also happen indirectly. Various suitable selection methods are provided. The user can, for example, choose all faces by '''''DimSelect_All''''' without knowing the specific number, or pass the program via '''''DimSelect_Various_Date''''' a selection of times to be displayed. It is the responsibility of the program to find the corresponding indices. Related to data curves of line charts the DimSelect method offers a further advantage: For the individual dimensions this mimic allows to create text components for the names of the data series shown in the curve legend. 
Control file can contain multiple blocks of this type.
* Key '''"Name" :''' unique name of this data set.
* Key '''"File" :''' name of the CF-NetCDF file (*.nc) with the data to be displayed.
* Key '''"Variable" :''' Description of the data whose values are to be displayed.
:* Parameter '''1''' = name of the variable (in file of type *.nc)
:* (optional) Parameter '''2''' = role of the variable as part of a vector
::* X-component = Variable is the X component of a vector
::* Y-component = Variable is the Y component of a vector
::* normal_component = Variable is the normal component of a vector
:Hint: The command "ncdump -h <filename>.nc" shows the header of the CF-NetCDF file. The names of the offered variables and their dimensions can be found in the metadata.
* (optional) Key '''"Start" :''' start address for the data to be displayed.
* (optional) Key '''"Step" :''' number of steps for the data to be displayed.
* (optional) Key '''"Stride" :''' increment for the data to be displayed.
* (optional) Key '''"DimSelect_EquiDist_Index" :''' Equidistant selection of indices for a given dimension. Exemplary:
:* Parameter '''1''' = Name of the dimension
:* Parameter '''2''' = NONE or text component for curve legend
:* Parameter '''3''' = Index becomes part of the curve legend .true./.false.
:* Parameter '''4''' = Start Index
:* Parameter '''5''' = Index increment
:* Parameter '''6''' = Number of steps
* (optional) Key '''"DimSelect_EquiDist_Date" :''' Equidistant selection of times.
* (optional) Key '''"DimSelect_StartEnd_Index" :''' Selection of all indices from start to end index.
* (optional) Key '''"DimSelect_StartEnd_Date" :''' Selection of all times from start to end date.
* (optional) Key '''"DimSelect_Single_Index" :''' Selection of a specific index.
* (optional) Key '''"DimSelect_Single_Date" :''' Selection of a specific date.
* (optional) Key '''"DimSelect_Various_Index" :''' List of various indices.
* (optional) Key '''"DimSelect_Various_Date" :''' List of various dates.
* (optional) Key '''"DimSelect_All" :''' Selection of all indices of a dimension.
* (optional) Key '''"DimSelect_ByLabel_LabVar" :''' Determine indices with list of names by label variable.
* (optional) Key '''"DimSelect_ByLabel_List" :''' Continuation line to Key '''''DimSelect_ByLabel_LabVar'''''.
* (optional) Key '''"DimSelect_Location_Coord" :''' Selection of locations by coordinates.
* (optional) Key '''"DimSelect_LocByFile_File" :''' Selection of locations from file with locations.
* (optional) Key '''"DimSelect_LocByFile_List" :''' Continuation line to Key '''''DimSelect_LocByFile_File'''''.
* (optional) Key '''"Dimensions_for_Picture_Series" :''' Requesting seperate presentations for selected dimensions.
:Hint: Causes series of pictures, i.e. for each selected index of the dimensions listed here a separate picture is created. Only works with line charts. Picture series must be the same length!
* (optional) Key '''"Dataset_UUID_Textbox" :''' textbox for entering the UUID of the dataset's NetCDF file.

===Block "Layer"===
A block of type Layer defines a area diagram.
The illustration in the horizontal plane (the map view) differs fundamentally
from the area charts with axes. 
Control file can contain multiple blocks of this type.
* Key '''"Name" :''' unique name of this layer and the possibility of assigning a different plot level to the diagram.
* Key '''"Layer_Dataset_Name" :''' name of the dataset to be displayed. Or a valid connexion (OPERATOR string) made out of known data sets, e. g. '''[DSet2-DSet1]/[DSet1+DSet2]''', '''ABS[DSet]''', '''SQR[DSet]''' or '''G18[DSet]'''. Constant factors in arithmetic operation possible.
* Key '''"Layer_Type" :''' type of data view of this layer.
:*'''XY_data''' = Map, or top view illustration (horizontal plane)
:*'''PZ''' = Vertical section along profile (3D data)
:*'''TZ''' = Time depth diagram (3D data)
:*'''PT''' = Hovmöller diagram variant 1: X-axis=profile axis (P), Y-axis=time axis (T).
:*'''TP''' = Hovmöller diagram variant 2: X-axis=time axis (T), Y-axis=profile axis (P).
* Key '''"Layer_Primitive_Name" :''' graphic primitive to visualize the data in the layer.
:* Parameter '''1''' = Symbolization of the layer
::*'''GPM''' = as poly marker
::*'''GPL''' = as poly line (only Layer_Type ''XY_data'')
::*'''GFA''' = as fill area
::*'''GTX''' = as text
::*'''VEC''' = as vector (only Layer_Type ''XY_data'')
:* (optional) Parameter '''2''' = Type of the vector ... optional parameter, only at VEC visualization permitted. ...allows, for example, the interpolation of the total vector from the normal component a vectorial quantity.
::*'''total''' = total vector
::*'''normal''' = normal vector
* Key '''"Layer_Primitive_Representation_Name" :''' name of the representation of the primitive.
* Key '''"Layer_Bounds_Name" :''' name of the interval definition for this layer (from the file '''''[[BOUNDS.CFG.DAT|bounds.cfg.dat]]''''').
:Hint: The number of intervals in the interval definition and the number of colors of the associated color legend must match.
* Key '''"Layer_Palette_Name" :''' name of the color legend for this layer (corresponds to the attribute ''Name'' in the file ''palette.dat''. More detailed information about palettes on file description page '''''[[PALETTES.CFG.DAT|palettes.cfg.dat]]''''').
* Key '''"Layer_Invert_Palette" :''' invertation of the color ramp.
* (optional) Key '''"Layer_Normalization_Transformation_Name" :''' name of the normalization transformation for this layer and background color if necessary.
:Hint: Required for diagram definition map view (Layer_Type ''XY_data'').
* (optional) Key '''"Layer_Area" :''' Image area spanned by the diagram axes and background color if necessary.
:Hint: Required for definitions of diagrams working with axes.
* (optional) Key '''"Layer_Extent" :''' Total area that the diagram in the picture takes up.
:Hint: Required for definitions of diagrams working with axes.
* (optional) Key '''"Layer_X-Axis" :''' X-axis of the diagram and its positioning.
:Hint: Required for definitions of diagrams working with axes.
* (optional) Key '''"Layer_Y-Axis" :''' Y-axis of the diagram and its positioning.
:Hint: Required for definitions of diagrams working with axes.
* (optional) Key '''"Layer_Legend_Plot_Area" :''' image area for the color legend of this layer. Depending on the space, the color legend can be applied horizontally or vertically.
* (optional) Key '''"Layer_Legend_Label_Switch" :''' Switch list for switching off or positioning labels of the color legend.
* (optional) Key '''"Layer_Data_Description_Name" :''' name of the '''''Data_Description''''' text box, which should collects up the data description (e.g. indication of the time) of this layer.
* (optional) Key '''"Layer_Display_Units" :''' physical unit in which the data should be converted for the graphical presentation.
:Hints: The original unit of the data and the target unit must be known in the configuration file '''''phydef.cfg.si.dat'''''. In addition, the SI-base (dimension) of the units must be identical.
* (optional) Key '''"Layer_Display_Name" :''' name of physical quantity, will be used instead of the original name given in the input data set. Without this line the name in PHYDEF is used, if the variable owns the attribute '''''name_id'''''.. Dynamic text parts can be realized with special placeholders:
:*<LAY_DSET> will be replaced by the name of the dataset associated with the layer.
:*<LAY_DIM1> will be replaced by the info text for the 1st dimension of the displayed data set.
:*<LAY_DIM2> will be replaced by the info text for the 2nd dimension of the displayed data set.
:*<LAY_DIM?> etc. to the number of data set dimensions.
* (optional) Key '''"Layer_Vector_Legend_Plot_Area" :''' image area for the vector legend in case of arrows with length_type proportional.
* (optional) Key '''"Layer_Vector_Thinout_Raster" :''' dimensions of the grid used to thin out the display of vector arrows.
* (optional) Key '''"Layer_NOBS_Filter" :''' filter for displayed data based on ''ancillary variable'' with type ''number of observations'':
** parameter 1: filter type:
*** '''EQ''' = display data only for a fixed number of observations;
*** '''LE''' = display data for a certain number of observations or less;
*** '''LE''' = display data for a certain number of observations or more.
** parameter 2: filter value:
*** '''0''' = maximum number of observations;
*** '''N''' = specified number of observations;
*** '''-M''' = maximum number of observations minus M.
* (optional) Key '''"Layer_Description_Textbox" :''' name of a textbox to be linked with the layer.
* (optional) Key '''"Layer_Route_Dataset" :''' name of a '''''dataset''''' with profile route for sorting and filtering data to be displayed.
* (optional) Key '''"Layer_Legend_Number_Format" :''' Format specification for numerical values of the color legend.
* (optional) Key '''"Layer_Draw_Heaven_Hell" :''' Visualize sky and ground surfaces in PZ or TZ diagram.
* (optional) Key '''"Layer_ASCII_Output" :''' Write data displayed in layer to text file.

===Block "Normalization_Transformation (NTN)"===
Definition of an image section and description of the link between the world and image
coordinates. 
A block of this type is only required for areal representation in the horizontal plane
(layer definition with Type == XY_Data). 
The coordinates of the drawing area, the so-called NDC space, range from [0.0,0.0] to [1.0,1.0].
For an undistorted view of the area the representation scale in the X direction must match
the scale in Y-direction (DWC / DNDC = const);
optionally also key '''"Autoscale"''' can be used for this purpose.
Distorted representations are also possible. 
* Key '''"Name" :''' unique name of this normalization transformation.
* Key '''"EPSG" :''' EPSG code of the data coordinates in the file.
* Key '''"EPSG_Window" :''' EPSG code of the plot projection.
* Key '''"Left_Lower_Window_Coordinates" :''' world coordinates (according to EPSG) the lower left corner of the projection window.
* Key '''"Right_Upper_Window_Coordinates" :''' world coordinates (according to EPSG) the upper right corner of the projection window.
* Key '''"Left_Lower_NDC_Coordinates" :''' picture coordinates (NDC within [0.0,1.0]) the lower left corner of the projection window.
* Key '''"Right_Upper_NDC_Coordinates" :''' picture coordinates (NDC within [0.0,1.0]) the upper right corner of the projection window.
* (optional) Key '''"Autoscale" :''' automatic adjustment (.true.) of scales in X- and Y-direction. Default is .false. (no adjustment).
* (optional) Key '''"Scale_Bar_Request"''' : Request drawing a scale bar. Autoscale needs to be on.
* (optional) Key '''"NTN_Framing" :''' Type of the coordinate frame when displayed as map.
:Hint: More info at '''''[[NCPLOT: Framing|Options of map frames]]'''''.

===Block "Data_Description"===
The block '''Data_Description''' defines a Data_Description object.
Such an object collects data descriptions and displays them together in a text field. 
A block of this type is currently only needed for area charts in the horizontal plane (Layer definition with Type == XY_Data). 
Control file can contain multiple blocks of this type.
* Key '''"Data_Desc_Name" :''' unique name of the text field for data descriptions.
* Key '''"Data_Desc_Plot_Area" :''' image area for the Data_Description text box.
* (optional) Key '''"Data_Desc_Draw_Frame" :''' draw a frame around the Data Description text box TRUE/FALSE.
* (optional) Key '''"Data_Desc_Color_Name" :''' name of the color for text and frame.

===Block "LineChart"===
The block '''LineChart''' is used to define a line diagram. 
A "LineChart" has only one X- and one Y-axis.
A secondary Y-axis must be realized by defining a second "LineChart" object
on the same drawing area and with the same X-axis. 
Any number of LineCharts can be stacked. The associated axes can be positioned
on all four sides of the diagram and can also be moved away from the drawing
area by different distances.
Thus, for example, on the sheet "one" time series diagram with three Y-axes
can be generated that represents the curves for flow amount, flow direction
and salinity together. 
Control file can contain multiple blocks of this type.
* Key '''"LineChart_Name" :''' unique name of the line chart and the possibility of assigning a different plot level to the diagram.
* Key '''"LineChart_Type" :''' type of line chart.
:*'''TG''' = Time series; Data over time
:*'''PG''' = Profile chart; Data over profile axis
:*'''GZ''' = Depth profile; 3D data along depth axis
* Key '''"LineChart_Area" :''' image area spanned by the diagram axes and background color if necessary.
* Key '''"LineChart_Extent" :''' total area occupied by the diagram on the image.
* Key '''"LineChart_X-Axis" :''' X-axis of the diagram and its positioning.
* Key '''"LineChart_Y-Axis" :''' Y-axis of the diagram and its positioning.
* (optional) Key '''"LineChart_Legend_Box" :''' name of a '''''Legend_Box''''', the object/area in which the curve legends of the diagram are stored and presented.
* (optional) Key '''"LineChart_Route_Dataset" :''' name of a '''''dataset''''' with profile route for sorting and filtering data to be displayed.
* (optional) Key '''"LineChart_PLR_Representation" :''' line Symbolization for the data curves of this diagram.
* (optional) Key '''"LineChart_PMR_Representation" :''' marker Symbolization for the data curves of this diagram.
* (optional) Key '''"LineChart_PLR_Palette" :''' color palette and start color for line symbols of this line chart.
* (optional) Key '''"LineChart_PMR_Palette" :''' color palette and start color for marker symbols of this line chart.
* (optional) Key '''"LineChart_FillArea_Between_Series" :''' Coloring of areas between two data series.
* (optional) Key '''"LineChart_FillArea_Series_Values" :''' Coloring of areas between a data series and a specific value.

===Block "Axis"===
The block '''Axis''' is used to define a diagram axis. 
An axis definition can be used for varius diagrams.
For example superposed "LineCharts" or several diagrams arranged
one below the other with the same time axis. 
Control file can contain multiple blocks of this type.
* Key '''"Axis_Name" :''' unique name of the axis definition.
* Key '''"Axis_Type" :''' type of axis.
:*'''T''' = time axis
:*'''G''' = axis for physical quantities
:*'''P''' = profile axis
:*'''Z''' = depth axis
* (optional) Key '''"Axis_Value_Range" :''' value range of the axis.
* (optional) Key '''"Axis_Date_Range" :''' time range of the axis.
* (optional) Key '''"Axis_Scale_Logarithmic" :''' switch logarithmic scaling LOG10 on TRUE/FALSE.
* (optional) Key '''"Axis_Invert_Profile_Route" :''' switch invert the route of a profile axis TRUE/FALSE.
* (optional) Key '''"Axis_Scale_Multiplicator" :''' multiplication factor for axis scaling.
* (optional) Key '''"Axis_Display_Name" :''' axis title, will be used instead of the original name given in the input data.
* (optional) Key '''"Axis_Display_Unit" :''' physical unit in which the data should be converted for the graphical presentation.
:Hints: The original unit of the data and the target unit must be known in the configuration file '''''phydef.cfg.si.dat'''''. In addition, the SI-base (dimension) of the units must be identical.
* (optional) Key '''"Axis_Labels_EquiDist_Value" :''' equidistant values for labeling along the axis.
* (optional) Key '''"Axis_Labels_EquiDist_Date" :''' equidistant dates for labeling along the axis.
* (optional) Key '''"Axis_Labels_at_Values" :''' list of values for labeling along the axis.
* (optional) Key '''"Axis_Labels_at_Dates" :''' list of dates for labeling along the axis.
* (optional) Key '''"Axis_Line_Representation" :''' name of a ''Poly_Line_Representation'' for the representation of the axis line.
* (optional) Key '''"Axis_Text_Representation" :''' name of a ''Text_Representation'' for the axis labeling (only influencing the font color).
* (optional) Key '''"Gitternetz_Representation" :''' name of a ''Poly_Line_Representation'' for the gridlines or switch off these lines with NONE.
* (optional) Key '''"Tickmark_Representation" :''' formatting or switching off axis tickmarks.
:* Parameter '''1''' = name of a color for the tickmarks
:* Parameter '''2''' = width of the tickmark line
:* Parameter '''3''' = length of tickmarks in image coordinates; 0.0 turn it off!
* (optional) Key '''"Axis_Additional_Line_Value" :''' draw an additional line vertical to the axis at a certain value.
* (optional) Key '''"Axis_Additional_Line_Date" :''' draw an additional line vertical to the time axis at a certain date.
* (optional) Key '''"Axis_Additional_Line_Coord" :''' draw an additional line vertical to the profile axis at a certain location.
* (optional) Key '''"Axis_Font_Size" :''' font size of the axis labeling.
* (optional) Key '''"Characters_along_Axis" :''' fixed number of characters for relative font size calculation.
* (optional) Key '''"Axis_Number_Format" :''' Format specification for numerical values of the axis scaling.

===Block "DataRow"===
The block '''DataRow''' is used to describe a data series, or a group
of data series. 
Due to the data addressing in the ''DataSet'', a ''DataRow'' description can
result in several data series.
All these data series end up in the same line diagramm. 
Blocks of this type are needed for line charts. 
Control file can contain multiple blocks of this type.
* Key '''"DataRow_Name" :''' unique name of the data row description.
* Key '''"DataRow_Dataset" :''' name of the dataset to be displayed. Or a valid connexion (OPERATOR string) made out of known data sets, e. g. '''[DSet2-DSet1]/[DSet1+DSet2]''', '''ABS[DSet]''', '''SQR[DSet]''' or '''G18[DSet]'''.
* Key '''"DataRow_LineChart" :''' name of the ''LineChart'', i.e. of the line diagram in which the data series are to be drawn.
* (optional) Key '''"DataRow_PLR_Representation" :''' line symbolization for the data curves of this data series.
* (optional) Key '''"DataRow_PMR_Representation" :''' marker symbolization for the data curves of this data series.
* (optional) Key '''"DataRow_PLR_Palette" :''' color palette and start color for line symbols of this data series.
* (optional) Key '''"DataRow_PMR_Palette" :''' color palette and start color for marker symbols of this data series.
* (optional) Key '''"DataRow_NoValue_Handling" :''' Handling invalid values in the data series.
:*'''Luecke''' = Points without data are not displayed
:*'''Interpolation''' = a straight line closes the data gap in the curve
* (optional) Key '''"DataRow_NOBS_Filter" :''' filter for displayed data based on ''ancillary variable'' with type ''number of observations'':
** parameter 1: filter type:
*** '''EQ''' = display data only for a fixed number of observations;
*** '''LE''' = display data for a certain number of observations or less;
*** '''LE''' = display data for a certain number of observations or more.
** parameter 2: filter value:
*** '''0''' = maximum number of observations;
*** '''N''' = specified number of observations;
*** '''-M''' = maximum number of observations minus M.
* (optional) Key '''"DataRow_Linked_Textbox" :''' name of a textbox to be linked with this DataRow group.
* (optional) Key '''"DataRow_Legend_Box" :''' name of a Legend_Box in which the curve legends of this DataRow group are presented.

===Block "Legend_Box"===
A legend box collects names and symbolizations of data curves and
displays them together in a text field.
A legend field can accommodate curve descriptions from different diagrams. 
A block of this type is only needed by line charts. 
Control file can contain multiple blocks of this type.
* Key '''"Legend_Box_Name" :''' unique name of the legend field.
* Key '''"Legend_Box_Plot_Area" :''' image area for the legend field.
* (optional) Key '''"Legend_Box_Color_Name" :''' colors of the legend box.
** parameter 1: for text and frame
** (optional) parameter 2: for the background
* (optional) Key '''"Legend_Box_Draw_Frame" :''' draw a frame around the legend field TRUE/FALSE.
* (optional) Key '''"Legend_Box_Frame_Style" :''' appearance of the legend box frame.
** parameter 1: line width
** (optional) parameter 2: line type
* (optional) Key '''"Legend_Box_Font_Size" :''' font size can be preset.
* (optional) Key '''"MaxCharNumber_LegendEntry" :''' fixed number of characters for relative font size calculation.
* (optional) Key '''"Legend_Box_Orientation" :''' arrangement of legend entries.
* (optional) Key '''"Legend_Box_HIDE_List" :''' legend entries of this list are NOT displayed.
* (optional) Key '''"Legend_Box_SHOW_List" :''' ONLY the legend entries of this list are shown.

===Block "Textbox"===
Description of one free text field. 
An empty text box can act as rectangular frame, with the color, type and width of the line
being adjustable. If you give the text box a background color, you can use it to cover
a particular area of the diagram. 
Control file can contain multiple blocks of this type.
* Key '''"Name" :''' unique name of the text box.
* Key '''"Plot_Area" :''' image area for the text box.
* (optional) Key '''"Text_Line" :''' one line of the text box. Specification of several lines possible. Placeholder for system information:
:*<SYS_DATE> will be replaced by current date.
:*<SYS_TIME> will be replaced by current time.
:*<SYS_USER> will be replaced by User ID.
:Placeholder for text box, which is connected to a Layer:
:*<LAY_DSET> will be replaced by the name of the dataset associated with the layer.
:*<LAY_DIM1> will be replaced by the info text for the 1st dimension of the displayed data set.
:*<LAY_DIM2> will be replaced by the info text for the 2nd dimension of the displayed data set.
:*<LAY_DIM?> etc. to the number of data set dimensions.
:Hint: Linking is realized in the layer block via KEY ''Layer_Description_Textbox''.
:Placeholder for a text box, which is connected to a DataRow block:
:*<ROW_T_DROW>, <ROW_F_DROW> will be replaced by the name of the DataRow block.
:*<ROW_T_DSET>, <ROW_F_DSET> will be replaced by the name of the dataset associated with the DataRow.
:*<ROW_T_DIM1>, <ROW_F_DIM1> will be replaced by the info text for the 1st dimension of the displayed data set.
:*<ROW_T_DIM2>, <ROW_F_DIM2> will be replaced by the info text for the 2nd dimension of the displayed data set.
:*<ROW_T_DIM?>, <ROW_F_DIM?> etc. to the number of data set dimensions.
:Hint: Linking is realized in the DataRow block via KEY ''DataRow_Linked_Textbox''.
* (optional) Key '''"Color_Name" :''' colors of the textbox.
** parameter 1: for text and frame
** (optional) parameter 2: for the background
* (optional) Key '''"Draw_Frame" :''' draw a frame around the text box TRUE/FALSE.
* (optional) Key '''"Frame_Style" :'''appearance of the text box frame.
** parameter 1: line width
** (optional) parameter 2: line type
* (optional) Key '''"Fixed_Width" :''' character-wise writing with constant width or not.
* (optional) Key '''"Horizontal_Char_Space" :''' Horizontal character distance factor for character-wise writing.
* (optional) Key '''"Vertical_Line_Space" :''' Vertical line spacing factor.
* (optional) Key '''"Font_Size" :''' font size can be preset.
* (optional) Key '''"Font_Size_Factor" :''' factor for manipulating the calculated font size.
* (optional) Key '''"MaxCharNumber_TextLine" :''' fixed number of characters for relative font size calculation.

===Block "Poly_Marker_Representation"===
Description of one type of marker symbols. 
Control file can contain multiple blocks of this type.

===Block "Fill_Area_Representation"===
Description of one type of fill area symbolization. 
Control file can contain multiple blocks of this type.

===Block "Poly_Line_Representation"===
Description of one type of line symbolization. 
Control file can contain multiple blocks of this type.

===Block "Text_Representation"===
Description of one type of text symbolization. 
Control file can contain multiple blocks of this type.

===Block "Vector_Representation"===
Description of one type of vector symbolization. 
Control file can contain multiple blocks of this type. 
Hint: More info at '''''[[NCPLOT: Types of vector symbols]]'''''.

===General Remarks===
* While reading this steering data file the '''dictionary file''' '''''ncplot_dico.dat''''' will be automatically accessed in directory '''''$PROGHOME/dic/''''' to support input.
* If no such file exists in the working directory, NCPLOT accesses the following configuration files from the directory '''''$PROGHOME/cfg/''''':
:* '''''colors.cfg.dat''''': File with definitions of colors.
:* '''''palettes.cfg.dat''''': File with references to files with color palette definitions.
:* '''''bounds.cfg.dat''''': File with interval definitions for legends. Hint: The bounds file should be better stored within a project in the working directory.
* The following '''standard configuration files''' from the directory '''''$PROGHOME/cfg/''''' are required:
:* '''gkssystem.rechnername.dat''': GKS parameter file.
:* '''phydef.cfg.si.dat''': Configuration file for units and their relation to the SI system.

|nutzerprogramme=[[NCPLOT]]
|fileform=FORMATTED
|examplefile=$PROGHOME/examples/ncplot/ncplot.dat
}}

NCPLOT.DAT

2025-01-03T12:35:31Z

Ak3spohr: syntax probs mit altem General Remarks Abschnitt

NCPLOT.DAT

2025-01-03T12:13:32Z

Ak3spohr: New with version ncplot_2024_12_20

{{FileDescription
|name_de=NCPLOT.DAT
|filetype=ncplot.dat
|version=December 2024
|version_descr=January 2025
|significance=contains general steering data for the program [[NCPLOT]].
|filecontents=

===Block "Program_Parameters"===
The block '''Program_Parameters''' contains general steering data.
* Key '''"Language" :''' Language preference for labels and texts:
:*'''DE''' = German,
:*'''EN''' = English.
* Key '''"Max_Read_Storage" :''' max. read only memory (in bytes) for analysis
* Key '''"Min_Water_Depth" :''' minimum water coverage in [m].
:Hint: The excluding of data from the presentation in case of low water coverage is only possible, if the variable to be displayed points in a certain way to a variable associated with the total water depth. The CF-NetCDF output of UnTRIM programs fulfills this requirement. The page '''''[[NCPLOT: Min_Water_Depth]]''''' illustrates the effect of this control parameter.
* (optional) Key '''"Infobox_Plot_Area" :''' Image area for the metadata infobox.
:If this image area is specified, information about the plot creation will be given to the graphic. This includes information about the underlying data files as well as if neccessary information about used data filtering.
* (optional) Key '''"PLR_Representation" :''' Default setting for line symbols of data curves in line charts.
* (optional) Key '''"PMR_Representation" :''' Default setting for marker symbols of data curves in line charts.
* (optional) Key '''"PLR_Palette" :''' Color palette and start color for line symbols of data curves in line charts.
* (optional) Key '''"PMR_Palette" :''' Color palette and start color for marker symbols of data curves in line charts.
* (optional) Key '''"Picture_Name_Fixum" :''' fixed name part for graphic file(s).
* (optional) Key '''"Phydef_Units" :''' Display physical units as in PHYDEF administration.
:Hint: Without explicit request, the units are displayed according to the BAW Rules.
* (optional) Key '''"Output_Format" :''' Output format for the generated graphics (CGM or SVG).
* (optional) Key '''"Heaven_Hell_Colors" :''' Color names for sky and ground.
* (optional) Key '''"Heaven_Hell_Contour_Style" :''' Color and line thickness of the boundary lines to the water body.

===Block "SVG_Specifications"===
Optional block with attributes for graphic output in SVG format.
* (optional) Key '''"SVG_Maximum_Size" :''' Maximum size of the SVG graphic, i.e. factor for converting NDC space from GKS to SVG space.
* (optional) Key '''"SVG_Font_Family" :''' Font family for text elements.
* (optional) Key '''"SVG_Free_Text_Attributes" :''' Font attribute(s) that are given to ALL texts of the SVG graphic.
* (optional) Key '''"SVG_Axis_Text_by_Char" :''' Write texts on diagram axes character by character (as in CGM format).
* (optional) Key '''"SVG_Legend_Box_by_Char" :''' Write legend texts of line charts character by character (as in CGM format).

===Block "Dataset"===
Description of a data set to be displayed. 
 
For addressing the data to be displayed, either the Start-Step-Stride technique
or the DimSelect method is available. The user has to choose one way or the other,
the procedures exclude each other. Each Start-Step-Stride-Addressing can be copied
by DimSelect, the other way round that is not the case.
DimSelect offers additional options for data selection, with the method
you can also realize non-equidistant index selection.
;Start-Step-Stride technique:
:For each dimension of the variable a start, step and stride value must be specified. The page '''''[[NCPLOT: Define DataSet]]''''' gives instructions for addressing the desired data.
;DimSelect method:
:DimSelect also requires the addressing of the indices for each dimension of the data variables to be displayed. But this can also happen indirectly. Various suitable selection methods are provided. The user can, for example, choose all faces by '''''DimSelect_All''''' without knowing the specific number, or pass the program via '''''DimSelect_Various_Date''''' a selection of times to be displayed. It is the responsibility of the program to find the corresponding indices. Related to data curves of line charts the DimSelect method offers a further advantage: For the individual dimensions this mimic allows to create text components for the names of the data series shown in the curve legend. 
Control file can contain multiple blocks of this type.
* Key '''"Name" :''' unique name of this data set.
* Key '''"File" :''' name of the CF-NetCDF file (*.nc) with the data to be displayed.
* Key '''"Variable" :''' Description of the data whose values are to be displayed.
:* Parameter '''1''' = name of the variable (in file of type *.nc)
:* (optional) Parameter '''2''' = role of the variable as part of a vector
::* X-component = Variable is the X component of a vector
::* Y-component = Variable is the Y component of a vector
::* normal_component = Variable is the normal component of a vector
:Hint: The command "ncdump -h <filename>.nc" shows the header of the CF-NetCDF file. The names of the offered variables and their dimensions can be found in the metadata.
* (optional) Key '''"Start" :''' start address for the data to be displayed.
* (optional) Key '''"Step" :''' number of steps for the data to be displayed.
* (optional) Key '''"Stride" :''' increment for the data to be displayed.
* (optional) Key '''"DimSelect_EquiDist_Index" :''' Equidistant selection of indices for a given dimension. Exemplary:
:* Parameter '''1''' = Name of the dimension
:* Parameter '''2''' = NONE or text component for curve legend
:* Parameter '''3''' = Index becomes part of the curve legend .true./.false.
:* Parameter '''4''' = Start Index
:* Parameter '''5''' = Index increment
:* Parameter '''6''' = Number of steps
* (optional) Key '''"DimSelect_EquiDist_Date" :''' Equidistant selection of times.
* (optional) Key '''"DimSelect_StartEnd_Index" :''' Selection of all indices from start to end index.
* (optional) Key '''"DimSelect_StartEnd_Date" :''' Selection of all times from start to end date.
* (optional) Key '''"DimSelect_Single_Index" :''' Selection of a specific index.
* (optional) Key '''"DimSelect_Single_Date" :''' Selection of a specific date.
* (optional) Key '''"DimSelect_Various_Index" :''' List of various indices.
* (optional) Key '''"DimSelect_Various_Date" :''' List of various dates.
* (optional) Key '''"DimSelect_All" :''' Selection of all indices of a dimension.
* (optional) Key '''"DimSelect_ByLabel_LabVar" :''' Determine indices with list of names by label variable.
* (optional) Key '''"DimSelect_ByLabel_List" :''' Continuation line to Key '''''DimSelect_ByLabel_LabVar'''''.
* (optional) Key '''"DimSelect_Location_Coord" :''' Selection of locations by coordinates.
* (optional) Key '''"DimSelect_LocByFile_File" :''' Selection of locations from file with locations.
* (optional) Key '''"DimSelect_LocByFile_List" :''' Continuation line to Key '''''DimSelect_LocByFile_File'''''.
* (optional) Key '''"Dimensions_for_Picture_Series" :''' Requesting seperate presentations for selected dimensions.
:Hint: Causes series of pictures, i.e. for each selected index of the dimensions listed here a separate picture is created. Only works with line charts. Picture series must be the same length!
* (optional) Key '''"Dataset_UUID_Textbox" :''' textbox for entering the UUID of the dataset's NetCDF file.

===Block "Layer"===
A block of type Layer defines a area diagram.
The illustration in the horizontal plane (the map view) differs fundamentally
from the area charts with axes. 
Control file can contain multiple blocks of this type.
* Key '''"Name" :''' unique name of this layer and the possibility of assigning a different plot level to the diagram.
* Key '''"Layer_Dataset_Name" :''' name of the dataset to be displayed. Or a valid connexion (OPERATOR string) made out of known data sets, e. g. '''[DSet2-DSet1]/[DSet1+DSet2]''', '''ABS[DSet]''', '''SQR[DSet]''' or '''G18[DSet]'''. Constant factors in arithmetic operation possible.
* Key '''"Layer_Type" :''' type of data view of this layer.
:*'''XY_data''' = Map, or top view illustration (horizontal plane)
:*'''PZ''' = Vertical section along profile (3D data)
:*'''TZ''' = Time depth diagram (3D data)
:*'''PT''' = Hovmöller diagram variant 1: X-axis=profile axis (P), Y-axis=time axis (T).
:*'''TP''' = Hovmöller diagram variant 2: X-axis=time axis (T), Y-axis=profile axis (P).
* Key '''"Layer_Primitive_Name" :''' graphic primitive to visualize the data in the layer.
:* Parameter '''1''' = Symbolization of the layer
::*'''GPM''' = as poly marker
::*'''GPL''' = as poly line (only Layer_Type ''XY_data'')
::*'''GFA''' = as fill area
::*'''GTX''' = as text
::*'''VEC''' = as vector (only Layer_Type ''XY_data'')
:* (optional) Parameter '''2''' = Type of the vector ... optional parameter, only at VEC visualization permitted. ...allows, for example, the interpolation of the total vector from the normal component a vectorial quantity.
::*'''total''' = total vector
::*'''normal''' = normal vector
* Key '''"Layer_Primitive_Representation_Name" :''' name of the representation of the primitive.
* Key '''"Layer_Bounds_Name" :''' name of the interval definition for this layer (from the file '''''[[BOUNDS.CFG.DAT|bounds.cfg.dat]]''''').
:Hint: The number of intervals in the interval definition and the number of colors of the associated color legend must match.
* Key '''"Layer_Palette_Name" :''' name of the color legend for this layer (corresponds to the attribute ''Name'' in the file ''palette.dat''. More detailed information about palettes on file description page '''''[[PALETTES.CFG.DAT|palettes.cfg.dat]]''''').
* Key '''"Layer_Invert_Palette" :''' invertation of the color ramp.
* (optional) Key '''"Layer_Normalization_Transformation_Name" :''' name of the normalization transformation for this layer and background color if necessary.
:Hint: Required for diagram definition map view (Layer_Type ''XY_data'').
* (optional) Key '''"Layer_Area" :''' Image area spanned by the diagram axes and background color if necessary.
:Hint: Required for definitions of diagrams working with axes.
* (optional) Key '''"Layer_Extent" :''' Total area that the diagram in the picture takes up.
:Hint: Required for definitions of diagrams working with axes.
* (optional) Key '''"Layer_X-Axis" :''' X-axis of the diagram and its positioning.
:Hint: Required for definitions of diagrams working with axes.
* (optional) Key '''"Layer_Y-Axis" :''' Y-axis of the diagram and its positioning.
:Hint: Required for definitions of diagrams working with axes.
* (optional) Key '''"Layer_Legend_Plot_Area" :''' image area for the color legend of this layer. Depending on the space, the color legend can be applied horizontally or vertically.
* (optional) Key '''"Layer_Legend_Label_Switch" :''' Switch list for switching off or positioning labels of the color legend.
* (optional) Key '''"Layer_Data_Description_Name" :''' name of the '''''Data_Description''''' text box, which should collects up the data description (e.g. indication of the time) of this layer.
* (optional) Key '''"Layer_Display_Units" :''' physical unit in which the data should be converted for the graphical presentation.
:Hints: The original unit of the data and the target unit must be known in the configuration file '''''phydef.cfg.si.dat'''''. In addition, the SI-base (dimension) of the units must be identical.
* (optional) Key '''"Layer_Display_Name" :''' name of physical quantity, will be used instead of the original name given in the input data set. Without this line the name in PHYDEF is used, if the variable owns the attribute '''''name_id'''''.. Dynamic text parts can be realized with special placeholders:
:*<LAY_DSET> will be replaced by the name of the dataset associated with the layer.
:*<LAY_DIM1> will be replaced by the info text for the 1st dimension of the displayed data set.
:*<LAY_DIM2> will be replaced by the info text for the 2nd dimension of the displayed data set.
:*<LAY_DIM?> etc. to the number of data set dimensions.
* (optional) Key '''"Layer_Vector_Legend_Plot_Area" :''' image area for the vector legend in case of arrows with length_type proportional.
* (optional) Key '''"Layer_Vector_Thinout_Raster" :''' dimensions of the grid used to thin out the display of vector arrows.
* (optional) Key '''"Layer_NOBS_Filter" :''' filter for displayed data based on ''ancillary variable'' with type ''number of observations'':
** parameter 1: filter type:
*** '''EQ''' = display data only for a fixed number of observations;
*** '''LE''' = display data for a certain number of observations or less;
*** '''LE''' = display data for a certain number of observations or more.
** parameter 2: filter value:
*** '''0''' = maximum number of observations;
*** '''N''' = specified number of observations;
*** '''-M''' = maximum number of observations minus M.
* (optional) Key '''"Layer_Description_Textbox" :''' name of a textbox to be linked with the layer.
* (optional) Key '''"Layer_Route_Dataset" :''' name of a '''''dataset''''' with profile route for sorting and filtering data to be displayed.
* (optional) Key '''"Layer_Legend_Number_Format" :''' Format specification for numerical values of the color legend.
* (optional) Key '''"Layer_Draw_Heaven_Hell" :''' Visualize sky and ground surfaces in PZ or TZ diagram.
* (optional) Key '''"Layer_ASCII_Output" :''' Write data displayed in layer to text file.

===Block "Normalization_Transformation (NTN)"===
Definition of an image section and description of the link between the world and image
coordinates. 
A block of this type is only required for areal representation in the horizontal plane
(layer definition with Type == XY_Data). 
The coordinates of the drawing area, the so-called NDC space, range from [0.0,0.0] to [1.0,1.0].
For an undistorted view of the area the representation scale in the X direction must match
the scale in Y-direction (DWC / DNDC = const);
optionally also key '''"Autoscale"''' can be used for this purpose.
Distorted representations are also possible. 
* Key '''"Name" :''' unique name of this normalization transformation.
* Key '''"EPSG" :''' EPSG code of the data coordinates in the file.
* Key '''"EPSG_Window" :''' EPSG code of the plot projection.
* Key '''"Left_Lower_Window_Coordinates" :''' world coordinates (according to EPSG) the lower left corner of the projection window.
* Key '''"Right_Upper_Window_Coordinates" :''' world coordinates (according to EPSG) the upper right corner of the projection window.
* Key '''"Left_Lower_NDC_Coordinates" :''' picture coordinates (NDC within [0.0,1.0]) the lower left corner of the projection window.
* Key '''"Right_Upper_NDC_Coordinates" :''' picture coordinates (NDC within [0.0,1.0]) the upper right corner of the projection window.
* (optional) Key '''"Autoscale" :''' automatic adjustment (.true.) of scales in X- and Y-direction. Default is .false. (no adjustment).
* (optional) Key '''"Scale_Bar_Request"''' : Request drawing a scale bar. Autoscale needs to be on.
* (optional) Key '''"NTN_Framing" :''' Type of the coordinate frame when displayed as map.
:Hint: More info at '''''[[NCPLOT: Framing|Options of map frames]]'''''.

===Block "Data_Description"===
The block '''Data_Description''' defines a Data_Description object.
Such an object collects data descriptions and displays them together in a text field. 
A block of this type is currently only needed for area charts in the horizontal plane (Layer definition with Type == XY_Data). 
Control file can contain multiple blocks of this type.
* Key '''"Data_Desc_Name" :''' unique name of the text field for data descriptions.
* Key '''"Data_Desc_Plot_Area" :''' image area for the Data_Description text box.
* (optional) Key '''"Data_Desc_Draw_Frame" :''' draw a frame around the Data Description text box TRUE/FALSE.
* (optional) Key '''"Data_Desc_Color_Name" :''' name of the color for text and frame.

===Block "LineChart"===
The block '''LineChart''' is used to define a line diagram. 
A "LineChart" has only one X- and one Y-axis.
A secondary Y-axis must be realized by defining a second "LineChart" object
on the same drawing area and with the same X-axis. 
Any number of LineCharts can be stacked. The associated axes can be positioned
on all four sides of the diagram and can also be moved away from the drawing
area by different distances.
Thus, for example, on the sheet "one" time series diagram with three Y-axes
can be generated that represents the curves for flow amount, flow direction
and salinity together. 
Control file can contain multiple blocks of this type.
* Key '''"LineChart_Name" :''' unique name of the line chart and the possibility of assigning a different plot level to the diagram.
* Key '''"LineChart_Type" :''' type of line chart.
:*'''TG''' = Time series; Data over time
:*'''PG''' = Profile chart; Data over profile axis
:*'''GZ''' = Depth profile; 3D data along depth axis
* Key '''"LineChart_Area" :''' image area spanned by the diagram axes and background color if necessary.
* Key '''"LineChart_Extent" :''' total area occupied by the diagram on the image.
* Key '''"LineChart_X-Axis" :''' X-axis of the diagram and its positioning.
* Key '''"LineChart_Y-Axis" :''' Y-axis of the diagram and its positioning.
* (optional) Key '''"LineChart_Legend_Box" :''' name of a '''''Legend_Box''''', the object/area in which the curve legends of the diagram are stored and presented.
* (optional) Key '''"LineChart_Route_Dataset" :''' name of a '''''dataset''''' with profile route for sorting and filtering data to be displayed.
* (optional) Key '''"LineChart_PLR_Representation" :''' line Symbolization for the data curves of this diagram.
* (optional) Key '''"LineChart_PMR_Representation" :''' marker Symbolization for the data curves of this diagram.
* (optional) Key '''"LineChart_PLR_Palette" :''' color palette and start color for line symbols of this line chart.
* (optional) Key '''"LineChart_PMR_Palette" :''' color palette and start color for marker symbols of this line chart.
* (optional) Key '''"LineChart_FillArea_Between_Series" :''' Coloring of areas between two data series.
* (optional) Key '''"LineChart_FillArea_Series_Values" :''' Coloring of areas between a data series and a specific value.

===Block "Axis"===
The block '''Axis''' is used to define a diagram axis. 
An axis definition can be used for varius diagrams.
For example superposed "LineCharts" or several diagrams arranged
one below the other with the same time axis. 
Control file can contain multiple blocks of this type.
* Key '''"Axis_Name" :''' unique name of the axis definition.
* Key '''"Axis_Type" :''' type of axis.
:*'''T''' = time axis
:*'''G''' = axis for physical quantities
:*'''P''' = profile axis
:*'''Z''' = depth axis
* (optional) Key '''"Axis_Value_Range" :''' value range of the axis.
* (optional) Key '''"Axis_Date_Range" :''' time range of the axis.
* (optional) Key '''"Axis_Scale_Logarithmic" :''' switch logarithmic scaling LOG10 on TRUE/FALSE.
* (optional) Key '''"Axis_Invert_Profile_Route" :''' switch invert the route of a profile axis TRUE/FALSE.
* (optional) Key '''"Axis_Scale_Multiplicator" :''' multiplication factor for axis scaling.
* (optional) Key '''"Axis_Display_Name" :''' axis title, will be used instead of the original name given in the input data.
* (optional) Key '''"Axis_Display_Unit" :''' physical unit in which the data should be converted for the graphical presentation.
:Hints: The original unit of the data and the target unit must be known in the configuration file '''''phydef.cfg.si.dat'''''. In addition, the SI-base (dimension) of the units must be identical.
* (optional) Key '''"Axis_Labels_EquiDist_Value" :''' equidistant values for labeling along the axis.
* (optional) Key '''"Axis_Labels_EquiDist_Date" :''' equidistant dates for labeling along the axis.
* (optional) Key '''"Axis_Labels_at_Values" :''' list of values for labeling along the axis.
* (optional) Key '''"Axis_Labels_at_Dates" :''' list of dates for labeling along the axis.
* (optional) Key '''"Axis_Line_Representation" :''' name of a ''Poly_Line_Representation'' for the representation of the axis line.
* (optional) Key '''"Axis_Text_Representation" :''' name of a ''Text_Representation'' for the axis labeling (only influencing the font color).
* (optional) Key '''"Gitternetz_Representation" :''' name of a ''Poly_Line_Representation'' for the gridlines or switch off these lines with NONE.
* (optional) Key '''"Tickmark_Representation" :''' formatting or switching off axis tickmarks.
:* Parameter '''1''' = name of a color for the tickmarks
:* Parameter '''2''' = width of the tickmark line
:* Parameter '''3''' = length of tickmarks in image coordinates; 0.0 turn it off!
* (optional) Key '''"Axis_Additional_Line_Value" :''' draw an additional line vertical to the axis at a certain value.
* (optional) Key '''"Axis_Additional_Line_Date" :''' draw an additional line vertical to the time axis at a certain date.
* (optional) Key '''"Axis_Additional_Line_Coord" :''' draw an additional line vertical to the profile axis at a certain location.
* (optional) Key '''"Axis_Font_Size" :''' font size of the axis labeling.
* (optional) Key '''"Characters_along_Axis" :''' fixed number of characters for relative font size calculation.
* (optional) Key '''"Axis_Number_Format" :''' Format specification for numerical values of the axis scaling.

===Block "DataRow"===
The block '''DataRow''' is used to describe a data series, or a group
of data series. 
Due to the data addressing in the ''DataSet'', a ''DataRow'' description can
result in several data series.
All these data series end up in the same line diagramm. 
Blocks of this type are needed for line charts. 
Control file can contain multiple blocks of this type.
* Key '''"DataRow_Name" :''' unique name of the data row description.
* Key '''"DataRow_Dataset" :''' name of the dataset to be displayed. Or a valid connexion (OPERATOR string) made out of known data sets, e. g. '''[DSet2-DSet1]/[DSet1+DSet2]''', '''ABS[DSet]''', '''SQR[DSet]''' or '''G18[DSet]'''.
* Key '''"DataRow_LineChart" :''' name of the ''LineChart'', i.e. of the line diagram in which the data series are to be drawn.
* (optional) Key '''"DataRow_PLR_Representation" :''' line symbolization for the data curves of this data series.
* (optional) Key '''"DataRow_PMR_Representation" :''' marker symbolization for the data curves of this data series.
* (optional) Key '''"DataRow_PLR_Palette" :''' color palette and start color for line symbols of this data series.
* (optional) Key '''"DataRow_PMR_Palette" :''' color palette and start color for marker symbols of this data series.
* (optional) Key '''"DataRow_NoValue_Handling" :''' Handling invalid values in the data series.
:*'''Luecke''' = Points without data are not displayed
:*'''Interpolation''' = a straight line closes the data gap in the curve
* (optional) Key '''"DataRow_NOBS_Filter" :''' filter for displayed data based on ''ancillary variable'' with type ''number of observations'':
** parameter 1: filter type:
*** '''EQ''' = display data only for a fixed number of observations;
*** '''LE''' = display data for a certain number of observations or less;
*** '''LE''' = display data for a certain number of observations or more.
** parameter 2: filter value:
*** '''0''' = maximum number of observations;
*** '''N''' = specified number of observations;
*** '''-M''' = maximum number of observations minus M.
* (optional) Key '''"DataRow_Linked_Textbox" :''' name of a textbox to be linked with this DataRow group.
* (optional) Key '''"DataRow_Legend_Box" :''' name of a Legend_Box in which the curve legends of this DataRow group are presented.

===Block "Legend_Box"===
A legend box collects names and symbolizations of data curves and
displays them together in a text field.
A legend field can accommodate curve descriptions from different diagrams. 
A block of this type is only needed by line charts. 
Control file can contain multiple blocks of this type.
* Key '''"Legend_Box_Name" :''' unique name of the legend field.
* Key '''"Legend_Box_Plot_Area" :''' image area for the legend field.
* (optional) Key '''"Legend_Box_Color_Name" :''' colors of the legend box.
** parameter 1: for text and frame
** (optional) parameter 2: for the background
* (optional) Key '''"Legend_Box_Draw_Frame" :''' draw a frame around the legend field TRUE/FALSE.
* (optional) Key '''"Legend_Box_Frame_Style" :''' appearance of the legend box frame.
** parameter 1: line width
** (optional) parameter 2: line type
* (optional) Key '''"Legend_Box_Font_Size" :''' font size can be preset.
* (optional) Key '''"MaxCharNumber_LegendEntry" :''' fixed number of characters for relative font size calculation.
* (optional) Key '''"Legend_Box_Orientation" :''' arrangement of legend entries.
* (optional) Key '''"Legend_Box_HIDE_List" :''' legend entries of this list are NOT displayed.
* (optional) Key '''"Legend_Box_SHOW_List" :''' ONLY the legend entries of this list are shown.

===Block "Textbox"===
Description of one free text field. 
An empty text box can act as rectangular frame, with the color, type and width of the line
being adjustable. If you give the text box a background color, you can use it to cover
a particular area of the diagram. 
Control file can contain multiple blocks of this type.
* Key '''"Name" :''' unique name of the text box.
* Key '''"Plot_Area" :''' image area for the text box.
* (optional) Key '''"Text_Line" :''' one line of the text box. Specification of several lines possible. Placeholder for system information:
:*<SYS_DATE> will be replaced by current date.
:*<SYS_TIME> will be replaced by current time.
:*<SYS_USER> will be replaced by User ID.
:Placeholder for text box, which is connected to a Layer:
:*<LAY_DSET> will be replaced by the name of the dataset associated with the layer.
:*<LAY_DIM1> will be replaced by the info text for the 1st dimension of the displayed data set.
:*<LAY_DIM2> will be replaced by the info text for the 2nd dimension of the displayed data set.
:*<LAY_DIM?> etc. to the number of data set dimensions.
:Hint: Linking is realized in the layer block via KEY ''Layer_Description_Textbox''.
:Placeholder for a text box, which is connected to a DataRow block:
:*<ROW_T_DROW>, <ROW_F_DROW> will be replaced by the name of the DataRow block.
:*<ROW_T_DSET>, <ROW_F_DSET> will be replaced by the name of the dataset associated with the DataRow.
:*<ROW_T_DIM1>, <ROW_F_DIM1> will be replaced by the info text for the 1st dimension of the displayed data set.
:*<ROW_T_DIM2>, <ROW_F_DIM2> will be replaced by the info text for the 2nd dimension of the displayed data set.
:*<ROW_T_DIM?>, <ROW_F_DIM?> etc. to the number of data set dimensions.
:Hint: Linking is realized in the DataRow block via KEY ''DataRow_Linked_Textbox''.
* (optional) Key '''"Color_Name" :''' colors of the textbox.
** parameter 1: for text and frame
** (optional) parameter 2: for the background
* (optional) Key '''"Draw_Frame" :''' draw a frame around the text box TRUE/FALSE.
* (optional) Key '''"Frame_Style" :'''appearance of the text box frame.
** parameter 1: line width
** (optional) parameter 2: line type
* (optional) Key '''"Fixed_Width" :''' character-wise writing with constant width or not.
* (optional) Key '''"Horizontal_Char_Space" :''' Horizontal character distance factor for character-wise writing.
* (optional) Key '''"Vertical_Line_Space" :''' Vertical line spacing factor.
* (optional) Key '''"Font_Size" :''' font size can be preset.
* (optional) Key '''"Font_Size_Factor" :''' factor for manipulating the calculated font size.
* (optional) Key '''"MaxCharNumber_TextLine" :''' fixed number of characters for relative font size calculation.

===Block "Poly_Marker_Representation"===
Description of one type of marker symbols. 
Control file can contain multiple blocks of this type.

===Block "Fill_Area_Representation"===
Description of one type of fill area symbolization. 
Control file can contain multiple blocks of this type.

===Block "Poly_Line_Representation"===
Description of one type of line symbolization. 
Control file can contain multiple blocks of this type.

===Block "Text_Representation"===
Description of one type of text symbolization. 
Control file can contain multiple blocks of this type.

===Block "Vector_Representation"===
Description of one type of vector symbolization. 
Control file can contain multiple blocks of this type. 
Hint: More info at '''''[[NCPLOT: Types of vector symbols]]'''''.

|nutzerprogramme=[[NCPLOT]]
|fileform=FORMATTED
|examplefile=$PROGHOME/examples/ncplot/ncplot.dat
}}

NCPLOT

2025-01-02T16:13:56Z

Ak3spohr: Version angepasst

{{ProgramDescription
|name_de=NCPLOT
|name=NCPLOT
|version=December 2024
|version_descr=September 2022
|catchwords=graphical postprocessor 
graphical presentation of CF NetCDF data (unknown attributes are ignored) 
finite element models 
finite difference models 
orthogonal unstructured grid model 
orthogonal unstructured grid model with subgrid information 
conversion or transformation (extensive - intensive) of physical units 
calculation of new quantities (for display) from one or several input data sets 
(optional) filter based on water depth 
(optional) filter based on number of observations 

Acknowledgment: ''This project took advantage of netCDF software developed by UCAR/Unidata ([http://www.unidata.ucar.edu/software/netcdf/ www.unidata.ucar.edu/software/netcdf/]).''

|shortdescription=
The graphical postprocessor NCPLOT can be used for a graphical presentation
of simulation and analysis results, which is stored in CF NetCDF data format.
The data can be defined on nodes, edges or faces. The program works on 2D-data,
3D-data and on data with details scaled on a subgrid. 
[[File:NcplotBspFaceArea.png|thumb|250px|Picture 1: Salinity with underlaid topography.]]

The sample pictures illustrate the capability of the program NCPLOT. 
[[NCPLOT: Example figures|Example figures: NCPLOT]]

Basically, NCPLOT distinguishes linear from areal chart types.
For area charts the symbolization of the data is depending on the data value
(color legend, proportional arrow).
For linear charts, the values of data series are plotted on an axis.
The symbolization of the data series is independent of the data value.
 

[[NCPLOT: Area Charts|Area Charts]]:
* Map, or top view illustration
* Vertical section along profile (3D data)
* Time depth diagram (3D data)
* Hovmöller diagram: Temporal development along profile.
 
[[NCPLOT: Line Charts|Line Charts]]: 
* time series
* profile view
* depth profile
 
NCPLOT allows you to illustrate different diagrams of different types in one picture.
Line diagrams next to areal charts with static and possibly dynamic parts.
 

Picture series: 
Both line and area chart definitions can request the creation of picture series.
A picture can contain static and dynamic image components.
Dynamic components means parts of the image that vary over a picture series.
 

The following rule applies to the program: 
The first read dynamic definition determines the permitted length of the
picture series.
The program aborts, if a further dynamic diagram definition results a
different number of images.
 

Further tests are not carried out.
 

Different series diagrams from dynamic diagram definitions of the same
length are processed by the program. The static picture elements are displayed
on every picture in the series.
 

|inputfiles=
# '''general input data''' (file type [[NCPLOT.DAT|ncplot.dat]])
# '''result files''' (file type [[CF-NETCDF.NC]])
# file with '''interval definitions''' for color legends (file type [[BOUNDS.CFG.DAT|bounds.cfg.dat]]) Hint: (Recommended) Local configuration file or file from the directory ''$PROGHOME/cfg/''.
# file with '''list of definitions of palettes''' (file type [[PALETTES.CFG.DAT|palettes.cfg.dat]]) Hint: (Recommended) Provided file from the directory ''$PROGHOME/cfg/'' or local configuration file.
# file with '''definitions of colors''' (file type [[COLORS.CFG.DAT|colors.cfg.dat]]) Hint: (Recommended) Provided file from the directory ''$PROGHOME/cfg/'' or local configuration file.

For NCPLOT the following standard configuration files from the directory '''''$PROGHOME/cfg/''''' are required:
* GKS parameter file: '''gkssystem.computername.dat'''

|outputfiles=
# '''graphic files''' (format: CGM or SVG)
# (optional) informative '''printer file''' of program execution (file type ncplot.sdr)
# (optional) '''trace''' of program execution (file type ncplot.trc)

|methodology=
NCPLOT is a pure plot program without any user interaction at runtime.
The layout of the picture and the graphical presentation of the data has to be
described in the steering file.
 

NCPLOT creates vector graphics in CGM or SVG format.
 

For special data files it is possible to exclude data at places with low water
coverage from the display. The technic works only on original UnTRIM result files
in CF NetCDF format.
 

Just in case '''HDF error''' is detected during read of a data record,
the program tries to reconstruct the wanted data set from adjacent (in time)
records for the same variable.
This type of repair works for time dependent variables only.
 

|preprocessor=[[BOE2NC]], [[DATACONVERT]], [[GRIDCONVERT]], [[NCAGGREGATE]], [[NCANALYSE]], [[NCCUTOUT]], [[NCDELTA]], [[NCDVAR]], [[NCMERGE]], [[UNK]], [[UNTRIM2007]], [[UNTRIM2]]
|postprocessor=---
|language=Fortran95
|add_software=GKS (by GTS-Gral)
|contact_original=G. Lang, S. Spohr
|contact_maintenance=[mailto:pos.proghome@baw.de Working group POS]
|documentation=
template files available in '''$PROGHOME/examples/ncplot'''
}}

NC2TABLE.DAT

2024-05-21T15:19:16Z

Ak3spohr: update version

{{FileDescription
|name_de=NC2TABLE.DAT
|filetype=nc2table.dat
|version=October 2024
|version_descr=October 2017
|significance=contains general steering data for the program [[NC2TABLE]].
|filecontents=
'''steering data'''

* Block '''Program_Parameters''': general steering data
*# '''ASCII_Output_Format''': format for output file(s)
*## ''csv'' : [[NC2TABLE.CSV|nc2table.csv]], store results in [https://en.wikipedia.org/wiki/Comma-separated_values CSV format]
*# '''Max_Read_Storage''': maximum number of data values stored in one READ cycle.
*# (optional) '''Create_Missing_Variables''': enable automatic creation of missing variables, e. g. for D-Flow FM result files.
*## ''0'' : disabled (Default);
*## ''1'' : enabled.
*# (optional) '''Fortran_Format''': Fortran-Format, e.g. '''F10.3'''.
*## In case this key is specified, this value will be used as default for all output variables.
*## In case this key is not specified, program default '''G15.8''' will be used.
*## Only valid formats defined in nc2table_dico.dat are allowed to be used.
*# (optional) '''Min_Water_Depth''': minimum water coverage in [m], up to which data values are considered being valid.
*## In case this key is specified, this value will be used as default for all output variables.
*## In case this key is not specified, program default 0.0 will be applied.
*## Works only for variables which have an auxiliary variable of type ''total water depth''.
*# (optional) '''NOBS_Filter''': description of ''filter type'' and ''filter value''.
*## ''filter type'':
*### ''EQ'' : results will be only shown as long as the number of observations are identical to a prescribed value.
*### ''LE'' : results will be only shown when the number of observations is less or equal to a prescribed value.
*### ''GE'' : results will be only shown when the number of observations is greater or equal to a prescribed value.
*## ''filter value'':
*### ''N'' : 0 := maximum number of observations; N := number of observations N; -M := maximum number of observations minus M.
*## In case this key is specified, this filter will be used as default for all output variables..
*## In case this key is not specified, program default ''no filter'' will be used.
*## Works only for variables which have an auxiliary variable of type ''number of observations''.
*# (optional) '''Undefined_String'''
*## In case this key is specified, this value will be used as default for all output variables.
*## In case this key is not specified, program default ''--undefined-'' will be used.
*# (optional) '''Date_Time_Format''': string definition for date and time output format.
*## In case this key is not specified, program default ISO8601 (see [https://en.wikipedia.org/wiki/ISO_8601 ISO 8601]) will be used.
*## 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 <nowiki>''.'', '':'', ''-'' or '' ''</nowiki>.
*##: examples: YYYY-MM-DD hh:mm:ss ; YYYY-MM-DD hh:mm:ss.nnn ZZZZ.
*# (optional) '''Time_Diff_Format''': string definition for time differences output format.
*## In case this key is not specified, program default ISO8601 (see [https://en.wikipedia.org/wiki/ISO_8601 ISO 8601]) will be used.
*## 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 <nowiki>''.'', '':'', ''-'' or '' ''</nowiki>.
*##: examples: Vhh:mm:ss .
*# (optional) '''Hor_Coord_Format''': Output format for (geographical) coordinates.
*## Format '''XY''': local coordinates as real numbers.
*## Format '''GEO_LON_LAT''': geographical coordinates as real number (in degree).
*## Format '''GEO_DEGREE''': geographical coordinates in degree, minute, second (and fractions of a second) plus specification of direction '''N''', '''S''', '''E''' or '''W''' (default).
*# (optional) '''Table_Datetime_Zone''': time zone used for date and time table data.
*## '''UTC''' or '''GMT''': [https://en.wikipedia.org/wiki/Coordinated_Universal_Time ''Universal Time Coordinated''] (Default);
*## '''CET''' or '''MEZ''': [https://www.timeanddate.com/time/zones/cet ''Central European Time''];
*## '''CEST''' or '''MESZ''': [https://www.timeanddate.com/time/zones/cest ''Central European Summer Time''].
* Block '''Input_Variable_Info''' (IVI): informations about variables (can be specified more than once)
*# '''Name''': short name.
*## In case several IVI blocks are specified, ''Name'' must be unique.
*## In case several IVIs are extracted to one table ''Name'' is used as column/row header.
*# '''File''': file name and file type
*## name of file from which data shall be extracted, type [[CF-NETCDF.NC|cf-netcdf.nc]].
*## file type ''NETCDF''.
*# '''Variable''': name of variable to be extracted. Must be contained in '''File'''.
*# (optional) '''Fortran_Format''': Fortran format.
*## Overrides program default or value specified in Block '''Program_Parameters''' . See block '''Program_Parameters'''.
*## For variables with time, special format ''TI'' may be specified. In this case '''Date_Time_Format''' will be used for output.
*## For variables with time differences (periods), special format ''DT'' may be specified. In this case '''Time_Diff_Format''' will be used for output.
*# (optional) '''Display_Unit''': physical unit to be used during data extraction.
*## Must be known in $PROGHOME/cfg/phydef.cfg.si.dat.
*## Actually transformation is only supported in case the SI base doesn't change, e.g. from ''m'' to ''cm''.
*## In case this key is missing, original variable units are used.
*# '''Min_Water_Depth''': minimum water coverage in [m], up to which data values are considered being valid.
*## Overrides program default or value specified in block '''Program_Parameters'''. See block '''Program_Parameters'''.
*# (optional) '''NOBS_Filter''': description of ''filter type'' and ''filter value''.
*## 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)
*# '''Name''': short name.
*## In case several CSI blocks are specified, ''Name'' must be unique.
*# '''Dim_Name''': name of coordinate dimension.
*## Must be a valid dimension of variables referenced in IVI blocks.
*## For all the variables listed in IVI blocks all of their used dimensions should be specified in CSI blocks.
*## 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.
*# '''Dim_Space''': range of (coordinate) values (four different options)
*## '':'' : all values.
*## ''<startindex>:<endindex>:<schrittweite>'' : equidistant selection.
*## ''indices=<index1>,<index2>,<index3>,...,<indexN>'' : list of individual coordinate values.
*## ''names=<name1>,<name2>,<name3>,...,<nameN>'' : list of names. Must be defined in a respective label coordinate variable.
*## ''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.
*## ''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.
*## ''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.
*# '''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.
* Block '''Table_Design_Info''' (TDI): basic design of a table (can be specified more than once).
*# '''Name''': short name.
*## In case several TDI blocks are specified, ''Name'' must be unique.
*# '''First_Column_IVI''': valid ''Name'' from block '''Input_Variable_Info'''.
*## Will be used to construct the first ''column'' of a table.
*# '''First_Row_IVI''': Valid ''Name'' from block '''Input_Variable_Info'''.
*## Will be used to construct the first ''row'' of a table.
*# (optional) '''Row_CSI''': Valid ''Name'' from block '''Coordinate_Space_Info'''
*## Defines the coordinate (dimension) for the ''rows'' of the table.
*# (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===
# Dictionary file used from directory '''''$PROGHOME/dic/''''':
#* '''''nc2table_dico.dat'''''.

|nutzerprogramme=[[NC2TABLE]]
|language=Fortran90
|fileform=FORMATTED
|fileaccess=SEQUENTIAL
|fileextension=.dat
|writemodules= ---
|readmodules=$PROGHOME/fortran/prg/nc2table/*/mod_m_nc2table_steer.f90
|contact_original=[mailto:guenther.lang@baw.de G. Lang]
|contact_maintenance=[mailto:guenther.lang@baw.de G. Lang]
|examplefile=$PROGHOME/examples/nc2table/nc2table.dat
}}

NC2TABLE

2024-05-21T14:13:17Z

Ak3spohr: update version

{{ProgramDescription
|name_de=NC2TABLE
|name=NC2TABLE
|version=May 2024
|version_descr=September 2022
|catchwords=
data conversion 
postprocessor 
synoptic data sets 
[[NetCDF|CF NetCDF]] format 
[https://en.wikipedia.org/wiki/Comma-separated_values CSV format] (''comma separated values'') 
tabular data 
support of DMQS metadata and variables 
automatic adjustment of number of data READ to chunk size of input data

Acknowledgment: ''This project took advantage of netCDF software developed by UCAR/Unidata ([http://www.unidata.ucar.edu/software/netcdf/ www.unidata.ucar.edu/software/netcdf/]).''

|shortdescription=
Program NC2TABLE allows selective data extraction from [[NetCDF|CF NetCDF]] files to [https://en.wikipedia.org/wiki/Comma-separated_values CSV files].
Extracted data ares stored in tabular form and may be subsequently used in spread sheet programs like MS EXCEL.

===General Introduction===

Geophysical variables '''f_i''' stored in (netCDF) data files are typically dependent on different numbers of coordinates. According to the CF metadata standard, time and date as well as geographical location are the required minimum.

General form of a variable (function):

f = f_i(t,x[,z][,l][,c])

In the above definition, '''t''' means time, '''x''' stands for the (horizontal) location, '''z''' is either height or depth, '''l''' symbolizes a ''label'' (e. g. a sediment fraction) and '''c''' is typically representing (other) classes, e. g. for a probability distribution.

Expressions function and variable are synonymously used in the following.

===Structure of Tables===

Tables consist out of rows and columns. Tables are best suited for the following data presentations:
# '''Table Type 1''' (functional profile): The dependence of '''f_i''' on two different coordinates is displayed. The values of (optionally) present other coordinates are frozen in. Example: water level in dependence on (discrete) space '''x_m''' and (discrete) time '''t_n'''.
#:Typical combinations for axes are:
#:* Time series (Ts): '''f(t,x)''' Ts for several locations, '''f(t,z)''' Ts for several vertical layers, '''f(t,l)''' Ts for multiple sediment fractions and '''f(t,c)''' Ts for various classes (probability distribution) or frequencies (spectrum).
#:* Dependence on horizontal position: '''f(x,z)''' variation over height or depth, '''f(x,l)''' variation over sediment fractions and '''f(x,c)''' variation over classes (probability distribution) or frequencies (spectrum).
#:* Dependence on vertical position: '''f(z,l)''' variation over sediment fractions and '''f(z,c)''' variation over classes (probability distribution) or frequencies (spectrum).
#:* Other: '''f(l,c)''' probability distribution for various sediment fractions.
# '''Table Type 2''' (comparison of functions): The dependence of several functions '''f_i''', with '''i=1,n_i''', in dependence on a single coordinate can be displayed. All other coordinate values remain frozen in. Example: time series of water level, current velocity and salinity for a specific location.

Program NC2TABLE supports both above mentioned types of tables. For date and time data items the time zone used can be
selected via file [[NC2TABLE.DAT|nc2table.dat]].

|inputfiles=
# '''general input data''' (file type [[NC2TABLE.DAT|nc2table.dat]]);
# '''geophysical data''' (file type [[CF-NETCDF.NC|cf-netcdf.nc]]).

|outputfiles=
# '''ASCII tables''' (file type [[NC2TABLE.CSV|nc2table.csv]]) in [https://en.wikipedia.org/wiki/Comma-separated_values CSV file format];
# '''Metadata''' (filetype nc2table.txt) in readable form (text file);
# (optional) informative '''printer file''' of program execution (file type nc2table.sdr)
# (optional) '''trace''' of program execution (file type nc2table.trc)

|methodology=
Binary data are extracted an printed in tabular form according to the user requirements.

Just in case '''HDF error''' is detected during read of a data record, the program tries to reconstruct the wanted data set from adjacent (in time) records for the same variable. This type of repair works for time dependent variables only.

|preprocessor=[[DATACONVERT]], [[GRIDCONVERT]], [[NCAGGREGATE]], [[NCANALYSE]], [[NCCHUNKIE]], [[NCCUTOUT]], [[NCDELTA]], [[NCDVAR]], [[NCMERGE]], [[UNTRIM2007]], [[UNTRIM2]]
|postprocessor=spread sheet program, text editor
|language=Fortran95
|add_software=---
|contact_original=G. Lang
|contact_maintenance=[mailto:pos.proghome@baw.de Working group POS]
|documentation=
template files available in '''$PROGHOME/examples/nc2table'''
}}

NCMERGE

2024-03-12T13:04:02Z

Ak3spohr: update version date

{{ProgramDescription
|name_de=NCMERGE
|name=NCMERGE
|version=March 2024
|version_descr=September 2022
|catchwords=
postprocessor 
Merge contents of various [[CF-NETCDF.NC|netcdf.nc]] files 
Change of time step for optional time-equidistant data records 
Storage of the content of the ASCII input control files in [[CF-NETCDF.NC|netcdf.nc]] (as a variable) 
Storage of the [https://en.wikipedia.org/wiki/MD5 MD5 hash] values of input files in [[CF-NETCDF.NC|netcdf.nc]] (as a variable) 
optional use of ''Message Passing Interface'' (MPI, [https://www.mpi-forum.org/ MPI Forum])

Acknowledgment: ''This project took advantage of netCDF software developed by UCAR/Unidata ([http://www.unidata.ucar.edu/software/netcdf/ www.unidata.ucar.edu/software/netcdf/]).''

|shortdescription=
The program enables merging variables from multiple [[CF-NETCDF.NC|netcdf.nc]] input files into one single [[CF-NETCDF.NC|netcdf.nc]] output file.

|inputfiles=
# '''general input data''' (file type [[NCMERGE.DAT|ncmerge.dat]]);
# '''Input data''', multiple files (file type [[CF-NETCDF.NC|cf-netcdf.nc]]).

|outputfiles=
# '''Output data''' (file type [[CF-NETCDF.NC|netcdf.nc]])
# (optional) informative '''printer file''' of program execution (file type ncmerge.sdr)
# (optional) '''trace''' of program execution (file type ncmerge.trc)

|methodology=
The program is subdivided into the following sections:
# Read, check and print the control data of the user;
# Read metadata of the input data;
# Transfer metadata into internal data objects;
# Classification of all variables of the input files;
# Determine transfer operations for primary variables;
# Determine transfer operations for all other variables;
# Comparison of the input data specified by the user with the data available in the input file;
# Create common time coordinate variables for all output variables;
# (optional) Adjustment of MD5 hash values between all input data files;
# Copy the variables to be transferred from the input files to the output file.

|preprocessor=[[DATACONVERT]], [[BOE2NC]], [[NCAGGREGATE]], [[NCCHUNKIE]], [[NCCUTOUT]], [[NCRCATMAT]], [[NetCDF Operators]], [[UNK]], [[UNTRIM2007]], [[UNTRIM2]]
|postprocessor=[[DAVIT]], [[NCAUTO]], [[NCAGGREGATE]], [[NCANALYSE]], [[NCCHUNKIE]], [[NCCUTOUT]], [[NCPLOT]], [[NCPOLO]], [[NC2TABLE]], [[UNK]], [[UNTRIM2007]], [[UNTRIM2]]
|language=Fortran95
|add_software=none
|contact_original=G. Lang, S. Spohr
|contact_maintenance=[mailto:pos.proghome@baw.de Working group POS]
|documentation=
* [https://izw-campus.baw.de/ ''IZW-Campus''] (Podcast, available in German only)
** 2022-02-14: [https://izw-campus.baw.de/goto.php?target=cat_3742&client_id=iliasclient ''NCMERGE - Anwendung, Struktur, Code-Beispiele''].
* Template Files:
** template files available in '''$PROGHOME/examples/ncmerge'''
}}

NCMERGE.DAT

2024-03-12T13:03:34Z

Ak3spohr: update version date

{{FileDescription
|name_de=NCMERGE.DAT
|filetype=ncmerge.dat
|version=March 2024
|version_descr=January 2022
|significance=contains general steering data for the program [[NCMERGE]].
|filecontents=
'''steering data'''

* Block '''Program_Parameters''': general steering data
*# '''Max_Read_Storage''': Maximum number of data values that can be read for each input variable in a read-write cycle. Default = 125000000.
*# (optional) '''Create_Missing_Variables''': Generate additional variables
*#* 0 = do not create additional variables (default)
*#* 1 = generate additional variables (in combination with DFlow FM)
*# (optional) '''NC_Deflate_Level''': Compression of the result data
*#* 0 = no compression
*#* 1 ... 8 = compression (default = 3)
*#* 9 = maximum compression
*# (optional) '''END_After_Define''': Abort after generating the metadata of the output file
*#* .false. = Program runs through to the end (default)
*#* .true. = Program ends after definition of the result file (metadata)
* (optional) Block '''Hash_Identity_Checks''': inter-comparison of [https://de.wikipedia.org/wiki/Message-Digest_Algorithm_5 MD5-Hash] values
*# '''Check_MD5'''
*#* Name of MD5 hash variable to be compared;
*#* Descriptor for file to be compared;
*#* Requirement for compliance
*#** '''STRICT''' (exact),
*#** '''WARNING''' (Warning in case of differences)
:::''Remark:'' the same MD5 hash variable must be present in all input NetCDF files.
* Block '''Input_Files''': input files
*# '''Data_File''': Name and type of the input file (file of type [[CF-NETCDF.NC|netcdf.nc]])
:::- at least two files must be prescribed
:::- files must exist
:::''Remark:'' Following file type several optional key-value pairs can be added
:::- '''TA'''=DD.MM.YYYY-hh:mm:ss start time
:::- '''TE'''=DD.MM.YYYY-hh:mm:ss end time
:::- '''TZ'''=UTC MEZ MESZ ... time zone
:::- '''DT'''=dddddd-hh:mm:ss output time step
* Block '''Output_File''': output file
*# '''Data_File''' Name and type of the output file (file of type [[CF-NETCDF.NC|netcdf.nc]])
:::- file must not exist

===General Remarks===
# Used '''dictionary files''' from directory '''''$PROGHOME/dic/''''':
#* '''''ncmerge_dico.dat'''''.

|nutzerprogramme=[[NCMERGE]]
|language=Fortran95
|fileform=FORMATTED
|fileaccess=SEQUENTIAL
|fileextension=.dat
|writemodules= ---
|readmodules=$PROGHOME/fortran/prg/ncmerge/*/mod_m_ncmerge_steer.f90
|contact_original=[mailto:guenther.lang@baw.de G. Lang]
|contact_maintenance=[mailto:guenther.lang@baw.de G. Lang], [mailto:susanne.spohr@baw.de S. Spohr]
|examplefile=$PROGHOME/examples/ncmerge/ncmerge.dat
}}

NCDVAR

2023-05-17T10:11:37Z

Ak3spohr:

{{ProgramDescription
|name_de=NCDVAR
|name=NCDVAR
|version=May 2023
|version_descr=September 2022
|catchwords=
postprocessor 
Selective deletion or copying of variables in a [[CF-NETCDF.NC|netcdf.nc]] file 
Delete/Copy coordinate variables of a certain type (X-Y or LON-LAT) 
Delete/Copy variables belonging to a grid (''Mesh'') 
Delete/Copy of individual variables 
Deletion/Copying of individuual dates of synoptic, time-equidistant data records 
Automatic setting of the WRITE chunk size 
Storage of the content of the ASCII input control files in [[CF-NETCDF.NC|netcdf.nc]] (as a variable) 
Storage of the [https://en.wikipedia.org/wiki/MD5 MD5 hash] values of input files in [[CF-NETCDF.NC|netcdf.nc]] (as a variable) 
optional use of ''Message Passing Interface'' (MPI, [https://www.mpi-forum.org/ MPI Forum])

Acknowledgment: ''This project took advantage of netCDF software developed by UCAR/Unidata ([http://www.unidata.ucar.edu/software/netcdf/ www.unidata.ucar.edu/software/netcdf/]).''

|shortdescription=
The program enables the selective deletion / copying of variables in a [[CF-NETCDF.NC|netcdf.nc]] input file into an equivalent output file.

|inputfiles=
# '''general input data''' (file type [[NCDVAR.DAT|ncdvar.dat]]);
# '''Input data''', data record to be thinned (file type [[CF-NETCDF.NC|cf-netcdf.nc]]).

|outputfiles=
# '''Output data''' (file type [[CF-NETCDF.NC|netcdf.nc]])
# (optional) informative '''printer file''' of program execution (file type ncdvar.sdr)
# (optional) '''trace''' of program execution (file type ncdvar.trc)

|methodology=
The program is subdivided into the following sections:
# Read, check and print the control data of the user;
# Read metadata of the input data;
# Transfer metadata into internal data objects;
# Classification of all variables of the input file;
# Comparison of the input data specified by the user with the data available in the input file;
# Mark all primary variables that can be selected by the user with '''COPY''' or '''DELETE''';
# Deriving the transfer method (COPY, DELETE) for the variables used by the primary variables (coordinate variable, auxiliary variable, etc.);
# Copy the variables to be transferred from the input to the output file.

|preprocessor=[[DATACONVERT]], [[BOE2NC]], [[NCAGGREGATE]], [[NCANALYSE]], [[NCCHUNKIE]], [[NCCUTOUT]], [[NCRCATMAT]], [[NetCDF Operators]], [[UNK]], [[UNTRIM2007]], [[UNTRIM2]]
|postprocessor=[[DAVIT]], [[NCAUTO]], [[NCAGGREGATE]], [[NCANALYSE]], [[NCCHUNKIE]], [[NCCUTOUT]], [[NCPLOT]], [[NCPOLO]], [[NC2TABLE]], [[UNK]], [[UNTRIM2007]], [[UNTRIM2]]
|language=Fortran95
|add_software=none
|contact_original=G. Lang, S. Spohr
|contact_maintenance=[mailto:pos.proghome@baw.de Working group POS]
|documentation=
* Template Files:
** template files available in '''$PROGHOME/examples/ncdvar'''
}}

NCDVAR.DAT

2023-05-17T10:11:16Z

Ak3spohr:

{{FileDescription
|name_de=NCDVAR.DAT
|filetype=ncdvar.dat
|version=May 2023
|version_descr=April 2020
|significance=contains general steering data for the program [[NCDVAR]].
|filecontents=
'''steering data'''

* Block '''Program_Parameters''': Allgemeine Steuerdaten
*# '''Max_Read_Storage''': Maximum number of data values that can be read for each input variable in a copy cycle. Default = 125000000.
*# (optional) '''Create_Missing_Variables''': Generate additional variables
*#* 0 = do not create additional variables (default)
*#* 1 = generate additional variables (in combination with DFlow FM)
*# (optional) '''NC_Deflate_Level''': Compression of the result data
*#* 0 = no compression
*#* 1 ... 8 = compression (default = 3)
*#* 9 = maximum compression
*# (optional) '''END_After_Define''': Abort after generating the metadata of the output file
*#* .false. = Program runs through to the end (default)
*#* .true. = Program ends after definition of the result file (metadata)
*# (optional) '''Delete_Coordinate_Variables''': Delete coordinate variables of a certain type
*#* X-Y = all x and y coordinate variables (projected coordinates) are not transferred
*#* LON-LAT = all lon and lat coordinates (geographic coordinates) are not transferred
*#* If this key is not specified, all coordinate variables are transferred
* Block '''Input_File''': Input-Datei
*# '''Data_File''': Name and type of the input file (file of type [[CF-NETCDF.NC|netcdf.nc]])
:::- File must exist
* Block '''Output_File''': Output-Datei
*# '''Data_File''' Name and type of the output file (file of type [[CF-NETCDF.NC|netcdf.nc]])
:::- File cannot exist
* (optional) Block '''Mesh_Variables_Action''': Actions on all variables of a grid (mesh)
*# '''Action''' Name of the mesh variable and action ('''COPY''', '''DELETE''') to be carried out on the variables of this grid
:::- Not all netcdf.nc files have mesh variables;
:::- If '''ALL''' is specified for Mesh, all variables are set to the corresponding action;
:::- The line may be specified more than once.
* (optional) Block '''Single_Variable_Action''': Actions for individual variables
*# '''Action''': Name of the variable and action ('''COPY''', '''DELETE''') to be carried out for this variable.
:::- Line may be specified more than once;
:::- Overrides the global action in Block '''Mesh_Variables_Action''';
:::- The user may only list variables that he can ''influence''. These are also known as ''geophysical variables''. Coordinate variables, measure variables, etc. must not be specified by the user.
* (optional) Block '''Time_Coordinate_Thinning''': Thinning out of equidistant time coordinates
*# '''Time_KV_Name''': Name of a time coordinate variable
*# '''Start_Time''': Start time and time zone in format DD.MM.YYYY-hh:mm:ss.nnnnnnnnn zone
*# '''End_Time''': End time and time zone in format DD.MM.YYYY-hh:mm:ss.nnnnnnnnn zone
*# '''Time_Step''': Time step in format dddddd-hh:mm:ss.nnnnnnnnn
:::- Only works for temporally equidistant input data;
:::- The start and end times must be present in the input data;
:::- The time step must be an integer multiple of the input data.

===General Remarks===
# Used '''dictionary files''' from directory '''''$PROGHOME/dic/''''':
#* '''''ncdvar_dico.dat'''''.
# Applications:
#* Case 1: deleting coordinate variables of a certain type;
#* Case 2: deleting/copying variables present on a certain grid;
#* Case 3: deleting/copying selected variables;
#* Case 4: deleting/copying selected dates in the time direction of equidistant data.

|nutzerprogramme=[[NCDVAR]]
|language=Fortran95
|fileform=FORMATTED
|fileaccess=SEQUENTIAL
|fileextension=.dat
|writemodules= ---
|readmodules=$PROGHOME/fortran/prg/ncdvar/*/mod_m_ncdvar_steer.f90
|contact_original=[mailto:guenther.lang@baw.de G. Lang]
|contact_maintenance=[mailto:guenther.lang@baw.de G. Lang], [mailto:susanne.spohr@baw.de S. Spohr]
|examplefile=$PROGHOME/examples/ncdvar/ncdvar.dat
}}

NCDVAR.DAT

2023-05-17T10:09:48Z

Ak3spohr: update version

{{FileDescription
|name_de=NCDVAR.DAT
|filetype=ncdvar.dat
|version=Mai 2023
|version_descr=April 2020
|significance=contains general steering data for the program [[NCDVAR]].
|filecontents=
'''steering data'''

* Block '''Program_Parameters''': Allgemeine Steuerdaten
*# '''Max_Read_Storage''': Maximum number of data values that can be read for each input variable in a copy cycle. Default = 125000000.
*# (optional) '''Create_Missing_Variables''': Generate additional variables
*#* 0 = do not create additional variables (default)
*#* 1 = generate additional variables (in combination with DFlow FM)
*# (optional) '''NC_Deflate_Level''': Compression of the result data
*#* 0 = no compression
*#* 1 ... 8 = compression (default = 3)
*#* 9 = maximum compression
*# (optional) '''END_After_Define''': Abort after generating the metadata of the output file
*#* .false. = Program runs through to the end (default)
*#* .true. = Program ends after definition of the result file (metadata)
*# (optional) '''Delete_Coordinate_Variables''': Delete coordinate variables of a certain type
*#* X-Y = all x and y coordinate variables (projected coordinates) are not transferred
*#* LON-LAT = all lon and lat coordinates (geographic coordinates) are not transferred
*#* If this key is not specified, all coordinate variables are transferred
* Block '''Input_File''': Input-Datei
*# '''Data_File''': Name and type of the input file (file of type [[CF-NETCDF.NC|netcdf.nc]])
:::- File must exist
* Block '''Output_File''': Output-Datei
*# '''Data_File''' Name and type of the output file (file of type [[CF-NETCDF.NC|netcdf.nc]])
:::- File cannot exist
* (optional) Block '''Mesh_Variables_Action''': Actions on all variables of a grid (mesh)
*# '''Action''' Name of the mesh variable and action ('''COPY''', '''DELETE''') to be carried out on the variables of this grid
:::- Not all netcdf.nc files have mesh variables;
:::- If '''ALL''' is specified for Mesh, all variables are set to the corresponding action;
:::- The line may be specified more than once.
* (optional) Block '''Single_Variable_Action''': Actions for individual variables
*# '''Action''': Name of the variable and action ('''COPY''', '''DELETE''') to be carried out for this variable.
:::- Line may be specified more than once;
:::- Overrides the global action in Block '''Mesh_Variables_Action''';
:::- The user may only list variables that he can ''influence''. These are also known as ''geophysical variables''. Coordinate variables, measure variables, etc. must not be specified by the user.
* (optional) Block '''Time_Coordinate_Thinning''': Thinning out of equidistant time coordinates
*# '''Time_KV_Name''': Name of a time coordinate variable
*# '''Start_Time''': Start time and time zone in format DD.MM.YYYY-hh:mm:ss.nnnnnnnnn zone
*# '''End_Time''': End time and time zone in format DD.MM.YYYY-hh:mm:ss.nnnnnnnnn zone
*# '''Time_Step''': Time step in format dddddd-hh:mm:ss.nnnnnnnnn
:::- Only works for temporally equidistant input data;
:::- The start and end times must be present in the input data;
:::- The time step must be an integer multiple of the input data.

===General Remarks===
# Used '''dictionary files''' from directory '''''$PROGHOME/dic/''''':
#* '''''ncdvar_dico.dat'''''.
# Applications:
#* Case 1: deleting coordinate variables of a certain type;
#* Case 2: deleting/copying variables present on a certain grid;
#* Case 3: deleting/copying selected variables;
#* Case 4: deleting/copying selected dates in the time direction of equidistant data.

|nutzerprogramme=[[NCDVAR]]
|language=Fortran95
|fileform=FORMATTED
|fileaccess=SEQUENTIAL
|fileextension=.dat
|writemodules= ---
|readmodules=$PROGHOME/fortran/prg/ncdvar/*/mod_m_ncdvar_steer.f90
|contact_original=[mailto:guenther.lang@baw.de G. Lang]
|contact_maintenance=[mailto:guenther.lang@baw.de G. Lang], [mailto:susanne.spohr@baw.de S. Spohr]
|examplefile=$PROGHOME/examples/ncdvar/ncdvar.dat
}}

NCDVAR

2023-05-17T10:09:04Z

Ak3spohr: update version

{{ProgramDescription
|name_de=NCDVAR
|name=NCDVAR
|version=Mai 2023
|version_descr=September 2022
|catchwords=
postprocessor 
Selective deletion or copying of variables in a [[CF-NETCDF.NC|netcdf.nc]] file 
Delete/Copy coordinate variables of a certain type (X-Y or LON-LAT) 
Delete/Copy variables belonging to a grid (''Mesh'') 
Delete/Copy of individual variables 
Deletion/Copying of individuual dates of synoptic, time-equidistant data records 
Automatic setting of the WRITE chunk size 
Storage of the content of the ASCII input control files in [[CF-NETCDF.NC|netcdf.nc]] (as a variable) 
Storage of the [https://en.wikipedia.org/wiki/MD5 MD5 hash] values of input files in [[CF-NETCDF.NC|netcdf.nc]] (as a variable) 
optional use of ''Message Passing Interface'' (MPI, [https://www.mpi-forum.org/ MPI Forum])

Acknowledgment: ''This project took advantage of netCDF software developed by UCAR/Unidata ([http://www.unidata.ucar.edu/software/netcdf/ www.unidata.ucar.edu/software/netcdf/]).''

|shortdescription=
The program enables the selective deletion / copying of variables in a [[CF-NETCDF.NC|netcdf.nc]] input file into an equivalent output file.

|inputfiles=
# '''general input data''' (file type [[NCDVAR.DAT|ncdvar.dat]]);
# '''Input data''', data record to be thinned (file type [[CF-NETCDF.NC|cf-netcdf.nc]]).

|outputfiles=
# '''Output data''' (file type [[CF-NETCDF.NC|netcdf.nc]])
# (optional) informative '''printer file''' of program execution (file type ncdvar.sdr)
# (optional) '''trace''' of program execution (file type ncdvar.trc)

|methodology=
The program is subdivided into the following sections:
# Read, check and print the control data of the user;
# Read metadata of the input data;
# Transfer metadata into internal data objects;
# Classification of all variables of the input file;
# Comparison of the input data specified by the user with the data available in the input file;
# Mark all primary variables that can be selected by the user with '''COPY''' or '''DELETE''';
# Deriving the transfer method (COPY, DELETE) for the variables used by the primary variables (coordinate variable, auxiliary variable, etc.);
# Copy the variables to be transferred from the input to the output file.

|preprocessor=[[DATACONVERT]], [[BOE2NC]], [[NCAGGREGATE]], [[NCANALYSE]], [[NCCHUNKIE]], [[NCCUTOUT]], [[NCRCATMAT]], [[NetCDF Operators]], [[UNK]], [[UNTRIM2007]], [[UNTRIM2]]
|postprocessor=[[DAVIT]], [[NCAUTO]], [[NCAGGREGATE]], [[NCANALYSE]], [[NCCHUNKIE]], [[NCCUTOUT]], [[NCPLOT]], [[NCPOLO]], [[NC2TABLE]], [[UNK]], [[UNTRIM2007]], [[UNTRIM2]]
|language=Fortran95
|add_software=none
|contact_original=G. Lang, S. Spohr
|contact_maintenance=[mailto:pos.proghome@baw.de Working group POS]
|documentation=
* Template Files:
** template files available in '''$PROGHOME/examples/ncdvar'''
}}

NCAGGREGATE.DAT

2023-05-11T08:57:01Z

Ak3spohr: update version

{{FileDescription
|name_de=NCAGGREGATE.DAT
|filetype=ncaggregate.dat
|version=May 2023
|version_descr=December 2020
|significance=contains general steering data for the program [[NCAGGREGATE]].
|filecontents=
'''steering data'''

* Block '''Program_Parameters''': general input data
*# '''Input_Data_File''': [[NetCDF|CF NetCDF]] file with input data
*# '''Output_Data_File''': [[NetCDF|CF NetCDF]] file with aggregated result data
*# '''Aggregation_File''': definition of control volumes in file of type [[IPDS.DAT|ipds.dat]]
*# '''Aggregation_EPSG''': EPSG code (see [http://www.epsg-registry.org/ http://www.epsg-registry.org/]) for coordinates stored in ''Aggregation_File''
*# (optional) '''NC_Deflate_Level''': deflate level (0,1,2,...,9) for online compression of data during write. 0 corresponds to no compression and 9 to maximum compression
*# (optional) '''NC_Cmode_Id''': ''creation mode flag'' used for [[NetCDF|CF NetCDF]] method [https://www.unidata.ucar.edu/software/netcdf/netcdf-4/newdocs/netcdf-f90/NF90_005fCREATE.html NF90_CREATE]. Typical values used in this application are:
*#* 4 = '''NF90_64BIT_OFFSET''' (NetCDF 64Bit file, no HDF - no online compression);
*#* 5 = '''NF90_CLASSIC_MODEL''' (HDF file without use of extended HDF features - with online compression).
*# (optional) '''Max_Time_Steps_Per_Record''': maximum number of time steps allowed to be transferred in one WRITE to disc file.
*# (optional) '''Create_Missing_Variables''': create additional (virtual) variables
*#: 0 = do not create (default);
*#: 1 = create (for DFlow FM UGRID CF NetCDF).
*# (optional) '''With_Median''': compute (.true.) median (>= 2 values) or do not compute (.false.);
*# (optional) '''With_Percentiles_05_95''': compute (.true.) percentiles Q05, Q95 (>= 11 values) or do not compute (.false.);
*# (optional) '''With_Percentiles_01_99''': compute (.true.) percentiles Q01, Q99 (>= 51 values) or do not compute (.false.).
* (optional) Block '''Exclude_Variable_From_NCAGGREGATE''': list of variables to be excluded from aggregation.
*# '''Variable''': variable from ''Input_Data_File''. Key can be prescribed several times. With exception of the variables listed here results will be computed for all variables suited for aggregation.
* (optional) Block '''Include_Only_Variable_for_NCAGGREAGTE''': list of variables for which results are exclusively aggregated.
*# '''Variable''': variable from ''Input_Data_File''. Key can be prescribed several times. Aggregation will be solely performed for the variables listed here.
* (optional) Block '''Probability_Distribution_Group''': classification and list of variables for which probability distributions are computed. Block can be prescribed several times.
*# '''Bounds_Name''': classification from file [[BOUNDS.CFG.DAT|bounds.cfg.dat]] which will be used to compute probability distributions for all subsequent variables.
*# '''Variable''': variable from ''Input_Data_File''. Key can be prescribed several times. Probability distributions will be solely performed for the variables listed here. Variables listed here shall not be excluded via blocks '''Exclude_Variable_From_NCAGGREGATE''' or '''Include_Only_Variable_for_NCAGGREAGTE'''.
===General Remarks===
# Dictionary file used from directory '''''$PROGHOME/dic/''''':
#* '''''ncaggregate_dico.dat'''''.
# If no online compression is used during output file creation, it is recommended to apply [https://www.unidata.ucar.edu/software/netcdf/docs/netcdf/nccopy.html NCCOPY] manually. Example:
nccopy -k 3 -d 5 <infile> <outfile>

|nutzerprogramme=[[NCAGGREGATE]]
|language=Fortran90
|fileform=FORMATTED
|fileaccess=SEQUENTIAL
|fileextension=.dat
|writemodules= ---
|readmodules=$PROGHOME/fortran/prg/ncaggregate/*/mod_m_ncaggregate_steer.f90
|contact_original=[mailto:guenther.lang@baw.de G. Lang]
|contact_maintenance=[mailto:guenther.lang@baw.de G. Lang], [mailto:susanne.spohr@baw.de S. Spohr]
|examplefile=$PROGHOME/examples/ncaggregate/ncaggregate.dat
}}

NCAGGREGATE

2023-05-11T08:56:22Z

Ak3spohr: update version

{{ProgramDescription
|name_de=NCAGGREGATE
|name=NCAGGREGATE
|version=May 2023
|version_descr=September 2022
|catchwords=
data analysis 
postprocessor 
synoptic data sets 
[[Analysis_of_Calculated_Results#Tidal_Characteristic_Numbers|tidal characteristic numbers]] 
[[Analysis_of_Calculated_Results#Characteristic_Numbers_.28independent_of_the_presence_of_tides.29|tide-independent characteristic numbers]] 
differences for synoptic data sets 
differences for tidal characteristic numbers 
differences for tide-independent characteristic numbers 
[[NetCDF|CF NetCDF]] format for 2D/3D data 
aggregated data for control volumes and exchanges 
orthogonal unstructured grid model 
support of computational results based on sub-grid bathymetry 
parallelization using [http://openmp.org/wp/ OpenMP] 
support of DMQS metadata and variables 
[[NetCDF#Quality assurance using NetCDF attributes|automatic quality assurance (value range)]] 
automatic adjustment of number of data READ to chunk size of input data 
automatic computation of chunk sizes for result variables to support orthogonal data access 
Storage of the content of the ASCII input control files in [[CF-NETCDF.NC|netcdf.nc]] (as a variable) 
Storage of [https://en.wikipedia.org/wiki/MD5 MD5 hash values] of input files in [[CF-NETCDF.NC|netcdf.nc]] (as a variable) 
optional use of ''Message Passing Interface'' (MPI, [https://www.mpi-forum.org/ MPI Forum])

Acknowledgment: ''This project took advantage of netCDF software developed by UCAR/Unidata ([http://www.unidata.ucar.edu/software/netcdf/ www.unidata.ucar.edu/software/netcdf/]).''

|shortdescription=
Program NCAGGRGATE may be useful in different situations which are listed in the following. For each type of application a list of programs (with sequence of execution) is given:
* aggregation of synoptic transport data for control volumes aiming at a precise balance of transports (water volume, salt, etc.): Attention: To get an input file suitable for INSPECT_CONTROL_VOLUMES, the simulation must be performed at least with salt or temperature. Even if you are only interested in the hydrodynamics, NCAGGREGATE also has to aggregate the salt or temperature values. The aggregated synoptic water volume is otherwise not calculated. However, this physical quantity is required for the calculations performed in INSPECT_CONTROL_VOLUMES.
*# [[UNTRIM2007]] or [[UNTRIM2]],
*# NCAGGREGATE,
*# [[INSPECT_CONTROL_VOLUMES]] (check results),
*# [[NCANALYSE]], and
*# [[DISPLAY_CONTROL_VOLUMES]].
* aggregation of synoptic data (water level, current velocity, salinity, etc.) aiming at the reduction of data complexity:
*# [[UNTRIM2007]] or [[UNTRIM2]],
*# NCAGGREGATE, and
*# [[NCPLOT]].
* aggregation of characteristic numbers aiming at the reduction of data complexity:
*# [[UNTRIM2007]] or [[UNTRIM2]],
*# [[NCANALYSE]],
*# [[NCPLOT]] (check characteristic numbers),
*# NCAGGREGATE, and
*# [[NCPLOT]].
* aggregation of differences for characteristic numbers or synoptic data aiming at the reduction of data complexity:
*# [[UNTRIM2007]] or [[UNTRIM2]] (experimentally also for DFlow FM),
*# [[NCANALYSE]] (computation of characteristic numbers),
*# [[NCPLOT]] (check characteristic numbers),
*# [[NCDELTA]],
*# [[NCPLOT]] (check differences),
*# NCAGGREGATE, and
*# [[NCPLOT]].
During aggragation of classical data ''land binary masks'' (LBM) are automatically added to the result file. LBMs are used to describe the distribution of land and water at aggregation time. LBMs therefore empower visualization programs like [[NCPLOT]] to optimally present aggregated data in combination with a meaningful land-water-distribution.

Optionally the user is able to generate percentiles (0.01, 0.05, 0.50, 0.95 and 0.99) as well as probability distributions in addition to those aggregated data which are ''usually'' created. For further advice see [[NCAGGREGATE.DAT|ncaggregate.dat]].

[[File:ncaggregate_patch.png|thumb|'''Picture ''control volumes and exchanges'''''.]]

|inputfiles=
# '''general input data''' (file type [[NCAGGREGATE.DAT|ncaggregate.dat]]);
# file with '''classifications''' for probability distributions (file type [[BOUNDS.CFG.DAT|bounds.cfg.dat]]) Hint: (Recommended) Local configuration file or file from the directory ''$PROGHOME/cfg/''.
# '''synoptic data sets''' (file type [[CF-NETCDF.NC|cf-netcdf.nc]]);
# '''control volumes''' (file type [[IPDS.DAT|ipds.dat]]);
# for [[NetCDF#Automatic quality assurance using NetCDF attributes|automatic quality assurance]] (file type [[BOUNDS.CFG.DAT|bounds_verify.dat]]).

|outputfiles=
# '''data analysis result files''' (file type [[CF-NETCDF.NC|cf-netcdf.nc]]); see ''[[NetCDF aggregation for unstructured grids]]'' for details about the aggregational grid.
# (optional) informative '''printer file''' of program execution (file type ncaggregate.sdr)
# (optional) '''trace''' of program execution (file type ncaggregate.trc)

|methodology=
Physical data, suitable for aggregation, are collected for different control volumes as well as exchanges between adjacent control volumes.

Just in case '''HDF error''' is detected during read of a data record, the program tries to reconstruct the wanted data set from adjacent (in time) records for the same variable. This type of repair works for time dependent variables only.

|preprocessor=[[NCANALYSE]], [[NCCHUNKIE]], [[NCCUTOUT]], [[NCDELTA]], [[NCDVAR]], [[NCMERGE]], [[UNTRIM2007]], [[UNTRIM2]], [[INSEL2IPDS]]
|postprocessor=[[DAVIT]], [[INSPECT_CONTROL_VOLUMES]], [[NCANALYSE]], [[NCAUTO]], [[NCCHUNKIE]], [[NCDELTA]], [[NCDVAR]], [[NCMERGE]], [[NCPLOT]], [[NC2TABLE]], [[PLOTPROFILZEIT]]
|language=Fortran95
|add_software=---
|contact_original=G. Lang
|contact_maintenance=[mailto:pos.proghome@baw.de Working group POS]
|documentation=
* Presentations (available in German only):
** 2014-03-12: [http://ewisa.baw.de/files/09206_tv12_2014_03_12_aggregation_g_lang.pdf ''Aggregation von Daten''].
* [https://izw-campus.baw.de/ ''IZW-Campus''] (Podcast, available in German only)
**2020-12-07: [https://izw-campus.baw.de/goto.php?target=cat_1830&client_id=iliasclient ''Aggregation und NCAGGREGATE''].
* Template Files:
** template files available in '''$PROGHOME/examples/ncaggregate'''
}}

NCDELTA.DAT

2023-04-12T11:00:42Z

Ak3spohr: update version

{{FileDescription
|name_de=NCDELTA.DAT
|filetype=ncdelta.dat
|version=April 2023
|version_descr=October 2022
|significance=contains general steering data for the program [[NCDELTA]].
|filecontents=
'''steering data'''

* Block '''Program_Parameters''': general steering data
*# '''Max_Read_Storage''': number of data items in byte read from input file during each analysis cycle. This value gives a good approximation of [[NCDELTA|NCDELTA's]] mamximum memory requirements for each variable.
*# '''Max_Distance''': maximum distance in [m] up to which points with different location are compared.
*# (optional) '''Print_Modus_Classify''': parameter to steer informative printout messages in program section ''classification'':
*## '''0''' = no extensive messages printed;
*## '''1''' = more extensive messages about classified variables will be printed.
*# (optional) '''Print_Modus_Pairs''': parameter to steer informative printout messages in program section ''primary partner variables'':
*## '''0''' = no extensive messages printed;
*## '''1''' = more extensive messages about detected variable pairs will be printed;
*## '''2''' = also informations about rejected variable pairs will be printed.
*# (optional) '''Print_Modus_Define''': parameter to steer informative printout messages in program section ''definition of computational results'':
*##'''0''' = no extensive messages printed;
*## '''1''' = more extensive informations with respect to metadata of computational results will be printed.
*# (optional) '''Print_Modus_Compute''': parameter to steer informative printout messages in program section ''computation of results'':
*##'''0''' = no extensive messages printed;
*## '''1''' = more extensive messages about computational result variables will be printed.
*# (optional) '''NC_Deflate_Level''': deflate level (0,1,2,...,9) for online compression of data during write. 0 corresponds to no compression and 9 to maximum compression
*# (optional) '''NC_Cmode_Id''': ''creation mode flag'' used for [[NetCDF|CF NetCDF]] method [https://www.unidata.ucar.edu/software/netcdf/netcdf-4/newdocs/netcdf-f90/NF90_005fCREATE.html NF90_CREATE]. Typical values used in this application are:
*#* 4 = '''NF90_64BIT_OFFSET''' (NetCDF 64Bit file, no HDF - no online compression);
*#* 5 = '''NF90_CLASSIC_MODEL''' (HDF file without use of extended HDF features - with online compression).
* Block '''Data_Files''': data files
*# '''Reference_File''': file (NETCDF) with '''reference''' data (filetype [[CF-NETCDF.NC|cf-netcdf.nc]]);
*# '''Variant_File''': file (NETCDF) with '''variant''' data (filetype [[CF-NETCDF.NC|cf-netcdf.nc]]);
*# '''Result_File''': file (NETCDF) for '''result''' data (filetype [[CF-NETCDF.NC|cf-netcdf.nc]]);
*# (optional) '''Reference_Period''': start and end time of period of comparison for reference data (for synoptic data only);
*# (optional) '''Variant_Period''': start and end time of period of comparison for variant data (for synoptic data only).
* (optional) Block '''Data_Operations''': data operations
*# (optional) '''With_Ordinary_Differences''': compute (.true.) common differences (if possible) or do not compute (.false.);
*# (optional) '''With_Taylor_Diagram_Data''': compute (.true.) data for Taylor diagram (if possible) or do not compute (.false.); including skill scores according to Taylor (2001) equations 4 and 5;
*# (optional) '''With_Median''': compute (.true.) median (>= 32 events) or do not compute (.false.);
*# (optional) '''With_Percentiles_05_95''': compute (.true.) percentiles Q05, Q95 (>= 32 events) or do not compute (.false.);
*# (optional) '''With_Percentiles_01_99''': compute (.true.) percentiles Q01, Q99 (>= 51 events) or do not compute (.false.);
*# (optional) '''With_Murphy_Skill_1988''': compute (.true.) skill according to Murphy (1988) equation 4 or do not compute (.false.);
*# (optional) '''With_Skill_Willmott_1981''': compute (.true.) skill according to Willmott (1981) Index of agreement (d);
*# (optional) '''With_Original_Data''': copy (.true.) or not (.false.) input data from which ordinary differences are computed.
* (optional) Block '''Exclude_Variable_From_NCDELTA''': list of variables to be excluded from computation.
*# '''Variant_Variable''': variable from ''Variant-File''. Key can be prescribed several times. With exception of the variables listed here results will be computed for all primary variable pairs.
* (optional) Block '''Include_Only_Variable_for_NCDELTA''': list of variables for which results ar exclusively computed.
*# '''Variant_Variable''': variable from ''Variant-File''. Key can be prescribed several times. Results will be solely computed for the variables listed here.
* (optional) Block '''No_Normal_Vector_Variable''': The list of variables which are normal vectors is (mostly) automatically determined with [[NCDELTA]]. So far, unfortunately, not all of them can be safely identified based on CF metadata. With this list variables can be explicitely '''''excluded''''' from the class of normal vector variables.
*# '''Variable''': variable from ''Variant-File'' or ''Reference_File''. Key can be prescribed several times.
* (optional) Block '''Normal_Vector_Variable''': The list of variables which are normal vectors is (mostly) automatically determined with [[NCDELTA]]. So far, unfortunately, not all of them can be safely identified based on CF metadata. With this list variables can be explicitely '''''included''''' in the class of normal vector variables.
*# '''Variable''': variable from ''Variant-File'' or ''Reference_File''. Key can be prescribed several times.
* (optional) Block '''Label_Relation''': For intercomparison of ''fractioned'' variables, for which the relationship between individual ''fractions'' (sediment, tidal constituent, etc.) cannot be automatically determined. In such situations the corresponding names must be prescribed by the user. Block can be specified several times.
*# '''Variant_Label_KV''': name of a valid label coordinate variable from ''Variant_File'' or ''NONE''.
*# '''Reference_Label_KV''': name of a valid label coordinate variable from ''Reference_File'' or ''NONE''.
*# '''Relation''': ''name of a ''fraction'' in Variant_File'' ''':''' ''name of a ''fraction'' in Reference_File''. Key can be specified several times. ''NONE'' must be specified in case there exists no corresponding label coordinate variable. Colon is used as separator.

===General Remarks===
# Dictionary files used from directory '''''$PROGHOME/dic/''''':
#* '''''ncdelta_dico.dat'''''.
# Use Cases:
#* Case 1: '''Reference_File''' = simulation 1, '''Variant_File''' = simulation 2;
#* Case 2: '''Reference_File''' = measurement, '''Variant_File''' = simulation;
#* Case 3: '''Reference_File''' = measurement 1, '''Variant_File''' = measurement 2;
#: Synoptic data ''or'' data analysis results from program [[NCANALYSE]] can be used.
# General requirements:
#* Synoptic data:
#** length of time period must be identical (periods may differ), and
#** time step must be identical.
#* Analysis results ([[NCANALYSE]]):
#** length of period of data analysis must be comparable, and
#** number of events, e.g. tidal high water, must also be identical.
#* Z coordinate variables:
#: z coordinate variables, if present, must be consistent with respect to
#:* CF attribute ''positive'' all with value "down", or
#:* CF attribute ''positive'' all with value "up"
#: (see [http://cfconventions.org/ CF metadata conventions]).
# Special requirements:
#* ref. case 1:
#** same vertical structure (number of layers), and
#** identical (tracer-) fractions (if present).
#* ref. case 2:
#** identical (tracer-) fractions (if present), and
#** measured data may contain for the same (geographical) location (x,y) several measured data in different depths (z). Furthermore
#** for comparisons with measured current velocity attribute "name_id" of variable "current_velocity" must be set to 836. This requirement should be checked before execution (e.g. using ncdump). In case this condition is not fulfilled NCO tool NCATTED '''ncatted -a name_id,current_velocity,m,i,836 -O ''reference_file''.nc''' can be used to redefine "name_id" accordingly.
#* ref. case 3:
#** each (geographical) location is allowed to be present only once; locations with several stacked data positions are not allowed currently with this use case.

|nutzerprogramme=[[NCDELTA]]
|language=Fortran90
|fileform=FORMATTED
|fileaccess=SEQUENTIAL
|fileextension=.dat
|writemodules= ---
|readmodules=$PROGHOME/fortran/prg/ncdelta/*/mod_m_ncdelta_steer.f90
|contact_original=[mailto:guenther.lang@baw.de G. Lang]
|contact_maintenance=[mailto:guenther.lang@baw.de G. Lang], [mailto:susanne.spohr@baw.de S. Spohr]
|examplefile=$PROGHOME/examples/ncdelta/ncdelta.dat
}}

NCDELTA

2023-04-12T11:00:15Z

Ak3spohr: update version

{{ProgramDescription
|name_de=NCDELTA
|name=NCDELTA
|version=April 2023
|version_descr=September 2022
|catchwords=
postprocessor 
differences of synoptic data (with optional restriction of time period) 
differences of characteristic numbers 
differences for extensive quantities 
input data for Taylor diagram 
median, percentiles (Q01, Q05, Q95, Q99) 
skill score according to Murphy (1988) equation 4 
skill score according to Taylor (2001) equations 4 and 5 
skill score according to Willmott (1981) Index of agreement (d) 
parallelization using [http://openmp.org/wp/ OpenMP] 
[[NetCDF#Quality assurance using NetCDF attributes|automatic quality assurance (value range)]] 
automatic adjustment of number of READ data to chunk size of data 
automatic setting of WRITE chunk sizes for written variables 
Storage of the content of the ASCII input control files in [[CF-NETCDF.NC|netcdf.nc]] (as a variable) 
Storage of [https://en.wikipedia.org/wiki/MD5 MD5 hash values] of input files in [[CF-NETCDF.NC|netcdf.nc]] (as a variable) 
optional use of ''Message Passing Interface'' (MPI, [https://www.mpi-forum.org/ MPI Forum])

Acknowledgment: ''This project took advantage of netCDF software developed by UCAR/Unidata ([http://www.unidata.ucar.edu/software/netcdf/ www.unidata.ucar.edu/software/netcdf/]).''

|shortdescription=
Program computes differences for comparable variables (primary variable pairs) as well as additional statistical data derived from primary differences, but also data for Taylor diagrams (details see [[Differences of Calculated Results]]) can be computed for some types of data. Finding the primary variable pairs is done in an essentially automatical manner but can be altered to some extent by the user (see [[NCDELTA.DAT|ncdelta.dat]]). Primary differences are computed according to ''variant data'' '''minus''' ''reference data''.

Requirements for time-dependent primary variable pairs with individual constant time step:
# both data sets may contain a ''different'' number of data items (time steps), but the length of the time period to be compared must be identical, whereas the periods to be compared may differ ;
# constant time step for each data set may differ from each other, but the larger time step must an integer multiple of the smaller one.

Requirements for time-dependent primary variable pairs with variable time step:
# both data sets must contain an ''identical'' number of data items (time steps), with periods allowed to be different.

Remarks concerning the spatial location of data:
# data sets may differ with respect to their geographical location;
# areas for which data are defined must overlap to some degree;
# coordinates may be given in different coordinate systems, e. g. Gauß-Krüger and UTM;
# data for a location are compared with data for the nearest lying location, as far as the distance between the different locations does not exceed a prescribed maximum (see [[NCDELTA.DAT|ncdelta.dat]]).

Remarks concerning the comparison of extensive variables:
# for extensive variables the respective sizes of the computational cells (area, length) are taken into account.

|inputfiles=
# '''general input data''' (file type [[NCDELTA.DAT|ncdelta.dat]]);
# '''reference data''' (file type [[CF-NETCDF.NC]]);
# '''variant data''' (file type [[CF-NETCDF.NC]]);
# for [[NetCDF#Automatic quality assurance using NetCDF attributes|automatic quality assurance]] (file type [[BOUNDS.CFG.DAT|bounds_verify.dat]]).

|outputfiles=
# '''results''' (file type [[CF-NETCDF.NC]])
# (optional) informative '''printer file''' of program execution (file type ncdelta.sdr)
# (optional) '''trace''' of program execution (file type ncdelta.trc)

|methodology=
The program is subdivided into the following sections:
# read, check and print steering data prescribed by the user;
# read metadata for ''reference data'';
# read metadata for ''variant data'';
# copy metadata for reference as well as variant data to program specific data structures;
# compare metadata for substantial discrepancies (e. g. reference locations) between data sets;
# classify all reference as well as variant data;
# find primary variable pairs: each variant variable has one partner reference variable; primary computational results will be later derived from primary variable pairs;
# derive variables to be copied from reference as well as variant data file into the result file;
# compute interpolation matrices required for interpolation between reference data locations and variant data locations;
# create all metadata for the result file; essentially they stem from variables to be copied, from primary result variables, newly generated coordinate variables (time, vertical), as well as newly derived or to be copied measure and auxiliary variables;
# copy selceted variables from reference as well as variant file to the result file;
# compute all primary variables, (new) time and vertical coordinate variables, as well as weights and auxiliary variables. For primary variables optionally available axiliary variables with ''standard_name'' modifier ''status_flag'' are taken into account in case meaning ''good'' is represented by an appropriate flag (bit).
# with respect of the different skill scores used and computed by the program - references:
#* Murphy, Allan H. (1988) "Skill Scores Based on the Mean Square Error and Their Relationship to the Correlation Coefficient". Monthly Weather Review, Dec. 1988, Pages 2417 - 2424.
#* Taylor, Karl E. (2001) "Summarizing multiple aspects of model performance in a single diagram". Journal of Geophysical Research, Vol 106, No. D7, April 16, 2001, Pages 7183 - 7192.
#* Willmott, Cort J. (1981) "On the validation of models". Physical Geography, Pages 184–194.
Just in case '''HDF error''' is detected during read of a data record, the program tries to reconstruct the wanted data set from adjacent (in time) records for the same variable. This type of repair works for time dependent variables only.

|preprocessor=[[BOE2NC]], [[DATACONVERT]], [[NCAGGREGATE]], [[NCANALYSE]], [[NCCHUNKIE]], [[NCCUTOUT]], [[NCRCATMAT]], [[NetCDF Operators]], [[UNK]], [[UNTRIM2007]], [[UNTRIM2]]
|postprocessor=[[DAVIT]], [[NCAUTO]], [[NCCHUNKIE]], [[NCPOLO]], [[NCPLOT]], [[NCCUTOUT]], [[NC2TABLE]], [[NCVIEW2D]], [[PLOTTS]], [[TAYLORDIAGRAM]]
|language=Fortran95
|add_software=none
|contact_original=G. Lang, S. Spohr
|contact_maintenance=[mailto:pos.proghome@baw.de Working group POS]
|documentation=
* Presentations (available in German only):
** 2015-07-15: [http://ewisa.baw.de/files/12835_tv12_2015_07_15_ncdelta_g_lang.pdf ''NCDELTA - Differenzen neu berechnet''].
* [https://izw-campus.baw.de/ ''IZW-Campus''] (Podcast, available in German only)
** 2022-05-30: [https://izw-campus.baw.de/goto.php?target=cat_4308&client_id=iliasclient ''NCDELTA - Berechnung von Differenzen''].
* Template Files:
** template files available in '''$PROGHOME/examples/ncdelta'''
}}

NCANALYSE.DAT

2023-03-29T13:16:56Z

Ak3spohr: update Version

{{FileDescription
|name_de=NCANALYSE.DAT
|filetype=ncanalyse.dat
|version=March 2023
|version_descr=October 2021
|significance=contains general steering data for the program [[NCANALYSE]].
|filecontents=
'''steering data'''

* Block '''Program_Parameters''': general input data
*# '''Max_Read_Storage''': maximum number of data items which can be read, stored and processed within one analysis cycle.
*# '''Min_Water_Depth''': minimum water depth up to which analyses are carried through.
*# (optional) '''Create_Missing_Variables''': create additional (virtual) variables
*#: 0 = do not create (default);
*#: 1 = create (actually only "magnitude_of_sea_water_velocity" for DFlow FM UGRID CF NetCDF).
*# (optional) '''NC_Deflate_Level''': level (0 to 9) of online-compression used during write of the result file
*#: 0 = no compression (default);
*#: 5 = good compression (recommendation);
*#: 9 = highest level of compression.
*# (optional) '''FRQ_use_j_v_correction''': nodal correction in tidal constituent analysis
*#: .true. = use nodal correction in computation of tidal constituents (default);
*#: .false. = ''neglect'' nodal correction in computation of tidal constituents.
*# (optional) '''END_after_hrp''': end program execution after analysis at reference locations before entering spatial analysis
*#: .true. = end execution before spatial analysis;
*#: .false. = normal execution of program (default).
*# (optional) '''CU_zero_slack''': critical value for current velocity in [m s-1]. Typically 1 [cm s-1] is predefined in the configuration files. This value is used to determine current slack. Current slack is recognized by the program in case magnitude of current velocity lies above this limit value and the direction of flow has changed.
*# (optional) '''Compute_FE_Ratio''': Compute flood(current):ebb(current) characteristic numbers, in case they are marked using <OPT:COMPUTE_FE_RATIO> in a configuration file.
*#: .true. = F:E-Kenngrößen berechnen
*#: .false. = F:E-Kenngrößen nicht berechnen (Default)
*# (optional) '''CFG_Level''': some configuration files may contain lines including <OPT:CFG_Level_''number''> to allow for a more flexible use for different purposes.
*#: 0 = activate lines including <OPT:CFG_Level_0> (default)
*#: 1 = activate lines including <OPT:CFG_Level_1>
*# (optional) '''Location_XY_EPSG''': EPSG code for X- and Y-coordinates used in '''Location''' blocks. In case this key is missing, EPSG code derived from input data (block '''Input_Files''') will be used.
*# (optional) '''Gap_Fill''': control parameter for filling data gaps at reference locations by interpolation. If this key is not specified, data gaps (water level, current) are not automatically filled.
*#: 0 = data gaps are not filled (default)
*#: 1 = Data gaps are filled by spline interpolation
* Block '''Data_Analysis_Period''': period of data analysis
*# '''Start_Time''': start time of data analysis period.
*# '''End_Time''': end time of data analysis period.
* Block '''Input_Files''': [[NetCDF|CF NetCDF]] file with input data
*# '''Data_File''': name and type (NETCDF) of the input data file (filetype [[CF-NETCDF.NC|cf-netcdf.nc]]). An optional third parameter may be used to choose between MPI COLLECTIVE I/O and MPI INDEPENDENT I/O (relevant for MPI program version only).
* Block '''Location''': reference locations (one block per location)
*# '''Name''': name of reference location.
*# '''Type''': type of reference location:
*#* 0 = reference location ''tide'' (must be specified exactely once);
*#* 1 = reference location ''phase'' (must be specified exactely once);
*#* 2 = auxiliary location (can be specified several times).
*# '''X''': x-coordinate of location(specify either '''X''' and '''Y''' or '''LON''' and '''LAT''').
*# '''Y''': y-coordinate of location (specify either '''X''' and '''Y''' or '''LON''' und '''LAT''').
*# '''LON''': longitude of location (specify either '''X''' and '''Y''' or '''LON''' and '''LAT''').
*# '''LAT''': latitude of location (specify either '''X''' and '''Y''' or '''LON''' and '''LAT''').
*# '''Z''': z-coordinate of location (positive downwards).
*# '''Rank''': ''rank'' of location(not for ''reference location phase'').
*# '''Previous_Rank''': refers to the ''rank'' of the previous location (not for ''reference location tide'' and ''reference location phase'').
* Block '''Input_Variables''': names(s) for variables to be analysed
*# '''Name''': name of variable to be analysed (must be a valid [[NetCDF|CF NetCDF]] variable name from the input data file).
* Block '''Data_Analysis''': type of analysis and [[NetCDF|CF NetCDF]] file for result data
*# '''Type''': type of analysis:
*#* '''TDKW''' = [[Tidal Characteristic Numbers of Water Level]];
*#* '''TDKV''' = [[Tidal Characteristic Numbers of Current]];
*#* '''TDXF''' = [[Tidal Characteristic Numbers of Water Transport]];
*#* '''TDKS''' or '''TDWS''' = [[Tidal Characteristic Numbers of Salinity]];
*#* '''TDXS''' = [[Tidal Characteristic Numbers of Salt Transport]];
*#* '''TDKT''' = [[Tidal Characteristic Numbers of Temperature]];
*#* '''TDXT''' = [[Tidal Characteristic Numbers of Heat Transport]];
*#* '''TDKC''' = [[Tidal Characteristic Numbers of Suspended Sediment Transport|Tidal Characteristic Numbers of Suspended Sediment]];
*#* '''TDXC''' = [[Tidal Characteristic Numbers of Suspended Load Transport]];
*#* '''TDKP''' = [[Tidal Characteristic Numbers of Tracer Load]];
*#* '''TDXP''' = [[Tidal Characteristic Numbers of Tracer Load Transport]];
*#* '''TDKB''' = [[Tidal Characteristic Numbers of Eff. Bed Shear Stress Action|Tidal Characteristic Numbers of Effective Bed Shear Stress]];
*#* '''TDKG''' = [[Tidal Characteristic Numbers of Bed Load Transport]];
*#* '''TDKA''' = [[Tidal Characteristic Numbers of Potential Energy Anomaly]];
*#* '''FRQW''' = [[Harmonic Analysis of Water Level|Harmonic Analysis of Water Level (tidal constituents)]];
*#* '''FRQV''' = [[Harmonic Analysis of Current Velocity|Harmonic Analysis of Current Velocity (tidal constituents)]];
*#* '''LZKW''' = [[Characteristic Numbers of Water Level (independent of tides)]];
*#* '''LZKV''' = [[Characteristic Numbers of Current Velocity (independent of tides)]];
*#* '''LZKS''' = [[Characteristic Numbers of Salinity (independent of tides)]];
*#* '''LZKT''' = [[Characteristic Numbers of Temperature (independent of tides)]];
*#* '''LZKC''' = [[Characteristic Numbers of Suspended Sediment Concentration (independent of tides)]];
*#* '''LZKP''' = [[Characteristic Numbers of Tracer Load (independent of tides)]];
*#* '''LZKO''' = [[Characteristic Numbers of Oxygen Concentration (independent of tides)]];
*#* '''LZKM''' = [[Characteristic Numbers of Morphodynamics (independent of tides)]];
*#* '''LZKG''' = [[Characteristic Numbers of Bed Load Transport (independent of tides)]];
*#* '''LZKB''' = [[Characteristic Numbers of Eff. Bed Shear Stress (independent of tides)]];
*#* '''LZKA''' = [[Characteristic Numbers of Potential Energy Anomaly (independent of tides)]];
*#* '''LZXF''' = [[Characteristic Numbers of Water Transport (independent of tides)]];
*#* '''LZXS''' = [[Characteristic Numbers of Salt Transport (independent of tides)]];
*#* '''LZXT''' = [[Characteristic Numbers of Heat Transport (independent of tides)]];
*#* '''LZXP''' = [[Characteristic Numbers of Tracer Transport (independent of tides)]];
*#* '''LZXC''' = [[Characteristic Numbers of Suspended Sediment Transport (independent of tides)]];
*#* '''LZXG''' = [[Characteristic Numbers of Sediment Transport (independent of tides)]] (bed and suspended load at the bottom);
*#* '''LZXE''' = [[Characteristic Numbers of Tidal Energy Transport]];
*#* '''LZMW''' = [[Characteristic Numbers of Meteorological Data (independent of tides)|Characteristic Numbers of Meteorological Data (Wind Speed)]];
*#* '''LZSS''' = [[Characteristic Numbers for Wave and Sea State (independent of tides)|Characteristic Numbers for Wave and Sea State (significant wave height)]].
*# '''Result_File''': name and type (NETCDF) of the result file (filetype [[CF-NETCDF.NC|cf-netcdf.nc]]).
* '''Optional Input Blocks''' for different analyses
: To specify meaningful ''bounds'', which are the interval boundaries for the various frequency distributions computed, the range of the physical quantity under consideration should be evaluated before, e.g. using program [[NCAUTO]].
:* optional for '''TDKW''':
:** Block '''TDKW_Quantiles''': definition of quantiles.
:**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
:* optional for '''TDKV''':
:** Block '''TDKV_Quantiles''': definition of quantiles.
:**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
:* optional for '''TDKS''' or '''TDWS''':
:** Block '''TDKS_Quantiles''' or '''TDWS_Quantiles''': definition of quantiles.
:**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
:* optional for '''TDKT''':
:** Block '''TDKT_Quantiles''': definition of quantiles.
:**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
:* optional for '''TDKC''':
:** Block '''TDKC_Quantiles''': definition of quantiles.
:**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
:* optional for '''TDKP''':
:** Block '''TDKP_Quantiles''': definition of quantiles.
:**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
:* optional for '''TDKG''':
:** Block '''TDKG_Quantiles''': definition of quantiles.
:**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
:* optional for '''TDKB''':
:** Block '''TDKB_Quantiles''': definition of quantiles.
:**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
:* optional for '''TDKA''':
:** Block '''TDKA_Quantiles''': definition of quantiles.
:**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
:* optional for '''FRQW''' and '''FRQV''':
:** Block '''Tidal_Constituents''': list of tidal constituents
:**# '''Value''': code of tidal constituent, e. g. Mm, Mf, K_1, O_1, S_2, M_2, M_4, M_6, M_8.
* '''Optional Required Input Blocks''' for different analyses
: To specify meaningful ''bounds'', which are the interval boundaries for the various frequency distributions computed, the range of the physical quantity under consideration should be evaluated before, e.g. using program [[NCAUTO]].
:* required for '''LZKW''':
:** Block '''Water_Level_Bounds''': definition of classes for water level.
:**# '''Interval''': lower and upper bound of classes (intervals).
:** Block '''Water_Level_Quantiles''': definition of quantiles.
:**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
:* required for '''LZKV''':
:** Block '''Current_Velocity_Bounds''': definition of classes for current velocity.
:**# '''Interval''': lower and upper bound of classes (intervals).
:** Block '''Current_Velocity_Quantiles''': definition of quantiles.
:**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
:* required for '''LZKS''':
:** Block '''Salinity_Bounds''': definition of classes for salinity.
:**# '''Interval''': lower and upper bound of classes (intervals).
:** Block '''Salinity_Quantiles''': definition of quantiles.
:**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
:* required for '''LZKT''':
:** Block '''Temperature_Bounds''': definition of classes for temperature.
:**# '''Interval''': lower and upper bound of classes (intervals).
:** Block '''Temperature_Quantiles''': definition of quantiles.
:**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
:* required for '''LZKC''':
:** Block '''Suspended_Sediment_Bounds''': definition of classes for suspended sediment concentration.
:**# '''Interval''': lower and upper bound of classes (intervals).
:** Block '''Suspended_Sediment_Quantiles''': definition of quantiles.
:**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
:* required for '''LZKP''':
:** Block '''Tracer_Bounds''': definition of classes for tracer load.
:**# '''Interval''': lower and upper bound of classes (intervals).
:** Block '''Tracer_Quantiles''': definition of quantiles.
:**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
:* required for '''LZKO''':
:** Block '''Oxygen_Bounds''': definition of classes for oxygen concentration.
:**# '''Interval''': lower and upper bound of classes (intervals).
:** Block '''Oxygen_Quantiles''': definition of quantiles.
:**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
:* required for '''LZKM''':
:** Block '''Bathymetry_Bounds''': definition of classes for bathymetry.
:**# '''Interval''': lower and upper bound of classes (intervals).
:** Block '''Bathymetry_Quantiles''': definition of quantiles.
:**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
:* required for '''LZKG''':
:** Block '''Bedload_Bounds''': definition of classes for bedload transport.
:**# '''Interval''': lower and upper bound of classes (intervals).
:** Block '''Bedload_Quantiles''': definition of quantiles.
:**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
:* required for '''LZKB''':
:** Block '''Bedfriction_Bounds''': definition of classes for eff. bed shear stress.
:**# '''Interval''': lower and upper bound of classes (intervals).
:** Block '''Bedfriction_Quantiles''': definition of quantiles.
:**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
:* required for '''LZKA''':
:** Block '''PE_Anomaly_Bounds''': definition of classes for PEA.
:**# '''Interval''': lower and upper bound of classes (intervals).
:** Block '''PE_Anomaly_Quantiles''': definition of quantiles.
:**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
:* required for '''LZMW''':
:** Block '''Wind_Bounds''': definition of classes for wind speed.
:**# '''Interval''': lower and upper bound of classes (intervals).
:** Block '''Wind_Quantiles''': definition of quantiles.
:**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
:* required for '''LZSS''':
:** Block '''Sig_Wave_Bounds''': definition of classes for significant wave height.
:**# '''Interval''': lower and upper bound of classes (intervals).
:** Block '''Sig_Wave_Quantiles''': definition of quantiles.
:**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
===General Remarks===
# Dictionary files used from directory '''''$PROGHOME/dic/''''':
#* '''''ncanalyse_dico.dat''''' and
#* '''''ncanalyse_config_dico.dat'''''.
# Standard configuration files used from directory '''''$PROGHOME/cfg/''''':
#* '''TDKW_ncanalyse_cfg.dat''': definition file for [[Tidal Characteristic Numbers of Water Level]];
#* '''TDKV_ncanalyse_cfg.dat''': definition file for [[Tidal Characteristic Numbers of Current]];
#* '''TDXF_ncanalyse_cfg.dat''': definition file for [[Tidal Characteristic Numbers of Water Transport]];
#* '''TDKS_ncanalyse_cfg.dat''': definition file for [[Tidal Characteristic Numbers of Salinity]];
#* '''TDXS_ncanalyse_cfg.dat''': definition file for [[Tidal Characteristic Numbers of Salt Transport]];
#* '''TDKT_ncanalyse_cfg.dat''': definition file for [[Tidal Characteristic Numbers of Temperature]];
#* '''TDXT_ncanalyse_cfg.dat''': definition file for [[Tidal Characteristic Numbers of Heat Transport]];
#* '''TDKC_ncanalyse_cfg.dat''': definition file for [[Tidal Characteristic Numbers of Suspended Sediment Transport|Tidal Characteristic Numbers of Suspended Sediment]];
#* '''TDXC_ncanalyse_cfg.dat''': definition file for [[Tidal Characteristic Numbers of Suspended Load Transport]];
#* '''TDKP_ncanalyse_cfg.dat''': definition file for [[Tidal Characteristic Numbers of Tracer Load]];
#* '''TDXP_ncanalyse_cfg.dat''': definition file for [[Tidal Characteristic Numbers of Tracer Load Transport]];
#* '''TDKB_ncanalyse_cfg.dat''': definition file for [[Tidal Characteristic Numbers of Eff. Bed Shear Stress Action|Tidal Characteristic Numbers of Effective Bed Shear Stress]];
#* '''TDKG_ncanalyse_cfg.dat''': definition file for [[Tidal Characteristic Numbers of Bed Load Transport]];
#* '''TDKA_ncanalyse_cfg.dat''': definition file for [[Tidal Characteristic Numbers of Potential Energy Anomaly]];
#* '''FRQW_ncanalyse_cfg.dat''': definition file for [[Harmonic Analysis of Water Level]];
#* '''FRQV_ncanalyse_cfg.dat''': definition file for [[Harmonic Analysis of Current Velocity]];
#* '''LZKW_ncanalyse_cfg.dat''': definition file for [[Characteristic Numbers of Water Level (independent of tides)]];
#* '''LZKV_ncanalyse_cfg.dat''': definition file for [[Characteristic Numbers of Current Velocity (independent of tides)]];
#* '''LZKS_ncanalyse_cfg.dat''': definition file for [[Characteristic Numbers of Salinity (independent of tides)]];
#* '''LZKT_ncanalyse_cfg.dat''': definition file for [[Characteristic Numbers of Temperature (independent of tides)]];
#* '''LZKC_ncanalyse_cfg.dat''': definition file for [[Characteristic Numbers of Suspended Sediment Concentration (independent of tides)]];
#* '''LZKP_ncanalyse_cfg.dat''': definition file for [[Characteristic Numbers of Tracer Load (independent of tides)]];
#* '''LZKO_ncanalyse_cfg.dat''': definition file for [[Characteristic Numbers of Oxygen Concentration (independent of tides)]];
#* '''LZKM_ncanalyse_cfg.dat''': definition file for [[Characteristic Numbers of Morphodynamics (independent of tides)]];
#* '''LZKG_ncanalyse_cfg.dat''': definition file for [[Characteristic Numbers of Bed Load Transport (independent of tides)]];
#* '''LZKB_ncanalyse_cfg.dat''': definition file for [[Characteristic Numbers of Eff. Bed Shear Stress (independent of tides)]];
#* '''LZKA_ncanalyse_cfg.dat''': definition file for [[Characteristic Numbers of Potential Energy Anomaly (independent of tides)]];
#* '''LZXF_ncanalyse_cfg.dat''': definition file for [[Characteristic Numbers of Water Transport (independent of tides)]];
#* '''LZXS_ncanalyse_cfg.dat''': definition file for [[Characteristic Numbers of Salt Transport (independent of tides)]];
#* '''LZXT_ncanalyse_cfg.dat''': definition file for [[Characteristic Numbers of Heat Transport (independent of tides)]];
#* '''LZXP_ncanalyse_cfg.dat''': definition file for [[Characteristic Numbers of Tracer Transport (independent of tides)]];
#* '''LZXC_ncanalyse_cfg.dat''': definition file for [[Characteristic Numbers of Suspended Sediment Transport (independent of tides)]];
#* '''LZXG_ncanalyse_cfg.dat''': definition file for [[Characteristic Numbers of Sediment Transport (independent of tides)]] (bed an suspended load at the bottom);
#* '''LZXE_ncanalyse_cfg.dat''': definition file for [[Characteristic Numbers of Tidal Energy Transport]];
#* '''LZMW_ncanalyse_cfg.dat''': definition file for [[Characteristic Numbers of Meteorological Data (independent of tides)|Characteristic Numbers of Meteorological Data (Wind Speed)]];
#* '''LZSS_ncanalyse_cfg.dat''': definition file for [[Characteristic Numbers for Wave and Sea State (independent of tides)|Characteristic Numbers for Wave and Sea State (significant wave height)]].
|nutzerprogramme=[[NCANALYSE]]
|language=Fortran90
|fileform=FORMATTED
|fileaccess=SEQUENTIAL
|fileextension=.dat
|writemodules= ---
|readmodules=$PROGHOME/fortran/prg/ncanalyse/*/mod_m_ncanalyse_steer.f90
|contact_original=[mailto:guenther.lang@baw.de G. Lang]
|contact_maintenance=[mailto:guenther.lang@baw.de G. Lang], [mailto:susanne.spohr@baw.de S. Spohr]
|examplefile=$PROGHOME/examples/ncanalyse/ncanalyse.dat
}}

NCANALYSE

2023-03-29T13:16:25Z

Ak3spohr: update Version

{{ProgramDescription
|name_de=NCANALYSE
|name=NCANALYSE
|version=March 2023
|version_descr=September 2022
|catchwords=
data analysis 
postprocessor 
synoptic data sets 
measured time series data (optionally with [http://cfconventions.org/Data/cf-conventions/cf-conventions-1.6/build/cf-conventions.html#flags flag variables] for a more detailed qualification of data) 
depth averaged (2D) and depth structured data (3D) with z-layers 
[[Tidal Characteristic Numbers of Water Level|tidal characteristic numbers of water level]] 
[[Tidal Characteristic Numbers of Current|tidal characteristic numbers of current]], [[Tidal Characteristic Numbers of Water Transport|tidal characteristic numbers of water transport]] 
[[Tidal Characteristic Numbers of Salinity|tidal characteristic numbers of salinity]], [[Tidal Characteristic Numbers of Salt Transport|tidal characteristic numbers of salt transport]] 
[[Tidal Characteristic Numbers of Temperature|tidal characteristic numbers of temperature]], [[Tidal Characteristic Numbers of Heat Transport|tidal characteristic numbers of heat transport]] 
[[Tidal Characteristic Numbers of Suspended Sediment Transport|tidal characteristic numbers of suspended sediment]],
[[Tidal Characteristic Numbers of Suspended Load Transport|tidal characteristic numbers of suspended load transport]] 
[[Tidal Characteristic Numbers of Tracer Load|tidal characteristic numbers of tracer load]], [[Tidal Characteristic Numbers of Tracer Load Transport|tidal characteristic numbers of tracer load transport]] 
[[Tidal Characteristic Numbers of Eff. Bed Shear Stress Action|tidal characteristic numbers of effective bed shear stress]] 
[[Tidal Characteristic Numbers of Bed Load Transport|tidal characteristic numbers of bed load transport]] 
[[Tidal Characteristic Numbers of Potential Energy Anomaly|tidal characteristic numbers of potential energy anomaly]] 
[[Harmonic Analysis of Water Level|harmonic analysis of water level]] 
[[Harmonic Analysis of Current Velocity|harmonic analysis of current velocity]] 
[[Characteristic Numbers of Water Level (independent of tides)|characteristic numbers of water level (independent of tides)]] 
[[Characteristic Numbers of Current Velocity (independent of tides)|characteristic numbers of current velocity (independent of tides)]] 
[[Characteristic Numbers of Salinity (independent of tides)|characteristic numbers of salinity (independent of tides)]] 
[[Characteristic Numbers of Temperature (independent of tides)|characteristic numbers of temperature (independent of tides)]] 
[[Characteristic Numbers of Suspended Sediment Concentration (independent of tides)|characteristic numbers of suspended sediment concentration (independent of tides)]] 
[[Characteristic Numbers of Tracer Load (independent of tides)|characteristic numbers of tracer load (independent of tides)]] 
[[Characteristic Numbers of Oxygen Concentration (independent of tides)|characteristic numbers of oxygen concentration (independent of tides)]] 
[[Characteristic Numbers of Morphodynamics (independent of tides)|characteristic numbers of morphodynamics (independent of tides)]] 
[[Characteristic Numbers of Bed Load Transport (independent of tides)|characteristic numbers of bedload transport (independent of tides)]] 
[[Characteristic Numbers of Eff. Bed Shear Stress (independent of tides)|characteristic numbers of effective bed shear stress (independent of tides)]] 
[[Characteristic Numbers of Water Transport (independent of tides)|characteristic numbers of water transport (independent of tides)]]
 
[[Characteristic Numbers of Salt Transport (independent of tides)|characteristic numbers of salt transport (independent of tides)]]
 
[[Characteristic Numbers of Heat Transport (independent of tides)|characteristic numbers of heat transport (independent of tides)]]
 
[[Characteristic Numbers of Tracer Transport (independent of tides)|characteristic numbers of tracer transport (independent of tides)]] 
[[Characteristic Numbers of Suspended Sediment Transport (independent of tides)|characteristic numbers of suspended sediment transport (independent of tides)]] 
[[Characteristic Numbers of Sediment Transport (independent of tides)|characteristic numbers of sediment transport (independent of tides)]] (bed and suspended load at the bottom) 
[[Characteristic Numbers of Tidal Energy Transport|characteristic numbers of tidal energy transport]] 
[[Characteristic Numbers of Potential Energy Anomaly (independent of tides)|characteristic numbers of potential energy anomaly]] 
[[Characteristic Numbers of Meteorological Data (independent of tides)|characteristic numbers of meteorological data (wind speed)]] 
[[Characteristic Numbers for Wave and Sea State (independent of tides)|characteristic numbers for wave and sea state (significant wave height)]] 
[[NetCDF|CF NetCDF]] format for 2D/3D data 
orthogonal unstructured grid model 
orthogonal unstructured grid model with subgrid information 
data at individual locations (''Discrete Sampling Geometry'' featureType = '''timeSeriesProfile''') 
data at multiple locations along trajectories (''Discrete Sampling Geometry'' featureType = '''trajectoryProfile''') 
parallelization using [http://openmp.org/wp/ OpenMP] and [http://en.wikipedia.org/wiki/Message_Passing_Interface MPI] 
[[NetCDF#Quality assurance using NetCDF attributes|automatic quality assurance (value range)]] 
automatic adjustment of number of READ data to chunk size of data 
automatic setting of WRITE chunk sizes for written variables 
Storage of the content of the ASCII input control files in [[CF-NETCDF.NC|netcdf.nc]] (as a variable) 
Storage of [https://en.wikipedia.org/wiki/MD5 MD5 hash values] of input files in [[CF-NETCDF.NC|netcdf.nc]] (as a variable) 
optional closing of data gaps at reference positions by interpolation 

Acknowledgment: ''This project took advantage of netCDF software developed by UCAR/Unidata ([http://www.unidata.ucar.edu/software/netcdf/ www.unidata.ucar.edu/software/netcdf/]).''

|shortdescription=
Program NCANALYSE serves as an analysis program for data stored in CF netCDF data files.

|inputfiles=
# '''general input data''' (file type [[NCANALYSE.DAT|ncanalyse.dat]]);
# '''synoptic data sets''' (file type [[CF-NETCDF.NC]]);
# for [[NetCDF#Automatic quality assurance using NetCDF attributes|automatic quality assurance]] (file type [[BOUNDS.CFG.DAT|bounds_verify.dat]]).

|outputfiles=
# '''data analysis result files''' (file type [[CF-NETCDF.NC]])
# (optional) informative '''printer file''' of program execution (file type ncanalyse.sdr)
# (optional) '''trace''' of program execution (file type ncanalyse.trc)

|methodology=
The following data analysis methods are currently available:
* Tidal Characteristic Numbers:
*# [[Tidal Characteristic Numbers of Water Level]];
*# [[Tidal Characteristic Numbers of Current]];
*# [[Tidal Characteristic Numbers of Salinity]];
*# [[Tidal Characteristic Numbers of Temperature]];
*# [[Tidal Characteristic Numbers of Suspended Sediment Transport|Tidal Characteristic Numbers of Suspended Sediment]];
*# [[Tidal Characteristic Numbers of Tracer Load]];
*# [[Tidal Characteristic Numbers of Eff. Bed Shear Stress Action|Tidal Characteristic Numbers of Effective Bed Shear Stress]];
*# [[Tidal Characteristic Numbers of Bed Load Transport]];
*# [[Tidal Characteristic Numbers of Potential Energy Anomaly]].
* Tide-dependent Characteristic Numbers for Transport-Processes (based on ''exact'' integrals):
*# [[Tidal Characteristic Numbers of Water Transport]];
*# [[Tidal Characteristic Numbers of Salt Transport]];
*# [[Tidal Characteristic Numbers of Heat Transport]];
*# [[Tidal Characteristic Numbers of Suspended Load Transport]];
*# [[Tidal Characteristic Numbers of Tracer Load Transport]].
* Harmonic Analysis:
*# [[Harmonic Analysis of Water Level]];
*# [[Harmonic Analysis of Current Velocity]].
* Tide-Independent Characteristic Numbers:
*# [[Characteristic Numbers of Water Level (independent of tides)]];
*# [[Characteristic Numbers of Current Velocity (independent of tides)]];
*# [[Characteristic Numbers of Salinity (independent of tides)]];
*# [[Characteristic Numbers of Temperature (independent of tides)]];
*# [[Characteristic Numbers of Suspended Sediment Concentration (independent of tides)]];
*# [[Characteristic Numbers of Tracer Load (independent of tides)]];
*# [[Characteristic Numbers of Oxygen Concentration (independent of tides)]];
*# [[Characteristic Numbers of Morphodynamics (independent of tides)]];
*# [[Characteristic Numbers of Bed Load Transport (independent of tides)]];
*# [[Characteristic Numbers of Eff. Bed Shear Stress (independent of tides)]];
*# [[Characteristic Numbers of Potential Energy Anomaly (independent of tides)]].
* Tide-Independent Characteristic Numbers for Transport-Processes (based on ''exact'' integrals):
*# [[Characteristic Numbers of Water Transport (independent of tides)]];
*# [[Characteristic Numbers of Water Transport (independent of tides)]];
*# [[Characteristic Numbers of Salt Transport (independent of tides)]];
*# [[Characteristic Numbers of Heat Transport (independent of tides)]];
*# [[Characteristic Numbers of Tracer Transport (independent of tides)]];
*# [[Characteristic Numbers of Suspended Sediment Transport (independent of tides)]];
*# [[Characteristic Numbers of Sediment Transport (independent of tides)]] (bed an suspended load at the bottom).
* Tidal Energy Transport:
*# [[Characteristic Numbers of Tidal Energy Transport]]
* Characteristic Numbers of Meteorological Data:
*# [[Characteristic Numbers of Meteorological Data (independent of tides)|wind speed]].
* Characteristic Numbers for Wave and Sea State:
*# [[Characteristic Numbers for Wave and Sea State (independent of tides)|significant wave height]].

Just in case '''HDF error''' is detected during read of a data record, the program tries to reconstruct the wanted data set from adjacent (in time) records for the same variable. This type of repair works for time dependent variables only.

|preprocessor=[[BOE2NC]], [[DATACONVERT]], [[GRIDCONVERT]], [[NCAGGREGATE]], [[NCCHUNKIE]], [[NCCUTOUT]], [[NCDVAR]], [[NCMERGE]], [[NetCDF Operators]], [[QUICKPLOT]], [[UNTRIM2007]], [[UNTRIM2]]
|postprocessor=[[DAVIT]], [[DISPLAY_CONTROL_VOLUMES]], [[NCAGGREGATE]], [[NCAUTO]], [[NCCHUNKIE]], [[NCCUTOUT]], [[NCDELTA]], [[NCDVAR]], [[NCPLOT]], [[NC2TABLE]], [[PLOTPROFILZEIT]], [[PLOTTS]]
|language=Fortran95
|add_software=---
|contact_original=G. Lang
|contact_maintenance=[mailto:pos.proghome@baw.de Working group POS]
|documentation=
* Presentations (many available in German only):
** 2021-06-16: [http://doi.org/10.13140/RG.2.2.20390.45120 ''Tidal Asymmetry - Classical Parameters vs Skewness''] (DOI: [http://doi.org/10.13140/RG.2.2.20390.45120 http://doi.org/10.13140/RG.2.2.20390.45120]);
** 2015-05-29: [http://ewisa.baw.de/files/12556_tv12_2015_05_29_tide_energie_transport_g_lang.pdf ''Tidewelle und Energietransport''] (DOI: [http://dx.doi.org/10.13140/RG.2.2.31352.14089 http://dx.doi.org/10.13140/RG.2.2.31352.14089]);
** 2014-12-03: [http://ewisa.baw.de/files/11284_tv12_2014_12_03_ncanalyse_lzks_g_lang.pdf ''NCANALYSE - Tideunabhängige Kennwerte des Salzgehalts''];
** 2014-12-03: [http://ewisa.baw.de/files/11285_tv12_2014_12_03_ncanalyse_tdks_g_lang.pdf ''NCANALYSE - Tidekennwerte des Salzgehalts''];
** 2014-10-08: [http://ewisa.baw.de/files/10587_tv12_2014_10_08_ncanalyse_lzkv_g_lang.pdf ''NCANALYSE - Tideunabhängige Kennwerte der Strömung''];
** 2014-09-10: [http://ewisa.baw.de/files/10588_tv12_2014_09_10_allgemein_g_lang.pdf ''NCANALYSE - Tidekennwerte der Strömung''];
** 2013-08-07: [http://ewisa.baw.de/files/08510_speech_2013-08-07.pdf ''NCANALYSE - Tideunabhängige Kennwerte des Wasserstands''];
** 2013-05-15: [http://ewisa.baw.de/files/08500_speech_2013-05-15.pdf ''NCANALYSE - Daten aus CF netCDF Dateien analysieren''].
* [https://izw-campus.baw.de/ ''IZW-Campus''] (Podcast, available in German only)
** 2022-04-25: [https://izw-campus.baw.de/goto.php?target=cat_4105&client_id=iliasclient ''NCANALYSE - Grundlagen am Beispiel der Analyse LZKW (tideunabhängige Kennwerte des Wasserstands)''];
** 2022-03-21: [https://izw-campus.baw.de/goto.php?target=cat_3829&client_id=iliasclient ''Energietransport einer Tidewelle''];
** 2021-11-29: [https://izw-campus.baw.de/goto.php?target=cat_3490&client_id=iliasclient ''NCANALYSE - Grundlagen - Wechselwirkung zwischen Salzgehalt und Schwebstoffgehalt''];
** 2021-10-18: [https://izw-campus.baw.de/goto.php?target=cat_3301&client_id=iliasclient ''NCANALYSE - Grundlagen verschiedener Kennwerte (Einfluss des Salzgehalts auf verschiedene Kenngrößen)''];
** 2021-09-13: [https://izw-campus.baw.de/goto.php?target=cat_3102&client_id=iliasclient ''NCANALYSE - Grundlagen TDKA (Tidekennwerte der Anomalie der Potentiellen Energie)''];
** 2021-08-09: [https://izw-campus.baw.de/goto.php?target=cat_1830&client_id=iliasclient ''NCANALYSE - Grundlagen TDKS (Tidekennwerte des Salzgehalts)''];
** 2021-06-07: [https://izw-campus.baw.de/goto.php?target=cat_2554&client_id=iliasclient ''NCANALYSE Update zu Skewness - aus Partialtiden des Wasserstands und der Strömung''];
** 2021-04-19: [https://izw-campus.baw.de/goto.php?target=cat_2329&client_id=iliasclient ''NCANALYSE - Grundlagen am Beispiel der Analyse FRQV (Harmonische Analyse der Strömung)''];
** 2021-03-08: [https://izw-campus.baw.de/goto.php?target=cat_2224&client_id=iliasclient ''NCANALYSE - Grundlagen am Beispiel der Analyse FRQW (Harmonische Analyse des Wasserstands)''];
** 2021-02-08: [https://izw-campus.baw.de/goto.php?target=cat_1940&client_id=iliasclient ''NCANALYSE - Grundlagen am Beispiel der Analyse TDKV (Tidekennwerte der Strömungsgeschwindigkeit)''];
** 2021-01-11: [https://izw-campus.baw.de/goto.php?target=cat_1853&client_id=iliasclient ''NCANALYSE - Grundlagen am Beispiel der Analyse TDKW (Tidekennwerte des Wasserstands)''].
* Template input files:
** template files available in '''$PROGHOME/examples/ncanalyse'''
}}

NCPLOT.DAT

2023-01-03T15:29:42Z

Ak3spohr: Added new features with version ncplot_2022_09_28

{{FileDescription
|name_de=NCPLOT.DAT
|filetype=ncplot.dat
|version=January 2023
|version_descr=January 2023
|significance=contains general steering data for the program [[NCPLOT]].
|filecontents=

===Block "Program_Parameters"===
The block '''Program_Parameters''' contains general steering data.
* Key '''"Language" :''' Language preference for labels and texts:
:*'''DE''' = German,
:*'''EN''' = English.
* Key '''"Max_Read_Storage" :''' max. read only memory (in bytes) for analysis
* Key '''"Min_Water_Depth" :''' minimum water coverage in [m].
:Hint: The excluding of data from the presentation in case of low water coverage is only possible, if the variable to be displayed points in a certain way to a variable associated with the total water depth. The CF-NetCDF output of UnTRIM programs fulfills this requirement. The page '''''[[NCPLOT: Min_Water_Depth]]''''' illustrates the effect of this control parameter.
* (optional) Key '''"Infobox_Plot_Area" :''' Image area for the metadata infobox.
:If this image area is specified, information about the plot creation will be given to the graphic. This includes information about the underlying data files as well as if neccessary information about used data filtering.
* (optional) Key '''"PLR_Representation" :''' Default setting for line symbols of data curves in line charts.
* (optional) Key '''"PMR_Representation" :''' Default setting for marker symbols of data curves in line charts.
* (optional) Key '''"PLR_Palette" :''' Color palette and start color for line symbols of data curves in line charts.
* (optional) Key '''"PMR_Palette" :''' Color palette and start color for marker symbols of data curves in line charts.
* (optional) Key '''"Picture_Name_Fixum" :''' fixed name part for graphic file(s).
* (optional) Key '''"Phydef_Units" :''' Display physical units as in PHYDEF administration.
:Hint: Without explicit request, the units are displayed according to the BAW Rules.
* (optional) Key '''"Output_Format" :''' Output format for the generated graphics (CGM or SVG).

===Block "SVG_Specifications"===
Optional block with attributes for graphic output in SVG format.
* (optional) Key '''"SVG_Maximum_Size" :''' Maximum size of the SVG graphic, i.e. factor for converting NDC space from GKS to SVG space.
* (optional) Key '''"SVG_Font_Family" :''' Font family for text elements.
* (optional) Key '''"SVG_Free_Text_Attributes" :''' Font attribute(s) that are given to ALL texts of the SVG graphic.
* (optional) Key '''"SVG_Axis_Text_by_Char" :''' Write texts on diagram axes character by character (as in CGM format).
* (optional) Key '''"SVG_Legend_Box_by_Char" :''' Write legend texts of line charts character by character (as in CGM format).

===Block "Dataset"===
Description of a data set to be displayed. 
 
For addressing the data to be displayed, either the Start-Step-Stride technique
or the DimSelect method is available. The user has to choose one way or the other,
the procedures exclude each other. Each Start-Step-Stride-Addressing can be copied
by DimSelect, the other way round that is not the case.
DimSelect offers additional options for data selection, with the method
you can also realize non-equidistant index selection.
;Start-Step-Stride technique:
:For each dimension of the variable a start, step and stride value must be specified. The page '''''[[NCPLOT: Define DataSet]]''''' gives instructions for addressing the desired data.
;DimSelect method:
:DimSelect also requires the addressing of the indices for each dimension of the data variables to be displayed. But this can also happen indirectly. Various suitable selection methods are provided. The user can, for example, choose all faces by '''''DimSelect_All''''' without knowing the specific number, or pass the program via '''''DimSelect_Various_Date''''' a selection of times to be displayed. It is the responsibility of the program to find the corresponding indices. Related to data curves of line charts the DimSelect method offers a further advantage: For the individual dimensions this mimic allows to create text components for the names of the data series shown in the curve legend. 
Control file can contain multiple blocks of this type.
* Key '''"Name" :''' unique name of this data set.
* Key '''"File" :''' name of the CF-NetCDF file (*.nc) with the data to be displayed.
* Key '''"Variable" :''' Description of the data whose values are to be displayed.
:* Parameter '''1''' = name of the variable (in file of type *.nc)
:* (optional) Parameter '''2''' = role of the variable as part of a vector
::* X-component = Variable is the X component of a vector
::* Y-component = Variable is the Y component of a vector
::* normal_component = Variable is the normal component of a vector
:Hint: The command "ncdump -h <filename>.nc" shows the header of the CF-NetCDF file. The names of the offered variables and their dimensions can be found in the metadata.
* (optional) Key '''"Start" :''' start address for the data to be displayed.
* (optional) Key '''"Step" :''' number of steps for the data to be displayed.
* (optional) Key '''"Stride" :''' increment for the data to be displayed.
* (optional) Key '''"DimSelect_EquiDist_Index" :''' Equidistant selection of indices for a given dimension. Exemplary:
:* Parameter '''1''' = Name of the dimension
:* Parameter '''2''' = NONE or text component for curve legend
:* Parameter '''3''' = Index becomes part of the curve legend .true./.false.
:* Parameter '''4''' = Start Index
:* Parameter '''5''' = Index increment
:* Parameter '''6''' = Number of steps
* (optional) Key '''"DimSelect_EquiDist_Date" :''' Equidistant selection of times.
* (optional) Key '''"DimSelect_StartEnd_Index" :''' Selection of all indices from start to end index.
* (optional) Key '''"DimSelect_StartEnd_Date" :''' Selection of all times from start to end date.
* (optional) Key '''"DimSelect_Single_Index" :''' Selection of a specific index.
* (optional) Key '''"DimSelect_Single_Date" :''' Selection of a specific date.
* (optional) Key '''"DimSelect_Various_Index" :''' List of various indices.
* (optional) Key '''"DimSelect_Various_Date" :''' List of various dates.
* (optional) Key '''"DimSelect_All" :''' Selection of all indices of a dimension.
* (optional) Key '''"DimSelect_ByLabel_LabVar" :''' Determine indices with list of names by label variable.
* (optional) Key '''"DimSelect_ByLabel_List" :''' Continuation line to Key '''''DimSelect_ByLabel_LabVar'''''.
* (optional) Key '''"DimSelect_Location_Coord" :''' Selection of locations by coordinates.
* (optional) Key '''"DimSelect_LocByFile_File" :''' Selection of locations from file with locations.
* (optional) Key '''"DimSelect_LocByFile_List" :''' Continuation line to Key '''''DimSelect_LocByFile_File'''''.
* (optional) Key '''"Dimensions_for_Picture_Series" :''' Requesting seperate presentations for selected dimensions.
:Hint: Causes series of pictures, i.e. for each selected index of the dimensions listed here a separate picture is created. Only works with line charts. Picture series must be the same length!
* (optional) Key '''"Dataset_UUID_Textbox" :''' textbox for entering the UUID of the dataset's NetCDF file.

===Block "Layer"===
A block of type Layer defines a area diagram.
The illustration in the horizontal plane (the map view) differs fundamentally
from the area charts with axes. 
Control file can contain multiple blocks of this type.
* Key '''"Name" :''' unique name of this layer and the possibility of assigning a different plot level to the diagram.
* Key '''"Layer_Dataset_Name" :''' name of the dataset to be displayed. Or a valid connexion (OPERATOR string) made out of known data sets, e. g. '''[DSet2-DSet1]/[DSet1+DSet2]''', '''ABS[DSet]''', '''SQR[DSet]''' or '''G18[DSet]'''. Constant factors in arithmetic operation possible.
* Key '''"Layer_Type" :''' type of data view of this layer.
:*'''XY_data''' = Map, or top view illustration (horizontal plane)
:*'''PZ''' = Vertical section along profile (3D data)
:*'''TZ''' = Time depth diagram (3D data)
:*'''PT''' = Hovmöller diagram variant 1: X-axis=profile axis (P), Y-axis=time axis (T).
:*'''TP''' = Hovmöller diagram variant 2: X-axis=time axis (T), Y-axis=profile axis (P).
* Key '''"Layer_Primitive_Name" :''' graphic primitive to visualize the data in the layer.
:* Parameter '''1''' = Symbolization of the layer
::*'''GPM''' = as poly marker
::*'''GPL''' = as poly line (only Layer_Type ''XY_data'')
::*'''GFA''' = as fill area
::*'''GTX''' = as text
::*'''VEC''' = as vector (only Layer_Type ''XY_data'')
:* (optional) Parameter '''2''' = Type of the vector ... optional parameter, only at VEC visualization permitted. ...allows, for example, the interpolation of the total vector from the normal component a vectorial quantity.
::*'''total''' = total vector
::*'''normal''' = normal vector
* Key '''"Layer_Primitive_Representation_Name" :''' name of the representation of the primitive.
* Key '''"Layer_Bounds_Name" :''' name of the interval definition for this layer (from the file '''''[[BOUNDS.CFG.DAT|bounds.cfg.dat]]''''').
:Hint: The number of intervals in the interval definition and the number of colors of the associated color legend must match.
* Key '''"Layer_Palette_Name" :''' name of the color legend for this layer (corresponds to the attribute ''Name'' in the file ''palette.dat''. More detailed information about palettes on file description page '''''[[PALETTES.CFG.DAT|palettes.cfg.dat]]''''').
* Key '''"Layer_Invert_Palette" :''' invertation of the color ramp.
* (optional) Key '''"Layer_Normalization_Transformation_Name" :''' name of the normalization transformation for this layer.
:Hint: Required for diagram definition map view (Layer_Type ''XY_data'').
* (optional) Key '''"Layer_Area" :''' Image area spanned by the diagram axes.
:Hint: Required for definitions of diagrams working with axes.
* (optional) Key '''"Layer_Extent" :''' Total area that the diagram in the picture takes up.
:Hint: Required for definitions of diagrams working with axes.
* (optional) Key '''"Layer_X-Axis" :''' X-axis of the diagram and its positioning.
:Hint: Required for definitions of diagrams working with axes.
* (optional) Key '''"Layer_Y-Axis" :''' Y-axis of the diagram and its positioning.
:Hint: Required for definitions of diagrams working with axes.
* (optional) Key '''"Layer_Legend_Plot_Area" :''' image area for the color legend of this layer. Depending on the space, the color legend can be applied horizontally or vertically.
* (optional) Key '''"Layer_Legend_Label_Switch" :''' Switch list for switching off or positioning labels of the color legend.
* (optional) Key '''"Layer_Data_Description_Name" :''' name of the '''''Data_Description''''' text box, which should collects up the data description (e.g. indication of the time) of this layer.
* (optional) Key '''"Layer_Display_Units" :''' physical unit in which the data should be converted for the graphical presentation.
:Hints: The original unit of the data and the target unit must be known in the configuration file '''''phydef.cfg.si.dat'''''. In addition, the SI-base (dimension) of the units must be identical.
* (optional) Key '''"Layer_Display_Name" :''' name of physical quantity, will be used instead of the original name given in the input data set. Without this line the name in PHYDEF is used, if the variable owns the attribute '''''name_id'''''.. Dynamic text parts can be realized with special placeholders:
:*<LAY_DSET> will be replaced by the name of the dataset associated with the layer.
:*<LAY_DIM1> will be replaced by the info text for the 1st dimension of the displayed data set.
:*<LAY_DIM2> will be replaced by the info text for the 2nd dimension of the displayed data set.
:*<LAY_DIM?> etc. to the number of data set dimensions.
* (optional) Key '''"Layer_Vector_Legend_Plot_Area" :''' image area for the vector legend in case of arrows with length_type proportional.
* (optional) Key '''"Layer_Vector_Thinout_Raster" :''' dimensions of the grid used to thin out the display of vector arrows.
* (optional) Key '''"Layer_NOBS_Filter" :''' filter for displayed data based on ''ancillary variable'' with type ''number of observations'':
** parameter 1: filter type:
*** '''EQ''' = display data only for a fixed number of observations;
*** '''LE''' = display data for a certain number of observations or less;
*** '''LE''' = display data for a certain number of observations or more.
** parameter 2: filter value:
*** '''0''' = maximum number of observations;
*** '''N''' = specified number of observations;
*** '''-M''' = maximum number of observations minus M.
* (optional) Key '''"Layer_Description_Textbox" :''' name of a textbox to be linked with the layer.
* (optional) Key '''"Layer_Route_Dataset" :''' name of a '''''dataset''''' with profile route for sorting and filtering data to be displayed.
* (optional) Key '''"Layer_Legend_Number_Format" :''' Format specification for numerical values of the color legend.
* (optional) Key '''"Layer_ASCII_Output" :''' Write data displayed in layer to text file.

===Block "Normalization_Transformation (NTN)"===
Definition of an image section and description of the link between the world and image
coordinates. 
A block of this type is only required for areal representation in the horizontal plane
(layer definition with Type == XY_Data). 
The coordinates of the drawing area, the so-called NDC space, range from [0.0,0.0] to [1.0,1.0].
For an undistorted view of the area the representation scale in the X direction must match
the scale in Y-direction (DWC / DNDC = const);
optionally also key '''"Autoscale"''' can be used for this purpose.
Distorted representations are also possible. 
* Key '''"Name" :''' unique name of this normalization transformation.
* Key '''"EPSG" :''' EPSG code of the data coordinates in the file.
* Key '''"EPSG_Window" :''' EPSG code of the plot projection.
* Key '''"Left_Lower_Window_Coordinates" :''' world coordinates (according to EPSG) the lower left corner of the projection window.
* Key '''"Right_Upper_Window_Coordinates" :''' world coordinates (according to EPSG) the upper right corner of the projection window.
* Key '''"Left_Lower_NDC_Coordinates" :''' picture coordinates (NDC within [0.0,1.0]) the lower left corner of the projection window.
* Key '''"Right_Upper_NDC_Coordinates" :''' picture coordinates (NDC within [0.0,1.0]) the upper right corner of the projection window.
* (optional) Key '''"Autoscale" :''' automatic adjustment (.true.) of scales in X- and Y-direction. Default is .false. (no adjustment).
* (optional) Key '''"Scale_Bar_Request"''' : Request drawing a scale bar. Autoscale needs to be on.
* (optional) Key '''"NTN_Framing" :''' Type of the coordinate frame when displayed as map.
:Hint: More info at '''''[[NCPLOT: Framing|Options of map frames]]'''''.

===Block "Data_Description"===
The block '''Data_Description''' defines a Data_Description object.
Such an object collects data descriptions and displays them together in a text field. 
A block of this type is currently only needed for area charts in the horizontal plane (Layer definition with Type == XY_Data). 
Control file can contain multiple blocks of this type.
* Key '''"Data_Desc_Name" :''' unique name of the text field for data descriptions.
* Key '''"Data_Desc_Plot_Area" :''' image area for the Data_Description text box.
* (optional) Key '''"Data_Desc_Draw_Frame" :''' draw a frame around the Data Description text box TRUE/FALSE.
* (optional) Key '''"Data_Desc_Color_Name" :''' name of the color for text and frame.

===Block "LineChart"===
The block '''LineChart''' is used to define a line diagram. 
A "LineChart" has only one X- and one Y-axis.
A secondary Y-axis must be realized by defining a second "LineChart" object
on the same drawing area and with the same X-axis. 
Any number of LineCharts can be stacked. The associated axes can be positioned
on all four sides of the diagram and can also be moved away from the drawing
area by different distances.
Thus, for example, on the sheet "one" time series diagram with three Y-axes
can be generated that represents the curves for flow amount, flow direction
and salinity together. 
Control file can contain multiple blocks of this type.
* Key '''"LineChart_Name" :''' unique name of the line chart and the possibility of assigning a different plot level to the diagram.
* Key '''"LineChart_Type" :''' type of line chart.
:*'''TG''' = Time series; Data over time
:*'''PG''' = Profile chart; Data over profile axis
:*'''GZ''' = Depth profile; 3D data along depth axis
* Key '''"LineChart_Area" :''' image area spanned by the diagram axes.
* Key '''"LineChart_Extent" :''' total area occupied by the diagram on the image.
* Key '''"LineChart_X-Axis" :''' X-axis of the diagram and its positioning.
* Key '''"LineChart_Y-Axis" :''' Y-axis of the diagram and its positioning.
* (optional) Key '''"LineChart_Legend_Box" :''' name of a '''''Legend_Box''''', the object/area in which the curve legends of the diagram are stored and presented.
* (optional) Key '''"LineChart_Route_Dataset" :''' name of a '''''dataset''''' with profile route for sorting and filtering data to be displayed.
* (optional) Key '''"LineChart_PLR_Representation" :''' line Symbolization for the data curves of this diagram.
* (optional) Key '''"LineChart_PMR_Representation" :''' marker Symbolization for the data curves of this diagram.
* (optional) Key '''"LineChart_PLR_Palette" :''' color palette and start color for line symbols of this line chart.
* (optional) Key '''"LineChart_PMR_Palette" :''' color palette and start color for marker symbols of this line chart.
* (optional) Key '''"LineChart_FillArea_Between_Series" :''' Coloring of areas between two data series.
* (optional) Key '''"LineChart_FillArea_Series_Values" :''' Coloring of areas between a data series and a specific value.

===Block "Axis"===
The block '''Axis''' is used to define a diagram axis. 
An axis definition can be used for varius diagrams.
For example superposed "LineCharts" or several diagrams arranged
one below the other with the same time axis. 
Control file can contain multiple blocks of this type.
* Key '''"Axis_Name" :''' unique name of the axis definition.
* Key '''"Axis_Type" :''' type of axis.
:*'''T''' = time axis
:*'''G''' = axis for physical quantities
:*'''P''' = profile axis
:*'''Z''' = depth axis
* (optional) Key '''"Axis_Value_Range" :''' value range of the axis.
* (optional) Key '''"Axis_Date_Range" :''' time range of the axis.
* (optional) Key '''"Axis_Scale_Logarithmic" :''' switch logarithmic scaling LOG10 on TRUE/FALSE.
* (optional) Key '''"Axis_Invert_Profile_Route" :''' switch invert the route of a profile axis TRUE/FALSE.
* (optional) Key '''"Axis_Scale_Multiplicator" :''' multiplication factor for axis scaling.
* (optional) Key '''"Axis_Display_Name" :''' axis title, will be used instead of the original name given in the input data.
* (optional) Key '''"Axis_Display_Unit" :''' physical unit in which the data should be converted for the graphical presentation.
:Hints: The original unit of the data and the target unit must be known in the configuration file '''''phydef.cfg.si.dat'''''. In addition, the SI-base (dimension) of the units must be identical.
* (optional) Key '''"Axis_Labels_EquiDist_Value" :''' equidistant values for labeling along the axis.
* (optional) Key '''"Axis_Labels_EquiDist_Date" :''' equidistant dates for labeling along the axis.
* (optional) Key '''"Axis_Labels_at_Values" :''' list of values for labeling along the axis.
* (optional) Key '''"Axis_Labels_at_Dates" :''' list of dates for labeling along the axis.
* (optional) Key '''"Axis_Line_Representation" :''' name of a ''Poly_Line_Representation'' for the representation of the axis line.
* (optional) Key '''"Axis_Text_Representation" :''' name of a ''Text_Representation'' for the axis labeling (only influencing the font color).
* (optional) Key '''"Gitternetz_Representation" :''' name of a ''Poly_Line_Representation'' for the gridlines or switch off these lines with NONE.
* (optional) Key '''"Tickmark_Representation" :''' formatting or switching off axis tickmarks.
:* Parameter '''1''' = name of a color for the tickmarks
:* Parameter '''2''' = width of the tickmark line
:* Parameter '''3''' = length of tickmarks in image coordinates; 0.0 turn it off!
* (optional) Key '''"Axis_Additional_Line_Value" :''' draw an additional line vertical to the axis at a certain value.
* (optional) Key '''"Axis_Additional_Line_Date" :''' draw an additional line vertical to the time axis at a certain date.
* (optional) Key '''"Axis_Additional_Line_Coord" :''' draw an additional line vertical to the profile axis at a certain location.
* (optional) Key '''"Axis_Font_Size" :''' font size of the axis labeling.
* (optional) Key '''"Characters_along_Axis" :''' fixed number of characters for relative font size calculation.
* (optional) Key '''"Axis_Number_Format" :''' Format specification for numerical values of the axis scaling.

===Block "DataRow"===
The block '''DataRow''' is used to describe a data series, or a group
of data series. 
Due to the data addressing in the ''DataSet'', a ''DataRow'' description can
result in several data series.
All these data series end up in the same line diagramm. 
Blocks of this type are needed for line charts. 
Control file can contain multiple blocks of this type.
* Key '''"DataRow_Name" :''' unique name of the data row description.
* Key '''"DataRow_Dataset" :''' name of the dataset to be displayed. Or a valid connexion (OPERATOR string) made out of known data sets, e. g. '''[DSet2-DSet1]/[DSet1+DSet2]''', '''ABS[DSet]''', '''SQR[DSet]''' or '''G18[DSet]'''.
* Key '''"DataRow_LineChart" :''' name of the ''LineChart'', i.e. of the line diagram in which the data series are to be drawn.
* (optional) Key '''"DataRow_PLR_Representation" :''' line symbolization for the data curves of this data series.
* (optional) Key '''"DataRow_PMR_Representation" :''' marker symbolization for the data curves of this data series.
* (optional) Key '''"DataRow_PLR_Palette" :''' color palette and start color for line symbols of this data series.
* (optional) Key '''"DataRow_PMR_Palette" :''' color palette and start color for marker symbols of this data series.
* (optional) Key '''"DataRow_NoValue_Handling" :''' Handling invalid values in the data series.
:*'''Luecke''' = Points without data are not displayed
:*'''Interpolation''' = a straight line closes the data gap in the curve
* (optional) Key '''"DataRow_NOBS_Filter" :''' filter for displayed data based on ''ancillary variable'' with type ''number of observations'':
** parameter 1: filter type:
*** '''EQ''' = display data only for a fixed number of observations;
*** '''LE''' = display data for a certain number of observations or less;
*** '''LE''' = display data for a certain number of observations or more.
** parameter 2: filter value:
*** '''0''' = maximum number of observations;
*** '''N''' = specified number of observations;
*** '''-M''' = maximum number of observations minus M.
* (optional) Key '''"DataRow_Linked_Textbox" :''' name of a textbox to be linked with this DataRow group.
* (optional) Key '''"DataRow_Legend_Box" :''' name of a Legend_Box in which the curve legends of this DataRow group are presented.

===Block "Legend_Box"===
A legend box collects names and symbolizations of data curves and
displays them together in a text field.
A legend field can accommodate curve descriptions from different diagrams. 
A block of this type is only needed by line charts. 
Control file can contain multiple blocks of this type.
* Key '''"Legend_Box_Name" :''' unique name of the legend field.
* Key '''"Legend_Box_Plot_Area" :''' image area for the legend field.
* (optional) Key '''"Legend_Box_Color_Name" :''' colors of the legend box.
** parameter 1: for text and frame
** (optional) parameter 2: for the background
* (optional) Key '''"Legend_Box_Draw_Frame" :''' draw a frame around the legend field TRUE/FALSE.
* (optional) Key '''"Legend_Box_Frame_Style" :''' appearance of the legend box frame.
** parameter 1: line width
** (optional) parameter 2: line type
* (optional) Key '''"Legend_Box_Font_Size" :''' font size can be preset.
* (optional) Key '''"MaxCharNumber_LegendEntry" :''' fixed number of characters for relative font size calculation.
* (optional) Key '''"Legend_Box_Orientation" :''' arrangement of legend entries.
* (optional) Key '''"Legend_Box_HIDE_List" :''' legend entries of this list are NOT displayed.
* (optional) Key '''"Legend_Box_SHOW_List" :''' ONLY the legend entries of this list are shown.

===Block "Textbox"===
Description of one free text field. 
An empty text box can act as rectangular frame, with the color, type and width of the line
being adjustable. If you give the text box a background color, you can use it to cover
a particular area of the diagram. 
Control file can contain multiple blocks of this type.
* Key '''"Name" :''' unique name of the text box.
* Key '''"Plot_Area" :''' image area for the text box.
* (optional) Key '''"Text_Line" :''' one line of the text box. Specification of several lines possible. Placeholder for system information:
:*<SYS_DATE> will be replaced by current date.
:*<SYS_TIME> will be replaced by current time.
:*<SYS_USER> will be replaced by User ID.
:Placeholder for text box, which is connected to a Layer:
:*<LAY_DSET> will be replaced by the name of the dataset associated with the layer.
:*<LAY_DIM1> will be replaced by the info text for the 1st dimension of the displayed data set.
:*<LAY_DIM2> will be replaced by the info text for the 2nd dimension of the displayed data set.
:*<LAY_DIM?> etc. to the number of data set dimensions.
:Hint: Linking is realized in the layer block via KEY ''Layer_Description_Textbox''.
:Placeholder for a text box, which is connected to a DataRow block:
:*<ROW_T_DROW>, <ROW_F_DROW> will be replaced by the name of the DataRow block.
:*<ROW_T_DSET>, <ROW_F_DSET> will be replaced by the name of the dataset associated with the DataRow.
:*<ROW_T_DIM1>, <ROW_F_DIM1> will be replaced by the info text for the 1st dimension of the displayed data set.
:*<ROW_T_DIM2>, <ROW_F_DIM2> will be replaced by the info text for the 2nd dimension of the displayed data set.
:*<ROW_T_DIM?>, <ROW_F_DIM?> etc. to the number of data set dimensions.
:Hint: Linking is realized in the DataRow block via KEY ''DataRow_Linked_Textbox''.
* (optional) Key '''"Color_Name" :''' colors of the textbox.
** parameter 1: for text and frame
** (optional) parameter 2: for the background
* (optional) Key '''"Draw_Frame" :''' draw a frame around the text box TRUE/FALSE.
* (optional) Key '''"Frame_Style" :'''appearance of the text box frame.
** parameter 1: line width
** (optional) parameter 2: line type
* (optional) Key '''"Fixed_Width" :''' character-wise writing with constant width or not.
* (optional) Key '''"Horizontal_Char_Space" :''' Horizontal character distance factor for character-wise writing.
* (optional) Key '''"Vertical_Line_Space" :''' Vertical line spacing factor.
* (optional) Key '''"Font_Size" :''' font size can be preset.
* (optional) Key '''"Font_Size_Factor" :''' factor for manipulating the calculated font size.
* (optional) Key '''"MaxCharNumber_TextLine" :''' fixed number of characters for relative font size calculation.

===Block "Poly_Marker_Representation"===
Description of one type of marker symbols. 
Control file can contain multiple blocks of this type.

===Block "Fill_Area_Representation"===
Description of one type of fill area symbolization. 
Control file can contain multiple blocks of this type.

===Block "Poly_Line_Representation"===
Description of one type of line symbolization. 
Control file can contain multiple blocks of this type.

===Block "Text_Representation"===
Description of one type of text symbolization. 
Control file can contain multiple blocks of this type.

===Block "Vector_Representation"===
Description of one type of vector symbolization. 
Control file can contain multiple blocks of this type. 
Hint: More info at '''''[[NCPLOT: Types of vector symbols]]'''''.

===General Remarks===
# While reading this steering data file the '''dictionary file''' '''''ncplot_dico.dat''''' will be automatically accessed in directory '''''$PROGHOME/dic/''''' to support input.
# If no such file exists in the working directory, NCPLOT accesses the following configuration files from the directory '''''$PROGHOME/cfg/''''':
#* '''''colors.cfg.dat''''': File with definitions of colors.
#* '''''palettes.cfg.dat''''': File with references to files with color palette definitions.
#* '''''bounds.cfg.dat''''': File with interval definitions for legends. Hint: The bounds file should be better stored within a project in the working directory.
# The following '''standard configuration files''' from the directory '''''$PROGHOME/cfg/''''' are required:
#* '''gkssystem.rechnername.dat''': GKS parameter file.
#* '''phydef.cfg.si.dat''': Configuration file for units and their relation to the SI system.

|nutzerprogramme=[[NCPLOT]]
|language=Fortran90
|fileform=FORMATTED
|fileaccess=SEQUENTIAL
|fileextension=.dat
|writemodules= ---
|readmodules=$PROGHOME/fortran/prg/ncplot/*/mod_m_ncplot_steer.f90
|contact_original=[mailto:guenther.lang@baw.de G. Lang], [mailto:susanne.spohr@baw.de S. Spohr]
|contact_maintenance=[mailto:guenther.lang@baw.de G. Lang], [mailto:susanne.spohr@baw.de S. Spohr]
|examplefile=$PROGHOME/examples/ncplot/ncplot.dat
}}

Template:FileDescription

2023-01-03T13:23:18Z

Ak3spohr: Removed 'Additional Information' section

__NOAUTOLINKS__
__NOAUTOLINKTARGET__
[[Category:File Description]]
[[de:{{{name_de}}}]]
==Basic Information==
===File-Type===
{{{filetype}}}
===File-Form===
{{{fileform}}}
===Version===
{{{version}}}
===Description-Date===
{{{version_descr}}}
==Significance of the File==
{{{significance}}}
==File-Contents (in Catchwords)==
{{{filecontents}}}
==Programs using this Type of File==
{{{nutzerprogramme}}}

===Example-File===
{{{examplefile}}}

----
back to: [[File Descriptions]]
----
[[Overview]]

NCPLOT.DAT

2022-04-20T12:48:24Z

Ak3spohr: Added changes for version ncplot_2022_03_29

{{FileDescription
|name_de=NCPLOT.DAT
|filetype=ncplot.dat
|version=March 2022
|version_descr=April 2022
|significance=contains general steering data for the program [[NCPLOT]].
|filecontents=

===Block "Program_Parameters"===
The block '''Program_Parameters''' contains general steering data.
* Key '''"Language" :''' Language preference for labels and texts:
:*'''DE''' = German,
:*'''EN''' = English.
* Key '''"Max_Read_Storage" :''' max. read only memory (in bytes) for analysis
* Key '''"Min_Water_Depth" :''' minimum water coverage in [m].
:Hint: The excluding of data from the presentation in case of low water coverage is only possible, if the variable to be displayed points in a certain way to a variable associated with the total water depth. The CF-NetCDF output of UnTRIM programs fulfills this requirement. The page '''''[[NCPLOT: Min_Water_Depth]]''''' illustrates the effect of this control parameter.
* (optional) Key '''"Infobox_Plot_Area" :''' Image area for the metadata infobox.
:If this image area is specified, information about the plot creation will be given to the graphic. This includes information about the underlying data files as well as if neccessary information about used data filtering.
* (optional) Key '''"PLR_Representation" :''' Default setting for line symbols of data curves in line charts.
* (optional) Key '''"PMR_Representation" :''' Default setting for marker symbols of data curves in line charts.
* (optional) Key '''"PLR_Palette" :''' Color palette and start color for line symbols of data curves in line charts.
* (optional) Key '''"PMR_Palette" :''' Color palette and start color for marker symbols of data curves in line charts.
* (optional) Key '''"Picture_Name_Fixum" :''' fixed name part for graphic file(s).
* (optional) Key '''"Phydef_Units" :''' Display physical units as in PHYDEF administration.
:Hint: Without explicit request, the units are displayed according to the BAW Rules.
* (optional) Key '''"Output_Format" :''' Output format for the generated graphics (CGM or SVG).

===Block "SVG_Specifications"===
Optional block with attributes for graphic output in SVG format.
* (optional) Key '''"SVG_Maximum_Size" :''' Maximum size of the SVG graphic, i.e. factor for converting NDC space from GKS to SVG space.
* (optional) Key '''"SVG_Font_Family" :''' Font family for text elements.
* (optional) Key '''"SVG_Free_Text_Attributes" :''' Font attribute(s) that are given to ALL texts of the SVG graphic.
* (optional) Key '''"SVG_Axis_Text_by_Char" :''' Write texts on diagram axes character by character (as in CGM format).
* (optional) Key '''"SVG_Legend_Box_by_Char" :''' Write legend texts of line charts character by character (as in CGM format).

===Block "Dataset"===
Description of a data set to be displayed. 
 
For addressing the data to be displayed, either the Start-Step-Stride technique
or the DimSelect method is available. The user has to choose one way or the other,
the procedures exclude each other. Each Start-Step-Stride-Addressing can be copied
by DimSelect, the other way round that is not the case.
DimSelect offers additional options for data selection, with the method
you can also realize non-equidistant index selection.
;Start-Step-Stride technique:
:For each dimension of the variable a start, step and stride value must be specified. The page '''''[[NCPLOT: Define DataSet]]''''' gives instructions for addressing the desired data.
;DimSelect method:
:DimSelect also requires the addressing of the indices for each dimension of the data variables to be displayed. But this can also happen indirectly. Various suitable selection methods are provided. The user can, for example, choose all faces by '''''DimSelect_All''''' without knowing the specific number, or pass the program via '''''DimSelect_Various_Date''''' a selection of times to be displayed. It is the responsibility of the program to find the corresponding indices. Related to data curves of line charts the DimSelect method offers a further advantage: For the individual dimensions this mimic allows to create text components for the names of the data series shown in the curve legend. 
Control file can contain multiple blocks of this type.
* Key '''"Name" :''' unique name of this data set.
* Key '''"File" :''' name of the CF-NetCDF file (*.nc) with the data to be displayed.
* Key '''"Variable" :''' Description of the data whose values are to be displayed.
:* Parameter '''1''' = name of the variable (in file of type *.nc)
:* (optional) Parameter '''2''' = role of the variable as part of a vector
::* X-component = Variable is the X component of a vector
::* Y-component = Variable is the Y component of a vector
::* normal_component = Variable is the normal component of a vector
:Hint: The command "ncdump -h <filename>.nc" shows the header of the CF-NetCDF file. The names of the offered variables and their dimensions can be found in the metadata.
* (optional) Key '''"Start" :''' start address for the data to be displayed.
* (optional) Key '''"Step" :''' number of steps for the data to be displayed.
* (optional) Key '''"Stride" :''' increment for the data to be displayed.
* (optional) Key '''"DimSelect_EquiDist_Index" :''' Equidistant selection of indices for a given dimension. Exemplary:
:* Parameter '''1''' = Name of the dimension
:* Parameter '''2''' = NONE or text component for curve legend
:* Parameter '''3''' = Index becomes part of the curve legend .true./.false.
:* Parameter '''4''' = Start Index
:* Parameter '''5''' = Index increment
:* Parameter '''6''' = Number of steps
* (optional) Key '''"DimSelect_EquiDist_Date" :''' Equidistant selection of times.
* (optional) Key '''"DimSelect_StartEnd_Index" :''' Selection of all indices from start to end index.
* (optional) Key '''"DimSelect_StartEnd_Date" :''' Selection of all times from start to end date.
* (optional) Key '''"DimSelect_Single_Index" :''' Selection of a specific index.
* (optional) Key '''"DimSelect_Single_Date" :''' Selection of a specific date.
* (optional) Key '''"DimSelect_Various_Index" :''' List of various indices.
* (optional) Key '''"DimSelect_Various_Date" :''' List of various dates.
* (optional) Key '''"DimSelect_All" :''' Selection of all indices of a dimension.
* (optional) Key '''"DimSelect_ByLabel_LabVar" :''' Determine indices with list of names by label variable.
* (optional) Key '''"DimSelect_ByLabel_List" :''' Continuation line to Key '''''DimSelect_ByLabel_LabVar'''''.
* (optional) Key '''"DimSelect_Location_Coord" :''' Selection of locations by coordinates.
* (optional) Key '''"DimSelect_LocByFile_File" :''' Selection of locations from file with locations.
* (optional) Key '''"DimSelect_LocByFile_List" :''' Continuation line to Key '''''DimSelect_LocByFile_File'''''.
* (optional) Key '''"Dimensions_for_Picture_Series" :''' Requesting seperate presentations for selected dimensions.
:Hint: Causes series of pictures, i.e. for each selected index of the dimensions listed here a separate picture is created. Only works with line charts. Picture series must be the same length!

===Block "Layer"===
A block of type Layer defines a area diagram.
The illustration in the horizontal plane (the map view) differs fundamentally
from the area charts with axes. 
Control file can contain multiple blocks of this type.
* Key '''"Name" :''' unique name of this layer and the possibility of assigning a different plot level to the diagram.
* Key '''"Layer_Dataset_Name" :''' name of the dataset to be displayed. Or a valid connexion (OPERATOR string) made out of known data sets, e. g. '''[DSet2-DSet1]/[DSet1+DSet2]''', '''ABS[DSet]''', '''SQR[DSet]''' or '''G18[DSet]'''. Constant factors in arithmetic operation possible.
* Key '''"Layer_Type" :''' type of data view of this layer.
:*'''XY_data''' = Map, or top view illustration (horizontal plane)
:*'''PZ''' = Vertical section along profile (3D data)
:*'''TZ''' = Time depth diagram (3D data)
:*'''PT''' = Hovmöller diagram variant 1: X-axis=profile axis (P), Y-axis=time axis (T).
:*'''TP''' = Hovmöller diagram variant 2: X-axis=time axis (T), Y-axis=profile axis (P).
* Key '''"Layer_Primitive_Name" :''' graphic primitive to visualize the data in the layer.
:* Parameter '''1''' = Symbolization of the layer
::*'''GPM''' = as poly marker
::*'''GPL''' = as poly line (only Layer_Type ''XY_data'')
::*'''GFA''' = as fill area
::*'''GTX''' = as text
::*'''VEC''' = as vector (only Layer_Type ''XY_data'')
:* (optional) Parameter '''2''' = Type of the vector ... optional parameter, only at VEC visualization permitted. ...allows, for example, the interpolation of the total vector from the normal component a vectorial quantity.
::*'''total''' = total vector
::*'''normal''' = normal vector
* Key '''"Layer_Primitive_Representation_Name" :''' name of the representation of the primitive.
* Key '''"Layer_Bounds_Name" :''' name of the interval definition for this layer (from the file '''''[[BOUNDS.CFG.DAT|bounds.cfg.dat]]''''').
:Hint: The number of intervals in the interval definition and the number of colors of the associated color legend must match.
* Key '''"Layer_Palette_Name" :''' name of the color legend for this layer (corresponds to the attribute ''Name'' in the file ''palette.dat''. More detailed information about palettes on file description page '''''[[PALETTES.CFG.DAT|palettes.cfg.dat]]''''').
* Key '''"Layer_Invert_Palette" :''' invertation of the color ramp.
* (optional) Key '''"Layer_Normalization_Transformation_Name" :''' name of the normalization transformation for this layer.
:Hint: Required for diagram definition map view (Layer_Type ''XY_data'').
* (optional) Key '''"Layer_Area" :''' Image area spanned by the diagram axes.
:Hint: Required for definitions of diagrams working with axes.
* (optional) Key '''"Layer_Extent" :''' Total area that the diagram in the picture takes up.
:Hint: Required for definitions of diagrams working with axes.
* (optional) Key '''"Layer_X-Axis" :''' X-axis of the diagram and its positioning.
:Hint: Required for definitions of diagrams working with axes.
* (optional) Key '''"Layer_Y-Axis" :''' Y-axis of the diagram and its positioning.
:Hint: Required for definitions of diagrams working with axes.
* (optional) Key '''"Layer_Legend_Plot_Area" :''' image area for the color legend of this layer. Depending on the space, the color legend can be applied horizontally or vertically.
* (optional) Key '''"Layer_Legend_Label_Switch" :''' Switch list for switching off or positioning labels of the color legend.
* (optional) Key '''"Layer_Data_Description_Name" :''' name of the '''''Data_Description''''' text box, which should collects up the data description (e.g. indication of the time) of this layer.
* (optional) Key '''"Layer_Display_Units" :''' physical unit in which the data should be converted for the graphical presentation.
:Hints: The original unit of the data and the target unit must be known in the configuration file '''''phydef.cfg.si.dat'''''. In addition, the SI-base (dimension) of the units must be identical.
* (optional) Key '''"Layer_Display_Name" :''' name of physical quantity, will be used instead of the original name given in the input data set. Without this line the name in PHYDEF is used, if the variable owns the attribute '''''name_id'''''.. Dynamic text parts can be realized with special placeholders:
:*<LAY_DSET> will be replaced by the name of the dataset associated with the layer.
:*<LAY_DIM1> will be replaced by the info text for the 1st dimension of the displayed data set.
:*<LAY_DIM2> will be replaced by the info text for the 2nd dimension of the displayed data set.
:*<LAY_DIM?> etc. to the number of data set dimensions.
* (optional) Key '''"Layer_Vector_Legend_Plot_Area" :''' image area for the vector legend in case of arrows with length_type proportional.
* (optional) Key '''"Layer_Vector_Thinout_Raster" :''' dimensions of the grid used to thin out the display of vector arrows.
* (optional) Key '''"Layer_NOBS_Filter" :''' filter for displayed data based on ''ancillary variable'' with type ''number of observations'':
** parameter 1: filter type:
*** '''EQ''' = display data only for a fixed number of observations;
*** '''LE''' = display data for a certain number of observations or less;
*** '''LE''' = display data for a certain number of observations or more.
** parameter 2: filter value:
*** '''0''' = maximum number of observations;
*** '''N''' = specified number of observations;
*** '''-M''' = maximum number of observations minus M.
* (optional) Key '''"Layer_Description_Textbox" :''' name of a textbox to be linked with the layer.
* (optional) Key '''"Layer_Route_Dataset" :''' name of a '''''dataset''''' with profile route for sorting and filtering data to be displayed.
* (optional) Key '''"Layer_Legend_Number_Format" :''' Format specification for numerical values of the color legend.
* (optional) Key '''"Layer_ASCII_Output" :''' Write data displayed in layer to text file.

===Block "Normalization_Transformation (NTN)"===
Definition of an image section and description of the link between the world and image
coordinates. 
A block of this type is only required for areal representation in the horizontal plane
(layer definition with Type == XY_Data). 
The coordinates of the drawing area, the so-called NDC space, range from [0.0,0.0] to [1.0,1.0].
For an undistorted view of the area the representation scale in the X direction must match
the scale in Y-direction (DWC / DNDC = const);
optionally also key '''"Autoscale"''' can be used for this purpose.
Distorted representations are also possible. 
* Key '''"Name" :''' unique name of this normalization transformation.
* Key '''"EPSG" :''' EPSG code of the data coordinates in the file.
* Key '''"EPSG_Window" :''' EPSG code of the plot projection.
* Key '''"Left_Lower_Window_Coordinates" :''' world coordinates (according to EPSG) the lower left corner of the projection window.
* Key '''"Right_Upper_Window_Coordinates" :''' world coordinates (according to EPSG) the upper right corner of the projection window.
* Key '''"Left_Lower_NDC_Coordinates" :''' picture coordinates (NDC within [0.0,1.0]) the lower left corner of the projection window.
* Key '''"Right_Upper_NDC_Coordinates" :''' picture coordinates (NDC within [0.0,1.0]) the upper right corner of the projection window.
* (optional) Key '''"Autoscale" :''' automatic adjustment (.true.) of scales in X- and Y-direction. Default is .false. (no adjustment).
* (optional) Key '''"Scale_Bar_Request"''' : Request drawing a scale bar. Autoscale needs to be on.
* (optional) Key '''"NTN_Framing" :''' Type of the coordinate frame when displayed as map.
:Hint: More info at '''''[[NCPLOT: Framing|Options of map frames]]'''''.

===Block "Data_Description"===
The block '''Data_Description''' defines a Data_Description object.
Such an object collects data descriptions and displays them together in a text field. 
A block of this type is currently only needed for area charts in the horizontal plane (Layer definition with Type == XY_Data). 
Control file can contain multiple blocks of this type.
* Key '''"Data_Desc_Name" :''' unique name of the text field for data descriptions.
* Key '''"Data_Desc_Plot_Area" :''' image area for the Data_Description text box.
* (optional) Key '''"Data_Desc_Draw_Frame" :''' draw a frame around the Data Description text box TRUE/FALSE.
* (optional) Key '''"Data_Desc_Color_Name" :''' name of the color for text and frame.

===Block "LineChart"===
The block '''LineChart''' is used to define a line diagram. 
A "LineChart" has only one X- and one Y-axis.
A secondary Y-axis must be realized by defining a second "LineChart" object
on the same drawing area and with the same X-axis. 
Any number of LineCharts can be stacked. The associated axes can be positioned
on all four sides of the diagram and can also be moved away from the drawing
area by different distances.
Thus, for example, on the sheet "one" time series diagram with three Y-axes
can be generated that represents the curves for flow amount, flow direction
and salinity together. 
Control file can contain multiple blocks of this type.
* Key '''"LineChart_Name" :''' unique name of the line chart and the possibility of assigning a different plot level to the diagram.
* Key '''"LineChart_Type" :''' type of line chart.
:*'''TG''' = Time series; Data over time
:*'''PG''' = Profile chart; Data over profile axis
:*'''GZ''' = Depth profile; 3D data along depth axis
* Key '''"LineChart_Area" :''' image area spanned by the diagram axes.
* Key '''"LineChart_Extent" :''' total area occupied by the diagram on the image.
* Key '''"LineChart_X-Axis" :''' X-axis of the diagram and its positioning.
* Key '''"LineChart_Y-Axis" :''' Y-axis of the diagram and its positioning.
* (optional) Key '''"LineChart_Legend_Box" :''' name of a '''''Legend_Box''''', the object/area in which the curve legends of the diagram are stored and presented.
* (optional) Key '''"LineChart_Route_Dataset" :''' name of a '''''dataset''''' with profile route for sorting and filtering data to be displayed.
* (optional) Key '''"LineChart_PLR_Representation" :''' line Symbolization for the data curves of this diagram.
* (optional) Key '''"LineChart_PMR_Representation" :''' marker Symbolization for the data curves of this diagram.
* (optional) Key '''"LineChart_PLR_Palette" :''' color palette and start color for line symbols of this line chart.
* (optional) Key '''"LineChart_PMR_Palette" :''' color palette and start color for marker symbols of this line chart.
* (optional) Key '''"LineChart_FillArea_Between_Series" :''' Coloring of areas between two data series.
* (optional) Key '''"LineChart_FillArea_Series_Values" :''' Coloring of areas between a data series and a specific value.

===Block "Axis"===
The block '''Axis''' is used to define a diagram axis. 
An axis definition can be used for varius diagrams.
For example superposed "LineCharts" or several diagrams arranged
one below the other with the same time axis. 
Control file can contain multiple blocks of this type.
* Key '''"Axis_Name" :''' unique name of the axis definition.
* Key '''"Axis_Type" :''' type of axis.
:*'''T''' = time axis
:*'''G''' = axis for physical quantities
:*'''P''' = profile axis
:*'''Z''' = depth axis
* (optional) Key '''"Axis_Value_Range" :''' value range of the axis.
* (optional) Key '''"Axis_Date_Range" :''' time range of the axis.
* (optional) Key '''"Axis_Scale_Logarithmic" :''' switch logarithmic scaling LOG10 on TRUE/FALSE.
* (optional) Key '''"Axis_Invert_Profile_Route" :''' switch invert the route of a profile axis TRUE/FALSE.
* (optional) Key '''"Axis_Scale_Multiplicator" :''' multiplication factor for axis scaling.
* (optional) Key '''"Axis_Display_Name" :''' axis title, will be used instead of the original name given in the input data.
* (optional) Key '''"Axis_Display_Unit" :''' physical unit in which the data should be converted for the graphical presentation.
:Hints: The original unit of the data and the target unit must be known in the configuration file '''''phydef.cfg.si.dat'''''. In addition, the SI-base (dimension) of the units must be identical.
* (optional) Key '''"Axis_Labels_EquiDist_Value" :''' equidistant values for labeling along the axis.
* (optional) Key '''"Axis_Labels_EquiDist_Date" :''' equidistant dates for labeling along the axis.
* (optional) Key '''"Axis_Labels_at_Values" :''' list of values for labeling along the axis.
* (optional) Key '''"Axis_Labels_at_Dates" :''' list of dates for labeling along the axis.
* (optional) Key '''"Axis_Line_Representation" :''' name of a ''Poly_Line_Representation'' for the representation of the axis line.
* (optional) Key '''"Axis_Text_Representation" :''' name of a ''Text_Representation'' for the axis labeling (only influencing the font color).
* (optional) Key '''"Gitternetz_Representation" :''' name of a ''Poly_Line_Representation'' for the gridlines or switch off these lines with NONE.
* (optional) Key '''"Tickmark_Representation" :''' formatting or switching off axis tickmarks.
:* Parameter '''1''' = name of a color for the tickmarks
:* Parameter '''2''' = width of the tickmark line
:* Parameter '''3''' = length of tickmarks in image coordinates; 0.0 turn it off!
* (optional) Key '''"Axis_Additional_Line_Value" :''' draw an additional line vertical to the axis at a certain value.
* (optional) Key '''"Axis_Additional_Line_Date" :''' draw an additional line vertical to the time axis at a certain date.
* (optional) Key '''"Axis_Additional_Line_Coord" :''' draw an additional line vertical to the profile axis at a certain location.
* (optional) Key '''"Characters_along_Axis" :''' allows the manipulation of the font size of the axis labeling.
* (optional) Key '''"Axis_Number_Format" :''' Format specification for numerical values of the axis scaling.

===Block "DataRow"===
The block '''DataRow''' is used to describe a data series, or a group
of data series. 
Due to the data addressing in the ''DataSet'', a ''DataRow'' description can
result in several data series.
All these data series end up in the same line diagramm. 
Blocks of this type are needed for line charts. 
Control file can contain multiple blocks of this type.
* Key '''"DataRow_Name" :''' unique name of the data row description.
* Key '''"DataRow_Dataset" :''' name of the dataset to be displayed. Or a valid connexion (OPERATOR string) made out of known data sets, e. g. '''[DSet2-DSet1]/[DSet1+DSet2]''', '''ABS[DSet]''', '''SQR[DSet]''' or '''G18[DSet]'''.
* Key '''"DataRow_LineChart" :''' name of the ''LineChart'', i.e. of the line diagram in which the data series are to be drawn.
* (optional) Key '''"DataRow_PLR_Representation" :''' line symbolization for the data curves of this data series.
* (optional) Key '''"DataRow_PMR_Representation" :''' marker symbolization for the data curves of this data series.
* (optional) Key '''"DataRow_PLR_Palette" :''' color palette and start color for line symbols of this data series.
* (optional) Key '''"DataRow_PMR_Palette" :''' color palette and start color for marker symbols of this data series.
* (optional) Key '''"DataRow_NoValue_Handling" :''' Handling invalid values in the data series.
:*'''Luecke''' = Points without data are not displayed
:*'''Interpolation''' = a straight line closes the data gap in the curve

* (optional) Key '''"DataRow_NOBS_Filter" :''' filter for displayed data based on ''ancillary variable'' with type ''number of observations'':
** parameter 1: filter type:
*** '''EQ''' = display data only for a fixed number of observations;
*** '''LE''' = display data for a certain number of observations or less;
*** '''LE''' = display data for a certain number of observations or more.
** parameter 2: filter value:
*** '''0''' = maximum number of observations;
*** '''N''' = specified number of observations;
*** '''-M''' = maximum number of observations minus M.

===Block "Legend_Box"===
A legend box collects names and symbolizations of data curves and
displays them together in a text field.
A legend field can accommodate curve descriptions from different diagrams. 
A block of this type is only needed by line charts. 
Control file can contain multiple blocks of this type.
* Key '''"Legend_Box_Name" :''' unique name of the legend field.
* Key '''"Legend_Box_Plot_Area" :''' image area for the legend field.
* (optional) Key '''"Legend_Box_Draw_Frame" :''' draw a frame around the legend field TRUE/FALSE.
* (optional) Key '''"Legend_Box_Color_Name" :''' name of the color for text and frame.

===Block "Textbox"===
Description of one free text field. 
An empty text box can act as rectangular frame, with the color, type and width of the line
being adjustable. If you give the text box a background color, you can use it to cover
a particular area of the diagram. 
Control file can contain multiple blocks of this type.
* Key '''"Name" :''' unique name of the text box.
* Key '''"Plot_Area" :''' image area for the text box.
* (optional) Key '''"Text_Line" :''' one line of the text box. Specification of several lines possible. Placeholder for system information:
:*<SYS_DATE> will be replaced by current date.
:*<SYS_TIME> will be replaced by current time.
:*<SYS_USER> will be replaced by User ID.
:Placeholder for text box, which is connected to a Layer:
:*<LAY_DSET> will be replaced by the name of the dataset associated with the layer.
:*<LAY_DIM1> will be replaced by the info text for the 1st dimension of the displayed data set.
:*<LAY_DIM2> will be replaced by the info text for the 2nd dimension of the displayed data set.
:*<LAY_DIM?> etc. to the number of data set dimensions.
:Hint: Linking is realized in the layer block via KEY ''Layer_Description_Textbox''.
* (optional) Key '''"Color_Name" :''' colors of the textbox.
** parameter 1: for text and frame
** (optional) parameter 2: for background
* (optional) Key '''"Draw_Frame" :''' draw a frame around the text box TRUE/FALSE.
* (optional) Key '''"Frame_Style" :''' appearance of the text box frame.
** parameter 1: line width
** (optional) parameter 2: line type
* (optional) Key '''"Fixed_Width" :''' character-wise writing with constant width or not.
* (optional) Key '''"Horizontal_Char_Space" :''' Horizontal character distance factor for character-wise writing.
* (optional) Key '''"Vertical_Line_Space" :''' Vertical line spacing factor.
* (optional) Key '''"Font_Size" :''' Font size can be specified possibly.
* (optional) Key '''"Font_Size_Factor" :''' Factor for manipulating the calculated font size.

===Block "Poly_Marker_Representation"===
Description of one type of marker symbols. 
Control file can contain multiple blocks of this type.

===Block "Fill_Area_Representation"===
Description of one type of fill area symbolization. 
Control file can contain multiple blocks of this type.

===Block "Poly_Line_Representation"===
Description of one type of line symbolization. 
Control file can contain multiple blocks of this type.

===Block "Text_Representation"===
Description of one type of text symbolization. 
Control file can contain multiple blocks of this type.

===Block "Vector_Representation"===
Description of one type of vector symbolization. 
Control file can contain multiple blocks of this type. 
Hint: More info at '''''[[NCPLOT: Types of vector symbols]]'''''.

===General Remarks===
# While reading this steering data file the '''dictionary file''' '''''ncplot_dico.dat''''' will be automatically accessed in directory '''''$PROGHOME/dic/''''' to support input.
# If no such file exists in the working directory, NCPLOT accesses the following configuration files from the directory '''''$PROGHOME/cfg/''''':
#* '''''colors.cfg.dat''''': File with definitions of colors.
#* '''''palettes.cfg.dat''''': File with references to files with color palette definitions.
#* '''''bounds.cfg.dat''''': File with interval definitions for legends. Hint: The bounds file should be better stored within a project in the working directory.
# The following '''standard configuration files''' from the directory '''''$PROGHOME/cfg/''''' are required:
#* '''gkssystem.rechnername.dat''': GKS parameter file.
#* '''phydef.cfg.si.dat''': Configuration file for units and their relation to the SI system.

|nutzerprogramme=[[NCPLOT]]
|language=Fortran90
|fileform=FORMATTED
|fileaccess=SEQUENTIAL
|fileextension=.dat
|writemodules= ---
|readmodules=$PROGHOME/fortran/prg/ncplot/*/mod_m_ncplot_steer.f90
|contact_original=[mailto:guenther.lang@baw.de G. Lang], [mailto:susanne.spohr@baw.de S. Spohr]
|contact_maintenance=[mailto:guenther.lang@baw.de G. Lang], [mailto:susanne.spohr@baw.de S. Spohr]
|examplefile=$PROGHOME/examples/ncplot/ncplot.dat
}}

NCPLOT

2022-04-20T12:34:08Z

Ak3spohr: update version

{{ProgramDescription
|name_de=NCPLOT
|name=NCPLOT
|version=March 2022
|version_descr=April 2022
|catchwords=graphical postprocessor 
graphical presentation of CF NetCDF data (unknown attributes are ignored) 
finite element models 
finite difference models 
orthogonal unstructured grid model 
orthogonal unstructured grid model with subgrid information 
conversion or transformation (extensive - intensive) of physical units 
calculation of new quantities (for display) from one or several input data sets 
(optional) filter based on water depth 
(optional) filter based on number of observations 

Acknowledgment: ''This project took advantage of netCDF software developed by UCAR/Unidata ([http://www.unidata.ucar.edu/software/netcdf/ www.unidata.ucar.edu/software/netcdf/]).''

|shortdescription=
The graphical postprocessor NCPLOT can be used for a graphical presentation
of simulation and analysis results, which is stored in CF NetCDF data format.
The data can be defined on nodes, edges or faces. The program works on 2D-data,
3D-data and on data with details scaled on a subgrid. 
[[File:NcplotBspFaceArea.png|thumb|250px|Picture 1: Salinity with underlaid topography.]]

The sample pictures illustrate the capability of the program NCPLOT. 
[[NCPLOT: Example figures|Example figures: NCPLOT]]

Basically, NCPLOT distinguishes linear from areal chart types.
For area charts the symbolization of the data is depending on the data value
(color legend, proportional arrow).
For linear charts, the values of data series are plotted on an axis.
The symbolization of the data series is independent of the data value.
 

[[NCPLOT: Area Charts|Area Charts]]:
* Map, or top view illustration
* Vertical section along profile (3D data)
* Time depth diagram (3D data)
* Hovmöller diagram: Temporal development along profile.
 
[[NCPLOT: Line Charts|Line Charts]]: 
* time series
* profile view
* depth profile
 
NCPLOT allows you to illustrate different diagrams of different types in one picture.
Line diagrams next to areal charts with static and possibly dynamic parts.
 

Picture series: 
Both line and area chart definitions can request the creation of picture series.
A picture can contain static and dynamic image components.
Dynamic components means parts of the image that vary over a picture series.
 

The following rule applies to the program: 
The first read dynamic definition determines the permitted length of the
picture series.
The program aborts, if a further dynamic diagram definition results a
different number of images.
 

Further tests are not carried out.
 

Different series diagrams from dynamic diagram definitions of the same
length are processed by the program. The static picture elements are displayed
on every picture in the series.
 

|inputfiles=
# '''general input data''' (file type [[NCPLOT.DAT|ncplot.dat]])
# '''result files''' (file type [[CF-NETCDF.NC]])
# file with '''interval definitions''' for color legends (file type [[BOUNDS.CFG.DAT|bounds.cfg.dat]]) Hint: (Recommended) Local configuration file or file from the directory ''$PROGHOME/cfg/''.
# file with '''list of definitions of palettes''' (file type [[PALETTES.CFG.DAT|palettes.cfg.dat]]) Hint: (Recommended) Provided file from the directory ''$PROGHOME/cfg/'' or local configuration file.
# file with '''definitions of colors''' (file type [[COLORS.CFG.DAT|colors.cfg.dat]]) Hint: (Recommended) Provided file from the directory ''$PROGHOME/cfg/'' or local configuration file.

For NCPLOT the following standard configuration files from the directory '''''$PROGHOME/cfg/''''' are required:
* GKS parameter file: '''gkssystem.computername.dat'''

|outputfiles=
# '''graphic files''' (format: CGM or SVG)
# (optional) informative '''printer file''' of program execution (file type ncplot.sdr)
# (optional) '''trace''' of program execution (file type ncplot.trc)

|methodology=
NCPLOT is a pure plot program without any user interaction at runtime.
The layout of the picture and the graphical presentation of the data has to be
described in the steering file.
 

NCPLOT creates vector graphics in CGM or SVG format.
 

For special data files it is possible to exclude data at places with low water
coverage from the display. The technic works only on original UnTRIM result files
in CF NetCDF format.
 

Just in case '''HDF error''' is detected during read of a data record,
the program tries to reconstruct the wanted data set from adjacent (in time)
records for the same variable.
This type of repair works for time dependent variables only.
 

|preprocessor=[[BOE2NC]], [[DATACONVERT]], [[GRIDCONVERT]], [[NCAGGREGATE]], [[NCANALYSE]], [[NCCUTOUT]], [[NCDELTA]], [[NCDVAR]], [[NCMERGE]], [[UNK]], [[UNTRIM2007]], [[UNTRIM2]]
|postprocessor=---
|language=Fortran95
|add_software=GKS (by GTS-Gral)
|contact_original=[mailto:guenther.lang@baw.de G. Lang], [mailto:susanne.spohr@baw.de S. Spohr]
|contact_maintenance=[mailto:guenther.lang@baw.de G. Lang], [mailto:susanne.spohr@baw.de S. Spohr]
|documentation=
template files available in '''$PROGHOME/examples/ncplot'''
}}

NCPLOT.DAT

2021-10-18T14:01:57Z

Ak3spohr: Version 6: SVG-Output

{{FileDescription
|name_de=NCPLOT.DAT
|filetype=ncplot.dat
|version=October 2021
|version_descr=October 2021
|significance=contains general steering data for the program [[NCPLOT]].
|filecontents=

===Block "Program_Parameters"===
The block '''Program_Parameters''' contains general steering data.
* Key '''"Language" :''' Language preference for labels and texts:
:*'''DE''' = German,
:*'''EN''' = English.
* Key '''"Max_Read_Storage" :''' max. read only memory (in bytes) for analysis
* Key '''"Min_Water_Depth" :''' minimum water coverage in [m].
:Hint: The excluding of data from the presentation in case of low water coverage is only possible, if the variable to be displayed points in a certain way to a variable associated with the total water depth. The CF-NetCDF output of UnTRIM programs fulfills this requirement. The page '''''[[NCPLOT: Min_Water_Depth]]''''' illustrates the effect of this control parameter.
* (optional) Key '''"Infobox_Plot_Area" :''' Image area for the metadata infobox.
:If this image area is specified, information about the plot creation will be given to the graphic. This includes information about the underlying data files as well as if neccessary information about used data filtering.
* (optional) Key '''"PLR_Representation" :''' Default setting for line symbols of data curves in line charts.
* (optional) Key '''"PMR_Representation" :''' Default setting for marker symbols of data curves in line charts.
* (optional) Key '''"PLR_Palette" :''' Color palette and start color for line symbols of data curves in line charts.
* (optional) Key '''"PMR_Palette" :''' Color palette and start color for marker symbols of data curves in line charts.
* (optional) Key '''"Picture_Name_Fixum" :''' fixed name part for graphic file(s).
* (optional) Key '''"Phydef_Units" :''' Display physical units as in PHYDEF administration.
:Hint: Without explicit request, the units are displayed according to the BAW Rules.
* (optional) Key '''"Output_Format" :''' Output format for the generated graphics (CGM or SVG).

===Block "SVG_Specifications"===
Optional block with attributes for graphic output in SVG format.
* (optional) Key '''"SVG_Maximum_Size" :''' Maximum size of the SVG graphic, i.e. factor for converting NDC space from GKS to SVG space.
* (optional) Key '''"SVG_Font_Family" :''' Font family for text elements (monospace or sans-serif).

===Block "Dataset"===
Description of a data set to be displayed. 
 
For addressing the data to be displayed, either the Start-Step-Stride technique
or the DimSelect method is available. The user has to choose one way or the other,
the procedures exclude each other. Each Start-Step-Stride-Addressing can be copied
by DimSelect, the other way round that is not the case.
DimSelect offers additional options for data selection, with the method
you can also realize non-equidistant index selection.
;Start-Step-Stride technique:
:For each dimension of the variable a start, step and stride value must be specified. The page '''''[[NCPLOT: Define DataSet]]''''' gives instructions for addressing the desired data.
;DimSelect method:
:DimSelect also requires the addressing of the indices for each dimension of the data variables to be displayed. But this can also happen indirectly. Various suitable selection methods are provided. The user can, for example, choose all faces by '''''DimSelect_All''''' without knowing the specific number, or pass the program via '''''DimSelect_Various_Date''''' a selection of times to be displayed. It is the responsibility of the program to find the corresponding indices. Related to data curves of line charts the DimSelect method offers a further advantage: For the individual dimensions this mimic allows to create text components for the names of the data series shown in the curve legend. 
Control file can contain multiple blocks of this type.
* Key '''"Name" :''' unique name of this data set.
* Key '''"File" :''' name of the CF-NetCDF file (*.nc) with the data to be displayed.
* Key '''"Variable" :''' Description of the data whose values are to be displayed.
:* Parameter '''1''' = name of the variable (in file of type *.nc)
:* (optional) Parameter '''2''' = role of the variable as part of a vector
::* X-component = Variable is the X component of a vector
::* Y-component = Variable is the Y component of a vector
::* normal_component = Variable is the normal component of a vector
:Hint: The command "ncdump -h <filename>.nc" shows the header of the CF-NetCDF file. The names of the offered variables and their dimensions can be found in the metadata.
* (optional) Key '''"Start" :''' start address for the data to be displayed.
* (optional) Key '''"Step" :''' number of steps for the data to be displayed.
* (optional) Key '''"Stride" :''' increment for the data to be displayed.
* (optional) Key '''"DimSelect_EquiDist_Index" :''' Equidistant selection of indices for a given dimension. Exemplary:
:* Parameter '''1''' = Name of the dimension
:* Parameter '''2''' = NONE or text component for curve legend
:* Parameter '''3''' = Index becomes part of the curve legend .true./.false.
:* Parameter '''4''' = Start Index
:* Parameter '''5''' = Index increment
:* Parameter '''6''' = Number of steps
* (optional) Key '''"DimSelect_EquiDist_Date" :''' Equidistant selection of times.
* (optional) Key '''"DimSelect_StartEnd_Index" :''' Selection of all indices from start to end index.
* (optional) Key '''"DimSelect_StartEnd_Date" :''' Selection of all times from start to end date.
* (optional) Key '''"DimSelect_Single_Index" :''' Selection of a specific index.
* (optional) Key '''"DimSelect_Single_Date" :''' Selection of a specific date.
* (optional) Key '''"DimSelect_Various_Index" :''' List of various indices.
* (optional) Key '''"DimSelect_Various_Date" :''' List of various dates.
* (optional) Key '''"DimSelect_All" :''' Selection of all indices of a dimension.
* (optional) Key '''"DimSelect_ByLabel_LabVar" :''' Determine indices with list of names by label variable.
* (optional) Key '''"DimSelect_ByLabel_List" :''' Continuation line to Key '''''DimSelect_ByLabel_LabVar'''''.
* (optional) Key '''"DimSelect_Location_Coord" :''' Selection of locations by coordinates.
* (optional) Key '''"DimSelect_LocByFile_File" :''' Selection of locations from file with locations.
* (optional) Key '''"DimSelect_LocByFile_List" :''' Continuation line to Key '''''DimSelect_LocByFile_File'''''.
* (optional) Key '''"Dimensions_for_Picture_Series" :''' Requesting seperate presentations for selected dimensions.
:Hint: Causes series of pictures, i.e. for each selected index of the dimensions listed here a separate picture is created. Only works with line charts. Picture series must be the same length!

===Block "Layer"===
A block of type Layer defines a area diagram.
The illustration in the horizontal plane (the map view) differs fundamentally
from the area charts with axes. 
Control file can contain multiple blocks of this type.
* Key '''"Name" :''' unique name of this layer and the possibility of assigning a different plot level to the diagram.
* Key '''"Layer_Dataset_Name" :''' name of the dataset to be displayed. Or a valid connexion (OPERATOR string) made out of known data sets, e. g. '''[DSet2-DSet1]/[DSet1+DSet2]''', '''ABS[DSet]''', '''SQR[DSet]''' or '''G18[DSet]'''.
* Key '''"Layer_Type" :''' type of data view of this layer.
:*'''XY_data''' = Map, or top view illustration (horizontal plane)
:*'''PZ''' = Vertical section along profile (3D data)
:*'''TZ''' = Time depth diagram (3D data)
:*'''PT''' = Hovmöller diagram variant 1: X-axis=profile axis (P), Y-axis=time axis (T).
:*'''TP''' = Hovmöller diagram variant 2: X-axis=time axis (T), Y-axis=profile axis (P).
* Key '''"Layer_Primitive_Name" :''' graphic primitive to visualize the data in the layer.
:* Parameter '''1''' = Symbolization of the layer
::*'''GPM''' = as poly marker
::*'''GPL''' = as poly line (only Layer_Type ''XY_data'')
::*'''GFA''' = as fill area
::*'''GTX''' = as text
::*'''VEC''' = as vector (only Layer_Type ''XY_data'')
:* (optional) Parameter '''2''' = Type of the vector ... optional parameter, only at VEC visualization permitted. ...allows, for example, the interpolation of the total vector from the normal component a vectorial quantity.
::*'''total''' = total vector
::*'''normal''' = normal vector
* Key '''"Layer_Primitive_Representation_Name" :''' name of the representation of the primitive.
* Key '''"Layer_Bounds_Name" :''' name of the interval definition for this layer (from the file '''''[[BOUNDS.CFG.DAT|bounds.cfg.dat]]''''').
:Hint: The number of intervals in the interval definition and the number of colors of the associated color legend must match.
* Key '''"Layer_Palette_Name" :''' name of the color legend for this layer (corresponds to the attribute ''Name'' in the file ''palette.dat''. More detailed information about palettes on file description page '''''[[PALETTES.CFG.DAT|palettes.cfg.dat]]''''').
* Key '''"Layer_Invert_Palette" :''' invertation of the color ramp.
* (optional) Key '''"Layer_Normalization_Transformation_Name" :''' name of the normalization transformation for this layer.
:Hint: Required for diagram definition map view (Layer_Type ''XY_data'').
* (optional) Key '''"Layer_Area" :''' Image area spanned by the diagram axes.
:Hint: Required for definitions of diagrams working with axes.
* (optional) Key '''"Layer_Extent" :''' Total area that the diagram in the picture takes up.
:Hint: Required for definitions of diagrams working with axes.
* (optional) Key '''"Layer_X-Axis" :''' X-axis of the diagram and its positioning.
:Hint: Required for definitions of diagrams working with axes.
* (optional) Key '''"Layer_Y-Axis" :''' Y-axis of the diagram and its positioning.
:Hint: Required for definitions of diagrams working with axes.
* (optional) Key '''"Layer_Legend_Plot_Area" :''' image area for the color legend of this layer. Depending on the space, the color legend can be applied horizontally or vertically.
* (optional) Key '''"Layer_Legend_Label_Switch" :''' Switch list for switching off or positioning labels of the color legend.
* (optional) Key '''"Layer_Data_Description_Name" :''' name of the '''''Data_Description''''' text box, which should collects up the data description (e.g. indication of the time) of this layer.
* (optional) Key '''"Layer_Display_Units" :''' physical unit in which the data should be converted for the graphical presentation.
:Hints: The original unit of the data and the target unit must be known in the configuration file '''''phydef.cfg.si.dat'''''. In addition, the SI-base (dimension) of the units must be identical.
* (optional) Key '''"Layer_Display_Name" :''' name of physical quantity, will be used instead of the original name given in the input data set. Without this line the name in PHYDEF is used, if the variable owns the attribute '''''name_id'''''.. Dynamic text parts can be realized with special placeholders:
:*<LAY_DSET> will be replaced by the name of the dataset associated with the layer.
:*<LAY_DIM1> will be replaced by the info text for the 1st dimension of the displayed data set.
:*<LAY_DIM2> will be replaced by the info text for the 2nd dimension of the displayed data set.
:*<LAY_DIM?> etc. to the number of data set dimensions.
* (optional) Key '''"Layer_Vector_Legend_Plot_Area" :''' image area for the vector legend in case of arrows with length_type proportional.
* (optional) Key '''"Layer_Vector_Thinout_Raster" :''' dimensions of the grid used to thin out the display of vector arrows.
* (optional) Key '''"Layer_NOBS_Filter" :''' filter for displayed data based on ''ancillary variable'' with type ''number of observations'':
** parameter 1: filter type:
*** '''EQ''' = display data only for a fixed number of observations;
*** '''LE''' = display data for a certain number of observations or less;
*** '''LE''' = display data for a certain number of observations or more.
** parameter 2: filter value:
*** '''0''' = maximum number of observations;
*** '''N''' = specified number of observations;
*** '''-M''' = maximum number of observations minus M.
* (optional) Key '''"Layer_Description_Textbox" :''' name of a textbox to be linked with the layer.
* (optional) Key '''"Layer_Route_Dataset" :''' name of a '''''dataset''''' with profile route for sorting and filtering data to be displayed.
* (optional) Key '''"Layer_Legend_Number_Format" :''' Format specification for numerical values of the color legend.

===Block "Normalization_Transformation (NTN)"===
Definition of an image section and description of the link between the world and image
coordinates. 
A block of this type is only required for areal representation in the horizontal plane
(layer definition with Type == XY_Data). 
The coordinates of the drawing area, the so-called NDC space, range from [0.0,0.0] to [1.0,1.0].
For an undistorted view of the area the representation scale in the X direction must match
the scale in Y-direction (DWC / DNDC = const);
optionally also key '''"Autoscale"''' can be used for this purpose.
Distorted representations are also possible. 
* Key '''"Name" :''' unique name of this normalization transformation.
* Key '''"EPSG" :''' EPSG code of the data coordinates in the file.
* Key '''"EPSG_Window" :''' EPSG code of the plot projection.
* Key '''"Left_Lower_Window_Coordinates" :''' world coordinates (according to EPSG) the lower left corner of the projection window.
* Key '''"Right_Upper_Window_Coordinates" :''' world coordinates (according to EPSG) the upper right corner of the projection window.
* Key '''"Left_Lower_NDC_Coordinates" :''' picture coordinates (NDC within [0.0,1.0]) the lower left corner of the projection window.
* Key '''"Right_Upper_NDC_Coordinates" :''' picture coordinates (NDC within [0.0,1.0]) the upper right corner of the projection window.
* (optional) Key '''"Autoscale" :''' automatic adjustment (.true.) of scales in X- and Y-direction. Default is .false. (no adjustment).
* (optional) Key '''"Scale_Bar_Request"''' : Request drawing a scale bar. Autoscale needs to be on.
* (optional) Key '''"NTN_Framing" :''' Type of the coordinate frame when displayed as map.
:Hint: More info at '''''[[NCPLOT: Framing|Options of map frames]]'''''.

===Block "Data_Description"===
The block '''Data_Description''' defines a Data_Description object.
Such an object collects data descriptions and displays them together in a text field. 
A block of this type is currently only needed for area charts in the horizontal plane (Layer definition with Type == XY_Data). 
Control file can contain multiple blocks of this type.
* Key '''"Data_Desc_Name" :''' unique name of the text field for data descriptions.
* Key '''"Data_Desc_Plot_Area" :''' image area for the Data_Description text box.
* (optional) Key '''"Data_Desc_Draw_Frame" :''' draw a frame around the Data Description text box TRUE/FALSE.
* (optional) Key '''"Data_Desc_Color_Name" :''' name of the color for text and frame.

===Block "LineChart"===
The block '''LineChart''' is used to define a line diagram. 
A "LineChart" has only one X- and one Y-axis.
A secondary Y-axis must be realized by defining a second "LineChart" object
on the same drawing area and with the same X-axis. 
Any number of LineCharts can be stacked. The associated axes can be positioned
on all four sides of the diagram and can also be moved away from the drawing
area by different distances.
Thus, for example, on the sheet "one" time series diagram with three Y-axes
can be generated that represents the curves for flow amount, flow direction
and salinity together. 
Control file can contain multiple blocks of this type.
* Key '''"LineChart_Name" :''' unique name of the line chart and the possibility of assigning a different plot level to the diagram.
* Key '''"LineChart_Type" :''' type of line chart.
:*'''TG''' = Time series; Data over time
:*'''PG''' = Profile chart; Data over profile axis
:*'''GZ''' = Depth profile; 3D data along depth axis
* Key '''"LineChart_Area" :''' image area spanned by the diagram axes.
* Key '''"LineChart_Extent" :''' total area occupied by the diagram on the image.
* Key '''"LineChart_X-Axis" :''' X-axis of the diagram and its positioning.
* Key '''"LineChart_Y-Axis" :''' Y-axis of the diagram and its positioning.
* (optional) Key '''"LineChart_Legend_Box" :''' name of a '''''Legend_Box''''', the object/area in which the curve legends of the diagram are stored and presented.
* (optional) Key '''"LineChart_Route_Dataset" :''' name of a '''''dataset''''' with profile route for sorting and filtering data to be displayed.
* (optional) Key '''"LineChart_PLR_Representation" :''' line Symbolization for the data curves of this diagram.
* (optional) Key '''"LineChart_PMR_Representation" :''' marker Symbolization for the data curves of this diagram.
* (optional) Key '''"LineChart_PLR_Palette" :''' color palette and start color for line symbols of this line chart.
* (optional) Key '''"LineChart_PMR_Palette" :''' color palette and start color for marker symbols of this line chart.
* (optional) Key '''"LineChart_FillArea_Between_Series" :''' Coloring of areas between two data series.
* (optional) Key '''"LineChart_FillArea_Series_Values" :''' Coloring of areas between a data series and a specific value.

===Block "Axis"===
The block '''Axis''' is used to define a diagram axis. 
An axis definition can be used for varius diagrams.
For example superposed "LineCharts" or several diagrams arranged
one below the other with the same time axis. 
Control file can contain multiple blocks of this type.
* Key '''"Axis_Name" :''' unique name of the axis definition.
* Key '''"Axis_Type" :''' type of axis.
:*'''T''' = time axis
:*'''G''' = axis for physical quantities
:*'''P''' = profile axis
:*'''Z''' = depth axis
* (optional) Key '''"Axis_Value_Range" :''' value range of the axis.
* (optional) Key '''"Axis_Date_Range" :''' time range of the axis.
* (optional) Key '''"Axis_Scale_Logarithmic" :''' switch logarithmic scaling LOG10 on TRUE/FALSE.
* (optional) Key '''"Axis_Invert_Profile_Route" :''' switch invert the route of a profile axis TRUE/FALSE.
* (optional) Key '''"Axis_Scale_Multiplicator" :''' multiplication factor for axis scaling.
* (optional) Key '''"Axis_Display_Name" :''' axis title, will be used instead of the original name given in the input data.
* (optional) Key '''"Axis_Display_Unit" :''' physical unit in which the data should be converted for the graphical presentation.
:Hints: The original unit of the data and the target unit must be known in the configuration file '''''phydef.cfg.si.dat'''''. In addition, the SI-base (dimension) of the units must be identical.
* (optional) Key '''"Axis_Labels_EquiDist_Value" :''' equidistant values for labeling along the axis.
* (optional) Key '''"Axis_Labels_EquiDist_Date" :''' equidistant dates for labeling along the axis.
* (optional) Key '''"Axis_Labels_at_Values" :''' list of values for labeling along the axis.
* (optional) Key '''"Axis_Labels_at_Dates" :''' list of dates for labeling along the axis.
* (optional) Key '''"Axis_Line_Representation" :''' name of a ''Poly_Line_Representation'' for the representation of the axis line.
* (optional) Key '''"Axis_Text_Representation" :''' name of a ''Text_Representation'' for the axis labeling (only influencing the font color).
* (optional) Key '''"Gitternetz_Representation" :''' name of a ''Poly_Line_Representation'' for the gridlines or switch off these lines with NONE.
* (optional) Key '''"Tickmark_Representation" :''' formatting or switching off axis tickmarks.
:* Parameter '''1''' = name of a color for the tickmarks
:* Parameter '''2''' = width of the tickmark line
:* Parameter '''3''' = length of tickmarks in image coordinates; 0.0 turn it off!
* (optional) Key '''"Axis_Additional_Line_Value" :''' draw an additional line vertical to the axis at a certain value.
* (optional) Key '''"Axis_Additional_Line_Date" :''' draw an additional line vertical to the time axis at a certain date.
* (optional) Key '''"Axis_Additional_Line_Coord" :''' draw an additional line vertical to the profile axis at a certain location.
* (optional) Key '''"Characters_along_Axis" :''' allows the manipulation of the font size of the axis labeling.
* (optional) Key '''"Axis_Number_Format" :''' Format specification for numerical values of the axis scaling.

===Block "DataRow"===
The block '''DataRow''' is used to describe a data series, or a group
of data series. 
Due to the data addressing in the ''DataSet'', a ''DataRow'' description can
result in several data series.
All these data series end up in the same line diagramm. 
Blocks of this type are needed for line charts. 
Control file can contain multiple blocks of this type.
* Key '''"DataRow_Name" :''' unique name of the data row description.
* Key '''"DataRow_Dataset" :''' name of the dataset to be displayed. Or a valid connexion (OPERATOR string) made out of known data sets, e. g. '''[DSet2-DSet1]/[DSet1+DSet2]''', '''ABS[DSet]''', '''SQR[DSet]''' or '''G18[DSet]'''.
* Key '''"DataRow_LineChart" :''' name of the ''LineChart'', i.e. of the line diagram in which the data series are to be drawn.
* (optional) Key '''"DataRow_PLR_Representation" :''' line symbolization for the data curves of this data series.
* (optional) Key '''"DataRow_PMR_Representation" :''' marker symbolization for the data curves of this data series.
* (optional) Key '''"DataRow_PLR_Palette" :''' color palette and start color for line symbols of this data series.
* (optional) Key '''"DataRow_PMR_Palette" :''' color palette and start color for marker symbols of this data series.
* (optional) Key '''"DataRow_NoValue_Handling" :''' Handling invalid values in the data series.
:*'''Luecke''' = Points without data are not displayed
:*'''Interpolation''' = a straight line closes the data gap in the curve

* (optional) Key '''"DataRow_NOBS_Filter" :''' filter for displayed data based on ''ancillary variable'' with type ''number of observations'':
** parameter 1: filter type:
*** '''EQ''' = display data only for a fixed number of observations;
*** '''LE''' = display data for a certain number of observations or less;
*** '''LE''' = display data for a certain number of observations or more.
** parameter 2: filter value:
*** '''0''' = maximum number of observations;
*** '''N''' = specified number of observations;
*** '''-M''' = maximum number of observations minus M.

===Block "Legend_Box"===
A legend box collects names and symbolizations of data curves and
displays them together in a text field.
A legend field can accommodate curve descriptions from different diagrams. 
A block of this type is only needed by line charts. 
Control file can contain multiple blocks of this type.
* Key '''"Legend_Box_Name" :''' unique name of the legend field.
* Key '''"Legend_Box_Plot_Area" :''' image area for the legend field.
* (optional) Key '''"Legend_Box_Draw_Frame" :''' draw a frame around the legend field TRUE/FALSE.
* (optional) Key '''"Legend_Box_Color_Name" :''' name of the color for text and frame.

===Block "Textbox"===
Description of one free text field. 
An empty text box can act as rectangular frame, with the color, type and width of the line
being adjustable. If you give the text box a background color, you can use it to cover
a particular area of the diagram. 
Control file can contain multiple blocks of this type.
* Key '''"Name" :''' unique name of the text box.
* Key '''"Plot_Area" :''' image area for the text box.
* (optional) Key '''"Text_Line" :''' one line of the text box. Specification of several lines possible. Placeholder for system information:
:*<SYS_DATE> will be replaced by current date.
:*<SYS_TIME> will be replaced by current time.
:*<SYS_USER> will be replaced by User ID.
:Placeholder for text box, which is connected to a Layer:
:*<LAY_DSET> will be replaced by the name of the dataset associated with the layer.
:*<LAY_DIM1> will be replaced by the info text for the 1st dimension of the displayed data set.
:*<LAY_DIM2> will be replaced by the info text for the 2nd dimension of the displayed data set.
:*<LAY_DIM?> etc. to the number of data set dimensions.
:Hint: Linking is realized in the layer block via KEY ''Layer_Description_Textbox''.
* (optional) Key '''"Color_Name" :''' colors of the textbox.
** parameter 1: for text and frame
** (optional) parameter 2: for background
* (optional) Key '''"Draw_Frame" :''' draw a frame around the text box TRUE/FALSE.
* (optional) Key '''"Frame_Style" :''' appearance of the text box frame.
** parameter 1: line width
** (optional) parameter 2: line type
* (optional) Key '''"Fixed_Width" :''' character-wise writing with constant width or not.
* (optional) Key '''"Horizontal_Char_Space" :''' Horizontal character distance factor for character-wise writing.
* (optional) Key '''"Vertical_Line_Space" :''' Vertical line spacing factor.
* (optional) Key '''"Font_Size" :''' Font size can be specified possibly.
* (optional) Key '''"Font_Size_Factor" :''' Factor for manipulating the calculated font size.

===Block "Poly_Marker_Representation"===
Description of one type of marker symbols. 
Control file can contain multiple blocks of this type.

===Block "Fill_Area_Representation"===
Description of one type of fill area symbolization. 
Control file can contain multiple blocks of this type.

===Block "Poly_Line_Representation"===
Description of one type of line symbolization. 
Control file can contain multiple blocks of this type.

===Block "Text_Representation"===
Description of one type of text symbolization. 
Control file can contain multiple blocks of this type.

===Block "Vector_Representation"===
Description of one type of vector symbolization. 
Control file can contain multiple blocks of this type. 
Hint: More info at '''''[[NCPLOT: Types of vector symbols]]'''''.

===General Remarks===
# While reading this steering data file the '''dictionary file''' '''''ncplot_dico.dat''''' will be automatically accessed in directory '''''$PROGHOME/dic/''''' to support input.
# If no such file exists in the working directory, NCPLOT accesses the following configuration files from the directory '''''$PROGHOME/cfg/''''':
#* '''''colors.cfg.dat''''': File with definitions of colors.
#* '''''palettes.cfg.dat''''': File with references to files with color palette definitions.
#* '''''bounds.cfg.dat''''': File with interval definitions for legends. Hint: The bounds file should be better stored within a project in the working directory.
# The following '''standard configuration files''' from the directory '''''$PROGHOME/cfg/''''' are required:
#* '''gkssystem.rechnername.dat''': GKS parameter file.
#* '''phydef.cfg.si.dat''': Configuration file for units and their relation to the SI system.

|nutzerprogramme=[[NCPLOT]]
|language=Fortran90
|fileform=FORMATTED
|fileaccess=SEQUENTIAL
|fileextension=.dat
|writemodules= ---
|readmodules=$PROGHOME/fortran/prg/ncplot/*/mod_m_ncplot_steer.f90
|contact_original=[mailto:guenther.lang@baw.de G. Lang], [mailto:susanne.spohr@baw.de S. Spohr]
|contact_maintenance=[mailto:guenther.lang@baw.de G. Lang], [mailto:susanne.spohr@baw.de S. Spohr]
|examplefile=$PROGHOME/examples/ncplot/ncplot.dat
}}

NCPLOT

2021-10-18T13:46:45Z

Ak3spohr: Version 6: SVG-Output

{{ProgramDescription
|name_de=NCPLOT
|name=NCPLOT
|version=October 2021
|version_descr=October 2021
|catchwords=graphical postprocessor 
graphical presentation of CF NetCDF data (unknown attributes are ignored) 
finite element models 
finite difference models 
orthogonal unstructured grid model 
orthogonal unstructured grid model with subgrid information 
conversion or transformation (extensive - intensive) of physical units 
calculation of new quantities (for display) from one or several input data sets 
(optional) filter based on water depth 
(optional) filter based on number of observations 

Acknowledgment: ''This project took advantage of netCDF software developed by UCAR/Unidata ([http://www.unidata.ucar.edu/software/netcdf/ www.unidata.ucar.edu/software/netcdf/]).''

|shortdescription=
The graphical postprocessor NCPLOT can be used for a graphical presentation
of simulation and analysis results, which is stored in CF NetCDF data format.
The data can be defined on nodes, edges or faces. The program works on 2D-data,
3D-data and on data with details scaled on a subgrid. 
[[File:NcplotBspFaceArea.png|thumb|250px|Picture 1: Salinity with underlaid topography.]]

The sample pictures illustrate the capability of the program NCPLOT. 
[[NCPLOT: Example figures|Example figures: NCPLOT]]

Basically, NCPLOT distinguishes linear from areal chart types.
For area charts the symbolization of the data is depending on the data value
(color legend, proportional arrow).
For linear charts, the values of data series are plotted on an axis.
The symbolization of the data series is independent of the data value.
 

[[NCPLOT: Area Charts|Area Charts]]:
* Map, or top view illustration
* Vertical section along profile (3D data)
* Time depth diagram (3D data)
* Hovmöller diagram: Temporal development along profile.
 
[[NCPLOT: Line Charts|Line Charts]]: 
* time series
* profile view
* depth profile
 
NCPLOT allows you to illustrate different diagrams of different types in one picture.
Line diagrams next to areal charts with static and possibly dynamic parts.
 

Picture series: 
Both line and area chart definitions can request the creation of picture series.
A picture can contain static and dynamic image components.
Dynamic components means parts of the image that vary over a picture series.
 

The following rule applies to the program: 
The first read dynamic definition determines the permitted length of the
picture series.
The program aborts, if a further dynamic diagram definition results a
different number of images.
 

Further tests are not carried out.
 

Different series diagrams from dynamic diagram definitions of the same
length are processed by the program. The static picture elements are displayed
on every picture in the series.
 

|inputfiles=
# '''general input data''' (file type [[NCPLOT.DAT|ncplot.dat]])
# '''result files''' (file type [[CF-NETCDF.NC]])
# file with '''interval definitions''' for color legends (file type [[BOUNDS.CFG.DAT|bounds.cfg.dat]]) Hint: (Recommended) Local configuration file or file from the directory ''$PROGHOME/cfg/''.
# file with '''list of definitions of palettes''' (file type [[PALETTES.CFG.DAT|palettes.cfg.dat]]) Hint: (Recommended) Provided file from the directory ''$PROGHOME/cfg/'' or local configuration file.
# file with '''definitions of colors''' (file type [[COLORS.CFG.DAT|colors.cfg.dat]]) Hint: (Recommended) Provided file from the directory ''$PROGHOME/cfg/'' or local configuration file.

For NCPLOT the following standard configuration files from the directory '''''$PROGHOME/cfg/''''' are required:
* GKS parameter file: '''gkssystem.computername.dat'''

|outputfiles=
# '''graphic files''' (format: CGM or SVG)
# (optional) informative '''printer file''' of program execution (file type ncplot.sdr)
# (optional) '''trace''' of program execution (file type ncplot.trc)

|methodology=
NCPLOT is a pure plot program without any user interaction at runtime.
The layout of the picture and the graphical presentation of the data has to be
described in the steering file.
 

NCPLOT creates vector graphics in CGM or SVG format.
 

For special data files it is possible to exclude data at places with low water
coverage from the display. The technic works only on original UnTRIM result files
in CF NetCDF format.
 

Just in case '''HDF error''' is detected during read of a data record,
the program tries to reconstruct the wanted data set from adjacent (in time)
records for the same variable.
This type of repair works for time dependent variables only.
 

|preprocessor=[[BOE2NC]], [[DATACONVERT]], [[GRIDCONVERT]], [[NCAGGREGATE]], [[NCANALYSE]], [[NCCUTOUT]], [[NCDELTA]], [[NCDVAR]], [[UNK]], [[UNTRIM2007]], [[UNTRIM2]]
|postprocessor=---
|language=Fortran95
|add_software=GKS (by GTS-Gral)
|contact_original=[mailto:guenther.lang@baw.de G. Lang], [mailto:susanne.spohr@baw.de S. Spohr]
|contact_maintenance=[mailto:guenther.lang@baw.de G. Lang], [mailto:susanne.spohr@baw.de S. Spohr]
|documentation=
template files available in '''$PROGHOME/examples/ncplot'''
}}

NCPLOT: Area Charts

2020-10-23T13:55:14Z

Ak3spohr: + Hovmöller variant TP

__NOAUTOLINKS__
__NOAUTOLINKTARGET__
[[de:NCPLOT: Flächenhafte Diagramme]]
__TOC__
 

=General=

The visualisation of a data set as an area diagram is described in a so-called ''Layer''.
The assignment of colors to values of a data set and the form of representation
of the underlying geometry are set in one layer block of the steering file.
Different layers can be plotted lying upon each other.
 

The map view (horizontal plane) differs fundamentaly from the illustration using
area charts with axes.
Instead of specifying the image area and axes definitions, the relationship
between world and image coordinates is described using a so-called
''Normalization_Transformation''.
 

Color legends used by a layer can be displayed on the scene and can be arranged
horizontally or vertically.
Another layer dependent, optional image element is a text field
for the data label (e.g. Indication of the time).
 

Also simple data operations can be executed (addition, subtraction,
multiplication, division, absolute value, square root).
 

=Types of area charts=

==Map, or top view illustration==
Scaled maps, or top view representation of simulation or analysis results.
[[File:NcplotBspFaceArea.png|thumb|250px|Picture 1: Salinity with underlaid topography.]]

===Options of presentation===
The data are presented by the program at their original positions (node, edge, face).
A horizontal interpolation of the data is also possible.
In addition to the fill area symbolization the data can be visualized by
line symbolization by marker symbols or text.
For edge and polygon data, there are also the possibilities of point-symbolization.
In this case the marker or the text is positioned at the middle of the edge or at the
polygon center.
The edges of polygons can be also visualized by lines symbolization.

The sample pictures illustrate the capability of the program [[NCPLOT]]. 
[[NCPLOT: Example Figures Area Chart Map View|Example Figures: Map View]]

===Coordinate frame===
Each map can be framed.
The type of frame can be a simple black edging or a complex frame with coordinates.
The offered coordinate frames are optimized for values belonging to Gauss Krüger
or to universal transverse mercator (UTM) projections.
Different maps can be arranged in one picture.

===Vector representation===
If the X- and the Y-component of a vector quantity exists, the visualization of
the entire vector is possible.
Normal components of a vector quantity saved on edges can be visualized as a
normal vector of the edge or as an interpolated total vector. 
The thin out of the display of vector arrows is possible.

[[File:NcplotBspAcPzElbeLP.png|thumb|250px|Picture 2: Vertical section (3D data).]]
[[File:NcplotBspAcTzBrunCU.png|thumb|250px|Picture 3: Time depth diagram (3D data).]]
[[File:NcplotBspAcPtElbeHov.png|thumb|250px|Picture 4: Hovmöller diagram variant PT.]]
[[File:NcplotBspAcTpElbeQp.png|thumb|250px|Picture 5: Hovmöller diagram variant TP.]]
 

==Vertical section==
Representation of depth dependent, scalar simulation or analysis results
along a profile axis (Picture 2).
 

==Time depth diagram==
Representation of the temporal development of depth-dependent, scalar simulation or
analysis results at a specific location (Picture 3).
 

==Hovmöller diagram==
Representation of the temporal development of scalar simulation or
analysis results over a profile or locations axis. 
variant PT: X-axis=profile axis, Y-axis=time axis (Picture 4). 
variant TP: X-axis=time axis, Y-axis=profile axis (Picture 5). 
 

----
back to [[NCPLOT]]

NCPLOT: Example figures

2020-10-23T13:32:42Z

Ak3spohr: (+ 2nd Hovmöller variant TP)

__NOAUTOLINKS__
__NOAUTOLINKTARGET__
[[de:Beispiel-Grafiken: NCPLOT]]

The sample pictures should give an impression of the capability of the program [[NCPLOT]].
__TOC__
 

=Examples=

===Area Chart: Map View===
{| border="1"
! width="50%" | Topography with details on a subgrid
! width="50%" | Comparison of water level and salinity
|-
|[[File:NcplotBspSubgridTopo.png|center|500px|Topography with details on a subgrid]]
|[[File:NcplotBspTwo_Maps.png|center|500px|Comparison of water level and salinity]]
|}
 

===Area Chart: Vertical sections along profiles (3D data)===
{| border="1"
! width="50%" | Salinity along Elbe longitudinal profile
! width="50%" | Salinity cross profile Elbe-KM 703
|-
|[[File:NcplotBspAcPzElbeLP.png|center|500px|Salinity along Elbe longitudinal profile]]
|[[File:NcplotBspAcPzElbeQP.png|center|500px|Salinity cross profile Elbe-KM 703]]
|}
 

===Area Chart: Time depth diagram (3D data)===
{| border="1"
! width="50%" | Scalar current velocity
! width="50%" | Salinity Elbe at Brunsbüttel
|-
|[[File:NcplotBspAcTzBrunCU.png|center|500px|Scalar current velocity]]
|[[File:NcplotBspAcTzBrunSA.png|center|500px|Salinity Elbe at Brunsbüttel]]
|}
 

===Area Chart: Hovmöller diagram===
{| border="1"
! width="50%" | Variante PT: X-axis=profile axis, Y-axis=time axis
! width="50%" | Variante TP: X-axis=time axis (T), Y-axis=profile axis (P).
|-
|[[File:NcplotBspAcPtElbeHov.png|center|500px|Water level development along the river Elbe]]
|[[File:NcplotBspAcTpElbeQp.png|center|500px|Salinity development at Elbe cross profile]]
|}
 

===Line Chart: Time series===
{| border="1"
! width="50%" | Measurement ADCP cross section (Gandersum)
! width="50%" | Aggregated transport of suspended load
|-
|[[File:NcplotBspLcTgAdcpGandersum.png|center|500px|Measurement ADCP cross section (Gandersum)]]
|[[File:NcplotBspAggSchwStTp.png|center|500px|Aggregated transport of suspended load over edge surfaces]]
|}
 

===Line Chart: Profile view===
{| border="1"
! width="50%" | Water levels along the river Elbe
! width="50%" |
|-
|[[File:NcplotBspLcPgElbeLP.png|center|500px|Water levels along the river Elbe]]
|
|}
 

===Line Chart: Depth profile===
{| border="1"
! width="50%" | Absolute value of mean current velocity (Weser)
! width="50%" |
|-
|[[File:NcplotBspLcGzWeserCU.png|center|500px|Absolute value of mean current velocity (Weser)]]
|
|}
 

----
back to [[NCPLOT]]

File:NcplotBspAcTpElbeQp.png

2020-10-23T13:25:27Z

Ak3spohr: NCPLOT example figure Hovmöller diagram (variant TP): temporal development salinity at Elbe cross profile.

== Summary ==
NCPLOT example figure Hovmöller diagram (variant TP): temporal development salinity at Elbe cross profile.

NCPLOT.DAT

2020-10-23T12:07:09Z

Ak3spohr:

{{FileDescription
|name_de=NCPLOT.DAT
|filetype=ncplot.dat
|version=October 2020
|version_descr=October 2020
|significance=contains general steering data for the program [[NCPLOT]].
|filecontents=

===Block "Program_Parameters"===
The block '''Program_Parameters''' contains general steering data.
* Key '''"Language" :''' Language preference for labels and texts:
:*'''DE''' = German,
:*'''EN''' = English.
* Key '''"Max_Read_Storage" :''' max. read only memory (in bytes) for analysis
* Key '''"Min_Water_Depth" :''' minimum water coverage in [m].
:Hint: The excluding of data from the presentation in case of low water coverage is only possible, if the variable to be displayed points in a certain way to a variable associated with the total water depth. The CF-NetCDF output of UnTRIM programs fulfills this requirement. The page '''''[[NCPLOT: Min_Water_Depth]]''''' illustrates the effect of this control parameter.
* (optional) Key '''"Infobox_Plot_Area" :''' Image area for the metadata infobox.
:If this image area is specified, information about the plot creation will be given to the graphic. This includes information about the underlying data files as well as if neccessary information about used data filtering.
* (optional) Key '''"PLR_Representation" :''' Default setting for line symbols of data curves in line charts.
* (optional) Key '''"PMR_Representation" :''' Default setting for marker symbols of data curves in line charts.
* (optional) Key '''"PLR_Palette" :''' Color palette and start color for line symbols of data curves in line charts.
* (optional) Key '''"PMR_Palette" :''' Color palette and start color for marker symbols of data curves in line charts.
* (optional) Key '''"Picture_Name_Fixum" :''' fixed name part for CGM output file.
* (optional) Key '''"Phydef_Units" :''' Display physical units as in PHYDEF administration.
:Hint: Without explicit request, the units are displayed according to the BAW Rules.

===Block "Dataset"===
Description of a data set to be displayed. 
 
For addressing the data to be displayed, either the Start-Step-Stride technique
or the DimSelect method is available. The user has to choose one way or the other,
the procedures exclude each other. Each Start-Step-Stride-Addressing can be copied
by DimSelect, the other way round that is not the case.
DimSelect offers additional options for data selection, with the method
you can also realize non-equidistant index selection.
;Start-Step-Stride technique:
:For each dimension of the variable a start, step and stride value must be specified. The page '''''[[NCPLOT: Define DataSet]]''''' gives instructions for addressing the desired data.
;DimSelect method:
:DimSelect also requires the addressing of the indices for each dimension of the data variables to be displayed. But this can also happen indirectly. Various suitable selection methods are provided. The user can, for example, choose all faces by '''''DimSelect_All''''' without knowing the specific number, or pass the program via '''''DimSelect_Various_Date''''' a selection of times to be displayed. It is the responsibility of the program to find the corresponding indices. Related to data curves of line charts the DimSelect method offers a further advantage: For the individual dimensions this mimic allows to create text components for the names of the data series shown in the curve legend. 
Control file can contain multiple blocks of this type.
* Key '''"Name" :''' unique name of this data set.
* Key '''"File" :''' name of the CF-NetCDF file (*.nc) with the data to be displayed.
* Key '''"Variable" :''' Description of the data whose values are to be displayed.
:* Parameter '''1''' = name of the variable (in file of type *.nc)
:* (optional) Parameter '''2''' = role of the variable as part of a vector
::* X-component = Variable is the X component of a vector
::* Y-component = Variable is the Y component of a vector
::* normal_component = Variable is the normal component of a vector
:Hint: The command "ncdump -h <filename>.nc" shows the header of the CF-NetCDF file. The names of the offered variables and their dimensions can be found in the metadata.
* (optional) Key '''"Start" :''' start address for the data to be displayed.
* (optional) Key '''"Step" :''' number of steps for the data to be displayed.
* (optional) Key '''"Stride" :''' increment for the data to be displayed.
* (optional) Key '''"DimSelect_EquiDist_Index" :''' Equidistant selection of indices for a given dimension. Exemplary:
:* Parameter '''1''' = Name of the dimension
:* Parameter '''2''' = NONE or text component for curve legend
:* Parameter '''3''' = Index becomes part of the curve legend .true./.false.
:* Parameter '''4''' = Start Index
:* Parameter '''5''' = Index increment
:* Parameter '''6''' = Number of steps
* (optional) Key '''"DimSelect_EquiDist_Date" :''' Equidistant selection of times.
* (optional) Key '''"DimSelect_StartEnd_Index" :''' Selection of all indices from start to end index.
* (optional) Key '''"DimSelect_StartEnd_Date" :''' Selection of all times from start to end date.
* (optional) Key '''"DimSelect_Single_Index" :''' Selection of a specific index.
* (optional) Key '''"DimSelect_Single_Date" :''' Selection of a specific date.
* (optional) Key '''"DimSelect_Various_Index" :''' List of various indices.
* (optional) Key '''"DimSelect_Various_Date" :''' List of various dates.
* (optional) Key '''"DimSelect_All" :''' Selection of all indices of a dimension.
* (optional) Key '''"DimSelect_ByLabel_LabVar" :''' Determine indices with list of names by label variable.
* (optional) Key '''"DimSelect_ByLabel_List" :''' Continuation line to Key '''''DimSelect_ByLabel_LabVar'''''.
* (optional) Key '''"DimSelect_Location_Coord" :''' Selection of locations by coordinates.
* (optional) Key '''"DimSelect_LocByFile_File" :''' Selection of locations from file with locations.
* (optional) Key '''"DimSelect_LocByFile_List" :''' Continuation line to Key '''''DimSelect_LocByFile_File'''''.
* (optional) Key '''"Dimensions_for_Picture_Series" :''' Requesting seperate presentations for selected dimensions.
:Hint: Causes series of pictures, i.e. for each selected index of the dimensions listed here a separate picture is created. Only works with line charts. Picture series must be the same length!

===Block "Layer"===
A block of type Layer defines a area diagram.
The illustration in the horizontal plane (the map view) differs fundamentally
from the area charts with axes. 
Control file can contain multiple blocks of this type.
* Key '''"Name" :''' unique name of this layer and the possibility of assigning a different plot level to the diagram.
* Key '''"Layer_Dataset_Name" :''' name of the dataset to be displayed. Or a valid connexion (OPERATOR string) made out of known data sets, e. g. '''[DSet2-DSet1]/[DSet1+DSet2]''', '''ABS[DSet]''', '''SQR[DSet]''' or '''G18[DSet]'''.
* Key '''"Layer_Type" :''' type of data view of this layer.
:*'''XY_data''' = Map, or top view illustration (horizontal plane)
:*'''PZ''' = Vertical section along profile (3D data)
:*'''TZ''' = Time depth diagram (3D data)
:*'''PT''' = Hovmöller diagram variant 1: X-axis=profile axis (P), Y-axis=time axis (T).
:*'''TP''' = Hovmöller diagram variant 2: X-axis=time axis (T), Y-axis=profile axis (P).
* Key '''"Layer_Primitive_Name" :''' graphic primitive to visualize the data in the layer.
:* Parameter '''1''' = Symbolization of the layer
::*'''GPM''' = as poly marker
::*'''GPL''' = as poly line (only Layer_Type ''XY_data'')
::*'''GFA''' = as fill area
::*'''GTX''' = as text
::*'''VEC''' = as vector (only Layer_Type ''XY_data'')
:* (optional) Parameter '''2''' = Type of the vector ... optional parameter, only at VEC visualization permitted. ...allows, for example, the interpolation of the total vector from the normal component a vectorial quantity.
::*'''total''' = total vector
::*'''normal''' = normal vector
* Key '''"Layer_Primitive_Representation_Name" :''' name of the representation of the primitive.
* Key '''"Layer_Bounds_Name" :''' name of the interval definition for this layer (from the file '''''[[BOUNDS.CFG.DAT|bounds.cfg.dat]]''''').
:Hint: The number of intervals in the interval definition and the number of colors of the associated color legend must match.
* Key '''"Layer_Palette_Name" :''' name of the color legend for this layer (corresponds to the attribute ''Name'' in the file ''palette.dat''. More detailed information about palettes on file description page '''''[[PALETTES.CFG.DAT|palettes.cfg.dat]]''''').
* Key '''"Layer_Invert_Palette" :''' invertation of the color ramp.
* (optional) Key '''"Layer_Normalization_Transformation_Name" :''' name of the normalization transformation for this layer.
:Hint: Required for diagram definition map view (Layer_Type ''XY_data'').
* (optional) Key '''"Layer_Area" :''' Image area spanned by the diagram axes.
:Hint: Required for definitions of diagrams working with axes.
* (optional) Key '''"Layer_Extent" :''' Total area that the diagram in the picture takes up.
:Hint: Required for definitions of diagrams working with axes.
* (optional) Key '''"Layer_X-Axis" :''' X-axis of the diagram and its positioning.
:Hint: Required for definitions of diagrams working with axes.
* (optional) Key '''"Layer_Y-Axis" :''' Y-axis of the diagram and its positioning.
:Hint: Required for definitions of diagrams working with axes.
* (optional) Key '''"Layer_Legend_Plot_Area" :''' image area for the color legend of this layer. Depending on the space, the color legend can be applied horizontally or vertically.
* (optional) Key '''"Layer_Legend_Label_Switch" :''' Switch list for switching off or positioning labels of the color legend.
* (optional) Key '''"Layer_Data_Description_Name" :''' name of the '''''Data_Description''''' text box, which should collects up the data description (e.g. indication of the time) of this layer.
* (optional) Key '''"Layer_Display_Units" :''' physical unit in which the data should be converted for the graphical presentation.
:Hints: The original unit of the data and the target unit must be known in the configuration file '''''phydef.cfg.si.dat'''''. In addition, the SI-base (dimension) of the units must be identical.
* (optional) Key '''"Layer_Display_Name" :''' name of physical quantity, will be used instead of the original name given in the input data set. Without this line the name in PHYDEF is used, if the variable owns the attribute '''''name_id'''''.. Dynamic text parts can be realized with special placeholders:
:*<LAY_DSET> will be replaced by the name of the dataset associated with the layer.
:*<LAY_DIM1> will be replaced by the info text for the 1st dimension of the displayed data set.
:*<LAY_DIM2> will be replaced by the info text for the 2nd dimension of the displayed data set.
:*<LAY_DIM?> etc. to the number of data set dimensions.
* (optional) Key '''"Layer_Vector_Legend_Plot_Area" :''' image area for the vector legend in case of arrows with length_type proportional.
* (optional) Key '''"Layer_Vector_Thinout_Raster" :''' dimensions of the grid used to thin out the display of vector arrows.
* (optional) Key '''"Layer_NOBS_Filter" :''' filter for displayed data based on ''ancillary variable'' with type ''number of observations'':
** parameter 1: filter type:
*** '''EQ''' = display data only for a fixed number of observations;
*** '''LE''' = display data for a certain number of observations or less;
*** '''LE''' = display data for a certain number of observations or more.
** parameter 2: filter value:
*** '''0''' = maximum number of observations;
*** '''N''' = specified number of observations;
*** '''-M''' = maximum number of observations minus M.
* (optional) Key '''"Layer_Description_Textbox" :''' name of a textbox to be linked with the layer.
* (optional) Key '''"Layer_Route_Dataset" :''' name of a '''''dataset''''' with profile route for sorting and filtering data to be displayed.

===Block "Normalization_Transformation (NTN)"===
Definition of an image section and description of the link between the world and image
coordinates. 
A block of this type is only required for areal representation in the horizontal plane
(layer definition with Type == XY_Data). 
The coordinates of the drawing area, the so-called NDC space, range from [0.0,0.0] to [1.0,1.0].
For an undistorted view of the area the representation scale in the X direction must match
the scale in Y-direction (DWC / DNDC = const);
optionally also key '''"Autoscale"''' can be used for this purpose.
Distorted representations are also possible. 
* Key '''"Name" :''' unique name of this normalization transformation.
* Key '''"EPSG" :''' EPSG code of the data coordinates in the file.
* Key '''"EPSG_Window" :''' EPSG code of the plot projection.
* Key '''"Left_Lower_Window_Coordinates" :''' world coordinates (according to EPSG) the lower left corner of the projection window.
* Key '''"Right_Upper_Window_Coordinates" :''' world coordinates (according to EPSG) the upper right corner of the projection window.
* Key '''"Left_Lower_NDC_Coordinates" :''' picture coordinates (NDC within [0.0,1.0]) the lower left corner of the projection window.
* Key '''"Right_Upper_NDC_Coordinates" :''' picture coordinates (NDC within [0.0,1.0]) the upper right corner of the projection window.
* (optional) Key '''"Autoscale" :''' automatic adjustment (.true.) of scales in X- and Y-direction. Default is .false. (no adjustment).
* (optional) Key '''"Scale_Bar_Request"''' : Request drawing a scale bar. Autoscale needs to be on.
* (optional) Key '''"NTN_Framing" :''' Type of the coordinate frame when displayed as map.
:Hint: More info at '''''[[NCPLOT: Framing|Options of map frames]]'''''.

===Block "Data_Description"===
The block '''Data_Description''' defines a Data_Description object.
Such an object collects data descriptions and displays them together in a text field. 
A block of this type is currently only needed for area charts in the horizontal plane (Layer definition with Type == XY_Data). 
Control file can contain multiple blocks of this type.
* Key '''"Data_Desc_Name" :''' unique name of the text field for data descriptions.
* Key '''"Data_Desc_Plot_Area" :''' image area for the Data_Description text box.
* (optional) Key '''"Data_Desc_Draw_Frame" :''' draw a frame around the Data Description text box TRUE/FALSE.
* (optional) Key '''"Data_Desc_Color_Name" :''' name of the color for text and frame.

===Block "LineChart"===
The block '''LineChart''' is used to define a line diagram. 
A "LineChart" has only one X- and one Y-axis.
A secondary Y-axis must be realized by defining a second "LineChart" object
on the same drawing area and with the same X-axis. 
Any number of LineCharts can be stacked. The associated axes can be positioned
on all four sides of the diagram and can also be moved away from the drawing
area by different distances.
Thus, for example, on the sheet "one" time series diagram with three Y-axes
can be generated that represents the curves for flow amount, flow direction
and salinity together. 
Control file can contain multiple blocks of this type.
* Key '''"LineChart_Name" :''' unique name of the line chart and the possibility of assigning a different plot level to the diagram.
* Key '''"LineChart_Type" :''' type of line chart.
:*'''TG''' = Time series; Data over time
:*'''PG''' = Profile chart; Data over profile axis
:*'''GZ''' = Depth profile; 3D data along depth axis
* Key '''"LineChart_Area" :''' image area spanned by the diagram axes.
* Key '''"LineChart_Extent" :''' total area occupied by the diagram on the image.
* Key '''"LineChart_X-Axis" :''' X-axis of the diagram and its positioning.
* Key '''"LineChart_Y-Axis" :''' Y-axis of the diagram and its positioning.
* (optional) Key '''"LineChart_Legend_Box" :''' name of a '''''Legend_Box''''', the object/area in which the curve legends of the diagram are stored and presented.
* (optional) Key '''"LineChart_Route_Dataset" :''' name of a '''''dataset''''' with profile route for sorting and filtering data to be displayed.
* (optional) Key '''"LineChart_PLR_Representation" :''' line Symbolization for the data curves of this diagram.
* (optional) Key '''"LineChart_PMR_Representation" :''' marker Symbolization for the data curves of this diagram.
* (optional) Key '''"LineChart_PLR_Palette" :''' color palette and start color for line symbols of this line chart.
* (optional) Key '''"LineChart_PMR_Palette" :''' color palette and start color for marker symbols of this line chart.

===Block "Axis"===
The block '''Axis''' is used to define a diagram axis. 
An axis definition can be used for varius diagrams.
For example superposed "LineCharts" or several diagrams arranged
one below the other with the same time axis. 
Control file can contain multiple blocks of this type.
* Key '''"Axis_Name" :''' unique name of the axis definition.
* Key '''"Axis_Type" :''' type of axis.
:*'''T''' = time axis
:*'''G''' = axis for physical quantities
:*'''P''' = profile axis
:*'''Z''' = depth axis
* (optional) Key '''"Axis_Value_Range" :''' value range of the axis.
* (optional) Key '''"Axis_Date_Range" :''' time range of the axis.
* (optional) Key '''"Axis_Scale_Logarithmic" :''' switch logarithmic scaling LOG10 on TRUE/FALSE.
* (optional) Key '''"Axis_Invert_Profile_Route" :''' switch invert the route of a profile axis TRUE/FALSE.
* (optional) Key '''"Axis_Scale_Multiplicator" :''' multiplication factor for axis scaling.
* (optional) Key '''"Axis_Display_Name" :''' axis title, will be used instead of the original name given in the input data.
* (optional) Key '''"Axis_Display_Unit" :''' physical unit in which the data should be converted for the graphical presentation.
:Hints: The original unit of the data and the target unit must be known in the configuration file '''''phydef.cfg.si.dat'''''. In addition, the SI-base (dimension) of the units must be identical.
* (optional) Key '''"Axis_Labels_EquiDist_Value" :''' equidistant values for labeling along the axis.
* (optional) Key '''"Axis_Labels_EquiDist_Date" :''' equidistant dates for labeling along the axis.
* (optional) Key '''"Axis_Labels_at_Values" :''' list of values for labeling along the axis.
* (optional) Key '''"Axis_Labels_at_Dates" :''' list of dates for labeling along the axis.
* (optional) Key '''"Axis_Line_Representation" :''' name of a ''Poly_Line_Representation'' for the representation of the axis line.
* (optional) Key '''"Axis_Text_Representation" :''' name of a ''Text_Representation'' for the axis labeling (only influencing the font color).
* (optional) Key '''"Gitternetz_Representation" :''' name of a ''Poly_Line_Representation'' for the gridlines or switch off these lines with NONE.
* (optional) Key '''"Tickmark_Representation" :''' formatting or switching off axis tickmarks.
:* Parameter '''1''' = name of a color for the tickmarks
:* Parameter '''2''' = width of the tickmark line
:* Parameter '''3''' = length of tickmarks in image coordinates; 0.0 turn it off!
* (optional) Key '''"Axis_Additional_Line_Value" :''' draw an additional line vertical to the axis at a certain value.
* (optional) Key '''"Axis_Additional_Line_Date" :''' draw an additional line vertical to the time axis at a certain date.
* (optional) Key '''"Axis_Additional_Line_Coord" :''' draw an additional line vertical to the profile axis at a certain location.
* (optional) Key '''"Characters_along_Axis" :''' allows the manipulation of the font size of the axis labeling.
* (optional) Key '''"Axis_Number_Format" :''' Format specification for numerical values of the axis scaling.

===Block "DataRow"===
The block '''DataRow''' is used to describe a data series, or a group
of data series. 
Due to the data addressing in the ''DataSet'', a ''DataRow'' description can
result in several data series.
All these data series end up in the same line diagramm. 
Blocks of this type are needed for line charts. 
Control file can contain multiple blocks of this type.
* Key '''"DataRow_Name" :''' unique name of the data row description.
* Key '''"DataRow_Dataset" :''' name of the dataset to be displayed. Or a valid connexion (OPERATOR string) made out of known data sets, e. g. '''[DSet2-DSet1]/[DSet1+DSet2]''', '''ABS[DSet]''', '''SQR[DSet]''' or '''G18[DSet]'''.
* Key '''"DataRow_LineChart" :''' name of the ''LineChart'', i.e. of the line diagram in which the data series are to be drawn.
* (optional) Key '''"DataRow_PLR_Representation" :''' line symbolization for the data curves of this data series.
* (optional) Key '''"DataRow_PMR_Representation" :''' marker symbolization for the data curves of this data series.
* (optional) Key '''"DataRow_PLR_Palette" :''' color palette and start color for line symbols of this data series.
* (optional) Key '''"DataRow_PMR_Palette" :''' color palette and start color for marker symbols of this data series.
* (optional) Key '''"DataRow_NoValue_Handling" :''' Handling invalid values in the data series.
:*'''Luecke''' = Points without data are not displayed
* (optional) Key '''"DataRow_NOBS_Filter" :''' filter for displayed data based on ''ancillary variable'' with type ''number of observations'':
** parameter 1: filter type:
*** '''EQ''' = display data only for a fixed number of observations;
*** '''LE''' = display data for a certain number of observations or less;
*** '''LE''' = display data for a certain number of observations or more.
** parameter 2: filter value:
*** '''0''' = maximum number of observations;
*** '''N''' = specified number of observations;
*** '''-M''' = maximum number of observations minus M.

===Block "Legend_Box"===
A legend box collects names and symbolizations of data curves and
displays them together in a text field.
A legend field can accommodate curve descriptions from different diagrams. 
A block of this type is only needed by line charts. 
Control file can contain multiple blocks of this type.
* Key '''"Legend_Box_Name" :''' unique name of the legend field.
* Key '''"Legend_Box_Plot_Area" :''' image area for the legend field.
* (optional) Key '''"Legend_Box_Draw_Frame" :''' draw a frame around the legend field TRUE/FALSE.
* (optional) Key '''"Legend_Box_Color_Name" :''' name of the color for text and frame.

===Block "Textbox"===
Description of one free text field. 
An empty text box can act as rectangular frame, with the color, type and width of the line
being adjustable. If you give the text box a background color, you can use it to cover
a particular area of the diagram. 
Control file can contain multiple blocks of this type.
* Key '''"Name" :''' unique name of the text box.
* Key '''"Plot_Area" :''' image area for the text box.
* (optional) Key '''"Text_Line" :''' one line of the text box. Specification of several lines possible. Placeholder for system information:
:*<SYS_DATE> will be replaced by current date.
:*<SYS_TIME> will be replaced by current time.
:*<SYS_USER> will be replaced by User ID.
:Placeholder for text box, which is connected to a Layer:
:*<LAY_DSET> will be replaced by the name of the dataset associated with the layer.
:*<LAY_DIM1> will be replaced by the info text for the 1st dimension of the displayed data set.
:*<LAY_DIM2> will be replaced by the info text for the 2nd dimension of the displayed data set.
:*<LAY_DIM?> etc. to the number of data set dimensions.
:Hint: Linking is realized in the layer block via KEY ''Layer_Description_Textbox''.
* (optional) Key '''"Color_Name" :''' colors of the textbox.
** parameter 1: for text and frame
** (optional) parameter 2: for background
* (optional) Key '''"Draw_Frame" :''' draw a frame around the text box TRUE/FALSE.
* (optional) Key '''"Frame_Style" :''' appearance of the text box frame.
** parameter 1: line width
** (optional) parameter 2: line type
* (optional) Key '''"Fixed_Width" :''' character-wise writing with constant width or not.
* (optional) Key '''"Horizontal_Char_Space" :''' Horizontal character distance factor for character-wise writing.
* (optional) Key '''"Vertical_Line_Space" :''' Vertical line spacing factor.
* (optional) Key '''"Font_Size" :''' Font size can be specified possibly.
* (optional) Key '''"Font_Size_Factor" :''' Factor for manipulating the calculated font size.

===Block "Poly_Marker_Representation"===
Description of one type of marker symbols. 
Control file can contain multiple blocks of this type.

===Block "Fill_Area_Representation"===
Description of one type of fill area symbolization. 
Control file can contain multiple blocks of this type.

===Block "Poly_Line_Representation"===
Description of one type of line symbolization. 
Control file can contain multiple blocks of this type.

===Block "Text_Representation"===
Description of one type of text symbolization. 
Control file can contain multiple blocks of this type.

===Block "Vector_Representation"===
Description of one type of vector symbolization. 
Control file can contain multiple blocks of this type. 
Hint: More info at '''''[[NCPLOT: Types of vector symbols]]'''''.

===General Remarks===
# While reading this steering data file the '''dictionary file''' '''''ncplot_dico.dat''''' will be automatically accessed in directory '''''$PROGHOME/dic/''''' to support input.
# If no such file exists in the working directory, NCPLOT accesses the following configuration files from the directory '''''$PROGHOME/cfg/''''':
#* '''''colors.cfg.dat''''': File with definitions of colors.
#* '''''palettes.cfg.dat''''': File with references to files with color palette definitions.
#* '''''bounds.cfg.dat''''': File with interval definitions for legends. Hint: The bounds file should be better stored within a project in the working directory.
# The following '''standard configuration files''' from the directory '''''$PROGHOME/cfg/''''' are required:
#* '''gkssystem.rechnername.dat''': GKS parameter file.
#* '''phydef.cfg.si.dat''': Configuration file for units and their relation to the SI system.

|nutzerprogramme=[[NCPLOT]]
|language=Fortran90
|fileform=FORMATTED
|fileaccess=SEQUENTIAL
|fileextension=.dat
|writemodules= ---
|readmodules=$PROGHOME/fortran/prg/ncplot/*/mod_m_ncplot_steer.f90
|contact_original=[mailto:guenther.lang@baw.de G. Lang], [mailto:susanne.spohr@baw.de S. Spohr]
|contact_maintenance=[mailto:guenther.lang@baw.de G. Lang], [mailto:susanne.spohr@baw.de S. Spohr]
|examplefile=$PROGHOME/examples/ncplot/ncplot.dat
}}

NCPLOT.DAT

2020-10-23T12:03:50Z

Ak3spohr:

{{FileDescription
|name_de=NCPLOT.DAT
|filetype=ncplot.dat
|version=October 2020
|version_descr=October 2020
|significance=contains general steering data for the program [[NCPLOT]].
|filecontents=

===Block "Program_Parameters"===
The block '''Program_Parameters''' contains general steering data.
* Key '''"Language" :''' Language preference for labels and texts:
:*'''DE''' = German,
:*'''EN''' = English.
* Key '''"Max_Read_Storage" :''' max. read only memory (in bytes) for analysis
* Key '''"Min_Water_Depth" :''' minimum water coverage in [m].
:Hint: The excluding of data from the presentation in case of low water coverage is only possible, if the variable to be displayed points in a certain way to a variable associated with the total water depth. The CF-NetCDF output of UnTRIM programs fulfills this requirement. The page '''''[[NCPLOT: Min_Water_Depth]]''''' illustrates the effect of this control parameter.
* (optional) Key '''"Infobox_Plot_Area" :''' Image area for the metadata infobox.
:If this image area is specified, information about the plot creation will be given to the graphic. This includes information about the underlying data files as well as if neccessary information about used data filtering.
* (optional) Key '''"PLR_Representation" :''' Default setting for line symbols of data curves in line charts.
* (optional) Key '''"PMR_Representation" :''' Default setting for marker symbols of data curves in line charts.
* (optional) Key '''"PLR_Palette" :''' Color palette and start color for line symbols of data curves in line charts.
* (optional) Key '''"PMR_Palette" :''' Color palette and start color for marker symbols of data curves in line charts.
* (optional) Key '''"Picture_Name_Fixum" :''' fixed name part for CGM output file.
* (optional) Key '''"Phydef_Units" :''' Display physical units as in PHYDEF administration.
:Hint: Without explicit request, the units are displayed according to the BAW Rules.

===Block "Dataset"===
Description of a data set to be displayed. 
 
For addressing the data to be displayed, either the Start-Step-Stride technique
or the DimSelect method is available. The user has to choose one way or the other,
the procedures exclude each other. Each Start-Step-Stride-Addressing can be copied
by DimSelect, the other way round that is not the case.
DimSelect offers additional options for data selection, with the method
you can also realize non-equidistant index selection.
;Start-Step-Stride technique:
:For each dimension of the variable a start, step and stride value must be specified. The page '''''[[NCPLOT: Define DataSet]]''''' gives instructions for addressing the desired data.
;DimSelect method:
:DimSelect also requires the addressing of the indices for each dimension of the data variables to be displayed. But this can also happen indirectly. Various suitable selection methods are provided. The user can, for example, choose all faces by '''''DimSelect_All''''' without knowing the specific number, or pass the program via '''''DimSelect_Various_Date''''' a selection of times to be displayed. It is the responsibility of the program to find the corresponding indices. Related to data curves of line charts the DimSelect method offers a further advantage: For the individual dimensions this mimic allows to create text components for the names of the data series shown in the curve legend. 
Control file can contain multiple blocks of this type.
* Key '''"Name" :''' unique name of this data set.
* Key '''"File" :''' name of the CF-NetCDF file (*.nc) with the data to be displayed.
* Key '''"Variable" :''' Description of the data whose values are to be displayed.
:* Parameter '''1''' = name of the variable (in file of type *.nc)
:* (optional) Parameter '''2''' = role of the variable as part of a vector
::* X-component = Variable is the X component of a vector
::* Y-component = Variable is the Y component of a vector
::* normal_component = Variable is the normal component of a vector
:Hint: The command "ncdump -h <filename>.nc" shows the header of the CF-NetCDF file. The names of the offered variables and their dimensions can be found in the metadata.
* (optional) Key '''"Start" :''' start address for the data to be displayed.
* (optional) Key '''"Step" :''' number of steps for the data to be displayed.
* (optional) Key '''"Stride" :''' increment for the data to be displayed.
* (optional) Key '''"DimSelect_EquiDist_Index" :''' Equidistant selection of indices for a given dimension. Exemplary:
:* Parameter '''1''' = Name of the dimension
:* Parameter '''2''' = NONE or text component for curve legend
:* Parameter '''3''' = Index becomes part of the curve legend .true./.false.
:* Parameter '''4''' = Start Index
:* Parameter '''5''' = Index increment
:* Parameter '''6''' = Number of steps
* (optional) Key '''"DimSelect_EquiDist_Date" :''' Equidistant selection of times.
* (optional) Key '''"DimSelect_StartEnd_Index" :''' Selection of all indices from start to end index.
* (optional) Key '''"DimSelect_StartEnd_Date" :''' Selection of all times from start to end date.
* (optional) Key '''"DimSelect_Single_Index" :''' Selection of a specific index.
* (optional) Key '''"DimSelect_Single_Date" :''' Selection of a specific date.
* (optional) Key '''"DimSelect_Various_Index" :''' List of various indices.
* (optional) Key '''"DimSelect_Various_Date" :''' List of various dates.
* (optional) Key '''"DimSelect_All" :''' Selection of all indices of a dimension.
* (optional) Key '''"DimSelect_ByLabel_LabVar" :''' Determine indices with list of names by label variable.
* (optional) Key '''"DimSelect_ByLabel_List" :''' Continuation line to Key '''''DimSelect_ByLabel_LabVar'''''.
* (optional) Key '''"DimSelect_Location_Coord" :''' Selection of locations by coordinates.
* (optional) Key '''"DimSelect_LocByFile_File" :''' Selection of locations from file with locations.
* (optional) Key '''"DimSelect_LocByFile_List" :''' Continuation line to Key '''''DimSelect_LocByFile_File'''''.
* (optional) Key '''"Dimensions_for_Picture_Series" :''' Requesting seperate presentations for selected dimensions.
:Hint: Causes series of pictures, i.e. for each selected index of the dimensions listed here a separate picture is created. Only works with line charts. Picture series must be the same length!

===Block "Layer"===
A block of type Layer defines a area diagram.
The illustration in the horizontal plane (the map view) differs fundamentally
from the area charts with axes. 
Control file can contain multiple blocks of this type.
* Key '''"Name" :''' unique name of this layer and the possibility of assigning a different plot level to the diagram.
* Key '''"Layer_Dataset_Name" :''' name of the dataset to be displayed. Or a valid connexion (OPERATOR string) made out of known data sets, e. g. '''[DSet2-DSet1]/[DSet1+DSet2]''', '''ABS[DSet]''', '''SQR[DSet]''' or '''G18[DSet]'''.
* Key '''"Layer_Type" :''' type of data view of this layer.
:*'''XY_data''' = Map, or top view illustration (horizontal plane)
:*'''PZ''' = Vertical section along profile (3D data)
:*'''TZ''' = Time depth diagram (3D data)
:*'''PT''' = Hovmöller diagram variant 1: X-axis=profile axis (P), Y-axis=time axis (T).
:*'''TP''' = Hovmöller diagram variant 2: X-axis=time axis (T), Y-axis=profile axis (P).
* Key '''"Layer_Primitive_Name" :''' graphic primitive to visualize the data in the layer.
:* Parameter '''1''' = Symbolization of the layer
::*'''GPM''' = as poly marker
::*'''GPL''' = as poly line (only Layer_Type ''XY_data'')
::*'''GFA''' = as fill area
::*'''GTX''' = as text
::*'''VEC''' = as vector (only Layer_Type ''XY_data'')
:* (optional) Parameter '''2''' = Type of the vector ... optional parameter, only at VEC visualization permitted. ...allows, for example, the interpolation of the total vector from the normal component a vectorial quantity.
::*'''total''' = total vector
::*'''normal''' = normal vector
* Key '''"Layer_Primitive_Representation_Name" :''' name of the representation of the primitive.
* Key '''"Layer_Bounds_Name" :''' name of the interval definition for this layer (from the file '''''[[BOUNDS.CFG.DAT|bounds.cfg.dat]]''''').
:Hint: The number of intervals in the interval definition and the number of colors of the associated color legend must match.
* Key '''"Layer_Palette_Name" :''' name of the color legend for this layer (corresponds to the attribute ''Name'' in the file ''palette.dat''. More detailed information about palettes on file description page '''''[[PALETTES.CFG.DAT|palettes.cfg.dat]]''''').
* Key '''"Layer_Invert_Palette" :''' invertation of the color ramp.
* (optional) Key '''"Layer_Normalization_Transformation_Name" :''' name of the normalization transformation for this layer.
:Hint: Required for diagram definition map view (Layer_Type ''XY_data'').
* (optional) Key '''"Layer_Area" :''' Image area spanned by the diagram axes.
:Hint: Required for definitions of diagrams working with axes.
* (optional) Key '''"Layer_Extent" :''' Total area that the diagram in the picture takes up.
:Hint: Required for definitions of diagrams working with axes.
* (optional) Key '''"Layer_X-Axis" :''' X-axis of the diagram and its positioning.
:Hint: Required for definitions of diagrams working with axes.
* (optional) Key '''"Layer_Y-Axis" :''' Y-axis of the diagram and its positioning.
:Hint: Required for definitions of diagrams working with axes.
* (optional) Key '''"Layer_Legend_Plot_Area" :''' image area for the color legend of this layer. Depending on the space, the color legend can be applied horizontally or vertically.
* (optional) Key '''"Layer_Legend_Label_Switch" :''' Switch list for switching off or positioning labels of the color legend.
* (optional) Key '''"Layer_Data_Description_Name" :''' name of the '''''Data_Description''''' text box, which should collects up the data description (e.g. indication of the time) of this layer.
* (optional) Key '''"Layer_Display_Units" :''' physical unit in which the data should be converted for the graphical presentation.
:Hints: The original unit of the data and the target unit must be known in the configuration file '''''phydef.cfg.si.dat'''''. In addition, the SI-base (dimension) of the units must be identical.
* (optional) Key '''"Layer_Display_Name" :''' name of physical quantity, will be used instead of the original name given in the input data set. Without this line the name in PHYDEF is used, if the variable owns the attribute '''''name_id'''''.. Dynamic text parts can be realized with special placeholders:
:*<LAY_DSET> will be replaced by the name of the dataset associated with the layer.
:*<LAY_DIM1> will be replaced by the info text for the 1st dimension of the displayed data set.
:*<LAY_DIM2> will be replaced by the info text for the 2nd dimension of the displayed data set.
:*<LAY_DIM?> etc. to the number of data set dimensions.
* (optional) Key '''"Layer_Vector_Legend_Plot_Area" :''' image area for the vector legend in case of arrows with length_type proportional.
* (optional) Key '''"Layer_Vector_Thinout_Raster" :''' dimensions of the grid used to thin out the display of vector arrows.
* (optional) Key '''"Layer_NOBS_Filter" :''' filter for displayed data based on ''ancillary variable'' with type ''number of observations'':
** parameter 1: filter type:
*** '''EQ''' = display data only for a fixed number of observations;
*** '''LE''' = display data for a certain number of observations or less;
*** '''LE''' = display data for a certain number of observations or more.
** parameter 2: filter value:
*** '''0''' = maximum number of observations;
*** '''N''' = specified number of observations;
*** '''-M''' = maximum number of observations minus M.
* (optional) Key '''"Layer_Description_Textbox" :''' name of a textbox to be linked with the layer.
* (optional) Key '''"Layer_Route_Dataset" :''' name of a '''''dataset''''' with profile route for sorting and filtering data to be displayed.

===Block "Normalization_Transformation (NTN)"===
Definition of an image section and description of the link between the world and image
coordinates. 
A block of this type is only required for areal representation in the horizontal plane
(layer definition with Type == XY_Data). 
The coordinates of the drawing area, the so-called NDC space, range from [0.0,0.0] to [1.0,1.0].
For an undistorted view of the area the representation scale in the X direction must match
the scale in Y-direction (DWC / DNDC = const);
optionally also key '''"Autoscale"''' can be used for this purpose.
Distorted representations are also possible. 
* Key '''"Name" :''' unique name of this normalization transformation.
* Key '''"EPSG" :''' EPSG code of the data coordinates in the file.
* Key '''"EPSG_Window" :''' EPSG code of the plot projection.
* Key '''"Left_Lower_Window_Coordinates" :''' world coordinates (according to EPSG) the lower left corner of the projection window.
* Key '''"Right_Upper_Window_Coordinates" :''' world coordinates (according to EPSG) the upper right corner of the projection window.
* Key '''"Left_Lower_NDC_Coordinates" :''' picture coordinates (NDC within [0.0,1.0]) the lower left corner of the projection window.
* Key '''"Right_Upper_NDC_Coordinates" :''' picture coordinates (NDC within [0.0,1.0]) the upper right corner of the projection window.
* (optional) Key '''"Autoscale" :''' automatic adjustment (.true.) of scales in X- and Y-direction. Default is .false. (no adjustment).
* (optional) Key '''"Scale_Bar_Request"''' : Request drawing a scale bar. Autoscale needs to be on.
* (optional) Key '''"NTN_Framing" :''' Type of the coordinate frame when displayed as map.
:Hint: More info at '''''[[NCPLOT: Framing|Options of map frames]]'''''.

===Block "Data_Description"===
The block '''Data_Description''' defines a Data_Description object.
Such an object collects data descriptions and displays them together in a text field. 
A block of this type is currently only needed for area charts in the horizontal plane (Layer definition with Type == XY_Data). 
Control file can contain multiple blocks of this type.
* Key '''"Data_Desc_Name" :''' unique name of the text field for data descriptions.
* Key '''"Data_Desc_Plot_Area" :''' image area for the Data_Description text box.
* (optional) Key '''"Data_Desc_Draw_Frame" :''' draw a frame around the Data Description text box TRUE/FALSE.
* (optional) Key '''"Data_Desc_Color_Name" :''' name of the color for text and frame.

===Block "LineChart"===
The block '''LineChart''' is used to define a line diagram. 
A "LineChart" has only one X- and one Y-axis.
A secondary Y-axis must be realized by defining a second "LineChart" object
on the same drawing area and with the same X-axis. 
Any number of LineCharts can be stacked. The associated axes can be positioned
on all four sides of the diagram and can also be moved away from the drawing
area by different distances.
Thus, for example, on the sheet "one" time series diagram with three Y-axes
can be generated that represents the curves for flow amount, flow direction
and salinity together. 
Control file can contain multiple blocks of this type.
* Key '''"LineChart_Name" :''' unique name of the line chart and the possibility of assigning a different plot level to the diagram.
* Key '''"LineChart_Type" :''' type of line chart.
:*'''TG''' = Time series; Data over time
:*'''PG''' = Profile chart; Data over profile axis
:*'''GZ''' = Depth profile; 3D data along depth axis
* Key '''"LineChart_Area" :''' image area spanned by the diagram axes.
* Key '''"LineChart_Extent" :''' total area occupied by the diagram on the image.
* Key '''"LineChart_X-Axis" :''' X-axis of the diagram and its positioning.
* Key '''"LineChart_Y-Axis" :''' Y-axis of the diagram and its positioning.
* (optional) Key '''"LineChart_Legend_Box" :''' name of a '''''Legend_Box''''', the object/area in which the curve legends of the diagram are stored and presented.
* (optional) Key '''"LineChart_Route_Dataset" :''' * (optional) Key '''"LineChart_PLR_Representation" :''' line Symbolization for the data curves of this diagram.
* (optional) Key '''"LineChart_PMR_Representation" :''' marker Symbolization for the data curves of this diagram.
* (optional) Key '''"LineChart_PLR_Palette" :''' color palette and start color for line symbols of this line chart.
* (optional) Key '''"LineChart_PMR_Palette" :''' color palette and start color for marker symbols of this line chart.

===Block "Axis"===
The block '''Axis''' is used to define a diagram axis. 
An axis definition can be used for varius diagrams.
For example superposed "LineCharts" or several diagrams arranged
one below the other with the same time axis. 
Control file can contain multiple blocks of this type.
* Key '''"Axis_Name" :''' unique name of the axis definition.
* Key '''"Axis_Type" :''' type of axis.
:*'''T''' = time axis
:*'''G''' = axis for physical quantities
:*'''P''' = profile axis
:*'''Z''' = depth axis
* (optional) Key '''"Axis_Value_Range" :''' value range of the axis.
* (optional) Key '''"Axis_Date_Range" :''' time range of the axis.
* (optional) Key '''"Axis_Scale_Logarithmic" :''' switch logarithmic scaling LOG10 on TRUE/FALSE.
* (optional) Key '''"Axis_Invert_Profile_Route" :''' switch invert the route of a profile axis TRUE/FALSE.
* (optional) Key '''"Axis_Scale_Multiplicator" :''' multiplication factor for axis scaling.
* (optional) Key '''"Axis_Display_Name" :''' axis title, will be used instead of the original name given in the input data.
* (optional) Key '''"Axis_Display_Unit" :''' physical unit in which the data should be converted for the graphical presentation.
:Hints: The original unit of the data and the target unit must be known in the configuration file '''''phydef.cfg.si.dat'''''. In addition, the SI-base (dimension) of the units must be identical.
* (optional) Key '''"Axis_Labels_EquiDist_Value" :''' equidistant values for labeling along the axis.
* (optional) Key '''"Axis_Labels_EquiDist_Date" :''' equidistant dates for labeling along the axis.
* (optional) Key '''"Axis_Labels_at_Values" :''' list of values for labeling along the axis.
* (optional) Key '''"Axis_Labels_at_Dates" :''' list of dates for labeling along the axis.
* (optional) Key '''"Axis_Line_Representation" :''' name of a ''Poly_Line_Representation'' for the representation of the axis line.
* (optional) Key '''"Axis_Text_Representation" :''' name of a ''Text_Representation'' for the axis labeling (only influencing the font color).
* (optional) Key '''"Gitternetz_Representation" :''' name of a ''Poly_Line_Representation'' for the gridlines or switch off these lines with NONE.
* (optional) Key '''"Tickmark_Representation" :''' formatting or switching off axis tickmarks.
:* Parameter '''1''' = name of a color for the tickmarks
:* Parameter '''2''' = width of the tickmark line
:* Parameter '''3''' = length of tickmarks in image coordinates; 0.0 turn it off!
* (optional) Key '''"Axis_Additional_Line_Value" :''' draw an additional line vertical to the axis at a certain value.
* (optional) Key '''"Axis_Additional_Line_Date" :''' draw an additional line vertical to the time axis at a certain date.
* (optional) Key '''"Axis_Additional_Line_Coord" :''' draw an additional line vertical to the profile axis at a certain location.
* (optional) Key '''"Characters_along_Axis" :''' allows the manipulation of the font size of the axis labeling.
* (optional) Key '''"Axis_Number_Format" :''' Format specification for numerical values of the axis scaling.

===Block "DataRow"===
The block '''DataRow''' is used to describe a data series, or a group
of data series. 
Due to the data addressing in the ''DataSet'', a ''DataRow'' description can
result in several data series.
All these data series end up in the same line diagramm. 
Blocks of this type are needed for line charts. 
Control file can contain multiple blocks of this type.
* Key '''"DataRow_Name" :''' unique name of the data row description.
* Key '''"DataRow_Dataset" :''' name of the dataset to be displayed. Or a valid connexion (OPERATOR string) made out of known data sets, e. g. '''[DSet2-DSet1]/[DSet1+DSet2]''', '''ABS[DSet]''', '''SQR[DSet]''' or '''G18[DSet]'''.
* Key '''"DataRow_LineChart" :''' name of the ''LineChart'', i.e. of the line diagram in which the data series are to be drawn.
* (optional) Key '''"DataRow_PLR_Representation" :''' line symbolization for the data curves of this data series.
* (optional) Key '''"DataRow_PMR_Representation" :''' marker symbolization for the data curves of this data series.
* (optional) Key '''"DataRow_PLR_Palette" :''' color palette and start color for line symbols of this data series.
* (optional) Key '''"DataRow_PMR_Palette" :''' color palette and start color for marker symbols of this data series.
* (optional) Key '''"DataRow_NoValue_Handling" :''' Handling invalid values in the data series.
:*'''Luecke''' = Points without data are not displayed
* (optional) Key '''"DataRow_NOBS_Filter" :''' filter for displayed data based on ''ancillary variable'' with type ''number of observations'':
** parameter 1: filter type:
*** '''EQ''' = display data only for a fixed number of observations;
*** '''LE''' = display data for a certain number of observations or less;
*** '''LE''' = display data for a certain number of observations or more.
** parameter 2: filter value:
*** '''0''' = maximum number of observations;
*** '''N''' = specified number of observations;
*** '''-M''' = maximum number of observations minus M.

===Block "Legend_Box"===
A legend box collects names and symbolizations of data curves and
displays them together in a text field.
A legend field can accommodate curve descriptions from different diagrams. 
A block of this type is only needed by line charts. 
Control file can contain multiple blocks of this type.
* Key '''"Legend_Box_Name" :''' unique name of the legend field.
* Key '''"Legend_Box_Plot_Area" :''' image area for the legend field.
* (optional) Key '''"Legend_Box_Draw_Frame" :''' draw a frame around the legend field TRUE/FALSE.
* (optional) Key '''"Legend_Box_Color_Name" :''' name of the color for text and frame.

===Block "Textbox"===
Description of one free text field. 
An empty text box can act as rectangular frame, with the color, type and width of the line
being adjustable. If you give the text box a background color, you can use it to cover
a particular area of the diagram. 
Control file can contain multiple blocks of this type.
* Key '''"Name" :''' unique name of the text box.
* Key '''"Plot_Area" :''' image area for the text box.
* (optional) Key '''"Text_Line" :''' one line of the text box. Specification of several lines possible. Placeholder for system information:
:*<SYS_DATE> will be replaced by current date.
:*<SYS_TIME> will be replaced by current time.
:*<SYS_USER> will be replaced by User ID.
:Placeholder for text box, which is connected to a Layer:
:*<LAY_DSET> will be replaced by the name of the dataset associated with the layer.
:*<LAY_DIM1> will be replaced by the info text for the 1st dimension of the displayed data set.
:*<LAY_DIM2> will be replaced by the info text for the 2nd dimension of the displayed data set.
:*<LAY_DIM?> etc. to the number of data set dimensions.
:Hint: Linking is realized in the layer block via KEY ''Layer_Description_Textbox''.
* (optional) Key '''"Color_Name" :''' colors of the textbox.
** parameter 1: for text and frame
** (optional) parameter 2: for background
* (optional) Key '''"Draw_Frame" :''' draw a frame around the text box TRUE/FALSE.
* (optional) Key '''"Frame_Style" :''' appearance of the text box frame.
** parameter 1: line width
** (optional) parameter 2: line type
* (optional) Key '''"Fixed_Width" :''' character-wise writing with constant width or not.
* (optional) Key '''"Horizontal_Char_Space" :''' Horizontal character distance factor for character-wise writing.
* (optional) Key '''"Vertical_Line_Space" :''' Vertical line spacing factor.
* (optional) Key '''"Font_Size" :''' Font size can be specified possibly.
* (optional) Key '''"Font_Size_Factor" :''' Factor for manipulating the calculated font size.

===Block "Poly_Marker_Representation"===
Description of one type of marker symbols. 
Control file can contain multiple blocks of this type.

===Block "Fill_Area_Representation"===
Description of one type of fill area symbolization. 
Control file can contain multiple blocks of this type.

===Block "Poly_Line_Representation"===
Description of one type of line symbolization. 
Control file can contain multiple blocks of this type.

===Block "Text_Representation"===
Description of one type of text symbolization. 
Control file can contain multiple blocks of this type.

===Block "Vector_Representation"===
Description of one type of vector symbolization. 
Control file can contain multiple blocks of this type. 
Hint: More info at '''''[[NCPLOT: Types of vector symbols]]'''''.

===General Remarks===
# While reading this steering data file the '''dictionary file''' '''''ncplot_dico.dat''''' will be automatically accessed in directory '''''$PROGHOME/dic/''''' to support input.
# If no such file exists in the working directory, NCPLOT accesses the following configuration files from the directory '''''$PROGHOME/cfg/''''':
#* '''''colors.cfg.dat''''': File with definitions of colors.
#* '''''palettes.cfg.dat''''': File with references to files with color palette definitions.
#* '''''bounds.cfg.dat''''': File with interval definitions for legends. Hint: The bounds file should be better stored within a project in the working directory.
# The following '''standard configuration files''' from the directory '''''$PROGHOME/cfg/''''' are required:
#* '''gkssystem.rechnername.dat''': GKS parameter file.
#* '''phydef.cfg.si.dat''': Configuration file for units and their relation to the SI system.

|nutzerprogramme=[[NCPLOT]]
|language=Fortran90
|fileform=FORMATTED
|fileaccess=SEQUENTIAL
|fileextension=.dat
|writemodules= ---
|readmodules=$PROGHOME/fortran/prg/ncplot/*/mod_m_ncplot_steer.f90
|contact_original=[mailto:guenther.lang@baw.de G. Lang], [mailto:susanne.spohr@baw.de S. Spohr]
|contact_maintenance=[mailto:guenther.lang@baw.de G. Lang], [mailto:susanne.spohr@baw.de S. Spohr]
|examplefile=$PROGHOME/examples/ncplot/ncplot.dat
}}

NCPLOT.DAT

2020-10-23T12:01:12Z

Ak3spohr: Changes for version ncplot_2020_09_18

{{FileDescription
|name_de=NCPLOT.DAT
|filetype=ncplot.dat
|version=October 2020
|version_descr=October 2020
|significance=contains general steering data for the program [[NCPLOT]].
|filecontents=

===Block "Program_Parameters"===
The block '''Program_Parameters''' contains general steering data.
* Key '''"Language" :''' Language preference for labels and texts:
:*'''DE''' = German,
:*'''EN''' = English.
* Key '''"Max_Read_Storage" :''' max. read only memory (in bytes) for analysis
* Key '''"Min_Water_Depth" :''' minimum water coverage in [m].
:Hint: The excluding of data from the presentation in case of low water coverage is only possible, if the variable to be displayed points in a certain way to a variable associated with the total water depth. The CF-NetCDF output of UnTRIM programs fulfills this requirement. The page '''''[[NCPLOT: Min_Water_Depth]]''''' illustrates the effect of this control parameter.
* (optional) Key '''"Infobox_Plot_Area" :''' Image area for the metadata infobox.
:If this image area is specified, information about the plot creation will be given to the graphic. This includes information about the underlying data files as well as if neccessary information about used data filtering.
* (optional) Key '''"PLR_Representation" :''' Default setting for line symbols of data curves in line charts.
* (optional) Key '''"PMR_Representation" :''' Default setting for marker symbols of data curves in line charts.
* (optional) Key '''"PLR_Palette" :''' Color palette and start color for line symbols of data curves in line charts.
* (optional) Key '''"PMR_Palette" :''' Color palette and start color for marker symbols of data curves in line charts.
* (optional) Key '''"Picture_Name_Fixum" :''' fixed name part for CGM output file.
* (optional) Key '''"Phydef_Units" :''' Display physical units as in PHYDEF administration.
:Hint: Without explicit request, the units are displayed according to the BAW Rules.

===Block "Dataset"===
Description of a data set to be displayed. 
 
For addressing the data to be displayed, either the Start-Step-Stride technique
or the DimSelect method is available. The user has to choose one way or the other,
the procedures exclude each other. Each Start-Step-Stride-Addressing can be copied
by DimSelect, the other way round that is not the case.
DimSelect offers additional options for data selection, with the method
you can also realize non-equidistant index selection.
;Start-Step-Stride technique:
:For each dimension of the variable a start, step and stride value must be specified. The page '''''[[NCPLOT: Define DataSet]]''''' gives instructions for addressing the desired data.
;DimSelect method:
:DimSelect also requires the addressing of the indices for each dimension of the data variables to be displayed. But this can also happen indirectly. Various suitable selection methods are provided. The user can, for example, choose all faces by '''''DimSelect_All''''' without knowing the specific number, or pass the program via '''''DimSelect_Various_Date''''' a selection of times to be displayed. It is the responsibility of the program to find the corresponding indices. Related to data curves of line charts the DimSelect method offers a further advantage: For the individual dimensions this mimic allows to create text components for the names of the data series shown in the curve legend. 
Control file can contain multiple blocks of this type.
* Key '''"Name" :''' unique name of this data set.
* Key '''"File" :''' name of the CF-NetCDF file (*.nc) with the data to be displayed.
* Key '''"Variable" :''' Description of the data whose values are to be displayed.
:* Parameter '''1''' = name of the variable (in file of type *.nc)
:* (optional) Parameter '''2''' = role of the variable as part of a vector
::* X-component = Variable is the X component of a vector
::* Y-component = Variable is the Y component of a vector
::* normal_component = Variable is the normal component of a vector
:Hint: The command "ncdump -h <filename>.nc" shows the header of the CF-NetCDF file. The names of the offered variables and their dimensions can be found in the metadata.
* (optional) Key '''"Start" :''' start address for the data to be displayed.
* (optional) Key '''"Step" :''' number of steps for the data to be displayed.
* (optional) Key '''"Stride" :''' increment for the data to be displayed.
* (optional) Key '''"DimSelect_EquiDist_Index" :''' Equidistant selection of indices for a given dimension. Exemplary:
:* Parameter '''1''' = Name of the dimension
:* Parameter '''2''' = NONE or text component for curve legend
:* Parameter '''3''' = Index becomes part of the curve legend .true./.false.
:* Parameter '''4''' = Start Index
:* Parameter '''5''' = Index increment
:* Parameter '''6''' = Number of steps
* (optional) Key '''"DimSelect_EquiDist_Date" :''' Equidistant selection of times.
* (optional) Key '''"DimSelect_StartEnd_Index" :''' Selection of all indices from start to end index.
* (optional) Key '''"DimSelect_StartEnd_Date" :''' Selection of all times from start to end date.
* (optional) Key '''"DimSelect_Single_Index" :''' Selection of a specific index.
* (optional) Key '''"DimSelect_Single_Date" :''' Selection of a specific date.
* (optional) Key '''"DimSelect_Various_Index" :''' List of various indices.
* (optional) Key '''"DimSelect_Various_Date" :''' List of various dates.
* (optional) Key '''"DimSelect_All" :''' Selection of all indices of a dimension.
* (optional) Key '''"DimSelect_ByLabel_LabVar" :''' Determine indices with list of names by label variable.
* (optional) Key '''"DimSelect_ByLabel_List" :''' Continuation line to Key '''''DimSelect_ByLabel_LabVar'''''.
* (optional) Key '''"DimSelect_Location_Coord" :''' Selection of locations by coordinates.
* (optional) Key '''"DimSelect_LocByFile_File" :''' Selection of locations from file with locations.
* (optional) Key '''"DimSelect_LocByFile_List" :''' Continuation line to Key '''''DimSelect_LocByFile_File'''''.
* (optional) Key '''"Dimensions_for_Picture_Series" :''' Requesting seperate presentations for selected dimensions.
:Hint: Causes series of pictures, i.e. for each selected index of the dimensions listed here a separate picture is created. Only works with line charts. Picture series must be the same length!

===Block "Layer"===
A block of type Layer defines a area diagram.
The illustration in the horizontal plane (the map view) differs fundamentally
from the area charts with axes. 
Control file can contain multiple blocks of this type.
* Key '''"Name" :''' unique name of this layer and the possibility of assigning a different plot level to the diagram.
* Key '''"Layer_Dataset_Name" :''' name of the dataset to be displayed. Or a valid connexion (OPERATOR string) made out of known data sets, e. g. '''[DSet2-DSet1]/[DSet1+DSet2]''', '''ABS[DSet]''', '''SQR[DSet]''' or '''G18[DSet]'''.
* Key '''"Layer_Type" :''' type of data view of this layer.
:*'''XY_data''' = Map, or top view illustration (horizontal plane)
:*'''PZ''' = Vertical section along profile (3D data)
:*'''TZ''' = Time depth diagram (3D data)
:*'''PT''' = Hovmöller diagram variant 1: X-axis=time axis (T), Y-axis=profile axis (P).
:*'''TP''' = Hovmöller diagram variant 2: X-axis=profile axis (P), Y-axis=time axis (T).
* Key '''"Layer_Primitive_Name" :''' graphic primitive to visualize the data in the layer.
:* Parameter '''1''' = Symbolization of the layer
::*'''GPM''' = as poly marker
::*'''GPL''' = as poly line (only Layer_Type ''XY_data'')
::*'''GFA''' = as fill area
::*'''GTX''' = as text
::*'''VEC''' = as vector (only Layer_Type ''XY_data'')
:* (optional) Parameter '''2''' = Type of the vector ... optional parameter, only at VEC visualization permitted. ...allows, for example, the interpolation of the total vector from the normal component a vectorial quantity.
::*'''total''' = total vector
::*'''normal''' = normal vector
* Key '''"Layer_Primitive_Representation_Name" :''' name of the representation of the primitive.
* Key '''"Layer_Bounds_Name" :''' name of the interval definition for this layer (from the file '''''[[BOUNDS.CFG.DAT|bounds.cfg.dat]]''''').
:Hint: The number of intervals in the interval definition and the number of colors of the associated color legend must match.
* Key '''"Layer_Palette_Name" :''' name of the color legend for this layer (corresponds to the attribute ''Name'' in the file ''palette.dat''. More detailed information about palettes on file description page '''''[[PALETTES.CFG.DAT|palettes.cfg.dat]]''''').
* Key '''"Layer_Invert_Palette" :''' invertation of the color ramp.
* (optional) Key '''"Layer_Normalization_Transformation_Name" :''' name of the normalization transformation for this layer.
:Hint: Required for diagram definition map view (Layer_Type ''XY_data'').
* (optional) Key '''"Layer_Area" :''' Image area spanned by the diagram axes.
:Hint: Required for definitions of diagrams working with axes.
* (optional) Key '''"Layer_Extent" :''' Total area that the diagram in the picture takes up.
:Hint: Required for definitions of diagrams working with axes.
* (optional) Key '''"Layer_X-Axis" :''' X-axis of the diagram and its positioning.
:Hint: Required for definitions of diagrams working with axes.
* (optional) Key '''"Layer_Y-Axis" :''' Y-axis of the diagram and its positioning.
:Hint: Required for definitions of diagrams working with axes.
* (optional) Key '''"Layer_Legend_Plot_Area" :''' image area for the color legend of this layer. Depending on the space, the color legend can be applied horizontally or vertically.
* (optional) Key '''"Layer_Legend_Label_Switch" :''' Switch list for switching off or positioning labels of the color legend.
* (optional) Key '''"Layer_Data_Description_Name" :''' name of the '''''Data_Description''''' text box, which should collects up the data description (e.g. indication of the time) of this layer.
* (optional) Key '''"Layer_Display_Units" :''' physical unit in which the data should be converted for the graphical presentation.
:Hints: The original unit of the data and the target unit must be known in the configuration file '''''phydef.cfg.si.dat'''''. In addition, the SI-base (dimension) of the units must be identical.
* (optional) Key '''"Layer_Display_Name" :''' name of physical quantity, will be used instead of the original name given in the input data set. Without this line the name in PHYDEF is used, if the variable owns the attribute '''''name_id'''''.. Dynamic text parts can be realized with special placeholders:
:*<LAY_DSET> will be replaced by the name of the dataset associated with the layer.
:*<LAY_DIM1> will be replaced by the info text for the 1st dimension of the displayed data set.
:*<LAY_DIM2> will be replaced by the info text for the 2nd dimension of the displayed data set.
:*<LAY_DIM?> etc. to the number of data set dimensions.
* (optional) Key '''"Layer_Vector_Legend_Plot_Area" :''' image area for the vector legend in case of arrows with length_type proportional.
* (optional) Key '''"Layer_Vector_Thinout_Raster" :''' dimensions of the grid used to thin out the display of vector arrows.
* (optional) Key '''"Layer_NOBS_Filter" :''' filter for displayed data based on ''ancillary variable'' with type ''number of observations'':
** parameter 1: filter type:
*** '''EQ''' = display data only for a fixed number of observations;
*** '''LE''' = display data for a certain number of observations or less;
*** '''LE''' = display data for a certain number of observations or more.
** parameter 2: filter value:
*** '''0''' = maximum number of observations;
*** '''N''' = specified number of observations;
*** '''-M''' = maximum number of observations minus M.
* (optional) Key '''"Layer_Description_Textbox" :''' name of a textbox to be linked with the layer.
* (optional) Key '''"Layer_Route_Dataset" :''' name of a '''''dataset''''' with profile route for sorting and filtering data to be displayed.

===Block "Normalization_Transformation (NTN)"===
Definition of an image section and description of the link between the world and image
coordinates. 
A block of this type is only required for areal representation in the horizontal plane
(layer definition with Type == XY_Data). 
The coordinates of the drawing area, the so-called NDC space, range from [0.0,0.0] to [1.0,1.0].
For an undistorted view of the area the representation scale in the X direction must match
the scale in Y-direction (DWC / DNDC = const);
optionally also key '''"Autoscale"''' can be used for this purpose.
Distorted representations are also possible. 
* Key '''"Name" :''' unique name of this normalization transformation.
* Key '''"EPSG" :''' EPSG code of the data coordinates in the file.
* Key '''"EPSG_Window" :''' EPSG code of the plot projection.
* Key '''"Left_Lower_Window_Coordinates" :''' world coordinates (according to EPSG) the lower left corner of the projection window.
* Key '''"Right_Upper_Window_Coordinates" :''' world coordinates (according to EPSG) the upper right corner of the projection window.
* Key '''"Left_Lower_NDC_Coordinates" :''' picture coordinates (NDC within [0.0,1.0]) the lower left corner of the projection window.
* Key '''"Right_Upper_NDC_Coordinates" :''' picture coordinates (NDC within [0.0,1.0]) the upper right corner of the projection window.
* (optional) Key '''"Autoscale" :''' automatic adjustment (.true.) of scales in X- and Y-direction. Default is .false. (no adjustment).
* (optional) Key '''"Scale_Bar_Request"''' : Request drawing a scale bar. Autoscale needs to be on.
* (optional) Key '''"NTN_Framing" :''' Type of the coordinate frame when displayed as map.
:Hint: More info at '''''[[NCPLOT: Framing|Options of map frames]]'''''.

===Block "Data_Description"===
The block '''Data_Description''' defines a Data_Description object.
Such an object collects data descriptions and displays them together in a text field. 
A block of this type is currently only needed for area charts in the horizontal plane (Layer definition with Type == XY_Data). 
Control file can contain multiple blocks of this type.
* Key '''"Data_Desc_Name" :''' unique name of the text field for data descriptions.
* Key '''"Data_Desc_Plot_Area" :''' image area for the Data_Description text box.
* (optional) Key '''"Data_Desc_Draw_Frame" :''' draw a frame around the Data Description text box TRUE/FALSE.
* (optional) Key '''"Data_Desc_Color_Name" :''' name of the color for text and frame.

===Block "LineChart"===
The block '''LineChart''' is used to define a line diagram. 
A "LineChart" has only one X- and one Y-axis.
A secondary Y-axis must be realized by defining a second "LineChart" object
on the same drawing area and with the same X-axis. 
Any number of LineCharts can be stacked. The associated axes can be positioned
on all four sides of the diagram and can also be moved away from the drawing
area by different distances.
Thus, for example, on the sheet "one" time series diagram with three Y-axes
can be generated that represents the curves for flow amount, flow direction
and salinity together. 
Control file can contain multiple blocks of this type.
* Key '''"LineChart_Name" :''' unique name of the line chart and the possibility of assigning a different plot level to the diagram.
* Key '''"LineChart_Type" :''' type of line chart.
:*'''TG''' = Time series; Data over time
:*'''PG''' = Profile chart; Data over profile axis
:*'''GZ''' = Depth profile; 3D data along depth axis
* Key '''"LineChart_Area" :''' image area spanned by the diagram axes.
* Key '''"LineChart_Extent" :''' total area occupied by the diagram on the image.
* Key '''"LineChart_X-Axis" :''' X-axis of the diagram and its positioning.
* Key '''"LineChart_Y-Axis" :''' Y-axis of the diagram and its positioning.
* (optional) Key '''"LineChart_Legend_Box" :''' name of a '''''Legend_Box''''', the object/area in which the curve legends of the diagram are stored and presented.
* (optional) Key '''"LineChart_Route_Dataset" :''' * (optional) Key '''"LineChart_PLR_Representation" :''' line Symbolization for the data curves of this diagram.
* (optional) Key '''"LineChart_PMR_Representation" :''' marker Symbolization for the data curves of this diagram.
* (optional) Key '''"LineChart_PLR_Palette" :''' color palette and start color for line symbols of this line chart.
* (optional) Key '''"LineChart_PMR_Palette" :''' color palette and start color for marker symbols of this line chart.

===Block "Axis"===
The block '''Axis''' is used to define a diagram axis. 
An axis definition can be used for varius diagrams.
For example superposed "LineCharts" or several diagrams arranged
one below the other with the same time axis. 
Control file can contain multiple blocks of this type.
* Key '''"Axis_Name" :''' unique name of the axis definition.
* Key '''"Axis_Type" :''' type of axis.
:*'''T''' = time axis
:*'''G''' = axis for physical quantities
:*'''P''' = profile axis
:*'''Z''' = depth axis
* (optional) Key '''"Axis_Value_Range" :''' value range of the axis.
* (optional) Key '''"Axis_Date_Range" :''' time range of the axis.
* (optional) Key '''"Axis_Scale_Logarithmic" :''' switch logarithmic scaling LOG10 on TRUE/FALSE.
* (optional) Key '''"Axis_Invert_Profile_Route" :''' switch invert the route of a profile axis TRUE/FALSE.
* (optional) Key '''"Axis_Scale_Multiplicator" :''' multiplication factor for axis scaling.
* (optional) Key '''"Axis_Display_Name" :''' axis title, will be used instead of the original name given in the input data.
* (optional) Key '''"Axis_Display_Unit" :''' physical unit in which the data should be converted for the graphical presentation.
:Hints: The original unit of the data and the target unit must be known in the configuration file '''''phydef.cfg.si.dat'''''. In addition, the SI-base (dimension) of the units must be identical.
* (optional) Key '''"Axis_Labels_EquiDist_Value" :''' equidistant values for labeling along the axis.
* (optional) Key '''"Axis_Labels_EquiDist_Date" :''' equidistant dates for labeling along the axis.
* (optional) Key '''"Axis_Labels_at_Values" :''' list of values for labeling along the axis.
* (optional) Key '''"Axis_Labels_at_Dates" :''' list of dates for labeling along the axis.
* (optional) Key '''"Axis_Line_Representation" :''' name of a ''Poly_Line_Representation'' for the representation of the axis line.
* (optional) Key '''"Axis_Text_Representation" :''' name of a ''Text_Representation'' for the axis labeling (only influencing the font color).
* (optional) Key '''"Gitternetz_Representation" :''' name of a ''Poly_Line_Representation'' for the gridlines or switch off these lines with NONE.
* (optional) Key '''"Tickmark_Representation" :''' formatting or switching off axis tickmarks.
:* Parameter '''1''' = name of a color for the tickmarks
:* Parameter '''2''' = width of the tickmark line
:* Parameter '''3''' = length of tickmarks in image coordinates; 0.0 turn it off!
* (optional) Key '''"Axis_Additional_Line_Value" :''' draw an additional line vertical to the axis at a certain value.
* (optional) Key '''"Axis_Additional_Line_Date" :''' draw an additional line vertical to the time axis at a certain date.
* (optional) Key '''"Axis_Additional_Line_Coord" :''' draw an additional line vertical to the profile axis at a certain location.
* (optional) Key '''"Characters_along_Axis" :''' allows the manipulation of the font size of the axis labeling.
* (optional) Key '''"Axis_Number_Format" :''' Format specification for numerical values of the axis scaling.

===Block "DataRow"===
The block '''DataRow''' is used to describe a data series, or a group
of data series. 
Due to the data addressing in the ''DataSet'', a ''DataRow'' description can
result in several data series.
All these data series end up in the same line diagramm. 
Blocks of this type are needed for line charts. 
Control file can contain multiple blocks of this type.
* Key '''"DataRow_Name" :''' unique name of the data row description.
* Key '''"DataRow_Dataset" :''' name of the dataset to be displayed. Or a valid connexion (OPERATOR string) made out of known data sets, e. g. '''[DSet2-DSet1]/[DSet1+DSet2]''', '''ABS[DSet]''', '''SQR[DSet]''' or '''G18[DSet]'''.
* Key '''"DataRow_LineChart" :''' name of the ''LineChart'', i.e. of the line diagram in which the data series are to be drawn.
* (optional) Key '''"DataRow_PLR_Representation" :''' line symbolization for the data curves of this data series.
* (optional) Key '''"DataRow_PMR_Representation" :''' marker symbolization for the data curves of this data series.
* (optional) Key '''"DataRow_PLR_Palette" :''' color palette and start color for line symbols of this data series.
* (optional) Key '''"DataRow_PMR_Palette" :''' color palette and start color for marker symbols of this data series.
* (optional) Key '''"DataRow_NoValue_Handling" :''' Handling invalid values in the data series.
:*'''Luecke''' = Points without data are not displayed
* (optional) Key '''"DataRow_NOBS_Filter" :''' filter for displayed data based on ''ancillary variable'' with type ''number of observations'':
** parameter 1: filter type:
*** '''EQ''' = display data only for a fixed number of observations;
*** '''LE''' = display data for a certain number of observations or less;
*** '''LE''' = display data for a certain number of observations or more.
** parameter 2: filter value:
*** '''0''' = maximum number of observations;
*** '''N''' = specified number of observations;
*** '''-M''' = maximum number of observations minus M.

===Block "Legend_Box"===
A legend box collects names and symbolizations of data curves and
displays them together in a text field.
A legend field can accommodate curve descriptions from different diagrams. 
A block of this type is only needed by line charts. 
Control file can contain multiple blocks of this type.
* Key '''"Legend_Box_Name" :''' unique name of the legend field.
* Key '''"Legend_Box_Plot_Area" :''' image area for the legend field.
* (optional) Key '''"Legend_Box_Draw_Frame" :''' draw a frame around the legend field TRUE/FALSE.
* (optional) Key '''"Legend_Box_Color_Name" :''' name of the color for text and frame.

===Block "Textbox"===
Description of one free text field. 
An empty text box can act as rectangular frame, with the color, type and width of the line
being adjustable. If you give the text box a background color, you can use it to cover
a particular area of the diagram. 
Control file can contain multiple blocks of this type.
* Key '''"Name" :''' unique name of the text box.
* Key '''"Plot_Area" :''' image area for the text box.
* (optional) Key '''"Text_Line" :''' one line of the text box. Specification of several lines possible. Placeholder for system information:
:*<SYS_DATE> will be replaced by current date.
:*<SYS_TIME> will be replaced by current time.
:*<SYS_USER> will be replaced by User ID.
:Placeholder for text box, which is connected to a Layer:
:*<LAY_DSET> will be replaced by the name of the dataset associated with the layer.
:*<LAY_DIM1> will be replaced by the info text for the 1st dimension of the displayed data set.
:*<LAY_DIM2> will be replaced by the info text for the 2nd dimension of the displayed data set.
:*<LAY_DIM?> etc. to the number of data set dimensions.
:Hint: Linking is realized in the layer block via KEY ''Layer_Description_Textbox''.
* (optional) Key '''"Color_Name" :''' colors of the textbox.
** parameter 1: for text and frame
** (optional) parameter 2: for background
* (optional) Key '''"Draw_Frame" :''' draw a frame around the text box TRUE/FALSE.
* (optional) Key '''"Frame_Style" :''' appearance of the text box frame.
** parameter 1: line width
** (optional) parameter 2: line type
* (optional) Key '''"Fixed_Width" :''' character-wise writing with constant width or not.
* (optional) Key '''"Horizontal_Char_Space" :''' Horizontal character distance factor for character-wise writing.
* (optional) Key '''"Vertical_Line_Space" :''' Vertical line spacing factor.
* (optional) Key '''"Font_Size" :''' Font size can be specified possibly.
* (optional) Key '''"Font_Size_Factor" :''' Factor for manipulating the calculated font size.

===Block "Poly_Marker_Representation"===
Description of one type of marker symbols. 
Control file can contain multiple blocks of this type.

===Block "Fill_Area_Representation"===
Description of one type of fill area symbolization. 
Control file can contain multiple blocks of this type.

===Block "Poly_Line_Representation"===
Description of one type of line symbolization. 
Control file can contain multiple blocks of this type.

===Block "Text_Representation"===
Description of one type of text symbolization. 
Control file can contain multiple blocks of this type.

===Block "Vector_Representation"===
Description of one type of vector symbolization. 
Control file can contain multiple blocks of this type. 
Hint: More info at '''''[[NCPLOT: Types of vector symbols]]'''''.

===General Remarks===
# While reading this steering data file the '''dictionary file''' '''''ncplot_dico.dat''''' will be automatically accessed in directory '''''$PROGHOME/dic/''''' to support input.
# If no such file exists in the working directory, NCPLOT accesses the following configuration files from the directory '''''$PROGHOME/cfg/''''':
#* '''''colors.cfg.dat''''': File with definitions of colors.
#* '''''palettes.cfg.dat''''': File with references to files with color palette definitions.
#* '''''bounds.cfg.dat''''': File with interval definitions for legends. Hint: The bounds file should be better stored within a project in the working directory.
# The following '''standard configuration files''' from the directory '''''$PROGHOME/cfg/''''' are required:
#* '''gkssystem.rechnername.dat''': GKS parameter file.
#* '''phydef.cfg.si.dat''': Configuration file for units and their relation to the SI system.

|nutzerprogramme=[[NCPLOT]]
|language=Fortran90
|fileform=FORMATTED
|fileaccess=SEQUENTIAL
|fileextension=.dat
|writemodules= ---
|readmodules=$PROGHOME/fortran/prg/ncplot/*/mod_m_ncplot_steer.f90
|contact_original=[mailto:guenther.lang@baw.de G. Lang], [mailto:susanne.spohr@baw.de S. Spohr]
|contact_maintenance=[mailto:guenther.lang@baw.de G. Lang], [mailto:susanne.spohr@baw.de S. Spohr]
|examplefile=$PROGHOME/examples/ncplot/ncplot.dat
}}

NCPLOT: Area Charts

2020-04-30T14:42:09Z

Ak3spohr: + area diagrams with axes PZ,TZ,PT

__NOAUTOLINKS__
__NOAUTOLINKTARGET__
[[de:NCPLOT: Flächenhafte Diagramme]]
__TOC__
 

=General=

The visualisation of a data set as an area diagram is described in a so-called ''Layer''.
The assignment of colors to values of a data set and the form of representation
of the underlying geometry are set in one layer block of the steering file.
Different layers can be plotted lying upon each other.
 

The map view (horizontal plane) differs fundamentaly from the illustration using
area charts with axes.
Instead of specifying the image area and axes definitions, the relationship
between world and image coordinates is described using a so-called
''Normalization_Transformation''.
 

Color legends used by a layer can be displayed on the scene and can be arranged
horizontally or vertically.
Another layer dependent, optional image element is a text field
for the data label (e.g. Indication of the time).
 

Also simple data operations can be executed (addition, subtraction,
multiplication, division, absolute value, square root).
 

=Types of area charts=

==Map, or top view illustration==
Scaled maps, or top view representation of simulation or analysis results.
[[File:NcplotBspFaceArea.png|thumb|250px|Picture 1: Salinity with underlaid topography.]]

===Options of presentation===
The data are presented by the program at their original positions (node, edge, face).
A horizontal interpolation of the data is also possible.
In addition to the fill area symbolization the data can be visualized by
line symbolization by marker symbols or text.
For edge and polygon data, there are also the possibilities of point-symbolization.
In this case the marker or the text is positioned at the middle of the edge or at the
polygon center.
The edges of polygons can be also visualized by lines symbolization.

The sample pictures illustrate the capability of the program [[NCPLOT]]. 
[[NCPLOT: Example Figures Area Chart Map View|Example Figures: Map View]]

===Coordinate frame===
Each map can be framed.
The type of frame can be a simple black edging or a complex frame with coordinates.
The offered coordinate frames are optimized for values belonging to Gauss Krüger
or to universal transverse mercator (UTM) projections.
Different maps can be arranged in one picture.

===Vector representation===
If the X- and the Y-component of a vector quantity exists, the visualization of
the entire vector is possible.
Normal components of a vector quantity saved on edges can be visualized as a
normal vector of the edge or as an interpolated total vector. 
The thin out of the display of vector arrows is possible.

[[File:NcplotBspAcPzElbeLP.png|thumb|250px|Picture 2: Vertical section (3D data).]]
[[File:NcplotBspAcTzBrunCU.png|thumb|250px|Picture 3: Time depth diagram (3D data).]]
[[File:NcplotBspAcPtElbeHov.png|thumb|250px|Picture 4: Hovmöller diagram.]]
 

==Vertical section==
Representation of depth dependent, scalar simulation or analysis results
along a profile axis (Picture 2).
 

==Time depth diagram==
Representation of the temporal development of depth-dependent, scalar simulation or
analysis results at a specific location (Picture 3).
 

==Hovmöller diagram==
Representation of the temporal development of scalar simulation or
analysis results over a profile or locations axis (Picture 4).
 

----
back to [[NCPLOT]]

NCPLOT.DAT

2020-04-30T13:11:00Z

Ak3spohr: + area charts PZ,TZ,PT)

{{FileDescription
|name_de=NCPLOT.DAT
|filetype=ncplot.dat
|version=April 2020
|version_descr=April 2020
|significance=contains general steering data for the program [[NCPLOT]].
|filecontents=

===Block "Program_Parameters"===
The block '''Program_Parameters''' contains general steering data.
* Key '''"Language" :''' Language preference for labels and texts:
:*'''DE''' = German,
:*'''EN''' = English.
* Key '''"Max_Read_Storage" :''' max. read only memory (in bytes) for analysis
* Key '''"Min_Water_Depth" :''' minimum water coverage in [m].
:Hint: The excluding of data from the presentation in case of low water coverage is only possible, if the variable to be displayed points in a certain way to a variable associated with the total water depth. The CF-NetCDF output of UnTRIM programs fulfills this requirement. The page '''''[[NCPLOT: Min_Water_Depth]]''''' illustrates the effect of this control parameter.
* (optional) Key '''"Infobox_Plot_Area" :''' Image area for the metadata infobox.
:If this image area is specified, information about the plot creation will be given to the graphic. This includes information about the underlying data files as well as if neccessary information about used data filtering.
* (optional) Key '''"PLR_Representation" :''' Default setting for line symbols of data curves in line charts.
* (optional) Key '''"PMR_Representation" :''' Default setting for marker symbols of data curves in line charts.
* (optional) Key '''"PLR_Palette" :''' Color palette and start color for line symbols of data curves in line charts.
* (optional) Key '''"PMR_Palette" :''' Color palette and start color for marker symbols of data curves in line charts.
* (optional) Key '''"Picture_Name_Fixum" :''' fixed name part for CGM output file.
* (optional) Key '''"Phydef_Units" :''' Display physical units as in PHYDEF administration.
:Hint: Without explicit request, the units are displayed according to the BAW Rules.

===Block "Dataset"===
Description of a data set to be displayed. 
 
For addressing the data to be displayed, either the Start-Step-Stride technique
or the DimSelect method is available. The user has to choose one way or the other,
the procedures exclude each other. Each Start-Step-Stride-Addressing can be copied
by DimSelect, the other way round that is not the case.
DimSelect offers additional options for data selection, with the method
you can also realize non-equidistant index selection.
;Start-Step-Stride technique:
:For each dimension of the variable a start, step and stride value must be specified. The page '''''[[NCPLOT: Define DataSet]]''''' gives instructions for addressing the desired data.
;DimSelect method:
:DimSelect also requires the addressing of the indices for each dimension of the data variables to be displayed. But this can also happen indirectly. Various suitable selection methods are provided. The user can, for example, choose all faces by '''''DimSelect_All''''' without knowing the specific number, or pass the program via '''''DimSelect_Various_Date''''' a selection of times to be displayed. It is the responsibility of the program to find the corresponding indices. Related to data curves of line charts the DimSelect method offers a further advantage: For the individual dimensions this mimic allows to create text components for the names of the data series shown in the curve legend. 
Control file can contain multiple blocks of this type.
* Key '''"Name" :''' unique name of this data set.
* Key '''"File" :''' name of the CF-NetCDF file (*.nc) with the data to be displayed.
* Key '''"Variable" :''' Description of the data whose values are to be displayed.
:* Parameter '''1''' = name of the variable (in file of type *.nc)
:* (optional) Parameter '''2''' = role of the variable as part of a vector
::* X-component = Variable is the X component of a vector
::* Y-component = Variable is the Y component of a vector
::* normal_component = Variable is the normal component of a vector
:Hint: The command "ncdump -h <filename>.nc" shows the header of the CF-NetCDF file. The names of the offered variables and their dimensions can be found in the metadata.
* (optional) Key '''"Start" :''' start address for the data to be displayed.
* (optional) Key '''"Step" :''' number of steps for the data to be displayed.
* (optional) Key '''"Stride" :''' increment for the data to be displayed.
* (optional) Key '''"DimSelect_EquiDist_Index" :''' Equidistant selection of indices for a given dimension. Exemplary:
:* Parameter '''1''' = Name of the dimension
:* Parameter '''2''' = NONE or text component for curve legend
:* Parameter '''3''' = Index becomes part of the curve legend .true./.false.
:* Parameter '''4''' = Start Index
:* Parameter '''5''' = Index increment
:* Parameter '''6''' = Number of steps
* (optional) Key '''"DimSelect_EquiDist_Date" :''' Equidistant selection of times.
* (optional) Key '''"DimSelect_StartEnd_Index" :''' Selection of all indices from start to end index.
* (optional) Key '''"DimSelect_StartEnd_Date" :''' Selection of all times from start to end date.
* (optional) Key '''"DimSelect_Single_Index" :''' Selection of a specific index.
* (optional) Key '''"DimSelect_Single_Date" :''' Selection of a specific date.
* (optional) Key '''"DimSelect_Various_Index" :''' List of various indices.
* (optional) Key '''"DimSelect_Various_Date" :''' List of various dates.
* (optional) Key '''"DimSelect_All" :''' Selection of all indices of a dimension.
* (optional) Key '''"DimSelect_ByLabel_LabVar" :''' Determine indices with list of names by label variable.
* (optional) Key '''"DimSelect_ByLabel_List" :''' Continuation line to Key '''''DimSelect_ByLabel_LabVar'''''.
* (optional) Key '''"DimSelect_Location_Coord" :''' Selection of locations by coordinates.
* (optional) Key '''"DimSelect_LocByFile_File" :''' Selection of locations from file with locations.
* (optional) Key '''"DimSelect_LocByFile_List" :''' Continuation line to Key '''''DimSelect_LocByFile_File'''''.
* (optional) Key '''"Dimensions_for_Picture_Series" :''' Requesting seperate presentations for selected dimensions.
:Hint: Causes series of pictures, i.e. for each selected index of the dimensions listed here a separate picture is created. Only works with line charts. Picture series must be the same length!

===Block "Layer"===
A block of type Layer defines a area diagram.
The illustration in the horizontal plane (the map view) differs fundamentally
from the area charts with axes. 
Control file can contain multiple blocks of this type.
* Key '''"Name" :''' unique name of this layer.
* Key '''"Layer_Dataset_Name" :''' name of the dataset to be displayed. Or a valid connexion (OPERATOR string) made out of known data sets, e. g. '''[DSet2-DSet1]/[DSet1+DSet2]''', '''ABS[DSet]''', '''SQR[DSet]''' or '''G18[DSet]'''.
* Key '''"Layer_Type" :''' type of data view of this layer.
:*'''XY_data''' = Map, or top view illustration (horizontal plane)
:*'''PZ''' = Vertical section along profile (3D data)
:*'''TZ''' = Time depth diagram (3D data)
:*'''PT''' = Hovmöller diagram: Temporal development along profile.
* Key '''"Layer_Primitive_Name" :''' graphic primitive to visualize the data in the layer.
:* Parameter '''1''' = Symbolization of the layer
::*'''GPM''' = as poly marker
::*'''GPL''' = as poly line (only Layer_Type ''XY_data'')
::*'''GFA''' = as fill area
::*'''GTX''' = as text (only Layer_Type ''XY_data'')
::*'''VEC''' = as vector (only Layer_Type ''XY_data'')
:* (optional) Parameter '''2''' = Type of the vector ... optional parameter, only at VEC visualization permitted. ...allows, for example, the interpolation of the total vector from the normal component a vectorial quantity.
::*'''total''' = total vector
::*'''normal''' = normal vector
* Key '''"Layer_Primitive_Representation_Name" :''' name of the representation of the primitive.
* Key '''"Layer_Bounds_Name" :''' name of the interval definition for this layer (from the file '''''[[BOUNDS.CFG.DAT|bounds.cfg.dat]]''''').
:Hint: The number of intervals in the interval definition and the number of colors of the associated color legend must match.
* Key '''"Layer_Palette_Name" :''' name of the color legend for this layer (corresponds to the attribute ''Name'' in the file ''palette.dat''. More detailed information about palettes on file description page '''''[[PALETTES.CFG.DAT|palettes.cfg.dat]]''''').
* Key '''"Layer_Invert_Palette" :''' invertation of the color ramp.
* (optional) Key '''"Layer_Normalization_Transformation_Name" :''' name of the normalization transformation for this layer.
:Hint: Required for diagram definition map view (Layer_Type ''XY_data'').
* (optional) Key '''"Layer_Area" :''' Image area spanned by the diagram axes.
:Hint: Required for definitions of diagrams working with axes.
* (optional) Key '''"Layer_Extent" :''' Total area that the diagram in the picture takes up.
:Hint: Required for definitions of diagrams working with axes.
* (optional) Key '''"Layer_X-Axis" :''' X-axis of the diagram and its positioning.
:Hint: Required for definitions of diagrams working with axes.
* (optional) Key '''"Layer_Y-Axis" :''' Y-axis of the diagram and its positioning.
:Hint: Required for definitions of diagrams working with axes.
* (optional) Key '''"Layer_Legend_Plot_Area" :''' image area for the color legend of this layer. Depending on the space, the color legend can be applied horizontally or vertically.
* (optional) Key '''"Layer_Legend_Label_Switch" :''' Switch list for switching off or positioning labels of the color legend.
* (optional) Key '''"Layer_Data_Description_Name" :''' name of the '''''Data_Description''''' text box, which should collects up the data description (e.g. indication of the time) of this layer.
* (optional) Key '''"Layer_Display_Units" :''' physical unit in which the data should be converted for the graphical presentation.
:Hints: The original unit of the data and the target unit must be known in the configuration file '''''phydef.cfg.si.dat'''''. In addition, the SI-base (dimension) of the units must be identical.
* (optional) Key '''"Layer_Display_Name" :''' name of physical quantity, will be used instead of the original name given in the input data set. Without this line the name in PHYDEF is used, if the variable owns the attribute '''''name_id'''''.. Dynamic text parts can be realized with special placeholders:
:*<LAY_DSET> will be replaced by the name of the dataset associated with the layer.
:*<LAY_DIM1> will be replaced by the info text for the 1st dimension of the displayed data set.
:*<LAY_DIM2> will be replaced by the info text for the 2nd dimension of the displayed data set.
:*<LAY_DIM?> etc. to the number of data set dimensions.
* (optional) Key '''"Layer_Vector_Legend_Plot_Area" :''' image area for the vector legend in case of arrows with length_type proportional.
* (optional) Key '''"Layer_Vector_Thinout_Raster" :''' dimensions of the grid used to thin out the display of vector arrows.
* (optional) Key '''"Layer_NOBS_Filter" :''' filter for displayed data based on ''ancillary variable'' with type ''number of observations'':
** parameter 1: filter type:
*** '''EQ''' = display data only for a fixed number of observations;
*** '''LE''' = display data for a certain number of observations or less;
*** '''LE''' = display data for a certain number of observations or more.
** parameter 2: filter value:
*** '''0''' = maximum number of observations;
*** '''N''' = specified number of observations;
*** '''-M''' = maximum number of observations minus M.
* (optional) Key '''"Layer_Description_Textbox" :''' name of a textbox to be linked with the layer.

===Block "Normalization_Transformation (NTN)"===
Definition of an image section and description of the link between the world and image
coordinates. 
A block of this type is only required for areal representation in the horizontal plane
(layer definition with Type == XY_Data). 
The coordinates of the drawing area, the so-called NDC space, range from [0.0,0.0] to [1.0,1.0].
For an undistorted view of the area the representation scale in the X direction must match
the scale in Y-direction (DWC / DNDC = const);
optionally also key '''"Autoscale"''' can be used for this purpose.
Distorted representations are also possible. 
* Key '''"Name" :''' unique name of this normalization transformation.
* Key '''"EPSG" :''' EPSG code of the data coordinates in the file.
* Key '''"EPSG_Window" :''' EPSG code of the plot projection.
* Key '''"Left_Lower_Window_Coordinates" :''' world coordinates (according to EPSG) the lower left corner of the projection window.
* Key '''"Right_Upper_Window_Coordinates" :''' world coordinates (according to EPSG) the upper right corner of the projection window.
* Key '''"Left_Lower_NDC_Coordinates" :''' picture coordinates (NDC within [0.0,1.0]) the lower left corner of the projection window.
* Key '''"Right_Upper_NDC_Coordinates" :''' picture coordinates (NDC within [0.0,1.0]) the upper right corner of the projection window.
* (optional) Key '''"Autoscale" :''' automatic adjustment (.true.) of scales in X- and Y-direction. Default is .false. (no adjustment).
* (optional) Key '''"Scale_Bar_Request"''' : Request drawing a scale bar. Autoscale needs to be on.
* (optional) Key '''"NTN_Framing" :''' Type of the coordinate frame when displayed as map.
:Hint: More info at '''''[[NCPLOT: Framing|Options of map frames]]'''''.

===Block "Data_Description"===
The block '''Data_Description''' defines a Data_Description object.
Such an object collects data descriptions and displays them together in a text field. 
A block of this type is currently only needed for area charts in the horizontal plane (Layer definition with Type == XY_Data). 
Control file can contain multiple blocks of this type.
* Key '''"Data_Desc_Name" :''' unique name of the text field for data descriptions.
* Key '''"Data_Desc_Plot_Area" :''' image area for the Data_Description text box.
* (optional) Key '''"Data_Desc_Draw_Frame" :''' draw a frame around the Data Description text box TRUE/FALSE.
* (optional) Key '''"Data_Desc_Color_Name" :''' name of the color for text and frame.

===Block "LineChart"===
The block '''LineChart''' is used to define a line diagram. 
A "LineChart" has only one X- and one Y-axis.
A secondary Y-axis must be realized by defining a second "LineChart" object
on the same drawing area and with the same X-axis. 
Any number of LineCharts can be stacked. The associated axes can be positioned
on all four sides of the diagram and can also be moved away from the drawing
area by different distances.
Thus, for example, on the sheet "one" time series diagram with three Y-axes
can be generated that represents the curves for flow amount, flow direction
and salinity together. 
Control file can contain multiple blocks of this type.
* Key '''"LineChart_Name" :''' unique name of the line chart.
* Key '''"LineChart_Type" :''' type of line chart.
:*'''TG''' = Time series; Data over time
:*'''PG''' = Profile chart; Data over profile axis
:*'''GZ''' = Depth profile; 3D data along depth axis
* Key '''"LineChart_Area" :''' image area spanned by the diagram axes.
* Key '''"LineChart_Extent" :''' total area occupied by the diagram on the image.
* Key '''"LineChart_X-Axis" :''' X-axis of the diagram and its positioning.
* Key '''"LineChart_Y-Axis" :''' Y-axis of the diagram and its positioning.
* (optional) Key '''"LineChart_Legend_Box" :''' name of a '''''Legend_Box''''', the object/area in which the curve legends of the diagram are stored and presented.
* (optional) Key '''"LineChart_Route_Dataset" :''' name of a '''''dataset''''' with profile route for sorting and filtering data to be displayed.
* (optional) Key '''"LineChart_PLR_Representation" :''' line Symbolization for the data curves of this diagram.
* (optional) Key '''"LineChart_PMR_Representation" :''' marker Symbolization for the data curves of this diagram.
* (optional) Key '''"LineChart_PLR_Palette" :''' color palette and start color for line symbols of this line chart.
* (optional) Key '''"LineChart_PMR_Palette" :''' color palette and start color for marker symbols of this line chart.

===Block "Axis"===
The block '''Axis''' is used to define a diagram axis. 
An axis definition can be used for varius diagrams.
For example superposed "LineCharts" or several diagrams arranged
one below the other with the same time axis. 
Control file can contain multiple blocks of this type.
* Key '''"Axis_Name" :''' unique name of the axis definition.
* Key '''"Axis_Type" :''' type of axis.
:*'''T''' = time axis
:*'''G''' = axis for physical quantities
:*'''P''' = profile axis
:*'''Z''' = depth axis
* (optional) Key '''"Axis_Value_Range" :''' value range of the axis.
* (optional) Key '''"Axis_Date_Range" :''' time range of the axis.
* (optional) Key '''"Axis_Scale_Logarithmic" :''' switch logarithmic scaling LOG10 on TRUE/FALSE.
* (optional) Key '''"Axis_Invert_Profile_Route" :''' switch invert the route of a profile axis TRUE/FALSE.
* (optional) Key '''"Axis_Scale_Multiplicator" :''' multiplication factor for axis scaling.
* (optional) Key '''"Axis_Display_Name" :''' axis title, will be used instead of the original name given in the input data.
* (optional) Key '''"Axis_Display_Unit" :''' physical unit in which the data should be converted for the graphical presentation.
:Hints: The original unit of the data and the target unit must be known in the configuration file '''''phydef.cfg.si.dat'''''. In addition, the SI-base (dimension) of the units must be identical.
* (optional) Key '''"Axis_Labels_EquiDist_Value" :''' equidistant values for labeling along the axis.
* (optional) Key '''"Axis_Labels_EquiDist_Date" :''' equidistant dates for labeling along the axis.
* (optional) Key '''"Axis_Labels_at_Values" :''' list of values for labeling along the axis.
* (optional) Key '''"Axis_Labels_at_Dates" :''' list of dates for labeling along the axis.
* (optional) Key '''"Axis_Line_Representation" :''' name of a ''Poly_Line_Representation'' for the representation of the axis line.
* (optional) Key '''"Axis_Text_Representation" :''' name of a ''Text_Representation'' for the axis labeling (only influencing the font color).
* (optional) Key '''"Gitternetz_Representation" :''' name of a ''Poly_Line_Representation'' for the gridlines or switch off these lines with NONE.
* (optional) Key '''"Tickmark_Representation" :''' formatting or switching off axis tickmarks.
:* Parameter '''1''' = name of a color for the tickmarks
:* Parameter '''2''' = width of the tickmark line
:* Parameter '''3''' = length of tickmarks in image coordinates; 0.0 turn it off!
* (optional) Key '''"Axis_Additional_Line_Value" :''' draw an additional line vertical to the axis at a certain value.
* (optional) Key '''"Axis_Additional_Line_Date" :''' draw an additional line vertical to the time axis at a certain date.
* (optional) Key '''"Axis_Additional_Line_Coord" :''' draw an additional line vertical to the profile axis at a certain location.
* (optional) Key '''"Characters_along_Axis" :''' allows the manipulation of the font size of the axis labeling.

===Block "DataRow"===
The block '''DataRow''' is used to describe a data series, or a group
of data series. 
Due to the data addressing in the ''DataSet'', a ''DataRow'' description can
result in several data series.
All these data series end up in the same line diagramm. 
Blocks of this type are needed for line charts. 
Control file can contain multiple blocks of this type.
* Key '''"DataRow_Name" :''' unique name of the data row description.
* Key '''"DataRow_Dataset" :''' name of the dataset to be displayed. Or a valid connexion (OPERATOR string) made out of known data sets, e. g. '''[DSet2-DSet1]/[DSet1+DSet2]''', '''ABS[DSet]''', '''SQR[DSet]''' or '''G18[DSet]'''.
* Key '''"DataRow_LineChart" :''' name of the ''LineChart'', i.e. of the line diagram in which the data series are to be drawn.
* (optional) Key '''"DataRow_PLR_Representation" :''' line symbolization for the data curves of this data series.
* (optional) Key '''"DataRow_PMR_Representation" :''' marker symbolization for the data curves of this data series.
* (optional) Key '''"DataRow_PLR_Palette" :''' color palette and start color for line symbols of this data series.
* (optional) Key '''"DataRow_PMR_Palette" :''' color palette and start color for marker symbols of this data series.
* (optional) Key '''"DataRow_NoValue_Handling" :''' Handling invalid values in the data series.
:*'''Luecke''' = Points without data are not displayed
* (optional) Key '''"DataRow_NOBS_Filter" :''' filter for displayed data based on ''ancillary variable'' with type ''number of observations'':
** parameter 1: filter type:
*** '''EQ''' = display data only for a fixed number of observations;
*** '''LE''' = display data for a certain number of observations or less;
*** '''LE''' = display data for a certain number of observations or more.
** parameter 2: filter value:
*** '''0''' = maximum number of observations;
*** '''N''' = specified number of observations;
*** '''-M''' = maximum number of observations minus M.

===Block "Legend_Box"===
A legend box collects names and symbolizations of data curves and
displays them together in a text field.
A legend field can accommodate curve descriptions from different diagrams. 
A block of this type is only needed by line charts. 
Control file can contain multiple blocks of this type.
* Key '''"Legend_Box_Name" :''' unique name of the legend field.
* Key '''"Legend_Box_Plot_Area" :''' image area for the legend field.
* (optional) Key '''"Legend_Box_Draw_Frame" :''' draw a frame around the legend field TRUE/FALSE.
* (optional) Key '''"Legend_Box_Color_Name" :''' name of the color for text and frame.

===Block "Textbox"===
Description of one free text field. 
An empty text box can act as rectangular frame, with the color, type and width of the line
being adjustable. If you give the text box a background color, you can use it to cover
a particular area of the diagram. 
Control file can contain multiple blocks of this type.
* Key '''"Name" :''' unique name of the text box.
* Key '''"Plot_Area" :''' image area for the text box.
* (optional) Key '''"Text_Line" :''' one line of the text box. Specification of several lines possible. Placeholder for system information:
:*<SYS_DATE> will be replaced by current date.
:*<SYS_TIME> will be replaced by current time.
:*<SYS_USER> will be replaced by User ID.
:Placeholder for text box, which is connected to a Layer:
:*<LAY_DSET> will be replaced by the name of the dataset associated with the layer.
:*<LAY_DIM1> will be replaced by the info text for the 1st dimension of the displayed data set.
:*<LAY_DIM2> will be replaced by the info text for the 2nd dimension of the displayed data set.
:*<LAY_DIM?> etc. to the number of data set dimensions.
:Hint: Linking is realized in the layer block via KEY ''Layer_Description_Textbox''.
* (optional) Key '''"Color_Name" :''' colors of the textbox.
** parameter 1: for text and frame
** (optional) parameter 2: for background
* (optional) Key '''"Draw_Frame" :''' draw a frame around the text box TRUE/FALSE.
* (optional) Key '''"Frame_Style" :''' appearance of the text box frame.
** parameter 1: line width
** (optional) parameter 2: line type
* (optional) Key '''"Fixed_Width" :''' character-wise writing with constant width or not.
* (optional) Key '''"Horizontal_Char_Space" :''' Horizontal character distance factor for character-wise writing.
* (optional) Key '''"Vertical_Line_Space" :''' Vertical line spacing factor.
* (optional) Key '''"Font_Size" :''' Font size can be specified possibly.
* (optional) Key '''"Font_Size_Factor" :''' Factor for manipulating the calculated font size.

===Block "Poly_Marker_Representation"===
Description of one type of marker symbols. 
Control file can contain multiple blocks of this type.

===Block "Fill_Area_Representation"===
Description of one type of fill area symbolization. 
Control file can contain multiple blocks of this type.

===Block "Poly_Line_Representation"===
Description of one type of line symbolization. 
Control file can contain multiple blocks of this type.

===Block "Text_Representation"===
Description of one type of text symbolization. 
Control file can contain multiple blocks of this type.

===Block "Vector_Representation"===
Description of one type of vector symbolization. 
Control file can contain multiple blocks of this type. 
Hint: More info at '''''[[NCPLOT: Types of vector symbols]]'''''.

===General Remarks===
# While reading this steering data file the '''dictionary file''' '''''ncplot_dico.dat''''' will be automatically accessed in directory '''''$PROGHOME/dic/''''' to support input.
# If no such file exists in the working directory, NCPLOT accesses the following configuration files from the directory '''''$PROGHOME/cfg/''''':
#* '''''colors.cfg.dat''''': File with definitions of colors.
#* '''''palettes.cfg.dat''''': File with references to files with color palette definitions.
#* '''''bounds.cfg.dat''''': File with interval definitions for legends. Hint: The bounds file should be better stored within a project in the working directory.
# The following '''standard configuration files''' from the directory '''''$PROGHOME/cfg/''''' are required:
#* '''gkssystem.rechnername.dat''': GKS parameter file.
#* '''phydef.cfg.si.dat''': Configuration file for units and their relation to the SI system.

|nutzerprogramme=[[NCPLOT]]
|language=Fortran90
|fileform=FORMATTED
|fileaccess=SEQUENTIAL
|fileextension=.dat
|writemodules= ---
|readmodules=$PROGHOME/fortran/prg/ncplot/*/mod_m_ncplot_steer.f90
|contact_original=[mailto:guenther.lang@baw.de G. Lang], [mailto:susanne.spohr@baw.de S. Spohr]
|contact_maintenance=[mailto:guenther.lang@baw.de G. Lang], [mailto:susanne.spohr@baw.de S. Spohr]
|examplefile=$PROGHOME/examples/ncplot/ncplot.dat
}}

NCPLOT

2020-04-30T12:36:43Z

Ak3spohr: + area Charts PZ,TZ,PT

{{ProgramDescription
|name_de=NCPLOT
|name=NCPLOT
|version=April 2020
|version_descr=April 2020
|catchwords=graphical postprocessor 
graphical presentation of CF NetCDF data (unknown attributes are ignored) 
finite element models 
finite difference models 
orthogonal unstructured grid model 
orthogonal unstructured grid model with subgrid information 
conversion or transformation (extensive - intensive) of physical units 
calculation of new quantities (for display) from one or several input data sets 
(optional) filter based on water depth 
(optional) filter based on number of observations 

Acknowledgment: ''This project took advantage of netCDF software developed by UCAR/Unidata ([http://www.unidata.ucar.edu/software/netcdf/ www.unidata.ucar.edu/software/netcdf/]).''

|shortdescription=
The graphical postprocessor NCPLOT can be used for a graphical presentation
of simulation and analysis results, which is stored in CF NetCDF data format.
The data can be defined on nodes, edges or faces. The program works on 2D-data,
3D-data and on data with details scaled on a subgrid. 
[[File:NcplotBspFaceArea.png|thumb|250px|Picture 1: Salinity with underlaid topography.]]

The sample pictures illustrate the capability of the program NCPLOT. 
[[NCPLOT: Example figures|Example figures: NCPLOT]]

Basically, NCPLOT distinguishes linear from areal chart types.
For area charts the symbolization of the data is depending on the data value
(color legend, proportional arrow).
For linear charts, the values of data series are plotted on an axis.
The symbolization of the data series is independent of the data value.
 

[[NCPLOT: Area Charts|Area Charts]]:
* Map, or top view illustration
* Vertical section along profile (3D data)
* Time depth diagram (3D data)
* Hovmöller diagram: Temporal development along profile.
 
[[NCPLOT: Line Charts|Line Charts]]: 
* time series
* profile view
* depth profile
 
NCPLOT allows you to illustrate different diagrams of different types in one picture.
Line diagrams next to areal charts with static and possibly dynamic parts.
 

Picture series: 
Both line and area chart definitions can request the creation of picture series.
A picture can contain static and dynamic image components.
Dynamic components means parts of the image that vary over a picture series.
 

The following rule applies to the program: 
The first read dynamic definition determines the permitted length of the
picture series.
The program aborts, if a further dynamic diagram definition results a
different number of images.
 

Further tests are not carried out.
 

Different series diagrams from dynamic diagram definitions of the same
length are processed by the program. The static picture elements are displayed
on every picture in the series.
 

|inputfiles=
# '''general input data''' (file type [[NCPLOT.DAT|ncplot.dat]])
# '''result files''' (file type [[CF-NETCDF.NC]])
# file with '''interval definitions''' for color legends (file type [[BOUNDS.CFG.DAT|bounds.cfg.dat]]) Hint: (Recommended) Local configuration file or file from the directory ''$PROGHOME/cfg/''.
# file with '''list of definitions of palettes''' (file type [[PALETTES.CFG.DAT|palettes.cfg.dat]]) Hint: (Recommended) Provided file from the directory ''$PROGHOME/cfg/'' or local configuration file.
# file with '''definitions of colors''' (file type [[COLORS.CFG.DAT|colors.cfg.dat]]) Hint: (Recommended) Provided file from the directory ''$PROGHOME/cfg/'' or local configuration file.

For NCPLOT the following standard configuration files from the directory '''''$PROGHOME/cfg/''''' are required:
* GKS parameter file: '''gkssystem.computername.dat'''

|outputfiles=
# '''plot metafiles''' (CGM format)
# (optional) informative '''printer file''' of program execution (file type ncplot.sdr)
# (optional) '''trace''' of program execution (file type ncplot.trc)

|methodology=
NCPLOT is a pure plot program without any user interaction at runtime.
The layout of the picture and the graphical presentation of the data has to be
described in the steering file.
 

NCPLOT creates vector graphics in CGM format.
 

For special data files it is possible to exclude data at places with low water
coverage from the display. The technic works only on original UnTRIM result files
in CF NetCDF format.
 

Just in case '''HDF error''' is detected during read of a data record,
the program tries to reconstruct the wanted data set from adjacent (in time)
records for the same variable.
This type of repair works for time dependent variables only.
 

|preprocessor=[[BOE2NC]], [[DATACONVERT]], [[GRIDCONVERT]], [[NCAGGREGATE]], [[NCANALYSE]], [[NCCUTOUT]], [[NCDELTA]], [[NCDVAR]], [[UNK]], [[UNTRIM2007]], [[UNTRIM2]]
|postprocessor=---
|language=Fortran95
|add_software=GKS (by GTS-Gral)
|contact_original=[mailto:guenther.lang@baw.de G. Lang], [mailto:susanne.spohr@baw.de S. Spohr]
|contact_maintenance=[mailto:guenther.lang@baw.de G. Lang], [mailto:susanne.spohr@baw.de S. Spohr]
|documentation=
template files available in '''$PROGHOME/examples/ncplot'''
}}

NCPLOT: Example figures

2020-04-30T12:26:43Z

Ak3spohr: + area Charts PZ,TZ,PT

__NOAUTOLINKS__
__NOAUTOLINKTARGET__
[[de:Beispiel-Grafiken: NCPLOT]]

The sample pictures should give an impression of the capability of the program [[NCPLOT]].
__TOC__
 

=Examples=

===Area Chart: Map View===
{| border="1"
! width="50%" | Topography with details on a subgrid
! width="50%" | Comparison of water level and salinity
|-
|[[File:NcplotBspSubgridTopo.png|center|500px|Topography with details on a subgrid]]
|[[File:NcplotBspTwo_Maps.png|center|500px|Comparison of water level and salinity]]
|}
 

===Area Chart: Vertical sections along profiles (3D data)===
{| border="1"
! width="50%" | Salinity along Elbe longitudinal profile
! width="50%" | Salinity cross profile Elbe-KM 703
|-
|[[File:NcplotBspAcPzElbeLP.png|center|500px|Salinity along Elbe longitudinal profile]]
|[[File:NcplotBspAcPzElbeQP.png|center|500px|Salinity cross profile Elbe-KM 703]]
|}
 

===Area Chart: Time depth diagram (3D data)===
{| border="1"
! width="50%" | Scalar current velocity
! width="50%" | Salinity Elbe at Brunsbüttel
|-
|[[File:NcplotBspAcTzBrunCU.png|center|500px|Scalar current velocity]]
|[[File:NcplotBspAcTzBrunSA.png|center|500px|Salinity Elbe at Brunsbüttel]]
|}
 

===Area Chart: Hovmöller diagram===
{| border="1"
! width="50%" | Water level along Elbe
! width="50%" |
|-
|[[File:NcplotBspAcPtElbeHov.png|center|500px|Water level along the Elbe]]
|
|}
 

===Line Chart: Time series===
{| border="1"
! width="50%" | Measurement ADCP cross section (Gandersum)
! width="50%" | Aggregated transport of suspended load
|-
|[[File:NcplotBspLcTgAdcpGandersum.png|center|500px|Measurement ADCP cross section (Gandersum)]]
|[[File:NcplotBspAggSchwStTp.png|center|500px|Aggregated transport of suspended load over edge surfaces]]
|}
 

===Line Chart: Profile view===
{| border="1"
! width="50%" | Water levels along the river Elbe
! width="50%" |
|-
|[[File:NcplotBspLcPgElbeLP.png|center|500px|Water levels along the river Elbe]]
|
|}
 

===Line Chart: Depth profile===
{| border="1"
! width="50%" | Absolute value of mean current velocity (Weser)
! width="50%" |
|-
|[[File:NcplotBspLcGzWeserCU.png|center|500px|Absolute value of mean current velocity (Weser)]]
|
|}
 

----
back to [[NCPLOT]]

File:NcplotBspAcPtElbeHov.png

2020-04-30T12:16:09Z

Ak3spohr: NCPLOT Example figure Hovmöller diagram: Temporal development water level along the Elbe.

== Summary ==
NCPLOT Example figure Hovmöller diagram: Temporal development water level along the Elbe.

File:NcplotBspAcTzBrunSA.png

2020-04-30T12:15:45Z

Ak3spohr: NCPLOT Example figure time depth diagram (3D data): Salinity Elbe at Brunsbüttel.

== Summary ==
NCPLOT Example figure time depth diagram (3D data): Salinity Elbe at Brunsbüttel.

File:NcplotBspAcTzBrunCU.png

2020-04-30T12:15:21Z

Ak3spohr: NCPLOT Example figure time depth diagram (3D data): Scalar current velocity Elbe at Brunsbüttel.

== Summary ==
NCPLOT Example figure time depth diagram (3D data): Scalar current velocity Elbe at Brunsbüttel.

File:NcplotBspAcPzElbeQP.png

2020-04-30T12:14:51Z

Ak3spohr: NCPLOT Example figure vertical section (3D data): Salinity cross profile Elbe-KM 703.

== Summary ==
NCPLOT Example figure vertical section (3D data): Salinity cross profile Elbe-KM 703.

File:NcplotBspAcPzElbeLP.png

2020-04-30T12:14:22Z

Ak3spohr: NCPLOT Example figure vertical section (3D data): Salinity along Elbe longitudinal profile.

== Summary ==
NCPLOT Example figure vertical section (3D data): Salinity along Elbe longitudinal profile.

NCPLOT: Framing

2020-01-27T14:01:53Z

Ak3spohr: Framing request moved to NTN block

__NOAUTOLINKS__
__NOAUTOLINKTARGET__
[[de:NCPLOT: Umrahmung]]

This page lists the ways of framing a map offered by [[NCPLOT]].

The type of framing a map is requested in the corresponding "Normalization_Transformation"-block of the
control file [[NCPLOT.DAT]] through the KEY line "NTN_Framing" and its two input parameters.
The input line is optional. If the line is missing, no frame is plotted.

The type of frame can be a simple black edging or a complex frame with coordinates.
The offered coordinate frames are optimized for values belonging to Gauss Krüger projection.
Gridlines can help with orientation in the map.
 

* Key '''NTN_Framing''': Type of map framing
:* First parameter: '''Type of the frame'''
::*'''Rechteck''' = Rectangular frame without labeling
::*'''Standard''' = Rectangular frame with labeling bottom and left
::*'''Schachlinie''' = Small alternating black and white rectangles with no label
::*'''BSH''' = Like "Schachlinie" with labeling top, bottom, right and left
::*'''BWK''' = Framing like the "Bundeswasserstrassenkarten" with labeling top, bottom, right and left
:* Second parameter: '''Type of displaying the grid lines'''
::*'''NONE''' = no grid lines
::*'''mit_x_Gitternetzlinien''' = only the grid lines along the x-axis are displayed
::*'''mit_y_Gitternetzlinien''' = only the grid lines along the y-axis are displayed
::*'''mit_xy_Gitternetzlinien''' = display the grid lines for both axes
 

{| border="1"
! width="50%" | Frame type: Rechteck
! width="50%" | Frame type: Standard
|-
|[[File:NcplotBspFrameRechteck.png|center|500px|Frame type "Rechteck"]]
|[[File:NcplotBspFrameStandard.png|center|500px|Frame type "Standard"]]
|}
{| border="1"
! width="50%" | Frame type: Schachlinie
! width="50%" | Frame type: BSH
|-
|[[File:NcplotBspFrameSchachlinie.png|center|500px|Frame type "Schachlinie"]]
|[[File:NcplotBspFrameBSH.png|center|500px|Frame type "BSH"]]
|}
{| border="1"
! width="50%" | Frame type: BWK
! width="50%" | Frame with grid lines
|-
|[[File:NcplotBspFrameBWK.png|center|500px|Frame type "BWK"]]
|[[File:NcplotBspFrameGrid.png|center|500px|Frame with grid lines]]
|}
 

----
back to [[NCPLOT.DAT]]

NCPLOT.DAT

2020-01-27T13:52:32Z

Ak3spohr: GO-compliant units; Framing moved to NTN-Block

{{FileDescription
|name_de=NCPLOT.DAT
|filetype=ncplot.dat
|version=January 2020
|version_descr=January 2020
|significance=contains general steering data for the program [[NCPLOT]].
|filecontents=

===Block "Program_Parameters"===
The block '''Program_Parameters''' contains general steering data.
* Key '''"Language" :''' Language preference for labels and texts:
:*'''DE''' = German,
:*'''EN''' = English.
* Key '''"Max_Read_Storage" :''' max. read only memory (in bytes) for analysis
* Key '''"Min_Water_Depth" :''' minimum water coverage in [m].
:Hint: The excluding of data from the presentation in case of low water coverage is only possible, if the variable to be displayed points in a certain way to a variable associated with the total water depth. The CF-NetCDF output of UnTRIM programs fulfills this requirement. The page '''''[[NCPLOT: Min_Water_Depth]]''''' illustrates the effect of this control parameter.
* (optional) Key '''"Infobox_Plot_Area" :''' Image area for the metadata infobox.
:If this image area is specified, information about the plot creation will be given to the graphic. This includes information about the underlying data files as well as if neccessary information about used data filtering.
* (optional) Key '''"PLR_Representation" :''' Default setting for line symbols of data curves in line charts.
* (optional) Key '''"PMR_Representation" :''' Default setting for marker symbols of data curves in line charts.
* (optional) Key '''"PLR_Palette" :''' Color palette and start color for line symbols of data curves in line charts.
* (optional) Key '''"PMR_Palette" :''' Color palette and start color for marker symbols of data curves in line charts.
* (optional) Key '''"Picture_Name_Fixum" :''' fixed name part for CGM output file.
* (optional) Key '''"Phydef_Units" :''' Display physical units as in PHYDEF administration.
:Hint: Without explicit request, the units are displayed according to the BAW Rules.

===Block "Dataset"===
Description of a data set to be displayed. 
 
For addressing the data to be displayed, either the Start-Step-Stride technique
or the DimSelect method is available. The user has to choose one way or the other,
the procedures exclude each other. Each Start-Step-Stride-Addressing can be copied
by DimSelect, the other way round that is not the case.
DimSelect offers additional options for data selection, with the method
you can also realize non-equidistant index selection.
;Start-Step-Stride technique:
:For each dimension of the variable a start, step and stride value must be specified. The page '''''[[NCPLOT: Define DataSet]]''''' gives instructions for addressing the desired data.
;DimSelect method:
:DimSelect also requires the addressing of the indices for each dimension of the data variables to be displayed. But this can also happen indirectly. Various suitable selection methods are provided. The user can, for example, choose all faces by '''''DimSelect_All''''' without knowing the specific number, or pass the program via '''''DimSelect_Various_Date''''' a selection of times to be displayed. It is the responsibility of the program to find the corresponding indices. Related to data curves of line charts the DimSelect method offers a further advantage: For the individual dimensions this mimic allows to create text components for the names of the data series shown in the curve legend. 
Control file can contain multiple blocks of this type.
* Key '''"Name" :''' unique name of this data set.
* Key '''"File" :''' name of the CF-NetCDF file (*.nc) with the data to be displayed.
* Key '''"Variable" :''' Description of the data whose values are to be displayed.
:* Parameter '''1''' = name of the variable (in file of type *.nc)
:* (optional) Parameter '''2''' = role of the variable as part of a vector
::* X-component = Variable is the X component of a vector
::* Y-component = Variable is the Y component of a vector
::* normal_component = Variable is the normal component of a vector
:Hint: The command "ncdump -h <filename>.nc" shows the header of the CF-NetCDF file. The names of the offered variables and their dimensions can be found in the metadata.
* (optional) Key '''"Start" :''' start address for the data to be displayed.
* (optional) Key '''"Step" :''' number of steps for the data to be displayed.
* (optional) Key '''"Stride" :''' increment for the data to be displayed.
* (optional) Key '''"DimSelect_EquiDist_Index" :''' Equidistant selection of indices for a given dimension. Exemplary:
:* Parameter '''1''' = Name of the dimension
:* Parameter '''2''' = NONE or text component for curve legend
:* Parameter '''3''' = Index becomes part of the curve legend .true./.false.
:* Parameter '''4''' = Start Index
:* Parameter '''5''' = Index increment
:* Parameter '''6''' = Number of steps
* (optional) Key '''"DimSelect_EquiDist_Date" :''' Equidistant selection of times.
* (optional) Key '''"DimSelect_StartEnd_Index" :''' Selection of all indices from start to end index.
* (optional) Key '''"DimSelect_StartEnd_Date" :''' Selection of all times from start to end date.
* (optional) Key '''"DimSelect_Single_Index" :''' Selection of a specific index.
* (optional) Key '''"DimSelect_Single_Date" :''' Selection of a specific date.
* (optional) Key '''"DimSelect_Various_Index" :''' List of various indices.
* (optional) Key '''"DimSelect_Various_Date" :''' List of various dates.
* (optional) Key '''"DimSelect_All" :''' Selection of all indices of a dimension.
* (optional) Key '''"DimSelect_ByLabel_LabVar" :''' Determine indices with list of names by label variable.
* (optional) Key '''"DimSelect_ByLabel_List" :''' Continuation line to Key '''''DimSelect_ByLabel_LabVar'''''.
* (optional) Key '''"DimSelect_Location_Coord" :''' Selection of locations by coordinates.
* (optional) Key '''"DimSelect_LocByFile_File" :''' Selection of locations from file with locations.
* (optional) Key '''"DimSelect_LocByFile_List" :''' Continuation line to Key '''''DimSelect_LocByFile_File'''''.
* (optional) Key '''"Dimensions_for_Picture_Series" :''' Requesting seperate presentations for selected dimensions.
:Hint: Causes series of pictures, i.e. for each selected index of the dimensions listed here a separate picture is created. Only works with line charts. Picture series must be the same length!

===Block "Layer"===
A block of type Layer defines a area diagram.
Currently, only the representation in the horizontal plane (i.e. top view illustration) is realized. 
Control file can contain multiple blocks of this type.
* Key '''"Name" :''' unique name of this layer.
* Key '''"Layer_Dataset_Name" :''' name of the dataset to be displayed. Or a valid connexion (OPERATOR string) made out of known data sets, e. g. '''[DSet2-DSet1]/[DSet1+DSet2]''', '''ABS[DSet]''', '''SQR[DSet]''' or '''G18[DSet]'''.
* Key '''"Layer_Normalization_Transformation_Name" :''' name of the normalization transformation for this layer.
* Key '''"Layer_Type" :''' type of data view of this layer.
:Hint: Currently only "XY_data" = horizontal view implemented.
* Key '''"Layer_Primitive_Name" :''' graphic primitive to visualize the data in the layer.
:* Parameter '''1''' = Symbolization of the layer
::*'''GPM''' = as poly marker
::*'''GPL''' = as poly line
::*'''GFA''' = as fill area
::*'''GTX''' = as text
::*'''VEC''' = as vector
:* (optional) Parameter '''2''' = Type of the vector ... optional parameter, only at VEC visualization permitted. ...allows, for example, the interpolation of the total vector from the normal component a vectorial quantity.
::*'''total''' = total vector
::*'''normal''' = normal vector
* Key '''"Layer_Primitive_Representation_Name" :''' name of the representation of the primitive.
* Key '''"Layer_Bounds_Name" :''' name of the interval definition for this layer (from the file '''''[[BOUNDS.CFG.DAT|bounds.cfg.dat]]''''').
:Hint: The number of intervals in the interval definition and the number of colors of the associated color legend must match.
* Key '''"Layer_Palette_Name" :''' name of the color legend for this layer (corresponds to the attribute ''Name'' in the file ''palette.dat''. More detailed information about palettes on file description page '''''[[PALETTES.CFG.DAT|palettes.cfg.dat]]''''').
* Key '''"Layer_Invert_Palette" :''' invertation of the color ramp.
* Key '''"Layer_Legend_Plot_Area" :''' image area for the color legend of this layer. Depending on the space, the color legend can be applied horizontally or vertically.
* Key '''"Layer_Legend_Label_Switch" :''' Switch list for switching off or positioning labels of the color legend.
* Key '''"Layer_Data_Description_Name" :''' name of the '''''Data_Description''''' text box, which should collects up the data description (e.g. indication of the time) of this layer.
* (optional) Key '''"Layer_Display_Units" :''' physical unit in which the data should be converted for the graphical presentation.
:Hints: The original unit of the data and the target unit must be known in the configuration file '''''phydef.cfg.si.dat'''''. In addition, the SI-base (dimension) of the units must be identical.
* (optional) Key '''"Layer_Display_Name" :''' name of physical quantity, will be used instead of the original name given in the input data set. Without this line the name in PHYDEF is used, if the variable owns the attribute '''''name_id'''''.. Dynamic text parts can be realized with special placeholders:
:*<LAY_DSET> will be replaced by the name of the dataset associated with the layer.
:*<LAY_DIM1> will be replaced by the info text for the 1st dimension of the displayed data set.
:*<LAY_DIM2> will be replaced by the info text for the 2nd dimension of the displayed data set.
:*<LAY_DIM?> etc. to the number of data set dimensions.
* (optional) Key '''"Layer_Vector_Legend_Plot_Area" :''' image area for the vector legend in case of arrows with length_type proportional.
* (optional) Key '''"Layer_Vector_Thinout_Raster" :''' dimensions of the grid used to thin out the display of vector arrows.
* (optional) Key '''"Layer_NOBS_Filter" :''' filter for displayed data based on ''ancillary variable'' with type ''number of observations'':
** parameter 1: filter type:
*** '''EQ''' = display data only for a fixed number of observations;
*** '''LE''' = display data for a certain number of observations or less;
*** '''LE''' = display data for a certain number of observations or more.
** parameter 2: filter value:
*** '''0''' = maximum number of observations;
*** '''N''' = specified number of observations;
*** '''-M''' = maximum number of observations minus M.
* (optional) Key '''"Layer_Description_Textbox" :''' name of a textbox to be linked with the layer.

===Block "Normalization_Transformation (NTN)"===
Definition of an image section and description of the link between the world and image
coordinates. 
A block of this type is only required for areal representation in the horizontal plane
(layer definition with Type == XY_Data). 
The coordinates of the drawing area, the so-called NDC space, range from [0.0,0.0] to [1.0,1.0].
For an undistorted view of the area the representation scale in the X direction must match
the scale in Y-direction (DWC / DNDC = const);
optionally also key '''"Autoscale"''' can be used for this purpose.
Distorted representations are also possible. 
* Key '''"Name" :''' unique name of this normalization transformation.
* Key '''"EPSG" :''' EPSG code of the data coordinates in the file.
* Key '''"EPSG_Window" :''' EPSG code of the plot projection.
* Key '''"Left_Lower_Window_Coordinates" :''' world coordinates (according to EPSG) the lower left corner of the projection window.
* Key '''"Right_Upper_Window_Coordinates" :''' world coordinates (according to EPSG) the upper right corner of the projection window.
* Key '''"Left_Lower_NDC_Coordinates" :''' picture coordinates (NDC within [0.0,1.0]) the lower left corner of the projection window.
* Key '''"Right_Upper_NDC_Coordinates" :''' picture coordinates (NDC within [0.0,1.0]) the upper right corner of the projection window.
* (optional) Key '''"Autoscale" :''' automatic adjustment (.true.) of scales in X- and Y-direction. Default is .false. (no adjustment).
* (optional) Key '''"Scale_Bar_Request"''' : Request drawing a scale bar. Autoscale needs to be on.
* (optional) Key '''"NTN_Framing" :''' Type of the coordinate frame when displayed as map.
:Hint: More info at '''''[[NCPLOT: Framing|Options of map frames]]'''''.

===Block "Data_Description"===
The block '''Data_Description''' defines a Data_Description object.
Such an object collects data descriptions and displays them together in a text field. 
A block of this type is currently only needed for area charts in the horizontal plane (Layer definition with Type == XY_Data). 
Control file can contain multiple blocks of this type.
* Key '''"Data_Desc_Name" :''' unique name of the text field for data descriptions.
* Key '''"Data_Desc_Plot_Area" :''' image area for the Data_Description text box.
* (optional) Key '''"Data_Desc_Draw_Frame" :''' draw a frame around the Data Description text box TRUE/FALSE.
* (optional) Key '''"Data_Desc_Color_Name" :''' name of the color for text and frame.

===Block "LineChart"===
The block '''LineChart''' is used to define a line diagram. 
A "LineChart" has only one X- and one Y-axis.
A secondary Y-axis must be realized by defining a second "LineChart" object
on the same drawing area and with the same X-axis. 
Any number of LineCharts can be stacked. The associated axes can be positioned
on all four sides of the diagram and can also be moved away from the drawing
area by different distances.
Thus, for example, on the sheet "one" time series diagram with three Y-axes
can be generated that represents the curves for flow amount, flow direction
and salinity together. 
Control file can contain multiple blocks of this type.
* Key '''"LineChart_Name" :''' unique name of the line chart.
* Key '''"LineChart_Type" :''' type of line chart.
:*'''TG''' = Time series; Data over time
:*'''PG''' = Profile chart; Data over profile axis
:*'''GZ''' = Depth profile; 3D data along depth axis
* Key '''"LineChart_Area" :''' image area spanned by the diagram axes.
* Key '''"LineChart_Extent" :''' total area occupied by the diagram on the image.
* Key '''"LineChart_X-Axis" :''' X-axis of the diagram and its positioning.
* Key '''"LineChart_Y-Axis" :''' Y-axis of the diagram and its positioning.
* (optional) Key '''"LineChart_Legend_Box" :''' name of a '''''Legend_Box''''', the object/area in which the curve legends of the diagram are stored and presented.
* (optional) Key '''"LineChart_Route_Dataset" :''' name of a '''''dataset''''' with profile route for sorting and filtering data to be displayed.
* (optional) Key '''"LineChart_PLR_Representation" :''' line Symbolization for the data curves of this diagram.
* (optional) Key '''"LineChart_PMR_Representation" :''' marker Symbolization for the data curves of this diagram.
* (optional) Key '''"LineChart_PLR_Palette" :''' color palette and start color for line symbols of this line chart.
* (optional) Key '''"LineChart_PMR_Palette" :''' color palette and start color for marker symbols of this line chart.

===Block "Axis"===
The block '''Axis''' is used to define a diagram axis. 
An axis definition can be used for varius diagrams.
For example superposed "LineCharts" or several diagrams arranged
one below the other with the same time axis. 
Control file can contain multiple blocks of this type.
* Key '''"Axis_Name" :''' unique name of the axis definition.
* Key '''"Axis_Type" :''' type of axis.
:*'''T''' = time axis
:*'''G''' = axis for physical quantities
:*'''P''' = profile axis
:*'''Z''' = depth axis
* (optional) Key '''"Axis_Value_Range" :''' value range of the axis.
* (optional) Key '''"Axis_Date_Range" :''' time range of the axis.
* (optional) Key '''"Axis_Scale_Logarithmic" :''' switch logarithmic scaling LOG10 on TRUE/FALSE.
* (optional) Key '''"Axis_Invert_Profile_Route" :''' switch invert the route of a profile axis TRUE/FALSE.
* (optional) Key '''"Axis_Scale_Multiplicator" :''' multiplication factor for axis scaling.
* (optional) Key '''"Axis_Display_Name" :''' axis title, will be used instead of the original name given in the input data.
* (optional) Key '''"Axis_Display_Unit" :''' physical unit in which the data should be converted for the graphical presentation.
:Hints: The original unit of the data and the target unit must be known in the configuration file '''''phydef.cfg.si.dat'''''. In addition, the SI-base (dimension) of the units must be identical.
* (optional) Key '''"Axis_Labels_EquiDist_Value" :''' equidistant values for labeling along the axis.
* (optional) Key '''"Axis_Labels_EquiDist_Date" :''' equidistant dates for labeling along the axis.
* (optional) Key '''"Axis_Labels_at_Values" :''' list of values for labeling along the axis.
* (optional) Key '''"Axis_Labels_at_Dates" :''' list of dates for labeling along the axis.
* (optional) Key '''"Axis_Line_Representation" :''' name of a ''Poly_Line_Representation'' for the representation of the axis line.
* (optional) Key '''"Axis_Text_Representation" :''' name of a ''Text_Representation'' for the axis labeling (only influencing the font color).
* (optional) Key '''"Gitternetz_Representation" :''' name of a ''Poly_Line_Representation'' for the gridlines or switch off these lines with NONE.
* (optional) Key '''"Tickmark_Representation" :''' formatting or switching off axis tickmarks.
:* Parameter '''1''' = name of a color for the tickmarks
:* Parameter '''2''' = width of the tickmark line
:* Parameter '''3''' = length of tickmarks in image coordinates; 0.0 turn it off!
* (optional) Key '''"Axis_Additional_Line_Value" :''' draw an additional line vertical to the axis at a certain value.
* (optional) Key '''"Axis_Additional_Line_Date" :''' draw an additional line vertical to the time axis at a certain date.
* (optional) Key '''"Axis_Additional_Line_Coord" :''' draw an additional line vertical to the profile axis at a certain location.
* (optional) Key '''"Characters_along_Axis" :''' allows the manipulation of the font size of the axis labeling.

===Block "DataRow"===
The block '''DataRow''' is used to describe a data series, or a group
of data series. 
Due to the data addressing in the ''DataSet'', a ''DataRow'' description can
result in several data series.
All these data series end up in the same line diagramm. 
Blocks of this type are needed for line charts. 
Control file can contain multiple blocks of this type.
* Key '''"DataRow_Name" :''' unique name of the data row description.
* Key '''"DataRow_Dataset" :''' name of the dataset to be displayed. Or a valid connexion (OPERATOR string) made out of known data sets, e. g. '''[DSet2-DSet1]/[DSet1+DSet2]''', '''ABS[DSet]''', '''SQR[DSet]''' or '''G18[DSet]'''.
* Key '''"DataRow_LineChart" :''' name of the ''LineChart'', i.e. of the line diagram in which the data series are to be drawn.
* (optional) Key '''"DataRow_PLR_Representation" :''' line symbolization for the data curves of this data series.
* (optional) Key '''"DataRow_PMR_Representation" :''' marker symbolization for the data curves of this data series.
* (optional) Key '''"DataRow_PLR_Palette" :''' color palette and start color for line symbols of this data series.
* (optional) Key '''"DataRow_PMR_Palette" :''' color palette and start color for marker symbols of this data series.
* (optional) Key '''"DataRow_NoValue_Handling" :''' Handling invalid values in the data series.
:*'''Luecke''' = Points without data are not displayed
* (optional) Key '''"DataRow_NOBS_Filter" :''' filter for displayed data based on ''ancillary variable'' with type ''number of observations'':
** parameter 1: filter type:
*** '''EQ''' = display data only for a fixed number of observations;
*** '''LE''' = display data for a certain number of observations or less;
*** '''LE''' = display data for a certain number of observations or more.
** parameter 2: filter value:
*** '''0''' = maximum number of observations;
*** '''N''' = specified number of observations;
*** '''-M''' = maximum number of observations minus M.

===Block "Legend_Box"===
A legend box collects names and symbolizations of data curves and
displays them together in a text field.
A legend field can accommodate curve descriptions from different diagrams. 
A block of this type is only needed by line charts. 
Control file can contain multiple blocks of this type.
* Key '''"Legend_Box_Name" :''' unique name of the legend field.
* Key '''"Legend_Box_Plot_Area" :''' image area for the legend field.
* (optional) Key '''"Legend_Box_Draw_Frame" :''' draw a frame around the legend field TRUE/FALSE.
* (optional) Key '''"Legend_Box_Color_Name" :''' name of the color for text and frame.

===Block "Textbox"===
Description of one free text field. 
An empty text box can act as rectangular frame, with the color, type and width of the line
being adjustable. If you give the text box a background color, you can use it to cover
a particular area of the diagram. 
Control file can contain multiple blocks of this type.
* Key '''"Name" :''' unique name of the text box.
* Key '''"Plot_Area" :''' image area for the text box.
* (optional) Key '''"Text_Line" :''' one line of the text box. Specification of several lines possible. Placeholder for system information:
:*<SYS_DATE> will be replaced by current date.
:*<SYS_TIME> will be replaced by current time.
:*<SYS_USER> will be replaced by User ID.
:Placeholder for text box, which is connected to a Layer:
:*<LAY_DSET> will be replaced by the name of the dataset associated with the layer.
:*<LAY_DIM1> will be replaced by the info text for the 1st dimension of the displayed data set.
:*<LAY_DIM2> will be replaced by the info text for the 2nd dimension of the displayed data set.
:*<LAY_DIM?> etc. to the number of data set dimensions.
:Hint: Linking is realized in the layer block via KEY ''Layer_Description_Textbox''.
* (optional) Key '''"Color_Name" :''' colors of the textbox.
** parameter 1: for text and frame
** (optional) parameter 2: for background
* (optional) Key '''"Draw_Frame" :''' draw a frame around the text box TRUE/FALSE.
* (optional) Key '''"Frame_Style" :''' appearance of the text box frame.
** parameter 1: line width
** (optional) parameter 2: line type
* (optional) Key '''"Fixed_Width" :''' character-wise writing with constant width or not.
* (optional) Key '''"Horizontal_Char_Space" :''' Horizontal character distance factor for character-wise writing.
* (optional) Key '''"Vertical_Line_Space" :''' Vertical line spacing factor.
* (optional) Key '''"Font_Size" :''' Font size can be specified possibly.
* (optional) Key '''"Font_Size_Factor" :''' Factor for manipulating the calculated font size.

===Block "Poly_Marker_Representation"===
Description of one type of marker symbols. 
Control file can contain multiple blocks of this type.

===Block "Fill_Area_Representation"===
Description of one type of fill area symbolization. 
Control file can contain multiple blocks of this type.

===Block "Poly_Line_Representation"===
Description of one type of line symbolization. 
Control file can contain multiple blocks of this type.

===Block "Text_Representation"===
Description of one type of text symbolization. 
Control file can contain multiple blocks of this type.

===Block "Vector_Representation"===
Description of one type of vector symbolization. 
Control file can contain multiple blocks of this type. 
Hint: More info at '''''[[NCPLOT: Types of vector symbols]]'''''.

===General Remarks===
# While reading this steering data file the '''dictionary file''' '''''ncplot_dico.dat''''' will be automatically accessed in directory '''''$PROGHOME/dic/''''' to support input.
# If no such file exists in the working directory, NCPLOT accesses the following configuration files from the directory '''''$PROGHOME/cfg/''''':
#* '''''colors.cfg.dat''''': File with definitions of colors.
#* '''''palettes.cfg.dat''''': File with references to files with color palette definitions.
#* '''''bounds.cfg.dat''''': File with interval definitions for legends. Hint: The bounds file should be better stored within a project in the working directory.
# The following '''standard configuration files''' from the directory '''''$PROGHOME/cfg/''''' are required:
#* '''gkssystem.rechnername.dat''': GKS parameter file.
#* '''phydef.cfg.si.dat''': Configuration file for units and their relation to the SI system.

|nutzerprogramme=[[NCPLOT]]
|language=Fortran90
|fileform=FORMATTED
|fileaccess=SEQUENTIAL
|fileextension=.dat
|writemodules= ---
|readmodules=$PROGHOME/fortran/prg/ncplot/*/mod_m_ncplot_steer.f90
|contact_original=[mailto:guenther.lang@baw.de G. Lang], [mailto:susanne.spohr@baw.de S. Spohr]
|contact_maintenance=[mailto:guenther.lang@baw.de G. Lang], [mailto:susanne.spohr@baw.de S. Spohr]
|examplefile=$PROGHOME/examples/ncplot/ncplot.dat
}}

NCPLOT

2020-01-27T13:06:07Z

Ak3spohr: Modified version date

{{ProgramDescription
|name_de=NCPLOT
|name=NCPLOT
|version=January 2020
|version_descr=January 2020
|catchwords=graphical postprocessor 
graphical presentation of CF NetCDF data (unknown attributes are ignored) 
finite element models 
finite difference models 
orthogonal unstructured grid model 
orthogonal unstructured grid model with subgrid information 
conversion or transformation (extensive - intensive) of physical units 
calculation of new quantities (for display) from one or several input data sets 
(optional) filter based on water depth 
(optional) filter based on number of observations 

Acknowledgment: ''This project took advantage of netCDF software developed by UCAR/Unidata ([http://www.unidata.ucar.edu/software/netcdf/ www.unidata.ucar.edu/software/netcdf/]).''

|shortdescription=
The graphical postprocessor NCPLOT can be used for a graphical presentation
of simulation and analysis results, which is stored in CF NetCDF data format.
The data can be defined on nodes, edges or faces. The program works on 2D-data,
3D-data and on data with details scaled on a subgrid. 
[[File:NcplotBspFaceArea.png|thumb|250px|Picture 1: Salinity with underlaid topography.]]

The sample pictures illustrate the capability of the program NCPLOT. 
[[NCPLOT: Example figures|Example figures: NCPLOT]]

Basically, NCPLOT distinguishes linear from areal chart types.
For area charts the symbolization of the data is depending on the data value
(color legend, proportional arrow).
For linear charts, the values of data series are plotted on an axis.
The symbolization of the data series is independent of the data value.
 

[[NCPLOT: Area Charts|Area Charts]]:
* Map, or top view illustration

[[NCPLOT: Line Charts|Line Charts]]: 
* time series
* profile view
* depth profile

NCPLOT allows you to illustrate different diagrams of different types in one picture.
Line diagrams next to areal charts with static and possibly dynamic parts.
 

Picture series: 
Both line and area chart definitions can request the creation of picture series.
A picture can contain static and dynamic image components.
Dynamic components means parts of the image that vary over a picture series.
 

The following rule applies to the program: 
The first read dynamic definition determines the permitted length of the
picture series.
The program aborts, if a further dynamic diagram definition results a
different number of images.
 

Further tests are not carried out.
 

Different series diagrams from dynamic diagram definitions of the same
length are processed by the program. The static picture elements are displayed
on every picture in the series.
 

|inputfiles=
# '''general input data''' (file type [[NCPLOT.DAT|ncplot.dat]])
# '''result files''' (file type [[CF-NETCDF.NC]])
# file with '''interval definitions''' for color legends (file type [[BOUNDS.CFG.DAT|bounds.cfg.dat]]) Hint: (Recommended) Local configuration file or file from the directory ''$PROGHOME/cfg/''.
# file with '''list of definitions of palettes''' (file type [[PALETTES.CFG.DAT|palettes.cfg.dat]]) Hint: (Recommended) Provided file from the directory ''$PROGHOME/cfg/'' or local configuration file.
# file with '''definitions of colors''' (file type [[COLORS.CFG.DAT|colors.cfg.dat]]) Hint: (Recommended) Provided file from the directory ''$PROGHOME/cfg/'' or local configuration file.

For NCPLOT the following standard configuration files from the directory '''''$PROGHOME/cfg/''''' are required:
* GKS parameter file: '''gkssystem.computername.dat'''

|outputfiles=
# '''plot metafiles''' (CGM format)
# (optional) informative '''printer file''' of program execution (file type ncplot.sdr)
# (optional) '''trace''' of program execution (file type ncplot.trc)

|methodology=
NCPLOT is a pure plot program without any user interaction at runtime.
The layout of the picture and the graphical presentation of the data has to be
described in the steering file.
 

NCPLOT creates vector graphics in CGM format.
 

For special data files it is possible to exclude data at places with low water
coverage from the display. The technic works only on original UnTRIM result files
in CF NetCDF format.
 

Just in case '''HDF error''' is detected during read of a data record,
the program tries to reconstruct the wanted data set from adjacent (in time)
records for the same variable.
This type of repair works for time dependent variables only.
 

|preprocessor=[[DATACONVERT]], [[GRIDCONVERT]], [[NCAGGREGATE]], [[NCANALYSE]], [[NCCUTOUT]], [[NCDELTA]], [[UNK]], [[UNTRIM2007]], [[UNTRIM2]]
|postprocessor=---
|language=Fortran95
|add_software=GKS (by GTS-Gral)
|contact_original=[mailto:guenther.lang@baw.de G. Lang], [mailto:susanne.spohr@baw.de S. Spohr]
|contact_maintenance=[mailto:guenther.lang@baw.de G. Lang], [mailto:susanne.spohr@baw.de S. Spohr]
|documentation=
template files available in '''$PROGHOME/examples/ncplot'''
}}

Harmonic Analysis of Current Velocity

2019-12-16T14:39:35Z

Ak3spohr: replaced Tidal_current_ellipse_definition.gif by Tidal_current_ellipse_definition.png

[[de:Harmonische Analyse der Strömung]]
[[Category:Tidal Constituents]]

=Motivation=

For almost any location within an estuary the current velocity can be decomposed into a periodic part driven by the tides (astronomical and shallow water tides) as well as a non-periodic part driven by river runoff, meteorological effects as well as local topographic features.

[[File:Tidal_current_ellipse_definition.png|200px|thumb|right|defintion of tidal ellipse]]
For each tidal constituent the tip of the current velocity vector describes an ellipse, the tidal ellipse (see accompanying figure). Within each period of the respective tidal constituent a full rotation is executed. Characteristic parameters for a tidal ellipse are semi major axis, semi minor axis, inclination of tidal ellipse as well as its eccentricity. In dependence on eccentricity the ellipse degenerates either to a circle (eccentricity +1.0 or -1.0) or a straight line (eccentricity 0.0). The beforementioned parameters are well suited to describe the tidal influence on current velocity.

=Basic Concepts=

Basic informations on ''Tidal Harmonic Analysis'' are presented in [[Harmonic Analysis of Water Level]].
The methods used to compute various ellipse parameters using program [[NCANALYSE]] are described in more detail in publication
[[Media:zhigang_xu_2000_ellipse_parameters_conversion.pdf|zhigang_xu_2000_ellipse_parameters_conversion.pdf]].

The computational procedure is as follows (number of equation with reference to Zhigang Xu (2000) given in brackets):
# Compute amplitude and phase for u-component (x- or eastward) of current velocity (Eq. 1).
# Compute amplitude and phase for v-component (y- or northward) of current velocity (Eq 2).
# Determine equivalent complex formulas for u and v (Eq. 9 und Eq. 10).
# Derive complex formulas for (mathematical) positive as well as negative rotating circular components (Eq. 7 and Eq. 8). Superposition of two components with different sense of orientation results in a tidal ellipse.
# From the lastly mentioned complex formulas magnitude an phase for positive and negative rotating components can be computed.
# With these results it is possible to compute semi major axis and semi minor axis (Eq. 14 and Eq. 19), axes inclination (Eq. 15 and Eq. 20) as well as eccentricity (Eq. 21).
The aforementioned calculations must be performed for any tidal constituent.

=Definition of Characteristic Numbers=

The Least Square Fit Method (LSQF) is used to compute amplitude and phase for the u- and v-component of current velocity.
For this purpose program [[NCANALYSE]] makes use of methods available within the software package LAPACK.

All quantities are computed for permanently wet areas only.

For each tidal constituent the following quantities are determined.

==Residual Current Velocity (Vres)==

Residual current velocity (computed from tidal constituent analysis) within the period of data analysis.
This quantity describes the non-tidal (or non-periodc) contribution. It mainly depends on river flow,
meteorology and local topographic details, but is also dependent to some extent on the number of tidal
constituents taken into account.


==Amplitude and Phase of Tidal Constituents==

The subsequent quantities are essential to derive the various characteristic parameters for tidal ellipses
introduced below. Standard error for each of the four quantities is also computed. The quantities,
although important, are not well suited to be used for visualization.

===Amplitude of u-Component===

Amplitude of current velocity u-component (x- or eastward) of a tidal constituent.


===Amplitude of v-Component===

Amplitude of current velocity v-component (y- or northward) of a tidal constituent.


===Phase of u-Component===

Phase (in degree) of current velocity u-component (x- or eastward) of a tidal constituent.


===Phase of v-Component===

Phase (in degree) of current velocity v-component (y- or northward) of a tidal constituent.


==Characteristic Parameters for Tidal Ellipses==

From the above mentioned quantities (amplitudes and phases) all subsequent characteristic parameters for tidal ellipses can be derived.

===Semi Major Axis of Tidal Ellipse===

Semi major axis of a tidal constituent. Gives maximum current velocity within one period for the tidal constituent.


===Semi Minor Axis of Tidal Ellipse===

Semi minor axis of a tidal constituent. Gives minimum current velocity within one period for the tidal constituent.


===Inclination (direction) of Major Axis===

Gives the (mathematically positive) direction (-180.0 to 180.0 degree) of the semi major axis for a tidal constituent velocity.
Is equivalent to the orientation of the maximum current induced by the tidal constituent.


===Inclination (direction) of Minor Axis===

Gives the (mathematically positive) direction (-180.0 to 180.0 degree) of the semi minor axis for a tidal constituent velocity.
Is equivalent to the orientation of the minimum current induced by the tidal constituent.


===Eccentricity of Tidal Ellipse===

Eccentricity is defined as the ratio between semi minor and semi major axis of a tidal ellipse. Special cases are:
* 0.0 : rectilinear current, e. g. due to topographic guidance;
* 1.0 : circular current velocity in mathematical positive direction (counter clockwise);
* -1.0 : circular current velocity in mathematical negative direction (clockwise).


----
back to [[Analysis of Calculated Results]]
----
[[Overview]]

File:Tidal current ellipse definition.png

2019-12-16T14:37:34Z

Ak3spohr: Tidal current Ellipse definition

== Summary ==
Tidal current Ellipse definition