<html><head><meta name="color-scheme" content="light dark"></head><body><pre style="word-wrap: break-word; white-space: pre-wrap;">%=================================================================
\section{The alogavg Tool}
%=================================================================
\label{sec_alogavg}
\index{alogavg!Overview}

The post-mission analysis pipeline starts with raw alog files and ends
with plotted data. The raw data in alog files cannot be directly
plotted without some filtering and analysis steps.  The \cmd{alogavg}
tool is one of the tools for performing these steps. These steps could
also be done within the plotting language such as Matlab or Python,
but our preference is to have general tools in the ALog Toolbox for
these steps to allow users to choose between plotting tools without
having to re-write the data preparation steps in each plotting
language.

\vspace{0.1in}
\noindent
A concise form of this documentation is available on the command line:

\vspace{0.1in}
\begin{consoleverb}
$ alogavg --help    (or -h)
\end{consoleverb}
\vspace{0.1in}

\noindent
The web version of this content can be quickly summoned from the command
line with:

\vspace{0.1in}
\begin{consoleverb}
$ alogavg --web    (or -w)
\end{consoleverb}


%=================================================================
\subsection{Input Format for alogavg}

The \cmd{alogavg} tool ingests a single file, using the
\var{--file=file.txt} argument. This file will have two columns
of data, the domain (x) in the first column, and the range (y)
in the second column. A file of this type may have been produced
by \cmd{aloggrep} directly from the raw alog file.
No ordering is presumed. A simple example:

\vspace{0.1in}
\begin{fileverb}
 2  289.09                                             
 1  357.331                                            
 2  287.762                                            
 1  358.505                                            
 2  289.645                                            
 1  358.952
\end{fileverb}
\vspace{0.1in}

\noindent
For now it is assumed that the column separator is white space (ASCII
32). White space at either the beginning or end of each line is
ignored, and it does not matter how much white space is between the
two columns.

%=================================================================
\subsection{Output Format for alogavg}

The output of \cmd{alogavg} will be five columns:

\begin{packed_itemize}
\item The domain (x values), ordered
\item The average of the range (y values)
\item The minimum range value for the given domain value
\item The maximum range value for the given domain value
\item The standard deviation of range values for the given domain value
\end{packed_itemize}

\vspace{0.1in}
\noindent
A simple example, using the data above, stored in \var{file.log}:

\vspace{0.1in}
\begin{consoleverb}
$ alogavg file.log
1 358.262667 357.331 358.952 0.683596                 
2 288.832333 287.762 289.645 0.790028 
\end{consoleverb}
\vspace{0.1in}

\noindent
By default the columns of the output are padded to line up all columns
in a more human readable format. With the \var{--noformat} option, the
columns will all be separated by a single white space. 


</pre></body></html>