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

Timestamp:

Jun 1, 2004, 10:00:08 AM (22 years ago)

Author:

desonia

Message:

added psImageClip* functions.

File:

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

trunk/psLib/src/image/psImage.h

@@ -9 +9 @@
  *  @author Ross Harman, MHPCC
  *
- *  @version $Revision: 1.17 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2004-05-29 01:42:12 $
+ *  @version $Revision: 1.18 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2004-06-01 20:00:08 $
  *
  *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
@@ -88 +88 @@
 /** Resize a given image to the given size/type.
  *
- *  return psImage* Resized psImage.
+ *  @return psImage* Resized psImage.
  *
  */
@@ -127 +127 @@
 /** Frees all children of a psImage.
  *
- *  return int      Number of children freed.
+ *  @return int      Number of children freed.
  *
  */
@@ -137 +137 @@
 /** Makes a copy of a psImage
  *
- * return psImage*  Copy of the input psImage.  This may not be equal to the
+ * @return psImage*  Copy of the input psImage.  This may not be equal to the
  * output parameter
  *
@@ -152 +152 @@
 );
 
+/** Clip image values outside of tange to given values
+ *
+ *  All pixels with values less than min are set to the value vmin.  all pixels
+ *  with values greater than max are set to the value vmax. This function is
+ *  defined for psU8, psU16, psS8, psS16, psF32, psF64, psC32, and psC64.
+ *
+ *  @return int     The number of clipped pixels
+ */
+int psImageClip(
+    psImage* input,                 ///< the image to clip
+    psF32 min,                      ///< the minimum image value allowed
+    psF32 vmin,                     ///< the value pixels < min are set to
+    psF32 max,                      ///< the maximum image value allowed
+    psF32 vmax                      ///< the value pixels > max are set to
+);
+
+/** Clip NaN image pixels to given value.
+ *
+ *  Pixels with NaN, +Inf, or -Inf values are set to the specified value. This
+ *  function is defined for psF32, psF64, psC32, and psC64.
+ *
+ *  @return int     The number of clipped pixels
+ */
+int psImageClipNaN(
+    psImage* input,                 ///< the image to clip
+    psF32 value                     ///< the value to set all NaN/Inf values to
+);
+
+/** Overlay subregion of image with another image
+ *
+ *  Replace the pixels in the image which correspond to the pixels in OVERLAY
+ *  with values derived from the IMAGE and OVERLAY based on the given operator
+ *  OP.  Valid operators are "=" (set image value to OVERLAY value), "+" (add
+ *  OVERLAY value to image value), "-" (subtract OVERLAY from image), "*"
+ *  (multiply OVERLAY times image), "/" (divide image by OVERLAY).  This
+ *  function is defined for psU8, psS8, psS16, psF32, psF64, psC32, and psC64.
+ *
+ *  @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
+);
 
 #endif