Changeset 1441 in Sophya for trunk/SophyaProg/PrgMap

Timestamp:

Mar 14, 2001, 5:25:02 PM (25 years ago)

Author:

ansari

Message:

documentation PrgUtil (fichiers .cc) pour doxygen - Reza 14/3/2001

Location:

trunk/SophyaProg/PrgMap

Files:

• cl2map.cc (modified) (2 diffs)
• map2cl.cc (modified) (2 diffs)
• prjsmap.cc (modified) (2 diffs)

trunk/SophyaProg/PrgMap/cl2map.cc

@@ -14 +14 @@
 #include "fitstarray.h"
 
+/*!
+  \ingroup PrgUtil
+  \file cl2map.cc
+  \brief \b cl2map: generates spherical maps from power spectra (C(l))
+
+  \verbatim
+
+  csh> cl2map -h
+  SOPHYA Version  1.1 Revision 0 (V_Fev2001) -- Mar  9 2001 15:45:31 cxx
+
+  cl2map : Spherical harmonics synthesis - Power spectrum C_l -> HEALPix map
+  Usage: cl2map [-float/-r4] [-msph pixp] [-beam fwhm]
+         [-fitsin] [-fitsout] [-autoinirand] InFileName OutFileName
+   -float (-r4): single precision C_l and map (default = double)
+   -msph pix: Spherical map pixelization parameter
+              nside=2^n for HEALPix - default=128
+                lmax = 2^n  default=128
+   -beam fwhm : Beam moothing (in l-space) FWHM in arcmin, default=0
+   -fitsout: Select the FITS format for the output map (default PPF format)
+   -fitsin : Select the FITS format for the input vector (default PPF format)
+   -autoinirand : Automtatic random number generator initialization
+   InFileName : Input file name containing the C_l vector
+   OutFileName : Output file name (HEALPix map)
+
+  \endverbatim
+*/
 
 
@@ -139 +165 @@
   }
 
-  if ((narg-ko) < 1)  Usage(true); 
+  if ((narg-ko) < 2)  Usage(true); 
   infile = arg[ko];
   outfile = arg[ko+1];

trunk/SophyaProg/PrgMap/map2cl.cc

@@ -15 +15 @@
 
 
+/*!
+  \ingroup PrgUtil
+  \file map2cl.cc
+  \brief \b map2cl: Computes power spectra (C(l)) on spherical maps.
+
+  \verbatim
+
+  csh> map2cl -h
+  SOPHYA Version  1.1 Revision 0 (V_Fev2001) -- Mar  9 2001 15:45:31 cxx
+
+  map2cl : Spherical harmonics analysis - HEALPix map -> Power spectrum C_l
+  Usage: map2cl [-float/-r4] [-lmax lval] [-thetacut dtdeg]
+         [-fitsin] [-fitsout] InFileName OutFileName
+   -float (-r4): single precision C_l and map (default = double)
+   -lmax lval: Maximum value for l index (default=255)
+   -thetacut dtdeg : Symmetric delta-theta cut (in degree) along equator
+                    (default=0 -> no cut)
+   -fitsout: Select the FITS format for the output map (default PPF format)
+   -fitsin : Select the FITS format for the input vector (default PPF format)
+   InFileName : Input file name (HEALPix map)
+   OutFileName : Output file name (the C_l vector)
+
+  \endverbatim
+*/
 
 /* Nouvelle-Fonction */
@@ -132 +156 @@
   }
 
-  if ((narg-ko) < 1)  Usage(true); 
+  if ((narg-ko) < 2)  Usage(true); 
   infile = arg[ko];
   outfile = arg[ko+1];

trunk/SophyaProg/PrgMap/prjsmap.cc

@@ -14 +14 @@
 #include "fitstarray.h"
 
+/*!
+  \ingroup PrgUtil
+  \file prjsmap.cc
+  \brief \b prjsmap: Molleweide and sinus projection of sky maps
+
+  \verbatim 
+
+  csh> prjsmap -h
+  SOPHYA Version  1.1 Revision 0 (V_Fev2001) -- Mar  9 2001 15:45:31 cxx
+
+  prjsmap : Molleweide and Sinus projection for sky maps
+  Usage: prjsmap [-float/-r4] [-sinus] [-sx sizeX] [-sy sizeY] [-scale fact]
+         [-off val][-ump val] [-invy] [-fitsin] [-fitsout] InFileName OutFileName
+   -float (-r4): single precision sky map and projection (default = double)
+   -sinus: Selects Sinus projection (default Molleweide projection)
+   -sx sizeX: Projected map size in X
+   -sy sizeY: Projected map size in Y
+       default: sizeX = 2*sizeY ; sizeX*sizeY ~ map.NbPixels()/2
+   -scale fact: scale factor applied to skymap pixels (def=1.)
+   -off val: offset value for projected map (def=0.)
+             prj(ix, jy) = offset + scale*skymap(theta, phi)
+   -ump val: Unmapped pixel value in projected map (def=0.)
+   -invy: reverses the projection direction along Y (Theta)
+   -fitsout: Select the FITS format for the output map (default PPF format)
+   -fitsin : Select the FITS format for the input vector (default PPF format)
+   InFileName : Input file name (HEALPix map)
+   OutFileName : Output file name (the C_l vector)
+
+  \endverbatim
+*/
 
 
@@ -278 +308 @@
   }
 
-  if ((narg-ko) < 1)  Usage(true); 
+  if ((narg-ko) < 2)  Usage(true); 
   infile = arg[ko];
   outfile = arg[ko+1];