Changeset 2808 in Sophya for trunk/SophyaLib/SkyMap

Timestamp:

Jun 14, 2005, 1:25:05 PM (20 years ago)

Author:

ansari

Message:

MAJ documentation - Reza 14/6/2005

Location:

trunk/SophyaLib/SkyMap

Files:

• sphereecp.cc (modified) (6 diffs)
• spherehealpix.cc (modified) (1 diff)
• spherethetaphi.cc (modified) (1 diff)

trunk/SophyaLib/SkyMap/sphereecp.cc

@@ -3 +3 @@
 #include <math.h>
 
+/*!
+  \class SOPHYA::SphereECP
+  \ingroup SkyMap
+  \brief Spherical maps in Equatorial Cylindrical Projection
+
+  Class implementing spherical maps, with a pixelisation
+  corresponding to the an Equatorial Cylindrical Projection.
+  Pixel size varie from equator to poles. The sphere is divided 
+  into a number of slices along the parallels. Each slice is subdivided
+  into the same number of pixels.
+  This class provides the possibility to have partial coverage.
+  Can be used for the following types: <br>
+  <tt> int_4 , r_4 , r_8 , complex<r_4> , complex<r_8> </tt>
+*/
+
 namespace SOPHYA {
 
+//! Default constructor
 template <class T>
 SphereECP<T>::SphereECP()
@@ -23 +39 @@
 }
 
+/*!
+  \brief  Constructor with the pixelisation parameter m
+  
+  Complete coverage.
+  The sphere is divided into \b m slices in theta (0..pi). each slice is divided
+  into \b 2m pixels (along phi) 
+*/
 template <class T>
 SphereECP<T>::SphereECP(int m)
@@ -40 +63 @@
 }
 
+/*! 
+  Complete coverage.
+  \b ntet slices in theta (0..pi) and \b nphi pixels (along phi) for 
+  each slice in theta
+*/
 template <class T>
 SphereECP<T>::SphereECP(int ntet, int nphi)
@@ -58 +86 @@
 }
 
+/*! 
+  Partial coverage : 
+  \b ntet slices in theta , in the range (tet1 .. tet2) and \b nphi pixels (along phi) for 
+  each slice in theta in the range (phi1 .. phi2) 
+*/
 template <class T>
 SphereECP<T>::SphereECP(r_8 tet1, r_8 tet2, int ntet, r_8 phi1, r_8 phi2, int nphi)
@@ -88 +121 @@
 }
 
+//! Copy constructor - shares the pixel data if \b share=true
 template <class T>
 SphereECP<T>::SphereECP(const SphereECP<T>& a, bool share)
@@ -106 +140 @@
 }
 
+//! Copy constructor - shares the pixel data 
 template <class T>
 SphereECP<T>::SphereECP(const SphereECP<T>& a)

trunk/SophyaLib/SkyMap/spherehealpix.cc

@@ -21 +21 @@
   \class SOPHYA::SphereHEALPix
   \ingroup SkyMap
+  \brief Spherical maps in HEALPix pixelisation scheme.
+
   Class implementing spherical maps, in the HEALPix pixelisation scheme, 
   with template data types (double, float, complex, ...)

trunk/SophyaLib/SkyMap/spherethetaphi.cc

@@ -10 +10 @@
   \class SOPHYA::SphereThetaPhi
   \ingroup SkyMap
+
+  \brief Spherical map with equal latitude (iso-theta) rings 
+
+
   Class implementing spherical maps, with equal latitude (iso-theta) rings 
   pixelisation scheme - with template data types (double, float, complex, ...)