Skip to content
Snippets Groups Projects
Commit 8c78e0fd authored by Jan Wille's avatar Jan Wille
Browse files

tabellen und listings formatierung

parent 456c4a94
No related branches found
No related tags found
No related merge requests found
No preview for this file type
...@@ -143,7 +143,7 @@ ...@@ -143,7 +143,7 @@
\begin{table} \begin{table}
\caption{Erklärungen zur Projektstruktur} \label{tab: struktur} \caption{Erklärungen zur Projektstruktur} \label{tab: struktur}
\renewcommand*{\arraystretch}{1.25} \renewcommand*{\arraystretch}{1.25}
\begin{tabular}{l p{.6\textwidth}} \begin{tabular}{@{}l p{.6\textwidth}@{}}
\textit{Ordner/Dateiname} & \textit{Erklärung}\\ \textit{Ordner/Dateiname} & \textit{Erklärung}\\
\hline \hline
\texttt{.venv/} & Dieser Ordner wird beim Erzeugend des \emph{Virtual Enviroments} (siehe \ref{sec: bibliotheken}) \texttt{.venv/} & Dieser Ordner wird beim Erzeugend des \emph{Virtual Enviroments} (siehe \ref{sec: bibliotheken})
...@@ -170,14 +170,15 @@ ...@@ -170,14 +170,15 @@
\caption{Verwendete Pakete und ihre Funktion} \label{tab: bibliotheken} \caption{Verwendete Pakete und ihre Funktion} \label{tab: bibliotheken}
\renewcommand*{\arraystretch}{1.25} \renewcommand*{\arraystretch}{1.25}
\begin{tabular}{@{}r p{.6\textwidth}@{}} \begin{tabular}{@{}r p{.6\textwidth}@{}}
\multicolumn{2}{@{}l}{\textit{Runtime Pakete:} } \\ \multicolumn{2}{@{}l}{\textit{Runtime Pakete:} } \\\hline
\texttt{opencv-python} \cite{pypi:python-opencv} & Ein Wrapper für das OpenCV Framework \cite{opencv}. Stellt eine Reihe an \texttt{opencv-python} \cite{pypi:python-opencv} & Ein Wrapper für das OpenCV Framework \cite{opencv}. Stellt eine Reihe an
Funktionen für die Bildverarbeitung zur Verfügung. Ein Großteil aller verwendeten Algorithmen sind hier implementiert. \\ Funktionen für die Bildverarbeitung zur Verfügung. Ein Großteil aller verwendeten Algorithmen sind hier implementiert. \\
\texttt{numpy} \cite{pypi:numpy} & Eine Bibliothek zu schnellen Verarbeitung großer Datenstrukturen (insbesondere Matrizen). Sie liegt den \texttt{numpy} \cite{pypi:numpy} & Eine Bibliothek zu schnellen Verarbeitung großer Datenstrukturen (insbesondere Matrizen). Sie liegt den
Bild-Datentypen in \texttt{opencv-python} zugrunde. \\ Bild-Datentypen in \texttt{opencv-python} zugrunde. \\
\texttt{pytesseract} \cite{pypi:pytesseract} & Wrapper für das OCR-Programm \emph{Tesseract} \cite{tesseract}. Dieses für die \texttt{pytesseract} \cite{pypi:pytesseract} & Wrapper für das OCR-Programm \emph{Tesseract} \cite{tesseract}. Dieses für die
eigentliche Texterkennung durch und kann durch diese Bibliothek bedient werden. \\ eigentliche Texterkennung durch und kann durch diese Bibliothek bedient werden. \\
\multicolumn{2}{@{}l}{\textit{Pakete für die Entwicklung:}} \\ \\[-3ex]
\multicolumn{2}{@{}l}{\textit{Pakete für die Entwicklung:}} \\\hline
\texttt{pyinstaller} \cite{pypi:pyinstaller} & Eine Bibliothek zum Verpacken eines Pythonprogrammes in ein alleinstehendes \texttt{pyinstaller} \cite{pypi:pyinstaller} & Eine Bibliothek zum Verpacken eines Pythonprogrammes in ein alleinstehendes
Programm. \\ Programm. \\
\texttt{black} & Python Formatierungsprogramm. \\ \texttt{black} & Python Formatierungsprogramm. \\
...@@ -191,6 +192,7 @@ ...@@ -191,6 +192,7 @@
Unterordner dieses Projektes abgelegt und nur diesem Projekt zur Verfügung gestellt. Dazu werden die folgenden Befehle oder das Unterordner dieses Projektes abgelegt und nur diesem Projekt zur Verfügung gestellt. Dazu werden die folgenden Befehle oder das
Makefilerezept \lstinline{setup} verwendet. Makefilerezept \lstinline{setup} verwendet.
\medskip
\begin{lstlisting}[language=bash,gobble=16] \begin{lstlisting}[language=bash,gobble=16]
# virual env erstellen: # virual env erstellen:
python -m venv .venv python -m venv .venv
...@@ -199,6 +201,7 @@ ...@@ -199,6 +201,7 @@
# pakete installieren: # pakete installieren:
pip install -r requirements.txt pip install -r requirements.txt
\end{lstlisting} \end{lstlisting}
\medskip
Der Quellcode des Projektes befindet sich im Unterordner \lstinline{./src}. Dort befindet sich die Datei \lstinline{__main__.py}, als Der Quellcode des Projektes befindet sich im Unterordner \lstinline{./src}. Dort befindet sich die Datei \lstinline{__main__.py}, als
Haupteinstiegspunkt des Programms, sowie alle weiteren selbsterstellten Pakete. Das Programm wird also mittels Haupteinstiegspunkt des Programms, sowie alle weiteren selbsterstellten Pakete. Das Programm wird also mittels
...@@ -212,6 +215,7 @@ ...@@ -212,6 +215,7 @@
folgen eine beliebig lange Reihe an gültigen Codes. Über die Flag \lstinline{-h} kann außerdem eine Hilfe aufgerufen werden, die die folgen eine beliebig lange Reihe an gültigen Codes. Über die Flag \lstinline{-h} kann außerdem eine Hilfe aufgerufen werden, die die
Benutzung erklärt und nachfolgend abgedruckt ist. Benutzung erklärt und nachfolgend abgedruckt ist.
\medskip
\begin{lstlisting}[language=,gobble=16] \begin{lstlisting}[language=,gobble=16]
usage: __main__.py [-h] imagepath code [code ...] usage: __main__.py [-h] imagepath code [code ...]
...@@ -222,6 +226,7 @@ ...@@ -222,6 +226,7 @@
options: options:
-h, --help show this help message and exit -h, --help show this help message and exit
\end{lstlisting} \end{lstlisting}
\medskip
Die Kommandozeilenparameter werden direkt an die Funktion \lstinline{main()} übergeben, die alternativ zur Nutzung über die Kommandozeile Die Kommandozeilenparameter werden direkt an die Funktion \lstinline{main()} übergeben, die alternativ zur Nutzung über die Kommandozeile
von anderen Python-Programmen importiert und aufgerufen werden kann. von anderen Python-Programmen importiert und aufgerufen werden kann.
...@@ -373,6 +378,7 @@ ...@@ -373,6 +378,7 @@
\lstinline{main()} mit diesen Parametern das erwartete Ergebnis liefert. Die Funktion kann also leicht an aktuelle Bilder angepasst \lstinline{main()} mit diesen Parametern das erwartete Ergebnis liefert. Die Funktion kann also leicht an aktuelle Bilder angepasst
werden. Hier der entsprechende code: werden. Hier der entsprechende code:
\medskip
\begin{lstlisting}[gobble=16] \begin{lstlisting}[gobble=16]
valid_codes = ["SIE20220101", "FAT3264128"] valid_codes = ["SIE20220101", "FAT3264128"]
@pytest.mark.parametrize( @pytest.mark.parametrize(
...@@ -385,6 +391,7 @@ ...@@ -385,6 +391,7 @@
def test_knownimages(path, contained_codes): def test_knownimages(path, contained_codes):
assert contained_codes == main(path, valid_codes) assert contained_codes == main(path, valid_codes)
\end{lstlisting} \end{lstlisting}
\medskip
Um die Tests durchzuführen, kann direkt der Befehl \lstinline{pytest} oder das Makefilerezept \emph{test} verwendet werden. Um die Tests durchzuführen, kann direkt der Befehl \lstinline{pytest} oder das Makefilerezept \emph{test} verwendet werden.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment