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

Timestamp:

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

Author:

ansari

Message:

ajout doc GLM

File:

• trunk/SophyaLib/Samba/localmap.h (modified) (8 diffs)

trunk/SophyaLib/Samba/localmap.h

@@ -10 +10 @@
 #include "ppersist.h"
 
-// A local map of a region of the sky, in cartesian coordinates.
-// It has an origin in (theta0, phi0), mapped to pixel(x0, y0)
-//   (x0, y0 might be outside of this local map)
-// default value of (x0, y0) is middle of the map, center of pixel(nx/2, ny/2)
+//! A local map of a region of the sky, in cartesian coordinates.
+/*! A local map has an origin in (theta0, phi0), mapped to pixel(x0, y0)
+   (x0, y0 might be outside of this local map)
+ default value of (x0, y0) is middle of the map, center of pixel(nx/2, ny/2)
+    A local map is a 2 dimensional array, with i as column index and j
+    as row index. The map is supposed to lie on a plan tangent to the 
+    celestial sphere in a point whose coordinates are (x0,y0) on the local
+   map and (theta0, phi0) on the sphere. The range of the map is defined
+    by two values of angles covered respectively by all the pixels in 
+    x direction and all the pixels in y direction (SetSize()).
+
+    A "reference plane" is considered : this plane is tangent to the 
+    celestial sphere in a point with angles theta=Pi/2 and phi=0. This 
+    point is the origine of coordinates is of the reference plane. The 
+    x-axis is the tangent parallel to the equatorial line and oriented 
+    toward the increasing phi's ; the y-axis is parallel to the meridian 
+    line and oriented toward the north pole.
+    
+    Internally, a map is first defined within this reference plane and
+    tranported until the point (theta0, phi0) in such a way that both 
+    axes are kept parallel to meridian and parallel lines of the sphere.
+    The user can define its own map with axes rotated with respect to
+    reference axes (this rotation is characterized by angle between 
+    the local parallel line and the wanted x-axis-- see method 
+    SetOrigin(...))
+*/
 //
 //    la carte est consideree comme un tableau a deux indices i et j, i etant 
@@ -57 +79 @@
 
 /* return/set the number of pixels */
+/*!    Return number of pixels */
 virtual int NbPixels() const;
 inline void setNbPixels(int n) {nPix_= n;}
   
 /* return the value of pixel number k */
+/*!    Return value of pixel with index k */
 virtual T& PixVal(int k);
+/*!   const version of previous method */
 virtual T const& PixVal(int k) const;
 
@@ -67 +92 @@
 virtual bool ContainsSph(double theta, double phi) const;
 /* return the index of pixel at (theta,phi) */
+/*!    Return index of the pixel with spherical coordinates (theta,phi) */
 virtual int PixIndexSph(double theta,double phi) const;
    
 /* return the spherical coordinates of center of pixel number k */
+/*!    Return (theta, phi) coordinates of pixel with index k */
 virtual void PixThetaPhi(int k,double& theta,double& phi) const;
 
 /* return the Pixel Solid angle  (steradians) */
+/*!    Pixel Solid angle  (steradians)
+
+    All the pixels have not necessarly the same size in (theta, phi)
+    because of the projection scheme which is not yet fixed. 
+*/  
 virtual double PixSolAngle(int k) const; 
 
 // ---------- Specific methods ------------------------------
 
+/*!    Resize storage area for pixels */
 void ReSize(int nx, int ny);
 
@@ -82 +115 @@
  
 /* Origin (with angle between x axis and phi axis, in degrees)  x0,y0  the default: middle of map*/
+/*!    set the referential of the map (angles in degrees)
+
+    (default x0=siz_x/2,  y0=siz_y/2) 
+*/
 virtual void SetOrigin(double theta=90.,double phi=0.,double angle=0.);
+/*!    set the referential of the map (angles in degrees) */
 virtual void SetOrigin(double theta,double phi,int x0,int y0,double angle=0.);
 
 /* Pixel size (degres) */ 
+/*!    angle range of tthe map (angles in degrees) */
 virtual void SetSize(double angleX,double angleY);
 
@@ -91 +130 @@
 inline bool LocalMap_isDone() const {return(originFlag_ && extensFlag_);};
 
-/* Projection to/from spherical map */
+/*! Projection to a spherical map */
 virtual void Project(SphericalMap<T>& sphere) const;
   
@@ -120 +159 @@
 
 void InitNul();
+/*!    Return 2 indices corresponding to the pixel number k */
 void Getij(int k,int& i,int& j) const;
+/*!    Transform a pair of coordinates (theta, phi) given in 
+    reference coordinates into map coordinates
+*/
 void ReferenceToUser(double& theta,double& phi) const; 
+/*!    Transform a pair of coordinates (theta, phi) given in 
+   map coordinates into reference coordinates
+*/
 void UserToReference(double& theta,double& phi) const;
+/*!   Given coordinates in pixel units in the REFERENCE PLANE, return
+    (theta, phi) in "absolute" referential theta=pi/2 ,phi=0.   
+*/
 void PixProjToAngle(double x,double y,double& theta,double& phi) const; 
+/*!    Given coordinates  (theta, phi) in "absolute" referential 
+    theta=pi/2 ,phi=0  return pixel indices  (i,j) in the REFERENCE PLANE.
+*/
 void AngleProjToPix(double theta,double phi,double& x,double& y) const; 
 
@@ -148 +200 @@
 
 // ------------- Classe pour la gestion de persistance --
+//!    Delegated objects for persitance management
 template <class T>
 class FIO_LocalMap : public PPersist  
@@ -161 +214 @@
 virtual AnyDataObj* DataObj();
 inline operator LocalMap<T>() { return(*dobj); }
-inline LocalMap<T> getObj() { return(*dobj); }
+//inline LocalMap<T> getObj() { return(*dobj); }
 
 protected :