X-Git-Url: http://git.kpe.io/?p=ctsim.git;a=blobdiff_plain;f=doc%2Fctsim-textui.tex;h=900c1622963b590ab9c0fc2de53232077eb124f8;hp=c6fc11d4a3288fe0e29d37d6f121749bce814c08;hb=8c02f79d3423db4a2d54e35cd4795629834357c9;hpb=82ea0c94394a5a175b260160760155a6686203a1 diff --git a/doc/ctsim-textui.tex b/doc/ctsim-textui.tex index c6fc11d..900c162 100644 --- a/doc/ctsim-textui.tex +++ b/doc/ctsim-textui.tex @@ -55,13 +55,13 @@ both real and complex valued images. \texttt{if1 input-filename output-filename [options...]} \textbf{Options} -\begin{itemize}\itemsep=0pt - \item \doublehyphen{invert} - Negate pixel values - \item \doublehyphen{log} - Take natural logrithm of pixel values - \item \doublehyphen{exp} - Take natural exponent of pixel values - \item \doublehyphen{sqr} - Take square of pixel values - \item \doublehyphen{sqrt} - Take square root of pixel values -\end{itemize} +\begin{twocollist} + \twocolitem{\doublehyphen{invert}}{Negate pixel values.} + \twocolitem{\doublehyphen{log}}{Take natural logrithm of pixel values.} + \twocolitem{\doublehyphen{exp}}{Take natural exponent of pixel values.} + \twocolitem{\doublehyphen{sqr}}{Take square of pixel values.} + \twocolitem{\doublehyphen{sqrt}}{Take square root of pixel values.} +\end{twocollist} \section{if2}\label{if2}\index{if2}% Performs math functions on a two images. The command works with both @@ -71,15 +71,15 @@ real and complex valued images. \texttt{if2 input-filename1 input-filename2 output-filename [options...]} \textbf{Options} -\begin{itemize}\itemsep=0pt - \item \doublehyphen{add} - Add the two images - \item \doublehyphen{sub} - Subtract the two images - \item \doublehyphen{multiply} - Multiply the two images - \item \doublehyphen{divide} - Divide the two images - \item \doublehyphen{comp} - Statistically compare the two images - \item \doublehyphen{column-plot n} - Plot the values of a particular col - \item \doublehyphen{row-plot n} - Plot the values of a particular row -\end{itemize} +\begin{twocollist} + \twocolitem{\doublehyphen{add}}{Add the two images.} + \twocolitem{\doublehyphen{sub}}{Subtract the two images.} + \twocolitem{\doublehyphen{multiply}}{Multiply the two images.} + \twocolitem{\doublehyphen{divide}}{Divide the two images.} + \twocolitem{\doublehyphen{comp}}{Statistically compare the two images.} + \twocolitem{\doublehyphen{column-plot n}}{Plot the values of a particular column.} + \twocolitem{\doublehyphen{row-plot n}}{Plot the values of a particular row.} +\end{twocollist} \section{ifexport}\label{ifexport}\index{ifexport}% Export an image file to a standard graphics file. @@ -88,21 +88,21 @@ Export an image file to a standard graphics file. \texttt{ifexport input-filename output-filename -\,-format }\emph{graphic-format} \texttt{ [options...]} \textbf{Options} -\begin{itemize}\itemsep=0pt - \item \doublehyphen{format} +\begin{twocollist} + \twocolitem{\doublehyphen{format}}{ \begin{itemize}\itemsep=0pt \item \texttt{pgm} - Portable graymap format. \item \texttt{pgmasc} - ASCII PGM format. \item \texttt{png} - Portable network graphics format. \item \texttt{png16} - 16-bit PNG format. - \end{itemize} - \item \doublehyphen{center} - Set center of intensity window. + \end{itemize}} + \twocolitem{\doublehyphen{center}}{Set center of intensity window. \begin{itemize}\itemsep=0pt \item \texttt{median} \item \texttt{mode} \item \texttt{mean} - \end{itemize} - \item \doublehyphen{auto} - Set half-width of intensity window. + \end{itemize}} + \twocolitem{\doublehyphen{auto}}{Set half-width of intensity window as a multiple of the standard deviation. \begin{itemize}\itemsep=0pt \item \texttt{full} \item \texttt{std0.1} @@ -110,12 +110,12 @@ Export an image file to a standard graphics file. \item \texttt{std1} \item \texttt{std2} \item \texttt{std3} - \end{itemize} - \item \doublehyphen{scale} - Set size of output image. A value of - \texttt{1} is default and creates an output image the same size as the input image. - \item \doublehyphen{min} - Set the minimum intensity value. - \item \doublehyphen{max} - Set the maximum intensity value. -\end{itemize} + \end{itemize}} + \twocolitem{\doublehyphen{scale}}{Set size of output image. A value of + \texttt{1} is default and creates an output image the same size as the input image.} + \twocolitem{\doublehyphen{min}}{Set the minimum intensity value.} + \twocolitem{\doublehyphen{max}}{Set the maximum intensity value.} +\end{twocollist} \section{ifinfo}\label{ifinfo}\index{ifinfo}% @@ -125,12 +125,12 @@ Displays information about an imagefile. \texttt{ifinfo input-filename [options...]} \textbf{Options} -\begin{itemize}\itemsep=0pt - \item \doublehyphen{labels} - Display history labels. - \item \doublehyphen{no-labels} - Suppress history labels. - \item \doublehyphen{stats} - Display image statistics. - \item \doublehyphen{no-stats} - Suppress image statistics. -\end{itemize} +\begin{twocollist} + \twocolitem{\doublehyphen{labels}}{Display history labels.} + \twocolitem{\doublehyphen{no-labels}}{Suppress history labels.} + \twocolitem{\doublehyphen{stats}}{Display image statistics.} + \twocolitem{\doublehyphen{no-stats}}{Suppress image statistics.} +\end{twocollist} \section{phm2pj}\label{phm2pj}\index{phm2pj}% Simulates collection of X-rays data (projections) around a phantom object. @@ -207,17 +207,17 @@ Displays information about a projection file. \texttt{pjinfo projection-filename [options...]} \textbf{Options} -\begin{itemize}\itemsep=0pt - \item \doublehyphen{binaryheader} - Dump the binary header to the standard output. +\begin{twocollist} + \twocolitem{\doublehyphen{binaryheader}}{Dump the binary header to the standard output. This option is only used when manually creating a composite projection file from - several different projection files. - \item \doublehyphen{binaryview} - Dump binary view data to the standard output. + several different projection files.} + \twocolitem{\doublehyphen{binaryview}}{Dump binary view data to the standard output. This option is only used when manually creating a composite projection file from - several different projection files. - \item \doublehyphen{startview} - Sets starting view to display. Default is \texttt{0}. - \item \doublehyphen{endview} - Sets ending view to display. Default is the last view. - \item \doublehyphen{dump} - Print all projection data to the console. -\end{itemize} + several different projection files.} + \twocolitem{\doublehyphen{startview}}{Sets starting view to display. Default is \texttt{0}.} + \twocolitem{\doublehyphen{endview}}{Sets ending view to display. Default is the last view.} + \twocolitem{\doublehyphen{dump}}{Print all projection data to the console.} +\end{twocollist} \section{pjrec}\label{pjrec}\index{pjrec}% Reconstructs the interior of an object from a projection file.