changeset 945:491b8d6cd291

Added content about generating charts doc/trunk@1089 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Hans Plum <hans.plum@intevation.de>
date Mon, 10 May 2010 19:41:15 +0000 (2010-05-10)
parents 4d1a1917282d
children dd6102eae823
files doc/ChangeLog doc/config-manual/general_settings.tex doc/config-manual/generating_charts.tex doc/config-manual/model_of_transitions.tex
diffstat 4 files changed, 60 insertions(+), 21 deletions(-) [+]
line wrap: on
line diff
--- a/doc/ChangeLog	Mon May 10 14:19:58 2010 +0000
+++ b/doc/ChangeLog	Mon May 10 19:41:15 2010 +0000
@@ -1,3 +1,10 @@
+2010-05-10  Hans Plum <hans@intevation.de>
+
+	* config-manual/model_of_transitions.tex,
+	config-manual/generating_charts.tex, 
+	config-manual/general_settings.tex:
+	Added content about generating charts.
+
 2010-05-10  Tim Englich  <tim@intevation.de>
 
 	* config-manual/general_settings.tex,
--- a/doc/config-manual/general_settings.tex	Mon May 10 14:19:58 2010 +0000
+++ b/doc/config-manual/general_settings.tex	Mon May 10 19:41:15 2010 +0000
@@ -36,9 +36,7 @@
 |   |   `-- *.xml
 |   |-- timeseries
 |   |   |-- *.xml
-|   |   `-- timegap_definition.xml # definition of a gaps as defines in
-            MEDIAN Coded Value Domains section TSIntervalTypes. The meaning
-            of the defined gaps are detailed  explained in the file itself.
+|   |   `-- timegap_definition.xml # definition of a gaps as defines in MEDIAN Coded Value Domains section TSIntervalTypes. The meaning of the defined gaps are detailed  explained in the file itself.
 |   |-- verticalcrosssection
 |   |   `-- *.xml
 |   `-- verticalprofile
--- a/doc/config-manual/generating_charts.tex	Mon May 10 14:19:58 2010 +0000
+++ b/doc/config-manual/generating_charts.tex	Mon May 10 19:41:15 2010 +0000
@@ -1,13 +1,11 @@
 \subsection{Generating Charts -- Background Information and Configuration}
 
-%% This section describes the possibilities to configure the
-%% artifact-server. The following properties do affect mostly technical
-%% funtions of the server.
-%% 
-%% This section describes the possibilities in a kind of a reference
-%% manual. Information for the process of installing and integration can be
-%% found in the Administration Manual of the GNV-System (FIXME reference).
-%% The following elements are covered here:
+The artifact-server is able to render different types of charts like 1D
+(timeseries, vertical- and horizontalprofiles, horizontal-cross-section
+profiles (a special case of the horizontalprofiles) and histograms) and 2D-diagrams
+(vertical-cross section profiles). This section describes the
+possibilities to configure different aspects for interpolating of data and
+visualising them in charts.
 
 \begin{lstlisting}
 artifact-database
@@ -19,33 +17,69 @@
 \end{lstlisting}
 
 \paragraph*{charttemplate}
-{\em Function}: 
+{\em Function}: The chart template is a global template for setting the
+visualization of charts globally like font styles, background, title,
+subtitle, etc. Further information can be found in the configuration
+file referenced via the attribute {\tt configuration}.
 
 \begin{itemize}
-    \item {\tt }:
+    \item {\tt configuration}: path to the configuration XML-file.
 \end{itemize}
 
 
 \paragraph*{palettes}
-{\em Function}: 
+{\em Function}: This section lists the available palettes used for rendering
+vertical-cross-section charts (2D). Each {\tt palette}-element contains
+the following attributes:
 
 \begin{itemize}
-    \item {\tt }:
+    \item {\tt name}: a descriptive name.
+    \item {\tt parameter-ids}: identifier used as keys for matching
+    between data (from the database) and palette. {\bf The {\tt
+    parameter-ids} have to been in sync with the database parameters
+    (normally in {\tt MEDIAN.Parameter})}
+    \item {\tt description}: a description.
+    \item {\tt file}: reference to the defintion of the palette.
+\end{itemize}
+
+For defining ranges for a palette, a range is definied by:
+
+\begin{itemize}
+    \item {\tt index}: Index for accessing the explicit range from the
+    program logic. 
+    \item {\tt from}: lower limit of a range.
+    \item {\tt to}: upper limit of a range
+    \item {\tt rgb}: Red-Green-Blue (RGB) value for rendering the range
+    \item {\tt description}: description for rendering the legend. For
+    special characters use HTML-encoded values like {\tt \&lt;} for $<$
+    or {\tt \&gt;} for $>$.
 \end{itemize}
 
 
 \paragraph*{horizontal-cross-section-profile}
 
-{\em Function}: 
+{\em Function}: Parameterization for the interpolation algorithm for
+horizontal-cross-section-profile calculating the interpolated value
+along the distance.
 
 \begin{itemize}
-    \item {\tt }:
+    \item {\tt samples}: Number of samples calculated for a
+    interpolation along the passed geometric line.
 \end{itemize}
 
 
 \paragraph*{vertical-cross-section}
-{\em Function}: 
+{\em Function}: Parameterization for the interpolation algorithm for
+vertical-cross-sections (2D-charts).
 
 \begin{itemize}
-    \item {\tt }:
+    \item {\tt samples}: Parameters for defining the interpolation grid.
+    {\tt width} for horizontal distances; {\tt height} for the vertical
+    distance.
+    \item {\tt ground}: {\tt interpolation} method for calculating the
+    interpolation from the last measured value against the seafloor.
+    Available methods are {\tt nearest-neighbor | bilinear | bicubic}.\\
+%%    FIXME: Could not find nn and bicubic in the code ...
+    {\tt fill-color}: setting the file color for the seafloor in the
+    diagram.
 \end{itemize}
--- a/doc/config-manual/model_of_transitions.tex	Mon May 10 14:19:58 2010 +0000
+++ b/doc/config-manual/model_of_transitions.tex	Mon May 10 19:41:15 2010 +0000
@@ -290,9 +290,9 @@
     \item {\tt type}: The type of the value. This is required for the validation 
                 of the value.
                 This might be String, Integer, Double, Date, Point, LineString, 
-                Polygon, Coordinate, Geometry and AttributeName.
+                Polygon, Coordinate, Geometry and AttributeName. \\
                 Coordinate is a format which accepts geographical coordinates in 
-                the following Syntax: 56n30 6e20
+                the following Syntax: 56n30 6e20 \\
                 AttributeName marks a stringvalue which will be used in 
                 SQL-statement without surrounding with "'" in the statement.
                 Usage is e.g. for determining the Axis (i or j) in the workflow

http://dive4elements.wald.intevation.org