NCPLOT.DAT

Basic Information

File-Type

ncplot.dat

File-Form

FORMATTED

Version

February 2014

Description-Date

February 2014

Significance of the File

contains general steering data for the program NCPLOT.

File-Contents (in Catchwords)

steering data

• Block Program_Parameters: 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.

• Block Normalization_Transformation: normalization transformation (NTN)
  Definition of an image section and description of the link between the world and image coordinates. 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). Distorted representations are also possible.
  In addition to the positioning of the map windows NTNs be used for legends and text windows. Legends can be arranged either horizontally or vertically.
  

• 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.

• Block Poly_Marker_Representation: Poly-Marker Representation
  Description of one type of marker symbols.
  Control file can contain multiple blocks of this type.

• Block Fill_Area_Representation: Fill-Area Representation
  Description of one type of fill area symbolization.
  Control file can contain multiple blocks of this type.

• Block Poly_Line_Representation: Poly-Line Representation
  Description of one type of line symbolization.
  Control file can contain multiple blocks of this type.

• Block Text_Representation: Text Representation
  Description of one type of text symbolization.
  Control file can contain multiple blocks of this type.

• Block Vector_Representation: 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".

• Block Dataset: Data set
  Description of a data set to be displayed.
  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.

• Key "Start" : start address for the data to be displayed.
• Key "Step" : number of steps for the data to be displayed.
• Key "Stride" : increment for the data to be displayed.

Hints:
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.

• Block Layer:
  Description of the content of a layer.
  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] and ABS[DSet1].
• 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

Hint: The primitive must fit to the underlying geometry of the data!
"node" data: GPM, GTX, VEC
"edge" data: GPM, GPL, GTX, VEC
"face" data: GPM, GPL, GFA, GTX, VEC

• 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).

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).
• Key "Layer_Invert_Palette" : invertation of the color ramp.
• Key "Layer_Legend_NTN_Name" : image area for the color legend of this layer.
• Key "Layer_Framing" : type of framing for this layer.

Hint: More info at "Options of the layer framing".

• Key "Layer_Description_NTN_Name" : image area for the data description (e.g. Indication of the time).
• (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.
• (optional) Key "Layer_Vector_Legend_NTN_Name" : image area for the vector legend in case of arrows with length_type proportional.

General Remarks

1. While reading this steering data file the dictionary file ncplot_dico.dat will be automatically accessed in directory $PROGHOME/dic/ to support input.
2. 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.
3. 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.

Programs using this Type of File

NCPLOT

Example-File

$PROGHOME/examples/ncplot/ncplot.dat

---

back to: File Descriptions

---

Overview