Changeset 1426 for trunk/psLib/src/image/psImage.h

Timestamp:

Aug 9, 2004, 12:44:25 PM (22 years ago)

Author:

desonia

Message:

fixed some stupid indent-induced formating problems and added doxygen
comments.

File:

• trunk/psLib/src/image/psImage.h (modified) (4 diffs)

trunk/psLib/src/image/psImage.h

@@ -12 +12 @@
  *  @author Ross Harman, MHPCC
  *
- *  @version $Revision: 1.28 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2004-08-07 00:06:06 $
+ *  @version $Revision: 1.29 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2004-08-09 22:44:25 $
  *
  *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
  */
 #ifndef PS_IMAGE_H
-#    define PS_IMAGE_H
+#define PS_IMAGE_H
 
-#    include <complex.h>
+#include <complex.h>
 
-#    include "psType.h"
+#include "psType.h"
 
 /// @addtogroup Image
 /// @{
 
+/** enumeration of options in interpolation
+ *
+ */
 typedef enum {
-    PS_INTERPOLATE_FLAT,
-    PS_INTERPOLATE_BILINEAR
+    PS_INTERPOLATE_FLAT,               ///< 'flat' interpolation (nearest pixel)
+    PS_INTERPOLATE_BILINEAR            ///< bi-linear interpolation
 } psImageInterpolateMode;
 
@@ -40 +43 @@
 typedef struct psImage
 {
-    const psType type;          // /< Image data type and dimension.
-    const unsigned int numCols; // /< Number of columns in image
-    const unsigned int numRows; // /< Number of rows in image.
-    const int col0;             // /< Column position relative to parent.
-    const int row0;             // /< Row position relative to parent.
+    const psType type;          ///< Image data type and dimension.
+    const unsigned int numCols; ///< Number of columns in image
+    const unsigned int numRows; ///< Number of rows in image.
+    const int col0;             ///< Column position relative to parent.
+    const int row0;             ///< Row position relative to parent.
 
     union {
-        psU8 **U8;              // /< Unsigned 8-bit integer data.
-        psU16 **U16;            // /< Unsigned 16-bit integer data.
-        psU32 **U32;            // /< Unsigned 32-bit integer data.
-        psU64 **U64;            // /< Unsigned 64-bit integer data.
-        psS8 **S8;              // /< Signed 8-bit integer data.
-        psS16 **S16;            // /< Signed 16-bit integer data.
-        psS32 **S32;            // /< Signed 32-bit integer data.
-        psS64 **S64;            // /< Signed 64-bit integer data.
-        psF32 **F32;            // /< Single-precision float data.
-        psF64 **F64;            // /< Double-precision float data.
-        psC32 **C32;            // /< Single-precision complex data.
-        psC64 **C64;            // /< Double-precision complex data.
-        psPTR **PTR;            // /< Void pointers.
-        psPTR *V;               // /< Pointer to data.
-    } data;                     // /< Union for data types.
-    const struct psImage *parent;       // /< Parent, if a subimage.
-    int nChildren;              // /< Number of subimages.
-    struct psImage **children;  // /< Children of this region.
+        psU8 **U8;              ///< Unsigned 8-bit integer data.
+        psU16 **U16;            ///< Unsigned 16-bit integer data.
+        psU32 **U32;            ///< Unsigned 32-bit integer data.
+        psU64 **U64;            ///< Unsigned 64-bit integer data.
+        psS8 **S8;              ///< Signed 8-bit integer data.
+        psS16 **S16;            ///< Signed 16-bit integer data.
+        psS32 **S32;            ///< Signed 32-bit integer data.
+        psS64 **S64;            ///< Signed 64-bit integer data.
+        psF32 **F32;            ///< Single-precision float data.
+        psF64 **F64;            ///< Double-precision float data.
+        psC32 **C32;            ///< Single-precision complex data.
+        psC64 **C64;            ///< Double-precision complex data.
+        psPTR **PTR;            ///< Void pointers.
+        psPTR *V;               ///< Pointer to data.
+    } data;                     ///< Union for data types.
+    const struct psImage *parent;       ///< Parent, if a subimage.
+    int nChildren;              ///< Number of subimages.
+    struct psImage **children;  ///< Children of this region.
 }
 psImage;
@@ -82 +85 @@
  *
  */
-psImage *psImageAlloc(unsigned int numCols,     // /< Number of rows in image.
-                      unsigned int numRows,     // /< Number of columns in image.
-                      const psElemType type     // /< Type of data for image.
+psImage *psImageAlloc(unsigned int numCols,     ///< Number of rows in image.
+                      unsigned int numRows,     ///< Number of columns in image.
+                      const psElemType type     ///< Type of data for image.
                      );
 
@@ -92 +95 @@
  *
  */
-psImage *psImageRecycle(psImage * old,  // /< the psImage to recycle by resizing image buffer
-                        unsigned int numCols,   // /< the desired number of columns in image
-                        unsigned int numRows,   // /< the desired number of rows in image
-                        const psElemType type   // /< the desired datatype of the image
+psImage *psImageRecycle(psImage * old,  ///< the psImage to recycle by resizing image buffer
+                        unsigned int numCols,   ///< the desired number of columns in image
+                        unsigned int numRows,   ///< the desired number of rows in image
+                        const psElemType type   ///< the desired datatype of the image
                        );