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

trunk/pswarp/src/pswarpDefine.c

@@ +1 @@
+/** @file pswarpDefine.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"
-// this function loads the skycell metadata
 
+/**
+ * loads the skycell metadata
+ */
 bool pswarpDefine (pmConfig *config) {
 
@@ -42 +56 @@
         view->cell = 0;
         view->readout = 0;
-        pmCell *source = pmFPAfileThisCell(config->files, view, "PSWARP.SKYCELL"); // Source cell
-        pmHDU *hdu = pmHDUFromCell(source); // HDU for source
+        pmCell *source = pmFPAfileThisCell(config->files, view, "PSWARP.SKYCELL"); ///< Source cell
+        pmHDU *hdu = pmHDUFromCell(source); ///< HDU for source
         if (!hdu || !hdu->header) {
             psError(PS_ERR_UNEXPECTED_NULL, false, "Unable to find header for sky cell.");
@@ -49 +63 @@
             return false;
         }
-        int numCols = psMetadataLookupS32(NULL, hdu->header, "NAXIS1"); // Number of columns
-        int numRows = psMetadataLookupS32(NULL, hdu->header, "NAXIS2"); // Number of rows
+        int numCols = psMetadataLookupS32(NULL, hdu->header, "NAXIS1"); ///< Number of columns
+        int numRows = psMetadataLookupS32(NULL, hdu->header, "NAXIS2"); ///< Number of rows
 
-        pmCell *target = pmFPAviewThisCell(view, output->fpa); // Target cell
-        pmReadout *readout = pmReadoutAlloc(target); // Target readout
+        pmCell *target = pmFPAviewThisCell(view, output->fpa); ///< Target cell
+        pmReadout *readout = pmReadoutAlloc(target); ///< Target readout
         readout->image = psImageAlloc(numCols, numRows, PS_TYPE_F32);
         psImageInit(readout->image, NAN);
@@ -72 +86 @@
     view->cell = 0;
     view->readout = -1;
-    pmHDU *phu = pmFPAviewThisPHU(view, skycell->fpa); // Skycell PHU
-    pmHDU *hdu = pmFPAviewThisHDU(view, skycell->fpa); // Skycell header
+    pmHDU *phu = pmFPAviewThisPHU(view, skycell->fpa); ///< Skycell PHU
+    pmHDU *hdu = pmFPAviewThisHDU(view, skycell->fpa); ///< Skycell header
     bool bilevelAstrometry = false;
     if (phu) {
@@ -83 +97 @@
 
     // We read from the skycell into the output.  i.e., the output receives the desired astrometry.
-    pmChip *outputChip = pmFPAviewThisChip(view, output->fpa); // Chip in the output
+    pmChip *outputChip = pmFPAviewThisChip(view, output->fpa); ///< Chip in the output
     if (bilevelAstrometry) {
         if (!pmAstromReadBilevelMosaic(output->fpa, phu->header)) {
@@ -104 +118 @@
     }
 
-    const char *name = psMetadataLookupStr(NULL, input->fpa->concepts, "FPA.OBS"); // Name of FPA
+    const char *name = psMetadataLookupStr(NULL, input->fpa->concepts, "FPA.OBS"); ///< Name of FPA
     view->chip = view->cell = view->readout = -1;
     pmFPAAddSourceFromView(output->fpa, name, view, output->format);