AFIT Thesis Template
Forfatter
Dr. David Woodburn
Sidst opdateret
7 måneder siden
Licens
Other (as stated in the work)
Resumé
AFIT Thesis Template compliant with the AFIT Style Guide
\documentclass[numbered]{afitthesis}
% Define your glossary words here. (optional)
\def\afit{Air Force Institute of Technology}
% Main document information
\author{John Doe}
\rank{First Lieutenant, USAF}
\previousdegrees{B.S.E.E.}
\newdegree{Master of Science in Electrical Engineering}
\graduationdate{September 2022}
\title{Doing Great Things as a Student}
%\doctype{dissertation}
\docdesignator{AFIT-ENG-MS-XX-XXXX}
\department{Department of Electrical and Computer Engineering}
\committee{
{Albert Einstein, Ph.D\\Chair},
{Michael Faraday, Ph.D\\Member},
{Carl Gauss, Ph.D\\Member}}
\abstract{This is a high-level explanation of the point of this research.}
\dedication{To the one who loves me most.}
\acknowledgments{I would like to thank the entire committee for your great
support.}
% SF 298 (Report Documentation Page) information
\sfReportDate{26--03--2020}
\sfReportType{Master's Thesis}
\sfStartDate{Sept 2018}
\sfEndDate{Mar 2020}
\sfContractNumber{DACA99--99--C--9999}
\sfGrantNumber{}
\sfProgramElementNumber{}
\sfProjectNumber{09ENP???}
\sfTaskNumber{}
\sfWorkUnitNumber{}
\sfSponsorAgency{AFXX/XXXX\\
Building XXX, WPAFB OH 45433-7765\\
DSN XXX-XXXX, COMM 937-XXX-XXXX, Email: first.last@us.af.mil }
\sfSponsorAcronyms{}
\sfSponsorReportNumber{}
\sfSupplementaryNotes{}
\sfAbstract{Summarized version of your abstract.}
\sfSubjectTerms{artificial neural network (ANN), deep learning}
\sfReportClassification{}
\sfAbstractClassification{}
\sfPageClassification{}
\sfAbstractLimitation{UU}
\sfResponsiblePerson{Dr. Your Advisor, AFIT/ENG}
\sfPhoneNumber{(937) 255-3636(937) 255-3636 x9999}
\begin{document}
\maketitle % This command will create all the prefatory pages.
% ------------------------------------------------------------------------------
\chapter{Introduction}
\section{Document Class Options}
The first line of your \LaTeX\ document should specify the document class:
\begin{verbatim}
\documentclass{afitthesis}
\end{verbatim}
You can pass a few options to this document class. You choose the body text font
size: \verb|10pt|, \verb|11pt|, or \verb|12pt|. The default is \verb|11pt|. You
can specify if IEEE (e.g., ``[1]'') or author-year (e.g., ``(Savage, 2015)'')
style citation references should be used. The default is author-year. To specify
the IEEE style, pass the option \verb|ieee|. So, if we wanted to use 12~pt font
and use IEEE style, we would write the following as our first line:
\begin{verbatim}
\documentclass[12pt, ieee]{afitthesis}
\end{verbatim}
\emph{Please note that the AFIT Style Guide does not number sections and
subsections, only chapters. This is on purpose.} However, if you and your
adviser choose to deviate from this rule, you can use the optional parameter
\verb|numbered| \emph{to add IEEE-style numbering to sections, subsections and
subsubsections:}
\begin{verbatim}
\documentclass[numbered]{afitthesis}
\end{verbatim}
\section{Content Location}
Any content (like chapters) can be moved into their own files and then included
into your main document using the \verb|\input{filename.tex}| command. You do
not have to keep all your content in one file!
You can put all your figures into a subfolder and then tell \LaTeX\ where to
look for figures by using the \verb|\graphicspath{{ }}| command, where the
folder name (e.g., \verb|figs/|) would go inside the \emph{double} braces.
\section{Equations}
To reference figures, tables, and algorithms, you would use the generic
\verb|\ref| command. To reference an equation, you can use the \verb|\eqref|
command. So, the following equation is referenced by using its label:
\verb|\eqref{eq_formula}|. Our first equation is \eqref{eq_formula}.
\begin{equation}
\diff{y}{x} = 2 \cos(2 \PI \theta) + 5.2\upi + \varOmega
\label{eq_formula}
\end{equation}
Here is a list of convenience commands that have been added:
\begin{center}
\begin{tabular}{l|c|l}
\verb|\diff{}{}| & $\diff{y}{x}$ & derivative \\
\verb|\pdiff{}{}| & $\pdiff{y}{x}$ & partial derivative \\
\verb|\abs{}| & $\abs{a}$ & absolute value \\
\verb|\norm{}| & $\norm{\ul{a}}$ & norm of vector \\
\verb|\ssm{}| & $\ssm{\ul{w}}$ & skew-symmetric matrix \\
\verb|\upd| & $\upd$ & differential operator \\
\verb|\upe| & $\upe$ & Euler's number \\
\verb|\upi| & $\upi$ & first basic quaternion \\
\verb|\upj| & $\upj$ & second basic quaternion \\
\verb|\upk| & $\upk$ & third basic quaternion \\
\verb|\PI| & $\PI$ & Archimedes' constant (3.14159...)
\end{tabular}
\end{center}
The \verb|\PI| ($\PI$) macro differs from \verb|\pi| ($\pi$). Constants should
be upright and variables should be italicized. Since the builtin \verb|\pi|
($\pi$) is italicized, \verb|\PI| ($\PI$) was created.
If you need to show units with a micro prefix, use the \verb|\micro| command, as
in $10^{6}$~\micro s.
\section{Figures}
Here is Figure~\ref{fig_first} showing the \afit\ (AFIT) crest. Using
\verb|htbp!| \emph{encourages} \LaTeX\ to keep the figure ``\textbf{h}ere''.
However, note that \LaTeX\ will not always follow your request. To reference a
figure, write ``\verb|Figure|'' or ``\verb|Fig.|'', a tilde (\verb|~|), and the
generic \verb|\ref| command: \verb|Figure.~\ref{fig_first}|. The tilde makes
sure that ``\verb|Figure|'' and the number are never separated on different
lines of text. Make sure to put figure captions \emph{below} the figure.
\begin{figure}[ht!]
\centering
\begin{tikzpicture}
\begin{axis}[
xlabel={Time, $t$ (s)},
ylabel={Amplitude},
grid=both, grid style={gray!25},
axis lines=left,
xmin=-180, xmax=180,
width=5in, height=3in,
legend style={at={(1,0.01)}, anchor=south east}]
\addplot[azure, line width=1pt, domain=-180:180, samples=60]
{cos(x)};
\addplot[lime, line width=1pt, domain=-180:180, samples=60]
{sin(x)};
\legend{{Voltage (V)}, {Current (A)}};
\end{axis}
\end{tikzpicture}
\caption{This is a figure.}
\label{fig_first}
\end{figure}
\emph{Please note that for pdf images to work correctly on OverLeaf, you need to
use the pdfLaTeX compiler, not the LaTeX compiler.}
When you save a figure from MATLAB, (1) make sure the figure is clear and does
not get pixelated, (2) remove excess white space from the sides of the figure,
and (3) make sure the text size is large enough to see. These can all be
accomplished by running the following function immediately after you have
created the plot:
\begin{matlab}
function savepdf(name, width, height)
% name is the file name including ".pdf".
% Both width and height are in (cm).
if nargin < 1 || isempty(name)
name = "fig.pdf";
width = 8.636;
height = 5.3373;
elseif nargin < 2 || isempty(width)
width = 8.636;
height = 5.3373;
elseif nargin < 3 || isempty(height)
height = width*0.618;
end
set(gcf, 'units', 'centimeters', ...
'position', [0, 0, width, height])
set(gca, 'FontSize', 9);
set(gca, 'FontName', 'Times New Roman');
exportgraphics(gcf, name, ...
'ContentType', 'vector');
end
\end{matlab}
Put this function into your ``MATLAB'' folder, and it will always be accessible
by whatever script you are running. For two-column documents, a width of
8.636~cm (3.4~in.) is the default. For a thesis, a width of 15.24~cm (6~in.) is
recommended.
\section{Tables}
In \LaTeX\ you can align tables \textbf{l}eft, \textbf{r}ight, or
\textbf{c}enter. However, the AFIT Style Guide requires that columns with only
decimal values be aligned along the decimal point. This is not a builtin feature
of \LaTeX. However, a decimal alignment style has been added for you. Use the
`.' column type to align numbers along their decimal points. Make sure to put
table captions \emph{above} the table.
\begin{table}[ht!]
\centering
\caption{This is a table. See how the decimal values are aligned along
their decimal points.}
\begin{tabular}{l|...}
\hline \hline
Unit & \text{pt} & \text{cm} & \text{in} \\
\hline
pt & 1.0 & 28.45274 & 72.26999 \\
cm & 0.03514 & 1.0 & 2.54 \\
in & 0.01384 & 0.3937 & 1.0 \\
\hline \hline
\end{tabular}
\label{tab_test}
\end{table}
Also, by default, the alignment specifiers do not support multi-line text in a
single table cell. So, three additional alignment specifiers are provided:
\textbf{L}, \textbf{C}, and \textbf{R}. These each take one parameter: the width
of the column. So, if you wanted a column to be left aligned and exactly 3~cm
wide so that any text wider than that would automatically wrap, use the
alignment specifier \verb|L{3cm}|.
\section{Code and Pseudocode}
If you have code you wrote or used for your thesis, generally you would not show
the actual code. Some readers might not be familiar with the particular
programming language you are using and often showing explicit code gets too much
into the details of the language. Rather, use pseudocode with math expressions
where appropriate. For this, use the \verb|pseudocode| environment. Keywords
like \verb|if|, \verb|then|, \verb|else|, and \verb|while|, and \verb|function|
will be automatically formatted in bold. The reason for using the left arrow
(\verb|\gets|) instead of an equals sign is that an equals sign implies that at
all points in a flow of equations, the equality is true, whereas the left arrow
implies that the equality is only necessarily true at that point in the
algorithm and henceforth until it is redefined.
If you want to be able to cite the pseudocode, wrap the \verb|pseudocode|
environment in an \verb|algorithm| environment, just like a \verb|tabular|
environment within a \verb|table| environment. An example algorithm is shown in
Algorithm~\ref{alg_example}. In order to write the algorithm shown in
Algorithm~\ref{alg_example}, you would type the following:
\par\bigskip
\begin{minipage}{3in}
\begin{verbatim}
function factorial($N$)
print "Calculating factorial ..."
$x \gets 1$
for $n$ in $1$ to $N$
$x \gets x \cdot n$
end for
return $x$
end function
\end{verbatim}
\end{minipage}
\begin{algorithm}[ht!]
\caption{This is some pseudocode.}
\begin{pseudocode}
function factorial($N$)
print "Calculating factorial ..."
$x \gets 1$
for $n$ in $1$ to $N$
$x \gets x \cdot n$
end for
return $x$
end function
\end{pseudocode}
\label{alg_example}
\end{algorithm}
If for some reason, you really need to put actual computer code into your paper,
the \verb|python|, \verb|matlab|, and \verb|rlang| environments have been
created for you. (This means for some Python code, for example, prefix your code
with \verb|\begin{python}| and postfix it with \verb|\end{python}|.) These will
automatically syntactically highlight the source code. Here is an example in
Python:
\begin{python}
def factorial(N):
print("Calculating factorial ...")
x = 1
for n in range(1, N + 1):
x *= n
return x
\end{python}
Optionally, you can control the starting line number. If you wanted the above
code to start line numbering at 7, you would prefix the code with
\verb|\begin{python}[7]|.
You can also have \LaTeX\ read the source code directly from another file. The
commands are
\begin{center}
\begin{tabular}{ll}
Python & \verb|\inputpython{file.py}{1}{6}| \\
MATLAB & \verb|\inputmatlab{file.m}{1}{6}| \\
R & \verb|\inputrlang{file.r}{1}{6}|
\end{tabular}
\end{center}
The first parameter is the name of the file to read the code from. The second
parameter is first line to read, and the third parameter is the last line to
read.
You can also include small code expressions in a paragraph using a command
similar to the \LaTeX-builtin \verb|\verb| command. For Python, write the
\verb|\py| command followed by a character like `\verb+|+', the text, and then
the same character. So, \verb+\py|np.array(["A", 1.5])|+ will produce
\py|np.array(["A", 1.5])|. For MATLAB, the command is \verb|\mat| and for R it
is \verb|\rlng|.
\section{Citation}
The AFIT Style Guide permits a few styles for citations. The preferred style is
the author-year. So, a paper by W.~A.~Poor in 1989 would be cited as
(\cite{poor1989}). To achieve this, your bibliography entry would start like
this
\begin{verbatim}
\bibitem[Poor, 1989]{poor1989} W. A. Poor, ``A Geometric Description of
\end{verbatim}
where the \verb|[Poor, 1989]| is the text that will be displayed when you cite
it (except surrounded by parentheses instead of brackets) and \verb|(poor1989)|
is the label you would use to cite it: \verb|(\cite{poor1989})|. If you have
multiple citations in a group, separate them with semicolons. So, the code
\begin{verbatim}
(\cite{doe1998}; \cite{smith2003}; \cite{cane2008})
\end{verbatim}
would render as ``(Doe, 1998; Smith, 2003; Cane, 2008).'' One of the advantages
of this method is that it gives better context to the citation than a simple
number because it tells the reader who the author is and when it was written.
Another advantage is that it does not require sorting your bibliography by order
of appearance. Instead, you need to sort alphabetically by the first author's
last name. This means that much of the automation of complex packages like {\rm
B\kern-.05em{\sc i\kern-.025em b}\kern-.08em
T\kern-.1667em\lower.7ex\hbox{E}\kern-.125emX} is unnecessary.
However, if for some reason you are required to use the IEEE style of citation,
simply remove the optional (bracketted) parameters to the \verb|\bibitem|
commands, remove the extra pairs of parentheses around the \verb|\cite|
commands, and add the \verb|ieee| option to your document class:
\begin{verbatim}
\documentclass[ieee]{afitthesis}
\end{verbatim}
\section{Standard Form 298}
All theses and dissertations must be accompanied by a Standard Form 298. This
\LaTeX\ class file has builtin an updated 2020 version of the form. The form
can be downloaded from
\url{https://www.gsa.gov/forms-library/report-documentation-page}. Note, the
instructions for this form can also be found there. To add the form to your
paper, the last command before \verb|\end{document}| should be
\verb|\sfTwoNineEight|. To fill in the fields of this form, use the following
commands:
\begin{verbatim}
\sfReportDate{} \sfSponsorAcronyms{}
\sfReportType{} \sfSponsorReportNumber{}
\sfStartDate{} \sfAbstract{}
\sfEndDate{} \sfSubjectTerms{}
\sfContractNumber{} \sfReportClassification{}
\sfGrantNumber{} \sfAbstractClassification{}
\sfProgramElementNumber{} \sfPageClassification{}
\sfProjectNumber{} \sfAbstractLimitation{}
\sfTaskNumber{} \sfResponsiblePerson{}
\sfWorkUnitNumber{} \sfPhoneNumber{}
\sfSponsorAgency{}
\end{verbatim}
The rest of the needed information is automatically retrieved from the document
variables: \verb|\title|, \verb|\author|, etc. However, you can override those
definitions with the following commands:
\begin{verbatim}
\sfTitle{} \sfDocDesignator{}
\sfRank{} \sfDistribution{}
\sfAddress{} \sfPageCount{}
\end{verbatim}
% ------------------------------------------------------------------------------
\chapter{Literature Review}
% ------------------------------------------------------------------------------
\chapter{Methodology}
% ------------------------------------------------------------------------------
\chapter{Results and Analysis}
% ------------------------------------------------------------------------------
\chapter{Conclusion}
\appendix % This command is necessary before any appendix chapters.
% --------------------------------- optional -----------------------------------
\chapter{List of Acronyms}
If you wish, you can use more complicated methods for acronyms, such as the
glossaries package. However, simply defining a macro for a name can be
sufficient:
\begin{verbatim}
\def\afit{Air Force Institute of Technology}
\end{verbatim}\vspace{-1em}
Then, when you need to list all your acronyms, simply make a table, referencing
your list of defined acronyms. The AFIT Style Guide permits putting your lists
of acronyms, symbols, and such into the appendices section of your paper.
% ------------------------------------------------------------------------------
\begin{thebibliography}{9}
\bibitem[Poor, 1989]{poor1989} W. A. Poor, ``A Geometric Description of
Wander Azimuth Frames,'' \textit{Journal of the Institute of
Navigation}, vol.~36, no.~3, Fall 1989. [Online serial].
\bibitem[Savage, 2000]{savage2000} P. G. Savage, \textit{Strapdown Analytics
II, Part 1}, Strapdown Associates, Inc., 2000.
\bibitem[Savage, 2015]{savage2015} P. G. Savage, ``Computational Elements
For Strapdown Systems,'' Strapdown Associates, Inc., 2015.
\end{thebibliography}
% --------------------------------- optional -----------------------------------
\begin{vita}
If you are adding a description about yourself. Use the \verb|vita|
environment. Keep the contents to one page. If for some reason there is
more than one author contributing to this paper, each author should have a
separate page.
\end{vita}
% This command adds the Standard Form 298 to your document.
\sfTwoNineEight
\end{document}