IPP Software Navigation Tools IPP Links Communication Pan-STARRS Links

Ignore:
Timestamp:
Jan 23, 2007, 4:54:15 PM (19 years ago)
Author:
magnier
Message:

cleaned up Doxygen groups

Location:
trunk/psModules/src/objects
Files:
16 edited

Legend:

Unmodified
Added
Removed

  • trunk/psModules/src/objects/pmGrowthCurve.h

    r9897 r11253  
     1/* @file  pmGrowthCurve.h
     2 * @brief functions to manipulate the curve-of-growth data
     3 *
     4 * @author EAM, IfA
     5 *
     6 * @version $Revision: 1.7 $ $Name: not supported by cvs2svn $
     7 * @date $Date: 2007-01-24 02:54:15 $
     8 * Copyright 2006 Institute for Astronomy, University of Hawaii
     9 */
    110
    211# ifndef PM_GROWTH_CURVE_H
    312# define PM_GROWTH_CURVE_H
     13
     14/// @addtogroup Objects Object Detection / Analysis Functions
     15/// @{
    416
    517typedef struct
    … …  
    1830psF32 pmGrowthCurveCorrect (pmGrowthCurve *growth, psF32 radius);
    1931
     32/// @}
    2033# endif /* PM_GROWTH_CURVE_H */

  • trunk/psModules/src/objects/pmModel.h

    r9810 r11253  
    1 /** @file  pmObjects.h
     1/* @file  pmObjects.h
     2 * @brief Functions to define and manipulate object models
    23 *
    3  *  Functions to define and manipulate object models
     4 * @author GLG, MHPCC
     5 * @author EAM, IfA
    46 *
    5  *  @author GLG, MHPCC
    6  *  @author EAM, IfA
    7  *
    8  *  @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
    9  *  @date $Date: 2006-10-31 19:38:44 $
    10  *
    11  *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    12  *
     7 * @version $Revision: 1.6 $ $Name: not supported by cvs2svn $
     8 * @date $Date: 2007-01-24 02:54:15 $
     9 * Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    1310 */
    1411
    1512# ifndef PM_MODEL_H
    1613# define PM_MODEL_H
     14
     15/// @addtogroup Objects Object Detection / Analysis Functions
     16/// @{
    1717
    1818// type of model carried by the pmModel structure
    … …  
    125125);
    126126
     127/// @}
    127128# endif /* PM_MODEL_H */

  • trunk/psModules/src/objects/pmModelGroup.h

    r10257 r11253  
    1 /** @file  pmModelGroup.h
    2  *
    3  *  The object model function types are defined to allow for the flexible addition
    4  *  of new object models. Every object model, with parameters represented by
    5  *  pmModel, has an associated set of functions which provide necessary support
    6  *  operations. A set of abstract functions allow the programmer to select the
    7  *  approriate function or property for a specific named object model.
    8  *
    9  *  @author EAM, IfA
    10  *
    11  *  @version $Revision: 1.6 $ $Name: not supported by cvs2svn $
    12  *  @date $Date: 2006-11-29 02:36:07 $
    13  *
    14  *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    15  *
     1/* @file  pmModelGroup.h
     2 *
     3 * The object model function types are defined to allow for the flexible addition
     4 * of new object models. Every object model, with parameters represented by
     5 * pmModel, has an associated set of functions which provide necessary support
     6 * operations. A set of abstract functions allow the programmer to select the
     7 * approriate function or property for a specific named object model.
     8 *
     9 * @author EAM, IfA
     10 *
     11 * @version $Revision: 1.7 $ $Name: not supported by cvs2svn $
     12 * @date $Date: 2007-01-24 02:54:15 $
     13 * Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    1614 */
    1715
    1816# ifndef PM_MODEL_GROUP_H
    1917# define PM_MODEL_GROUP_H
     18
     19/// @addtogroup Objects Object Detection / Analysis Functions
     20/// @{
    2021
    2122//  This function is the model chi-square minimization function for this model.
    … …  
    200201);
    201202
     203/// @}
    202204# endif /* PM_MODEL_GROUP_H */

  • trunk/psModules/src/objects/pmMoments.h

    r6872 r11253  
    1 /** @file  pmMoments.h
     1/* @file  pmMoments.h
     2 * @brief Definitions of the moments structure
    23 *
    3  *  Definitions of the moments structure
     4 * @author GLG, MHPCC
    45 *
    5  *  @author GLG, MHPCC
    6  *
    7  *  @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
    8  *  @date $Date: 2006-04-17 18:01:05 $
    9  *
    10  *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    11  *
     6 * @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
     7 * @date $Date: 2007-01-24 02:54:15 $
     8 * Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    129 */
    1310
    1411# ifndef PM_MOMENTS_H
    1512# define PM_MOMENTS_H
     13
     14/// @addtogroup Objects Object Detection / Analysis Functions
     15/// @{
    1616
    1717/** pmMoments data structure
    … …  
    4343pmMoments *pmMomentsAlloc();
    4444
     45/// @}
    4546# endif

  • trunk/psModules/src/objects/pmObjects.h

    r9621 r11253  
    1 /** @file  pmObjects.h
     1/* @file  pmObjects.h
    22 *
    33 * The process of finding, measuring, and classifying astronomical sources on
    … …  
    88 * construct a complete object measurement suite.
    99 *
    10  *  @author GLG, MHPCC
     10 * @author GLG, MHPCC
    1111 *
    12  *  @version $Revision: 1.7 $ $Name: not supported by cvs2svn $
    13  *  @date $Date: 2006-10-18 02:29:15 $
    14  *
    15  *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    16  *
     12 * @version $Revision: 1.8 $ $Name: not supported by cvs2svn $
     13 * @date $Date: 2007-01-24 02:54:15 $
     14 * Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    1715 */
    1816
    1917#ifndef PM_OBJECTS_H
    2018#define PM_OBJECTS_H
     19
     20/// @addtogroup Objects Object Detection / Analysis Functions
     21/// @{
    2122
    2223#include <stdio.h>
    … …  
    6465);
    6566
    66 
     67/// @}
    6768#endif

  • trunk/psModules/src/objects/pmPSF.h

    r9924 r11253  
    1 /** @file  pmPSF.h
     1/* @file  pmPSF.h
    22 *
    33 * This file contains typedefs for the Point-Spread Function and prototypes
    44 * for functions that calculate the PSF.
    55 *
    6  *  @author EAM, IfA
     6 * @author EAM, IfA
    77 *
    8  *
    9  *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    10  *
     8 * @version $Revision: 1.11 $ $Name: not supported by cvs2svn $
     9 * @date $Date: 2007-01-24 02:54:15 $
     10 * Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    1111 */
    1212
    1313# ifndef PM_PSF_H
    1414# define PM_PSF_H
     15
     16/// @addtogroup Objects Object Detection / Analysis Functions
     17/// @{
    1518
    1619typedef enum {
    … …  
    9699pmPSF *pmPSFBuildSimple (char *typeName, float sxx, float syy, float sxy, ...);
    97100
     101/// @}
    98102# endif

  • trunk/psModules/src/objects/pmPSF_IO.h

    r10421 r11253  
    1 /** @file  pmPSF.h
     1/* @file  pmPSF.h
    22 *
    33 * This file contains typedefs for the Point-Spread Function and prototypes
    44 * for functions that calculate the PSF.
    55 *
    6  *  @author EAM, IfA
     6 * @author EAM, IfA
    77 *
    8  *  @version $Revision: 1.4 $ $Name: not supported by cvs2svn $
    9  *  @date $Date: 2006-12-03 18:48:10 $
    10  *
    11  *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    12  *
     8 * @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
     9 * @date $Date: 2007-01-24 02:54:15 $
     10 * Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    1311 */
    1412
    1513# ifndef PM_PSF_IO_H
    1614# define PM_PSF_IO_H
     15
     16/// @addtogroup Objects Object Detection / Analysis Functions
     17/// @{
    1718
    1819psMetadata *pmPSFtoMetadata (psMetadata *metadata, pmPSF *psf);
    … …  
    3031bool pmReadoutReadPSFmodel (pmReadout *readout, const pmFPAview *view, pmFPAfile *file, pmConfig *config);
    3132
     33/// @}
    3234# endif

  • trunk/psModules/src/objects/pmPSFtry.h

    r10197 r11253  
    1 /** @file  pmPSFtry.h
     1/* @file  pmPSFtry.h
    22 *
    33 * This file contains code that allows the user to try to fit several
    44 * PSF models to an image.
    55 *
    6  *  @author EAM, IfA
     6 * @author EAM, IfA
    77 *
    8  *  @version $Revision: 1.10 $ $Name: not supported by cvs2svn $
    9  *  @date $Date: 2006-11-26 22:21:50 $
    10  *
    11  *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    12  *
     8 * @version $Revision: 1.11 $ $Name: not supported by cvs2svn $
     9 * @date $Date: 2007-01-24 02:54:15 $
     10 * Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    1311 */
    1412
    … …  
    1614# define PM_PSF_TRY_H
    1715
     16/// @addtogroup Objects Object Detection / Analysis Functions
     17/// @{
    1818
    1919/**
    … …  
    125125bool pmPSFFromPSFtry (pmPSFtry *psfTry, bool applyWeights);
    126126
     127/// @}
    127128# endif

  • trunk/psModules/src/objects/pmPeaks.h

    r11159 r11253  
    1 /** @file  pmPeaks.h
     1/* @file  pmPeaks.h
    22 *
    33 * The process of finding, measuring, and classifying astronomical sources on
    … …  
    88 * construct a complete object measurement suite.
    99 *
    10  *  @author GLG, MHPCC
     10 * @author GLG, MHPCC
    1111 *
    12  *  @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
    13  *  @date $Date: 2007-01-19 04:36:53 $
    14  *
    15  *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    16  *
     12 * @version $Revision: 1.6 $ $Name: not supported by cvs2svn $
     13 * @date $Date: 2007-01-24 02:54:15 $
     14 * Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    1715 */
    1816
    1917# ifndef PM_PEAKS_H
    2018# define PM_PEAKS_H
     19
     20/// @addtogroup Objects Object Detection / Analysis Functions
     21/// @{
    2122
    2223/** pmPeakType
    … …  
    147148int pmPeaksCompareDescend (const void **a, const void **b);
    148149
     150/// @}
    149151# endif /* PM_PEAKS_H */

  • trunk/psModules/src/objects/pmSource.h

    r11203 r11253  
    1 /** @file  pmSource.h
    2  *
    3  *  @author EAM, IfA; GLG, MHPCC
    4  *
    5  *  @version $Revision: 1.9 $ $Name: not supported by cvs2svn $
    6  *  @date $Date: 2007-01-20 02:01:20 $
    7  *
    8  *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    9  *
     1/* @file  pmSource.h
     2 *
     3 * @author EAM, IfA; GLG, MHPCC
     4 *
     5 * @version $Revision: 1.10 $ $Name: not supported by cvs2svn $
     6 * @date $Date: 2007-01-24 02:54:15 $
     7 * Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    108 */
    119
    1210# ifndef PM_SOURCE_H
    1311# define PM_SOURCE_H
     12
     13/// @addtogroup Objects Object Detection / Analysis Functions
     14/// @{
    1415
    1516/**
    … …  
    228229pmModel *pmSourceSelectModel (pmSource *source);
    229230
     231/// @}
    230232# endif /* PM_SOURCE_H */

  • trunk/psModules/src/objects/pmSourceContour.h

    r6872 r11253  
    1 /** @file  pmSourceContour.h
     1/* @file  pmSourceContour.h
    22 *
    3  *  @author EAM, IfA; GLG, MHPCC
     3 * @author EAM, IfA; GLG, MHPCC
    44 *
    5  *  @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
    6  *  @date $Date: 2006-04-17 18:01:05 $
    7  *
    8  *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    9  *
     5 * @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
     6 * @date $Date: 2007-01-24 02:54:15 $
     7 * Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    108 */
    119
    1210# ifndef PM_SOURCE_CONTOUR_H
    1311# define PM_SOURCE_CONTOUR_H
     12
     13/// @addtogroup Objects Object Detection / Analysis Functions
     14/// @{
    1415
    1516psArray *pmSourceContour (psImage *image, int xc, int yc, float threshold);
    … …  
    3536);
    3637
     38/// @}
    3739# endif /* PM_SOURCE_PHOTOMETRY_H */

  • trunk/psModules/src/objects/pmSourceFitModel.h

    r10260 r11253  
    1 /** @file  pmSourceFitModel.h
     1/* @file  pmSourceFitModel.h
    22 *
    3  *  @author EAM, IfA; GLG, MHPCC
     3 * @author EAM, IfA; GLG, MHPCC
    44 *
    5  *  @version $Revision: 1.4 $ $Name: not supported by cvs2svn $
    6  *  @date $Date: 2006-11-29 02:44:21 $
    7  *
    8  *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    9  *
     5 * @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
     6 * @date $Date: 2007-01-24 02:54:15 $
     7 * Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    108 */
    119
    1210# ifndef PM_SOURCE_FIT_MODEL_H
    1311# define PM_SOURCE_FIT_MODEL_H
     12
     13/// @addtogroup Objects Object Detection / Analysis Functions
     14/// @{
    1415
    1516typedef enum {
    … …  
    7172);
    7273
     74/// @}
    7375# endif /* PM_SOURCE_FIT_MODEL_H */

  • trunk/psModules/src/objects/pmSourceIO.h

    r10421 r11253  
    1 /** @file  pmSourceIO.h
     1/* @file  pmSourceIO.h
     2 * @brief functions to read and write object files
    23 *
    3  *  @author EAM, IfA; GLG, MHPCC
     4 * @author EAM, IfA; GLG, MHPCC
    45 *
    5  *  @version $Revision: 1.4 $ $Name: not supported by cvs2svn $
    6  *  @date $Date: 2006-12-03 18:48:10 $
    7  *
    8  *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
     6 * @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
     7 * @date $Date: 2007-01-24 02:54:15 $
     8 * Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    99 *
    1010 */
    … …  
    1212# ifndef PM_SOURCE_IO_H
    1313# define PM_SOURCE_IO_H
     14
     15/// @addtogroup Objects Object Detection / Analysis Functions
     16/// @{
    1417
    1518int pmSourceDophotType (pmSource *source);
    … …  
    4245bool pmReadoutWriteObjects (pmReadout *readout, const pmFPAview *view, pmFPAfile *file, pmConfig *config);
    4346
     47/// @}
    4448# endif /* PM_SOURCE_IO_H */

  • trunk/psModules/src/objects/pmSourcePhotometry.h

    r10050 r11253  
    1 /** @file  pmSourcePhotometry.h
     1/* @file  pmSourcePhotometry.h
     2 * @brief functions to measure source photometry
    23 *
    3  *  @author EAM, IfA; GLG, MHPCC
     4 * @author EAM, IfA; GLG, MHPCC
    45 *
    5  *  @version $Revision: 1.7 $ $Name: not supported by cvs2svn $
    6  *  @date $Date: 2006-11-17 23:02:21 $
    7  *
    8  *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    9  *
     6 * @version $Revision: 1.8 $ $Name: not supported by cvs2svn $
     7 * @date $Date: 2007-01-24 02:54:15 $
     8 * Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    109 */
    1110
    1211# ifndef PM_SOURCE_PHOTOMETRY_H
    1312# define PM_SOURCE_PHOTOMETRY_H
     13
     14/// @addtogroup Objects Object Detection / Analysis Functions
     15/// @{
    1416
    1517/**
    … …  
    5557
    5658double pmSourceWeight(const pmSource *Mi, int term, const bool unweighted_sum);
     59
     60/// @}
    5761# endif /* PM_SOURCE_PHOTOMETRY_H */

  • trunk/psModules/src/objects/pmSourcePlots.h

    r10827 r11253  
    1 /** @file  pmSourcePlots.h
    2 *
    3 *  @brief functions to create plots illustrating source properties
    4 *
    5 *  @ingroup none
    6 *
    7 *  @author EAM, IfA
    8 *
    9 *  @version $Revision: 1.1 $ $Name: not supported by cvs2svn $
    10 *  @date $Date: 2006-12-23 04:00:30 $
    11 *
    12 *  Copyright 2006 Institute for Astronomy, University of Hawaii
    13 */
     1/* @file  pmSourcePlots.h
     2 * @brief functions to create plots illustrating source properties
     3 *
     4 * @author EAM, IfA
     5 *
     6 * @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
     7 * @date $Date: 2007-01-24 02:54:15 $
     8 * Copyright 2006 Institute for Astronomy, University of Hawaii
     9 */
    1410
    1511#ifndef PM_SOURCE_PLOTS_H
    1612#define PM_SOURCE_PLOTS_H
     13
     14/// @addtogroup Objects Object Detection / Analysis Functions
     15/// @{
    1716
    1817typedef struct
    … …  
    3837bool pmSourcePlotMoments (const pmFPAview *view, pmFPAfile *file, pmConfig *config, pmSourcePlotLayout *layout);
    3938
     39/// @}
    4040#endif // PM_SOURCE_PLOTS_H

  • trunk/psModules/src/objects/pmSourceSky.h

    r6872 r11253  
    1 /** @file  pmSourceSky.h
     1/* @file  pmSourceSky.h
     2 * @author EAM, IfA; GLG, MHPCC
    23 *
    3  *  @author EAM, IfA; GLG, MHPCC
    4  *
    5  *  @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
    6  *  @date $Date: 2006-04-17 18:01:05 $
    7  *
    8  *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    9  *
     4 * @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
     5 * @date $Date: 2007-01-24 02:54:15 $
     6 * Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    107 */
    118
    129# ifndef PM_SOURCE_SKY_H
    1310# define PM_SOURCE_SKY_H
     11
     12/// @addtogroup Objects Object Detection / Analysis Functions
     13/// @{
    1414
    1515/** pmSourceLocalSky()
    … …  
    4040);
    4141
     42/// @}
    4243# endif /* PM_SOURCE_PHOTOMETRY_H */
Note: See TracChangeset for help on using the changeset viewer.