IPP Software Navigation Tools IPP Links Communication Pan-STARRS Links

Ignore:
Timestamp:
Jan 23, 2007, 12:47:23 PM (19 years ago)
Author:
magnier
Message:

major cleanup of the Doxygen groups

Location:
trunk/psLib/src/imageops
Files:
9 edited

Legend:

Unmodified
Added
Removed

  • trunk/psLib/src/imageops/psImageBackground.h

    r10396 r11248  
     1/** @file  psImageUnbin.h
     2 *
     3 *  @brief Functions to determine the image background
     4 *
     5 *  @author EAM, IfA
     6 *
     7 *  $Revision: 1.4 $ $Name: not supported by cvs2svn $
     8 *  $Date: 2007-01-23 22:47:23 $
     9 *  Copyright 2004-2005 IfA, University of Hawaii
     10 */
     11
    112#ifndef PS_IMAGE_BACKGROUND_H
    213#define PS_IMAGE_BACKGROUND_H
     14
     15/// @addtogroup ImageOps Image Operations
     16/// @{
    317
    418#include "psStats.h"
    … …  
    1428                      );
    1529
     30/// @}
    1631#endif // #ifndef PS_IMAGE_BACKGROUND_H

  • trunk/psLib/src/imageops/psImageConvolve.h

    r11153 r11248  
    1 /** @file  psImageConvolve.h
     1/* @file  psImageConvolve.h
    22 *
    3  *  @brief image convolution functionality
     3 * @brief image convolution functionality
    44 *
    5  *  @ingroup Transform
     5 * @author Robert DeSonia, MHPCC
    66 *
    7  *  @author Robert DeSonia, MHPCC
    8  *
    9  *  @version $Revision: 1.14 $ $Name: not supported by cvs2svn $
    10  *  @date $Date: 2007-01-19 04:30:33 $
    11  *
    12  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
     7 * @version $Revision: 1.15 $ $Name: not supported by cvs2svn $
     8 * @date $Date: 2007-01-23 22:47:23 $
     9 * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    1310 */
    1411
    1512#ifndef PS_IMAGE_CONVOLVE_H
    1613#define PS_IMAGE_CONVOLVE_H
     14
     15/// @addtogroup ImageOps Image Operations
     16/// @{
    1717
    1818#include "psImage.h"
    … …  
    158158);
    159159
    160 
     160/// @}
    161161#endif // #ifndef PS_IMAGE_CONVOLVE_H

  • trunk/psLib/src/imageops/psImageGeomManip.h

    r9927 r11248  
    1 /** @file  psImageGeomManip.h
     1/* @file  psImageGeomManip.h
    22 *
    3  *  @brief Contains basic image geometry manipulation operations, as
    4  *         specified in the PSLIB SDRS sections "Image Geometry Manipulations".
     3 * @brief Contains basic image geometry manipulation operations, as
     4 *        specified in the PSLIB SDRS sections "Image Geometry Manipulations".
    55 *
    6  *  @ingroup Image
     6 * @author Robert DeSonia, MHPCC
    77 *
    8  *  @author Robert DeSonia, MHPCC
    9  *
    10  *  @version $Revision: 1.17 $ $Name: not supported by cvs2svn $
    11  *  @date $Date: 2006-11-09 20:20:27 $
    12  *
    13  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
     8 * @version $Revision: 1.18 $ $Name: not supported by cvs2svn $
     9 * @date $Date: 2007-01-23 22:47:23 $
     10 * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    1411 */
    1512#ifndef PS_IMAGE_GEOM_MANIP_H
    1613#define PS_IMAGE_GEOM_MANIP_H
     14
     15/// @addtogroup ImageOps Image Operations
     16/// @{
    1717
    1818#include "psImage.h"
    … …  
    2020#include "psStats.h"
    2121#include "psPixels.h"
    22 
    23 /// @addtogroup Image
    24 /// @{
    2522
    2623/** Rebin image to new scale.
    … …  
    185182    psRegion region,                   ///< the size of the transformed image
    186183    const psPixels* pixels,            /**< if not NULL, consists of psPixelCoords and specifies
    187                                                     * which pixels in output image shall be transformed;
    188                                                     * otherwise, entire image generated*/
     184                                                        * which pixels in output image shall be transformed;
     185                                                        * otherwise, entire image generated*/
    189186    psImageInterpolateMode mode,       ///< the interpolation scheme to be used
    190187    double exposedValue                ///< Exposed value to which non-corresponding pixels are set
    … …  
    198195                    );
    199196
     197/// @}
    200198#endif // #ifndef PS_IMAGE_GEOM_MANIP_H

  • trunk/psLib/src/imageops/psImageMaskOps.h

    r5256 r11248  
    1 /** @file  psImageMaskOps.h
     1/* @file  psImageMaskOps.h
    22 *
    3  *  @brief Contains basic image pixel manipulation operations, as
    4  *         specified in the PSLIB SDRS sections "Mask Operations"
     3 * @brief Contains basic image pixel manipulation operations, as
     4 *        specified in the PSLIB SDRS sections "Mask Operations"
    55 *
    6  *  @ingroup Image
     6 * @author David Robbins, MHPCC
    77 *
    8  *  @author David Robbins, MHPCC
     8 * @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
     9 * @date $Date: 2007-01-23 22:47:23 $
    910 *
    10  *  @version $Revision: 1.1 $ $Name: not supported by cvs2svn $
    11  *  @date $Date: 2005-10-10 20:12:13 $
    12  *
    13  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
     11 * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    1412 */
     13
    1514#ifndef PS_IMAGE_MASK_OPS_H
    1615#define PS_IMAGE_MASK_OPS_H
     16
     17/// @addtogroup ImageOps Image Operations
     18/// @{
    1719
    1820#include "psImage.h"
    … …  
    2022#include "psStats.h"
    2123#include "psPixels.h"
    22 
    23 /// @addtogroup Image
    24 /// @{
    2524
    2625/** Sets the bits inside the region, ignoring pixels outside.
    … …  
    9594);
    9695
     96/// @}
    9797#endif // #ifndef PS_MASK_OPS_H

  • trunk/psLib/src/imageops/psImagePixelExtract.h

    r6294 r11248  
    1 /** @file  psImagePixelExtract.h
    2 *
    3 *  @brief Contains basic image extraction operations, as specified in the
    4 *         PSLIB SDRS sections "Image Pixel Extractions".
    5 *
    6 *  @ingroup Image
    7 *
    8 *  @author Robert DeSonia, MHPCC
    9 *
    10 *  @version $Revision: 1.9 $ $Name: not supported by cvs2svn $
    11 *  @date $Date: 2006-02-02 04:41:42 $
    12 *
    13 *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    14 */
     1/* @file  psImagePixelExtract.h
     2 *
     3 * @brief Basic image extraction operations
     4 *
     5 * @author Robert DeSonia, MHPCC
     6 *
     7 * @version $Revision: 1.10 $ $Name: not supported by cvs2svn $
     8 * @date $Date: 2007-01-23 22:47:23 $
     9 *
     10 * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
     11 */
    1512
    1613#ifndef PSIMAGE_PIXEL_EXTRACT_H
    1714#define PSIMAGE_PIXEL_EXTRACT_H
     15
     16/// @addtogroup ImageOps Image Operations
     17/// @{
    1818
    1919#include "psImage.h"
    … …  
    2121#include "psStats.h"
    2222#include "psPixels.h"
    23 
    24 /// @addtogroup Image
    25 /// @{
    2623
    2724/* Cut direction flag.  Used with psImageCut function.
    … …  
    146143
    147144/// @}
    148 
    149145#endif // #ifndef PSIMAGE_PIXEL_EXTRACT_H

  • trunk/psLib/src/imageops/psImagePixelManip.h

    r6227 r11248  
    1 /** @file  psImagePixelManip.h
     1/* @file  psImagePixelManip.h
    22 *
    3  *  @brief Contains basic image pixel manipulation operations, as
    4  *         specified in the PSLIB SDRS sections "Image Pixel Manipulations"
     3 * @brief Basic image pixel manipulation operations
    54 *
    6  *  @ingroup Image
     5 * @author Robert DeSonia, MHPCC
    76 *
    8  *  @author Robert DeSonia, MHPCC
     7 * @version $Revision: 1.16 $ $Name: not supported by cvs2svn $
     8 * @date $Date: 2007-01-23 22:47:23 $
    99 *
    10  *  @version $Revision: 1.15 $ $Name: not supported by cvs2svn $
    11  *  @date $Date: 2006-01-28 01:12:11 $
    12  *
    13  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
     10 * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    1411 */
     12
    1513#ifndef PS_IMAGE_PIXEL_MANIP_H
    1614#define PS_IMAGE_PIXEL_MANIP_H
     15
     16/// @addtogroup ImageOps Image Operations
     17/// @{
    1718
    1819#include "psImage.h"
    … …  
    2021#include "psStats.h"
    2122#include "psPixels.h"
    22 
    23 /// @addtogroup Image
    24 /// @{
    2523
    2624/** Clip image values outside of range to given values
    … …  
    8886);
    8987
     88/// @}
    9089#endif // #ifndef PS_IMAGE_PIXEL_MANIP_H

  • trunk/psLib/src/imageops/psImageStats.h

    r10548 r11248  
    1 /** @file psImageStats.h
    2 *  \brief Routines for calculating statistics on images.
    3 *  @ingroup ImageStats
    4 *
    5 * This file will hold the prototypes for procedures which calculate
    6 * statistic on images, histograms on images, and fit/evaluate Chebyshev
    7 * polynomials to images.
    8 *
    9 * @author GLG, MHPCC
    10 *
    11 *  @version $Revision: 1.29 $ $Name: not supported by cvs2svn $
    12 *  @date $Date: 2006-12-08 11:37:31 $
    13 *
    14 *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    15 */
     1/* @file psImageStats.h
     2 *
     3 * @brief Routines for calculating statistics on images.
     4 *
     5 * This file will hold the prototypes for procedures which calculate
     6 * statistic on images, histograms on images, and fit/evaluate Chebyshev
     7 * polynomials to images.
     8 *
     9 * @author GLG, MHPCC
     10 *
     11 * @version $Revision: 1.30 $ $Name: not supported by cvs2svn $
     12 * @date $Date: 2007-01-23 22:47:23 $
     13 * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
     14 */
     15
    1616#ifndef PS_IMAGE_STATS_H
    1717#define PS_IMAGE_STATS_H
     18
     19/// @addtogroup ImageOps Image Operations
     20/// @{
    1821
    1922#include "psType.h"
    … …  
    2427#include "psPolynomial.h"
    2528#include "psRegion.h"
    26 
    27 /// @addtogroup ImageStats
    28 /// @{
    2929
    3030/** This routine must determine the various statistics for the image.
    … …  
    101101
    102102/// @}
    103 
    104103#endif // #ifndef PS_IMAGE_STATS_H

  • trunk/psLib/src/imageops/psImageStructManip.h

    r6874 r11248  
    11/** @file  psImageStructManip.h
    22*
    3 *  @brief Contains basic image structure manipulation operations, as specified
    4 *         in the PSLIB SDRS sections "Image Structure Manipulation".
    5 *
    6 *  @ingroup Image
     3*  @brief basic image structure manipulation operations
    74*
    85*  @author Robert DeSonia, MHPCC
    96*
    10 *  @version $Revision: 1.4 $ $Name: not supported by cvs2svn $
    11 *  @date $Date: 2006-04-17 22:00:03 $
    12 *
     7*  @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
     8*  @date $Date: 2007-01-23 22:47:23 $
    139*  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    1410*/
    … …  
    1713#define PSIMAGE_STRUCT_MANIP_H
    1814
     15/// @addtogroup ImageOps Image Operations
     16/// @{
     17
    1918#include "psImage.h"
    2019#include "psRegion.h"
    2120
    22 /// @addtogroup Image
    23 /// @{
    24 
    2521/** Create a subimage of the specified area.
    2622 *
    27  *  Define a subimage of the specified area of the given image. This function
    28  *  must raise an error if the requested subset area lies outside of the
    29  *  parent image and return NULL. The argument image is the parent image,
    30  *  region.x0, region.y0 specify the starting pixel of the subraster, and
    31  *  region.x1,region.y1 specify the extent of the desired subraster. Note
    32  *  that the row and column of this “upper right-hand corner” are NOT included
    33  *  in the region. In the event that x1 or y1 are negative, they shall be
    34  *  interpreted as being relative to the size of the parent image in that
    35  *  dimension. The entire subraster must be contained within the raster of the
    36  *  parent image. Note that the refCounter for the parent should be
    37  *  incremented.  This function must be defined for the following types: psU8,
    38  *  psU16, psS8, psS16, psF32, psF64, psC32, psC64.
     23 *  Define a subimage of the specified area of the given image. This function must raise an
     24 *  error if the requested subset area lies outside of the parent image and return NULL. The
     25 *  argument image is the parent image, region.x0, region.y0 specify the starting pixel of the
     26 *  subraster, and region.x1,region.y1 specify the extent of the desired subraster. Note that
     27 *  the row and column of this upper right-hand corner NOT included in the region. In the event
     28 *  that x1 or y1 are negative, they shall be interpreted as being relative to the size of the
     29 *  parent image in that dimension. The entire subraster must be contained within the raster of
     30 *  the parent image. Note that the refCounter for the parent should be incremented.  This
     31 *  function must be defined for the following types: psU8, psU16, psS8, psS16, psF32, psF64,
     32 *  psC32, psC64.
    3933 *
    4034 *  @return psImage* : Pointer to psImage.
    … …  
    6054/** Trim an image
    6155 *
    62  *  Trim the specified image in-place, which involves shuffling the pixels
    63  *  around in memory.  The pixels in the region [col0:col1,row0:row1] shall consist
    64  *  the output image.  The column col1 and row row1 are NOT included in the range.
    65  *  In the event that x1 or y1 are non-positive, they shall be interpreted as
    66  *  being relative to the size of the parent image in that dimension.
     56 *  Trim the specified image in-place, which involves shuffling the pixels around in memory.
     57 *  The pixels in the region [col0:col1,row0:row1] shall consist the output image.  The column
     58 *  col1 and row row1 are NOT included in the range.  In the event that x1 or y1 are
     59 *  non-positive, they shall be interpreted as being relative to the size of the parent image
     60 *  in that dimension.
    6761 *
    68  *  If the entire specified subimage is not contained within the parent
    69  *  image, an error results and the return value will be NULL.
     62 *  If the entire specified subimage is not contained within the parent image, an error results
     63 *  and the return value will be NULL.
    7064 *
    71  *  N.B. If the input psImage is a child of another psImage, no pixel data
    72  *  will be trimmed, rather it equivalent to calling psImageSubset.  If the input
    73  *  psImage is, however, a parent psImage, any children will be obliterated,
    74  *  i.e., freed from memory.
     65 *  N.B. If the input psImage is a child of another psImage, no pixel data will be trimmed,
     66 *  rather it equivalent to calling psImageSubset.  If the input psImage is, however, a parent
     67 *  psImage, any children will be obliterated, i.e., freed from memory.
    7568 *
    7669 *  @return psImage*  trimmed image result
    … …  
    8275
    8376/// @}
    84 
    8577#endif // #ifndef PSIMAGE_STRUCT_MANIP_H

  • trunk/psLib/src/imageops/psImageUnbin.h

    r10136 r11248  
     1/** @file  psImageUnbin.h
     2 *
     3 *  @brief Functions to unbin images
     4 *
     5 *  @author EAM, IfA
     6 *  @author Robert DeSonia, MHPCC
     7 *
     8 *  $Revision: 1.3 $ $Name: not supported by cvs2svn $
     9 *  $Date: 2007-01-23 22:47:23 $
     10 *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
     11 */
     12
    113#ifndef PS_IMAGE_UNBIN_H
    214#define PS_IMAGE_UNBIN_H
     15
     16/// @addtogroup ImageOps Image Operations
     17/// @{
    318
    419#include "psImage.h"
    … …  
    1631                        );
    1732
     33/// @}
    1834#endif
Note: See TracChangeset for help on using the changeset viewer.