summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/hagenberg-thesis/examples/HgbLabReportEN/main.tex
blob: 99d2264b63d3fa84fb9d8c74779b995793fa87bc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
%% A simple template for a lab or course report using the Hagenberg setup
%% based on the standard LaTeX 'report' class
%% äöüÄÖÜß  <-- no German Umlauts here? Use an UTF-8 compatible editor!

%%% Magic comments for setting the correct parameters in compatible IDEs
% !TeX encoding = utf8
% !TeX program = pdflatex 
% !TeX spellcheck = en_US
% !BIB program = biber

\documentclass[english,notitlepage,smartquotes]{hgbreport}

\RequirePackage[utf8]{inputenc}		% remove when using lualatex oder xelatex!
\renewcommand{\chapter}[1]{}	% \chapter is deactivated

\graphicspath{{images/}}   % where are the images?

\bibliography{references}   % requires file 'references.bib'
\ExecuteBibliographyOptions{backref=false}



%%-----------------------------------------------------------
\setcounter{chapter}{3}	% <----- set to assignment number!
%%-----------------------------------------------------------

\author{Alex A.\ Wiseguy}
\title{MTD362 Digital Imaging -- WS 2020/21\\
				Lab Report \arabic{chapter}}
\date{\today}


%%%----------------------------------------------------------
\begin{document}
%%%----------------------------------------------------------
\maketitle
%%%----------------------------------------------------------

\begin{abstract}\noindent
This lab unit deals with various interesting problems  \ldots 
(give a short summary of the specific topics addressed).
If you decide to write your report in German, make sure to
change the \verb!\documentclass! parameter from \texttt{english}
to \texttt{german}.
If you write in MS Word (and such), try to use a similar structure.
\end{abstract}



\section{The first assignment}

Describe the goals of the assignment briefly in your own words
(i.e., do not just copy-paste the assignment text).
In general, try to describe
\begin{itemize}
\item
	the task or problem to solve;
\item
	the details of your solution, key ideas, steps involved, math, algorithms,
	references, \ldots ;
\item
	tests used to validate your solution and/or performance.
\end{itemize}

\subsection{Structuring}	% title of a subtask

This \latex document is based on the \texttt{HagenbergThesis} 
template, whose most recent version can be found on GitHub.%
\footnote{\url{https://github.com/Digital-Media/HagenbergThesis}}

The document uses the custom class \textsf{hgbreport} which is based
on \latex's standard \texttt{report} document class. Each lab unit 
(weekly assignment) corresponds to one \texttt{chapter}.
Use \verb!\setcounter{chapter}{n}! in the document's preamble
to set the \emph{lab unit number} to \texttt{n}.
Note that the \verb!\chapter! command itself is deactivated.
Use \verb!section{..}! at the beginning of each \emph{assignment}.
For individual \emph{subtasks} use the 
\verb!\subsection{..}! command, as shown here.



\subsection{Literature}

Use \emph{references} to literature or online resources whenever you found 
something relevant.
For example, the textbook recommended for this course is \cite{Sedgewick2011}.


\subsection{Mathematical elements}

Use mathematical expressions wherever appropriate, either in-line 
(e.g., $e = m \cdot c^2$) or in the form of displayed equations, such as
%
\begin{equation}
	e = m \cdot c^2 .
\end{equation}




\subsection{Pictures, figures}

Uses figures to show your test images, results, screen shots etc.,  
noting that (with the given setup) only
graphics in PNG, JPEG and PDF format can be directly included
(see Fig.~\ref{fig:example}).
See the thesis template for more details.
All images are set up to reside in the \verb!images/! subdirectory.
However, it may be a good idea to create a specific image folder for
each assignment.

\begin{figure}[htbp]
\centering\small
\begin{tabular}{cc}
	\fbox{\includegraphics[width=0.45\textwidth]{screenshot-dirty}} &		% JPEG file
	\fbox{\includegraphics[width=0.45\textwidth]{screenshot-clean}} \\	% PNG file
	(a) & (b) 
\end{tabular}
\caption{Example for including images in a figure. Explain what is shown
in (a) and (b), respectively.} 
\label{fig:example}
\end{figure}



\subsection{Including code}

Include relevant code snippets as shown in this Java example:
%
\begin{JavaCode}[numbers=none]
import ij.ImagePlus;
import ij.plugin.filter.PlugInFilter;
import ij.process.ImageProcessor;

public class Filter_Demo implements PlugInFilter {
	
	public int setup(String arg, ImagePlus imp) {
		return DOES_ALL;	// works for any type of image!
	}

	public void run(ImageProcessor ip) {
		float[] H = { 		// this is a 1D array!
				1, 2, 1,
				2, 4, 2,
				1, 2, 1 
		};
		ip.convolve(H, 3, 3);		// a 3 x 3 filter kernel
	}
}
\end{JavaCode}
%
The thesis template provides suitable code environments for
various other languages.


\section{The second assignment}

And so on for all other assignments \ldots


\section*{Summary and comments}

Here you should summarize your learning experience,
personal discoveries and major difficulties (if any).
Also state the approximate amount of time you spent for
this assignment and any optional accomplishments.
This non-numbered section is produced with the
\verb!\section*{..}! command.
 



%%%----------------------------------------------------------
  
\section*{References}
\printbibliography[heading=noheader]

%%%----------------------------------------------------------

\end{document}