Changeset 21323 for trunk/pswarp/src/pswarpPixelFraction.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/pswarpPixelFraction.c (modified) (5 diffs)

trunk/pswarp/src/pswarpPixelFraction.c

@@ +1 @@
+/** @file pswarpPixelFraction.c
+ *
+ *  @brief
+ *
+ *  @ingroup pswarp
+ *
+ *  @author IfA
+ *  @version $Revision: 1.6 $ $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>
@@ -30 +42 @@
     bool status; 
 
-    float minFrac = psMetadataLookupF32(NULL, config->arguments, "ACCEPT.FRAC"); // Minimum fraction
+    float minFrac = psMetadataLookupF32(NULL, config->arguments, "ACCEPT.FRAC"); ///< Minimum fraction
 
     // load the recipe
@@ -43 +55 @@
     psAssert (status, "MASK.OUTPUT was not defined");
 
-    psImage *image = readout->image;    // Image of interest
-    psImage *mask = readout->mask;      // Mask image
+    psImage *image = readout->image;    ///< Image of interest
+    psImage *mask = readout->mask;      ///< Mask image
 
-    int numCols = image->numCols, numRows = image->numRows; // Size of image
+    int numCols = image->numCols, numRows = image->numRows; ///< Size of image
     long numPix = numCols * numRows;
 
@@ -52 +64 @@
     int xMin = INT_MAX, xMax = -INT_MAX, yMin = INT_MAX, yMax = -INT_MAX;
 
-    long numBad = 0;                     // Number of bad pixels
+    long numBad = 0;                     ///< Number of bad pixels
     for (int y = 0; y < numRows; y++) {
         for (int x = 0; x < numCols; x++) {
@@ -74 +86 @@
     }
 
-    float goodFrac = (numPix - numBad) / (float)numPix; // Fraction of good pixels
-    bool accept = (goodFrac >= minFrac ? true : false); // Accept this readout?
+    float goodFrac = (numPix - numBad) / (float)numPix; ///< Fraction of good pixels
+    bool accept = (goodFrac >= minFrac ? true : false); ///< Accept this readout?
 
     if (stats) {