Ans commited on
Commit
fb8d22b
1 Parent(s): 2f52881

Adding project template files

Browse files
data/readme.md ADDED
@@ -0,0 +1,26 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ## Data
2
+ Keep your data (e.g. from evaluations here)
3
+
4
+
5
+ * If you involved human subjects in any form, you will require ethical permission.
6
+ * Keep records of all items related to ethics in `data/ethics`. There are templates for scripts, guidance provided.
7
+ * **You must have scanned PDFs of signed checklists in this folder**, or PDFs of ethics confirmations from other sources
8
+ * Ensure you remain GDPR compliant. In general:
9
+ * Never collect personally identifiable information if at all possible.
10
+ * Pseudonymise identifiers for subjects.
11
+ * Use coarse demographic values unless you need specific information (for example, if you need age ranges, collect ranges, not specific ages)
12
+ * Ensure you have explicit consent for the storage and use of data from human subjects
13
+ * DO NOT STORE PERSONALLY IDENTIFIABLE INFORMATION ON REMOTE SERVERS (no Dropbox, Github, etc.)
14
+
15
+ * Keep a written description of the data, what is contained, and how it was captured in `data/readme.md`
16
+ * Record all raw data as an immutable store. **Never modify captured data.**
17
+ * Keep this under `data/raw`
18
+ * This could be logs, questionnaire responses, computation results
19
+
20
+ * Write scripts to produced processed data from these (e.g. tidy dataframes, excel sheets, csv files, HDF5 files, sqlite databases)
21
+ * Write scripts that process these into results, visualisations, tables that you include in your project.
22
+ * If you use Jupyter/RStudio notebooks, place these in `data/notebooks` and name them carefully (not "Untitled1", "Untitled2").
23
+
24
+ * You may need to remove the `data/` folder from version control if the data size is too large or you are bound by confidentiality.
25
+ * If you do so **make sure you have good backups**
26
+
dissertation/.gitignore ADDED
@@ -0,0 +1,247 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ## Core latex/pdflatex auxiliary files:
2
+ *.aux
3
+ *.lof
4
+ *.log
5
+ *.lot
6
+ *.fls
7
+ *.out
8
+ *.toc
9
+ *.fmt
10
+ *.fot
11
+ *.cb
12
+ *.cb2
13
+ .*.lb
14
+ l4proj*.pdf
15
+
16
+ test/
17
+
18
+ bad_l4proj*.*
19
+
20
+ ## Intermediate documents:
21
+ *.dvi
22
+ *.xdv
23
+ *-converted-to.*
24
+ # these rules might exclude image files for figures etc.
25
+ # *.ps
26
+ # *.eps
27
+ # *.pdf
28
+
29
+ ## Generated if empty string is given at "Please type another file name for output:"
30
+ .pdf
31
+
32
+ ## Bibliography auxiliary files (bibtex/biblatex/biber):
33
+ *.bbl
34
+ *.bcf
35
+ *.blg
36
+ *-blx.aux
37
+ *-blx.bib
38
+ *.run.xml
39
+
40
+ ## Build tool auxiliary files:
41
+ *.fdb_latexmk
42
+ *.synctex
43
+ *.synctex(busy)
44
+ *.synctex.gz
45
+ *.synctex.gz(busy)
46
+ *.pdfsync
47
+
48
+ ## Auxiliary and intermediate files from other packages:
49
+ # algorithms
50
+ *.alg
51
+ *.loa
52
+
53
+ # achemso
54
+ acs-*.bib
55
+
56
+ # amsthm
57
+ *.thm
58
+
59
+ # beamer
60
+ *.nav
61
+ *.pre
62
+ *.snm
63
+ *.vrb
64
+
65
+ # changes
66
+ *.soc
67
+
68
+ # cprotect
69
+ *.cpt
70
+
71
+ # elsarticle (documentclass of Elsevier journals)
72
+ *.spl
73
+
74
+ # endnotes
75
+ *.ent
76
+
77
+ # fixme
78
+ *.lox
79
+
80
+ # feynmf/feynmp
81
+ *.mf
82
+ *.mp
83
+ *.t[1-9]
84
+ *.t[1-9][0-9]
85
+ *.tfm
86
+
87
+ #(r)(e)ledmac/(r)(e)ledpar
88
+ *.end
89
+ *.?end
90
+ *.[1-9]
91
+ *.[1-9][0-9]
92
+ *.[1-9][0-9][0-9]
93
+ *.[1-9]R
94
+ *.[1-9][0-9]R
95
+ *.[1-9][0-9][0-9]R
96
+ *.eledsec[1-9]
97
+ *.eledsec[1-9]R
98
+ *.eledsec[1-9][0-9]
99
+ *.eledsec[1-9][0-9]R
100
+ *.eledsec[1-9][0-9][0-9]
101
+ *.eledsec[1-9][0-9][0-9]R
102
+
103
+ # glossaries
104
+ *.acn
105
+ *.acr
106
+ *.glg
107
+ *.glo
108
+ *.gls
109
+ *.glsdefs
110
+
111
+ # gnuplottex
112
+ *-gnuplottex-*
113
+
114
+ # gregoriotex
115
+ *.gaux
116
+ *.gtex
117
+
118
+ # htlatex
119
+ *.4ct
120
+ *.4tc
121
+ *.idv
122
+ *.lg
123
+ *.trc
124
+ *.xref
125
+
126
+ # hyperref
127
+ *.brf
128
+
129
+ # knitr
130
+ *-concordance.tex
131
+ # TODO Comment the next line if you want to keep your tikz graphics files
132
+ *.tikz
133
+ *-tikzDictionary
134
+
135
+ # listings
136
+ *.lol
137
+
138
+ # makeidx
139
+ *.idx
140
+ *.ilg
141
+ *.ind
142
+ *.ist
143
+
144
+ # minitoc
145
+ *.maf
146
+ *.mlf
147
+ *.mlt
148
+ *.mtc[0-9]*
149
+ *.slf[0-9]*
150
+ *.slt[0-9]*
151
+ *.stc[0-9]*
152
+
153
+ # minted
154
+ _minted*
155
+ *.pyg
156
+
157
+ # morewrites
158
+ *.mw
159
+
160
+ # nomencl
161
+ *.nlg
162
+ *.nlo
163
+ *.nls
164
+
165
+ # pax
166
+ *.pax
167
+
168
+ # pdfpcnotes
169
+ *.pdfpc
170
+
171
+ # sagetex
172
+ *.sagetex.sage
173
+ *.sagetex.py
174
+ *.sagetex.scmd
175
+
176
+ # scrwfile
177
+ *.wrt
178
+
179
+ # sympy
180
+ *.sout
181
+ *.sympy
182
+ sympy-plots-for-*.tex/
183
+
184
+ # pdfcomment
185
+ *.upa
186
+ *.upb
187
+
188
+ # pythontex
189
+ *.pytxcode
190
+ pythontex-files-*/
191
+
192
+ # thmtools
193
+ *.loe
194
+
195
+ # TikZ & PGF
196
+ *.dpth
197
+ *.md5
198
+ *.auxlock
199
+
200
+ # todonotes
201
+ *.tdo
202
+
203
+ # easy-todo
204
+ *.lod
205
+
206
+ # xmpincl
207
+ *.xmpi
208
+
209
+ # xindy
210
+ *.xdy
211
+
212
+ # xypic precompiled matrices
213
+ *.xyc
214
+
215
+ # endfloat
216
+ *.ttt
217
+ *.fff
218
+
219
+ # Latexian
220
+ TSWLatexianTemp*
221
+
222
+ ## Editors:
223
+ # WinEdt
224
+ *.bak
225
+ *.sav
226
+
227
+ # Texpad
228
+ .texpadtmp
229
+
230
+ # Kile
231
+ *.backup
232
+
233
+ # KBibTeX
234
+ *~[0-9]*
235
+
236
+ # auto folder when using emacs and auctex
237
+ ./auto/*
238
+ *.el
239
+
240
+ # expex forward references with \gathertags
241
+ *-tags.tex
242
+
243
+ # standalone packages
244
+ *.sta
245
+
246
+ # generated if using elsarticle.cls
247
+ *.spl
dissertation/README.md ADDED
@@ -0,0 +1,20 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # UofG SoCS Level 4 Project LaTeX template
2
+
3
+ Provides `l4proj.cls`, the standard LaTeX template for Honours Individual Projects.
4
+
5
+ ![Preview of the layout](images/l4proj.png)
6
+
7
+ ## Notes on formatting
8
+
9
+ The first page, abstract and table of contents are numbered using Roman numerals and are not
10
+ included in the page count.
11
+
12
+ The first Chapter should start on page 1. You are allowed 40 pages for a 40 credit project and 30 pages for a
13
+ 20 credit report. This includes everything numbered in Arabic numerals (excluding front matter) up
14
+ to but excluding the appendices and bibliography.
15
+
16
+ **You must not alter font, text size (it is currently 10pt), margins or spacing.**
17
+
18
+ ## LaTeX
19
+ This template has been tested with `pdflatex`. It should also work with `xelatex` and `lualatex`. Note that on Linux you may need to copy the contents of the `fonts/` folder to `~/.fonts/`.
20
+
dissertation/fonts/FiraMono-Bold.ttf ADDED
Binary file (206 kB). View file
 
dissertation/fonts/FiraMono-Medium.ttf ADDED
Binary file (173 kB). View file
 
dissertation/fonts/FiraMono-Regular.ttf ADDED
Binary file (175 kB). View file
 
dissertation/fonts/FiraSans-Bold.ttf ADDED
Binary file (490 kB). View file
 
dissertation/fonts/FiraSans-BoldItalic.ttf ADDED
Binary file (507 kB). View file
 
dissertation/fonts/FiraSans-Italic.ttf ADDED
Binary file (472 kB). View file
 
dissertation/fonts/FiraSans-Regular.ttf ADDED
Binary file (457 kB). View file
 
dissertation/fonts/fbb-Bold.otf ADDED
Binary file (132 kB). View file
 
dissertation/fonts/fbb-Bold.pfb ADDED
Binary file (190 kB). View file
 
dissertation/fonts/fbb-BoldItalic.otf ADDED
Binary file (127 kB). View file
 
dissertation/fonts/fbb-BoldItalic.pfb ADDED
Binary file (175 kB). View file
 
dissertation/fonts/fbb-Italic.otf ADDED
Binary file (138 kB). View file
 
dissertation/fonts/fbb-Italic.pfb ADDED
Binary file (201 kB). View file
 
dissertation/fonts/fbb-Regular.otf ADDED
Binary file (134 kB). View file
 
dissertation/fonts/fbb-Regular.pfb ADDED
Binary file (203 kB). View file
 
dissertation/images/CompSci_colour.pdf ADDED
Binary file (28.1 kB). View file
 
dissertation/images/boxplot_finger_distance.pdf ADDED
Binary file (95.7 kB). View file
 
dissertation/images/l4proj.png ADDED
dissertation/images/relu.pdf ADDED
Binary file (6.75 kB). View file
 
dissertation/images/synthetic.png ADDED
dissertation/images/synthetic_2.png ADDED
dissertation/images/uog_white.pdf ADDED
Binary file (10 kB). View file
 
dissertation/images/uog_white.svg ADDED
dissertation/l4proj.bib ADDED
@@ -0,0 +1,46 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ @inproceedings{Pey17,
2
+ author = {Simon {Peyton Jones}},
3
+ title = {How to Write a Great Research Paper},
4
+ booktitle = {2017 Imperial College Computing Student Workshop, {ICCSW} 2017, September
5
+ 26-27, 2017, London, {UK}},
6
+ pages = {1:1--1:1},
7
+ year = {2017},
8
+
9
+ }
10
+
11
+ @book{Wil09,
12
+ title={Style: the basics of clarity and grace},
13
+ author={Williams, Joseph M and Bizup, Joseph},
14
+ year={2009},
15
+ publisher={Pearson Longman}
16
+ }
17
+
18
+ @book{Pin15,
19
+ title={The sense of style: The thinking person's guide to writing in the 21st century},
20
+ author={Pinker, Steven},
21
+ year={2015},
22
+ publisher={Penguin Books}
23
+ }
24
+
25
+ @book{StrWhi07,
26
+ title={The Elements of style},
27
+ author={Strunk, William and Whyte, EB},
28
+ year={2007},
29
+ publisher={Penguin}
30
+ }
31
+
32
+ @book{Von80,
33
+ title={How to write with style},
34
+ author={Vonnegut, Kurt},
35
+ year={1980},
36
+ publisher={International Paper Company}
37
+ }
38
+
39
+ @incollection{Orw68,
40
+ title={Politics and the {English} language},
41
+ author={Orwell, George},
42
+ booktitle={The collected essays, journalism and letters of George Orwell},
43
+ pages={127--140},
44
+ year={1968},
45
+ publisher={Harcourt, Brace, Javanovich}
46
+ }
dissertation/l4proj.cls ADDED
@@ -0,0 +1,295 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ % =============================================================================
2
+ % l4proj.cls
3
+ %
4
+ % Template for final year projects in the School of Computing Science at the
5
+ % University of Glasgow. Adapted from the level 3 project template originally
6
+ % provided by Colin Perkins <csp@dcs.gla.ac.uk>.
7
+ %
8
+ % =============================================================================
9
+
10
+ \ProvidesClass{l4proj}[%
11
+ 2009/01/09 Colin Perkins <csp@dcs.gla.ac.uk>.%
12
+ 2009/09/16 Modified by Tim Storer <tws@dcs.gla.ac.uk> to support non pdf modes.%
13
+ 2011/02/15 Modified by Gregg Hamilton <hamiltgr@dcs.gla.ac.uk> for use in final year projects.%
14
+ 2012/10/18 Modified by Patrick Prosser, use geometry to control margins, simplified.%
15
+ 2018/09/14 Modified by John Williamson, improve typographic appearance%
16
+ ]
17
+ \DeclareOption*{\PassOptionsToClass{\CurrentOption}{report}}
18
+
19
+ \ProcessOptions
20
+ \LoadClass[10pt,a4paper]{report}
21
+
22
+ % Monospace font is Fira Mono Sans
23
+ % the body font used is FBB (Bembo)
24
+
25
+ \usepackage{iftex}
26
+
27
+ \ifPDFTeX
28
+ \usepackage{fbb}
29
+ \usepackage{FiraMono}
30
+ \usepackage{FiraSans}
31
+ \usepackage{textcomp}
32
+ \usepackage[english]{babel}
33
+ \usepackage[T1]{fontenc}
34
+ \else
35
+ % make sure the fonts are actually set
36
+ \usepackage{fontspec}
37
+ \usepackage{polyglossia}
38
+ \setromanfont[Path=./fonts/, BoldFont=fbb-Bold, UprightFont=fbb-Regular, ItalicFont=fbb-Italic, BoldItalicFont=fbb-BoldItalic]{fbb}
39
+ \setmonofont[Path=./fonts/, BoldFont=FiraMono-Bold, UprightFont=FiraMono-Regular]{FiraMono.ttf}
40
+ \setsansfont[Path=./fonts/, BoldFont=FiraSans-Bold, UprightFont=FiraSans-Regular, ItalicFont=FiraSans-Italic, BoldItalicFont=FiraSans-BoldItalic]{FiraSans.ttf}
41
+ \fi
42
+
43
+ \usepackage[libertine,bigdelims,vvarbb]{newtxmath} % bb from STIX
44
+ \usepackage[cal=boondoxo]{mathalfa} % mathcal
45
+
46
+ \usepackage{microtype} % improve typography
47
+ \usepackage{anyfontsize} % allow any size of font
48
+ \usepackage{amsmath,amsfonts,amsbsy,amssymb}
49
+ \usepackage[style]{abstract} % abstract styling
50
+
51
+ % set bibliography styling
52
+ \usepackage{natbib}
53
+ \bibpunct{(}{)}{;}{a}{}{;}
54
+
55
+
56
+ \usepackage{etoolbox}
57
+ \usepackage[compact]{titlesec} % section heading formatting
58
+ \usepackage{color} % colors
59
+ \usepackage[table,svgnames]{xcolor}
60
+ \usepackage{parskip} % adjustable line spacing
61
+ \usepackage{listings} % nice code listings
62
+
63
+ % remove dots from ToC
64
+ \usepackage[titles]{tocloft}
65
+ \renewcommand{\cftdot}{}
66
+ \usepackage[nottoc]{tocbibind}
67
+
68
+ % from: https://gist.github.com/FelipeCortez/10729134
69
+ % set up listings for prettier output
70
+ \definecolor{bluekeywords}{rgb}{0.13, 0.19, 0.7}
71
+ \definecolor{greencomments}{rgb}{0.1, 0.5, 0.2}
72
+ \definecolor{redstrings}{rgb}{0.8, 0.15, 0.1}
73
+ \definecolor{graynumbers}{rgb}{0.5, 0.5, 0.5}
74
+ \definecolor{subtlegray}{rgb}{0.98, 0.98, 0.98}
75
+ \usepackage{lstautogobble}
76
+ \usepackage{listings}
77
+ \lstset{
78
+ autogobble,
79
+ columns=fullflexible,
80
+ showspaces=false,
81
+ showtabs=false,
82
+ breaklines=true,
83
+ showstringspaces=false,
84
+ breakatwhitespace=true,
85
+ escapeinside={(*@}{@*)},
86
+ rulecolor=\color{lightgray},
87
+ backgroundcolor=\color{subtlegray},
88
+ commentstyle=\color{greencomments},
89
+ keywordstyle=\color{bluekeywords},
90
+ stringstyle=\color{redstrings},
91
+ numberstyle=\color{graynumbers},
92
+ basicstyle=\ttfamily\linespread{1.15}\footnotesize,
93
+ frame=tb,
94
+ framesep=12pt,
95
+ framexleftmargin=12pt,
96
+ tabsize=4,
97
+ captionpos=b
98
+ }
99
+ %% ---
100
+
101
+ % nice number printing
102
+ \usepackage{numprint}
103
+
104
+ % allow PDF graphics
105
+ \usepackage{graphicx}
106
+
107
+ % allow section styling
108
+ %\usepackage{sectsty}
109
+
110
+ % make all cross-references clickable
111
+ \usepackage[hidelinks]{hyperref}
112
+
113
+ % enable styled captions
114
+ \usepackage[format=plain,
115
+ labelfont={bf,it},
116
+ textfont=it,tableposition=above]{caption}
117
+
118
+ \newcommand{\secfont}{\normalfont\sffamily}
119
+ % % style the sections and the abstract
120
+ % \allsectionsfont{\secfont}
121
+
122
+
123
+ \renewcommand{\abstractnamefont}{\Large\secfont}
124
+ \renewcommand{\abstitlestyle}[1]{{{\let\clearpage\relax \chapter*{#1}}}}
125
+
126
+ \usepackage[toc]{appendix}
127
+
128
+ % allow subfloats
129
+ \usepackage{subcaption}
130
+
131
+
132
+ % fix the margins and linespacing
133
+ \usepackage[top=3.5cm,bottom=4.0cm,left=3.5cm,right=3.5cm]{geometry}
134
+ \setlength{\parskip}{5pt plus 2pt}
135
+
136
+ % define the title page
137
+ \renewcommand\maketitle{
138
+ \begin{titlepage}%
139
+ \definecolor{UniBlue}{HTML}{00355F}
140
+
141
+ \let\footnotesize\small
142
+ \let\footnoterule\relax
143
+ \let\footnote \thanks
144
+
145
+ % the logo, full page width
146
+ \vspace{1in}
147
+ \includegraphics[width=\linewidth]{images/CompSci_colour.pdf}
148
+ \vskip 0.5em
149
+ \color{UniBlue}
150
+ {\large \sffamily Honours Individual Project Dissertation}\\
151
+
152
+ % title and author
153
+
154
+ \vspace{2cm}
155
+ \Large
156
+ \vskip 8em%
157
+
158
+ \begin{center}
159
+
160
+ \color{UniBlue}
161
+ \noindent
162
+ {\Huge \scshape \@title \par}%
163
+
164
+
165
+
166
+
167
+
168
+ \end{center}
169
+ \vfill
170
+ {\Large
171
+ \textbf{\@author}\\
172
+ \@date}
173
+
174
+
175
+
176
+ \end{titlepage}%
177
+
178
+ \setcounter{footnote}{0}%
179
+ \global\let\thanks\relax
180
+ \global\let\maketitle\relax
181
+ \global\let\@thanks\@empty
182
+ \global\let\@author\@empty
183
+ \global\let\@date\@empty
184
+ \global\let\@consentname\@empty
185
+ \global\let\@consentdate\@empty
186
+
187
+ \global\let\@title\@empty
188
+ \global\let\title\relax
189
+ \global\let\author\relax
190
+ \global\let\date\relax
191
+ \global\let\and\relax
192
+ }
193
+ \usepackage{booktabs}
194
+ % set up headers and footers
195
+ % no footer, page numbers at top-right
196
+ \usepackage{fancyhdr}
197
+ \pagestyle{fancy}
198
+ \fancyhead{}
199
+ \fancyfoot{}
200
+ \fancyhead[R]{\thepage}
201
+ \renewcommand{\headrulewidth}{0pt}
202
+ \fancypagestyle{plain}{%
203
+ \renewcommand{\headrulewidth}{0pt}%
204
+ \fancyhf{}%
205
+ \fancyhead[R]{\thepage}%
206
+ }
207
+
208
+ \usepackage{titlesec}
209
+ % set up chapter headings
210
+ \usepackage{xstring}
211
+ \titleformat{\chapter}[display]
212
+ % only show numbers if they aren't Chapter 0 (i.e. front matter)
213
+ {\normalfont}{}{0pt}{
214
+ \huge\bfseries\secfont
215
+ \IfInteger{\thechapter}{\ifnum0=0\thechapter\relax\else\relax {\Huge \thechapter}\ \rule[-0.25em]{0.5pt}{1.5em}\ \fi}
216
+ {\thechapter \ \rule[-0.25em]{0.5pt}{1.5em}\ }}
217
+ %[\titlerule]
218
+ \titlespacing*{\chapter}
219
+ {0pt}{0pt}{15pt}
220
+
221
+ % Educational consent form
222
+ \newcommand{\educationalconsent}{
223
+ \ifdefined\consentname
224
+ \newpage
225
+ \chapter*{Education Use Consent}
226
+
227
+ I hereby grant my permission for this project to be stored, distributed and shown to other
228
+ University of Glasgow students and staff for educational purposes.
229
+ \textbf{Please note that you are under no obligation to sign
230
+ this declaration, but doing so would help future students.}
231
+
232
+ \begin{tabular}{@{}llll}
233
+ & & & \\
234
+ & & & \\
235
+ Signature: & \consentname & Date: & \consentdate \\
236
+ & & & \\
237
+ & & & \\
238
+ \end{tabular}
239
+ \else
240
+ \newpage
241
+ \chapter*{Education Use Consent}
242
+ Consent for educational reuse withheld. Do not distribute.
243
+ \fi
244
+
245
+ }
246
+
247
+ % highlight boxes
248
+ \usepackage{tcolorbox}
249
+ \newenvironment{highlight}
250
+ {\begin{tcolorbox}[notitle,boxrule=0pt,colback=green!10,colframe=green!10]}
251
+ {
252
+ \end{tcolorbox}
253
+ }
254
+
255
+ \newenvironment{highlight_title}[1]
256
+ {\begin{tcolorbox}[title=#1,boxrule=2pt,colback=green!10,colframe=green!20,coltitle=black,fonttitle=\bfseries]}
257
+ {
258
+ \end{tcolorbox}
259
+ }
260
+
261
+
262
+
263
+ % adjust margins
264
+ \setlength{\parindent}{0pt}
265
+
266
+
267
+ % use (a) in figures
268
+ \captionsetup{subrefformat=parens}
269
+
270
+ % Algorithm typesetting package
271
+ \usepackage[plain, noline, shortend, linesnumberedhidden]{algorithm2e}
272
+ \SetAlFnt{\sffamily \small}
273
+
274
+ % adjust spacing
275
+ \titlespacing{\section}{10pt}{1.5\baselineskip}{8pt plus 3pt minus 3pt}
276
+ \titlespacing{\subsection}{10pt}{\baselineskip}{8pt plus 4pt minus 1pt}
277
+ \titleformat{\subsubsection}[runin]{\bfseries }{}{}{}[]
278
+ \titlespacing{\chapter}{0pt}{0pt}{40pt plus 10pt minus 5pt}
279
+
280
+ % switch to roman numeral for frontmatter
281
+ \pagenumbering{roman}
282
+
283
+ % fix itemise so it looks reasonable
284
+ \renewcommand{\@listI}{%
285
+ \leftmargin=25pt
286
+ \rightmargin=0pt
287
+ \labelsep=5pt
288
+ \labelwidth=20pt
289
+ \itemindent=0pt
290
+ \listparindent=0pt
291
+ \topsep=0pt plus 2pt minus 4pt
292
+ \partopsep=0pt plus 1pt minus 1pt
293
+ \parsep=1pt plus 1pt
294
+ \itemsep=\parsep}
295
+
dissertation/l4proj.tex ADDED
@@ -0,0 +1,479 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ % REMEMBER: You must not plagiarise anything in your report. Be extremely careful.
2
+
3
+ \documentclass{l4proj}
4
+
5
+
6
+ %
7
+ % put any additional packages here
8
+ %
9
+
10
+ \begin{document}
11
+
12
+ %==============================================================================
13
+ %% METADATA
14
+ \title{Level 4 Project Report Template}
15
+ \author{John H. Williamson}
16
+ \date{September 14, 2018}
17
+
18
+ \maketitle
19
+
20
+ %==============================================================================
21
+ %% ABSTRACT
22
+ \begin{abstract}
23
+ Every abstract follows a similar pattern. Motivate; set aims; describe work; explain results.
24
+ \vskip 0.5em
25
+ ``XYZ is bad. This project investigated ABC to determine if it was better.
26
+ ABC used XXX and YYY to implement ZZZ. This is particularly interesting as XXX and YYY have
27
+ never been used together. It was found that
28
+ ABC was 20\% better than XYZ, though it caused rabies in half of subjects.''
29
+ \end{abstract}
30
+
31
+ %==============================================================================
32
+
33
+ % EDUCATION REUSE CONSENT FORM
34
+ % If you consent to your project being shown to future students for educational purposes
35
+ % then insert your name and the date below to sign the education use form that appears in the front of the document.
36
+ % You must explicitly give consent if you wish to do so.
37
+ % If you sign, your project may be included in the Hall of Fame if it scores particularly highly.
38
+ %
39
+ % Please note that you are under no obligation to sign
40
+ % this declaration, but doing so would help future students.
41
+ %
42
+ %\def\consentname {My Name} % your full name
43
+ %\def\consentdate {20 March 2018} % the date you agree
44
+ %
45
+ \educationalconsent
46
+
47
+
48
+ %==============================================================================
49
+ \tableofcontents
50
+
51
+ %==============================================================================
52
+ %% Notes on formatting
53
+ %==============================================================================
54
+ % The first page, abstract and table of contents are numbered using Roman numerals and are not
55
+ % included in the page count.
56
+ %
57
+ % From now on pages are numbered
58
+ % using Arabic numerals. Therefore, immediately after the first call to \chapter we need the call
59
+ % \pagenumbering{arabic} and this should be called once only in the document.
60
+ %
61
+ % Do not alter the bibliography style.
62
+ %
63
+ % The first Chapter should then be on page 1. You are allowed 40 pages for a 40 credit project and 30 pages for a
64
+ % 20 credit report. This includes everything numbered in Arabic numerals (excluding front matter) up
65
+ % to but excluding the appendices and bibliography.
66
+ %
67
+ % You must not alter text size (it is currently 10pt) or alter margins or spacing.
68
+ %
69
+ %
70
+ %==================================================================================================================================
71
+ %
72
+ % IMPORTANT
73
+ % The chapter headings here are **suggestions**. You don't have to follow this model if
74
+ % it doesn't fit your project. Every project should have an introduction and conclusion,
75
+ % however.
76
+ %
77
+ %==================================================================================================================================
78
+ \chapter{Introduction}
79
+
80
+ % reset page numbering. Don't remove this!
81
+ \pagenumbering{arabic}
82
+
83
+
84
+ Why should the reader care about what are you doing and what are you actually doing?
85
+ \section{Guidance}
86
+
87
+ \textbf{Motivate} first, then state the general problem clearly.
88
+
89
+ \section{Writing guidance}
90
+ \subsection{Who is the reader?}
91
+
92
+ This is the key question for any writing. Your reader:
93
+
94
+ \begin{itemize}
95
+ \item
96
+ is a trained computer scientist: \emph{don't explain basics}.
97
+ \item
98
+ has limited time: \emph{keep on topic}.
99
+ \item
100
+ has no idea why anyone would want to do this: \emph{motivate clearly}
101
+ \item
102
+ might not know \emph{anything} about your project in particular:
103
+ \emph{explain your project}.
104
+ \item
105
+ but might know precise details and check them: \emph{be precise and
106
+ strive for accuracy.}
107
+ \item
108
+ doesn't know or care about you: \emph{personal discussions are
109
+ irrelevant}.
110
+ \end{itemize}
111
+
112
+ Remember, you will be marked by your supervisor and one or more members
113
+ of staff. You might also have your project read by a prize-awarding
114
+ committee or possibly a future employer. Bear that in mind.
115
+
116
+ \subsection{References and style guides}
117
+ There are many style guides on good English writing. You don't need to
118
+ read these, but they will improve how you write.
119
+
120
+ \begin{itemize}
121
+ \item
122
+ \emph{How to write a great research paper} \cite{Pey17} (\textbf{recommended}, even though you aren't writing a research paper)
123
+ \item
124
+ \emph{How to Write with Style} \cite{Von80}. Short and easy to read. Available online.
125
+ \item
126
+ \emph{Style: The Basics of Clarity and Grace} \cite{Wil09} A very popular modern English style guide.
127
+ \item
128
+ \emph{Politics and the English Language} \cite{Orw68} A famous essay on effective, clear writing in English.
129
+ \item
130
+ \emph{The Elements of Style} \cite{StrWhi07} Outdated, and American, but a classic.
131
+ \item
132
+ \emph{The Sense of Style} \cite{Pin15} Excellent, though quite in-depth.
133
+ \end{itemize}
134
+
135
+ \subsubsection{Citation styles}
136
+
137
+ \begin{itemize}
138
+ \item If you are referring to a reference as a noun, then cite it as: ``\citet{Orw68} discusses the role of language in political thought.''
139
+ \item If you are referring implicitly to references, use: ``There are many good books on writing \citep{Orw68, Wil09, Pin15}.''
140
+ \end{itemize}
141
+
142
+ There is a complete guide on good citation practice by Peter Coxhead available here: \url{http://www.cs.bham.ac.uk/~pxc/refs/index.html}.
143
+ If you are unsure about how to cite online sources, please see this guide: \url{https://student.unsw.edu.au/how-do-i-cite-electronic-sources}.
144
+
145
+ \subsection{Plagiarism warning}
146
+
147
+ \begin{highlight_title}{WARNING}
148
+
149
+ If you include material from other sources without full and correct attribution, you are commiting plagiarism. The penalties for plagiarism are severe.
150
+ Quote any included text and cite it correctly. Cite all images, figures, etc. clearly in the caption of the figure.
151
+ \end{highlight_title}
152
+
153
+
154
+ %==================================================================================================================================
155
+ \chapter{Background}
156
+ What did other people do, and how is it relevant to what you want to do?
157
+ \section{Guidance}
158
+ \begin{itemize}
159
+ \item
160
+ Don't give a laundry list of references.
161
+ \item
162
+ Tie everything you say to your problem.
163
+ \item
164
+ Present an argument.
165
+ \item Think critically; weigh up the contribution of the background and put it in context.
166
+ \item
167
+ \textbf{Don't write a tutorial}; provide background and cite
168
+ references for further information.
169
+ \end{itemize}
170
+
171
+ %==================================================================================================================================
172
+ \chapter{Analysis/Requirements}
173
+ What is the problem that you want to solve, and how did you arrive at it?
174
+ \section{Guidance}
175
+ Make it clear how you derived the constrained form of your problem via a clear and logical process.
176
+
177
+ %==================================================================================================================================
178
+ \chapter{Design}
179
+ How is this problem to be approached, without reference to specific implementation details?
180
+ \section{Guidance}
181
+ Design should cover the abstract design in such a way that someone else might be able to do what you did, but with a different language or library or tool.
182
+
183
+ %==================================================================================================================================
184
+ \chapter{Implementation}
185
+ What did you do to implement this idea, and what technical achievements did you make?
186
+ \section{Guidance}
187
+ You can't talk about everything. Cover the high level first, then cover important, relevant or impressive details.
188
+
189
+
190
+
191
+ \section{General points}
192
+
193
+ These points apply to the whole dissertation, not just this chapter.
194
+
195
+
196
+
197
+ \subsection{Figures}
198
+ \emph{Always} refer to figures included, like Figure \ref{fig:relu}, in the body of the text. Include full, explanatory captions and make sure the figures look good on the page.
199
+ You may include multiple figures in one float, as in Figure \ref{fig:synthetic}, using \texttt{subcaption}, which is enabled in the template.
200
+
201
+
202
+
203
+ % Figures are important. Use them well.
204
+ \begin{figure}
205
+ \centering
206
+ \includegraphics[width=0.5\linewidth]{images/relu.pdf}
207
+
208
+ \caption{In figure captions, explain what the reader is looking at: ``A schematic of the rectifying linear unit, where $a$ is the output amplitude,
209
+ $d$ is a configurable dead-zone, and $Z_j$ is the input signal'', as well as why the reader is looking at this:
210
+ ``It is notable that there is no activation \emph{at all} below 0, which explains our initial results.''
211
+ \textbf{Use vector image formats (.pdf) where possible}. Size figures appropriately, and do not make them over-large or too small to read.
212
+ }
213
+
214
+ % use the notation fig:name to cross reference a figure
215
+ \label{fig:relu}
216
+ \end{figure}
217
+
218
+
219
+ \begin{figure}
220
+ \centering
221
+ \begin{subfigure}[b]{0.45\textwidth}
222
+ \includegraphics[width=\textwidth]{images/synthetic.png}
223
+ \caption{Synthetic image, black on white.}
224
+ \label{fig:syn1}
225
+ \end{subfigure}
226
+ ~ %add desired spacing between images, e. g. ~, \quad, \qquad, \hfill etc.
227
+ %(or a blank line to force the subfigure onto a new line)
228
+ \begin{subfigure}[b]{0.45\textwidth}
229
+ \includegraphics[width=\textwidth]{images/synthetic_2.png}
230
+ \caption{Synthetic image, white on black.}
231
+ \label{fig:syn2}
232
+ \end{subfigure}
233
+ ~ %add desired spacing between images, e. g. ~, \quad, \qquad, \hfill etc.
234
+ %(or a blank line to force the subfigure onto a new line)
235
+ \caption{Synthetic test images for edge detection algorithms. \subref{fig:syn1} shows various gray levels that require an adaptive algorithm. \subref{fig:syn2}
236
+ shows more challenging edge detection tests that have crossing lines. Fusing these into full segments typically requires algorithms like the Hough transform.
237
+ This is an example of using subfigures, with \texttt{subref}s in the caption.
238
+ }\label{fig:synthetic}
239
+ \end{figure}
240
+
241
+ \clearpage
242
+
243
+ \subsection{Equations}
244
+
245
+ Equations should be typeset correctly and precisely. Make sure you get parenthesis sizing correct, and punctuate equations correctly
246
+ (the comma is important and goes \textit{inside} the equation block). Explain any symbols used clearly if not defined earlier.
247
+
248
+ For example, we might define:
249
+ \begin{equation}
250
+ \hat{f}(\xi) = \frac{1}{2}\left[ \int_{-\infty}^{\infty} f(x) e^{2\pi i x \xi} \right],
251
+ \end{equation}
252
+ where $\hat{f}(\xi)$ is the Fourier transform of the time domain signal $f(x)$.
253
+
254
+ \subsection{Algorithms}
255
+ Algorithms can be set using \texttt{algorithm2e}, as in Algorithm \ref{alg:metropolis}.
256
+
257
+ % NOTE: line ends are denoted by \; in algorithm2e
258
+ \begin{algorithm}
259
+ \DontPrintSemicolon
260
+ \KwData{$f_X(x)$, a probability density function returing the density at $x$.\; $\sigma$ a standard deviation specifying the spread of the proposal distribution.\;
261
+ $x_0$, an initial starting condition.}
262
+ \KwResult{$s=[x_1, x_2, \dots, x_n]$, $n$ samples approximately drawn from a distribution with PDF $f_X(x)$.}
263
+ \Begin{
264
+ $s \longleftarrow []$\;
265
+ $p \longleftarrow f_X(x)$\;
266
+ $i \longleftarrow 0$\;
267
+ \While{$i < n$}
268
+ {
269
+ $x^\prime \longleftarrow \mathcal{N}(x, \sigma^2)$\;
270
+ $p^\prime \longleftarrow f_X(x^\prime)$\;
271
+ $a \longleftarrow \frac{p^\prime}{p}$\;
272
+ $r \longleftarrow U(0,1)$\;
273
+ \If{$r<a$}
274
+ {
275
+ $x \longleftarrow x^\prime$\;
276
+ $p \longleftarrow f_X(x)$\;
277
+ $i \longleftarrow i+1$\;
278
+ append $x$ to $s$\;
279
+ }
280
+ }
281
+ }
282
+
283
+ \caption{The Metropolis-Hastings MCMC algorithm for drawing samples from arbitrary probability distributions,
284
+ specialised for normal proposal distributions $q(x^\prime|x) = \mathcal{N}(x, \sigma^2)$. The symmetry of the normal distribution means the acceptance rule takes the simplified form.}\label{alg:metropolis}
285
+ \end{algorithm}
286
+
287
+ \subsection{Tables}
288
+
289
+ If you need to include tables, like Table \ref{tab:operators}, use a tool like https://www.tablesgenerator.com/ to generate the table as it is
290
+ extremely tedious otherwise.
291
+
292
+ \begin{table}[]
293
+ \caption{The standard table of operators in Python, along with their functional equivalents from the \texttt{operator} package. Note that table
294
+ captions go above the table, not below. Do not add additional rules/lines to tables. }\label{tab:operators}
295
+ %\tt
296
+ \rowcolors{2}{}{gray!3}
297
+ \begin{tabular}{@{}lll@{}}
298
+ %\toprule
299
+ \textbf{Operation} & \textbf{Syntax} & \textbf{Function} \\ %\midrule % optional rule for header
300
+ Addition & \texttt{a + b} & \texttt{add(a, b)} \\
301
+ Concatenation & \texttt{seq1 + seq2} & \texttt{concat(seq1, seq2)} \\
302
+ Containment Test & \texttt{obj in seq} & \texttt{contains(seq, obj)} \\
303
+ Division & \texttt{a / b} & \texttt{div(a, b) } \\
304
+ Division & \texttt{a / b} & \texttt{truediv(a, b) } \\
305
+ Division & \texttt{a // b} & \texttt{floordiv(a, b)} \\
306
+ Bitwise And & \texttt{a \& b} & \texttt{and\_(a, b)} \\
307
+ Bitwise Exclusive Or & \texttt{a \textasciicircum b} & \texttt{xor(a, b)} \\
308
+ Bitwise Inversion & \texttt{$\sim$a} & \texttt{invert(a)} \\
309
+ Bitwise Or & \texttt{a | b} & \texttt{or\_(a, b)} \\
310
+ Exponentiation & \texttt{a ** b} & \texttt{pow(a, b)} \\
311
+ Identity & \texttt{a is b} & \texttt{is\_(a, b)} \\
312
+ Identity & \texttt{a is not b} & \texttt{is\_not(a, b)} \\
313
+ Indexed Assignment & \texttt{obj{[}k{]} = v} & \texttt{setitem(obj, k, v)} \\
314
+ Indexed Deletion & \texttt{del obj{[}k{]}} & \texttt{delitem(obj, k)} \\
315
+ Indexing & \texttt{obj{[}k{]}} & \texttt{getitem(obj, k)} \\
316
+ Left Shift & \texttt{a \textless{}\textless b} & \texttt{lshift(a, b)} \\
317
+ Modulo & \texttt{a \% b} & \texttt{mod(a, b)} \\
318
+ Multiplication & \texttt{a * b} & \texttt{mul(a, b)} \\
319
+ Negation (Arithmetic) & \texttt{- a} & \texttt{neg(a)} \\
320
+ Negation (Logical) & \texttt{not a} & \texttt{not\_(a)} \\
321
+ Positive & \texttt{+ a} & \texttt{pos(a)} \\
322
+ Right Shift & \texttt{a \textgreater{}\textgreater b} & \texttt{rshift(a, b)} \\
323
+ Sequence Repetition & \texttt{seq * i} & \texttt{repeat(seq, i)} \\
324
+ Slice Assignment & \texttt{seq{[}i:j{]} = values} & \texttt{setitem(seq, slice(i, j), values)} \\
325
+ Slice Deletion & \texttt{del seq{[}i:j{]}} & \texttt{delitem(seq, slice(i, j))} \\
326
+ Slicing & \texttt{seq{[}i:j{]}} & \texttt{getitem(seq, slice(i, j))} \\
327
+ String Formatting & \texttt{s \% obj} & \texttt{mod(s, obj)} \\
328
+ Subtraction & \texttt{a - b} & \texttt{sub(a, b)} \\
329
+ Truth Test & \texttt{obj} & \texttt{truth(obj)} \\
330
+ Ordering & \texttt{a \textless b} & \texttt{lt(a, b)} \\
331
+ Ordering & \texttt{a \textless{}= b} & \texttt{le(a, b)} \\
332
+ % \bottomrule
333
+ \end{tabular}
334
+ \end{table}
335
+ \subsection{Code}
336
+
337
+ Avoid putting large blocks of code in the report (more than a page in one block, for example). Use syntax highlighting if possible, as in Listing \ref{lst:callahan}.
338
+
339
+ \begin{lstlisting}[language=python, float, caption={The algorithm for packing the $3\times 3$ outer-totalistic binary CA successor rule into a
340
+ $16\times 16\times 16\times 16$ 4 bit lookup table, running an equivalent, notionally 16-state $2\times 2$ CA.}, label=lst:callahan]
341
+ def create_callahan_table(rule="b3s23"):
342
+ """Generate the lookup table for the cells."""
343
+ s_table = np.zeros((16, 16, 16, 16), dtype=np.uint8)
344
+ birth, survive = parse_rule(rule)
345
+
346
+ # generate all 16 bit strings
347
+ for iv in range(65536):
348
+ bv = [(iv >> z) & 1 for z in range(16)]
349
+ a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p = bv
350
+
351
+ # compute next state of the inner 2x2
352
+ nw = apply_rule(f, a, b, c, e, g, i, j, k)
353
+ ne = apply_rule(g, b, c, d, f, h, j, k, l)
354
+ sw = apply_rule(j, e, f, g, i, k, m, n, o)
355
+ se = apply_rule(k, f, g, h, j, l, n, o, p)
356
+
357
+ # compute the index of this 4x4
358
+ nw_code = a | (b << 1) | (e << 2) | (f << 3)
359
+ ne_code = c | (d << 1) | (g << 2) | (h << 3)
360
+ sw_code = i | (j << 1) | (m << 2) | (n << 3)
361
+ se_code = k | (l << 1) | (o << 2) | (p << 3)
362
+
363
+ # compute the state for the 2x2
364
+ next_code = nw | (ne << 1) | (sw << 2) | (se << 3)
365
+
366
+ # get the 4x4 index, and write into the table
367
+ s_table[nw_code, ne_code, sw_code, se_code] = next_code
368
+
369
+ return s_table
370
+
371
+ \end{lstlisting}
372
+
373
+ %==================================================================================================================================
374
+ \chapter{Evaluation}
375
+ How good is your solution? How well did you solve the general problem, and what evidence do you have to support that?
376
+
377
+ \section{Guidance}
378
+ \begin{itemize}
379
+ \item
380
+ Ask specific questions that address the general problem.
381
+ \item
382
+ Answer them with precise evidence (graphs, numbers, statistical
383
+ analysis, qualitative analysis).
384
+ \item
385
+ Be fair and be scientific.
386
+ \item
387
+ The key thing is to show that you know how to evaluate your work, not
388
+ that your work is the most amazing product ever.
389
+ \end{itemize}
390
+
391
+ \section{Evidence}
392
+ Make sure you present your evidence well. Use appropriate visualisations, reporting techniques and statistical analysis, as appropriate.
393
+
394
+ If you visualise, follow the basic rules, as illustrated in Figure \ref{fig:boxplot}:
395
+ \begin{itemize}
396
+ \item Label everything correctly (axis, title, units).
397
+ \item Caption thoroughly.
398
+ \item Reference in text.
399
+ \item \textbf{Include appropriate display of uncertainty (e.g. error bars, Box plot)}
400
+ \item Minimize clutter.
401
+ \end{itemize}
402
+
403
+ See the file \texttt{guide\_to\_visualising.pdf} for further information and guidance.
404
+
405
+ \begin{figure}
406
+ \centering
407
+ \includegraphics[width=1.0\linewidth]{images/boxplot_finger_distance.pdf}
408
+
409
+ \caption{Average number of fingers detected by the touch sensor at different heights above the surface, averaged over all gestures. Dashed lines indicate
410
+ the true number of fingers present. The Box plots include bootstrapped uncertainty notches for the median. It is clear that the device is biased toward
411
+ undercounting fingers, particularly at higher $z$ distances.
412
+ }
413
+
414
+ % use the notation fig:name to cross reference a figure
415
+ \label{fig:boxplot}
416
+ \end{figure}
417
+
418
+
419
+ %==================================================================================================================================
420
+ \chapter{Conclusion}
421
+ Summarise the whole project for a lazy reader who didn't read the rest (e.g. a prize-awarding committee).
422
+ \section{Guidance}
423
+ \begin{itemize}
424
+ \item
425
+ Summarise briefly and fairly.
426
+ \item
427
+ You should be addressing the general problem you introduced in the
428
+ Introduction.
429
+ \item
430
+ Include summary of concrete results (``the new compiler ran 2x
431
+ faster'')
432
+ \item
433
+ Indicate what future work could be done, but remember: \textbf{you
434
+ won't get credit for things you haven't done}.
435
+ \end{itemize}
436
+
437
+ %==================================================================================================================================
438
+ %
439
+ %
440
+ %==================================================================================================================================
441
+ % APPENDICES
442
+
443
+ \begin{appendices}
444
+
445
+ \chapter{Appendices}
446
+
447
+ Typical inclusions in the appendices are:
448
+
449
+ \begin{itemize}
450
+ \item
451
+ Copies of ethics approvals (required if obtained)
452
+ \item
453
+ Copies of questionnaires etc. used to gather data from subjects.
454
+ \item
455
+ Extensive tables or figures that are too bulky to fit in the main body of
456
+ the report, particularly ones that are repetitive and summarised in the body.
457
+
458
+ \item Outline of the source code (e.g. directory structure), or other architecture documentation like class diagrams.
459
+
460
+ \item User manuals, and any guides to starting/running the software.
461
+
462
+ \end{itemize}
463
+
464
+ \textbf{Don't include your source code in the appendices}. It will be
465
+ submitted separately.
466
+
467
+ \end{appendices}
468
+
469
+ %==================================================================================================================================
470
+ % BIBLIOGRAPHY
471
+
472
+ % The bibliography style is abbrvnat
473
+ % The bibliography always appears last, after the appendices.
474
+
475
+ \bibliographystyle{abbrvnat}
476
+
477
+ \bibliography{l4proj}
478
+
479
+ \end{document}
plan.md ADDED
@@ -0,0 +1,40 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Plan
2
+
3
+ * PROJECT TITLE
4
+ * YOUR NAME
5
+ * STUDENT ID
6
+ * SUPERVISOR NAME
7
+
8
+ Week-by-week plan for the whole project. Update this as you go along.
9
+
10
+ ## Winter semester
11
+
12
+ * **Week 1**
13
+ * **Week 2**
14
+ * **Week 3**
15
+ * **Week 4**
16
+ * **Week 5**
17
+ * **Week 6**
18
+ * **Week 7**
19
+ * **Week 8**
20
+ * **Week 9**
21
+ * **Week 10**
22
+ * **Week 11 [PROJECT WEEK]**
23
+ * **Week 12 [PROJECT WEEK]** Status report submitted.
24
+
25
+ ## Winter break
26
+
27
+ ## Spring Semester
28
+
29
+ * **Week 13**
30
+ * **Week 14**
31
+ * **Week 15**
32
+ * **Week 16**
33
+ * **Week 17**
34
+ * **Week 19**
35
+ * **Week 20**
36
+ * **Week 21**
37
+ * **Week 22**
38
+ * **Week 23 [TERM ENDS]**
39
+ * **Week 24** Dissertation submission deadline and presentations.
40
+
presentation/readme.md ADDED
@@ -0,0 +1,4 @@
 
 
 
 
 
1
+ # Presentation
2
+
3
+ Include your presentation slides here. You should include the slides in the original format you authored them in (e.g. PowerPoint, Keynote), *and*
4
+ a `pdf` version of the slides. Any necessary videos, audio, images, figures, etc. should be present.
src/manual.md ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ # User manual
2
+
3
+ Describe how to use your software, if this makes sense for your code. Almost all projects should have at least some instructions on how to run the code. More extensive instructions can be provided here.
src/readme.md ADDED
@@ -0,0 +1,41 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Readme
2
+
3
+ Put a brief description of your code here. This should at least describe the file structure.
4
+
5
+ ## Build instructions
6
+
7
+ **You must** include the instructions necessary to build and deploy this project successfully. If appropriate, also include
8
+ instructions to run automated tests.
9
+
10
+ ### Requirements
11
+
12
+ List the all of the pre-requisites software required to set up your project (e.g. compilers, packages, libraries, OS, hardware)
13
+
14
+ For example:
15
+
16
+ * Python 3.7
17
+ * Packages: listed in `requirements.txt`
18
+ * Tested on Windows 10
19
+
20
+ or another example:
21
+
22
+ * Requires Raspberry Pi 3
23
+ * a Linux host machine with the `arm-none-eabi` toolchain (at least version `x.xx`) installed
24
+ * a working LuaJIT installation > 2.1.0
25
+
26
+ ### Build steps
27
+
28
+ List the steps required to build software.
29
+
30
+ Hopefully something simple like `pip install -e .` or `make` or `cd build; cmake ..`. In
31
+ some cases you may have much more involved setup required.
32
+
33
+ ### Test steps
34
+
35
+ List steps needed to show your software works. This might be running a test suite, or just starting the program; but something that could be used to verify your code is working correctly.
36
+
37
+ Examples:
38
+
39
+ * Run automated tests by running `pytest`
40
+ * Start the software by running `bin/editor.exe` and opening the file `examples/example_01.bin`
41
+
status_report/exemplar/status_report_exemplar.tex ADDED
@@ -0,0 +1,120 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+
2
+ \documentclass[11pt]{article}
3
+ \usepackage{times}
4
+ \usepackage{fullpage}
5
+
6
+ \title{Audio feedback for gesture recognition}
7
+ \author{John Williamson 9804750w}
8
+
9
+ \begin{document}
10
+ \maketitle
11
+
12
+
13
+
14
+
15
+
16
+
17
+ \section{Proposal}\label{proposal}
18
+
19
+ \subsection{Motivation}\label{motivation}
20
+
21
+ Gesture recognition offers the opportunity to add controls to a myriad of sensing
22
+ devices, particularly on mobile devices with limited control inputs. However, the
23
+ resulting interfaces are hard to interpret. Adding auditory feedback to indicate
24
+ the progress and success of gesture recognition could improve the usability of
25
+ gesture recognition systems.
26
+
27
+
28
+ \subsection{Aims}\label{aims}
29
+
30
+ This project will develop a software framework for systematically exploring
31
+ audio feedback options for gesture recognition. This will be a modular visual
32
+ programming environment that allows various gesture recognisers to be configured
33
+ and their output processed and fed to audio synthesis devices. The effectiveness
34
+ of the project in improving gesture usability will be experimentally validated.
35
+
36
+ \section{Progress}\label{progress}
37
+
38
+ \begin{itemize}
39
+ \tightlist
40
+ \item Language and GUI framework chosen: project will be implemented in Java,
41
+ using Swing for GUI development.
42
+ \item Software architecture outlined and basic class structure written.
43
+ \item Background research conducted on gesture recognition technologies and
44
+ feedback mechanisms.
45
+ \item Interfacing to inertial sensing unit in Java completed.
46
+ \item Initial version of GUI developed, which allows basic signal processing to
47
+ be applied to mouse input, with interchangable blocks.
48
+ \item Basic finite state machine gesture recogniser implemented.
49
+ \item Initial MIDI note based output implemented and working. Limited to
50
+ pitch mapping.
51
+ \end{itemize}
52
+
53
+ \section{Problems and risks}\label{problems-and-risks}
54
+
55
+ \subsection{Problems}\label{problems}
56
+
57
+ The following issues were encountered in the project so far.
58
+ \begin{itemize}
59
+ \tightlist
60
+ \item Inertial sensing unit had unsupported and out-of-date drivers. Some tricky
61
+ fixes had to be applied to get inputs.
62
+ \item Many different types of gesture recognition; not clear which ones to focus
63
+ on.
64
+ \item Implemented FSM recogniser is not robust.
65
+ \item Significant latency issues in rendering audio via Java with default audio
66
+ generation libraries.
67
+ \end{itemize}
68
+
69
+ \subsection{Risks}\label{risks}
70
+
71
+ \begin{itemize}
72
+ \tightlist
73
+ \item Many different gesture recognisers to explore. \textbf{Mitigation}: will narrow
74
+ down to three possibilities by start of next semester.
75
+ \item Unclear how to evaluate success of the project. \textbf{Mitigation}: will do
76
+ background research to investigate how success of audio recognition has
77
+ been performed in the research literature.
78
+ \item Inertial sensing device seems to be unreliable. \textbf{No clear mitigation available at this stage}
79
+ \end{itemize}
80
+
81
+ \section{Plan}\label{plan}
82
+
83
+ \subsection{Semester 2}
84
+
85
+ \begin{itemize}
86
+ \tightlist
87
+ \item
88
+ Week 1-2: develop visual programming interface. \textbf{Deliverable:}
89
+ complete interface that allows components to be added, removed and
90
+ rearranged.
91
+ \item
92
+ Week 3-5: implement three recognisers and test them with a standard
93
+ recognition task. \textbf{Deliverable:} tested recognisers with
94
+ initial performance metrics and integration with visual programming
95
+ environment.
96
+ \item
97
+ Week 6: research on how to best evaluate performance of final system.
98
+ \textbf{Deliverable:} detailed evaluation plan, with participant
99
+ numbers, information sheet and analysis plan.
100
+ \item
101
+ Week 7-9: final implementation and improvements to audio rendering.
102
+ \textbf{Deliverable: polished software ready, passing basic tests,
103
+ ready for evaluation stage.}
104
+ \item
105
+ Week 9: evaluation experiments run. \textbf{Deliverable: quantitative
106
+ measures of usability and qualitative measures of effectiveness for at
107
+ least ten users.}
108
+ \item
109
+ Week 8-10: Write up. \textbf{Deliverable: first draft submitted to
110
+ supervisor two weeks before final deadline.}
111
+ \end{itemize}
112
+
113
+
114
+ \section{Ethics}
115
+
116
+ This project will involve tests with human users. These will be user studies
117
+ using standard hardware, and require no personally identifiable information to be captured.
118
+ I have verified that the experiments I plan to do comply with the Ethics Checklist.
119
+
120
+ \end{document}
status_report/status_report_template.tex ADDED
@@ -0,0 +1,68 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+
2
+ \documentclass[11pt]{article}
3
+ \usepackage{times}
4
+ \usepackage{fullpage}
5
+
6
+ \title{ {{cookiecutter.project_title}}
7
+ \author{ {{cookiecutter.student_name}} - {{cookiecutter.student_id}} }
8
+
9
+ \begin{document}
10
+ \maketitle
11
+
12
+
13
+
14
+
15
+ \section{Status report}
16
+
17
+ \subsection{Proposal}\label{proposal}
18
+
19
+ \subsubsection{Motivation}\label{motivation}
20
+
21
+ \emph{{[}Clearly motivate the purpose of your project; why someone would
22
+ care about what you are doing{]}}
23
+
24
+ \subsubsection{Aims}\label{aims}
25
+
26
+ \emph{{[}Clearly state what the project is intended to do. This should
27
+ be something which is measurable; it should be possible to tell if you
28
+ succeeded{]}}
29
+
30
+ \subsection{Progress}\label{progress}
31
+
32
+ \emph{{[}Briefly state your progress so far, as a bulleted list{]}}
33
+
34
+ \subsection{Problems and risks}\label{problems-and-risks}
35
+
36
+ \subsubsection{Problems}\label{problems}
37
+
38
+ \emph{{[}What problems have you had so far, that have held up the
39
+ project?{]}}
40
+
41
+ \subsubsection{Risks}\label{risks}
42
+
43
+ \emph{{[}What problems do you foresee in the future and how will you
44
+ mitigate them?{]}}
45
+
46
+ \subsection{Plan}\label{plan}
47
+
48
+ \emph{{[}Time plan, in roughly weekly to monthly blocks, up until
49
+ submission week{]}}
50
+
51
+
52
+ \subsection{Ethics and data}\label{ethics}
53
+ \emph{Specify what ethical approval you need to do your evaluation and how you are approaching it. This is mandatory.
54
+ Specify what data you expect to collect in your evaluation. Explain how this data will help you evaluate your project.
55
+ }
56
+
57
+ Options for ethics:
58
+ \item This project does not involve human subjects or data. No approval required.
59
+ \item I have verified that the ethics checklist will apply to any evaluation I need to do. I will sign and complete the checklist.
60
+ \item I have sought ethical guidance from the School's ethics convener and I will:
61
+ \begin{itemize}
62
+ \item Proceed under specific instructions from the Ethics convener (e.g. modified checklist).
63
+ \item Apply for College Ethics Board approval.
64
+ \item Other procedure (give details)
65
+ \end{itemize}
66
+
67
+
68
+ \end{document}
summer/readme.md ADDED
@@ -0,0 +1,17 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Summer work
2
+
3
+ * PROJECT NAME
4
+ * YOUR NAME
5
+ * STUDENT_ID
6
+ * SUPERVISOR NAME
7
+
8
+ Use this file to keep a report stating what you completed over the summer. The following is an *template* that you can use as a basis.
9
+
10
+ ## Research completed
11
+
12
+ ## Ideas developed
13
+
14
+ ## Concerns or risks identified
15
+
16
+
17
+
timelog.md ADDED
@@ -0,0 +1,26 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Timelog
2
+
3
+ * Text-generation with rhyme and rhythm
4
+ * Ans Farooq
5
+ * 2390370f
6
+ * Jake Lever
7
+
8
+ ## Guidance
9
+
10
+ * This file contains the time log for your project. It will be submitted along with your final dissertation.
11
+ * **YOU MUST KEEP THIS UP TO DATE AND UNDER VERSION CONTROL.**
12
+ * This timelog should be filled out honestly, regularly (daily) and accurately. It is for *your* benefit.
13
+ * Follow the structure provided, grouping time by weeks. Quantise time to the half hour.
14
+
15
+ ## Week 1
16
+
17
+ ### 19 Oct 2019
18
+
19
+ * *4 hours* Read the project guidance notes
20
+ * *0.5 hour* Created GitLab repository and cloned the cookiecutter for the projects
21
+ * *1 hour* Modified dissertation template, compiled
22
+
23
+ ## 20 Oct 2019
24
+
25
+ * *1 hour* meeting with supervisor
26
+ * *2 hours* writing initial version of test harness