Changeset 21323 for trunk/pswarp/src/pswarp.h

Timestamp:

Feb 5, 2009, 10:44:04 AM (17 years ago)

Author:

eugene

Message:

merging Doxygen comments by Bill G from eam_branch_20081230

File:

• trunk/pswarp/src/pswarp.h (modified) (5 diffs)

trunk/pswarp/src/pswarp.h

@@ +1 @@
+/** @file pswarp.h
+ *
+ *  @brief
+ *
+ *  @ingroup pswarp
+ *
+ *  @author IfA
+ *  @version $Revision: 1.17 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2009-02-05 20:44:04 $
+ *  Copyright 2009 Institute for Astronomy, University of Hawaii
+ */
+
 #ifdef HAVE_CONFIG_H
 #include <config.h>
@@ -14 +26 @@
 
 #include "pswarpErrorCodes.h"
-#define PSWARP_RECIPE  "PSWARP" // Name of the recipe to use
-#define PSASTRO_RECIPE "PSASTRO" // Name of the recipe to use
+#define PSWARP_RECIPE  "PSWARP" ///< Name of the recipe to use
+#define PSASTRO_RECIPE "PSASTRO" ///< Name of the recipe to use
 
-#define PSWARP_ANALYSIS_VARFACTOR "PSWARP.VARFACTOR" // Name for variance factor in analysis metadata
-#define PSWARP_ANALYSIS_GOODPIX   "PSWARP.GOODPIX" // Name for number of good pixels in analysis metadata
+#define PSWARP_ANALYSIS_VARFACTOR "PSWARP.VARFACTOR" ///< Name for variance factor in analysis metadata
+#define PSWARP_ANALYSIS_GOODPIX   "PSWARP.GOODPIX" ///< Name for number of good pixels in analysis metadata
 
-// a single pswarpMap converts coordinates from one image to a second image
-// the linear model is only valid over a limited range of pixels
+/**
+ * a single pswarpMap converts coordinates from one image to a second image
+ * the linear model is only valid over a limited range of pixels
+ */
 typedef struct {
     double Xo, Xx, Xy;
@@ -29 +43 @@
 } pswarpMap;
 
-// the pswarpMapGrid carries a collection of pswarpMag structures representing the
-// local value of the pswarpMap at different locations in the image.
+/* the pswarpMapGrid carries a collection of pswarpMag structures representing 
+ * the local value of the pswarpMap at different locations in the image.
+ */
 typedef struct {
     pswarpMap ***maps;
-    int nXpts, nYpts;                   // number of x,y samples in the grid
-    int nXpix, nYpix;                   // x,y spacing in src image pixels of grid samples
-    double xMin,  yMin;                 // coordinate of first grid sample
+    int nXpts, nYpts;                   ///< number of x,y samples in the grid
+    int nXpix, nYpix;                   ///< x,y spacing in src image pixels of grid samples
+    double xMin,  yMin;                 ///< coordinate of first grid sample
 } pswarpMapGrid;
 
 typedef struct {
-    // values which are common to all tiles
+    /** values which are common to all tilesa */
     pmReadout *input;
     pmReadout *output;
@@ -46 +61 @@
     psImage *region;
 
-    // input values for this tile
+    /** input values for this tile */
     int gridX;
     int gridY;
 
-    // output values for this tile
-    long goodPixels;                    // Number of good pixels
-    int xMin, xMax, yMin, yMax;         // Bounds of tile
+    /** output values for this tile */
+    long goodPixels;                    //< Number of good pixels
+    int xMin, xMax, yMin, yMax;         //< Bounds of tile
 } pswarpTransformTileArgs;
 
@@ -91 +106 @@
     );
 
-// define threads for this program
+/**
+ * define threads for this program
+ */
 bool pswarpSetThreads ();