Mercurial > dive4elements > gnv-client

annotate doc/config-manual/generating_charts.tex @ 945:491b8d6cd291

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
parents 2d84fc30ab58
children 9a28846dfb9c
rev   line source
938
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
1 \subsection{Generating Charts -- Background Information and Configuration}
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
2
945
491b8d6cd291 Added content about generating charts
Hans Plum <hans.plum@intevation.de>
parents: 938
diff changeset
3 The artifact-server is able to render different types of charts like 1D
491b8d6cd291 Added content about generating charts
Hans Plum <hans.plum@intevation.de>
parents: 938
diff changeset
4 (timeseries, vertical- and horizontalprofiles, horizontal-cross-section
491b8d6cd291 Added content about generating charts
Hans Plum <hans.plum@intevation.de>
parents: 938
diff changeset
5 profiles (a special case of the horizontalprofiles) and histograms) and 2D-diagrams
491b8d6cd291 Added content about generating charts
Hans Plum <hans.plum@intevation.de>
parents: 938
diff changeset
6 (vertical-cross section profiles). This section describes the
491b8d6cd291 Added content about generating charts
Hans Plum <hans.plum@intevation.de>
parents: 938
diff changeset
7 possibilities to configure different aspects for interpolating of data and
491b8d6cd291 Added content about generating charts
Hans Plum <hans.plum@intevation.de>
parents: 938
diff changeset
8 visualising them in charts.
938
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
9
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
10 \begin{lstlisting}
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
11 artifact-database
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
12 `-- gnv # charts, palettes, interpolation parameters
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
13 |-- charttemplate
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
14 |-- palettes
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
15 |-- horizontal-cross-section-profile
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
16 `-- vertical-cross-section
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
17 \end{lstlisting}
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
18
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
19 \paragraph*{charttemplate}
945
491b8d6cd291 Added content about generating charts
Hans Plum <hans.plum@intevation.de>
parents: 938
diff changeset
20 {\em Function}: The chart template is a global template for setting the
491b8d6cd291 Added content about generating charts
Hans Plum <hans.plum@intevation.de>
parents: 938
diff changeset
21 visualization of charts globally like font styles, background, title,
491b8d6cd291 Added content about generating charts
Hans Plum <hans.plum@intevation.de>
parents: 938
diff changeset
22 subtitle, etc. Further information can be found in the configuration
491b8d6cd291 Added content about generating charts
Hans Plum <hans.plum@intevation.de>
parents: 938
diff changeset
23 file referenced via the attribute {\tt configuration}.
938
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
24
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
25 \begin{itemize}
945
491b8d6cd291 Added content about generating charts
Hans Plum <hans.plum@intevation.de>
parents: 938
diff changeset
26 \item {\tt configuration}: path to the configuration XML-file.
938
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
27 \end{itemize}
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
28
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
29
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
30 \paragraph*{palettes}
945
491b8d6cd291 Added content about generating charts
Hans Plum <hans.plum@intevation.de>
parents: 938
diff changeset
31 {\em Function}: This section lists the available palettes used for rendering
491b8d6cd291 Added content about generating charts
Hans Plum <hans.plum@intevation.de>
parents: 938
diff changeset
32 vertical-cross-section charts (2D). Each {\tt palette}-element contains
491b8d6cd291 Added content about generating charts
Hans Plum <hans.plum@intevation.de>
parents: 938
diff changeset
33 the following attributes:
938
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
34
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
35 \begin{itemize}
945
491b8d6cd291 Added content about generating charts
Hans Plum <hans.plum@intevation.de>
parents: 938
diff changeset
36 \item {\tt name}: a descriptive name.
491b8d6cd291 Added content about generating charts
Hans Plum <hans.plum@intevation.de>
parents: 938
diff changeset
37 \item {\tt parameter-ids}: identifier used as keys for matching
491b8d6cd291 Added content about generating charts
Hans Plum <hans.plum@intevation.de>
parents: 938
diff changeset
38 between data (from the database) and palette. {\bf The {\tt
491b8d6cd291 Added content about generating charts
Hans Plum <hans.plum@intevation.de>
parents: 938
diff changeset
39 parameter-ids} have to been in sync with the database parameters
491b8d6cd291 Added content about generating charts
Hans Plum <hans.plum@intevation.de>
parents: 938
diff changeset
40 (normally in {\tt MEDIAN.Parameter})}
491b8d6cd291 Added content about generating charts
Hans Plum <hans.plum@intevation.de>
parents: 938
diff changeset
41 \item {\tt description}: a description.
491b8d6cd291 Added content about generating charts
Hans Plum <hans.plum@intevation.de>
parents: 938
diff changeset
42 \item {\tt file}: reference to the defintion of the palette.
491b8d6cd291 Added content about generating charts
Hans Plum <hans.plum@intevation.de>
parents: 938
diff changeset
43 \end{itemize}
491b8d6cd291 Added content about generating charts
Hans Plum <hans.plum@intevation.de>
parents: 938
diff changeset
44
491b8d6cd291 Added content about generating charts
Hans Plum <hans.plum@intevation.de>
parents: 938
diff changeset
45 For defining ranges for a palette, a range is definied by:
491b8d6cd291 Added content about generating charts
Hans Plum <hans.plum@intevation.de>
parents: 938
diff changeset
46
491b8d6cd291 Added content about generating charts
Hans Plum <hans.plum@intevation.de>
parents: 938
diff changeset
47 \begin{itemize}
491b8d6cd291 Added content about generating charts
Hans Plum <hans.plum@intevation.de>
parents: 938
diff changeset
48 \item {\tt index}: Index for accessing the explicit range from the
491b8d6cd291 Added content about generating charts
Hans Plum <hans.plum@intevation.de>
parents: 938
diff changeset
49 program logic.
491b8d6cd291 Added content about generating charts
Hans Plum <hans.plum@intevation.de>
parents: 938
diff changeset
50 \item {\tt from}: lower limit of a range.
491b8d6cd291 Added content about generating charts
Hans Plum <hans.plum@intevation.de>
parents: 938
diff changeset
51 \item {\tt to}: upper limit of a range
491b8d6cd291 Added content about generating charts
Hans Plum <hans.plum@intevation.de>
parents: 938
diff changeset
52 \item {\tt rgb}: Red-Green-Blue (RGB) value for rendering the range
491b8d6cd291 Added content about generating charts
Hans Plum <hans.plum@intevation.de>
parents: 938
diff changeset
53 \item {\tt description}: description for rendering the legend. For
491b8d6cd291 Added content about generating charts
Hans Plum <hans.plum@intevation.de>
parents: 938
diff changeset
54 special characters use HTML-encoded values like {\tt \&lt;} for $<$
491b8d6cd291 Added content about generating charts
Hans Plum <hans.plum@intevation.de>
parents: 938
diff changeset
55 or {\tt \&gt;} for $>$.
938
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
56 \end{itemize}
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
57
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
58
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
59 \paragraph*{horizontal-cross-section-profile}
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
60
945
491b8d6cd291 Added content about generating charts
Hans Plum <hans.plum@intevation.de>
parents: 938
diff changeset
61 {\em Function}: Parameterization for the interpolation algorithm for
491b8d6cd291 Added content about generating charts
Hans Plum <hans.plum@intevation.de>
parents: 938
diff changeset
62 horizontal-cross-section-profile calculating the interpolated value
491b8d6cd291 Added content about generating charts
Hans Plum <hans.plum@intevation.de>
parents: 938
diff changeset
63 along the distance.
938
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
64
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
65 \begin{itemize}
945
491b8d6cd291 Added content about generating charts
Hans Plum <hans.plum@intevation.de>
parents: 938
diff changeset
66 \item {\tt samples}: Number of samples calculated for a
491b8d6cd291 Added content about generating charts
Hans Plum <hans.plum@intevation.de>
parents: 938
diff changeset
67 interpolation along the passed geometric line.
938
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
68 \end{itemize}
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
69
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
70
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
71 \paragraph*{vertical-cross-section}
945
491b8d6cd291 Added content about generating charts
Hans Plum <hans.plum@intevation.de>
parents: 938
diff changeset
72 {\em Function}: Parameterization for the interpolation algorithm for
491b8d6cd291 Added content about generating charts
Hans Plum <hans.plum@intevation.de>
parents: 938
diff changeset
73 vertical-cross-sections (2D-charts).
938
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
74
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
75 \begin{itemize}
945
491b8d6cd291 Added content about generating charts
Hans Plum <hans.plum@intevation.de>
parents: 938
diff changeset
76 \item {\tt samples}: Parameters for defining the interpolation grid.
491b8d6cd291 Added content about generating charts
Hans Plum <hans.plum@intevation.de>
parents: 938
diff changeset
77 {\tt width} for horizontal distances; {\tt height} for the vertical
491b8d6cd291 Added content about generating charts
Hans Plum <hans.plum@intevation.de>
parents: 938
diff changeset
78 distance.
491b8d6cd291 Added content about generating charts
Hans Plum <hans.plum@intevation.de>
parents: 938
diff changeset
79 \item {\tt ground}: {\tt interpolation} method for calculating the
491b8d6cd291 Added content about generating charts
Hans Plum <hans.plum@intevation.de>
parents: 938
diff changeset
80 interpolation from the last measured value against the seafloor.
491b8d6cd291 Added content about generating charts
Hans Plum <hans.plum@intevation.de>
parents: 938
diff changeset
81 Available methods are {\tt nearest-neighbor | bilinear | bicubic}.\\
491b8d6cd291 Added content about generating charts
Hans Plum <hans.plum@intevation.de>
parents: 938
diff changeset
82 %% FIXME: Could not find nn and bicubic in the code ...
491b8d6cd291 Added content about generating charts
Hans Plum <hans.plum@intevation.de>
parents: 938
diff changeset
83 {\tt fill-color}: setting the file color for the seafloor in the
491b8d6cd291 Added content about generating charts
Hans Plum <hans.plum@intevation.de>
parents: 938
diff changeset
84 diagram.
938
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
85 \end{itemize}
http://dive4elements.wald.intevation.org