Changeset 11248 for trunk/psLib/src/imageops/psImageStructManip.h

Timestamp:

Jan 23, 2007, 12:47:23 PM (19 years ago)

Author:

magnier

Message:

major cleanup of the Doxygen groups

File:

• trunk/psLib/src/imageops/psImageStructManip.h (modified) (4 diffs)

trunk/psLib/src/imageops/psImageStructManip.h

@@ -1 +1 @@
 /** @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 +13 @@
 #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 +54 @@
 /** 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 +75 @@
 
 /// @}
-
 #endif // #ifndef PSIMAGE_STRUCT_MANIP_H