Index: trunk/psLib/src/imageops/psImageBackground.h =================================================================== --- trunk/psLib/src/imageops/psImageBackground.h (revision 11156) +++ trunk/psLib/src/imageops/psImageBackground.h (revision 11248) @@ -1,4 +1,18 @@ +/** @file psImageUnbin.h + * + * @brief Functions to determine the image background + * + * @author EAM, IfA + * + * $Revision: 1.4 $ $Name: not supported by cvs2svn $ + * $Date: 2007-01-23 22:47:23 $ + * Copyright 2004-2005 IfA, University of Hawaii + */ + #ifndef PS_IMAGE_BACKGROUND_H #define PS_IMAGE_BACKGROUND_H + +/// @addtogroup ImageOps Image Operations +/// @{ #include "psStats.h" @@ -14,3 +28,4 @@ ); +/// @} #endif // #ifndef PS_IMAGE_BACKGROUND_H Index: trunk/psLib/src/imageops/psImageConvolve.h =================================================================== --- trunk/psLib/src/imageops/psImageConvolve.h (revision 11156) +++ trunk/psLib/src/imageops/psImageConvolve.h (revision 11248) @@ -1,18 +1,18 @@ -/** @file psImageConvolve.h +/* @file psImageConvolve.h * - * @brief image convolution functionality + * @brief image convolution functionality * - * @ingroup Transform + * @author Robert DeSonia, MHPCC * - * @author Robert DeSonia, MHPCC - * - * @version $Revision: 1.14 $ $Name: not supported by cvs2svn $ - * @date $Date: 2007-01-19 04:30:33 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii + * @version $Revision: 1.15 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-23 22:47:23 $ + * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii */ #ifndef PS_IMAGE_CONVOLVE_H #define PS_IMAGE_CONVOLVE_H + +/// @addtogroup ImageOps Image Operations +/// @{ #include "psImage.h" @@ -158,4 +158,4 @@ ); - +/// @} #endif // #ifndef PS_IMAGE_CONVOLVE_H Index: trunk/psLib/src/imageops/psImageGeomManip.h =================================================================== --- trunk/psLib/src/imageops/psImageGeomManip.h (revision 11156) +++ trunk/psLib/src/imageops/psImageGeomManip.h (revision 11248) @@ -1,18 +1,18 @@ -/** @file psImageGeomManip.h +/* @file psImageGeomManip.h * - * @brief Contains basic image geometry manipulation operations, as - * specified in the PSLIB SDRS sections "Image Geometry Manipulations". + * @brief Contains basic image geometry manipulation operations, as + * specified in the PSLIB SDRS sections "Image Geometry Manipulations". * - * @ingroup Image + * @author Robert DeSonia, MHPCC * - * @author Robert DeSonia, MHPCC - * - * @version $Revision: 1.17 $ $Name: not supported by cvs2svn $ - * @date $Date: 2006-11-09 20:20:27 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii + * @version $Revision: 1.18 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-23 22:47:23 $ + * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii */ #ifndef PS_IMAGE_GEOM_MANIP_H #define PS_IMAGE_GEOM_MANIP_H + +/// @addtogroup ImageOps Image Operations +/// @{ #include "psImage.h" @@ -20,7 +20,4 @@ #include "psStats.h" #include "psPixels.h" - -/// @addtogroup Image -/// @{ /** Rebin image to new scale. @@ -185,6 +182,6 @@ psRegion region, ///< the size of the transformed image const psPixels* pixels, /**< if not NULL, consists of psPixelCoords and specifies - * which pixels in output image shall be transformed; - * otherwise, entire image generated*/ + * which pixels in output image shall be transformed; + * otherwise, entire image generated*/ psImageInterpolateMode mode, ///< the interpolation scheme to be used double exposedValue ///< Exposed value to which non-corresponding pixels are set @@ -198,3 +195,4 @@ ); +/// @} #endif // #ifndef PS_IMAGE_GEOM_MANIP_H Index: trunk/psLib/src/imageops/psImageMaskOps.h =================================================================== --- trunk/psLib/src/imageops/psImageMaskOps.h (revision 11156) +++ trunk/psLib/src/imageops/psImageMaskOps.h (revision 11248) @@ -1,18 +1,20 @@ -/** @file psImageMaskOps.h +/* @file psImageMaskOps.h * - * @brief Contains basic image pixel manipulation operations, as - * specified in the PSLIB SDRS sections "Mask Operations" + * @brief Contains basic image pixel manipulation operations, as + * specified in the PSLIB SDRS sections "Mask Operations" * - * @ingroup Image + * @author David Robbins, MHPCC * - * @author David Robbins, MHPCC + * @version $Revision: 1.2 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-23 22:47:23 $ * - * @version $Revision: 1.1 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-10-10 20:12:13 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii + * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii */ + #ifndef PS_IMAGE_MASK_OPS_H #define PS_IMAGE_MASK_OPS_H + +/// @addtogroup ImageOps Image Operations +/// @{ #include "psImage.h" @@ -20,7 +22,4 @@ #include "psStats.h" #include "psPixels.h" - -/// @addtogroup Image -/// @{ /** Sets the bits inside the region, ignoring pixels outside. @@ -95,3 +94,4 @@ ); +/// @} #endif // #ifndef PS_MASK_OPS_H Index: trunk/psLib/src/imageops/psImagePixelExtract.h =================================================================== --- trunk/psLib/src/imageops/psImagePixelExtract.h (revision 11156) +++ trunk/psLib/src/imageops/psImagePixelExtract.h (revision 11248) @@ -1,19 +1,19 @@ -/** @file psImagePixelExtract.h -* -* @brief Contains basic image extraction operations, as specified in the -* PSLIB SDRS sections "Image Pixel Extractions". -* -* @ingroup Image -* -* @author Robert DeSonia, MHPCC -* -* @version $Revision: 1.9 $ $Name: not supported by cvs2svn $ -* @date $Date: 2006-02-02 04:41:42 $ -* -* Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii -*/ +/* @file psImagePixelExtract.h + * + * @brief Basic image extraction operations + * + * @author Robert DeSonia, MHPCC + * + * @version $Revision: 1.10 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-23 22:47:23 $ + * + * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii + */ #ifndef PSIMAGE_PIXEL_EXTRACT_H #define PSIMAGE_PIXEL_EXTRACT_H + +/// @addtogroup ImageOps Image Operations +/// @{ #include "psImage.h" @@ -21,7 +21,4 @@ #include "psStats.h" #include "psPixels.h" - -/// @addtogroup Image -/// @{ /* Cut direction flag. Used with psImageCut function. @@ -146,4 +143,3 @@ /// @} - #endif // #ifndef PSIMAGE_PIXEL_EXTRACT_H Index: trunk/psLib/src/imageops/psImagePixelManip.h =================================================================== --- trunk/psLib/src/imageops/psImagePixelManip.h (revision 11156) +++ trunk/psLib/src/imageops/psImagePixelManip.h (revision 11248) @@ -1,18 +1,19 @@ -/** @file psImagePixelManip.h +/* @file psImagePixelManip.h * - * @brief Contains basic image pixel manipulation operations, as - * specified in the PSLIB SDRS sections "Image Pixel Manipulations" + * @brief Basic image pixel manipulation operations * - * @ingroup Image + * @author Robert DeSonia, MHPCC * - * @author Robert DeSonia, MHPCC + * @version $Revision: 1.16 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-23 22:47:23 $ * - * @version $Revision: 1.15 $ $Name: not supported by cvs2svn $ - * @date $Date: 2006-01-28 01:12:11 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii + * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii */ + #ifndef PS_IMAGE_PIXEL_MANIP_H #define PS_IMAGE_PIXEL_MANIP_H + +/// @addtogroup ImageOps Image Operations +/// @{ #include "psImage.h" @@ -20,7 +21,4 @@ #include "psStats.h" #include "psPixels.h" - -/// @addtogroup Image -/// @{ /** Clip image values outside of range to given values @@ -88,3 +86,4 @@ ); +/// @} #endif // #ifndef PS_IMAGE_PIXEL_MANIP_H Index: trunk/psLib/src/imageops/psImageStats.h =================================================================== --- trunk/psLib/src/imageops/psImageStats.h (revision 11156) +++ trunk/psLib/src/imageops/psImageStats.h (revision 11248) @@ -1,19 +1,22 @@ -/** @file psImageStats.h -* \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 GLG, MHPCC -* -* @version $Revision: 1.29 $ $Name: not supported by cvs2svn $ -* @date $Date: 2006-12-08 11:37:31 $ -* -* Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii -*/ +/* @file psImageStats.h + * + * @brief Routines for calculating statistics on images. + * + * This file will hold the prototypes for procedures which calculate + * statistic on images, histograms on images, and fit/evaluate Chebyshev + * polynomials to images. + * + * @author GLG, MHPCC + * + * @version $Revision: 1.30 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-23 22:47:23 $ + * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii + */ + #ifndef PS_IMAGE_STATS_H #define PS_IMAGE_STATS_H + +/// @addtogroup ImageOps Image Operations +/// @{ #include "psType.h" @@ -24,7 +27,4 @@ #include "psPolynomial.h" #include "psRegion.h" - -/// @addtogroup ImageStats -/// @{ /** This routine must determine the various statistics for the image. @@ -101,4 +101,3 @@ /// @} - #endif // #ifndef PS_IMAGE_STATS_H Index: trunk/psLib/src/imageops/psImageStructManip.h =================================================================== --- trunk/psLib/src/imageops/psImageStructManip.h (revision 11156) +++ trunk/psLib/src/imageops/psImageStructManip.h (revision 11248) @@ -1,14 +1,10 @@ /** @file psImageStructManip.h * -* @brief Contains basic image structure manipulation operations, as specified -* in the PSLIB SDRS sections "Image Structure Manipulation". -* -* @ingroup Image +* @brief basic image structure manipulation operations * * @author Robert DeSonia, MHPCC * -* @version $Revision: 1.4 $ $Name: not supported by cvs2svn $ -* @date $Date: 2006-04-17 22:00:03 $ -* +* @version $Revision: 1.5 $ $Name: not supported by cvs2svn $ +* @date $Date: 2007-01-23 22:47:23 $ * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii */ @@ -17,24 +13,22 @@ #define PSIMAGE_STRUCT_MANIP_H +/// @addtogroup ImageOps Image Operations +/// @{ + #include "psImage.h" #include "psRegion.h" -/// @addtogroup Image -/// @{ - /** Create a subimage of the specified area. * - * Define a subimage of the specified area of the given image. This function - * must raise an error if the requested subset area lies outside of the - * parent image and return NULL. The argument image is the parent image, - * region.x0, region.y0 specify the starting pixel of the subraster, and - * region.x1,region.y1 specify the extent of the desired subraster. Note - * that the row and column of this “upper right-hand corner” are NOT included - * in the region. In the event that x1 or y1 are negative, they shall be - * interpreted as being relative to the size of the parent image in that - * dimension. The entire subraster must be contained within the raster of the - * parent image. Note that the refCounter for the parent should be - * incremented. This function must be defined for the following types: psU8, - * psU16, psS8, psS16, psF32, psF64, psC32, psC64. + * Define a subimage of the specified area of the given image. This function must raise an + * error if the requested subset area lies outside of the parent image and return NULL. The + * argument image is the parent image, region.x0, region.y0 specify the starting pixel of the + * subraster, and region.x1,region.y1 specify the extent of the desired subraster. Note that + * the row and column of this upper right-hand corner NOT included in the region. In the event + * that x1 or y1 are negative, they shall be interpreted as being relative to the size of the + * parent image in that dimension. The entire subraster must be contained within the raster of + * the parent image. Note that the refCounter for the parent should be incremented. This + * function must be defined for the following types: psU8, psU16, psS8, psS16, psF32, psF64, + * psC32, psC64. * * @return psImage* : Pointer to psImage. @@ -60,17 +54,16 @@ /** Trim an image * - * Trim the specified image in-place, which involves shuffling the pixels - * around in memory. The pixels in the region [col0:col1,row0:row1] shall consist - * the output image. The column col1 and row row1 are NOT included in the range. - * In the event that x1 or y1 are non-positive, they shall be interpreted as - * being relative to the size of the parent image in that dimension. + * Trim the specified image in-place, which involves shuffling the pixels around in memory. + * The pixels in the region [col0:col1,row0:row1] shall consist the output image. The column + * col1 and row row1 are NOT included in the range. In the event that x1 or y1 are + * non-positive, they shall be interpreted as being relative to the size of the parent image + * in that dimension. * - * If the entire specified subimage is not contained within the parent - * image, an error results and the return value will be NULL. + * If the entire specified subimage is not contained within the parent image, an error results + * and the return value will be NULL. * - * N.B. If the input psImage is a child of another psImage, no pixel data - * will be trimmed, rather it equivalent to calling psImageSubset. If the input - * psImage is, however, a parent psImage, any children will be obliterated, - * i.e., freed from memory. + * N.B. If the input psImage is a child of another psImage, no pixel data will be trimmed, + * rather it equivalent to calling psImageSubset. If the input psImage is, however, a parent + * psImage, any children will be obliterated, i.e., freed from memory. * * @return psImage* trimmed image result @@ -82,4 +75,3 @@ /// @} - #endif // #ifndef PSIMAGE_STRUCT_MANIP_H Index: trunk/psLib/src/imageops/psImageUnbin.h =================================================================== --- trunk/psLib/src/imageops/psImageUnbin.h (revision 11156) +++ trunk/psLib/src/imageops/psImageUnbin.h (revision 11248) @@ -1,4 +1,19 @@ +/** @file psImageUnbin.h + * + * @brief Functions to unbin images + * + * @author EAM, IfA + * @author Robert DeSonia, MHPCC + * + * $Revision: 1.3 $ $Name: not supported by cvs2svn $ + * $Date: 2007-01-23 22:47:23 $ + * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii + */ + #ifndef PS_IMAGE_UNBIN_H #define PS_IMAGE_UNBIN_H + +/// @addtogroup ImageOps Image Operations +/// @{ #include "psImage.h" @@ -16,3 +31,4 @@ ); +/// @} #endif