Changeset 21323 for trunk/pswarp/src/pswarpTransformReadout.c

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/pswarpTransformReadout.c (modified) (5 diffs)

trunk/pswarp/src/pswarpTransformReadout.c

@@ +1 @@
+/** @file pswarpTransformReadout.c
+ *
+ *  @brief
+ *
+ *  @ingroup pswarp
+ *
+ *  @author IfA
+ *  @version $Revision: 1.15 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2009-02-05 20:44:04 $
+ *  Copyright 2009 Institute for Astronomy, University of Hawaii
+ */
+
 #include "pswarp.h"
 
-// NOTE: in this function, the coordinates are transformed from the OUTPUT to the INPUT
+/**
+ * NOTE: in this function, the coordinates are transformed from the OUTPUT to the INPUT
+ */
 bool pswarpTransformReadout(pmReadout *output, pmReadout *input, pmConfig *config)
 {
     // XXX this implementation currently ignores the use of the region
-    psImage *region = NULL;             // Region to transform
+    psImage *region = NULL;             ///< Region to transform
 
     psTimerStart("warp");
 
     // Get warp parameters
-    bool mdok;                          // Status of MD lookup
-    int nGridX = psMetadataLookupS32(NULL, config->arguments, "GRID.NX"); // Number of grid points in x
-    int nGridY = psMetadataLookupS32(NULL, config->arguments, "GRID.NY"); // Number of grid points in y
+    bool mdok;                          ///< Status of MD lookup
+    int nGridX = psMetadataLookupS32(NULL, config->arguments, "GRID.NX"); ///< Number of grid points in x
+    int nGridY = psMetadataLookupS32(NULL, config->arguments, "GRID.NY"); ///< Number of grid points in y
     psImageInterpolateMode interpolationMode = psMetadataLookupS32(NULL, config->arguments,
-                                                                   "INTERPOLATION.MODE"); // Mode for interp
-    int numKernels = psMetadataLookupS32(NULL, config->arguments, "INTERPOLATION.NUM"); // Number of kernels
+                                                                   "INTERPOLATION.MODE"); ///< Mode for interp
+    int numKernels = psMetadataLookupS32(NULL, config->arguments, "INTERPOLATION.NUM"); ///< Number of kernels
 
     // load the recipe
@@ -27 +41 @@
     psAssert(mdok, "MASK.INPUT was not defined");
 
-    int nThreads = psMetadataLookupS32(&mdok, config->arguments, "NTHREADS"); // Number of threads
+    int nThreads = psMetadataLookupS32(&mdok, config->arguments, "NTHREADS"); ///< Number of threads
     if (!mdok) {
         nThreads = 0;
     }
-    float poorFrac = psMetadataLookupF32(NULL, config->arguments, "POOR.FRAC"); // Flux fraction for "poor"
+    float poorFrac = psMetadataLookupF32(NULL, config->arguments, "POOR.FRAC"); ///< Flux fraction for "poor"
 
     // pswarpMapGridFromImage builds a set of locally-linear maps which convert the
@@ -42 +56 @@
 
     // Get range of interest
-    int xOutMin, xOutMax, yOutMin, yOutMax; // Output pixel range
+    int xOutMin, xOutMax, yOutMin, yOutMax; ///< Output pixel range
     pswarpMatchRange(&xOutMin, &yOutMin, &xOutMax, &yOutMax, input, output);
 
@@ -53 +67 @@
     }
 
-    int xGridMin = nGridX, xGridMax = 0, yGridMin = nGridY, yGridMax = 0; // Grid range
-    int xGrid, yGrid;                   // Grid coordinates
+    int xGridMin = nGridX, xGridMax = 0, yGridMin = nGridY, yGridMax = 0; ///< Grid range
+    int xGrid, yGrid;                   ///< Grid coordinates
     pswarpMapGridSetGrid(grid, xOutMin, yOutMin, &xGrid, &yGrid);
     CHECK_GRID_RANGE();
@@ -121 +135 @@
     psThreadJob *job = NULL;
     int xMin = output->image->numCols, xMax = 0, yMin = output->image->numRows, yMax = 0; // Bounds
-    int goodPixels = 0;                 // total number of good pixels across all tiles
+    int goodPixels = 0;                 ///< total number of good pixels across all tiles
     while ((job = psThreadJobGetDone()) != NULL) {
         if (job->args->n < 1) {