IPP Software Navigation Tools IPP Links Communication Pan-STARRS Links

Changeset 11253


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

cleaned up Doxygen groups

Location:
trunk/psModules
Files:
68 edited

Legend:

Unmodified
Added
Removed

  • trunk/psModules/Makefile.am

    r8569 r11253  
    1212        autogen.sh
    1313
    14 if DOXYGEN
     14if HAVE_DOXYGEN
     15install-data-hook: doxygen
     16        -$(mkdir_p) $(mandir)/man3
     17        chmod 0755 $(mandir)/man3
     18        -cp $(top_builddir)/docs/man/man3/* $(mandir)/man3
    1519
    16 docs: Doxyfile $(prefix)/docs/psmodules $(mandir)/man3
    17         doxygen Doxyfile
    18         mv -f $(prefix)/docs/psmodules/man/man3/* $(mandir)/man3
    19         rm -rf $(prefix)/docs/psmodules/man
    20 
    21 $(prefix)/docs/psmodules:
    22         mkdir -p $(prefix)/docs/psmodules
    23 
    24 $(mandir)/man3:
    25         mkdir -p $(mandir)/man3
    26 
    27 uninstall-hook:
    28         rm -rf $(prefix)/docs/psmodules/*
     20doxygen:
     21        $(DOXYGEN)
     22endif
    2923
    3024CLEANFILES = $(prefix)/docs/psmodules/* *~
    3125
    32 endif
    33 
    3426test: check

  • trunk/psModules/configure.ac

    r11250 r11253  
    9696
    9797dnl doxygen -------------------------------------------------------------------
    98 
    99 AC_CHECK_PROG([doxygen], [doxygen], [true], [false])
    100 AM_CONDITIONAL(DOXYGEN, test x$doxygen = xtrue)
     98dnl doxygen doc generation is very, very slow so we're turing it off by default
     99
     100dnl save LIBS/CFLAGS/LDFLAGS
     101TMP_LIBS=${LIBS}
     102TMP_CFLAGS=${CFLAGS}
     103TMP_LDFLAGS=${LDFLAGS}
     104TMP_CPPFLAGS=${CPPFLAGS}
     105
     106AC_ARG_ENABLE(doxygen,
     107  [AS_HELP_STRING(--enable-doxygen ,enable manpage generation)],
     108  [AC_MSG_RESULT(doxygen enabled)
     109    AC_PATH_PROG([DOXYGEN], [doxygen], [])
     110  ],
     111  [AC_MSG_RESULT([doxygen disabled])
     112    doxygen=off
     113  ]
     114)
     115AM_CONDITIONAL([HAVE_DOXYGEN], test -n "$DOXYGEN" -a "x$doxygen" != "xoff")
     116
     117dnl restore the CFLAGS/LDFLAGS
     118LIBS=${TMP_LIBS}
     119CFLAGS=${TMP_CFLAGS}
     120LDFLAGS=${TMP_LDFLAGS}
     121CPPFLAGS=${TMP_CPPFLAGS}
    101122
    102123dnl ------------------------------------------------------------

  • trunk/psModules/src/astrom/pmAstrometryDistortion.h

    r7152 r11253  
    1 /** @file  pmAstrometryDistortion.h
    2 *
    3 *  @brief This file defines the basic types for measuring and fitting the focal-plane distortion.
    4 *
    5 *  @ingroup AstroImage
    6 *
    7 *  @author EAM, IfA
    8 *
    9 *  @version $Revision: 1.1 $ $Name: not supported by cvs2svn $
    10 *  @date $Date: 2006-05-19 15:39:53 $
    11 *
    12 *  Copyright 2006 Institute for Astronomy, University of Hawaii
    13 */
     1/* @file  pmAstrometryDistortion.h
     2 * @brief This file defines the basic types for measuring and fitting the focal-plane distortion.
     3 *
     4 * @author EAM, IfA
     5 *
     6 * @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
     7 * @date $Date: 2007-01-24 02:54:14 $
     8 * Copyright 2006 Institute for Astronomy, University of Hawaii
     9 */
    1410
    1511#ifndef PM_ASTROMETRY_DISTORTION_H
    1612#define PM_ASTROMETRY_DISTORTION_H
     13
     14/// @addtogroup Astrometry
     15/// @{
    1716
    1817/* The following data structure carries the information about the residual
    … …  
    5655    psMetadata *config);
    5756
     57/// @}
    5858#endif // PM_ASTROMETRY_DISTORTION_H

  • trunk/psModules/src/astrom/pmAstrometryObjects.h

    r10829 r11253  
    1 /** @file  pmAstrometryObjects.h
    2 *
    3 *  @brief This file defines the basic types for matching objects
    4 *  based on their astrometry.
    5 *
    6 *  @ingroup AstroImage
    7 *
    8 *  @author EAM, IfA
    9 *
    10 *  @version $Revision: 1.14 $ $Name: not supported by cvs2svn $
    11 *  @date $Date: 2006-12-25 01:49:49 $
    12 *
    13 *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    14 */
     1/* @file  pmAstrometryObjects.h
     2 * @brief basic matching of objects based on their astrometry.
     3 *
     4 * @author EAM, IfA
     5 *
     6 * @version $Revision: 1.15 $ $Name: not supported by cvs2svn $
     7 * @date $Date: 2007-01-24 02:54:14 $
     8 * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
     9 */
    1510
    1611#ifndef PM_ASTROMETRY_OBJECTS_H
    1712#define PM_ASTROMETRY_OBJECTS_H
     13
     14/// @addtogroup Astrometry
     15/// @{
    1816
    1917/*
    … …  
    345343);
    346344
     345/// @}
    347346#endif // PM_ASTROMETRY_OBJECTS_H

  • trunk/psModules/src/astrom/pmAstrometryUtils.h

    r10870 r11253  
    1 /** @file  pmAstrometryUtils.h
    2 *
    3 *  @brief utility functions for transform and distort functions
    4 *
    5 *  @ingroup Astrometry
    6 *
    7 *  @author EAM, IfA
    8 *
    9 *  @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
    10 *  @date $Date: 2007-01-01 21:04:38 $
    11 *
    12 *  Copyright 2006 Institute for Astronomy, University of Hawaii
    13 */
     1/* @file  pmAstrometryUtils.h
     2 * @brief utility functions for transform and distort functions
     3 *
     4 * @author EAM, IfA
     5 *
     6 * @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
     7 * @date $Date: 2007-01-24 02:54:14 $
     8 * Copyright 2006 Institute for Astronomy, University of Hawaii
     9 */
    1410
    1511#ifndef PM_ASTROMETRY_UTILS_H
    1612#define PM_ASTROMETRY_UTILS_H
     13
     14/// @addtogroup Astrometry
     15/// @{
    1716
    1817psPlane *psPlaneTransformGetCenter (psPlaneTransform *trans, double tol);
    … …  
    2524bool psPlaneDistortIsDiagonal (psPlaneDistort *distort);
    2625
     26/// @}
    2727#endif

  • trunk/psModules/src/astrom/pmAstrometryWCS.h

    r10874 r11253  
    1 /** @file  pmAstrometryDistortion.h
    2 *
    3 *  @brief functions to convert FITS WCS keywords to / from pmFPA structures
    4 *
    5 *  @ingroup Astrometry
    6 *
    7 *  @author EAM, IfA
    8 *
    9 *  @version $Revision: 1.8 $ $Name: not supported by cvs2svn $
    10 *  @date $Date: 2007-01-01 21:05:59 $
    11 *
    12 *  Copyright 2006 Institute for Astronomy, University of Hawaii
    13 */
     1/* @file  pmAstrometryDistortion.h
     2 * @brief functions to convert FITS WCS keywords to / from pmFPA structures
     3 *
     4 * @author EAM, IfA
     5 *
     6 * @version $Revision: 1.9 $ $Name: not supported by cvs2svn $
     7 * @date $Date: 2007-01-24 02:54:14 $
     8 * Copyright 2006 Institute for Astronomy, University of Hawaii
     9 */
    1410
    1511#ifndef PM_ASTROMETRY_WCS_H
    1612#define PM_ASTROMETRY_WCS_H
     13
     14/// @addtogroup Astrometry
     15/// @{
    1716
    1817#define PM_ASTROM_WCS_TYPE_SIZE 80
    … …  
    7069# define PM_RAD_DEG  0.017453292519943
    7170
     71/// @}
    7272#endif // PM_ASTROMETRY_WCS_H
    7373

  • trunk/psModules/src/camera/pmFPA.h

    r10826 r11253  
    1 /// @file pmFPA.h
    2 ///
    3 /// @brief Defines the focal plane hierarchy, along with functions for interacting with it
    4 ///
    5 /// @ingroup Camera
    6 ///
    7 /// @author George Gusciora, MHPCC
    8 /// @author Paul Price, IfA
    9 /// @author Eugene Magnier, IfA
    10 ///
    11 /// @version $Revision: 1.11 $ $Name: not supported by cvs2svn $
    12 /// @date $Date: 2006-12-22 21:23:36 $
    13 ///
    14 /// Copyright 2005-2006 Institute for Astronomy, University of Hawaii
    15 ///
     1/* @file pmFPA.h
     2 * @brief Defines the focal plane hierarchy, along with functions for interacting with it
     3 *
     4 * @author George Gusciora, MHPCC
     5 * @author Paul Price, IfA
     6 * @author Eugene Magnier, IfA
     7 *
     8 * @version $Revision: 1.12 $ $Name: not supported by cvs2svn $
     9 * @date $Date: 2007-01-24 02:54:14 $
     10 * Copyright 2005-2006 Institute for Astronomy, University of Hawaii
     11 */
    1612
    1713#ifndef PM_FPA_H
    1814#define PM_FPA_H
     15
     16/// @addtogroup Camera Camera Layout
     17/// @{
    1918
    2019#include <pslib.h>
    … …  
    184183bool pmFPACheckParents(pmFPA *fpa       ///< FPA to check
    185184                      );
    186 
    187 
     185/// @}
    188186#endif // #ifndef PM_FPA_H

  • trunk/psModules/src/camera/pmFPAConstruct.h

    r11216 r11253  
    1 /// @file pmFPAConstruct.h
    2 ///
    3 /// @brief Functions to create an FPA, and add data sources to it.
    4 ///
    5 /// @ingroup Camera
    6 ///
    7 /// @author Paul Price, IfA
    8 ///
    9 /// @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
    10 /// @date $Date: 2007-01-20 04:24:42 $
    11 ///
    12 /// Copyright 2005-2006 Institute for Astronomy, University of Hawaii
    13 ///
     1/* @file pmFPAConstruct.h
     2 * @brief Functions to create an FPA, and add data sources to it.
     3 *
     4 * @author Paul Price, IfA
     5 *
     6 * @version $Revision: 1.6 $ $Name: not supported by cvs2svn $
     7 * @date $Date: 2007-01-24 02:54:14 $
     8 * Copyright 2005-2006 Institute for Astronomy, University of Hawaii
     9 */
    1410
    1511#ifndef PM_FPA_CONSTRUCT_H
    1612#define PM_FPA_CONSTRUCT_H
     13
     14/// @addtogroup Camera Camera Layout
     15/// @{
    1716
    1817#include <pslib.h>
    … …  
    6261                bool concepts           ///< Print concepts?
    6362               );
    64 
     63/// @}
    6564#endif

  • trunk/psModules/src/camera/pmFPACopy.h

    r9589 r11253  
    1 /// @file pmFPACopy.h
    2 ///
    3 /// @brief Functions to copy FPA components.
    4 ///
    5 /// @ingroup Camera
    6 ///
    7 /// @author Paul Price, IfA
    8 ///
    9 /// @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
    10 /// @date $Date: 2006-10-17 01:16:17 $
    11 ///
    12 /// Copyright 2005-2006 Institute for Astronomy, University of Hawaii
    13 ///
     1/* @file pmFPACopy.h
     2 * @brief Functions to copy FPA components.
     3 *
     4 * @author Paul Price, IfA
     5 *
     6 * @version $Revision: 1.4 $ $Name: not supported by cvs2svn $
     7 * @date $Date: 2007-01-24 02:54:14 $
     8 * Copyright 2005-2006 Institute for Astronomy, University of Hawaii
     9 */
    1410
    1511#ifndef PM_FPA_COPY_H
    1612#define PM_FPA_COPY_H
     13
     14/// @addtogroup Camera Camera Layout
     15/// @{
    1716
    1817/// Copy an FPA and components, including the pixels, to a different representation of the same camera
    … …  
    7372                         int xBin, int yBin ///< Binning factors in x and y
    7473                        );
    75 
    76 
     74/// @}
    7775#endif

  • trunk/psModules/src/camera/pmFPAExtent.h

    r11124 r11253  
     1/* @file  pmPFAExtent.h
     2 *
     3 * @author Paul Price, IfA
     4 *
     5 * @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
     6 * @date $Date: 2007-01-24 02:54:14 $
     7 * Copyright 2005-2006 Institute for Astronomy, University of Hawaii
     8 */
     9
    110#ifndef PM_FPA_EXTENT_H
    211#define PM_FPA_EXTENT_H
     12
     13/// @addtogroup Camera Camera Layout
     14/// @{
    315
    416/// Return the extent of a readout
    … …  
    2638                     );
    2739
    28 
     40/// @}
    2941#endif

  • trunk/psModules/src/camera/pmFPAFlags.h

    r9621 r11253  
    1 /// @file pmFPAFlags.h
    2 ///
    3 /// @brief Functions for setting and checking the status flags within the FPA hierarchy
    4 ///
    5 /// @ingroup Camera
    6 ///
    7 /// @author George Gusciora, MHPCC
    8 /// @author Paul Price, IfA
    9 /// @author Eugene Magnier, IfA
    10 ///
    11 /// @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
    12 /// @date $Date: 2006-10-18 02:29:15 $
    13 ///
    14 /// Copyright 2005-2006 Institute for Astronomy, University of Hawaii
    15 ///
     1/*  @file pmFPAFlags.h
     2 *  @brief Functions for setting and checking the status flags within the FPA hierarchy
     3 *
     4 *  @author George Gusciora, MHPCC
     5 *  @author Paul Price, IfA
     6 *  @author Eugene Magnier, IfA
     7 *
     8 *  @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2007-01-24 02:54:14 $
     10 *  Copyright 2005-2006 Institute for Astronomy, University of Hawaii
     11 */
    1612
    1713#ifndef PM_FPA_FLAGS_H
    1814#define PM_FPA_FLAGS_H
     15
     16/// @addtogroup Camera Camera Layout
     17/// @{
    1918
    2019#include "pmFPA.h"
    … …  
    9897                      int cellNum       ///< Cell number to exclude
    9998                     );
    100 
    101 
     99/// @}
    102100#endif

  • trunk/psModules/src/camera/pmFPAHeader.h

    r9592 r11253  
    1 /// @file pmFPAHeader.h
    2 ///
    3 /// @brief Functions read FITS headers for FPA components
    4 ///
    5 /// @ingroup Camera
    6 ///
    7 /// @author Paul Price, IfA
    8 ///
    9 /// @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
    10 /// @date $Date: 2006-10-17 01:29:02 $
    11 ///
    12 /// Copyright 2005-2006 Institute for Astronomy, University of Hawaii
    13 ///
     1/*  @file pmFPAHeader.h
     2 *  @brief Functions read FITS headers for FPA components
     3 *
     4 *  @author Paul Price, IfA
     5 *
     6 *  @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
     7 *  @date $Date: 2007-01-24 02:54:14 $
     8 *  Copyright 2005-2006 Institute for Astronomy, University of Hawaii
     9 */
    1410
    1511#ifndef PM_FPA_HEADER_H
    1612#define PM_FPA_HEADER_H
     13
     14/// @addtogroup Camera Camera Layout
     15/// @{
    1716
    1817/// Read the FITS header (and ingest concepts) for an FPA, if it exists at this level
    … …  
    3938                      psFits *fits      ///< FITS file handle
    4039                     );
    41 
     40/// @}
    4241#endif

  • trunk/psModules/src/camera/pmFPALevel.h

    r9621 r11253  
    1 /// @file pmFPALevel.h
    2 ///
    3 /// @brief Defines enum and string representations for the FPA levels
    4 ///
    5 /// @ingroup Camera
    6 ///
    7 /// @author Eugene Magnier, MHPCC
    8 ///
    9 /// @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
    10 /// @date $Date: 2006-10-18 02:29:15 $
    11 ///
    12 /// Copyright 2005-2006 Institute for Astronomy, University of Hawaii
    13 ///
     1/* @file pmFPALevel.h
     2 * @brief Defines enum and string representations for the FPA levels
     3 *
     4 * @author Eugene Magnier, MHPCC
     5 *
     6 * @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
     7 * @date $Date: 2007-01-24 02:54:14 $
     8 * Copyright 2005-2006 Institute for Astronomy, University of Hawaii
     9 */
    1410
    1511#ifndef PM_FPA_LEVEL_H
    1612#define PM_FPA_LEVEL_H
     13
     14/// @addtogroup Camera Camera Layout
     15/// @{
    1716
    1817/// Specify the level of the FPA hierarchy
    … …  
    3332pmFPALevel pmFPALevelFromName(const char *name ///< Level name
    3433                             );
    35 
     34/// @}
    3635#endif // #ifndef PM_FPA_LEVEL_H

  • trunk/psModules/src/camera/pmFPAMaskWeight.h

    r10247 r11253  
    1 /// @file pmFPAHeader.h
    2 ///
    3 /// @brief Functions read FITS headers for FPA components
    4 ///
    5 /// @ingroup Camera
    6 ///
    7 /// @author Paul Price, IfA
    8 /// @author Eugene Magnier, IfA
    9 ///
    10 /// @version $Revision: 1.6 $ $Name: not supported by cvs2svn $
    11 /// @date $Date: 2006-11-29 01:26:14 $
    12 ///
    13 /// Copyright 2005-2006 Institute for Astronomy, University of Hawaii
    14 ///
     1/* @file pmFPAHeader.h
     2 * @brief Functions read FITS headers for FPA components
     3 *
     4 * @author Paul Price, IfA
     5 * @author Eugene Magnier, IfA
     6 *
     7 * @version $Revision: 1.7 $ $Name: not supported by cvs2svn $
     8 * @date $Date: 2007-01-24 02:54:14 $
     9 * Copyright 2005-2006 Institute for Astronomy, University of Hawaii
     10 */
     11
    1512#ifndef PM_FPA_MASK_WEIGHT_H
    1613#define PM_FPA_MASK_WEIGHT_H
     14
     15/// @addtogroup Camera Camera Layout
     16/// @{
    1717
    1818#include "pmFPA.h"
    … …  
    8080                              bool poisson    ///< Use poisson weights (in addition to read noise)?
    8181                             );
    82 
    83 
    84 
     82/// @}
    8583#endif

  • trunk/psModules/src/camera/pmFPAMosaic.h

    r9718 r11253  
    1 /// @file pmFPAMosaic.h
    2 ///
    3 /// @brief Functions to mosaic FPA components into a single entity
    4 ///
    5 /// @ingroup Camera
    6 ///
    7 /// @author Paul Price, IfA
    8 ///
    9 /// @version $Revision: 1.4 $ $Name: not supported by cvs2svn $
    10 /// @date $Date: 2006-10-24 01:05:55 $
    11 ///
    12 /// Copyright 2005-2006 Institute for Astronomy, University of Hawaii
    13 ///
     1/* @file pmFPAMosaic.h
     2 * @brief Functions to mosaic FPA components into a single entity
     3 *
     4 * @author Paul Price, IfA
     5 *
     6 * @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
     7 * @date $Date: 2007-01-24 02:54:14 $
     8 * Copyright 2005-2006 Institute for Astronomy, University of Hawaii
     9 */
    1410
    1511#ifndef PM_CHIP_MOSAIC_H
    1612#define PM_CHIP_MOSAIC_H
     13
     14/// @addtogroup Camera Camera Layout
     15/// @{
    1716
    1817#include "pmFPA.h"
    … …  
    3736                 const pmFPA *source    ///< FPA whose chips and cells will be mosaicked
    3837                );
    39 
     38/// @}
    4039#endif

  • trunk/psModules/src/camera/pmFPARead.h

    r9949 r11253  
    1 /// @file pmFPARead.h
    2 ///
    3 /// @brief Functions to read FPA components from a FITS file
    4 ///
    5 /// @ingroup Camera
    6 ///
    7 /// @author Paul Price, IfA
    8 ///
    9 /// @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
    10 /// @date $Date: 2006-11-13 22:15:05 $
    11 ///
    12 /// Copyright 2005-2006 Institute for Astronomy, University of Hawaii
    13 ///
     1/* @file pmFPARead.h
     2 * @brief Functions to read FPA components from a FITS file
     3 *
     4 * @author Paul Price, IfA
     5 *
     6 * @version $Revision: 1.6 $ $Name: not supported by cvs2svn $
     7 * @date $Date: 2007-01-24 02:54:14 $
     8 * Copyright 2005-2006 Institute for Astronomy, University of Hawaii
     9 */
    1410
    1511#ifndef PM_FPA_READ_H
    1612#define PM_FPA_READ_H
     13
     14/// @addtogroup Camera Camera Layout
     15/// @{
    1716
    1817#include <pslib.h>
    … …  
    133132                   const char *name     ///< Specifies the extension name, and target in the analysis metadata
    134133                  );
    135 
     134/// @}
    136135#endif

  • trunk/psModules/src/camera/pmFPAUtils.h

    r9601 r11253  
    1 /// @file pmFPAUtils.h
    2 ///
    3 /// @brief Utility functions for FPAs
    4 ///
    5 /// @ingroup Camera
    6 ///
    7 /// @author Paul Price, IfA
    8 ///
    9 /// @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
    10 /// @date $Date: 2006-10-17 03:03:35 $
    11 ///
    12 /// Copyright 2005-2006 Institute for Astronomy, University of Hawaii
    13 ///
     1/* @file pmFPAUtils.h
     2 * @brief Utility functions for FPAs
     3 *
     4 * @author Paul Price, IfA
     5 *
     6 * @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
     7 * @date $Date: 2007-01-24 02:54:14 $
     8 * Copyright 2005-2006 Institute for Astronomy, University of Hawaii
     9 */
    1410
    1511#ifndef PM_FPA_UTILS_H
    1612#define PM_FPA_UTILS_H
     13
     14/// @addtogroup Camera Camera Layout
     15/// @{
    1716
    1817#include "pmFPA.h"
    … …  
    3332                   const char *name     // Name of the cell
    3433                  );
    35 
    36 
     34/// @}
    3735#endif

  • trunk/psModules/src/camera/pmFPAWrite.h

    r10081 r11253  
    1 /// @file pmFPAWrite.h
    2 ///
    3 /// @brief Write FPA components to a FITS file
    4 ///
    5 /// @ingroup Camera
    6 ///
    7 /// @author Paul Price, IfA
    8 ///
    9 /// @version $Revision: 1.7 $ $Name: not supported by cvs2svn $
    10 /// @date $Date: 2006-11-18 23:43:28 $
    11 ///
    12 /// Copyright 2005-2006 Institute for Astronomy, University of Hawaii
    13 ///
     1/* @file pmFPAWrite.h
     2 * @brief Write FPA components to a FITS file
     3 *
     4 * @author Paul Price, IfA
     5 *
     6 * @version $Revision: 1.8 $ $Name: not supported by cvs2svn $
     7 * @date $Date: 2007-01-24 02:54:14 $
     8 * Copyright 2005-2006 Institute for Astronomy, University of Hawaii
     9 */
    1410
    1511#ifndef PM_FPA_WRITE_H
    1612#define PM_FPA_WRITE_H
    1713
     14/// @addtogroup Camera Camera Layout
     15/// @{
     16
    1817#include <pslib.h>
    1918#include "pmFPA.h"
    20 
    2119
    2220/// Write a readout incrementally
    … …  
    167165                    const char *name    ///< Name for the table data, and the extension name
    168166                   );
    169 
     167/// @}
    170168#endif

  • trunk/psModules/src/camera/pmFPA_JPEG.h

    r10421 r11253  
    1 /** @file  pmFPAview.h
    2 *
    3 *  @brief Tools to manipulate the FPA structure elements.
    4 *
    5 *  @ingroup AstroImage
    6 *
    7 *  @author EAM, IfA
    8 *
    9 *  @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
    10 *  @date $Date: 2006-12-03 18:48:10 $
    11 *
    12 *  Copyright 2004-2005 Institute for Astronomy, University of Hawaii
    13 */
     1/* @file  pmFPAview.h
     2 * @brief Tools to manipulate the FPA structure elements.
     3 *
     4 * @author EAM, IfA
     5 *
     6 * @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
     7 * @date $Date: 2007-01-24 02:54:14 $
     8 * Copyright 2004-2005 Institute for Astronomy, University of Hawaii
     9 */
    1410
    1511#ifndef PM_FPA_JPEG_H
    1612#define PM_FPA_JPEG_H
    1713
    18 /// @addtogroup AstroImage
     14/// @addtogroup Camera Camera Layout
    1915/// @{
    2016
    … …  
    2521bool pmReadoutWriteJPEG (pmReadout *readout, const pmFPAview *view, pmFPAfile *file, pmConfig *config);
    2622
     23/// @}
    2724# endif

  • trunk/psModules/src/camera/pmFPA_MANAPLOT.h

    r10421 r11253  
    1 /** @file  pmFPAview.h
    2 *
    3 *  @brief Tools to manipulate the FPA structure elements.
    4 *
    5 *  @ingroup AstroImage
    6 *
    7 *  @author EAM, IfA
    8 *
    9 *  @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
    10 *  @date $Date: 2006-12-03 18:48:10 $
    11 *
    12 *  Copyright 2004-2005 Institute for Astronomy, University of Hawaii
    13 */
     1/* @file  pmFPAview.h
     2 * @brief Tools to manipulate the FPA structure elements.
     3 *
     4 * @author EAM, IfA
     5 *
     6 * @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
     7 * @date $Date: 2007-01-24 02:54:14 $
     8 * Copyright 2004-2005 Institute for Astronomy, University of Hawaii
     9 */
    1410
    1511#ifndef PM_FPA_MANAPLOT_H
    1612#define PM_FPA_MANAPLOT_H
    1713
    18 /// @addtogroup AstroImage
     14/// @addtogroup Camera Camera Layout
    1915/// @{
    2016
    … …  
    2521bool pmReadoutWriteMANAPLOT (pmReadout *readout, const pmFPAview *view, pmFPAfile *file, pmConfig *config);
    2622
     23/// @}
    2724# endif

  • trunk/psModules/src/camera/pmFPAfile.h

    r10966 r11253  
    1 /** @file  pmFPAview.h
    2 *
    3 *  @brief Tools to manipulate the FPA structure elements.
    4 *
    5 *  @ingroup AstroImage
    6 *
    7 *  @author EAM, IfA
    8 *
    9 *  @version $Revision: 1.11 $ $Name: not supported by cvs2svn $
    10 *  @date $Date: 2007-01-08 22:30:21 $
    11 *
    12 *  Copyright 2004-2005 Institute for Astronomy, University of Hawaii
    13 */
     1/* @file  pmFPAview.h
     2 * @brief Tools to manipulate the FPA structure elements.
     3 *
     4 * @author EAM, IfA
     5 *
     6 * @version $Revision: 1.12 $ $Name: not supported by cvs2svn $
     7 * @date $Date: 2007-01-24 02:54:14 $
     8 * Copyright 2004-2005 Institute for Astronomy, University of Hawaii
     9 */
    1410
    1511#ifndef PM_FPA_FILE_H
    1612#define PM_FPA_FILE_H
     13
     14/// @addtogroup Camera Camera Layout
     15/// @{
    1716
    1817#include "pslib.h"
    … …  
    126125pmFPAfileType pmFPAfileTypeFromString(const char *type);
    127126
     127/// @}
    128128# endif

  • trunk/psModules/src/camera/pmFPAfileDefine.h

    r11182 r11253  
    1 /** @file  pmFPAview.h
    2 *
    3 *  @brief Tools to manipulate the FPA structure elements.
    4 *
    5 *  @ingroup AstroImage
    6 *
    7 *  @author EAM, IfA
    8 *
    9 *  @version $Revision: 1.7 $ $Name: not supported by cvs2svn $
    10 *  @date $Date: 2007-01-19 22:14:15 $
    11 *
    12 *  Copyright 2004-2005 Institute for Astronomy, University of Hawaii
    13 */
     1/* @file  pmFPAview.h
     2 * @brief Tools to manipulate the FPA structure elements.
     3 *
     4 * @author EAM, IfA
     5 *
     6 * @version $Revision: 1.8 $ $Name: not supported by cvs2svn $
     7 * @date $Date: 2007-01-24 02:54:14 $
     8 * Copyright 2004-2005 Institute for Astronomy, University of Hawaii
     9 */
    1410
    1511#include <pmDetrendDB.h>
     12
     13/// @addtogroup Camera Camera Layout
     14/// @{
    1615
    1716#ifndef PM_FPA_FILE_DEFINE_H
    … …  
    9998pmFPAfile *pmFPAfileDefineSingleFromArgs (bool *found, pmConfig *config, const char *filename,
    10099        const char *argname, int entry);
    101 
     100/// @}
    102101# endif

  • trunk/psModules/src/camera/pmFPAfileFitsIO.h

    r10081 r11253  
    1 /** @file  pmFPAview.h
    2 *
    3 *  @brief Tools to manipulate the FPA structure elements.
    4 *
    5 *  @ingroup AstroImage
    6 *
    7 *  @author EAM, IfA
    8 *  @author PAP, IfA
    9 *
    10 *  @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
    11 *  @date $Date: 2006-11-18 23:43:28 $
    12 *
    13 *  Copyright 2004-2005 Institute for Astronomy, University of Hawaii
    14 */
     1/* @file  pmFPAview.h
     2 * @brief Tools to manipulate the FPA structure elements.
     3 *
     4 * @author EAM, IfA
     5 * @author PAP, IfA
     6 *
     7 * @version $Revision: 1.4 $ $Name: not supported by cvs2svn $
     8 * @date $Date: 2007-01-24 02:54:14 $
     9 * Copyright 2004-2005 Institute for Astronomy, University of Hawaii
     10 */
    1511
    1612#ifndef PM_FPA_FILE_FITS_IO_H
    1713#define PM_FPA_FILE_FITS_IO_H
     14
     15/// @addtogroup Camera Camera Layout
     16/// @{
    1817
    1918/// Read an image into the current view
    … …  
    6261                             const char *name ///< Name of table
    6362                            );
    64 
     63/// @}
    6564# endif

  • trunk/psModules/src/camera/pmFPAfileIO.h

    r10966 r11253  
    1 /** @file  pmFPAview.h
    2 *
    3 *  @brief Tools to manipulate the FPA structure elements.
    4 *
    5 *  @ingroup AstroImage
    6 *
    7 *  @author EAM, IfA
    8 *
    9 *  @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
    10 *  @date $Date: 2007-01-08 22:30:21 $
    11 *
    12 *  Copyright 2004-2005 Institute for Astronomy, University of Hawaii
    13 */
     1/* @file  pmFPAview.h
     2 * @brief Tools to manipulate the FPA structure elements.
     3 *
     4 * @author EAM, IfA
     5 *
     6 * @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
     7 * @date $Date: 2007-01-24 02:54:14 $
     8 * Copyright 2004-2005 Institute for Astronomy, University of Hawaii
     9 */
    1410
    1511#ifndef PM_FPA_FILE_IO_H
    1612#define PM_FPA_FILE_IO_H
     13
     14/// @addtogroup Camera Camera Layout
     15/// @{
    1716
    1817// open the real file corresponding to the given pmFPAfile appropriate to the current view
    … …  
    4039bool pmFPAfileIOChecks (pmConfig *config, const pmFPAview *view, pmFPAfilePlace place);
    4140
     41/// @}
    4242# endif

  • trunk/psModules/src/camera/pmFPAview.h

    r9710 r11253  
    1 /// @file pmFPA.h
    2 ///
    3 /// @brief Tools to manipulate the FPA structure elements.
    4 ///
    5 /// @ingroup Camera
    6 ///
    7 /// @author Eugene Magnier, IfA
    8 ///
    9 /// @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
    10 /// @date $Date: 2006-10-21 04:02:36 $
    11 ///
    12 /// Copyright 2005-2006 Institute for Astronomy, University of Hawaii
    13 ///
     1/* @file pmFPA.h
     2 * @brief Tools to manipulate the FPA structure elements.
     3 *
     4 * @author Eugene Magnier, IfA
     5 *
     6 * @version $Revision: 1.6 $ $Name: not supported by cvs2svn $
     7 * @date $Date: 2007-01-24 02:54:14 $
     8 * Copyright 2005-2006 Institute for Astronomy, University of Hawaii
     9 */
    1410
    1511#ifndef PM_FPA_VIEW_H
    1612#define PM_FPA_VIEW_H
     13
     14/// @addtogroup Camera Camera Layout
     15/// @{
    1716
    1817#include "pmFPA.h"
    … …  
    112111                       );
    113112
     113/// @}
    114114#endif

  • trunk/psModules/src/camera/pmHDU.h

    r10081 r11253  
    1 /// @file pmHDU.h
    2 ///
    3 /// @brief Define a header data unit (from a FITS file), with functions to read and write
    4 ///
    5 /// @ingroup Camera
    6 ///
    7 /// @author Paul Price, IfA
    8 ///
    9 /// @version $Revision: 1.6 $ $Name: not supported by cvs2svn $
    10 /// @date $Date: 2006-11-18 23:43:28 $
    11 ///
    12 /// Copyright 2005-2006 Institute for Astronomy, University of Hawaii
    13 ///
     1/* @file pmHDU.h
     2 * @brief Define a header data unit (from a FITS file), with functions to read and write
     3 *
     4 * @author Paul Price, IfA
     5 *
     6 * @version $Revision: 1.7 $ $Name: not supported by cvs2svn $
     7 * @date $Date: 2007-01-24 02:54:14 $
     8 * Copyright 2005-2006 Institute for Astronomy, University of Hawaii
     9 */
    1410
    1511#ifndef PM_HDU_H
    1612#define PM_HDU_H
     13
     14/// @addtogroup Camera Camera Layout
     15/// @{
    1716
    1817/// An instance of the FITS Header Data Unit
    … …  
    8079                     );
    8180
     81/// @}
    8282#endif

  • trunk/psModules/src/camera/pmHDUGenerate.h

    r9603 r11253  
    1 /// @file pmHDUGenerate.h
    2 ///
    3 /// @brief Generate HDU pixels from FPA components that have pixels
    4 ///
    5 /// @ingroup Camera
    6 ///
    7 /// @author Paul Price, IfA
    8 ///
    9 /// @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
    10 /// @date $Date: 2006-10-17 03:29:08 $
    11 ///
    12 /// Copyright 2005-2006 Institute for Astronomy, University of Hawaii
    13 ///
     1/* @file pmHDUGenerate.h
     2 * @brief Generate HDU pixels from FPA components that have pixels
     3 *
     4 * @author Paul Price, IfA
     5 *
     6 * @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
     7 * @date $Date: 2007-01-24 02:54:14 $
     8 * Copyright 2005-2006 Institute for Astronomy, University of Hawaii
     9 */
    1410
    1511#ifndef PM_HDU_GENERATE_H
    1612#define PM_HDU_GENERATE_H
     13
     14/// @addtogroup Camera Camera Layout
     15/// @{
    1716
    1817#include "pmFPA.h"
    … …  
    5352bool pmHDUGenerateForFPA(pmFPA *fpa     ///< The fpa for which to generate an HDU
    5453                        );
    55 
    56 
     54/// @}
    5755#endif

  • trunk/psModules/src/camera/pmHDUUtils.h

    r9703 r11253  
    1 /// @file pmHDUUtils.h
    2 ///
    3 /// @brief Utility functions for working with an HDU
    4 ///
    5 /// @ingroup Camera
    6 ///
    7 /// @author Paul Price, IfA
    8 ///
    9 /// @version $Revision: 1.7 $ $Name: not supported by cvs2svn $
    10 /// @date $Date: 2006-10-21 03:31:07 $
    11 ///
    12 /// Copyright 2005-2006 Institute for Astronomy, University of Hawaii
    13 ///
     1/* @file pmHDUUtils.h
     2 * @brief Utility functions for working with an HDU
     3 *
     4 * @author Paul Price, IfA
     5 *
     6 * @version $Revision: 1.8 $ $Name: not supported by cvs2svn $
     7 * @date $Date: 2007-01-24 02:54:14 $
     8 * Copyright 2005-2006 Institute for Astronomy, University of Hawaii
     9 */
    1410
    1511#ifndef PM_HDU_UTILS_H
    1612#define PM_HDU_UTILS_H
     13
     14/// @addtogroup Camera Camera Layout
     15/// @{
    1716
    1817#include "pmFPA.h"
    … …  
    5958                bool header             ///< Print header?
    6059               );
    61 
     60/// @}
    6261#endif

  • trunk/psModules/src/concepts/pmConcepts.h

    r10967 r11253  
    1 /// @file pmConcepts.h
    2 ///
    3 /// @brief Top-level functions for defining, registering, reading and writing concepts
    4 ///
    5 /// @ingroup Concepts
    6 ///
    7 /// @author Paul Price, IfA
    8 ///
    9 /// @version $Revision: 1.10 $ $Name: not supported by cvs2svn $
    10 /// @date $Date: 2007-01-08 22:31:41 $
    11 ///
    12 /// Copyright 2005-2006 Institute for Astronomy, University of Hawaii
    13 ///
     1/* @file pmConcepts.h
     2 * @brief Top-level functions for defining, registering, reading and writing concepts
     3 *
     4 * @author Paul Price, IfA
     5 *
     6 * @version $Revision: 1.11 $ $Name: not supported by cvs2svn $
     7 * @date $Date: 2007-01-24 02:54:14 $
     8 * Copyright 2005-2006 Institute for Astronomy, University of Hawaii
     9 */
    1410
    1511#ifndef PM_CONCEPTS_H
    1612#define PM_CONCEPTS_H
     13
     14/// @addtogroup Concepts Data Abstraction Concepts
     15/// @{
    1716
    1817#include <pslib.h>
    … …  
    3635        const pmCell *cell ///< Cell for concept, or NULL
    3736                                              );
    38 
    3937
    4038/// A "concept" specification
    … …  
    193191                       const pmFPA *source    ///< The source FPA
    194192                      );
    195 
    196 
     193/// @}
    197194#endif

  • trunk/psModules/src/concepts/pmConceptsAverage.h

    r9581 r11253  
    1 /// @file pmConceptsAverage.h
    2 ///
    3 /// @brief Average the values of multiple concepts
    4 ///
    5 /// @ingroup Concepts
    6 ///
    7 /// @author Paul Price, IfA
    8 ///
    9 /// @version $Revision: 1.4 $ $Name: not supported by cvs2svn $
    10 /// @date $Date: 2006-10-16 22:03:56 $
    11 ///
    12 /// Copyright 2005-2006 Institute for Astronomy, University of Hawaii
    13 ///
     1/* @file pmConceptsAverage.h
     2 * @brief Average the values of multiple concepts
     3 *
     4 * @author Paul Price, IfA
     5 *
     6 * @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
     7 * @date $Date: 2007-01-24 02:54:14 $
     8 * Copyright 2005-2006 Institute for Astronomy, University of Hawaii
     9 */
    1410
    1511#ifndef PM_CONCEPTS_AVERAGE_H
    1612#define PM_CONCEPTS_AVERAGE_H
     13
     14/// @addtogroup Concepts Data Abstraction Concepts
     15/// @{
    1716
    1817#include <pslib.h>
    … …  
    4140                           );
    4241
     42/// @}
    4343#endif

  • trunk/psModules/src/concepts/pmConceptsPhotcode.h

    r11251 r11253  
    1 /*  @file  pmConceptsPhotcode.h
    2  *  @brief Generate a photcode from the concepts
    3  * 
    4  *  @author Eugene Magnier, IfA
    5  * 
    6  *  @version $Revision: 1.6 $ $Name: not supported by cvs2svn $
    7  *  @date $Date: 2007-01-24 01:05:41 $
    8  *  Copyright 2005-2006 Institute for Astronomy, University of Hawaii
     1/* @file  pmConceptsPhotcode.h
     2 * @brief Generate a photcode from the concepts
     3 *
     4 * @author Eugene Magnier, IfA
     5 *
     6 * @version $Revision: 1.7 $ $Name: not supported by cvs2svn $
     7 * @date $Date: 2007-01-24 02:54:14 $
     8 * Copyright 2005-2006 Institute for Astronomy, University of Hawaii
    99 */
    1010

  • trunk/psModules/src/concepts/pmConceptsRead.h

    r9581 r11253  
    1 /// @file  pmConceptsRead.h
    2 ///
    3 /// @brief Reading concepts from a variety of sources.
    4 ///
    5 /// @ingroup Concepts
    6 ///
    7 /// @author Paul Price, IfA
    8 ///
    9 /// @version $Revision: 1.4 $ $Name: not supported by cvs2svn $
    10 /// @date $Date: 2006-10-16 22:03:56 $
    11 ///
    12 /// Copyright 2005-2006 Institute for Astronomy, University of Hawaii
    13 ///
     1/* @file  pmConceptsRead.h
     2 * @brief Reading concepts from a variety of sources.
     3 *
     4 * @author Paul Price, IfA
     5 *
     6 * @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
     7 * @date $Date: 2007-01-24 02:54:14 $
     8 * Copyright 2005-2006 Institute for Astronomy, University of Hawaii
     9 */
    1410
    1511#ifndef PM_CONCEPTS_READ_H
    … …  
    6460                                  psDB *db // The database handle
    6561                                 );
    66 
     62/// @}
    6763#endif

  • trunk/psModules/src/concepts/pmConceptsStandard.h

    r11132 r11253  
    1 /// @file  pmConceptsStandard.h
    2 ///
    3 /// @brief Private functions for parsing and formatting standard concepts.
    4 ///
    5 /// @ingroup Concepts
    6 ///
    7 /// @author Paul Price, IfA
    8 ///
    9 /// @version $Revision: 1.7 $ $Name: not supported by cvs2svn $
    10 /// @date $Date: 2007-01-18 03:14:09 $
    11 ///
    12 /// Copyright 2005-2006 Institute for Astronomy, University of Hawaii
    13 ///
     1/* @file  pmConceptsStandard.h
     2 * @brief Private functions for parsing and formatting standard concepts.
     3 *
     4 * @author Paul Price, IfA
     5 *
     6 * @version $Revision: 1.8 $ $Name: not supported by cvs2svn $
     7 * @date $Date: 2007-01-24 02:54:15 $
     8 * Copyright 2005-2006 Institute for Astronomy, University of Hawaii
     9 */
    1410
    1511#ifndef PM_CONCEPTS_STANDARD_H
    1612#define PM_CONCEPTS_STANDARD_H
    1713
     14/// @addtogroup Concepts Data Abstraction Concepts
     15/// @{
     16
    1817#include <pslib.h>
    1918#include "pmFPA.h"
    20 
    21 // Functions to parse and format the standard concepts
    22 
    2319
    2420/// Parse the FPA.FILTER concept to apply a lookup table
    … …  
    165161        const pmCell *cell ///< Cell for concept, or NULL
    166162                                           );
    167 
     163/// @}
    168164#endif

  • trunk/psModules/src/concepts/pmConceptsWrite.h

    r9581 r11253  
    1 /// @file  pmConceptsWrite.h
    2 ///
    3 /// @brief Writing concepts to a variety of sources.
    4 ///
    5 /// @ingroup Concepts
    6 ///
    7 /// @author Paul Price, IfA
    8 ///
    9 /// @version $Revision: 1.4 $ $Name: not supported by cvs2svn $
    10 /// @date $Date: 2006-10-16 22:03:56 $
    11 ///
    12 /// Copyright 2005-2006 Institute for Astronomy, University of Hawaii
    13 ///
     1/* @file  pmConceptsWrite.h
     2 * @brief Writing concepts to a variety of sources.
     3 *
     4 * @author Paul Price, IfA
     5 *
     6 * @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
     7 * @date $Date: 2007-01-24 02:54:15 $
     8 * Copyright 2005-2006 Institute for Astronomy, University of Hawaii
     9 */
    1410
    1511#ifndef PM_CONCEPTS_WRITE_H
    1612#define PM_CONCEPTS_WRITE_H
     13
     14/// @addtogroup Concepts Data Abstraction Concepts
     15/// @{
    1716
    1817#include <pslib.h>
    … …  
    6261                                 const psMetadata *concepts ///< The concepts
    6362                                );
    64 
     63/// @}
    6564#endif

  • trunk/psModules/src/config/Makefile.am

    r11250 r11253  
    1717    pmErrorCodes.h
    1818
    19 CLEANFILES = *~
    20 
    2119# Error codes.
    2220BUILT_SOURCES = pmErrorCodes.h pmErrorCodes.c
    23 CLEANFILES = pmErrorCodes.h pmErrorCodes.c
     21CLEANFILES = *~ pmErrorCodes.h pmErrorCodes.c
    2422
    2523pmErrorCodes.h : pmErrorCodes.dat pmErrorCodes.h.in

  • trunk/psModules/src/detrend/pmBias.h

    r10302 r11253  
    1 /// @file pmBias.h
    2 ///
    3 /// @brief Subtract the overscan, bias and dark
    4 ///
    5 /// @ingroup Detrend
    6 ///
    7 /// @author George Gusciora, MHPCC
    8 /// @author Paul Price, IfA
    9 ///
    10 /// @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
    11 /// @date $Date: 2006-11-30 01:03:06 $
    12 ///
    13 /// Copyright 2004--2006 Institute for Astronomy, University of Hawaii
    14 ///
     1/* @file pmBias.h
     2 * @brief Subtract the overscan, bias and dark
     3 *
     4 * @author George Gusciora, MHPCC
     5 * @author Paul Price, IfA
     6 *
     7 * @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
     8 * @date $Date: 2007-01-24 02:54:15 $
     9 * Copyright 2004--2006 Institute for Astronomy, University of Hawaii
     10 */
    1511
    1612#ifndef PM__BIAS_H
    1713#define PM__BIAS_H
     14
     15/// @addtogroup detrend Detrend Creation and Application
     16/// @{
    1817
    1918#include <pslib.h>
    … …  
    6665                   );
    6766
     67/// @}
    6868#endif

  • trunk/psModules/src/detrend/pmDetrendDB.h

    r9854 r11253  
    1 /** @file  pmDetrendDB.h
    2 *
    3 *  @brief Tools to query the detrend database system
    4 *
    5 *  the functions in here do not perform the detrend database queries directly.  all interfaces
    6 *  to the detrend database go through the external dettools functions.  this allows the modules
    7 *  and directly dependent program to be sufficiently independent of the database schema that it
    8 *  can be used with any properly defined detrend database tables.
    9 *
    10 *  XXX place the specific name of the detrend database query command in the configuration data
    11 *
    12 *  @ingroup Detrend
    13 *
    14 *  @author EAM, IfA
    15 *
    16 *  @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
    17 *  @date $Date: 2006-11-04 02:34:01 $
    18 *
    19 *  Copyright 2004-2005 Institute for Astronomy, University of Hawaii
    20 */
     1/* @file  pmDetrendDB.h
     2 * @brief Tools to query the detrend database system
     3 *
     4 * the functions in here do not perform the detrend database queries directly.  all interfaces
     5 * to the detrend database go through the external dettools functions.  this allows the modules
     6 * and directly dependent program to be sufficiently independent of the database schema that it
     7 * can be used with any properly defined detrend database tables.
     8 *
     9 * @author EAM, IfA
     10 *
     11 * @version $Revision: 1.6 $ $Name: not supported by cvs2svn $
     12 * @date $Date: 2007-01-24 02:54:15 $
     13 * Copyright 2004-2005 Institute for Astronomy, University of Hawaii
     14 */
    2115
    2216#ifndef PM_DETREND_DB_H
    2317#define PM_DETREND_DB_H
     18
     19/// @addtogroup detrend Detrend Creation and Application
     20/// @{
    2421
    2522#include "pmFPALevel.h"
    … …  
    6966char *pmDetrendFile (const char *detID, const char *classID);
    7067
     68/// @}
    7169# endif

  • trunk/psModules/src/detrend/pmFlatField.h

    r9724 r11253  
    1 /// @file pmFlatField.h
    2 ///
    3 /// @brief Apply flat field calibration
    4 ///
    5 /// @ingroup Detrend
    6 ///
    7 /// @author Ross Harman, MHPCC
    8 /// @author Paul Price, IfA
    9 ///
    10 /// @version $Revision: 1.7 $ $Name: not supported by cvs2svn $
    11 /// @date $Date: 2006-10-24 03:48:42 $
    12 ///
    13 /// Copyright 2004-2006 Institute for Astronomy, University of Hawaii
    14 ///
     1/* @file pmFlatField.h
     2 * @brief Apply flat field calibration
     3 *
     4 * @author Ross Harman, MHPCC
     5 * @author Paul Price, IfA
     6 *
     7 * @version $Revision: 1.8 $ $Name: not supported by cvs2svn $
     8 * @date $Date: 2007-01-24 02:54:15 $
     9 * Copyright 2004-2006 Institute for Astronomy, University of Hawaii
     10 */
    1511
    1612#ifndef PM_FLAT_FIELD_H
    1713#define PM_FLAT_FIELD_H
     14
     15/// @addtogroup detrend Detrend Creation and Application
     16/// @{
    1817
    1918#include "pmFPA.h"
    … …  
    2928                 const pmReadout *flat  ///< Readout with flat image
    3029                );
    31 
    32 
     30/// @}
    3331#endif

  • trunk/psModules/src/detrend/pmFlatNormalize.h

    r9614 r11253  
    1 /// @file pmFlatNormalize.h
    2 ///
    3 /// @brief Normalize flat-field measurements
    4 ///
    5 /// @ingroup Detrend
    6 ///
    7 /// @author Paul Price, IfA
    8 ///
    9 /// @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
    10 /// @date $Date: 2006-10-17 20:49:10 $
    11 ///
    12 /// Copyright 2004-2006 Institute for Astronomy, University of Hawaii
    13 ///
     1/* @file pmFlatNormalize.h
     2 * @brief Normalize flat-field measurements
     3 *
     4 * @author Paul Price, IfA
     5 *
     6 * @version $Revision: 1.6 $ $Name: not supported by cvs2svn $
     7 * @date $Date: 2007-01-24 02:54:15 $
     8 * Copyright 2004-2006 Institute for Astronomy, University of Hawaii
     9 */
    1410
    1511#ifndef PM_FLAT_NORMALIZE_H
    1612#define PM_FLAT_NORMALIZE_H
    1713
     14/// @addtogroup detrend Detrend Creation and Application
     15/// @{
     16
    1817#include <pslib.h>
    1918
    20 /// Normalise flat-field measurements
     19/// Normalize flat-field measurements
    2120///
    2221/// We have f_ij = g_i s_j where f_ij is the flux recorded for chip i and integration j, g_i is the gain for
    … …  
    3130                    );
    3231
     32/// @}
    3333#endif

  • trunk/psModules/src/detrend/pmFringeStats.h

    r9951 r11253  
    1 /// @file pmFringeStats.h
    2 ///
    3 /// @brief Measure fringe statistics, and apply correction
    4 ///
    5 /// @ingroup Detrend
    6 ///
    7 /// @author Eugene Magnier, IfA
    8 /// @author Paul Price, IfA
    9 ///
    10 /// @version $Revision: 1.11 $ $Name: not supported by cvs2svn $
    11 /// @date $Date: 2006-11-13 22:19:52 $
    12 ///
    13 /// Copyright 2004-2006 Institute for Astronomy, University of Hawaii
    14 ///
     1/* @file pmFringeStats.h
     2 * @brief Measure fringe statistics, and apply correction
     3 *
     4 * @author Eugene Magnier, IfA
     5 * @author Paul Price, IfA
     6 *
     7 * @version $Revision: 1.12 $ $Name: not supported by cvs2svn $
     8 * @date $Date: 2007-01-24 02:54:15 $
     9 * Copyright 2004-2006 Institute for Astronomy, University of Hawaii
     10 */
    1511
    1612#ifndef PM_FRINGE_STATS
    1713#define PM_FRINGE_STATS
     14
     15/// @addtogroup detrend Detrend Creation and Application
     16/// @{
    1817
    1918//////////////////////////////////////////////////////////////////////////////////////////////////////////////
    … …  
    212211                         float keepFrac ///< Minimum fraction of regions to keep, for pmFringeScaleMeasure
    213212                        );
    214 
    215 
     213/// @}
    216214#endif

  • trunk/psModules/src/detrend/pmMaskBadPixels.h

    r10026 r11253  
    1 /// @file pmMaskBadPixels.h
    2 ///
    3 /// @brief Mask bad pixels
    4 ///
    5 /// @ingroup Detrend
    6 ///
    7 /// @author Ross Harman, MHPCC
    8 /// @author Eugene Magnier, IfA
    9 ///
    10 /// @version $Revision: 1.11 $ $Name: not supported by cvs2svn $
    11 /// @date $Date: 2006-11-17 01:17:59 $
    12 ///
    13 /// Copyright 2004 Institute for Astronomy, University of Hawaii
    14 ///
     1/* @file pmMaskBadPixels.h
     2 * @brief Mask bad pixels
     3 *
     4 * @author Ross Harman, MHPCC
     5 * @author Eugene Magnier, IfA
     6 *
     7 * @version $Revision: 1.12 $ $Name: not supported by cvs2svn $
     8 * @date $Date: 2007-01-24 02:54:15 $
     9 * Copyright 2004 Institute for Astronomy, University of Hawaii
     10 */
    1511
    1612#ifndef PM_MASK_BAD_PIXELS_H
    1713#define PM_MASK_BAD_PIXELS_H
     14
     15/// @addtogroup detrend Detrend Creation and Application
     16/// @{
    1817
    1918#include <pslib.h>
    … …  
    5655                                 psMaskType maskVal ///< Value to set for bad pixels
    5756                                );
    58 
    59 
    60 
    61 
     57/// @}
    6258#endif

  • trunk/psModules/src/detrend/pmNonLinear.h

    r9617 r11253  
    1 /// @file pmNonLinear.h
    2 ///
    3 /// @brief Perform non-linear correction through polynomial or table lookup
    4 ///
    5 /// @ingroup Detrend
    6 ///
    7 /// @author George Gusciora, MHPCC
    8 /// @author Paul Price, IfA
    9 ///
    10 /// @version $Revision: 1.4 $ $Name: not supported by cvs2svn $
    11 /// @date $Date: 2006-10-17 22:57:27 $
    12 ///
    13 /// Copyright 2004 Institute for Astronomy, University of Hawaii
    14 ///
     1/* @file pmNonLinear.h
     2 * @brief Perform non-linear correction through polynomial or table lookup
     3 *
     4 * @author George Gusciora, MHPCC
     5 * @author Paul Price, IfA
     6 *
     7 * @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
     8 * @date $Date: 2007-01-24 02:54:15 $
     9 * Copyright 2004 Institute for Astronomy, University of Hawaii
     10 */
    1511
    1612#ifndef PM_NON_LINEAR_H
    1713#define PM_NON_LINEAR_H
     14
     15/// @addtogroup detrend Detrend Creation and Application
     16/// @{
    1817
    1918#include <pslib.h>
    … …  
    3635                               );
    3736
     37/// @}
    3838#endif

  • trunk/psModules/src/detrend/pmShutterCorrection.h

    r9984 r11253  
    1 /// @file pmShutterCorrection.h
    2 ///
    3 /// @brief Functions to build and apply a shutter exposure-time correction.
    4 ///
    5 /// @ingroup Detrend
    6 ///
    7 /// @author Eugene Magnier, IfA
    8 /// @author Paul Price, IfA
    9 ///
    10 /// @version $Revision: 1.10 $ $Name: not supported by cvs2svn $
    11 /// @date $Date: 2006-11-15 00:40:49 $
    12 ///
    13 /// Copyright 2006 Institute for Astronomy, University of Hawaii
    14 ///
    15 
    16 
    17 /// A mechanical shutter may not yield uniform exposure times as a function of
    18 /// position on the detector.  The typical error consists of a constant
    19 /// exposure-time offset relative to the requested value, ie exposure time is
    20 /// T_o + dT(x,y).  The exposure error, dT, may be measured with the following
    21 /// scheme.  Obtain a set of exposures with different exposures times taken of
    22 /// the same flat-field source; the source must be spatially stable between the
    23 /// exposures, but need not have a stable amplitude.  For an illuminating flux
    24 /// of intensity F(x,y) = F_o f(x,y), the signal recorded by any pixel in the
    25 /// detector is given by: S(t,x,y) = F_o(t) f(x,y) (T_o + dT(x,y)) where F_o is
    26 /// the F_o(t) is the (variable) overall intensity of the illuminating source
    27 /// and f(x,y) is the spatial illumination patter times the flat-field response.
    28 /// Choose a reference location in the image (eg, the detector center) and
    29 /// divide by the value of that region (ie, mean or median):
    30 ///
    31 /// s(t,x,y) = S(t,x,y) / S(t,0,0)
    32 /// s(t,x,y) = F_o(t) f(x,y) (T_o + dT(x,y)) / F_o(t) f(0,0) (T_o + dT(0,0))
    33 /// s(t,x,y) = f(x,y) (T_o + dT(x,y)) / f(0,0) (T_o + dT(0,0))
    34 ///
    35 /// we can absorb the term f(0,0) into f(x,y) as we have no motivation for the
    36 /// scale of f(x,y).  For any single pixel, over the set of exposures, we thus
    37 /// need to solve for dT(x,y), dT(0,0), and f'(x,y) in the equation:
    38 /// s(t,x,y) = f'(x,y) (T_o + dT(x,y)) / (T_o + dT(0,0))
    39 ///
    40 /// we avoid directly fitting these values as the process would be a non-linear
    41 /// least-squares problem for every pixel in the image, and thus very time
    42 /// consuming.  There are linear options which may be used instead.
    43 /// First, as T_o goes to a large value, s() approaches the value of f'(x,y).
    44 /// Next, as T_o goes to a very small value, s() approaches the value of
    45 /// f'(x,y)*dT(x,y)/dT(0,0).  Finally, when s() has the value of
    46 /// f'(x,y)*(1 + dT(x,y)/dT(0,0))/2, T_o has the value of dT(0,0).  with data
    47 /// points covering a reasonable dynamic range, we can solve for these three
    48 /// values by interpolation and/or extrapolation.
    49 ///
    50 /// To take the strategy one step further, we could use the above recipe to
    51 /// obtain a guess for the three parameters and then apply non-linear fitting to
    52 /// solve more accurately for the parameters.  If we limit this operation to a
    53 /// handful of positions in the image (user defined, but the obvious choice would
    54 /// be positions near the center, edges, and corners), then we may determine a
    55 /// good value for dT(0,0).  Since there is only one dT(0,0) for the image, we
    56 /// can apply the resulting measurement to the rest of the pixels in the image.
    57 /// If dT(0,0) is not a free parameter, then the fitting process is linear in
    58 /// terms of dT(x,y) and f'(x,y)
     1/* @file pmShutterCorrection.h
     2 * @brief Functions to build and apply a shutter exposure-time correction.
     3 *
     4 * @author Eugene Magnier, IfA
     5 * @author Paul Price, IfA
     6 *
     7 * @version $Revision: 1.11 $ $Name: not supported by cvs2svn $
     8 * @date $Date: 2007-01-24 02:54:15 $
     9 * Copyright 2006 Institute for Astronomy, University of Hawaii
     10 */
    5911
    6012#ifndef PM_SHUTTER_CORRECTION_H
    6113#define PM_SHUTTER_CORRECTION_H
     14
     15/// @addtogroup detrend Detrend Creation and Application
     16/// @{
     17
     18/*  A mechanical shutter may not yield uniform exposure times as a function of
     19 *  position on the detector.  The typical error consists of a constant
     20 *  exposure-time offset relative to the requested value, ie exposure time is
     21 *  T_o + dT(x,y).  The exposure error, dT, may be measured with the following
     22 *  scheme.  Obtain a set of exposures with different exposures times taken of
     23 *  the same flat-field source; the source must be spatially stable between the
     24 *  exposures, but need not have a stable amplitude.  For an illuminating flux
     25 *  of intensity F(x,y) = F_o f(x,y), the signal recorded by any pixel in the
     26 *  detector is given by: S(t,x,y) = F_o(t) f(x,y) (T_o + dT(x,y)) where F_o is
     27 *  the F_o(t) is the (variable) overall intensity of the illuminating source
     28 *  and f(x,y) is the spatial illumination patter times the flat-field response.
     29 *  Choose a reference location in the image (eg, the detector center) and
     30 *  divide by the value of that region (ie, mean or median):
     31 *
     32 *  s(t,x,y) = S(t,x,y) / S(t,0,0)
     33 *  s(t,x,y) = F_o(t) f(x,y) (T_o + dT(x,y)) / F_o(t) f(0,0) (T_o + dT(0,0))
     34 *  s(t,x,y) = f(x,y) (T_o + dT(x,y)) / f(0,0) (T_o + dT(0,0))
     35 *
     36 *  we can absorb the term f(0,0) into f(x,y) as we have no motivation for the
     37 *  scale of f(x,y).  For any single pixel, over the set of exposures, we thus
     38 *  need to solve for dT(x,y), dT(0,0), and f'(x,y) in the equation:
     39 *  s(t,x,y) = f'(x,y) (T_o + dT(x,y)) / (T_o + dT(0,0))
     40 *
     41 *  we avoid directly fitting these values as the process would be a non-linear
     42 *  least-squares problem for every pixel in the image, and thus very time
     43 *  consuming.  There are linear options which may be used instead.
     44 *  First, as T_o goes to a large value, s() approaches the value of f'(x,y).
     45 *  Next, as T_o goes to a very small value, s() approaches the value of
     46 *  f'(x,y)*dT(x,y)/dT(0,0).  Finally, when s() has the value of
     47 *  f'(x,y)*(1 + dT(x,y)/dT(0,0))/2, T_o has the value of dT(0,0).  with data
     48 *  points covering a reasonable dynamic range, we can solve for these three
     49 *  values by interpolation and/or extrapolation.
     50 *
     51 *  To take the strategy one step further, we could use the above recipe to
     52 *  obtain a guess for the three parameters and then apply non-linear fitting to
     53 *  solve more accurately for the parameters.  If we limit this operation to a
     54 *  handful of positions in the image (user defined, but the obvious choice would
     55 *  be positions near the center, edges, and corners), then we may determine a
     56 *  good value for dT(0,0).  Since there is only one dT(0,0) for the image, we
     57 *  can apply the resulting measurement to the rest of the pixels in the image.
     58 *  If dT(0,0) is not a free parameter, then the fitting process is linear in
     59 *  terms of dT(x,y) and f'(x,y)
     60 */
    6261
    6362#include <pslib.h>
    … …  
    130129                             );
    131130
     131/// @}
    132132#endif

  • trunk/psModules/src/detrend/pmSkySubtract.h

    r10299 r11253  
    1 /** @file  pmSubtractSky.h
     1/* @file  pmSubtractSky.h
    22 *
    3  *  This file will contain a module which will create a model of the
    4  *  background sky and subtract that from the input image.
     3 * This file will contain a module which will create a model of the
     4 * background sky and subtract that from the input image.
    55 *
    6  *  @author GLG, MHPCC
     6 * @author GLG, MHPCC
    77 *
    8  *  @version $Revision: 1.1 $ $Name: not supported by cvs2svn $
    9  *  @date $Date: 2006-11-30 00:52:21 $
    10  *
    11  *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    12  *
     8 * @version $Revision: 1.2 $ $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_SUBTRACT_SKY_H
    1614#define PM_SUBTRACT_SKY_H
     15
     16/// @addtogroup detrend Detrend Creation and Application
     17/// @{
    1718
    1819#include<stdio.h>
    … …  
    3435                         psStats *stats,
    3536                         float clipSD);
     37
     38/// @}
    3639#endif

  • trunk/psModules/src/extras/pmKapaPlots.c

    r10866 r11253  
    77 *  @author EAM, IfA
    88 *
    9  *  @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
    10  *  @date $Date: 2007-01-01 21:03:41 $
     9 *  @version $Revision: 1.6 $ $Name: not supported by cvs2svn $
     10 *  @date $Date: 2007-01-24 02:54:15 $
    1111 *
    1212 *  Copyright 2006 Institute for Astronomy, University of Hawaii
    … …  
    148148    # include "pmKapaPlots.h"
    149149
    150     int pmKapaOpen ()
     150    int pmKapaOpen (bool showWindow)
    151151{
    152152    return -1;

  • trunk/psModules/src/extras/pmKapaPlots.h

    r10866 r11253  
    1 /** @file  pmKapaPlots.h
    2 *
    3 *  @brief functions to make plots with the external program 'kapa'
    4 *
    5 *  @ingroup extras
    6 *
    7 *  @author EAM, IfA
    8 *
    9 *  @version $Revision: 1.4 $ $Name: not supported by cvs2svn $
    10 *  @date $Date: 2007-01-01 21:03:41 $
    11 *
    12 *  Copyright 2006 Institute for Astronomy, University of Hawaii
    13 */
     1/* @file  pmKapaPlots.h
     2 * @brief functions to make plots with the external program 'kapa'
     3 *
     4 * @author EAM, IfA
     5 *
     6 * @version $Revision: 1.5 $ $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_KAPA_PLOTS_H
    1612#define PM_KAPA_PLOTS_H
     13
     14/// @addtogroup Extras Miscellaneous Funtions
     15/// @{
    1716
    1817// move to psLib or psModules
    … …  
    3130# endif
    3231
     32/// @}
    3333#endif // PM_KAPA_PLOTS_H

  • trunk/psModules/src/extras/psIOBuffer.h

    r10610 r11253  
    1 /** @file  psPipe.h
    2 *
    3 *  @brief 3-stream pipe
    4 *
    5 *  @ingroup misc
    6 *
    7 *  @author EAM, IfA
    8 *
    9 *  @version $Revision: 1.1 $ $Name: not supported by cvs2svn $
    10 *  @date $Date: 2006-12-10 18:27:26 $
    11 *
    12 *  Copyright 2004-2005 Institute for Astronomy, University of Hawaii
    13 */
     1/* @file  IOBuffer.h
     2 * @brief input/output character buffer
     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 2004-2005 Institute for Astronomy, University of Hawaii
     9 */
    1410
    1511#ifndef PS_IO_BUFFER_H
    1612#define PS_IO_BUFFER_H
     13
     14/// @addtogroup Extras Miscellaneous Funtions
     15/// @{
    1716
    1817typedef struct
    … …  
    3231int psIOBufferReadEmpty (psIOBuffer *buffer, int maxRetries, int fd);
    3332
     33/// @}
    3434# endif

  • trunk/psModules/src/extras/psPipe.h

    r10610 r11253  
    1 /** @file  psPipe.h
    2 *
    3 *  @brief 3-stream pipe
    4 *
    5 *  @ingroup misc
    6 *
    7 *  @author EAM, IfA
    8 *
    9 *  @version $Revision: 1.1 $ $Name: not supported by cvs2svn $
    10 *  @date $Date: 2006-12-10 18:27:26 $
    11 *
    12 *  Copyright 2004-2005 Institute for Astronomy, University of Hawaii
    13 */
     1/* @file  psPipe.h
     2 * @brief 3-stream pipe
     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 2004-2005 Institute for Astronomy, University of Hawaii
     9 */
    1410
    1511#ifndef PS_PIPE_H
    1612#define PS_PIPE_H
     13
     14/// @addtogroup Extras Miscellaneous Funtions
     15/// @{
    1716
    1817// move these to pslib??
    … …  
    3130int     psPipeClose (psPipe *pipe);
    3231
     32/// @}
    3333# endif

  • trunk/psModules/src/extras/psVectorBracket.h

    r10610 r11253  
     1/* @file  psVectorBracket.h
     2 * @brief vector bracket functions
     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 2004-2005 Institute for Astronomy, University of Hawaii
     9 */
    110
    211# ifndef PS_VECTOR_BRACKET_H
    312# define PS_VECTOR_BRACKET_H
     13
     14/// @addtogroup Extras Miscellaneous Funtions
     15/// @{
    416
    517int psVectorBracket(const psVector *index, psF32 key, bool above);
    … …  
    719psF32 psVectorInterpolate(const psVector *index, const psVector *value, psF32 key);
    820
     21/// @}
    922# endif /* PS_VECTOR_BRACKET_H */

  • trunk/psModules/src/imcombine/pmImageCombine.h

    r11115 r11253  
    1 /** @file  pmImageCombine.h
     1/* @file  pmImageCombine.h
    22 *
    3  *  This file will perform image combination of several images of the
    4  *  same field, produce a list of questionable pixels, then tag some
    5  *  of those pixels as cosmic rays.
     3 * This file will perform image combination of several images of the
     4 * same field, produce a list of questionable pixels, then tag some
     5 * of those pixels as cosmic rays.
    66 *
    7  *  @author Paul Price, IfA (original prototype)
    8  *  @author GLG, MHPCC
     7 * @author Paul Price, IfA (original prototype)
     8 * @author GLG, MHPCC
    99 *
    10  *  @version $Revision: 1.4 $ $Name: not supported by cvs2svn $
    11  *  @date $Date: 2007-01-16 23:51:51 $
    12  *
    13  *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    14  *
     10 * @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
     11 * @date $Date: 2007-01-24 02:54:15 $
     12 * Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    1513 */
    1614
    1715#ifndef PM_IMAGE_COMBINE_H
    1816#define PM_IMAGE_COMBINE_H
     17
     18/// @addtogroup imcombine Image Combinations
     19/// @{
    1920
    2021#include <stdio.h>
    … …  
    4344    psF32 gradLimit                     ///< Gradient limit
    4445);
     46
     47/// @}
    4548#endif

  • trunk/psModules/src/imcombine/pmImageSubtract.h

    r9621 r11253  
    1 /** @file  ImageSubtract.h
     1/* @file  ImageSubtract.h
    22 *
    3  *  This file will contain code which creates a set of kernel basis
    4  *  functions, solves for their solution, and applies them to an image.
     3 * This file will contain code which creates a set of kernel basis
     4 * functions, solves for their solution, and applies them to an image.
    55 *
    6  *  @author Paul Price, IfA (original prototype)
    7  *  @author GLG, MHPCC
     6 * @author Paul Price, IfA (original prototype)
     7 * @author GLG, MHPCC
    88 *
    9  *  @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
    10  *  @date $Date: 2006-10-18 02:29:15 $
    11  *
    12  *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    13  *
     9 * @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
     10 * @date $Date: 2007-01-24 02:54:15 $
     11 * Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    1412 */
    1513
    1614#ifndef PM_IMAGE_COMBINE_H
    1715#define PM_IMAGE_COMBINE_H
     16
     17/// @addtogroup imcombine Image Combinations
     18/// @{
    1819
    1920#include <stdio.h>
    … …  
    120121);
    121122
     123/// @}
    122124#endif

  • trunk/psModules/src/imcombine/pmReadoutCombine.h

    r10250 r11253  
    1 /// @file  pmReadoutCombine.h
    2 ///
    3 /// @brief Combine multiple readouts
    4 ///
    5 /// @ingroup Image combination
    6 ///
    7 /// @author George Gusciora, MHPCC
    8 /// @author Paul Price, IfA
    9 ///
    10 /// @version $Revision: 1.9 $ $Name: not supported by cvs2svn $
    11 /// @date $Date: 2006-11-29 01:27:03 $
    12 ///
    13 /// Copyright 2004-2006 Institute for Astronomy, University of Hawaii
    14 ///
    15 ///
     1/* @file  pmReadoutCombine.h
     2 * @brief Combine multiple readouts
     3 *
     4 * @author George Gusciora, MHPCC
     5 * @author Paul Price, IfA
     6 *
     7 * @version $Revision: 1.10 $ $Name: not supported by cvs2svn $
     8 * @date $Date: 2007-01-24 02:54:15 $
     9 * Copyright 2004-2006 Institute for Astronomy, University of Hawaii
     10 */
    1611
    1712#ifndef PM_READOUT_COMBINE_H
    1813#define PM_READOUT_COMBINE_H
     14
     15/// @addtogroup imcombine Image Combinations
     16/// @{
    1917
    2018#include <pslib.h>
    … …  
    5048                     );
    5149
     50/// @}
    5251#endif

  • 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.