Changeset 1442 for trunk/psLib/src/image/psImageStats.h

Timestamp:

Aug 9, 2004, 3:05:53 PM (22 years ago)

Author:

desonia

Message:

doxygen comments added.

File:

• trunk/psLib/src/image/psImageStats.h (modified) (3 diffs)

trunk/psLib/src/image/psImageStats.h

@@ -1 @@
-
 /** @file psImageStats.h
 *  \brief Routines for calculating statistics on images.
@@ -10 +9 @@
 *  @author George Gusciora, MHPCC
 *
-*  @version $Revision: 1.14 $ $Name: not supported by cvs2svn $
-*  @date $Date: 2004-08-09 23:40:55 $
+*  @version $Revision: 1.15 $ $Name: not supported by cvs2svn $
+*  @date $Date: 2004-08-10 01:05:53 $
 *
 *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
@@ -27 +26 @@
 /// @{
 
-/// This routine must determine the various statistics for the image.
-psStats* psImageStats(psStats* stats,  ///< defines statistics to be calculated
-                      psImage* in,     ///< image (or subimage) to calculate stats
-                      psImage* mask,   ///< mask data for image (NULL ok)
-                      int maskVal);     ///< mask Mask for mask
+/** This routine must determine the various statistics for the image.
+ *
+ *  Determine statistics for image (or subimage). The statistics to be 
+ *  determined are specified by stats. The mask allows pixels to be excluded 
+ *  if their corresponding mask pixel value matches the value of maskVal. 
+ *  This function must be defined for the following types: psS8, psU16, psF32, 
+ *  psF64.
+ *
+ *  @return psStats*    the resulting statistics result(s)
+ */
+psStats* psImageStats(
+    psStats* stats,                    ///< defines statistics to be calculated
+    psImage* in,                       ///< image (or subimage) to calculate stats
+    psImage* mask,                     ///< mask data for image (NULL ok)
+    int maskVal                        ///< mask Mask for mask
+);
 
-psHistogram* psImageHistogram(psHistogram* out,        ///< input histogram description & target
-                              psImage* in,     ///< Image data to be histogramed.
-                              psImage* mask,   ///< mask data for image (NULL ok)
-                              unsigned int maskVal);    ///< mask Mask for mask
+/** Construct a histogram from an image (or subimage).
+ *
+ *  The histogram to generate is specified by psHistogram hist (see section 
+ *  4.3.2 in SDRS). This function must be defined for the following types: 
+ *  psS8, psU16, psF32, psF64.
+ *
+ *  @return psHistogram*     the resulting histogram
+ */
+psHistogram* psImageHistogram(
+    psHistogram* out,                  ///< input histogram description & target
+    psImage* in,                       ///< Image data to be histogramed.
+    psImage* mask,                     ///< mask data for image (NULL ok)
+    unsigned int maskVal               ///< mask Mask for mask
+);
 
-/// Fit a 2-D polynomial surface to an image.
-psPolynomial2D* psImageFitPolynomial(const psImage* input,     ///< image to fit
-                                     psPolynomial2D* coeffs    ///< coefficient structure carries in
-                                     // desired terms & target
-                                    );
+/** Fit a 2-D polynomial surface to an image.
+ *
+ *  The input structure coeffs contains the desired order and terms of 
+ *  interest. This function must be defined for the following types: psS8, 
+ *  psU16, psF32, psF64.
+ *
+ *  @return psPolynomial2D*     fitted polynomial result
+ *
+ */
+psPolynomial2D* psImageFitPolynomial(
+    const psImage* input,              ///< image to fit
+    psPolynomial2D* coeffs             ///< coefficient structure carries in desired terms & target
+);
 
-/// Evaluate a 2-D polynomial surface to image pixels.
-int psImageEvalPolynomial(const psImage* input,        ///< image to fit
-                          const psPolynomial2D* coeffs ///< coefficient structure carries in desired terms
-                         );
+/** Evaluate a 2-D polynomial surface for the image pixels.
+ *
+ *  Given the input polynomial coefficients, set the image pixel values on the 
+ *  basis of the polynomial function. This function must be defined for the 
+ *  following types: psS8, psU16, psF32, psF64.
+ *
+ *  @return psImage*    the resulting image
+ */
+int psImageEvalPolynomial(
+    const psImage* input,              ///< input image
+    const psPolynomial2D* coeffs       ///< coefficient structure carries in desired terms
+);
 
 /// @}