IPP Software Navigation Tools IPP Links Communication Pan-STARRS Links

Changeset 11248


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
Files:
71 edited

Legend:

Unmodified
Added
Removed

  • trunk/psLib/src/astro/psCoord.h

    r10823 r11248  
    11/** @file  psCoord.h
    22 *
    3  *  @brief Contains basic coordinate transformation definitions and operations
     3 *  @brief Basic coordinate transformations
    44 *
    55 *  This file defines the basic types for astronomical coordinate
    66 *  transformation
    77 *
    8  *  @ingroup CoordinateTransform
    9  *
    10  *
    118 *  @author GLG, MHPCC
    129 *
    13  *  @version $Revision: 1.55 $ $Name: not supported by cvs2svn $
    14  *  @date $Date: 2006-12-22 21:19:47 $
     10 *  @version $Revision: 1.56 $ $Name: not supported by cvs2svn $
     11 *  @date $Date: 2007-01-23 22:47:22 $
    1512 *
    1613 *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    … …  
    1916#ifndef PS_COORD_H
    2017#define PS_COORD_H
     18
     19/// @addtogroup Astro Astronomy
     20/// @{
    2121
    2222#include "psType.h"
    … …  
    2828#include "psRegion.h"
    2929//#include "psTime.h"
    30 
    31 /// @addtogroup CoordinateTransform
    32 /// @{
    3330
    3431/** Euclidiean Coordinate System.
    … …  
    459456
    460457/// @}
    461 
    462458#endif // #ifndef PS_COORD_H

  • trunk/psLib/src/astro/psEarthOrientation.h

    r7552 r11248  
    11/** @file  psEarthOrientation.h
    22*
    3 *  @brief Function prototypes for earth orientation calculations
    4 *  transformation
    5 *
    6 *  @ingroup EarthOrientation
    7 *
    8 *  @author Dave Robbins, MHPCC
     3*  @brief earth orientation calculations and transformation
     4*
     5*  @author Josh Hoblitt, IfA
     6*  @author Ed Pier, IfA
     7*  @author Eugene Magnier, IfA
    98*  @author Robert Daniel DeSonia, MHPCC
    109*
    11 *  @version $Revision: 1.16 $ $Name: not supported by cvs2svn $
    12 *  @date $Date: 2006-06-14 01:24:34 $
     10*  @version $Revision: 1.17 $ $Name: not supported by cvs2svn $
     11*  @date $Date: 2007-01-23 22:47:22 $
    1312*
    1413*  Copyright 2005 Maui High Performance Computing Center, University of Hawaii
    … …  
    1716#ifndef PS_EARTH_ORIENTATION
    1817#define PS_EARTH_ORIENTATION
     18
     19/// @addtogroup Astro Astronomy
     20/// @{
    1921
    2022#include "psCoord.h"
    … …  
    196198
    197199
     200/// @}
    198201#endif // #ifndef PS_EARTH_ORIENTATION

  • trunk/psLib/src/astro/psSphereOps.h

    r6425 r11248  
    22 *
    33 *  @brief Contains spherical rotation and offset operations
    4  *
    5  *  @ingroup CoordinateTransform
    64 *
    75 *  @author Robert DeSonia, MHPCC
    86 *  @author David Robbins, MHPCC
    97 *
    10  *  @version $Revision: 1.11 $ $Name: not supported by cvs2svn $
    11  *  @date $Date: 2006-02-14 00:09:27 $
     8 *  @version $Revision: 1.12 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2007-01-23 22:47:22 $
    1210 *
    1311 *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    … …  
    1715#define PS_SPHERE_H
    1816
    19 /// @addtogroup CoordinateTransform
     17/// @addtogroup Astro Astronomy
    2018/// @{
    2119
    22 #include "psTime.h"
     20# include "psTime.h"
    2321
    2422/** Spherical Rotation Definition
    … …  
    111109 *
    112110 *  Combines two rotations to produce a single rotation which is the
    113  *  equivalent of applying the first rotation and then the second. The output
     111 *  equivalent of applying the ï¬rst rotation and then the second. The output
    114112 *  rotation may be supplied, or will be allocated if NULL.
    115113 *

  • trunk/psLib/src/astro/psTime.h

    r10122 r11248  
    1111 *  @author Ross Harman, MHPCC
    1212 *
    13  *  @version $Revision: 1.53 $ $Name: not supported by cvs2svn $
    14  *  @date $Date: 2006-11-21 19:23:02 $
     13 *  @version $Revision: 1.54 $ $Name: not supported by cvs2svn $
     14 *  @date $Date: 2007-01-23 22:47:22 $
    1515 *
    1616 *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    … …  
    1919#ifndef PSTIME_H
    2020#define PSTIME_H
     21
     22/// @addtogroup Astro Astronomy
     23/// @{
    2124
    2225#include <time.h>
    … …  
    3437
    3538struct psSphere;
    36 
    37 /// @addtogroup Time
    38 /// @{
    39 
    4039
    4140/** Time type.

  • trunk/psLib/src/db/psDB.h

    r10669 r11248  
    1 /** @file  psDB.h
    2  *
    3  *  @brief database types and functions
    4  *
    5  *  This file defines the abstract database type and functions that
    6  *  perform basic database operations.
    7  *
    8  *  @ingroup DataBase
    9  *
    10  *  @author Joshua Hoblitt
    11  *
    12  *  @version $Revision: 1.33 $ $Name: not supported by cvs2svn $
    13  *  @date $Date: 2006-12-13 01:42:51 $
    14  *
    15  *  Copyright 2005 Joshua Hoblitt, University of Hawaii
     1/* @file  psDB.h
     2 * @brief database types and functions
     3 *
     4 * This file defines the abstract database type and functions that
     5 * perform basic database operations.
     6 *
     7 * @author Joshua Hoblitt
     8 *
     9 * @version $Revision: 1.34 $ $Name: not supported by cvs2svn $
     10 * @date $Date: 2007-01-23 22:47:22 $
     11 *
     12 * Copyright 2005 Joshua Hoblitt, University of Hawaii
    1613 */
    1714
    1815#ifndef PS_DB_H
    1916#define PS_DB_H 1
    20 
    2117#ifdef HAVE_PSDB
     18
     19/// @addtogroup FileIO Input/Output
     20/// @{
    2221
    2322#include "psType.h"
    2423#include "psMetadata.h"
    25 
    26 /// @addtogroup DataBase
    27 /// @{
    2824
    2925/** Database handle
    … …  
    458454
    459455/// @}
    460 
    461456#else
    462457typedef void psDB;
    463458#endif // HAVE_PSDB
    464 
    465459#endif // PS_DB_H

  • trunk/psLib/src/fft/psImageFFT.h

    r4540 r11248  
    1 /** @file  psImageFFT.h
     1/* @file  psImageFFT.h
     2 * @brief Contains FFT transform related functions for psImage
    23 *
    3  *  @brief Contains FFT transform related functions for psImage
     4 * @author Robert DeSonia, MHPCC
    45 *
    5  *  @ingroup Transform
    6  *
    7  *  @author Robert DeSonia, MHPCC
    8  *
    9  *  @version $Revision: 1.6 $ $Name: not supported by cvs2svn $
    10  *  @date $Date: 2005-07-12 19:12:01 $
    11  *
    12  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
     6 * @version $Revision: 1.7 $ $Name: not supported by cvs2svn $
     7 * @date $Date: 2007-01-23 22:47:22 $
     8 * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    139 */
    1410
    … …  
    1915#include "psVectorFFT.h"               // for psFFTFlags
    2016
    21 /// @addtogroup Transform
     17/// @addtogroup MathOps Mathematical Operations
    2218/// @{
    2319
    … …  
    8480
    8581/// @}
    86 
    8782#endif // #ifndef PS_IMAGE_FFT_H

  • trunk/psLib/src/fft/psVectorFFT.h

    r4162 r11248  
    1 /** @file  psVectorFFT.h
     1/* @file  psVectorFFT.h
     2 * @brief Contains FFT transform related functions for psVector
    23 *
    3  *  @brief Contains FFT transform related functions for psVector
     4 * @author Robert DeSonia, MHPCC
    45 *
    5  *  @ingroup Transform
    6  *
    7  *  @author Robert DeSonia, MHPCC
    8  *
    9  *  @version $Revision: 1.18 $ $Name: not supported by cvs2svn $
    10  *  @date $Date: 2005-06-08 23:40:45 $
    11  *
    12  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
     6 * @version $Revision: 1.19 $ $Name: not supported by cvs2svn $
     7 * @date $Date: 2007-01-23 22:47:22 $
     8 * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    139 */
    1410
    … …  
    1814#include "psVector.h"
    1915
    20 /// @addtogroup Transform
     16/// @addtogroup MathOps Mathematical Operations
    2117/// @{
    2218
    … …  
    9692
    9793/// @}
    98 
    9994#endif // #ifndef PS_VECTOR_FFT_H

  • trunk/psLib/src/fits/psFits.h

    r7846 r11248  
    1 /** @file  psFits.h
    2  *
    3  *  @brief Contains Fits I/O routines
    4  *
    5  *  @ingroup FileIO
    6  *
    7  *  @author Robert DeSonia, MHPCC
    8  *
    9  *  @version $Revision: 1.25 $ $Name: not supported by cvs2svn $
    10  *  @date $Date: 2006-07-08 03:06:40 $
    11  *
    12  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
     1/* @file  psFits.h
     2 * @brief Contains Fits I/O routines
     3 *
     4 * @author Robert DeSonia, MHPCC
     5 *
     6 * @version $Revision: 1.26 $ $Name: not supported by cvs2svn $
     7 * @date $Date: 2007-01-23 22:47:23 $
     8 * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    139 */
    1410
    … …  
    1612#define PS_FITS_H
    1713
     14/// @addtogroup FileIO Input/Output
     15/// @{
     16
    1817#include <fitsio.h>
    19 
    2018#include "psType.h"
    2119#include "psArray.h"
    … …  
    2321#include "psMetadata.h"
    2422#include "psImage.h"
    25 
    26 /// @addtogroup FileIO
    27 /// @{
    2823
    2924/** FITS HDU type.
    … …  
    203198
    204199/// @}
    205 
    206200#endif // #ifndef PS_FITS_H

  • trunk/psLib/src/fits/psFitsHeader.h

    r9066 r11248  
    1 /** @file  psFitsHeader.h
     1/* @file  psFitsHeader.h
     2 * @brief Contains Fits header I/O routines
    23 *
    3  *  @brief Contains Fits header I/O routines
     4 * @author Robert DeSonia, MHPCC
    45 *
    5  *  @ingroup FileIO
     6 * @version $Revision: 1.10 $ $Name: not supported by cvs2svn $
     7 * @date $Date: 2007-01-23 22:47:23 $
    68 *
    7  *  @author Robert DeSonia, MHPCC
    8  *
    9  *  @version $Revision: 1.9 $ $Name: not supported by cvs2svn $
    10  *  @date $Date: 2006-09-30 02:29:20 $
    11  *
    12  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
     9 * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    1310 */
    1411
    … …  
    1613#define PS_FITSHEADER_H
    1714
     15/// @addtogroup FileIO Input/Output
     16/// @{
     17
    1818#include "psFits.h"
    1919#include "psMetadata.h"
    20 
    21 /// @addtogroup FileIO
    22 /// @{
    2320
    2421/** Reads the header of the current HDU.
    … …  
    7067
    7168/// @}
    72 
    7369#endif // #ifndef PS_FITS_H

  • trunk/psLib/src/fits/psFitsImage.h

    r8412 r11248  
    1 /** @file  psFitsImage.h
     1/* @file  psFitsImage.h
     2 * @brief Contains Fits I/O routines
    23 *
    3  *  @brief Contains Fits I/O routines
     4 * @author Robert DeSonia, MHPCC
    45 *
    5  *  @ingroup FileIO
    6  *
    7  *  @author Robert DeSonia, MHPCC
    8  *
    9  *  @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
    10  *  @date $Date: 2006-08-17 22:15:17 $
    11  *
    12  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
     6 * @version $Revision: 1.6 $ $Name: not supported by cvs2svn $
     7 * @date $Date: 2007-01-23 22:47:23 $
     8 * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    139 */
    1410
    … …  
    1612#define PS_FITSIMAGE_H
    1713
     14/// @addtogroup FileIO Input/Output
     15/// @{
     16
    1817#include "psFits.h"
    19 
    2018#include "psType.h"
    2119#include "psArray.h"
    … …  
    2321#include "psMetadata.h"
    2422#include "psImage.h"
    25 
    26 /// @addtogroup FileIO
    27 /// @{
    2823
    2924/** Reads an image, given the desired region and z-plane.
    … …  
    8984
    9085/// @}
    91 
    9286#endif // #ifndef PS_FITS_H

  • trunk/psLib/src/fits/psFitsTable.h

    r7540 r11248  
    1 /** @file  psFitsTable.h
     1/* @file  psFitsTable.h
     2 * @brief Contains Fits I/O routines
    23 *
    3  *  @brief Contains Fits I/O routines
     4 * @author EAM, PAP, JH
     5 * @author Robert DeSonia, MHPCC
    46 *
    5  *  @ingroup FileIO
    6  *
    7  *  @author Robert DeSonia, MHPCC
    8  *
    9  *  @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
    10  *  @date $Date: 2006-06-13 22:28:02 $
    11  *
    12  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
     7 * @version $Revision: 1.6 $ $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_FITSTABLE_H
    1613#define PS_FITSTABLE_H
     14
     15/// @addtogroup FileIO Input/Output
     16/// @{
    1717
    1818#include "psFits.h"
    … …  
    2323#include "psMetadata.h"
    2424#include "psImage.h"
    25 
    26 /// @addtogroup FileIO
    27 /// @{
    2825
    2926/** Reads a table row.  The current HDU type must be either
    … …  
    117114
    118115/// @}
    119 
    120116#endif // #ifndef PS_FITS_H

  • 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

  • trunk/psLib/src/jpeg/psImageJpeg.h

    r7380 r11248  
    1 /** @file  psImageJpeg.h
    2  *
    3  * the functions to generate JPEG images from psImage
     1/* @file  psImageJpeg.h
     2 * @brief functions to generate JPEG images from psImage
     3 *
     4 * @author EAM
     5 * @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
     6 * @date $Date: 2007-01-23 22:47:23 $
    47 */
    58
    69#ifndef PS_IMAGE_JPEG_H
    710#define PS_IMAGE_JPEG_H
     11
     12/// @addtogroup FileIO Input/Output
     13/// @{
    814
    915#include "psImage.h"
    … …  
    3743                );
    3844
     45/// @}
    3946#endif /* PS_IMAGE_JPEG_H */

  • trunk/psLib/src/math/psBinaryOp.h

    r4540 r11248  
    1 /** @file  psBinaryOp.h
     1/* @file  psBinaryOp.h
    22 *
    3  *  @brief Provides binary functions for simple matrix and vector element operations. Functions
    4  *  include:
     3 * @brief Provides binary functions for simple matrix and vector element operations.
     4 *
     5 * Functions include:
     6 *     Addition (+)
     7 *     Subtraction (-)
     8 *     Multiplication (*)
     9 *     Division (/)
     10 *     Power (^)
     11 *     Minimum (min)
     12 *     Maximum (max)
     13 *     Absolute value (abs)
     14 *     Exponent (exp)
     15 *     Natural Log (ln)
     16 *     Power of 10 (ten)
     17 *     Log (log)
     18 *     Sine (sin or dsin)
     19 *     Cosine (cos or dcos)
     20 *     Tangent (tan or dtan)
     21 *     Arcsine (asin or dasin)
     22 *     Arccosine (acos or dacos)
     23 *     Arctan (atan or datan)
    524 *
    6  *      Addition (+)
    7  *      Subtraction (-)
    8  *      Multiplication (*)
    9  *      Division (/)
    10  *      Power (^)
    11  *      Minimum (min)
    12  *      Maximum (max)
    13  *      Absolute value (abs)
    14  *      Exponent (exp)
    15  *      Natural Log (ln)
    16  *      Power of 10 (ten)
    17  *      Log (log)
    18  *      Sine (sin or dsin)
    19  *      Cosine (cos or dcos)
    20  *      Tangent (tan or dtan)
    21  *      Arcsine (asin or dasin)
    22  *      Arccosine (acos or dacos)
    23  *      Arctan (atan or datan)
     25 * Currently only vector-vector and image-image binary operations are supported.
    2426 *
    25  *  Currently only vector-vector and image-image binary operations are supported.
     27 * @author Ross Harman, MHPCC
     28 * @author Robert DeSonia, MHPCC
    2629 *
    27  *  @ingroup MatrixArithmetic
     30 * @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
     31 * @date $Date: 2007-01-23 22:47:23 $
    2832 *
    29  *  @author Ross Harman, MHPCC
    30  *  @author Robert DeSonia, MHPCC
    31  *
    32  *  @version $Revision: 1.4 $ $Name: not supported by cvs2svn $
    33  *  @date $Date: 2005-07-12 19:12:01 $
    34  *
    35  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
     33 * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    3634 */
    3735
    … …  
    3937#define PSBINARY_OP_H
    4038
    41 /// @addtogroup MatrixArithmetic
     39/// @addtogroup MathOps Mathematical Operations
    4240/// @{
    4341
    … …  
    6361
    6462/// @}
    65 
    6663#endif // #ifndef PSBINARY_OP_H

  • trunk/psLib/src/math/psClip.h

    r9909 r11248  
     1/* @file  psClip.h
     2 * @brief vector clipping functions
     3 *
     4 * $Revision: 1.2 $ $Name: not supported by cvs2svn $
     5 * $Date: 2007-01-23 22:47:23 $
     6 * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
     7 */
     8
    19#ifndef PS_CLIP_H
    210#define PS_CLIP_H
     11
     12/// @addtogroup MathOps Mathematical Operations
     13/// @{
    314
    415/// Parameters for clipping
    … …  
    2637           );
    2738
     39/// @}
    2840#endif

  • trunk/psLib/src/math/psCompare.h

    r4367 r11248  
    1 /** @file psCompare.h
    2  *  @brief Comparison functions for sorting routines
    3  *
    4  *  @author Robert Daniel DeSonia, MHPCC
    5  *
    6  *  @ingroup Compare
    7  *
    8  *  @version $Revision: 1.8 $ $Name: not supported by cvs2svn $
    9  *  @date $Date: 2005-06-23 03:50:29 $
    10  *
    11  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
     1/* @file psCompare.h
     2 * @brief Comparison functions for sorting routines
     3 *
     4 * @author Robert Daniel DeSonia, MHPCC
     5 *
     6 * @version $Revision: 1.9 $ $Name: not supported by cvs2svn $
     7 * @date $Date: 2007-01-23 22:47:23 $
     8 * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    129 */
    1310
    … …  
    1512#define PS_COMPARE_H
    1613
     14/// @addtogroup MathOps Mathematical Operations
     15/// @{
     16
    1717#include "psType.h"
    18 
    19 /** @addtogroup Compare
    20 *  @{
    21 */
    2218
    2319/** A comparison function for sorting elements that are pointers to data,
    … …  
    503499);
    504500
    505 
    506501/// @}
    507 
    508502#endif  // #ifndef PS_COMPARE_H

  • trunk/psLib/src/math/psConstants.h

    r9593 r11248  
    1 /** @file  psConstants.h
     1/* @file  psConstants.h
    22 *
    3  *  This file will hold definitions of various constants as well as common
    4  *  macros used throughout psLib.
     3 * @brief Definitions of various constants and common macros
    54 *
    6  *  @author GLG, MHPCC
     5 * @author GLG, MHPCC
    76 *
    8  *  @version $Revision: 1.94 $ $Name: not supported by cvs2svn $
    9  *  @date $Date: 2006-10-17 01:34:45 $
     7 * @version $Revision: 1.95 $ $Name: not supported by cvs2svn $
     8 * @date $Date: 2007-01-23 22:47:23 $
    109 *
    11  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
     10 * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    1211 *
    13  *  XXX: Add parenthesis around all arguments so that these macros can be
    14  *       called with complex expressions.
     12 * XXX: Add parenthesis around all arguments so that these macros can be
     13 *      called with complex expressions.
    1514 *
    16  *  XXX: All functions which use the PS_ASSERT macros must be scrutinized so
    17  *  that we ensure that an argument which is expected to be output is
    18  *  psFree'ed before reurning NULL.
     15 * XXX: All functions which use the PS_ASSERT macros must be scrutinized so
     16 * that we ensure that an argument which is expected to be output is
     17 * psFree'ed before reurning NULL.
    1918 *
    20  *  XXX: The macros have a name similar to PS_CHECK_CONDITION() and generally
    21  *  throw a psError if the CONDITION is true.  However, some throw the error
    22  *  if the CONDITION is false.  This should be consistant.
     19 * XXX: The macros have a name similar to PS_CHECK_CONDITION() and generally
     20 * throw a psError if the CONDITION is true.  However, some throw the error
     21 * if the CONDITION is false.  This should be consistant.
    2322 *
    2423 */
     24
     25#ifndef PS_CONSTANTS_H
     26#define PS_CONSTANTS_H
     27
     28/// @addtogroup MathOps Mathematical Operations
     29/// @{
    2530
    2631#include <math.h> // for M_PI
    … …  
    6267#define PS_NOT_U16(A)(USHORT_MAX-(A)) // Perform bitwaise NOT on A which is of type U16
    6368
     69/// @}
     70#endif

  • trunk/psLib/src/math/psEllipse.h

    r10254 r11248  
    1 /** @file  psEllipse.h
     1/* @file  psEllipse.h
     2 * @brief functions to manipulate sparse matrices equations
    23 *
    3  * functions to manipulate sparse matrices equations
    4  *
     4 * $Revision: 1.3 $ $Name: not supported by cvs2svn $
     5 * $Date: 2007-01-23 22:47:23 $
     6 * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    57 */
    68
    79#ifndef PS_ELLIPSE_H
    810#define PS_ELLIPSE_H
     11
     12/// @addtogroup MathOps Mathematical Operations
     13/// @{
    914
    1015// strucures to define elliptical shape parameters
    … …  
    3944psEllipseAxes psEllipseShapeToAxes(psEllipseShape shape, double maxAR);
    4045
     46/// @}
    4147#endif

  • trunk/psLib/src/math/psHistogram.h

    r10550 r11248  
    1 /** @file  psHistogram.h
    2  *  \brief basic histogram functions
    3  *  @ingroup Math
     1/* @file  psHistogram.h
     2 * @brief basic histogram functions
    43 *
    5  *  This file holds the definition of the histogram data structures.  It also contains
    6  *  prototypes for procedures which operate on those data structures.
     4 * This file holds the definition of the histogram data structures.  It also contains
     5 * prototypes for procedures which operate on those data structures.
    76 *
    8  *  @author GLG, MHPCC
     7 * @author GLG, MHPCC
    98 *
    10  *  @version $Revision: 1.1 $ $Name: not supported by cvs2svn $
    11  *  @date $Date: 2006-12-08 11:38:54 $
     9 * @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
     10 * @date $Date: 2007-01-23 22:47:23 $
    1211 *
    13  *  Copyright 2004-2005 IfA, University of Hawaii
     12 * Copyright 2004-2005 IfA, University of Hawaii
    1413 */
    1514
    … …  
    1716#define PS_HISTOGRAM_H
    1817
    19 // #include "psVector.h"
    20 
    21 /// @addtogroup Math
     18/// @addtogroup MathOps Mathematical Operations
    2219/// @{
    2320
    … …  
    9592
    9693/// @}
    97 
    9894#endif // #ifndef PS_HISTOGRAM_H

  • trunk/psLib/src/math/psMD5.h

    r10309 r11248  
     1/* @file  psMD5.h
     2 * @brief support for MD5 hashes
     3 *
     4 * $Revision: 1.2 $ $Name: not supported by cvs2svn $
     5 * $Date: 2007-01-23 22:47:23 $
     6 * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
     7 */
     8
    19#ifndef PS_MD5_H
    210#define PS_MD5_h
     11
     12/// @addtogroup MathOps Mathematical Operations
     13/// @{
    314
    415#include "psVector.h"
    … …  
    2839                      );
    2940
    30 
     41/// @}
    3142#endif

  • trunk/psLib/src/math/psMathUtils.h

    r7132 r11248  
    1 /** @file psMathUtils.h
    2  *  @brief Standard Mathematical Functions.
    3  *  @ingroup GROUP00
     1/* @file psMathUtils.h
     2 * @brief Standard Mathematical Functions.
    43 *
    5  *  This file contains standard math rotines.
     4 * This file contains standard math rotines.
    65 *
    7  *  @author GLG, MHPCC
     6 * @author GLG, MHPCC
    87 *
    9  *  @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
    10  *  @date $Date: 2006-05-18 01:20:51 $
    11  *
    12  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
     8 * @version $Revision: 1.4 $ $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
    1311 */
    1412
    1513#ifndef PS_MATHUTILS_H
    1614#define PS_MATHUTILS_H
     15
     16/// @addtogroup MathOps Mathematical Operations
     17/// @{
    1718
    1819#include <stdio.h>
    … …  
    2324#include "psScalar.h"
    2425#include "psPolynomial.h"
    25 
    26 /** \addtogroup GROUP00
    27  *  \{
    28  */
    2926
    3027/** Performs a binary disection on a monotonically non-decreasing vector.
    … …  
    5552                              psF64 outHigh);
    5653
    57 /** \} */ // End of MathGroup Functions
    58 
     54/// @}
    5955#endif // #ifndef PS_MATHUTILS_H
    60 

  • trunk/psLib/src/math/psMatrix.h

    r10381 r11248  
    1 /** @file  psMatrix.h
     1/* @file  psMatrix.h
    22 *
    3  *  @brief Provides functions for linear algebra operations on psImages and psVectors.
     3 * @brief Provides functions for linear algebra operations on psImages and psVectors.
    44 *
    5  *  Functions are provided to:
    6  *      Transpose a psImage
    7  *      Compute LUD
    8  *      Solve LUD
    9  *      Matrix inversion
    10  *      Calculate determinant
    11  *      Matrix multiplication
    12  *      Calculate Eigenvectors
    13  *      Convert matrix to vector
    14  *      Convert vector to matrix
     5 * Functions are provided to:
     6 *     Transpose a psImage
     7 *     Compute LUD
     8 *     Solve LUD
     9 *     Matrix inversion
     10 *     Calculate determinant
     11 *     Matrix multiplication
     12 *     Calculate Eigenvectors
     13 *     Convert matrix to vector
     14 *     Convert vector to matrix
    1515 *
    16  *  These functions treat psImages as if they were matrices, therefore there is no psMatrix. These functions
    17  *  operate only with the psF64 data type.
     16 * These functions treat psImages as if they were matrices, therefore there is no psMatrix. These functions
     17 * operate only with the psF64 data type.
    1818 *
    19  *  @ingroup Matrix
     19 * @author Ross Harman, MHPCC
    2020 *
    21  *  @author Ross Harman, MHPCC
    22  *
    23  *  @version $Revision: 1.25 $ $Name: not supported by cvs2svn $
    24  *  @date $Date: 2006-12-01 21:48:47 $
    25  *
    26  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
     21 * @version $Revision: 1.26 $ $Name: not supported by cvs2svn $
     22 * @date $Date: 2007-01-23 22:47:23 $
     23 * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    2724 */
    2825
    … …  
    3027#define PSMATRIX_H
    3128
    32 /// @addtogroup Matrix
     29/// @addtogroup MathOps Mathematical Operations
    3330/// @{
    3431
    … …  
    183180
    184181/// @}
    185 
    186182#endif // #ifndef PSMATRIX_H

  • trunk/psLib/src/math/psMinimizeLMM.h

    r10252 r11248  
    1 /** @file  psMinimizeLMM.c
    2  *  \brief basic minimization functions
    3  *  @ingroup Math
     1/* @file  psMinimizeLMM.c
     2 * @brief basic minimization functions
    43 *
    5  *  This file will contain function prototypes for various Levenberg-Marquadt
    6  *  minimization routines.
     4 * This file will contain function prototypes for various Levenberg-Marquadt
     5 * minimization routines.
    76 *
    8  *  @author GLG, MHPCC
     7 * @author GLG, MHPCC
    98 *
    10  *  @version $Revision: 1.7 $ $Name: not supported by cvs2svn $
    11  *  @date $Date: 2006-11-29 02:17:15 $
    12  *
    13  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    14  *
     9 * @version $Revision: 1.8 $ $Name: not supported by cvs2svn $
     10 * @date $Date: 2007-01-23 22:47:23 $
     11 * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    1512 */
    1613
    … …  
    1815#define PS_MINIMIZE_LMM_H
    1916
    20 /** \file psMinimizeLMM.h
    21  *  \brief minimization operations
    22  *  \ingroup Stats
    23  */
    24 /** \addtogroup Stats
    25  *  \{
    26  */
     17/// @addtogroup MathOps Mathematical Operations
     18/// @{
    2719
    2820#include "psVector.h"
    … …  
    176168);
    177169
    178 /* \} */// End of MathGroup Functions
    179 
     170/// @}
    180171#endif // #ifndef PS_MINIMIZE_LMM_H
    181 

  • trunk/psLib/src/math/psMinimizePolyFit.h

    r10848 r11248  
    1 /** @file  psMinimizePolyFit.c
    2  *  \brief basic minimization functions
    3  *  @ingroup Math
     1/* @file  psMinimizePolyFit.c
     2 * @brief basic minimization functions
    43 *
    5  *  This file will contain function prototypes for various
    6  *  1-D polynomial fitting routines.
     4 * This file will contain function prototypes for various
     5 * 1-D polynomial fitting routines.
    76 *
    8  *  @author GLG, MHPCC
     7 * @author GLG, MHPCC
    98 *
    10  *  XXX: Must Doxygenate.
    11  *
    12  *  @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
    13  *  @date $Date: 2006-12-29 04:38:42 $
    14  *
    15  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
     9 * @version $Revision: 1.4 $ $Name: not supported by cvs2svn $
     10 * @date $Date: 2007-01-23 22:47:23 $
     11 * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    1612 *
    1713 */
    … …  
    2016#define PS_MINIMIZE_POLYFIT_H
    2117
    22 /** \file psMinimizePolyFit.h
    23  *  \brief minimization operations
    24  *  \ingroup Stats
    25  */
    26 /** \addtogroup Stats
    27  *  \{
    28  */
     18/// @addtogroup MathOps Mathematical Operations
     19/// @{
    2920
    3021#include "psVector.h"
    … …  
    143134);
    144135
    145 /* \} */// End of MathGroup Functions
    146 
     136/// @}
    147137#endif // #ifndef PS_MINIMIZE_POLYFIT_H
    148 

  • trunk/psLib/src/math/psMinimizePowell.h

    r10255 r11248  
    1 /** @file  psMinimizePowell.c
    2  *  \brief basic minimization functions
    3  *  @ingroup Math
     1/* @file  psMinimizePowell.c
     2 * @brief basic minimization functions
    43 *
    5  *  This file will contain function prototypes for various Powell
    6  *  chi-squared minimization routines.
     4 * This file will contain function prototypes for various Powell
     5 * chi-squared minimization routines.
    76 *
    8  *  @author GLG, MHPCC
     7 * @author GLG, MHPCC
    98 *
    10  *  @version $Revision: 1.4 $ $Name: not supported by cvs2svn $
    11  *  @date $Date: 2006-11-29 02:33:54 $
     9 * @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
     10 * @date $Date: 2007-01-23 22:47:23 $
    1211 *
    13  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
     12 * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    1413 *
    1514 */
    … …  
    1817#define PS_MINIMIZE_POWELL_H
    1918
    20 /** \file psMinimizePowell.h
    21  *  \brief minimization operations
    22  *  \ingroup Stats
    23  */
    24 /** \addtogroup Stats
    25  *  \{
    26  */
     19/// @addtogroup MathOps Mathematical Operations
     20/// @{
    2721
    2822#include "psMinimizeLMM.h"
    … …  
    8882);
    8983
    90 /* \} */// End of MathGroup Functions
    91 
     84/// @}
    9285#endif // #ifndef PS_MINIMIZE_POWELL_H
    93 

  • trunk/psLib/src/math/psPolynomial.h

    r10848 r11248  
    1 /** @file psPolynomial.h
    2  *  @brief Standard Mathematical Functions.
    3  *  @ingroup Stats
    4  *
    5  *  This file will hold the prototypes for procedures which allocate, free,
    6  *  and evaluate various polynomials.  Those polynomial structures are also
    7  *  defined here.
    8  *
    9  *  @ingroup Stats
    10  *
    11  *  @author GLG, MHPCC
    12  *
    13  *  @version $Revision: 1.66 $ $Name: not supported by cvs2svn $
    14  *  @date $Date: 2006-12-29 04:38:42 $
    15  *
    16  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
     1/* @file  psPolynomial.h
     2 * @brief Standard Mathematical Functions.
     3 *
     4 * This file will hold the prototypes for procedures which allocate, free,
     5 * and evaluate various polynomials.  Those polynomial structures are also
     6 * defined here.
     7 *
     8 * @author GLG, MHPCC
     9 *
     10 * @version $Revision: 1.67 $ $Name: not supported by cvs2svn $
     11 * @date $Date: 2007-01-23 22:47:23 $
     12 *
     13 * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    1714 */
    1815
    1916#ifndef PS_POLYNOMIAL_H
    2017#define PS_POLYNOMIAL_H
     18
     19/// @addtogroup MathOps Mathematical Operations
     20/// @{
    2121
    2222#include <stdio.h>
    … …  
    2727#include "psVector.h"
    2828#include "psScalar.h"
    29 
    30 /** \addtogroup Stats
    31  *  \{
    32  */
    3329
    3430/** Evaluate a non-normalized Gaussian with the given mean and sigma at the
    … …  
    351347}\
    352348
    353 /** \} */ // End of MathGroup Functions
    354 
     349/// @}
    355350#endif // #ifndef PS_POLYNOMIAL_H
    356 

  • trunk/psLib/src/math/psPolynomialUtils.h

    r10848 r11248  
    1 /** @file  psPolynomialUtils.h
     1/* @file  psPolynomialUtils.h
     2 * @brief extra psPolynomial-related functions
    23 *
    3  * extra psPolynomial-related functions
     4 * $Revision: 1.5 $ $Name: not supported by cvs2svn $
     5 * $Date: 2007-01-23 22:47:23 $
     6 * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    47 */
    58
    69#ifndef PS_POLYNOMIAL_UTILS_H
    710#define PS_POLYNOMIAL_UTILS_H
     11
     12/// @addtogroup MathOps Mathematical Operations
     13/// @{
    814
    915#include "psVector.h"
    … …  
    3844psPolynomial2D *psPolynomial2D_dY (psPolynomial2D *out, psPolynomial2D *poly);
    3945
     46/// @}
    4047#endif /* PS_POLY_UTILS_H */

  • trunk/psLib/src/math/psRandom.h

    r4857 r11248  
    1 /** @file psRandom.h
    2 *  \brief Random Number Generators
    3 *  \ingroup Math
    4 *
    5 *  This file will hold the prototypes for procedures which allocate, free,
    6 *  and evaluate random number Generators.
    7 *
    8 *  @ingroup Math
    9 *
    10 *  @author GLG, MHPCC
    11 *
    12 *  @version $Revision: 1.7 $ $Name: not supported by cvs2svn $
    13 *  @date $Date: 2005-08-23 23:23:05 $
    14 *
    15 *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    16 */
     1/* @file psRandom.h
     2 * @brief Random Number Generators
     3 *
     4 * This file will hold the prototypes for procedures which allocate, free,
     5 * and evaluate random number Generators.
     6 *
     7 * @author GLG, MHPCC
     8 *
     9 * @version $Revision: 1.8 $ $Name: not supported by cvs2svn $
     10 * @date $Date: 2007-01-23 22:47:23 $
     11 *
     12 * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
     13 */
    1714
    1815#ifndef PS_RANDOM_H
    1916#define PS_RANDOM_H
     17
     18/// @addtogroup MathOps Mathematical Operations
     19/// @{
    2020
    2121#include <stdio.h>
    … …  
    2828#include <gsl/gsl_rng.h>
    2929#include <gsl/gsl_randist.h>
    30 
    31 /** \addtogroup Math
    32  *  \{
    33  */
    3430
    3531/** Enumeration containing a flag for psRandom types.  */
    … …  
    109105);
    110106
    111 /* \} */// End of MathGroup Functions
    112 
     107/// @}
    113108#endif // #ifndef PS_RANDOM_H

  • trunk/psLib/src/math/psRegion.h

    r8312 r11248  
     1/* @file  psRegion.h
     2 * @brief image regions and related functions
     3 *
     4 * $Revision: 1.8 $ $Name: not supported by cvs2svn $
     5 * $Date: 2007-01-23 22:47:23 $
     6 * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
     7 */
     8
    19#ifndef PS_REGION_H
    210#define PS_REGION_H
     11
     12/// @addtogroup MathOps Mathematical Operations
     13/// @{
    314
    415#include "psString.h"
    … …  
    89100);
    90101
     102/// @}
    91103#endif

  • trunk/psLib/src/math/psRegionForImage.h

    r6874 r11248  
     1/* @file  psRegionForImage.h
     2 * @brief regions definitions based on images
     3 *
     4 * $Revision: 1.3 $ $Name: not supported by cvs2svn $
     5 * $Date: 2007-01-23 22:47:23 $
     6 * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
     7 */
     8
    19#ifndef PS_REGION_FOR_IMAGE_H
    210#define PS_REGION_FOR_IMAGE_H
    311
     12/// @addtogroup MathOps Mathematical Operations
     13/// @{
    414
    515/** Sets an actual region based on image parameters.
    … …  
    2232);
    2333
    24 
    25 
     34/// @}
    2635#endif

  • trunk/psLib/src/math/psSparse.h

    r10017 r11248  
    1 /** @file  psSparse.h
     1/* @file  psSparse.h
     2 * @brief functions to manipulate sparse matrices equations
    23 *
    3  * functions to manipulate sparse matrices equations
    4  *
     4 * $Revision: 1.8 $ $Name: not supported by cvs2svn $
     5 * $Date: 2007-01-23 22:47:23 $
     6 * Copyright 2004-2005 IfA, University of Hawaii
    57 */
    68
    79#ifndef PS_SPARSE_H
    810#define PS_SPARSE_H
     11
     12/// @addtogroup MathOps Mathematical Operations
     13/// @{
    914
    1015// constraints to limit the range of the matrix equation solution
    … …  
    102107bool psSparseBorderSolve(psVector **xFit, psVector **yFit, psSparseConstraint constraint, psSparseBorder *border, int Niter);
    103108
     109/// @}
    104110#endif /* PS_SPARSE_H */

  • trunk/psLib/src/math/psSpline.h

    r7766 r11248  
    1 /** @file psSpline.h
    2  *  @brief Standard Mathematical Functions.
    3  *  @ingroup GROUP00
     1/* @file psSpline.h
     2 * @brief Standard Mathematical Functions.
    43 *
    5  *  This file will hold the prototypes for procedures which allocate, free,
    6  *  and evaluate splines.
     4 * This file will hold the prototypes for procedures which allocate, free,
     5 * and evaluate splines.
    76 *
    8  *  XXX: What is the purpose of the SplineAlloc() function?
     7 * @author GLG, MHPCC
    98 *
    10  *  @ingroup GROUP00
    11  *
    12  *  @author GLG, MHPCC
    13  *
    14  *  @version $Revision: 1.60 $ $Name: not supported by cvs2svn $
    15  *  @date $Date: 2006-06-30 02:20:06 $
    16  *
    17  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
     9 * @version $Revision: 1.61 $ $Name: not supported by cvs2svn $
     10 * @date $Date: 2007-01-23 22:47:23 $
     11 * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    1812 */
    1913
    2014#ifndef PS_SPLINE_H
    2115#define PS_SPLINE_H
     16
     17/// @addtogroup MathOps Mathematical Operations
     18/// @{
    2219
    2320#include <stdio.h>
    … …  
    3229#define PS_LEFT_SPLINE_DERIV 0.0
    3330#define PS_RIGHT_SPLINE_DERIV 0.0
    34 
    35 /** \addtogroup GROUP00
    36  *  \{
    37  */
    3831
    3932/** One-Dimensional Spline */
    … …  
    115108
    116109
    117 /** \} */ // End of MathGroup Functions
    118 
     110/// @}
    119111#endif // #ifndef PS_SPLINE_H
    120 

  • trunk/psLib/src/math/psStats.h

    r11155 r11248  
    1 /** @file  psStats.h
    2  *  \brief basic statistical operations
    3  *  @ingroup Stats
     1/* @file  psStats.h
     2 * @brief basic statistical operations
    43 *
    5  *  This file will hold the definition of the histogram and stats data
    6  *  structures.  It also contains prototypes for procedures which operate
    7  *  on those data structures.
     4 * This file will hold the definition of the histogram and stats data
     5 * structures.  It also contains prototypes for procedures which operate
     6 * on those data structures.
    87 *
    9  *  @author GLG, MHPCC
     8 * @author GLG, MHPCC
    109 *
    11  *  @version $Revision: 1.58 $ $Name: not supported by cvs2svn $
    12  *  @date $Date: 2007-01-19 04:32:27 $
    13  *
    14  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
     10 * @version $Revision: 1.59 $ $Name: not supported by cvs2svn $
     11 * @date $Date: 2007-01-23 22:47:23 $
     12 * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    1513 */
    1614
    … …  
    1816#define PS_STATS_H
    1917
    20 // #include "psVector.h"
    21 
    22 /// @addtogroup Stats
     18/// @addtogroup MathOps Mathematical Operations
    2319/// @{
    2420
    … …  
    132128
    133129/// @}
    134 
    135130#endif // #ifndef PS_STATS_H
    136131

  • trunk/psLib/src/math/psUnaryOp.h

    r4540 r11248  
    1 /** @file  psUnaryOp.h
     1/* @file  psUnaryOp.h
    22 *
    3  *  @brief Provides unary functions for simple matrix and vector element operations. Functions
    4  *  include:
     3 * @brief Provides unary functions for simple matrix and vector element operations
    54 *
    6  *      Addition (+)
    7  *      Subtraction (-)
    8  *      Multiplication (*)
    9  *      Division (/)
    10  *      Power (^)
    11  *      Minimum (min)
    12  *      Maximum (max)
    13  *      Absolute value (abs)
    14  *      Exponent (exp)
    15  *      Natural Log (ln)
    16  *      Power of 10 (ten)
    17  *      Log (log)
    18  *      Sine (sin or dsin)
    19  *      Cosine (cos or dcos)
    20  *      Tangent (tan or dtan)
    21  *      Arcsine (asin or dasin)
    22  *      Arccosine (acos or dacos)
    23  *      Arctan (atan or datan)
     5 * Defined unary functions include:
    246 *
    25  *  Currently only vector-vector and image-image binary operations are supported.
     7 *     Addition (+)
     8 *     Subtraction (-)
     9 *     Multiplication (*)
     10 *     Division (/)
     11 *     Power (^)
     12 *     Minimum (min)
     13 *     Maximum (max)
     14 *     Absolute value (abs)
     15 *     Exponent (exp)
     16 *     Natural Log (ln)
     17 *     Power of 10 (ten)
     18 *     Log (log)
     19 *     Sine (sin or dsin)
     20 *     Cosine (cos or dcos)
     21 *     Tangent (tan or dtan)
     22 *     Arcsine (asin or dasin)
     23 *     Arccosine (acos or dacos)
     24 *     Arctan (atan or datan)
    2625 *
    27  *  @ingroup MatrixArithmetic
     26 * Currently only vector-vector and image-image binary operations are supported.
    2827 *
    29  *  @author Ross Harman, MHPCC
    30  *  @author Robert DeSonia, MHPCC
     28 * @author EAM, IfA
     29 * @author Ross Harman, MHPCC
     30 * @author Robert DeSonia, MHPCC
    3131 *
    32  *  @version $Revision: 1.4 $ $Name: not supported by cvs2svn $
    33  *  @date $Date: 2005-07-12 19:12:01 $
    34  *
    35  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
     32 * @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
     33 * @date $Date: 2007-01-23 22:47:23 $
     34 * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    3635 */
    3736
    … …  
    3938#define PSUNARY_OP_H
    4039
    41 /// @addtogroup MatrixArithmetic
     40/// @addtogroup MathOps Mathematical Operations
    4241/// @{
    43 
    4442
    4543/** Perform simple unary arithmetic with images or vectors
    … …  
    6664
    6765/// @}
    68 
    6966#endif // #ifndef PSUNARY_OP_H

  • trunk/psLib/src/math/psVectorSmooth.h

    r7380 r11248  
    1 /** @file  psVectorSmooth.h
     1/* @file psVectorSmooth.h
     2 * @brief smooth the input vector
    23 *
    3  * smooth the input vector
    4  *
     4 * $Revision: 1.2 $ $Name: not supported by cvs2svn $
     5 * $Date: 2007-01-23 22:47:23 $
     6 * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    57 */
    68
    79#ifndef PS_VECTOR_SMOOTH_H
    810#define PS_VECTOR_SMOOTH_H
     11
     12/// @addtogroup MathOps Mathematical Operations
     13/// @{
    914
    1015// Smooth a vector with a Gaussian
    … …  
    1419                         double Nsigma  // Number of standard deviations for Gaussian to extend (either side)
    1520                        );
    16 
     21/// @}
    1722#endif

  • trunk/psLib/src/mathtypes/psImage.h

    r9927 r11248  
    1 /** @file  psImage.h
    2  *
    3  *  @brief Contains basic image definitions and operations
    4  *
    5  *  This file defines the basic type for an image struct and functions useful
    6  *  in manupulating images.
    7  *
    8  *  @ingroup Image
    9  *
    10  *  @author Robert DeSonia, MHPCC
    11  *  @author Ross Harman, MHPCC
    12  *
    13  *  @version $Revision: 1.83 $ $Name: not supported by cvs2svn $
    14  *  @date $Date: 2006-11-09 20:20:27 $
    15  *
    16  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    17  */
     1/* @file  psImage.h
     2 * @brief Basic image definitions and operations
     3 *
     4 * This file defines the basic type for an image struct and functions useful
     5 * in manupulating images.
     6 *
     7 * @author Robert DeSonia, MHPCC
     8 * @author Ross Harman, MHPCC
     9 *
     10 * @version $Revision: 1.84 $ $Name: not supported by cvs2svn $
     11 * @date $Date: 2007-01-23 22:47:23 $
     12 * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
     13 */
     14
    1815#ifndef PS_IMAGE_H
    1916#define PS_IMAGE_H
     17
     18/// @addtogroup MathOps Mathematical Operations
     19/// @{
    2020
    2121#include <complex.h>
    … …  
    2424#include "psArray.h"
    2525#include "psConstants.h"
    26 
    27 /// @addtogroup Image
    28 /// @{
    2926
    3027/** enumeration of options in interpolation
    … …  
    311308
    312309/// @}
    313 
    314310#endif // PS_IMAGE_H

  • trunk/psLib/src/mathtypes/psScalar.h

    r6227 r11248  
    1 
    2 /** @file  psScalar.h
     1/* @file  psScalar.h
     2 * @brief Basic scalar definitions and operations
    33 *
    4  *  @brief Contains basic scalar definitions and operations
     4 * This file defines the basic type for a scalar struct and functions useful
     5 * in manupulating scalars.
    56 *
    6  *  This file defines the basic type for a scalar struct and functions useful
    7  *  in manupulating scalars.
     7 * @author Ross Harman, MHPCC
    88 *
    9  *  @ingroup Scalar
    10  *
    11  *  @author Ross Harman, MHPCC
    12  *
    13  *  @version $Revision: 1.20 $ $Name: not supported by cvs2svn $
    14  *  @date $Date: 2006-01-28 01:12:14 $
    15  *
    16  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
     9 * @version $Revision: 1.21 $ $Name: not supported by cvs2svn $
     10 * @date $Date: 2007-01-23 22:47:23 $
     11 * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    1712 */
    1813
    … …  
    2015#define PS_SCALAR_H
    2116
     17/// @addtogroup MathOps Mathematical Operations
     18/// @{
     19
    2220#include "psType.h"
    23 
    24 /// @addtogroup Scalar
    25 /// @{
    2621
    2722/** Basic scalar data structure.
    … …  
    9388
    9489/// @}
    95 
    9690#endif // #ifndef PS_SCALAR_H

  • trunk/psLib/src/mathtypes/psVector.h

    r10177 r11248  
    1 /** @file  psVector.h
    2  *
    3  *  @brief Contains basic vector definitions and operations
    4  *
    5  *  This file defines the basic type for a vector struct and functions useful
    6  *  in manupulating vectors.
    7  *
    8  *  @ingroup Vector
    9  *
    10  *  @author Robert DeSonia, MHPCC
    11  *  @author Ross Harman, MHPCC
    12  *
    13  *  @version $Revision: 1.60 $ $Name: not supported by cvs2svn $
    14  *  @date $Date: 2006-11-24 20:51:43 $
    15  *
    16  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
     1/* @file  psVector.h
     2 *
     3 * @brief basic vector definitions and operations
     4 *
     5 * This file defines the basic type for a vector struct and functions useful
     6 * in manupulating vectors.
     7 *
     8 * @author Robert DeSonia, MHPCC
     9 * @author Ross Harman, MHPCC
     10 *
     11 * @version $Revision: 1.61 $ $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
    1714 */
    1815
    … …  
    2017#define PS_VECTOR_H
    2118
    22 #include<stdio.h>
    23 
     19/// @addtogroup MathTypes Mathematical Structures
     20/// @{
     21
     22#include <stdio.h>
    2423#include "psType.h"
    25 
    26 /// @addtogroup Vector
    27 /// @{
    2824
    2925/** An vector to support primitive types.
    … …  
    372368
    373369/// @}
    374 
    375370#endif // #ifndef PS_VECTOR_H

  • trunk/psLib/src/sys/psAbort.h

    r8627 r11248  
    1 
    21/** @file  psAbort.h
    32 *
    … …  
    87 *  needing to abort from program execution.
    98 *
    10  *  @ingroup ErrorHandling
    11  *
    129 *  @author Eric Van Alst, MHPCC
    1310 *
    14  *  @version $Revision: 1.12 $ $Name: not supported by cvs2svn $
    15  *  @date $Date: 2006-08-26 04:34:28 $
    16  *
     11 *  $Revision: 1.13 $ $Name: not supported by cvs2svn $
     12 *  $Date: 2007-01-23 22:47:23 $
    1713 *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    1814 */
    … …  
    2117#define PS_ABORT_H
    2218
    23 // Doxygen grouping tags
    24 
    25 /** @addtogroup ErrorHandling
    26  *  @{
    27  */
     19/// @addtogroup SysUtils System Utilities
     20/// @{
    2821
    2922/** Reports an abort message to logging facility
    … …  
    5144#endif // __GNUC__
    5245
    53 /** @} */ // Doxygen - End of SystemGroup Functions
    54 
     46/// @}
    5547#endif // #ifndef PS_ABORT_H

  • trunk/psLib/src/sys/psAssert.h

    r9597 r11248  
    11#ifndef PS_ASSERT_H
    22#define PS_ASSERT_H
     3
     4/// @addtogroup SysUtils System Utilities
     5/// @{
    36
    47#include <assert.h>
    … …  
    263266
    264267
     268/// @}
    265269#endif

  • trunk/psLib/src/sys/psConfigure.h

    r10286 r11248  
    11/** @file  psConfigure.h
    22 *
    3  *  @brief Contains the declarations for initialization, memory finalization,
    4  *   and configuration.
     3 *  @brief Functions to init and cleanup psLib
    54 *
    65 *  These functions initalize psLib data before the beginning of a run and
    … …  
    87 *  also provided to return the current psLib version.
    98 *
    10  *  @ingroup Configure
    119 *
    1210 *  @author Ross Harman, MHPCC
    1311 *  @author Robert DeSonia, MHPCC
    1412 *
    15  *  @version $Revision: 1.9 $ $Name: not supported by cvs2svn $
    16  *  @date $Date: 2006-11-29 21:33:09 $
     13 *  @version $Revision: 1.10 $ $Name: not supported by cvs2svn $
     14 *  @date $Date: 2007-01-23 22:47:23 $
    1715 *
    1816 *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    … …  
    2220#define PS_CONFIGURE_H
    2321
    24 /** @addtogroup Configure
    25  *  @{
    26  */
     22/// @addtogroup SysUtils System Utilities
     23/// @{
    2724
    2825/** Get current psLib version
    … …  
    7067void p_psMemoryCheck(void);
    7168
    72 /** @} */
    73 
     69/// @}
    7470#endif // #ifndef PS_CONFIGURE_H

  • trunk/psLib/src/sys/psError.h

    r8802 r11248  
    11/** @file  psError.h
    22 *
    3  *  @brief Contains the declarations for the error reporting functions
     3 *  @brief error reporting functions
    44 *
    55 *  Error reporting functions shall be used to create log entries in the
    … …  
    88 *  of error detected.
    99 *
    10  *  @ingroup ErrorHandling
    11  *
     10 *  @author RHL, Princeton
    1211 *  @author Eric Van Alst, MHPCC
    1312 *
    14  *  @version $Revision: 1.31 $ $Name: not supported by cvs2svn $
    15  *  @date $Date: 2006-09-12 21:39:47 $
     13 *  @version $Revision: 1.32 $ $Name: not supported by cvs2svn $
     14 *  @date $Date: 2007-01-23 22:47:23 $
    1615 *
    1716 *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    … …  
    2019#ifndef PS_ERROR_H
    2120#define PS_ERROR_H
     21
     22/// @addtogroup SysUtils System Utilities
     23/// @{
    2224
    2325#include<stdio.h>
    … …  
    2830
    2931#define _(string) string
    30 
    31 /** @addtogroup ErrorHandling
    32  *  @{
    33  */
    3432
    3533/** Error message object */
    … …  
    231229);
    232230
    233 /* @} */// End of SysUtils Functions
    234 
     231/// @}
    235232#endif

  • trunk/psLib/src/sys/psErrorCodes.h.in

    r7957 r11248  
    33 *  @brief Contains the error codes for the error classes
    44 *
    5  *  @ingroup ErrorHandling
    6  *
     5 *  @author RHL, Princeton
    76 *  @author Robert DeSonia, MHPCC
    87 *
    9  *  @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
    10  *  @date $Date: 2006-07-25 00:30:31 $
     8 *  @version $Revision: 1.4 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2007-01-23 22:47:23 $
    1110 *
    1211 *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    … …  
    1615#define PS_ERROR_CODES_H
    1716
     17/// @addtogroup SysUtils System Utilities
     18/// @{
     19
    1820#include "psType.h"
    19 
    20 /** @addtogroup ErrorHandling
    21  *  @{
    22  */
    2321
    2422/** enumeration of the static error code classes
    … …  
    8482
    8583/// @}
    86 
    8784#endif // #ifndef PS_ERROR_CODES_H

  • trunk/psLib/src/sys/psExit.h

    r10979 r11248  
    11#ifndef PS_EXIT_H
    22#define PS_EXIT_H
     3
     4/// @addtogroup SysUtils System Utilities
     5/// @{
    36
    47/// Exit status codes
    … …  
    1518} psExit;
    1619
     20/// @}
    1721#endif

  • trunk/psLib/src/sys/psLine.h

    r7950 r11248  
    11/** @file  psLine.h
    22 *
    3  *
    4  *  @brief Contains the declarations of line utility functions
    5  *
    6  *  @ingroup SysUtils
     3 *  @brief charater-string fixed-length line functions
    74 *
    85 *  The psLine functions allow manipulation of fixed-length lines.
    96 *
     7 *  @author EAM, IFA
    108 *  @author Paul Price, IFA
    119 *  @author David Robbins, MHPCC
    1210 *
    13  *  @version $Revision: 1.4 $ $Name: not supported by cvs2svn $
    14  *  @date $Date: 2006-07-21 02:39:33 $
     11 *  @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
     12 *  @date $Date: 2007-01-23 22:47:23 $
    1513 *
    1614 *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    … …  
    2018#define PS_LINE_H
    2119
     20/// @addtogroup SysUtils System Utilities
     21/// @{
     22
    2223#include "psString.h"
    23 
    24 /** @addtogroup SysUtils
    25  *  @{
    26  */
    2724
    2825/** Structure to carry a dynamic string */
    … …  
    7774);
    7875
     76/// @}
    7977#endif /* PS_LINE_H */

  • trunk/psLib/src/sys/psLogMsg.h

    r10429 r11248  
    11/** @file  psLogMsg.h
     2 *
    23 *  @brief Procedures for logging messages.
    3  *  \ingroup LogTrace
    44 *
    55 *  This file will hold the prototypes for defining procedure which set
    66 *  message log levels, messahe log formats, message log destinations, and
    77 *  for generating the messages themselves.
    8  *  @ingroup LogTrace
    98 *
    109 *  @author Robert Lupton, Princeton University
    1110 *  @author GLG, MHPCC
    1211 *
    13  *  @version $Revision: 1.37 $ $Name: not supported by cvs2svn $
    14  *  @date $Date: 2006-12-04 20:45:46 $
     12 *  @version $Revision: 1.38 $ $Name: not supported by cvs2svn $
     13 *  @date $Date: 2007-01-23 22:47:23 $
    1514 *
    1615 *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    1716 */
     17
    1818#ifndef PS_LOG_MSG_H
    1919#define PS_LOG_MSG_H
     20
     21/// @addtogroup SysUtils System Utilities
     22/// @{
     23
    2024#include <stdarg.h>
    21 
    2225#include "psType.h"
    23 
    24 /** @addtogroup LogTrace
    25  *  @{
    26  */
    2726
    2827/** This procedure sets the destination for future log messages.
    … …  
    137136
    138137/// @}
    139 
    140138#endif // #ifndef PS_LOG_MSG_H

  • trunk/psLib/src/sys/psMemory.h

    r9538 r11248  
    1 /** @file  psMemory.h
    2  *
    3  *  @brief Contains the definitions for the memory management system
    4  *
    5  *  This is the generic memory management system put inbetween the user's high level code and the OS-level
    6  *  memory allocation routines.  This system adds such features as callback routines for memory error events,
    7  *  tracing capabilities, and reference counting.
    8  *
    9  *  @author Robert DeSonia, MHPCC
    10  *  @author Robert Lupton, Princeton University
    11  *
    12  *  @ingroup MemoryManagement
    13  *
    14  *  @version $Revision: 1.61 $ $Name: not supported by cvs2svn $
    15  *  @date $Date: 2006-10-13 21:13:48 $
    16  *
    17  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
     1/* @file  psMemory.h
     2 *
     3 * @brief Contains the definitions for the memory management system
     4 *
     5 * This is the generic memory management system put inbetween the user's high level code and the OS-level
     6 * memory allocation routines.  This system adds such features as callback routines for memory error events,
     7 * tracing capabilities, and reference counting.
     8 *
     9 * @author Robert Lupton, Princeton University
     10 * @author Robert DeSonia, MHPCC
     11 *
     12 * $Revision: 1.62 $ $Name: not supported by cvs2svn $
     13 * $Date: 2007-01-23 22:47:23 $
     14 * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    1815 */
    1916
    … …  
    2118#define PS_MEMORY_H
    2219
     20/// @addtogroup SysUtils System Utilities
     21/// @{
     22
    2323#include <stdio.h>                     // needed for FILE
    2424#include <pthread.h>                   // we need a mutex to make this stuff thread safe.
    25 
    2625#include "psType.h"
    2726
    28 /** @addtogroup MemoryManagement
    29  *  @{
    30  */
    31 
    3227#define P_PS_MEMMAGIC (psPtr)0xdeadbeef   // Magic number in psMemBlock header
    33 
    34 /**
    35  *  @addtogroup memCallback Memory Callbacks
    36  *
    37  *  Routines dealing with the creating and setting of memory management callback functions.
    38  */
    39 
    40 /**
    41  *  @addtogroup memTracing Memory Tracing
    42  *
    43  *  Routines dealing with memory tracing and corruption checking.
    44  */
    45 
    46 /**
    47  *  @addtogroup memRefCount Reference Count
    48  *
    49  *  Routines dealing with the reference counting of allocated buffers.
    50  */
    5128
    5229/// typedef for memory identification numbers.  Guaranteed to be some variety of integer.
    … …  
    8461 *
    8562 *  @see psMemAllocCallbackSet
    86  *  @ingroup memCallback
    8763 */
    8864typedef psMemId(*psMemAllocCallback) (
    … …  
    9369 *
    9470 *  @see psMemFreeCallbackSet
    95  *  @ingroup memCallback
    9671 */
    9772typedef psMemId(*psMemFreeCallback) (
    … …  
    10479 *
    10580 *  @see psMemProblemCallbackSet
    106  *  @ingroup memCallback
    10781 */
    10882typedef void (*psMemProblemCallback) (
    … …  
    11892 *
    11993 *  @see psMemExhaustedCallbackSet
    120  *  @ingroup memCallback
    12194 */
    12295typedef psPtr (*psMemExhaustedCallback) (
    … …  
    303276 *              blocks above id0 that have not been freed.
    304277 *  @see psAlloc, psFree, psgetMemId, psMemProblemCallbackSet
    305  *  @ingroup memTracing
    306278 */
    307279int psMemCheckLeaks(
    … …  
    317289 *  @return int
    318290 *
    319  *  @ingroup memTracing
    320291 */
    321292int psMemCheckCorruption(
    … …  
    327298 *  @return psReferenceCount
    328299 *
    329  *  @ingroup memRefCount
    330300 */
    331301psReferenceCount psMemGetRefCounter(
    … …  
    337307 *  @return psPtr
    338308 *
    339  *  @ingroup memRefCount
    340309 */
    341310#ifdef DOXYGEN
    … …  
    358327/** Decrement reference counter and return the pointer
    359328 *
    360  *  @ingroup memRefCount
    361329 *
    362330 *  @return psPtr    the pointer deremented in refCount, or NULL if pointer is
    … …  
    381349
    382350/** Set reference counter and return the pointer
    383  *
    384  *  @ingroup memRefCount
    385351 *
    386352 *  @return psPtr    the pointer with refCount set, or NULL if pointer is
    … …  
    411377 *  stack. If any of these checks discover that the memory stack is corrupted,
    412378 *  the psMemProblemCallback is called.
    413  
    414  *  @ingroup memCallback
    415379 *
    416380 *  @return psMemProblemCallback       old psMemProblemCallback function
    … …  
    431395 *  request and try again, limiting the size of the operating buffer.
    432396 *
    433  *  @ingroup memCallback
    434  *
    435397 *  @return psMemExhaustedCallback     old psMemExhaustedCallback function
    436398 */
    … …  
    446408 *  just before memory is returned to the calling function.
    447409 *
    448  *  @ingroup memCallback
    449  *
    450410 *  @return psMemAllocCallback      old psMemAllocCallback function
    451411 */
    … …  
    461421 *  before the memory block is freed.
    462422 *
    463  *  @ingroup memCallback
    464  *
    465423 *  @return psMemFreeCallback          old psMemFreeCallback function
    466424 */
    … …  
    471429/** get next memory ID
    472430 *
    473  *  @ingroup memCallback
    474  *
    475431 *  @return psMemId                 the next memory ID to be used
    476432 */
    … …  
    478434
    479435/** get the last memory ID used
    480  *
    481  *  @ingroup memCallback
    482436 *
    483437 *  @return psMemId                 the last memory ID used
    … …  
    492446 *  just before memory is returned to the calling function.
    493447 *
    494  *  @ingroup memCallback
    495  *
    496448 *  @return psMemId
    497449 *
    … …  
    509461 *  before the memory block is freed.
    510462 *
    511  *  @ingroup memCallback
    512  *
    513463 *  @return psMemId                 the old p_psMemFreeID
    514464 *
    … …  
    530480                  size_t *freelist); ///< memory that's waiting to be recycled
    531481
    532 //@} End of Memory Management Functions
     482/// @} end of SysUtils
    533483
    534484#ifndef DOXYGEN
    … …  
    549499
    550500#endif // #ifndef DOXYGEN
    551 
    552501#endif // #ifndef PS_MEMORY_H

  • trunk/psLib/src/sys/psSlurp.h

    r11154 r11248  
     1/* @file  psSlurp.h
     2 * @brief read complete files into strings
     3 *
     4 * @author JH
     5 * @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
     6 * @date $Date: 2007-01-23 22:47:23 $
     7 */
     8
    19#ifndef PS_SLURP_H
    210#define PS_SLURP_H
     11
     12/// @addtogroup FileIO Input/Output
     13/// @{
    314
    415// Read ("slurp") a file (specified by file descriptor)
    … …  
    1223                    );
    1324
    14 
     25/// @}
    1526#endif

  • trunk/psLib/src/sys/psString.h

    r10949 r11248  
    1 /** @file  psString.h
    2  *
    3  * -*- mode: C; c-basic-indent: 4; tab-width: 8; indent-tabs-mode: nil -*-
    4  * vim: set cindent ts=8 sw=4 expandtab:
    5  *
    6  *  @brief Contains the declarations of string utility functions
    7  *
    8  *  @ingroup SysUtils
    9  *
    10  *  String utility functions defined shall provide basic string copying
    11  *  capabilities.
    12  *
    13  *  @author Eric Van Alst, MHPCC
    14  *  @author David Robbins, MHPCC
    15  *
    16  *  @version $Revision: 1.34 $ $Name: not supported by cvs2svn $
    17  *  @date $Date: 2007-01-06 04:13:51 $
    18  *
    19  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
     1/* @file  psString.h
     2 *
     3 * @brief string utility functions
     4 *
     5 * String utility functions defined shall provide basic string copying
     6 * capabilities.
     7 *
     8 * @author EAM, IfA
     9 * @author Eric Van Alst, MHPCC
     10 * @author David Robbins, MHPCC
     11 *
     12 * @version $Revision: 1.35 $ $Name: not supported by cvs2svn $
     13 * @date $Date: 2007-01-23 22:47:23 $
     14 *
     15 * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    2016 */
    2117
    2218#ifndef PS_STRING_H
    2319#define PS_STRING_H
     20
     21/// @addtogroup SysUtils System Utilities
     22/// @{
    2423
    2524#include <sys/types.h>
    … …  
    3534const char *p_psFileLine(const char *file, int line);
    3635#define PS_FILE_LINE p_psFileLine(__FILE__,__LINE__)
    37 
    38 // Doxygen group tags
    39 
    40 /** @addtogroup SysUtils
    41  *  @{
    42  */
    4336
    4437/** Allocates a new psString.
    … …  
    230223#endif // ifndef DOXYGEN
    231224
    232 /** @} */// Doxygen - End of SystemGroup Functions
    233 
     225/// @}
    234226#endif // #ifndef PS_STRING_H

  • trunk/psLib/src/sys/psTrace.h

    r9546 r11248  
    11/** @file psTrace.h
    2  *  \brief basic run-time trace facilities
    3  *  \ingroup LogTrace
     2 *
     3 *  @brief basic run-time trace facilities
    44 *
    55 *  This file will hold the prototypes for defining procedures to insert
    … …  
    99 *  @author GLG, MHPCC
    1010 *
    11  *  @version $Revision: 1.52 $ $Name: not supported by cvs2svn $
    12  *  @date $Date: 2006-10-13 22:29:23 $
     11 *  @version $Revision: 1.53 $ $Name: not supported by cvs2svn $
     12 *  @date $Date: 2007-01-23 22:47:23 $
    1313 *
    1414 *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    1515 */
    16 #if !defined(PS_TRACE_H)
     16
     17#ifndef PS_TRACE_H
    1718#define PS_TRACE_H 1
     19
     20/// @addtogroup SysUtils System Utilities
     21/// @{
     22
    1823#include <stdarg.h>
    1924
    … …  
    2126#define PS_DEFAULT_TRACE_LEVEL -1
    2227#define PS_THE_OTHER_DEFAULT_TRACE_LEVEL 0
    23 
    24 /** \addtogroup LogTrace
    25  *  \{
    26  */
    2728
    2829enum {
    … …  
    171172int psTraceGetDestination(void);
    172173
    173 /* \} */// End of SystemGroup Functions
    174 
     174/// @}
    175175#endif /* PS_NO_TRACE */
    176 
    177176#endif /* PS_TRACE_H */
    178 

  • trunk/psLib/src/sys/psType.h

    r9552 r11248  
    1 /** @file  psType.h
    2 *
    3 *  @brief Contains support for basic types
    4 *
    5 *  This file defines common datatypes used throughout psLib.
    6 *
    7 *  @ingroup DataContainer
    8 *
    9 *  @author Robert DeSonia, MHPCC
    10 *  @author Ross Harman, MHPCC
    11 *
    12 *  @version $Revision: 1.52 $ $Name: not supported by cvs2svn $
    13 *  @date $Date: 2006-10-14 00:02:31 $
    14 *
    15 *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    16 */
     1/* @file  psType.h
     2 *
     3 * @brief Contains support for basic types
     4 *
     5 * This file defines common datatypes used throughout psLib.
     6 *
     7 * @author Robert DeSonia, MHPCC
     8 * @author Ross Harman, MHPCC
     9 *
     10 * @version $Revision: 1.53 $ $Name: not supported by cvs2svn $
     11 * @date $Date: 2007-01-23 22:47:23 $
     12 *
     13 * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
     14 */
    1715
    1816#ifndef PS_TYPE_H
    1917#define PS_TYPE_H
     18
     19/// @addtogroup DataContainer Data Containers
     20/// @{
    2021
    2122#include <complex.h>
    … …  
    2324#include <float.h>
    2425#include <stdbool.h>
    25 
    26 /// @addtogroup DataContainer
    27 /// @{
    2826
    2927/******************************************************************************/
    … …  
    301299
    302300/// @}
    303 
    304301#endif // #ifndef PS_TYPE_H

  • trunk/psLib/src/types/psArguments.h

    r9538 r11248  
    33 *  @brief Contains operations for parsing command line input arguments.
    44 *
    5  *  @ingroup Arguments
    6  *
    75 *  @author David Robbins, MHPCC
    86 *
    9  *  @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
    10  *  @date $Date: 2006-10-13 21:13:48 $
     7 *  @version $Revision: 1.4 $ $Name: not supported by cvs2svn $
     8 *  @date $Date: 2007-01-23 22:47:23 $
    119 *
    1210 *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    … …  
    1614#define PS_ARGUMENTS_H
    1715
    18 /// @addtogroup Arguments
     16/// @addtogroup SysUtils
    1917/// @{
    2018
    … …  
    5755 *
    5856 *  The input arguments shall contain the list of possible arguments as the keywords providing
    59  *  the default values.  As matching arguments are found on the command line, the values shall be
    60  *  read into the arguments metadata, with the appropriate type.  The arguments and their values
    61  *  shall be removed from the list of command line arguments as they are processed.
     57 *  the default values.  As matching arguments are found on the command line, the values shall
     58 *  be read into the arguments metadata, with the appropriate type.  The arguments and their
     59 *  values shall be removed from the list of command line arguments as they are processed.
    6260 *
    6361 *  @return bool:       False if any argument was encountered that is not present in arguments.
    … …  
    7472);
    7573
    76 
    7774/// @}
    78 
    7975#endif // #ifndef PS_ARGUMENTS_H

  • trunk/psLib/src/types/psArray.h

    r11074 r11248  
    66 *  in manupulating arrays.
    77 *
    8  *  @ingroup Array
    9  *
    108 *  @author Robert DeSonia, MHPCC
    119 *  @author Ross Harman, MHPCC
    1210 *
    13  *  @version $Revision: 1.44 $ $Name: not supported by cvs2svn $
    14  *  @date $Date: 2007-01-12 21:58:09 $
     11 *  @version $Revision: 1.45 $ $Name: not supported by cvs2svn $
     12 *  @date $Date: 2007-01-23 22:47:23 $
    1513 *
    1614 *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    … …  
    2321#include "psCompare.h"
    2422
    25 /// @addtogroup Array
     23/// @addtogroup DataContainer Data Containers
    2624/// @{
    2725
    … …  
    231229
    232230/// @}
    233 
    234231#endif // #ifndef PS_ARRAY_H

  • trunk/psLib/src/types/psBitSet.h

    r9082 r11248  
    88 *  string.
    99 *
    10  *  @ingroup BitSet
    11  *
     10 *  @author PAP, EAM, IfA
    1211 *  @author Ross Harman, MHPCC
    1312 *
    14  *  @version $Revision: 1.27 $ $Name: not supported by cvs2svn $
    15  *  @date $Date: 2006-10-01 00:40:35 $
     13 *  @version $Revision: 1.28 $ $Name: not supported by cvs2svn $
     14 *  @date $Date: 2007-01-23 22:47:23 $
    1615 *
    1716 *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    … …  
    2322#include "psType.h"
    2423
    25 /// @addtogroup BitSet
     24/// @addtogroup DataContainer Data Containers
    2625/// @{
    2726
    … …  
    151150
    152151/// @}
    153 
    154152#endif // #ifndef PSBITSET_H

  • trunk/psLib/src/types/psHash.h

    r9083 r11248  
    11/** @file  psHash.h
     2 *
    23 *  @brief Contains support for basic hashing functions.
    3  *  @ingroup HashTable
    44 *
    55 *  This file will hold the prototypes for defining a hash table with arbitrary
    … …  
    1111 *  @author GLG, MHPCC
    1212 *
    13  *  @version $Revision: 1.19 $ $Name: not supported by cvs2svn $
    14  *  @date $Date: 2006-10-01 00:45:34 $
     13 *  @version $Revision: 1.20 $ $Name: not supported by cvs2svn $
     14 *  @date $Date: 2007-01-23 22:47:23 $
    1515 *
    1616 *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    … …  
    2020#define PS_HASH_H
    2121
    22 /** \addtogroup HashTable
    23  *  \{
    24  */
     22/// @addtogroup DataContainer Data Containers
     23/// @{
    2524
    2625#include "psList.h"
    … …  
    9493);
    9594
    96 /* \} */// End of DataGroup Functions
    97 
     95/// @} End of DataContainer Functions
    9896#endif // #ifndef PS_HASH_H

  • trunk/psLib/src/types/psList.h

    r9086 r11248  
    55 *  @author Robert Daniel DeSonia, MHPCC
    66 *
    7  *  @ingroup LinkedList
    8  *
    9  *  @version $Revision: 1.38 $ $Name: not supported by cvs2svn $
    10  *  @date $Date: 2006-10-02 06:05:53 $
     7 *  @version $Revision: 1.39 $ $Name: not supported by cvs2svn $
     8 *  @date $Date: 2007-01-23 22:47:23 $
    119 *
    1210 *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    … …  
    1917#include "psArray.h"
    2018
    21 /** @addtogroup LinkedList
    22  *  @{
    23  */
     19/// @addtogroup DataContainer Data Containers
     20///  @{
    2421
    2522/** Special values of index into list
    … …  
    238235);
    239236
    240 
    241 /// @} End of DataGroup Functions
    242 
     237/// @} End of DataContainer Functions
    243238#endif // #ifndef PS_LIST_H
    244 

  • trunk/psLib/src/types/psLookupTable.h

    r9715 r11248  
    33*  @brief This file defines the structure and functions for table lookups.
    44*
    5 *  @ingroup types
    6 *
     5*  @author PAP, IfA
    76*  @author Ross Harman, MHPCC
    87*
    9 *  @version $Revision: 1.16 $ $Name: not supported by cvs2svn $
    10 *  @date $Date: 2006-10-22 00:51:05 $
     8*  @version $Revision: 1.17 $ $Name: not supported by cvs2svn $
     9*  @date $Date: 2007-01-23 22:47:23 $
    1110*
    1211*  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    … …  
    1514#ifndef PS_LOOKUPTABLE_H
    1615#define PS_LOOKUPTABLE_H
     16
     17/// @addtogroup DataContainer Data Containers
     18/// @{
    1719
    1820#include "psType.h"
    … …  
    143145);
    144146
     147/// @}
    145148#endif // #ifndef PS_LOOKUPTABLE_H

  • trunk/psLib/src/types/psMetadata.h

    r10290 r11248  
    66*  prototypes necessary creating psLib metadata APIs
    77*
    8 *  @ingroup Metadata
    9 *
    108*  @author Robert DeSonia, MHPCC
    119*  @author Ross Harman, MHPCC
    1210*
    13 *  @version $Revision: 1.93 $ $Name: not supported by cvs2svn $
    14 *  @date $Date: 2006-11-29 22:41:02 $
     11*  @version $Revision: 1.94 $ $Name: not supported by cvs2svn $
     12*  @date $Date: 2007-01-23 22:47:23 $
    1513*
    1614*  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    … …  
    1917#define PS_METADATA_H
    2018
     19/// @addtogroup DataContainer Data Containers
     20/// @{
     21
    2122#include <stdarg.h>
    2223#include <stdio.h>
    … …  
    2829#include "psTime.h"
    2930#include "psLookupTable.h"
    30 
    31 /// @addtogroup Metadata
    32 /// @{
    3331
    3432#define PS_DATA_IS_PRIMITIVE(TYPE) \
    … …  
    11991197}
    12001198
    1201 
    12021199/// @}
    1203 
    12041200#endif // #ifndef PS_METADATA_H

  • trunk/psLib/src/types/psMetadataConfig.h

    r9730 r11248  
    55 *  This file defines functions to read and write metadata to/from an external file.
    66 *
    7  *  @ingroup Metadata
    8  *
     7 *  @author EAM, IfA
     8 *  @author PAP, IfA
     9 *  @author JH, IfA
    910 *  @author Ross Harman, MHPCC
    1011 *  @author Robert DeSonia, MHPCC
    1112 *
    12  *  @version $Revision: 1.25 $ $Name: not supported by cvs2svn $
    13  *  @date $Date: 2006-10-24 22:52:56 $
     13 *  @version $Revision: 1.26 $ $Name: not supported by cvs2svn $
     14 *  @date $Date: 2007-01-23 22:47:23 $
    1415 *
    1516 *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    … …  
    2021#include "psMetadata.h"
    2122
    22 /// @addtogroup Metadata
     23/// @addtogroup DataContainer Data Containers
    2324/// @{
    2425
    … …  
    9899
    99100/// @}
    100 
    101101#endif // #ifndef PS_METADATAIO_H

  • trunk/psLib/src/types/psMetadataItemCompare.h

    r8224 r11248  
    55 *  This file defines functions to compare psMetadataItem's.
    66 *
    7  *  @ingroup Metadata
    8  *
    97 *  @author IFA
    108 *
    11  *  @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
    12  *  @date $Date: 2006-08-08 01:27:45 $
     9 *  @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
     10 *  @date $Date: 2007-01-23 22:47:23 $
    1311 *
    1412 *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    … …  
    2018#include "psMetadata.h"
    2119
    22 /// @addtogroup Metadata
     20/// @addtogroup DataContainer Data Containers
    2321/// @{
    2422
    … …  
    3331;
    3432
    35 
    3633/// @}
    37 
    3834#endif

  • trunk/psLib/src/types/psMetadataItemParse.h

    r7380 r11248  
     1/** @file  psMetadataItemParse.h
     2*
     3*  @brief Parse metadata items
     4*
     5*  @author EAM, PAP, JH, RHL,
     6*
     7*  @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
     8*  @date $Date: 2007-01-23 22:47:23 $
     9*
     10*  Copyright 2004-2005 IfA, University of Hawaii
     11*/
     12
    113#ifndef PS_METADATA_ITEM_PARSE_H
    214#define PS_METADATA_ITEM_PARSE_H
     15
     16/// @addtogroup DataContainer Data Containers
     17/// @{
    318
    419#include "psType.h"
    … …  
    1732psString psMetadataItemParseString(const psMetadataItem *item);
    1833
     34/// @}
    1935#endif

  • trunk/psLib/src/types/psPixels.h

    r8973 r11248  
    33 *  @brief Contains psPixel related functions
    44 *
    5  *  @ingroup Image
    6  *
     5 *  @author Paul Price, IfA
    76 *  @author Robert DeSonia, MHPCC
    87 *
    9  *  @version $Revision: 1.23 $ $Name: not supported by cvs2svn $
    10  *  @date $Date: 2006-09-26 02:55:34 $
     8 *  @version $Revision: 1.24 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2007-01-23 22:47:23 $
    1110 *
    1211 *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    1312 */
     13
    1414#ifndef PS_PIXELS_H
    1515#define PS_PIXELS_H
    … …  
    1919#include "psRegion.h"
    2020
    21 /// @addtogroup Image
     21/// @addtogroup DataContainer Data Containers
    2222/// @{
    2323
    … …  
    197197);
    198198
     199/// @}
    199200#endif // #ifndef PS_PIXELS_H

  • trunk/psLib/src/xml/psXML.h

    r8232 r11248  
    1 /** @file  psXML.h
     1/* @file  psXML.h
     2 * @brief Contains basic XML definitions and operations
    23 *
    3  *  @brief Contains basic XML definitions and operations
     4 * This file defines the basic type for an XML struct and functions useful
     5 * in creation and usage of XML documents/files.
    46 *
    5  *  This file defines the basic type for an XML struct and functions useful
    6  *  in creation and usage of XML documents/files.
     7 * @author David Robbins, MHPCC
    78 *
    8  *  @ingroup XML
    9  *
    10  *  @author David Robbins, MHPCC
    11  *
    12  *  @version $Revision: 1.20 $ $Name: not supported by cvs2svn $
    13  *  @date $Date: 2006-08-08 23:32:23 $
    14  *
    15  *  Copyright 2005 Maui High Performance Computing Center, University of Hawaii
     9 * @version $Revision: 1.21 $ $Name: not supported by cvs2svn $
     10 * @date $Date: 2007-01-23 22:47:23 $
     11 * Copyright 2005 Maui High Performance Computing Center, University of Hawaii
    1612 */
    1713
    1814#ifndef PS_XML_H
    1915#define PS_XML_H
     16
     17/// @addtogroup FileIO Input/Output
     18/// @{
    2019
    2120#include <libxml/parser.h>
    … …  
    3231#include "psConstants.h"
    3332#include "psTime.h"
    34 
    35 
    36 
    37 /// @addtogroup XML
    38 /// @{
    3933
    4034/** XML wrapper pointing to an XML document in memory */
    … …  
    124118
    125119/// @}
    126 
    127120#endif // #ifndef PS_XML_H
    128 
Note: See TracChangeset for help on using the changeset viewer.