Index: trunk/doc/pslib/psLibADD.tex =================================================================== --- trunk/doc/pslib/psLibADD.tex (revision 347) +++ trunk/doc/pslib/psLibADD.tex (revision 356) @@ -1,3 +1,3 @@ -%%% $Id: psLibADD.tex,v 1.9 2004-04-01 04:40:14 eugene Exp $ +%%% $Id: psLibADD.tex,v 1.10 2004-04-01 08:29:31 eugene Exp $ \documentclass[panstarrs]{panstarrs} @@ -18,5 +18,4 @@ \maketitle - % -- Revision History -- % provide explicit values for the old versions @@ -28,15 +27,25 @@ \RevisionsEnd -\pagebreak +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +\DocumentsInternal +PSCD-430-xxx & PS-1 Design Reference Mission \\ \hline +PSCD-430-004 & Pan-STARRS IPP C Code Conventions \\ \hline +PSCD-430-005 & Pan-STARRS IPP SRS \\ \hline +PSCD-430-006 & Pan-STARRS IPP ADD \\ \hline +PSCD-430-008 & Pan-STARRS IPP Architecture SDR \\ +\DocumentsExternal +Posix Standard & Open Group Based Specifications Issue 6, IEEE Std 1003.1, 2003 \\ +\DocumentsEnd + \tableofcontents - \pagebreak \pagenumbering{arabic} -\section{PanSTARRS Library PSLib} +\section{Pan-STARRS Library PSLib} \subsection{Math Utilities} -\subsection{Sorting} +\subsubsection{Sorting} A variety of sorting algorithms exist, with a wide range in speed for @@ -61,9 +70,12 @@ function \code{psSortIndex} shall return an integer index to the sequence of the input array without overwriting the input array. -Given the following line of code, \code{out = psSortIndex (NULL, -&in);}, the elements of the array \code{out} are in the sequence -\code{in.arr[out->arr[0]]} to \code{in.arr[out->arr[in.n - 1]]}. - -\subsection{Smoothing: Boxcar and Gaussian} +Given the following line of code: +\begin{verbatim} +out = psSortIndex (NULL,&in);} +\end{verbatim} +the elements of the array \code{out} are in the sequence +\code{in.arr[out->arr[0]]} to \code{in.arr[out->arr[in.n - 1]]}. + +\subsubsection{Smoothing: Boxcar and Gaussian} \label{smooth} @@ -92,5 +104,5 @@ \end{equation} -\subsection{Statistics} +\subsubsection{Statistics} The general statistics function \code{psStats} performs a variety of @@ -105,10 +117,10 @@ sample and robust estimators. -\subsubsection{Sample Statistics} +\paragraph{Sample Statistics} We define the following statistical terms, assuming there is a set of data elements $x_i$. -\paragraph{Mean} +\subparagraph{Mean} The mean is defined as: @@ -117,5 +129,5 @@ \end{equation} -\paragraph{Median} +\subparagraph{Median} The median is defined as the value for which 50\% of the data values @@ -127,5 +139,5 @@ robust median is quicker and more accurate. -\paragraph{Upper and Lower Quartiles} +\subparagraph{Upper and Lower Quartiles} The upper and lower quartiles ($U_{\frac{1}{4}}$ and @@ -141,5 +153,5 @@ are quicker and more accurate. -\paragraph{Standard Deviation} +\subparagraph{Standard Deviation} The standard deviation of the sample is given by: @@ -156,5 +168,5 @@ \end{equation} -\subsubsection{Clipped Statistics} +\paragraph{Clipped Statistics} The clipped statistics are used to determine the mean and standard @@ -186,5 +198,5 @@ \end{enumerate} -\subsubsection{Robust Statistics} +\paragraph{Robust Statistics} The robust version of the statistics provides estimators of basic @@ -232,5 +244,5 @@ -\subsection{Matrix Operations} +\subsubsection{Matrix Operations} In this section, we define the linear algebra operations performed on @@ -251,5 +263,5 @@ \code{gsl_linalg_LU_decomp}. -\subsubsection{LU Decomposition} +\paragraph{LU Decomposition} \label{LUdecomp} @@ -292,5 +304,5 @@ \end{equation} -\subsubsection{Calculate a matrix determinant} +\paragraph{Calculate a matrix determinant} The determinant $D$ of a matrix $a_{ij}$ is calculated from the @@ -308,5 +320,5 @@ shall be used. -\subsubsection{Solving a Linear Equation} +\paragraph{Solving a Linear Equation} The LU decomposition of a matrix may be used to solve the @@ -328,5 +340,5 @@ \end{eqnarray} -\subsubsection{Invert a matrix} +\paragraph{Invert a matrix} Inversion of a matrix using the LU decomposition is performed by @@ -337,5 +349,5 @@ operation shall be implemented using the GSL function \code{gsl_linalg_LU_invert}. -\subsubsection{Perform matrix addition, subtraction and multiplication} +\paragraph{Perform matrix addition, subtraction and multiplication} Matrix binary arithmetic operations differ from image binary @@ -361,5 +373,5 @@ \times$. -\subsubsection{Transpose a matrix} +\paragraph{Transpose a matrix} The transpose of a matrix is simply the reorganization of the matrix @@ -374,5 +386,5 @@ where $M_{ij}$ is the matrix to be transposed. -\subsubsection{Convert a matrix to a vector} +\paragraph{Convert a matrix to a vector} Matrix-to-vector conversion is only defined for a matrix that has a @@ -383,7 +395,7 @@ matrix is converted to a \code{PS_DIMEN_TRANV}-type vector. -\subsection{Fitting} - -\subsubsection{Chi-squared} +\subsubsection{Fitting} + +\paragraph{Chi-squared} \label{chisq} @@ -396,5 +408,5 @@ \end{equation} -\subsubsection{General Polynomial Fitting} +\paragraph{General Polynomial Fitting} Given a set of data values $y_i$ with errors $\sigma_i$, related to @@ -421,5 +433,5 @@ (section~\ref{LUdecomp}). -\subsubsection{Non-linear Fitting: Levenberg-Marquardt Method} +\paragraph{Non-linear Fitting: Levenberg-Marquardt Method} \TBD{describe LMM for psMinimize and psMinimizeChi2} @@ -497,5 +509,5 @@ %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -\subsection{Polynomials} +\subsubsection{Polynomials} We will employ Chebyshev polynomials (NR \S 5.8) to approximate functions: @@ -534,5 +546,5 @@ $-1 < x < 1$. -\subsubsection{Multi-dimensional polynomials} +\paragraph{Multi-dimensional polynomials} Multi-dimensional polynomials shall be composed of multiplications of @@ -540,8 +552,7 @@ the appropriate rank. - -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - -\subsection{(Fast) Fourier Transforms} +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +\subsubsection{(Fast) Fourier Transforms} (Fast) Fourier Transforms (FFTs) shall be implemented using the @@ -549,5 +560,5 @@ library}. -\subsubsection{FFTW Plans} +\paragraph{FFTW Plans} FFTW requires the user to create a ``plan'' for each transform size, @@ -566,5 +577,5 @@ saved at the conclusion (\code{psFFTDone()}). -\subsubsection{Function mapping} +\paragraph{Function mapping} The forward and reverse transforms call the corresponding @@ -583,5 +594,5 @@ place to avoid the need to pad the input array to hold the output. -\subsubsection{More Complicated Functions} +\paragraph{More Complicated Functions} The \code{psFFTFilter()} and \code{psFFTFilterComplex()} functions provide @@ -665,5 +676,5 @@ \end{eqnarray} -\subsubsubsection{Gnomonic} +\paragraph{Gnomonic} The Gnomonic projection (``TAN'') is a zenithal projection. @@ -674,5 +685,5 @@ \end{eqnarray} -\subsubsubsection{Orthographic} +\paragraph{Orthographic} The Orthographic projection (``SIN'') is a zenithal projection. @@ -683,5 +694,5 @@ \end{eqnarray} -\subsubsubsection{Cartesian} +\paragraph{Cartesian} The Cartesian projection (``CAR'') is a very simple cylindrical projection. @@ -692,5 +703,5 @@ \end{eqnarray} -\subsubsubsection{Mercator} +\paragraph{Mercator} The Mercator projection (``MER'') is a cylindrical projection. @@ -702,5 +713,5 @@ \end{eqnarray} -\subsubsubsection{Hammer-Aitoff} +\paragraph{Hammer-Aitoff} The Hammer-Aitoff projection is a general projection, and is defined: @@ -722,5 +733,5 @@ %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -\subsection{Tangent Plane to Sky} +\subsubsection{Tangent Plane to Sky} Mappings between the tangent plane and the sky will be implemented @@ -755,5 +766,5 @@ %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -\subsection{The One-to-Many Problem with Mosaic Cameras} +\subsubsection{The One-to-Many Problem with Mosaic Cameras} The \PS{} focal plane consists of several chips, so we will often want @@ -777,5 +788,5 @@ %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -\subsection{General Astronomy Functions} +\subsubsection{General Astronomy Functions} The airmass is calculated using the SLALIB function \code{sla_AIRMAS}. @@ -807,5 +818,5 @@ %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -\subsection{Positions of Major Solar System Objects} +\subsubsection{Positions of Major Solar System Objects} The SLALIB function \code{SLA_RDPLAN} returns the apparent position of @@ -818,16 +829,18 @@ \rightarrow \alpha + 12 {\rm hrs}$ and $\delta \rightarrow -\delta$). -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - -\subsection{Offsets} - - - - - -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +\subsubsection{Offsets} + + + + + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + + +\end{document} \section{Modules} @@ -866,3 +879,2 @@ \section{Architectual Components} -\end{document}