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