Changeset 2290 in Sophya for trunk/SophyaLib/SkyMap/localmap.h

Timestamp:

Dec 5, 2002, 4:43:18 PM (23 years ago)

Author:

lemeur

Message:

documentation

File:

• trunk/SophyaLib/SkyMap/localmap.h (modified) (3 diffs)

trunk/SophyaLib/SkyMap/localmap.h

@@ -69 +69 @@
 virtual T& PixVal(int_4 k);
 virtual T const& PixVal(int_4 k) const;
-
+  //! if fg = true, will generate  exceptions , when theta-phi out of range
 inline  void SetThrowExceptionWhenOutofMapFlag(bool fg = false) { exc_outofmap_ = fg; }
-// true --> Genere des exceptions si theta-phi out of range , sinon, index a -1
+
+//! true --> exceptions wil be active when theta-phi out of range 
 inline  bool GetThrowExceptionWhenOutofMapFlag() { return exc_outofmap_; }
 
 virtual bool ContainsSph(double theta, double phi) const;
+//! return pixel number correspoinding to (theta,phi)
 virtual int_4 PixIndexSph(double theta,double phi) const;
    
+//! return (theta,phi) correspoinding to pixel number k
 virtual void PixThetaPhi(int_4 k,double& theta,double& phi) const;
 
+//! set all pixel values equal to v
 virtual T SetPixels(T v);
 
+// return the solid angle covered by pixel k (steradians)
 virtual double PixSolAngle(int_4 k) const; 
 
@@ -91 +96 @@
 void SetSize(double angleX,double angleY);
 
-
-inline virtual char* TypeOfMap() const {return "LOCAL";};
+  /*! \fn TypeOfMap()
+ return the string "LOCAL"
+  */ 
+inline virtual string TypeOfMap() const {return string("LOCAL");};
  
 
@@ -152 +159 @@
 inline  LocalMap<T>& operator = (T a) {return SetT(a);}
 
-//! Add \b x to all elements
+// Add \b x to all elements
 virtual LocalMap<T>& Add(T a); 
 inline  LocalMap<T>&  operator += (T x)  { return Add(x); }
-//! Substract \b x to all elements
+// Substract \b x to all elements
 virtual LocalMap<T>& Sub(T a,bool fginv=false); 
 inline   LocalMap<T>&  operator -= (T x)  { return Sub(x); }
-//! Multiply all elements by \b x
+// Multiply all elements by \b x
 virtual LocalMap<T>& Mul(T a); 
 inline  LocalMap<T>&  operator *= (T x)  { return Mul(x); }
-//! Divide all elements by \b x
+// Divide all elements by \b x
 virtual LocalMap<T>& Div(T a); 
 inline  LocalMap<T>&  operator /= (T x)  { return Div(x); }