[Wsplgen-commits] r19 - trunk/doc/Feinkonzept
scm-commit at wald.intevation.org
scm-commit at wald.intevation.org
Tue Dec 20 22:32:16 CET 2005
Author: mrchip
Date: 2005-12-20 22:32:15 +0100 (Tue, 20 Dec 2005)
New Revision: 19
Modified:
trunk/doc/Feinkonzept/WSPLGEN-Feinkonzept.tex
Log:
Die Struktur wurde etwas verbessert und es wurde begonnen, die Dateiformatbeschreibungen aufzunehmen.
Modified: trunk/doc/Feinkonzept/WSPLGEN-Feinkonzept.tex
===================================================================
--- trunk/doc/Feinkonzept/WSPLGEN-Feinkonzept.tex 2005-12-17 21:26:49 UTC (rev 18)
+++ trunk/doc/Feinkonzept/WSPLGEN-Feinkonzept.tex 2005-12-20 21:32:15 UTC (rev 19)
@@ -33,7 +33,7 @@
\RCS$Id$
\RCS$Revision$
-\newcommand{\documentdate}{11. Dezember 2005}
+\newcommand{\documentdate}{17. Dezember 2005}
\newcommand{\documentversion}{\RCSRevision}
\newcommand{\documentID}{\RCSId}
%----------------------------------------------
@@ -168,6 +168,13 @@
\hyphenation{Intevation}
% end macro definition
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\newcounter{schritt}
+\renewcommand{\theschritt}{Schritt~\Roman{schritt}~-~}
+\makeatletter\renewcommand{\p at schritt}{Abschnitt~\thesubsubsection~}\makeatother
+
+
%-----------------------------------
% DOCUMENT SETTINGS
\pagestyle{fancy}
@@ -224,7 +231,7 @@
{
\tableofcontents
%
-%\listoffigures
+\listoffigures
%
%\listoftables
%EDIT HERE
@@ -256,31 +263,51 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\subsubsection{Schritt 1: Auswertung der Kommandozeilenparameter}
+\refstepcounter{schritt}
+\subsubsection{\theschritt Auswertung der Kommandozeilenparameter}
+Als erstes werden von WSPLGEN die Kommandozeilenparameter ausgewertet.
+Sollte das Programm hierbei unbekannte Optionen oder ungültige
+Argumente zu den Optionen finden, so wird ein Fehler generiert
+(siehe Abschnitt~\ref{subsubsec:file-prot}). Werden Optionen mehrfach verwendet
+(z.B. bei der Angabe einer Option in der Kommandozeile und gleichzeitiger
+Verwendung der gleichen Option in der Parameterdatei (siehe Abschnitt \ref{subsubsec:param-par}), so wird
+nur das erste Auftreten in der Kommandozeile berücksichtigt und eine Warnung
+generiert (siehe Abschnitt~\ref{subsubsec:file-prot}). Die zulässigen
+Kommandozeilenoptionen und ihre Argumente findet man in
+Abschnitt~\ref{subsec:param}.
+
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\subsubsection{Schritt 2: Einlesen der Eingabedaten}
+\refstepcounter{schritt}
+\subsubsection{\theschritt Einlesen der Eingabedaten}
+Die wichtigsten Kommandozeilenparameter bestimmen welche Dateien, das Programm
+einlesen soll und in welche Dateien es die Ausgaben schreiben soll.
+Wird das Programm angewiesen eine Datei zu lesen, die nicht existiert, die
+aus einem anderen Grund (z.B. ungenügende Rechte) nicht gelesen werden kann
+oder die in einem unbekannten oder fehlerhaften Format vorliegt, so wird
+eine Fehlermeldung generiert (siehe Abschnitt~\ref{subsubsec:file-prot}).
+
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\paragraph{Digitales Geländemodell (DGM)}
\verb; ;
-WSPLGEN liest zuerst ein digitales Geländemodell (DGM), das durch seine Größe
+WSPLGEN liest zuerst ein digitales Geländemodell (DGM) ein, das durch seine Größe
auch gleichzeitig die maximal mögliche Ausdehnung des Ergebnisses festlegt.
Das DGM muss für die weitere Bearbeitung als vermaschtes Netz vorliegen.
\begin{center}
-\includegraphics[width=10cm,keepaspectratio]{abbildungen/abb_netz.eps}
+\Fig{\includegraphics[width=10cm,keepaspectratio]{abbildungen/abb_netz.eps}}{Ein ganz kleiner Ausschnitt aus einem DGM als vermaschtes Netz}{Ausschnitt eines DGM als vermschtes Netz}
\end{center}
-Die verschiedenen möglichen Formate des DGM werden in Abschnitt~\ref{subsubsec:dgm}
-genauer spezifiziert. Wir ein Format für das DGM gewählt, das keine vermaschtes Netz
-darstellt (z.b. ein ASCII-Datei mit X,Y,Z-Tripeln) so wird nach dem Einlesen der Punkte
-eine automatische Triangulierung durchgeführt (siehe Abschnitt~\ref{subsubsec:triang}).
+Die verschiedenen möglichen Formate des DGM werden in Abschnitt~\ref{subsubsec:file-dgm}
+genauer spezifiziert. Wird ein Format für das DGM gewählt, das kein vermaschtes Netz
+darstellt (z.B. eine ASCII-Datei mit X,Y,Z-Tripeln) so wird nach dem Einlesen der Punkte
+eine automatische Triangulierung durchgeführt (siehe Abschnitt~\ref{subsubsec:schritt-triang}).
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -304,10 +331,10 @@
zu interpolieren.
\begin{center}
-\includegraphics[width=10cm,keepaspectratio]{abbildungen/abb_profil.eps}
+\Fig{\includegraphics[width=10cm,keepaspectratio]{abbildungen/abb_profil.eps}}{Lage von drei Gewässerquerprofilen}{Gewässerquerprofile}
\end{center}
-Das genaue Format der Querprofile wird in Abschnitt~\ref{subsubsec:profile}
+Das genaue Format der Querprofile wird in Abschnitt~\ref{subsubsec:file-profile}
genauer spezifiziert.
@@ -319,99 +346,219 @@
Als nächstes werden die Wasserstände eingelesen, die den Gewässerquerprofile
zugeordnet sind. Sollte einem Gewässerquerprofil kein Wasserstand
-direkt zugeordnet werden könnne, so wird versucht einen Wasserstand linear
+direkt zugeordnet werden können, so wird versucht einen Wasserstand linear
aus stromauf und stromab liegenden Wasserständen zu interpolieren. Sollte
dies nicht möglich sein, weil entweder kein stromauf oder kein
stromab liegender Wasserstand definiert wurde, so wird eine Fehlermeldung
-generiert (siehe Abschnitt~\ref{subsec:fehler}) und das Programm beendet.
+generiert (siehe Abschnitt~\ref{subsubsec:file-prot}) und das Programm beendet.
Es kann immer nur ein Wasserstand pro Profil verwendet werden. Sollten doch
mehrere Wasserstände einem Profil zugeordnet sein, so wird nur der erste
Wasserstand verwendet und eine entsprechende Warnung generiert
-(siehe Abschnitt~\ref{subsec:fehler}).
+(siehe Abschnitt~\ref{subsubsec:file-prot}).
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\subsubsection{Schritt 3: Verdichtung der Wasserstände}
+\paragraph{Sperren und Brüche (optional)}
-Im Moment wird von sinnvoll geknickten Querprofilen ausgegangen, die
-ein lineares Interpolieren zwischen den Querprofilen ermöglichen.
+\verb; ;
-Um einen sinnvollen Wert für die
+Um sowohl Brüche als auch den Neubau von Hochwasserschutzdämmen simulieren
+zu können, ohne das DGM verändern zu müssen, ist es möglich eine weitere
+Datei mit Linien im ESI SHAPE-Format einzulesen.
+In dieser Datei muss allen Polylinien ein Attribut zugeordnet
+sein. Diese Attribut bestimmt, ob es sich bei einer Linie um eine
+Sperre handelt (Wert \verb;SPERRE;), also Wasser diese Linie
+nicht übersteigen kann, oder ob es sich um einen 'Bruch' handelt
+(Wert \verb;BRUCH;), also Wasser in jedem Fall entlang der
+Linie transportiert wird.
+
+Sperren bzw. Brüche können nicht zusammen mit der Option \verb;-GEL;
+verwendet werden (siehe Abschnitt~\ref{subsubsec:param-gel}.
+
+
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\subsubsection{Schritt 4: Triangulierung (optional)}\label{subsubsec:triang}
+\refstepcounter{schritt}
+\subsubsection{\theschritt Triangulierung (optional)}\label{subsubsec:schritt-triang}
+Wird das DGM nicht in einem Format zur Verfügung gestellt, das ein
+vermaschtes Netz repräsentiert, sondern nur unabhängige Knoten, so wird
+von WSPLGEN ein vermaschtes Netz erzeugt.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\subsubsection{Schritt 5: Übertragung der Wasserstände auf das DGM}
+\refstepcounter{schritt}
+\subsubsection{\theschritt Verdichtung der Wasserstände}
+Im Moment wird von sinnvoll geknickten Querprofilen ausgegangen, die
+ein lineares Interpolieren von zusätzlichen Querprofilen zwischen
+den verhandenen Querprofilen ermöglichen.
+Als sinnvollen Wert für den Abstand der zu interpolierten
+Querprofile, wird der mittlere Abstand der Knoten im DGM benutzt.
+Wenn das DGM also großmaschig ist, werden weniger Profile interpoliert,
+als wenn das DGM feinmaschiger ist.
+
+
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\subsubsection{Schritt 6: Extrapolation der Wasserstände}
+\refstepcounter{schritt}
+\subsubsection{\theschritt Übertragung der Wasserstände auf das DGM}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\subsubsection{Schritt 7: Generierung der Isolinien gleicher Wasserstände}
+\refstepcounter{schritt}
+\subsubsection{\theschritt Extrapolation der Wasserstände}
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+\refstepcounter{schritt}
+\subsubsection{\theschritt Generierung der Isolinien gleicher Wasserstände}
+
+
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\section{Definition der Eingabedaten}
+\refstepcounter{schritt}
+\subsubsection{\theschritt Schreiben der Ausgabedaten}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\subsection{Kommandozeilen Parameter}\label{subsubsec:para}
+\section{Eingabedaten}
Die Eingabedaten werden in der grafischen Bedieneroberfläche definiert und
per Kommandozeilenparameter oder Parameterdatei und über verschiedene
Eingabedateien an das Programm WSPLGEN übergeben. Eine erste Überprüfung
-auf Vollständigkeit und Sinnhaftigkeit muss in der GUI erfolgen. Als Daten
-werden von WSPLGEN zwingend benötigt:
+auf Vollständigkeit und Sinnhaftigkeit sollte in der GUI erfolgen, da WSPLGEN
+bei den meisten Problemen nur einen Fehler generiert
+(siehe Abschnitt~\ref{subsubsec:file-prot}) oder Standardwerte benutzt,
+die nicht immer den eigentlichen Willen, des Benutzers wiedergeben. Beim
+letztgenannten Verhalten wird in jedem Fall eine Warnung generiert und
+eine entsprechende Meldung protokoliert (siehe Abschnitt~\ref{subsubsec:file-prot}).
-\begin{itemize}
-\item[a.] ein digitales Geländemodell (DGM),
-\item[b.] die Lage von Gewässerquerprofilen,
-\item[c.] Wasserstände, die den Gewäserquerprofilen zugeordnet werden können.
-\end{itemize}
-Optional können noch die folgenden Parameter und Daten zur Feinsteuerung der
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\subsection{Kommandozeilen Parameter}\label{subsec:param}
+
+Optional können noch die folgenden Parameter zur Feinsteuerung der
Arbeitsweise von WSPLGEN übergeben werden:
-\begin{itemize}
-\item[d.] Wassersperren bzw. Durchbrüche, die die Daten im DGM übersteuern.
-\item[e.] Parameter zur Steuerung folgender Änderungen der Arbeitsweise:
-\item[e.1] Angabe, ob die Wasserstände durch Geländeerhebungen hindurch getragen
- werden sollen. Dies würde ein potenziel gefährdetes Gebiet im Hinterland
- produzieren, welches aber immer in etwa den Gradienten im Fluss aufweisen
- würde (keine sinnvolle Wiedergabe von eingestauten Flächen). Eine
- Verwendung mit den Daten aus d. Wäre nicht sinnvoll und würde in der GUI
- verhindert.
-\item[e.2] Angabe in welchen Abstufungen die Wassertiefenpolygone generiert
- werden sollen.
-% Angaben über den Ursprung der Daten als beschreibenden Text und eine
-% mögliche Kommentierung werden im Datenkorb verwaltet.
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\end{itemize}
+\subsubsection{Parameter -PAR (Parameterdatei)}\label{subsubsec:param-par}
+Die Option \verb;-PAR; bestimmt, ob weitere Parameter in einer Parameterdatei enthalten sind.
+Da die Beschränkung der Kommandozeile bei Windows in Kombination mit
+langen Pfadnamen leicht zu Problemen führen kann, wird auch die
+Zusammenfassung aller Parameter in einer Parameterdatei vorgesehen.
+Wird sie verwendet, wird zunächst die Kommandozeile weiter ausgewertet
+und danach zusätzlich weitere Parameter in der Parameterdatei.
+
+In jeder Zeile dieser Datei würde dann ein Parameter stehen, der vom
+Aufbau genau den Anforderungen entspricht, wie sie auch direkt auf
+der Kommandozeile bestehen.
+
+Der Name der Parameterdatei wäre dann das einzige Argument der Option \verb;-PAR;.
+
+Format: \verb;-PAR=<Pfad>;
+
+Beispiel: \verb;-PAR=C:\TEMP\WSPLGEN.PAR;
+
+
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\subsection{Eingabedateien}
+\subsubsection{Parameter -DELTA (Abstufungen der Wassertiefen)}\label{subsubsec:param-delta}
+Die Option \verb;-DELTA; bestimmt, in welchen Abstufungen die Wassertiefenpolygone
+generiert werden sollen, die Isolinien gleicher Wassertiefe repräsentieren.
+Die entsprechenden Wassertiefen werden aus den Argumenten \verb;<Von>;, \verb;<Bis>; und \verb;<Diff>;
+Begonnen wird mit der Wassertiefe \verb;<Von>; (die nicht negativ sein darf) und danach solange die
+Wassertiefen um den Wert von \verb;<Diff>; erhöht, bis eine Wassertiefe größer als \verb;<Bis>; ist.
+
+Wird das Argument \verb;<Von>; ausgelassen (das Komma wird dann das erste Zeichen hinter dem Gleichheitszeichen), wird für \verb;<Von>;
+der Wert 0,00 angenommen.
+
+Wird das Argument \verb;<Bis>; ausgelassen (es gibt dann zwei Kommata hintereinander), wird der
+maximale Wert der ermittelten Wasserstände für \verb;<Bis>; angenommen.
+
+Wird das Argument \verb;<Diff>; ausgelassen (das Komma wird dann zum letzten Zeichen dieses Parameters),
+wird für \verb;<Diff>; die auf zwei Nachkommastellen gerundete und durch 10 geteilte Differenz
+zwischen \verb;<Bis>; und \verb;<Von>; angenommen.
+
+Man kann auch ganz auf den Parameter verzichten, was dem Ausruf \verb;-DELTA=,,; entspricht.
+
+Format: \verb;-DELTA=[<Von>],[<Bis>],[<Diff>];
+
+Beispiel: \verb;-DELTA=1.0,2.0,0.25;
+
+In diesem Beispiel werden die Isolinien für 5 verschiedene Wassertiefen
+erzeugt (1,00, 1,25, 1,50, 1,75 und 2,00).
+
+Beispiel: \verb;-DELTA=0.9,2.1,0.25;
+
+Auch in diesem Beispiel werden die Isolinien für 5 verschiedene Wassertiefen
+erzeugt (0,90, 1,15, 1,40, 1,65 und 1,90), da der nächste Schritt 2,15 größer
+als 2,10 ist.
+
+Beispiel: \verb;-DELTA=,1.0,0.25;
+
+In diesem Beispiel so werden die Isolinien für 5 verschiedene Wassertiefen
+erzeugt (0,00, 0,25, 0,50, 0,75 und 1,00).
+
+Beispiel: \verb;-DELTA=,,0.25;
+
+Ist der größte Wasserstand z.B. 2,345, so werden die Isolinien für 5 verschiedene Wassertiefen
+erzeugt (0,00, 0,25, 0,50, 0,75, 1,00, 1,25, 1,50, 1,75, 2,00 und 2,25) erzeugt.
+
+Beispiel: \verb;-DELTA=1.3,,;
+
+Ist der größte Wasserstand z.B. 2,345, so werden die Isolinien für 11 verschiedene Wassertiefen
+(1,3, 1,4, 1,5, 1,6, 1,7, 1,8, 1,9, 2,0, 2,1, 2,2 und 2,3) erzeugt, da die Differenz von
+2,345 und 1,3 den Wert 1,045 ergibt und damit ein Wert von 0,10 für \verb;<Diff>; verwendet wird.
+
+Beispiel: \verb;-DELTA=,,;
+
+In diesem Beispiel werden alle Argumente automatisch bestimmt.
+
+
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\subsubsection{Digitales Geländemodell (DGM)}\label{subsubsec:dgm}
+\subsubsection{Parameter -GEL (Einfluss von Geländeerhebungen)}\label{subsubsec:param-gel}
+Die Option \verb;-GEL; bestimmt, ob die Wasserstände durch Geländeerhebungen
+hindurch getragen werden sollen. Dies würde ein potenziel gefährdetes Gebiet im Hinterland
+produzieren, welches aber immer in etwa den Gradienten im Fluss aufweisen
+würde (keine sinnvolle Wiedergabe von eingestauten Flächen). Eine
+Verwendung mit den Daten aus \ref{param-lin} ist nicht sinnvoll und sollte in der GUI
+verhindert werden. Wird der Parameter mit Sperren bzw. Brüchen angegeben,
+wird eine Fehler generiert (siehe Abschnitt~\ref{subsubsec:file-prot}).
+
+Wird der Parameter \verb;-GEL; nicht angegeben, so wird der Wert \verb;SPERRE; angenommen,
+es wird also mit Einstau gearbeitet.
+
+Format: \verb;-GEL=<SPERRE|NOSPERRE>;
+
+Beispiel: \verb;-GEL=NOSPERRE;
+
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\subsubsection{Parameter -DGM (Digitales Geländemodell)}\label{subsubsec:param-dgm}
+
+Die Optionen \verb;-DGM; bestimmt mit welcher Datei das DGM bestimmt.
+
+Die Art der Daten wir von dem Programm WSPLGEN selbst erkannt und
+eine Plausibilitätprüfung des DGM vorgenommen.
+
Das DGM muss entweder ein Punktthema im SHAPE-oder ASCII-Format sein
(X,Y,Z-Tripel), ein Grid, wie es vom Spatial Analyst verwendet wird,
oder ein TIN, wie es der 3D-Analyst verwendet. Vorzuziehen wäre ein
@@ -428,20 +575,18 @@
wiedergegeben werden können, da ein Grid immer nur eine
rechteckige ,,Vermaschung'' unterstützt.
-Der komplette Pfad der Datei mit den DGM-Daten wird dem Programm WSPLGEN
-mit dem Parameter \verb;-DGM; übergeben. Die Art der Daten wir von
-dem Programm WSPLGEN selbst erkannt und eine Plausibilitätprüfung des DGM
-vorgenommen.
+Format: \verb;-DGM=<Pfad>;
-Parameter Format: \verb;-DGM=<Pfad>;
+Beispiel: \verb;-DGM=C:\DATEN\WESER\DGM.XYZ;
-Parameter Beispiel: \verb;-DGM=C:\DATEN\WESER\DGM.XYZ;
-
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\subsubsection{Lage von Gewässerquerprofilen}\label{subsubsec:profile}
+\subsubsection{Parameter -PRO (Lage der Querprofile)}\label{subsubsec:param-profile}
+Die Optionen \verb;-PRO; bestimmt mit welcher Datei die Lage der
+Querprofile bestimmt wird.
+
Die Lage der Gewässerquerprofile wird immer als Polylinien-Thema in einer
Shape-Datei übergeben. Die Profile können dabei beliebige Knicke
enthalten. Jeder Profilspur ist ein Gewässer bzw. Gewässerbereich und eine
@@ -454,23 +599,23 @@
Profillagen vorgenommen (z.B. mittlerer Abstand der Profilspuren und
Differenz der Stationierung)
-Parameter Format: \verb;-PRO=<Pfad>;
+Format: \verb;-PRO=<Pfad>;
-Parameter Beispiel: \verb;-PRO=C:\DATEN\WESER\120-129.SHP;
+Beispiel: \verb;-PRO=C:\DATEN\WESER\120-129.SHP;
-
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\subsubsection{Wasserstände}\label{subsubsec:wsp}
+\subsubsection{Parameter -WSP (Wasserstände)}\label{subsubsec:param-wsp}
+Die Optionen \verb;-WSP; bestimmt mit welcher Datei die Wasserstände
+bestimmt werden, die den Querprofilen zugeordnet werden sollen.
+
Die Wasserstände werden als Tabelle im ASCII oder DBF-Format übergeben.
Dabei muss eine eindeutige Zuordnung zu den Gewässerquerprofilen möglich
sein. Eine Tabelle sollte also 3 Spalten (Gewässerbereich, Stationierung
und Wasserstand enthalten).
-Der komplette Pfad der Datei mit den Wasserständen wird dem Programm
-WSPLGEN mit dem Parameter \verb;-WSP; übergeben. Die Art
-der Daten wird von dem Programm WSPLGEN selbst erkannt und eine
+Die Art der Daten wird von dem Programm WSPLGEN selbst erkannt und eine
Plausibilitätprüfung der Wasserstände vorgenommen (z.B. Kontinuierliches
Abnehmen der Wasserstände mit bzw. gegen die Stationierung).
@@ -481,64 +626,137 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\subsection{Wassersperren bzw. Durchbrüche, die die Daten im DGM übersteuern}
+\subsubsection{Parameter -LIN (Sperren und Brüche)}\label{param-lin}
-Die optionalen Wassersperren bzw. Durchbrüche werden in Form eines
-Polylinien Themas im Shape-Format übergeben. Jede Linie ist dabei mit dem
-Attribut für Bruch oder Sperre zu versehen.
+Die Optionen \verb;-LIN; bestimmt mit welcher Datei die Sperren
+bzw. Durchbrüche bestimmt werden.
+Format: \verb;-LIN=<Pfad>;
-Der komplette Pfad der Datei mit den Linien wird dem Programm
-WSPLGEN mit dem Parameter \verb;-LIN; übergeben.
+Beispiel: \verb;-LIN=C:\TEMP\BREAK.SHP;
-Parameter Format: \verb;-LIN=<Pfad>;
-Parameter Beispiel: \verb;-LIN=C:\TEMP\BREAK.SHP;
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+\subsubsection{Parameter -AUSGABE (Ausgabedatei)}\label{subsubsec:param-ausgabe}
-\subsection{Angabe, ob die Wasserstände durch Geländeerhebungen hindurch getragen
- werden sollen}
+Als Ausgabedaten generiert das Programm WSPLGEN bei fehlerfreier Ausführung
+eine Shape-Datei, in der Polygone enthalten sind, deren Umgrenzung Isolinien
+gleicher Wassertiefe repräsentieren (siehe Abschnitt~\ref{subsubsec:file-ausgabe}). Wird
+dieser Parameter nicht angegeben, so wird als Ausgabedateiname ein Standardwert
+angenommen.
-Der Paramter wird über die Kommandozeile in der Form
-\verb.-GEL=[SPERR|NOSPERR]. übergeben (z.B. \verb.-GEL=NOSPERR.). Wird der
-Parameter nicht übergeben, so wird das Gelände als Sperre dienen. Es werden
-dann nur eingestaute Bereiche mit konstantem Wasserstand generiert.
+Format: \verb;-AUSGABE=<Pfad>;
+Beispiel: \verb;-AUSGABE=C:\TEMP\WSPLGEN.SHP;
+Standardwert: \verb;WSPLGEN.SHP;
+
+
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\subsection{Angabe zur Abstufung der Wassertiefenpolygone}
+\subsubsection{Parameter -FORT (Fortschritt)}\label{subsubsec:param-fort}
-Der Parameter wird über die Kommandozeile in der Form\newline
-\verb.-DELTA=<von>,<bis>,<diff>. übergeben (z.B. \verb:-DELTA=0.0,1.5,0.25:).
-Wird der Parameter nicht übergeben, so wird nur die Nass-Trocken-Linie
-generiert, was den Werten \verb:<von>=0.0:, \verb:<bis>=0.0: und
-\verb:<diff>=0.0: entspricht. Sonst werden auch Polygone generiert, die
-verschiedene Wassertiefen repräsentieren.
+Während der Generierung wird der Fortschritt kontinuierlich in einer
+Fortschrittsdatei aktualisiert, so dass die GUI in der Lage ist,
+den Fortschritt anzuzeigen (siehe Abschnitt~\ref{subsubsec:file-fort}).
+Format: \verb;-FORT=<Pfad>;
+Beispiel: \verb;-FORT=C:\TEMP\WSPLGEN.STA;
+
+
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\section{Ausgabedaten}
+\subsubsection{Parameter -PROT (Protokoll)}\label{subsubsec:param-prot}
-\subsection{Ergebnisdatei}
+In einer Protokolldatei werden Warnungen und Fehler gespeichert,
+so dass der Benutzer nach dem Lauf überprüfen kann, ob alles zu
+seiner Zufriedenheit erledigt werden konnte oder es Probleme gegeben hat.
+(siehe Abschnitt~\ref{subsubsec:file-prot})
+Eine direkte Interaktion mit dem Programm WSPLGEN ist nicht vorgesehen.
+Sollte es also Fehler oder Warnungen gegeben haben, die der Benutzer
+nicht ignorieren will, so muss er die Eingabedaten oder Parameter
+ändern und einen erneuten Lauf starten. Die Meldungen sind aber
+so aussagekräftig, dass sie dem Benutzer optimale Hinweise für sein
+weiteres Vorgehen liefern (siehe Abschnitt~\ref{subsubsec:file-prot}).
+
+Wenn eine sinnvolle Shape-Datei erzeugt werden konnte (keine Fehler),
+so kann in einer GUI die weitere Visualisierung stattfinden.
+
+Format: \verb;-PROT=<Pfad>;
+
+Beispiel: \verb;-PROT=C:\TEMP\WSPLGEN.LOG;
+
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\subsection{Zwingend erforderliche Eingabedateien}
+
+Folgende Daten werden von WSPLGEN zwingend benötigt.
+
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\subsubsection{Datei Digitales Geländemodell (DGM)}\label{subsubsec:file-dgm}
+
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\subsubsection{Datei Lage der Querprofile}\label{subsubsec:file-profile}
+
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\subsubsection{Datei Wasserstände}\label{subsubsec:file-wsp}
+
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\subsection{Optionale Eingabedateien}
+
+Optional können noch die folgenden Daten zur Feinsteuerung der
+Arbeitsweise von WSPLGEN übergeben werden:
+
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\subsubsection{Datei Sperren und Durchbrüche}\label{subsubsec:file-sperr}
+
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\subsection{Ausgabedaten}
+
+\subsubsection{Datei Ergebnisse}\label{subsubsec:file-ausgabe}
+
Als Ausgabedaten generiert das Programm WSPLGEN bei fehlerfreier Ausführung
eine Shape-Datei, in der Polygone enthalten sind, deren Umgrenzung Isolinien
-gleicher Wassertiefe repräsentieren (vgl. Parameter e.2 in
-Abschnitt~\ref{subsubsec:para}). Die Shape-Datei
-enthält als Attribut die repräsentierte Wassertiefe. Der gewünschte Name
-der Shape-Datei (inkl. Pfadangaben) wird dem Programm WSPLGEN wieder über
-die Kommandozeile durch den Parameter \verb.-AUSGABE. mitgeteilt.
+gleicher Wassertiefe repräsentieren (vgl. Abschnitt~\ref{subsubsec:param-delta}).
+Die Shape-Datei enthält als Attribut die repräsentierte Wassertiefe.
+Der gewünschte Name der Shape-Datei (inkl. Pfadangaben) wird dem Programm
+WSPLGEN wieder über die Kommandozeile durch den Parameter \verb;-AUSGABE;
+(siehe Abschnitt~\ref{subsubsec:param-ausgabe} mitgeteilt.
-Format: \verb.-AUSGABE=<Datei>.
+Format Beschreibung:
-Beispiel: \verb;-AUSGABE="C:\TMP\AUSGABE\USG.SHP";)
+Bei der Ausgabedatei handelt es sich um eine Datei im ESRI-Shape-Format
+des Types (POLYGON).
+Die X- und Y-Koordinaten der Polygone werden systembedingt als Gleitkommazahlen
+gespeichert und repräsentieren das gleiche Koordinatensystem und die gleichen
+Einheiten wie das DGM, das als Basis für ihre Generierung diente.
+Das Attribut, das die repräsentierten Wassertiefen speichert,
+heisst \verb;Delta; (Differenz zwischen Wasserstand und Geländehöhe).
+Es gibt die Wassertiefe in ganzen cm an und ist daher vom Typ
+Ganzzahl (Integer).
+
+
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\subsection{Fortschritt, Warnungen und Fehlermeldungen}\label{subsec:fehler}
+\subsubsection{Datei Fortschritt}\label{subsubsec:file-fort}
Während der Generierung wird der Fortschritt kontinuierlich in einer
Fortschrittsdatei aktualisiert, so dass die GUI in der Lage ist,
@@ -561,23 +779,86 @@
Wenn eine sinnvolle Shape-Datei erzeugt werden konnte (keine Fehler),
so kann in einer GUI die weitere Visualisierung stattfinden.
-Die Fortschritts- und Protokolldateinamen werden auch über die
-Kommandozeile übergeben. Die Syntax hierfür lauten
-\verb.-FORT=<Datei>. und \verb.-PROT=<Datei>..
+Format Beschreibung:
+Die Fortschrittdatei wird von dem Programm WSPLGEN sehr häufig
+geschrieben, da so eine ausrufende GUI die Möglichkeit hat, dem Benutzer
+ständig auf dem Laufenden zu halten. Zu diesem Grund schreibt WSPLGEN
+in die Fortschrittdatei immer wieder Text, der entweder in einer Zeile angibt was das
+Programm gerade tut oder in den folgenden Zeilen wie weit es damit ist.
+Format Beispiel:
+\begin{verbatim}
+->Lese DGM-Dateien
+10000 Punkte gelesen (20% der Datei)
+20000 Punkte gelesen (41% der Datei)
+30000 Punkte gelesen (62% der Datei)
+40000 Punkte gelesen (83% der Datei)
+45322 Punkte gelesen (100% der Datei)
+->Lese Querprofile
+100 Profile gelesen (48% der Datei)
+200 Profile gelesen (96% der Datei)
+212 Profile gelesen (100% der Datei)
+->Lese Wasserstände
+100 Wasserstände gelesen (85% der Datei)
+145 Wasserstände gelesen (100% der Datei)
+->Interpoliere Profile
+50 von 234 Profilen interpoliert
+100 von 234 Profilen interpoliert
+150 von 234 Profilen interpoliert
+200 von 234 Profilen interpoliert
+234 von 234 Profilen interpoliert
+->Interpoliere Wasserstände
+100 von 342 fehlenden Wasserstände interpoliert
+200 von 342 fehlenden Wasserstände interpoliert
+300 von 342 fehlenden Wasserstände interpoliert
+\end{verbatim}
+
+
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\section{Jobdatei}
+\subsubsection{Datei Protokoll}\label{subsubsec:file-prot}
-Da die Beschränkung der Kommandozeile bei Windows in Kombination mit
-langen Pfadnamen leicht zu Problemen führen kann. Wird auch die
-Zusammenfassung aller Parameter in einer Jobdatei vorgesehen. In jeder
-Zeile dieser Datei würde dann ein Parameter stehen, der wie oben
-beschrieben ausgewertet wird. Der Name der Jobdatei wäre dann der
-einzige Parameter der Form \verb.-JOB=<datei>..
+Während der Generierung wird der Fortschritt kontinuierlich zusäzlich
+zu einer Fortschrittsdatei, auch in einer Protokolldatei festgehalten,
+in der Warnungen und Fehler gespeichert werden, so dass der Benutzer
+nach dem Lauf überprüfen kann, ob alles zu seiner Zufriedenheit
+erledigt werden konnte oder es Probleme gegeben hat.
+Eine direkte Interaktion mit dem Programm WSPLGEN ist nicht vorgesehen.
+Sollte es also Fehler oder Warnungen gegeben haben, die der Benutzer
+nicht ignorieren will, so muss er die Eingabedaten oder Parameter
+ändern und einen erneuten Lauf starten. Die Meldungen werden aber
+so aussehen, dass sie dem Benutzer optimale Hinweise für sein
+weiteres Vorgehen liefern.
+Wenn eine sinnvolle Shape-Datei erzeugt werden konnte (keine Fehler),
+so kann in einer GUI die weitere Visualisierung stattfinden.
+
+Format Beschreibung:
+
+Die Protokolldatei wird von dem Programm WSPLGEN nur
+geschrieben, wenn es Warnungen oder sogar Fehler im Programm gab.
+
+Die Protokolldatei sollte dem Benutzer immer nach dem Lauf von WSPLGEN
+angezeigt werden, wenn sie existiert und Warnungen oder Fehler enthält.
+
+Format Beispiel:
+\begin{verbatim}
+->Warnung:
+Für die Station 123 wurde der Wasserstand doppelt definiert
+(Wasserstände: 123,34 und 123,45).
+Es wurde der Waserstand 123,34 verwendet.
+->Warnung:
+Der Wasserstand bei Profil 145 ist kleiner als
+alle Geländehöhe im DGM entlanfg dieses Profiles.
+->Fehler:
+Für das Profil 23432 wurde kein Wasserstand definiert und
+es könnte auch keine Wasserstand interpoliert werden,
+da es kein Nachfolgeprofil mit einer höheren Stationsnummer gibt.
+\end{verbatim}
+
+
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\section{Zusammenfassung}
More information about the Wsplgen-commits
mailing list