source: Sophya/trunk/SophyaLib/Manual/sophya.tex@ 887

Last change on this file since 887 was 887, checked in by ansari, 25 years ago

Creation du module de documentation pour Sophya (DPC/Manual) Reza 11/4/2000

File size: 5.3 KB
Line 
1\documentclass[twoside,11pt]{article}
2% Package standard : Utilisation de caracteres accentues, mode francais et graphique
3\usepackage[latin1]{inputenc}
4\usepackage[T1]{fontenc}
5\usepackage[english]{babel}
6\usepackage{graphicx}
7% package a mettre pour faire du pdf
8\usepackage{palatino}
9
10% Extension de symboles mathematiques
11\usepackage{amssymb}
12
13% Definition de taille de page
14\setlength{\textwidth}{16cm}
15\setlength{\textheight}{21.5cm}
16\setlength{\topmargin}{0.5cm}
17\setlength{\oddsidemargin}{0.cm}
18\setlength{\evensidemargin}{0.cm}
19\setlength{\unitlength}{1mm}
20
21% Definition de commande pour les schemas de classe
22\newcommand{\dclsa}[1]{ \mbox{
23 \framebox[40mm][c]{\rule[-1pt]{0mm}{14pt} \bf #1} } \\[2mm] }
24\newcommand{\dclsb}[2]{ \mbox{
25 \framebox[40mm][c]{\rule[-1pt]{0mm}{14pt} \bf #1} \rule[2pt]{10mm}{0.3mm}
26 \framebox[40mm][c]{\rule[-1pt]{0mm}{5mm} \bf #2} } \\[2mm] }
27\newcommand{\dclsc}[3]{ \mbox{
28 \framebox[40mm][c]{\rule[-1pt]{0mm}{14pt} \bf #1} \rule[2pt]{10mm}{0.3mm}
29 \framebox[40mm][c]{\rule[-1pt]{0mm}{14pt} \bf #2} \rule[2pt]{10mm}{0.3mm}
30 \framebox[40mm][c]{\rule[-1pt]{0mm}{14pt} \bf #3} } \\[2mm] }
31
32
33\newcommand{\bul}{$\bullet \ $}
34
35\begin{document}
36
37\begin{titlepage}
38\vspace{1cm}
39\makebox[30mm][c]{\includegraphics[width=3cm]{hfi_icon_vsmall.eps}}
40\hspace{5mm} \raisebox{12mm}{\rule{75 mm}{0.5 mm}\makebox[50 mm]{\bf Sophya }}
41\vspace{2cm}
42\begin{center}
43\par \renewcommand{\baselinestretch}{2.0} \small
44{\LARGE \bf
45Sophya \\
46An overview
47}
48\par \renewcommand{\baselinestretch}{1.0} \normalsize
49\vspace{5 cm}
50\begin{tabular}{ll}
51{R. Ansari} & {\tt ansari@lal.in2p3.fr} \\
52% {. Lesquoy} & {\tt lesquoy@hep.saclay.cea.fr} \\
53{G. Le Meur} & {\tt lemeur@lal.in2p3.fr} \\
54{C. Magneville} & {\tt cmv@hep.saclay.cea.fr} \\
55\end{tabular}
56
57\end{center}
58\vfill
59\hfill
60\framebox[\textwidth]{\hspace{0.5cm} \bf Sophya
61\hspace{1cm} \today } \\
62\end{titlepage}
63
64\tableofcontents
65
66\newpage
67
68
69\section{Introduction}
70
71 {\bf SOPHYA} ({\bf SO}ftware for {\bf PHY}sics {\bf A}nalysis)
72is a collection of C++ classes designed for numerical and
73physics analysis software development. Our goal is to provide
74easy to use, yet powerful classes which can be used by scientists.
75We have decided to use as much as possible available
76numerical analysis libraries, encapsulating them whenever
77possible.
78
79 The SOPHYA design and implementation has been carried out
80with the specific goal of providing the general framework for
81the Planck-HFI data processing software. However, most of the
82packages presented are independent of Planck and CMB analysis
83problem.
84 The source directory tree
85\footnote{ CVS server: cvsserver.lal.in2p3.fr:/projects/Eros/CVSEros}
86is organised into a number of modules.
87
88\begin{itemize}
89\item[] {\bf Mgr/} Scripts for code management,
90makefile generation and software installation
91\item[] {\bf SysTools/} General architecture support classes such
92as {\tt PPersist, NDataBlock<T>}, and few utility classes
93({\tt DataCard, DVList} \ldots).
94\item[] {\bf TArray/} template numerical arrays, vectors and matrices
95({\tt PixelMap<T> SphericalMap<T>} \ldots) and few geometry
96handling utility classes.
97\item[] {\bf NTools/} Some standard numerical analysis tools
98(linear, and non linear parameter fitting, FFT, \ldots)
99\item[] {\bf HiStats/} Histogram-ming and data set handling classes \\
100({\tt Histo Histo2D NTuple XNTuple} \ldots)
101\end{itemize}
102
103Modules designed for problems related to CMB analysis :
104
105\begin{itemize}
106\item[] {\bf SkyMap/} Local and full sky maps
107\item[] {\bf SkyT/}
108classes for spectral emission and detector frequency response modelling \\
109({\tt SpectralResponse, RadSpectra, BlackBody} \ldots)
110\item[] {\bf Samba/} few classes for map and TOD analysis.
111\item[] {\bf PMixer/} skymixer and related programs
112\end{itemize}
113
114Modules containing interface classes with external libraries:
115\begin{itemize}
116\item[] {\bf FitsIOSrever/} Classes for handling file input-output
117in FITS format using the cfitsio library.
118\item[] {\bf LinAlg/} Interface with Lapack linear algebra package
119\item[] {\bf IFFTW/} Interface with FFTW package
120\end{itemize}
121
122Other modules:
123\begin{itemize}
124\item[] {\bf Tests/} Simple test programs
125\item[] {\bf ProgPI/} interactive analysis tool - It should be noted that
126this module uses the SOPHYA class library and is based on {\bf PI}
127which is a C++ library defining a complete GUI program
128architecture. An additional module (PIext) define the interactive
129analysis program framework and the interfaces with the objects
130in SOPHYA. The {\bf PI/} \footnote{the PI package documentation
131is available from {\tt http://www.lal.in2p3.fr/recherche/eros/PeidaDoc/} }
132and {\bf PIext/} modules are not currently part
133of the SOPHYA CVS structure.
134\end{itemize}
135
136\section{Mgr/ module and software installation}
137blabla ...
138
139\section{SysTools module}
140This is a dclsa{AAAA} \\[2mm]
141\dclsa{AAA}
142This is a dclsb{BBBB}{BBBB} \\[2mm]
143\dclsb{BBBB}{BBBB}
144This is a dclsc{CCCCC}{CCCCC}{CCCCC} \\[2mm]
145\dclsc{CCCCC$<$T$>$}{CCCCC}{CCCCC}
146
147\begin{figure}
148\dclsa{DataCard}
149\dclsb{AnyDataObj}{NDataBlock$<$T$>$}
150\dclsc{BaseArray}{TArray}{TMatrix}
151\caption{ Partial class diagram}
152\end{figure}
153
154PixelMap<T> --- LocalMap<T>
155 SphericalMap<T> --- SphereThetaPhi<T>
156 SphereHEALPix<T>
157
158
159\end{document}
Note: See TracBrowser for help on using the repository browser.