Changeset 1374 for trunk/psLib/src/imageops/psImageStats.h

Timestamp:

Aug 3, 2004, 2:55:17 PM (22 years ago)

Author:

desonia

Message:

doxygen grouping tweaks.

File:

• trunk/psLib/src/imageops/psImageStats.h (modified) (2 diffs)

trunk/psLib/src/imageops/psImageStats.h

@@ -1 +1 @@
 /** @file psImageStats.h
- *  \brief Routines for calculating statistics on images.
- *  \ingroup Stats
- *  @ingroup Stats
- *
- *  This file will hold the prototypes for procedures which calculate
- *  statistic on images, histograms on images, and fit/evaluate Chebyshev
- *  polynomials to images.
- *
- *  @author George Gusciora, MHPCC
- *
- *  @version $Revision: 1.9 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2004-07-29 02:00:27 $
- *
- *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
- */
+*  \brief Routines for calculating statistics on images.
+*  @ingroup ImageStats
+*
+*  This file will hold the prototypes for procedures which calculate
+*  statistic on images, histograms on images, and fit/evaluate Chebyshev
+*  polynomials to images.
+*
+*  @author George Gusciora, MHPCC
+*
+*  @version $Revision: 1.10 $ $Name: not supported by cvs2svn $
+*  @date $Date: 2004-08-04 00:55:17 $
+*
+*  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
+*/
 #if !defined(PS_IMAGE_STATS_H)
 #define PS_IMAGE_STATS_H
@@ -25 +24 @@
 #include "psFunctions.h"
 
+/// @addtogroup ImageStats
+/// @{
+
 /// 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
-
-
-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
-
+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
+                               
 /// 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
+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
+psImageEvalPolynomial( const psImage *input,  ///< image to fit
+                       const psPolynomial2D *coeffs ///< coefficient structure carries in desired terms
                      );
+                     
+/// @}
 
 #endif