Changeset 568 in Sophya for trunk/SophyaLib/Samba/mlobe.cc

Timestamp:

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

Author:

ansari

Message:

ajout doc GLM

File:

• trunk/SophyaLib/Samba/mlobe.cc (modified) (6 diffs)

trunk/SophyaLib/Samba/mlobe.cc

@@ -4 +4 @@
 #include "timing.h"
 // #include "nbrandom.h"
-
-/* --Methode-- */
+//++ 
+// Class        MainLobe
+//
+// include      mlobe.h sphericalmap.h unitvector.h math.h
+//
+//    Class for computation of main lobe.
+//
+//     The lobe values are computed in pixels laying on "nc" slices 
+//     with hexagonal  pavement around theta=0 , phi=0. The lobe is 
+//     gaussian with sigma="sig". The slices are built every 
+//     "dels"*sigma.
+// 
+//--
+//++
+// Titre        Constructor
+//--
+/* --Methode-- */
+//++
 MainLobe::MainLobe(float sig, float dels, int nc)
+//
+//--
 {
 if (sig < 1.e-9)  sig = M_PI/100.;   // Sigma du lobe gaussien (radians)
@@ -58 +76 @@
 
 
-/* --Methode-- */
+//++
+// Titre        Constructor
+//--
+/* --Methode-- */
+//++
 MainLobe::~MainLobe()
+//
+//--
 {
 delete mT0;
@@ -70 +94 @@
 delete mVal;
 }
-
-/* --Methode-- */
+//++
+// Titre        Public Methods
+//--
+//++
+//
+// inline int      NPix() 
+//    Return the total number of pixels of the lobe            
+// inline float    Sigma()             
+// inline double   Integral()            
+//--
+/* --Methode-- */
+//++
 void MainLobe::SetDirection(float teta, float phi)
+//
+//    orientate  the lobe  toward the direction  (theta, phi)
+//--
 {
 int k;
@@ -124 +161 @@
 
 /* --Methode-- */
+//++
 double MainLobe::Value(int kpx, float& teta, float& phi)
+//
+//    return the value of the lobe as also the (theta, phi) of the
+//    pixel "kpx"  
+//--
 {
 if ( (kpx < 0) || (kpx >= mNpix) ) { teta = phi = 0.; return(0.); }
@@ -133 +175 @@
 
 /* --Methode-- */
+//++
 double MainLobe::Convol(SphericalMap<double>& sph)
+//
+//    return the value of the lobe convolved with the sky (sphere) "sph"
+//--
 {
 double ret=0.;
@@ -146 +192 @@
 }
 
-/* --Methode-- */
+//++
+//
+// inline void     Print()  
+//--
+
+//++
+// Titre        Operators
+//--
+
+/* --Methode-- */
+//++
 ostream& operator << (ostream& s, MainLobe const& lob)
+//
+//--
 {
 s << "MainLobe_Info() : Sigma= " << lob.mSigma << " Dels= " << lob.mDels << " NC= "