Changeset 3048 in Sophya for trunk/SophyaLib/Manual

Timestamp:

Aug 11, 2006, 6:05:12 PM (19 years ago)

Author:

ansari

Message:

Petits ajouts dans la doc sophya.tex (concernant fitsinoutfile << en particulier) , Reza 11/08/2006

File:

• trunk/SophyaLib/Manual/sophya.tex (modified) (7 diffs)

trunk/SophyaLib/Manual/sophya.tex

@@ -1186 +1186 @@
 \subsubsection{NTuple}
 \index{NTuple}
-NTuple are memory resident tables of 32 or 64 bits floating values 
+{\bf NTuple} are memory resident tables of 32 or 64 bits floating values 
 (float/double).They are arranged in columns. Each line is often called an event.
 These objects are frequently used to analyze data.
@@ -1209 +1209 @@
 \end{verbatim}
 
-XNTuple provide additional functionalities, compared to NTuple. 
-They are deprecated and are only kept  for backward compatibility
-and should not be used anymore. Use DataTable and 
-SwPPFDataTable instead. 
+{\bf XNTuple} provide additional functionalities, compared to NTuple. However,
+this class is deprecated and superseded by classes inheriting from  BaseDataTable.
+It is only kept  for backward compatibility and should not be used anymore. 
+Use DataTable and  SwPPFDataTable instead. 
 Object of type XNTuple handle various types
 of column values (double,float,int,string,...) and can handle
@@ -1251 +1251 @@
 The class {\bf SwPPFDataTable} implements the BaseDataTable interface
 using segmented data blocks with swap on PPF streams. Very large data sets
-can be created and manipulated through tis class
+can be created and manipulated through this class. A similar class
+SwFitsDataTable (\ref{SwFitsDataTable}), using 
+FITS files as swap space is also provided in the FitsIOServer module.
 
 \index{DataTableRow}
@@ -1811 +1813 @@
 \end{figure}
 %%%%
-\subsection{FITS handlers}
+\subsection{FITS handlers and I/O operators}
 \index{FitsManager}
 Handlers classes inheriting from {\bf FitsHandlerInterface} perform write/read operations
@@ -1819 +1821 @@
 \hspace{5mm} {\tt FitsInOutFile\& $<<$ } \, and \,  {\tt FitsInOutFile\& $>>$ } \hspace{5mm}
 operators can be used to write and read objects.  
+When reading objects from a fits file using the {\tt FitsInOutFile\& $>>$ } operator, 
+the fits file is positioned on the next HDU, after reading. Also, if the {\bf FitsInOutFile}
+object is positioned on a first empty HDU (without data, naxis=0), reading in objects
+corresponding to a binary or ascii table using the operator $>>$  will skip automatically 
+the empty HDU and position the fits file on the second HDU, before trying to read in
+the object.
 \par
 The two main types of fits data structures, images and tables 
@@ -1826 +1834 @@
 A number of more specific handlers are also available, in particular for NTuple,
 \tcls{SphereHealPix} and \tcls{SphereThetaPhi}.  \\[2mm]
-{\bf Warning:} Some handlers were written with the old FitsIOServer classes and 
-inherit from the intermediate class {\bf FitsIOHandler}. They  
-have been adapted to the new scheme, but may not perform correctly if not used 
-through the {\bf FitsManager} class. \\[2mm] 
+{\bf Warning:} Some handlers were written with the old FitsIOServer classes.
+They  inherit from the intermediate class {\bf FitsIOHandler} and
+have been adapted to the new scheme. \\[2mm] 
 %%%
 The examples below illustrates the usage of FitsIOServer classes. They can be compiled
@@ -1919 +1926 @@
 
 \subsection{SwFitsDataTable and other classes}
+\label{SwFitsDataTable}
 \index{SwFitsDataTable} 
 The {\bf SwFitsDataTable} class implements the BaseDataTable interface