Changeset 568 in Sophya for trunk/SophyaLib/Samba/pixelmap.h

Timestamp:

Nov 10, 1999, 3:17:10 PM (26 years ago)

Author:

ansari

Message:

ajout doc GLM

File:

• trunk/SophyaLib/Samba/pixelmap.h (modified) (4 diffs)

trunk/SophyaLib/Samba/pixelmap.h

@@ -8 +8 @@
 #include <iostream.h>
 
-// General map of pixels on part of sphere or whole sphere
-// Class hierarchy :
-//   PixelMap
-//      SphericalMap
-//         SphereThetaPhi
-//         SphereGorski
-//         SphereIco
-//      LocalMap
-
+//! General map of pixels on part of sphere or whole sphere
+/*! Class hierarchy :
+\verbatim
+   PixelMap
+     SphericalMap
+         SphereThetaPhi
+         SphereGorski
+         SphereIco
+      LocalMap
+\endverbatim
+*/
 template<class T>
 class PixelMap  
@@ -33 +35 @@
 inline SphereCoordSys* GetCoordSys() const { return(cs_); }
 
-// Number of pixels
+/*! Number of pixels */
 virtual int NbPixels() const=0;
    
-// Value of pixel number k
+/*! Value of pixel number k */
 virtual T& PixVal(int k)=0;
 virtual T const& PixVal(int k) const=0;
@@ -44 +46 @@
 virtual bool Contains(const SpherePosition& spos) const;
 
-// Index of pixel at (theta,phi)
+/*! Index of pixel at (theta,phi) */
 virtual int PixIndexSph(double theta, double phi) const=0;
 // Index of pixel at a sky-position 
 virtual int PixIndex(const SpherePosition& spos);
 
-
-// Value of pixel number at (theta,phi)
+/*! Value of pixel number at (theta,phi) */
 virtual T& PixValSph(double theta, double phi)
                            {return PixVal(PixIndexSph(theta,phi));}
@@ -56 +57 @@
                            {return PixVal(PixIndexSph(theta,phi));}
 
-// Spherical coordinates of center of pixel number k
+/*! Spherical coordinates of center of pixel number k */
 virtual void PixThetaPhi(int k, double& theta, double& phi) const=0;
 
-// provides a integer characterizing the pixelization refinement 
-// (depending of the type of the map)              
+/*! provides a integer characterizing the pixelization refinement 
+ (depending of the type of the map) 
+*/             
 virtual int SizeIndex() const=0;
 virtual char* TypeOfMap() const =0;
 
-// Pixel  (steradians)
+/*! Pixel  (steradians) */
 virtual double PixSolAngle(int k) const =0; 
 
-// Overloading of () to access pixel number k.
+/*! Overloading of () to access pixel number k. */
 inline T& operator()(int k) {return(PixVal(k));}
 inline T const& operator()(int k) const {return(PixVal(k));}