Changeset 1426 for trunk/psLib/src/image/psImageManip.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/psImageManip.h (modified) (7 diffs)

trunk/psLib/src/image/psImageManip.h

@@ -11 +11 @@
  *  @author Ross Harman, MHPCC
  *
- *  @version $Revision: 1.7 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2004-08-07 00:06:06 $
+ *  @version $Revision: 1.8 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2004-08-09 22:44:25 $
  *
  *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
@@ -32 +32 @@
  *  @return int     The number of clipped pixels
  */
-int psImageClip(psImage * input,        // /< the image to clip
-                psF64 min,      // /< the minimum image value allowed
-                psF64 vmin,     // /< the value pixels < min are set to
-                psF64 max,      // /< the maximum image value allowed
-                psF64 vmax      // /< the value pixels > max are set to
+int psImageClip(psImage * input,        ///< the image to clip
+                psF64 min,      ///< the minimum image value allowed
+                psF64 vmin,     ///< the value pixels < min are set to
+                psF64 max,      ///< the maximum image value allowed
+                psF64 vmax      ///< the value pixels > max are set to
                );
 
@@ -48 +48 @@
  *  @return int     The number of clipped pixels
  */
-int psImageClipComplexRegion(psImage * input,   // /< the image to clip
-                             psC64 min, // /< the minimum image value allowed
-                             psC64 vmin,        // /< the value pixels < min are set to
-                             psC64 max, // /< the maximum image value allowed
-                             psC64 vmax // /< the value pixels > max are set to
+int psImageClipComplexRegion(psImage * input,   ///< the image to clip
+                             psC64 min, ///< the minimum image value allowed
+                             psC64 vmin,        ///< the value pixels < min are set to
+                             psC64 max, ///< the maximum image value allowed
+                             psC64 vmax ///< the value pixels > max are set to
                             );
 
@@ -62 +62 @@
  *  @return int     The number of clipped pixels
  */
-int psImageClipNaN(psImage * input,     // /< the image to clip
-                   psF64 value  // /< the value to set all NaN/Inf values to
+int psImageClipNaN(psImage * input,     ///< the image to clip
+                   psF64 value  ///< the value to set all NaN/Inf values to
                   );
 
@@ -77 +77 @@
  *  @return int         0 if success, non-zero if failed.
  */
-int psImageOverlaySection(psImage * image,      // /< target image
-                          const psImage * overlay,      // /< the overlay image
-                          int col0,     // /< the column to start overlay
-                          int row0,     // /< the row to start overlay
-                          const char *op        // /< the operation to perform for overlay
+int psImageOverlaySection(psImage * image,      ///< target image
+                          const psImage * overlay,      ///< the overlay image
+                          int col0,     ///< the column to start overlay
+                          int row0,     ///< the row to start overlay
+                          const char *op        ///< the operation to perform for overlay
                          );
 
@@ -94 +94 @@
  *  @return psImage    new image formed by rebinning input image.
  */
-psImage *psImageRebin(psImage * out,    // /< an psImage to recycle.  If NULL, a new image is created
-                      const psImage * in,       // /< input image
-                      unsigned int scale,       // /< the scale to rebin for each dimension
-                      const psStats * stats     // /< the statistic to perform when rebinning.  Only one
+psImage *psImageRebin(psImage * out,    ///< an psImage to recycle.  If NULL, a new image is created
+                      const psImage * in,       ///< input image
+                      unsigned int scale,       ///< the scale to rebin for each dimension
+                      const psStats * stats     ///< the statistic to perform when rebinning.  Only one
                       // method should be set.
                      );
 
-psImage *psImageResample(psImage * out, // /< an psImage to recycle.  If NULL, a new image is created
-                         const psImage * in,    // /< input image
+psImage *psImageResample(psImage * out, ///< an psImage to recycle.  If NULL, a new image is created
+                         const psImage * in,    ///< input image
                          int scale, psImageInterpolateMode mode);
 
-psImage *psImageRotate(psImage * out,   // /< an psImage to recycle.  If NULL, a new image is created
-                       const psImage * in,      // /< input image
+psImage *psImageRotate(psImage * out,   ///< an psImage to recycle.  If NULL, a new image is created
+                       const psImage * in,      ///< input image
                        float angle, float unexposedValue, psImageInterpolateMode mode);
 
-psImage *psImageShift(psImage * out,    // /< an psImage to recycle.  If NULL, a new image is created
-                      const psImage * in,       // /< input image
+psImage *psImageShift(psImage * out,    ///< an psImage to recycle.  If NULL, a new image is created
+                      const psImage * in,       ///< input image
                       float dx, float dy, float unexposedValue, psImageInterpolateMode mode);
 
@@ -121 +121 @@
  *  @return psImage*    the rolled version of the input image.
  */
-psImage *psImageRoll(psImage * out,     // /< an psImage to recycle.  If NULL, a new image is created
-                     const psImage * in,        // /< input image
-                     int dx,    // /< number of pixels to roll in the x-dimension
-                     int dy     // /< number of pixels to roll in the y-dimension
+psImage *psImageRoll(psImage * out,     ///< an psImage to recycle.  If NULL, a new image is created
+                     const psImage * in,        ///< input image
+                     int dx,    ///< number of pixels to roll in the x-dimension
+                     int dy     ///< number of pixels to roll in the y-dimension
                     );