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

trunk/pswarp/src/pswarpTransformSources.c

@@ +1 @@
+/** @file pswarpTransformSources.c
+ *
+ *  @brief
+ *
+ *  @ingroup pswarp
+ *
+ *  @author IfA
+ *  @version $Revision: 1.7 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2009-02-05 20:44:04 $
+ *  Copyright 2009 Institute for Astronomy, University of Hawaii
+ */
+
 #include "pswarp.h"
 
-#define SOURCE_ARRAY_BUFFER 100         // Size to grow the array of sources at a time
+#define SOURCE_ARRAY_BUFFER 100         ///< Size to grow the array of sources at a time
 
-// 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 pswarpTransformSources(pmReadout *output, pmReadout *input, pmConfig *config)
 {
@@ -33 +47 @@
     // this does not cost us so much time.
     for (int i = 0; i < inSources->n; i++) {
-        pmSource *source = inSources->data[i]; // Source of interest
-        pmModel *model = source->modelPSF; // Model for this source
-        float xIn, yIn;             // Coordinates of source
+        pmSource *source = inSources->data[i]; ///< Source of interest
+        pmModel *model = source->modelPSF; ///< Model for this source
+        float xIn, yIn;             ///< Coordinates of source
         xIn = model->params->data.F32[PM_PAR_XPOS] - input->image->col0;
         yIn = model->params->data.F32[PM_PAR_YPOS] - input->image->row0;
 
-        int xGrid, yGrid;           // Grid coordinates for local map
+        int xGrid, yGrid;           ///< Grid coordinates for local map
         if (!pswarpMapGridSetGrid(sourceGrid, xIn + 0.5, yIn + 0.5, &xGrid, &yGrid)) {
             psError(PS_ERR_UNKNOWN, false, "Unable to get grid coordinates for source at %f,%f\n",
@@ -53 +67 @@
         }
 
-        pswarpMap *map = sourceGrid->maps[xGrid][yGrid]; // Locally linear transformation
-        double xOut, yOut;          // Output coordinates
+        pswarpMap *map = sourceGrid->maps[xGrid][yGrid]; ///< Locally linear transformation
+        double xOut, yOut;          ///< Output coordinates
         if (!pswarpMapApply(&xOut, &yOut, map, xIn + 0.5, yIn + 0.5)) {
             psError(PS_ERR_UNKNOWN, false, "Unable to transform coordinates for source at %f,%f\n",
@@ -73 +87 @@
         // Magnitudes will be off if there's any change in scale, but for our purposes (mainly x,y and
         // relative flux) that's OK.
-        pmSource *new = pmSourceAlloc(); // New source
+        pmSource *new = pmSourceAlloc(); ///< New source
         new->peak = pmPeakAlloc(xOut, yOut, source->peak->flux, PM_PEAK_LONE);
         new->peak->flux = source->peak->flux;