Index: /trunk/psModules/Makefile.am =================================================================== --- /trunk/psModules/Makefile.am (revision 11252) +++ /trunk/psModules/Makefile.am (revision 11253) @@ -12,23 +12,15 @@ autogen.sh -if DOXYGEN +if HAVE_DOXYGEN +install-data-hook: doxygen + -$(mkdir_p) $(mandir)/man3 + chmod 0755 $(mandir)/man3 + -cp $(top_builddir)/docs/man/man3/* $(mandir)/man3 -docs: Doxyfile $(prefix)/docs/psmodules $(mandir)/man3 - doxygen Doxyfile - mv -f $(prefix)/docs/psmodules/man/man3/* $(mandir)/man3 - rm -rf $(prefix)/docs/psmodules/man - -$(prefix)/docs/psmodules: - mkdir -p $(prefix)/docs/psmodules - -$(mandir)/man3: - mkdir -p $(mandir)/man3 - -uninstall-hook: - rm -rf $(prefix)/docs/psmodules/* +doxygen: + $(DOXYGEN) +endif CLEANFILES = $(prefix)/docs/psmodules/* *~ -endif - test: check Index: /trunk/psModules/configure.ac =================================================================== --- /trunk/psModules/configure.ac (revision 11252) +++ /trunk/psModules/configure.ac (revision 11253) @@ -96,7 +96,28 @@ dnl doxygen ------------------------------------------------------------------- - -AC_CHECK_PROG([doxygen], [doxygen], [true], [false]) -AM_CONDITIONAL(DOXYGEN, test x$doxygen = xtrue) +dnl doxygen doc generation is very, very slow so we're turing it off by default + +dnl save LIBS/CFLAGS/LDFLAGS +TMP_LIBS=${LIBS} +TMP_CFLAGS=${CFLAGS} +TMP_LDFLAGS=${LDFLAGS} +TMP_CPPFLAGS=${CPPFLAGS} + +AC_ARG_ENABLE(doxygen, + [AS_HELP_STRING(--enable-doxygen ,enable manpage generation)], + [AC_MSG_RESULT(doxygen enabled) + AC_PATH_PROG([DOXYGEN], [doxygen], []) + ], + [AC_MSG_RESULT([doxygen disabled]) + doxygen=off + ] +) +AM_CONDITIONAL([HAVE_DOXYGEN], test -n "$DOXYGEN" -a "x$doxygen" != "xoff") + +dnl restore the CFLAGS/LDFLAGS +LIBS=${TMP_LIBS} +CFLAGS=${TMP_CFLAGS} +LDFLAGS=${TMP_LDFLAGS} +CPPFLAGS=${TMP_CPPFLAGS} dnl ------------------------------------------------------------ Index: /trunk/psModules/src/astrom/pmAstrometryDistortion.h =================================================================== --- /trunk/psModules/src/astrom/pmAstrometryDistortion.h (revision 11252) +++ /trunk/psModules/src/astrom/pmAstrometryDistortion.h (revision 11253) @@ -1,18 +1,17 @@ -/** @file pmAstrometryDistortion.h -* -* @brief This file defines the basic types for measuring and fitting the focal-plane distortion. -* -* @ingroup AstroImage -* -* @author EAM, IfA -* -* @version $Revision: 1.1 $ $Name: not supported by cvs2svn $ -* @date $Date: 2006-05-19 15:39:53 $ -* -* Copyright 2006 Institute for Astronomy, University of Hawaii -*/ +/* @file pmAstrometryDistortion.h + * @brief This file defines the basic types for measuring and fitting the focal-plane distortion. + * + * @author EAM, IfA + * + * @version $Revision: 1.2 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:14 $ + * Copyright 2006 Institute for Astronomy, University of Hawaii + */ #ifndef PM_ASTROMETRY_DISTORTION_H #define PM_ASTROMETRY_DISTORTION_H + +/// @addtogroup Astrometry +/// @{ /* The following data structure carries the information about the residual @@ -56,3 +55,4 @@ psMetadata *config); +/// @} #endif // PM_ASTROMETRY_DISTORTION_H Index: /trunk/psModules/src/astrom/pmAstrometryObjects.h =================================================================== --- /trunk/psModules/src/astrom/pmAstrometryObjects.h (revision 11252) +++ /trunk/psModules/src/astrom/pmAstrometryObjects.h (revision 11253) @@ -1,19 +1,17 @@ -/** @file pmAstrometryObjects.h -* -* @brief This file defines the basic types for matching objects -* based on their astrometry. -* -* @ingroup AstroImage -* -* @author EAM, IfA -* -* @version $Revision: 1.14 $ $Name: not supported by cvs2svn $ -* @date $Date: 2006-12-25 01:49:49 $ -* -* Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii -*/ +/* @file pmAstrometryObjects.h + * @brief basic matching of objects based on their astrometry. + * + * @author EAM, IfA + * + * @version $Revision: 1.15 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:14 $ + * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii + */ #ifndef PM_ASTROMETRY_OBJECTS_H #define PM_ASTROMETRY_OBJECTS_H + +/// @addtogroup Astrometry +/// @{ /* @@ -345,3 +343,4 @@ ); +/// @} #endif // PM_ASTROMETRY_OBJECTS_H Index: /trunk/psModules/src/astrom/pmAstrometryUtils.h =================================================================== --- /trunk/psModules/src/astrom/pmAstrometryUtils.h (revision 11252) +++ /trunk/psModules/src/astrom/pmAstrometryUtils.h (revision 11253) @@ -1,18 +1,17 @@ -/** @file pmAstrometryUtils.h -* -* @brief utility functions for transform and distort functions -* -* @ingroup Astrometry -* -* @author EAM, IfA -* -* @version $Revision: 1.2 $ $Name: not supported by cvs2svn $ -* @date $Date: 2007-01-01 21:04:38 $ -* -* Copyright 2006 Institute for Astronomy, University of Hawaii -*/ +/* @file pmAstrometryUtils.h + * @brief utility functions for transform and distort functions + * + * @author EAM, IfA + * + * @version $Revision: 1.3 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:14 $ + * Copyright 2006 Institute for Astronomy, University of Hawaii + */ #ifndef PM_ASTROMETRY_UTILS_H #define PM_ASTROMETRY_UTILS_H + +/// @addtogroup Astrometry +/// @{ psPlane *psPlaneTransformGetCenter (psPlaneTransform *trans, double tol); @@ -25,3 +24,4 @@ bool psPlaneDistortIsDiagonal (psPlaneDistort *distort); +/// @} #endif Index: /trunk/psModules/src/astrom/pmAstrometryWCS.h =================================================================== --- /trunk/psModules/src/astrom/pmAstrometryWCS.h (revision 11252) +++ /trunk/psModules/src/astrom/pmAstrometryWCS.h (revision 11253) @@ -1,18 +1,17 @@ -/** @file pmAstrometryDistortion.h -* -* @brief functions to convert FITS WCS keywords to / from pmFPA structures -* -* @ingroup Astrometry -* -* @author EAM, IfA -* -* @version $Revision: 1.8 $ $Name: not supported by cvs2svn $ -* @date $Date: 2007-01-01 21:05:59 $ -* -* Copyright 2006 Institute for Astronomy, University of Hawaii -*/ +/* @file pmAstrometryDistortion.h + * @brief functions to convert FITS WCS keywords to / from pmFPA structures + * + * @author EAM, IfA + * + * @version $Revision: 1.9 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:14 $ + * Copyright 2006 Institute for Astronomy, University of Hawaii + */ #ifndef PM_ASTROMETRY_WCS_H #define PM_ASTROMETRY_WCS_H + +/// @addtogroup Astrometry +/// @{ #define PM_ASTROM_WCS_TYPE_SIZE 80 @@ -70,4 +69,5 @@ # define PM_RAD_DEG 0.017453292519943 +/// @} #endif // PM_ASTROMETRY_WCS_H Index: /trunk/psModules/src/camera/pmFPA.h =================================================================== --- /trunk/psModules/src/camera/pmFPA.h (revision 11252) +++ /trunk/psModules/src/camera/pmFPA.h (revision 11253) @@ -1,20 +1,19 @@ -/// @file pmFPA.h -/// -/// @brief Defines the focal plane hierarchy, along with functions for interacting with it -/// -/// @ingroup Camera -/// -/// @author George Gusciora, MHPCC -/// @author Paul Price, IfA -/// @author Eugene Magnier, IfA -/// -/// @version $Revision: 1.11 $ $Name: not supported by cvs2svn $ -/// @date $Date: 2006-12-22 21:23:36 $ -/// -/// Copyright 2005-2006 Institute for Astronomy, University of Hawaii -/// +/* @file pmFPA.h + * @brief Defines the focal plane hierarchy, along with functions for interacting with it + * + * @author George Gusciora, MHPCC + * @author Paul Price, IfA + * @author Eugene Magnier, IfA + * + * @version $Revision: 1.12 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:14 $ + * Copyright 2005-2006 Institute for Astronomy, University of Hawaii + */ #ifndef PM_FPA_H #define PM_FPA_H + +/// @addtogroup Camera Camera Layout +/// @{ #include @@ -184,5 +183,4 @@ bool pmFPACheckParents(pmFPA *fpa ///< FPA to check ); - - +/// @} #endif // #ifndef PM_FPA_H Index: /trunk/psModules/src/camera/pmFPAConstruct.h =================================================================== --- /trunk/psModules/src/camera/pmFPAConstruct.h (revision 11252) +++ /trunk/psModules/src/camera/pmFPAConstruct.h (revision 11253) @@ -1,18 +1,17 @@ -/// @file pmFPAConstruct.h -/// -/// @brief Functions to create an FPA, and add data sources to it. -/// -/// @ingroup Camera -/// -/// @author Paul Price, IfA -/// -/// @version $Revision: 1.5 $ $Name: not supported by cvs2svn $ -/// @date $Date: 2007-01-20 04:24:42 $ -/// -/// Copyright 2005-2006 Institute for Astronomy, University of Hawaii -/// +/* @file pmFPAConstruct.h + * @brief Functions to create an FPA, and add data sources to it. + * + * @author Paul Price, IfA + * + * @version $Revision: 1.6 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:14 $ + * Copyright 2005-2006 Institute for Astronomy, University of Hawaii + */ #ifndef PM_FPA_CONSTRUCT_H #define PM_FPA_CONSTRUCT_H + +/// @addtogroup Camera Camera Layout +/// @{ #include @@ -62,4 +61,4 @@ bool concepts ///< Print concepts? ); - +/// @} #endif Index: /trunk/psModules/src/camera/pmFPACopy.h =================================================================== --- /trunk/psModules/src/camera/pmFPACopy.h (revision 11252) +++ /trunk/psModules/src/camera/pmFPACopy.h (revision 11253) @@ -1,18 +1,17 @@ -/// @file pmFPACopy.h -/// -/// @brief Functions to copy FPA components. -/// -/// @ingroup Camera -/// -/// @author Paul Price, IfA -/// -/// @version $Revision: 1.3 $ $Name: not supported by cvs2svn $ -/// @date $Date: 2006-10-17 01:16:17 $ -/// -/// Copyright 2005-2006 Institute for Astronomy, University of Hawaii -/// +/* @file pmFPACopy.h + * @brief Functions to copy FPA components. + * + * @author Paul Price, IfA + * + * @version $Revision: 1.4 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:14 $ + * Copyright 2005-2006 Institute for Astronomy, University of Hawaii + */ #ifndef PM_FPA_COPY_H #define PM_FPA_COPY_H + +/// @addtogroup Camera Camera Layout +/// @{ /// Copy an FPA and components, including the pixels, to a different representation of the same camera @@ -73,5 +72,4 @@ int xBin, int yBin ///< Binning factors in x and y ); - - +/// @} #endif Index: /trunk/psModules/src/camera/pmFPAExtent.h =================================================================== --- /trunk/psModules/src/camera/pmFPAExtent.h (revision 11252) +++ /trunk/psModules/src/camera/pmFPAExtent.h (revision 11253) @@ -1,4 +1,16 @@ +/* @file pmPFAExtent.h + * + * @author Paul Price, IfA + * + * @version $Revision: 1.2 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:14 $ + * Copyright 2005-2006 Institute for Astronomy, University of Hawaii + */ + #ifndef PM_FPA_EXTENT_H #define PM_FPA_EXTENT_H + +/// @addtogroup Camera Camera Layout +/// @{ /// Return the extent of a readout @@ -26,4 +38,4 @@ ); - +/// @} #endif Index: /trunk/psModules/src/camera/pmFPAFlags.h =================================================================== --- /trunk/psModules/src/camera/pmFPAFlags.h (revision 11252) +++ /trunk/psModules/src/camera/pmFPAFlags.h (revision 11253) @@ -1,20 +1,19 @@ -/// @file pmFPAFlags.h -/// -/// @brief Functions for setting and checking the status flags within the FPA hierarchy -/// -/// @ingroup Camera -/// -/// @author George Gusciora, MHPCC -/// @author Paul Price, IfA -/// @author Eugene Magnier, IfA -/// -/// @version $Revision: 1.2 $ $Name: not supported by cvs2svn $ -/// @date $Date: 2006-10-18 02:29:15 $ -/// -/// Copyright 2005-2006 Institute for Astronomy, University of Hawaii -/// +/* @file pmFPAFlags.h + * @brief Functions for setting and checking the status flags within the FPA hierarchy + * + * @author George Gusciora, MHPCC + * @author Paul Price, IfA + * @author Eugene Magnier, IfA + * + * @version $Revision: 1.3 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:14 $ + * Copyright 2005-2006 Institute for Astronomy, University of Hawaii + */ #ifndef PM_FPA_FLAGS_H #define PM_FPA_FLAGS_H + +/// @addtogroup Camera Camera Layout +/// @{ #include "pmFPA.h" @@ -98,5 +97,4 @@ int cellNum ///< Cell number to exclude ); - - +/// @} #endif Index: /trunk/psModules/src/camera/pmFPAHeader.h =================================================================== --- /trunk/psModules/src/camera/pmFPAHeader.h (revision 11252) +++ /trunk/psModules/src/camera/pmFPAHeader.h (revision 11253) @@ -1,18 +1,17 @@ -/// @file pmFPAHeader.h -/// -/// @brief Functions read FITS headers for FPA components -/// -/// @ingroup Camera -/// -/// @author Paul Price, IfA -/// -/// @version $Revision: 1.2 $ $Name: not supported by cvs2svn $ -/// @date $Date: 2006-10-17 01:29:02 $ -/// -/// Copyright 2005-2006 Institute for Astronomy, University of Hawaii -/// +/* @file pmFPAHeader.h + * @brief Functions read FITS headers for FPA components + * + * @author Paul Price, IfA + * + * @version $Revision: 1.3 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:14 $ + * Copyright 2005-2006 Institute for Astronomy, University of Hawaii + */ #ifndef PM_FPA_HEADER_H #define PM_FPA_HEADER_H + +/// @addtogroup Camera Camera Layout +/// @{ /// Read the FITS header (and ingest concepts) for an FPA, if it exists at this level @@ -39,4 +38,4 @@ psFits *fits ///< FITS file handle ); - +/// @} #endif Index: /trunk/psModules/src/camera/pmFPALevel.h =================================================================== --- /trunk/psModules/src/camera/pmFPALevel.h (revision 11252) +++ /trunk/psModules/src/camera/pmFPALevel.h (revision 11253) @@ -1,18 +1,17 @@ -/// @file pmFPALevel.h -/// -/// @brief Defines enum and string representations for the FPA levels -/// -/// @ingroup Camera -/// -/// @author Eugene Magnier, MHPCC -/// -/// @version $Revision: 1.2 $ $Name: not supported by cvs2svn $ -/// @date $Date: 2006-10-18 02:29:15 $ -/// -/// Copyright 2005-2006 Institute for Astronomy, University of Hawaii -/// +/* @file pmFPALevel.h + * @brief Defines enum and string representations for the FPA levels + * + * @author Eugene Magnier, MHPCC + * + * @version $Revision: 1.3 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:14 $ + * Copyright 2005-2006 Institute for Astronomy, University of Hawaii + */ #ifndef PM_FPA_LEVEL_H #define PM_FPA_LEVEL_H + +/// @addtogroup Camera Camera Layout +/// @{ /// Specify the level of the FPA hierarchy @@ -33,4 +32,4 @@ pmFPALevel pmFPALevelFromName(const char *name ///< Level name ); - +/// @} #endif // #ifndef PM_FPA_LEVEL_H Index: /trunk/psModules/src/camera/pmFPAMaskWeight.h =================================================================== --- /trunk/psModules/src/camera/pmFPAMaskWeight.h (revision 11252) +++ /trunk/psModules/src/camera/pmFPAMaskWeight.h (revision 11253) @@ -1,18 +1,18 @@ -/// @file pmFPAHeader.h -/// -/// @brief Functions read FITS headers for FPA components -/// -/// @ingroup Camera -/// -/// @author Paul Price, IfA -/// @author Eugene Magnier, IfA -/// -/// @version $Revision: 1.6 $ $Name: not supported by cvs2svn $ -/// @date $Date: 2006-11-29 01:26:14 $ -/// -/// Copyright 2005-2006 Institute for Astronomy, University of Hawaii -/// +/* @file pmFPAHeader.h + * @brief Functions read FITS headers for FPA components + * + * @author Paul Price, IfA + * @author Eugene Magnier, IfA + * + * @version $Revision: 1.7 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:14 $ + * Copyright 2005-2006 Institute for Astronomy, University of Hawaii + */ + #ifndef PM_FPA_MASK_WEIGHT_H #define PM_FPA_MASK_WEIGHT_H + +/// @addtogroup Camera Camera Layout +/// @{ #include "pmFPA.h" @@ -80,6 +80,4 @@ bool poisson ///< Use poisson weights (in addition to read noise)? ); - - - +/// @} #endif Index: /trunk/psModules/src/camera/pmFPAMosaic.h =================================================================== --- /trunk/psModules/src/camera/pmFPAMosaic.h (revision 11252) +++ /trunk/psModules/src/camera/pmFPAMosaic.h (revision 11253) @@ -1,18 +1,17 @@ -/// @file pmFPAMosaic.h -/// -/// @brief Functions to mosaic FPA components into a single entity -/// -/// @ingroup Camera -/// -/// @author Paul Price, IfA -/// -/// @version $Revision: 1.4 $ $Name: not supported by cvs2svn $ -/// @date $Date: 2006-10-24 01:05:55 $ -/// -/// Copyright 2005-2006 Institute for Astronomy, University of Hawaii -/// +/* @file pmFPAMosaic.h + * @brief Functions to mosaic FPA components into a single entity + * + * @author Paul Price, IfA + * + * @version $Revision: 1.5 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:14 $ + * Copyright 2005-2006 Institute for Astronomy, University of Hawaii + */ #ifndef PM_CHIP_MOSAIC_H #define PM_CHIP_MOSAIC_H + +/// @addtogroup Camera Camera Layout +/// @{ #include "pmFPA.h" @@ -37,4 +36,4 @@ const pmFPA *source ///< FPA whose chips and cells will be mosaicked ); - +/// @} #endif Index: /trunk/psModules/src/camera/pmFPARead.h =================================================================== --- /trunk/psModules/src/camera/pmFPARead.h (revision 11252) +++ /trunk/psModules/src/camera/pmFPARead.h (revision 11253) @@ -1,18 +1,17 @@ -/// @file pmFPARead.h -/// -/// @brief Functions to read FPA components from a FITS file -/// -/// @ingroup Camera -/// -/// @author Paul Price, IfA -/// -/// @version $Revision: 1.5 $ $Name: not supported by cvs2svn $ -/// @date $Date: 2006-11-13 22:15:05 $ -/// -/// Copyright 2005-2006 Institute for Astronomy, University of Hawaii -/// +/* @file pmFPARead.h + * @brief Functions to read FPA components from a FITS file + * + * @author Paul Price, IfA + * + * @version $Revision: 1.6 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:14 $ + * Copyright 2005-2006 Institute for Astronomy, University of Hawaii + */ #ifndef PM_FPA_READ_H #define PM_FPA_READ_H + +/// @addtogroup Camera Camera Layout +/// @{ #include @@ -133,4 +132,4 @@ const char *name ///< Specifies the extension name, and target in the analysis metadata ); - +/// @} #endif Index: /trunk/psModules/src/camera/pmFPAUtils.h =================================================================== --- /trunk/psModules/src/camera/pmFPAUtils.h (revision 11252) +++ /trunk/psModules/src/camera/pmFPAUtils.h (revision 11253) @@ -1,18 +1,17 @@ -/// @file pmFPAUtils.h -/// -/// @brief Utility functions for FPAs -/// -/// @ingroup Camera -/// -/// @author Paul Price, IfA -/// -/// @version $Revision: 1.2 $ $Name: not supported by cvs2svn $ -/// @date $Date: 2006-10-17 03:03:35 $ -/// -/// Copyright 2005-2006 Institute for Astronomy, University of Hawaii -/// +/* @file pmFPAUtils.h + * @brief Utility functions for FPAs + * + * @author Paul Price, IfA + * + * @version $Revision: 1.3 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:14 $ + * Copyright 2005-2006 Institute for Astronomy, University of Hawaii + */ #ifndef PM_FPA_UTILS_H #define PM_FPA_UTILS_H + +/// @addtogroup Camera Camera Layout +/// @{ #include "pmFPA.h" @@ -33,5 +32,4 @@ const char *name // Name of the cell ); - - +/// @} #endif Index: /trunk/psModules/src/camera/pmFPAWrite.h =================================================================== --- /trunk/psModules/src/camera/pmFPAWrite.h (revision 11252) +++ /trunk/psModules/src/camera/pmFPAWrite.h (revision 11253) @@ -1,22 +1,20 @@ -/// @file pmFPAWrite.h -/// -/// @brief Write FPA components to a FITS file -/// -/// @ingroup Camera -/// -/// @author Paul Price, IfA -/// -/// @version $Revision: 1.7 $ $Name: not supported by cvs2svn $ -/// @date $Date: 2006-11-18 23:43:28 $ -/// -/// Copyright 2005-2006 Institute for Astronomy, University of Hawaii -/// +/* @file pmFPAWrite.h + * @brief Write FPA components to a FITS file + * + * @author Paul Price, IfA + * + * @version $Revision: 1.8 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:14 $ + * Copyright 2005-2006 Institute for Astronomy, University of Hawaii + */ #ifndef PM_FPA_WRITE_H #define PM_FPA_WRITE_H +/// @addtogroup Camera Camera Layout +/// @{ + #include #include "pmFPA.h" - /// Write a readout incrementally @@ -167,4 +165,4 @@ const char *name ///< Name for the table data, and the extension name ); - +/// @} #endif Index: /trunk/psModules/src/camera/pmFPA_JPEG.h =================================================================== --- /trunk/psModules/src/camera/pmFPA_JPEG.h (revision 11252) +++ /trunk/psModules/src/camera/pmFPA_JPEG.h (revision 11253) @@ -1,20 +1,16 @@ -/** @file pmFPAview.h -* -* @brief Tools to manipulate the FPA structure elements. -* -* @ingroup AstroImage -* -* @author EAM, IfA -* -* @version $Revision: 1.2 $ $Name: not supported by cvs2svn $ -* @date $Date: 2006-12-03 18:48:10 $ -* -* Copyright 2004-2005 Institute for Astronomy, University of Hawaii -*/ +/* @file pmFPAview.h + * @brief Tools to manipulate the FPA structure elements. + * + * @author EAM, IfA + * + * @version $Revision: 1.3 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:14 $ + * Copyright 2004-2005 Institute for Astronomy, University of Hawaii + */ #ifndef PM_FPA_JPEG_H #define PM_FPA_JPEG_H -/// @addtogroup AstroImage +/// @addtogroup Camera Camera Layout /// @{ @@ -25,3 +21,4 @@ bool pmReadoutWriteJPEG (pmReadout *readout, const pmFPAview *view, pmFPAfile *file, pmConfig *config); +/// @} # endif Index: /trunk/psModules/src/camera/pmFPA_MANAPLOT.h =================================================================== --- /trunk/psModules/src/camera/pmFPA_MANAPLOT.h (revision 11252) +++ /trunk/psModules/src/camera/pmFPA_MANAPLOT.h (revision 11253) @@ -1,20 +1,16 @@ -/** @file pmFPAview.h -* -* @brief Tools to manipulate the FPA structure elements. -* -* @ingroup AstroImage -* -* @author EAM, IfA -* -* @version $Revision: 1.2 $ $Name: not supported by cvs2svn $ -* @date $Date: 2006-12-03 18:48:10 $ -* -* Copyright 2004-2005 Institute for Astronomy, University of Hawaii -*/ +/* @file pmFPAview.h + * @brief Tools to manipulate the FPA structure elements. + * + * @author EAM, IfA + * + * @version $Revision: 1.3 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:14 $ + * Copyright 2004-2005 Institute for Astronomy, University of Hawaii + */ #ifndef PM_FPA_MANAPLOT_H #define PM_FPA_MANAPLOT_H -/// @addtogroup AstroImage +/// @addtogroup Camera Camera Layout /// @{ @@ -25,3 +21,4 @@ bool pmReadoutWriteMANAPLOT (pmReadout *readout, const pmFPAview *view, pmFPAfile *file, pmConfig *config); +/// @} # endif Index: /trunk/psModules/src/camera/pmFPAfile.h =================================================================== --- /trunk/psModules/src/camera/pmFPAfile.h (revision 11252) +++ /trunk/psModules/src/camera/pmFPAfile.h (revision 11253) @@ -1,18 +1,17 @@ -/** @file pmFPAview.h -* -* @brief Tools to manipulate the FPA structure elements. -* -* @ingroup AstroImage -* -* @author EAM, IfA -* -* @version $Revision: 1.11 $ $Name: not supported by cvs2svn $ -* @date $Date: 2007-01-08 22:30:21 $ -* -* Copyright 2004-2005 Institute for Astronomy, University of Hawaii -*/ +/* @file pmFPAview.h + * @brief Tools to manipulate the FPA structure elements. + * + * @author EAM, IfA + * + * @version $Revision: 1.12 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:14 $ + * Copyright 2004-2005 Institute for Astronomy, University of Hawaii + */ #ifndef PM_FPA_FILE_H #define PM_FPA_FILE_H + +/// @addtogroup Camera Camera Layout +/// @{ #include "pslib.h" @@ -126,3 +125,4 @@ pmFPAfileType pmFPAfileTypeFromString(const char *type); +/// @} # endif Index: /trunk/psModules/src/camera/pmFPAfileDefine.h =================================================================== --- /trunk/psModules/src/camera/pmFPAfileDefine.h (revision 11252) +++ /trunk/psModules/src/camera/pmFPAfileDefine.h (revision 11253) @@ -1,17 +1,16 @@ -/** @file pmFPAview.h -* -* @brief Tools to manipulate the FPA structure elements. -* -* @ingroup AstroImage -* -* @author EAM, IfA -* -* @version $Revision: 1.7 $ $Name: not supported by cvs2svn $ -* @date $Date: 2007-01-19 22:14:15 $ -* -* Copyright 2004-2005 Institute for Astronomy, University of Hawaii -*/ +/* @file pmFPAview.h + * @brief Tools to manipulate the FPA structure elements. + * + * @author EAM, IfA + * + * @version $Revision: 1.8 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:14 $ + * Copyright 2004-2005 Institute for Astronomy, University of Hawaii + */ #include + +/// @addtogroup Camera Camera Layout +/// @{ #ifndef PM_FPA_FILE_DEFINE_H @@ -99,4 +98,4 @@ pmFPAfile *pmFPAfileDefineSingleFromArgs (bool *found, pmConfig *config, const char *filename, const char *argname, int entry); - +/// @} # endif Index: /trunk/psModules/src/camera/pmFPAfileFitsIO.h =================================================================== --- /trunk/psModules/src/camera/pmFPAfileFitsIO.h (revision 11252) +++ /trunk/psModules/src/camera/pmFPAfileFitsIO.h (revision 11253) @@ -1,19 +1,18 @@ -/** @file pmFPAview.h -* -* @brief Tools to manipulate the FPA structure elements. -* -* @ingroup AstroImage -* -* @author EAM, IfA -* @author PAP, IfA -* -* @version $Revision: 1.3 $ $Name: not supported by cvs2svn $ -* @date $Date: 2006-11-18 23:43:28 $ -* -* Copyright 2004-2005 Institute for Astronomy, University of Hawaii -*/ +/* @file pmFPAview.h + * @brief Tools to manipulate the FPA structure elements. + * + * @author EAM, IfA + * @author PAP, IfA + * + * @version $Revision: 1.4 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:14 $ + * Copyright 2004-2005 Institute for Astronomy, University of Hawaii + */ #ifndef PM_FPA_FILE_FITS_IO_H #define PM_FPA_FILE_FITS_IO_H + +/// @addtogroup Camera Camera Layout +/// @{ /// Read an image into the current view @@ -62,4 +61,4 @@ const char *name ///< Name of table ); - +/// @} # endif Index: /trunk/psModules/src/camera/pmFPAfileIO.h =================================================================== --- /trunk/psModules/src/camera/pmFPAfileIO.h (revision 11252) +++ /trunk/psModules/src/camera/pmFPAfileIO.h (revision 11253) @@ -1,18 +1,17 @@ -/** @file pmFPAview.h -* -* @brief Tools to manipulate the FPA structure elements. -* -* @ingroup AstroImage -* -* @author EAM, IfA -* -* @version $Revision: 1.2 $ $Name: not supported by cvs2svn $ -* @date $Date: 2007-01-08 22:30:21 $ -* -* Copyright 2004-2005 Institute for Astronomy, University of Hawaii -*/ +/* @file pmFPAview.h + * @brief Tools to manipulate the FPA structure elements. + * + * @author EAM, IfA + * + * @version $Revision: 1.3 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:14 $ + * Copyright 2004-2005 Institute for Astronomy, University of Hawaii + */ #ifndef PM_FPA_FILE_IO_H #define PM_FPA_FILE_IO_H + +/// @addtogroup Camera Camera Layout +/// @{ // open the real file corresponding to the given pmFPAfile appropriate to the current view @@ -40,3 +39,4 @@ bool pmFPAfileIOChecks (pmConfig *config, const pmFPAview *view, pmFPAfilePlace place); +/// @} # endif Index: /trunk/psModules/src/camera/pmFPAview.h =================================================================== --- /trunk/psModules/src/camera/pmFPAview.h (revision 11252) +++ /trunk/psModules/src/camera/pmFPAview.h (revision 11253) @@ -1,18 +1,17 @@ -/// @file pmFPA.h -/// -/// @brief Tools to manipulate the FPA structure elements. -/// -/// @ingroup Camera -/// -/// @author Eugene Magnier, IfA -/// -/// @version $Revision: 1.5 $ $Name: not supported by cvs2svn $ -/// @date $Date: 2006-10-21 04:02:36 $ -/// -/// Copyright 2005-2006 Institute for Astronomy, University of Hawaii -/// +/* @file pmFPA.h + * @brief Tools to manipulate the FPA structure elements. + * + * @author Eugene Magnier, IfA + * + * @version $Revision: 1.6 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:14 $ + * Copyright 2005-2006 Institute for Astronomy, University of Hawaii + */ #ifndef PM_FPA_VIEW_H #define PM_FPA_VIEW_H + +/// @addtogroup Camera Camera Layout +/// @{ #include "pmFPA.h" @@ -112,3 +111,4 @@ ); +/// @} #endif Index: /trunk/psModules/src/camera/pmHDU.h =================================================================== --- /trunk/psModules/src/camera/pmHDU.h (revision 11252) +++ /trunk/psModules/src/camera/pmHDU.h (revision 11253) @@ -1,18 +1,17 @@ -/// @file pmHDU.h -/// -/// @brief Define a header data unit (from a FITS file), with functions to read and write -/// -/// @ingroup Camera -/// -/// @author Paul Price, IfA -/// -/// @version $Revision: 1.6 $ $Name: not supported by cvs2svn $ -/// @date $Date: 2006-11-18 23:43:28 $ -/// -/// Copyright 2005-2006 Institute for Astronomy, University of Hawaii -/// +/* @file pmHDU.h + * @brief Define a header data unit (from a FITS file), with functions to read and write + * + * @author Paul Price, IfA + * + * @version $Revision: 1.7 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:14 $ + * Copyright 2005-2006 Institute for Astronomy, University of Hawaii + */ #ifndef PM_HDU_H #define PM_HDU_H + +/// @addtogroup Camera Camera Layout +/// @{ /// An instance of the FITS Header Data Unit @@ -80,3 +79,4 @@ ); +/// @} #endif Index: /trunk/psModules/src/camera/pmHDUGenerate.h =================================================================== --- /trunk/psModules/src/camera/pmHDUGenerate.h (revision 11252) +++ /trunk/psModules/src/camera/pmHDUGenerate.h (revision 11253) @@ -1,18 +1,17 @@ -/// @file pmHDUGenerate.h -/// -/// @brief Generate HDU pixels from FPA components that have pixels -/// -/// @ingroup Camera -/// -/// @author Paul Price, IfA -/// -/// @version $Revision: 1.2 $ $Name: not supported by cvs2svn $ -/// @date $Date: 2006-10-17 03:29:08 $ -/// -/// Copyright 2005-2006 Institute for Astronomy, University of Hawaii -/// +/* @file pmHDUGenerate.h + * @brief Generate HDU pixels from FPA components that have pixels + * + * @author Paul Price, IfA + * + * @version $Revision: 1.3 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:14 $ + * Copyright 2005-2006 Institute for Astronomy, University of Hawaii + */ #ifndef PM_HDU_GENERATE_H #define PM_HDU_GENERATE_H + +/// @addtogroup Camera Camera Layout +/// @{ #include "pmFPA.h" @@ -53,5 +52,4 @@ bool pmHDUGenerateForFPA(pmFPA *fpa ///< The fpa for which to generate an HDU ); - - +/// @} #endif Index: /trunk/psModules/src/camera/pmHDUUtils.h =================================================================== --- /trunk/psModules/src/camera/pmHDUUtils.h (revision 11252) +++ /trunk/psModules/src/camera/pmHDUUtils.h (revision 11253) @@ -1,18 +1,17 @@ -/// @file pmHDUUtils.h -/// -/// @brief Utility functions for working with an HDU -/// -/// @ingroup Camera -/// -/// @author Paul Price, IfA -/// -/// @version $Revision: 1.7 $ $Name: not supported by cvs2svn $ -/// @date $Date: 2006-10-21 03:31:07 $ -/// -/// Copyright 2005-2006 Institute for Astronomy, University of Hawaii -/// +/* @file pmHDUUtils.h + * @brief Utility functions for working with an HDU + * + * @author Paul Price, IfA + * + * @version $Revision: 1.8 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:14 $ + * Copyright 2005-2006 Institute for Astronomy, University of Hawaii + */ #ifndef PM_HDU_UTILS_H #define PM_HDU_UTILS_H + +/// @addtogroup Camera Camera Layout +/// @{ #include "pmFPA.h" @@ -59,4 +58,4 @@ bool header ///< Print header? ); - +/// @} #endif Index: /trunk/psModules/src/concepts/pmConcepts.h =================================================================== --- /trunk/psModules/src/concepts/pmConcepts.h (revision 11252) +++ /trunk/psModules/src/concepts/pmConcepts.h (revision 11253) @@ -1,18 +1,17 @@ -/// @file pmConcepts.h -/// -/// @brief Top-level functions for defining, registering, reading and writing concepts -/// -/// @ingroup Concepts -/// -/// @author Paul Price, IfA -/// -/// @version $Revision: 1.10 $ $Name: not supported by cvs2svn $ -/// @date $Date: 2007-01-08 22:31:41 $ -/// -/// Copyright 2005-2006 Institute for Astronomy, University of Hawaii -/// +/* @file pmConcepts.h + * @brief Top-level functions for defining, registering, reading and writing concepts + * + * @author Paul Price, IfA + * + * @version $Revision: 1.11 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:14 $ + * Copyright 2005-2006 Institute for Astronomy, University of Hawaii + */ #ifndef PM_CONCEPTS_H #define PM_CONCEPTS_H + +/// @addtogroup Concepts Data Abstraction Concepts +/// @{ #include @@ -36,5 +35,4 @@ const pmCell *cell ///< Cell for concept, or NULL ); - /// A "concept" specification @@ -193,5 +191,4 @@ const pmFPA *source ///< The source FPA ); - - +/// @} #endif Index: /trunk/psModules/src/concepts/pmConceptsAverage.h =================================================================== --- /trunk/psModules/src/concepts/pmConceptsAverage.h (revision 11252) +++ /trunk/psModules/src/concepts/pmConceptsAverage.h (revision 11253) @@ -1,18 +1,17 @@ -/// @file pmConceptsAverage.h -/// -/// @brief Average the values of multiple concepts -/// -/// @ingroup Concepts -/// -/// @author Paul Price, IfA -/// -/// @version $Revision: 1.4 $ $Name: not supported by cvs2svn $ -/// @date $Date: 2006-10-16 22:03:56 $ -/// -/// Copyright 2005-2006 Institute for Astronomy, University of Hawaii -/// +/* @file pmConceptsAverage.h + * @brief Average the values of multiple concepts + * + * @author Paul Price, IfA + * + * @version $Revision: 1.5 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:14 $ + * Copyright 2005-2006 Institute for Astronomy, University of Hawaii + */ #ifndef PM_CONCEPTS_AVERAGE_H #define PM_CONCEPTS_AVERAGE_H + +/// @addtogroup Concepts Data Abstraction Concepts +/// @{ #include @@ -41,3 +40,4 @@ ); +/// @} #endif Index: /trunk/psModules/src/concepts/pmConceptsPhotcode.h =================================================================== --- /trunk/psModules/src/concepts/pmConceptsPhotcode.h (revision 11252) +++ /trunk/psModules/src/concepts/pmConceptsPhotcode.h (revision 11253) @@ -1,10 +1,10 @@ -/* @file pmConceptsPhotcode.h - * @brief Generate a photcode from the concepts - * - * @author Eugene Magnier, IfA - * - * @version $Revision: 1.6 $ $Name: not supported by cvs2svn $ - * @date $Date: 2007-01-24 01:05:41 $ - * Copyright 2005-2006 Institute for Astronomy, University of Hawaii +/* @file pmConceptsPhotcode.h + * @brief Generate a photcode from the concepts + * + * @author Eugene Magnier, IfA + * + * @version $Revision: 1.7 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:14 $ + * Copyright 2005-2006 Institute for Astronomy, University of Hawaii */ Index: /trunk/psModules/src/concepts/pmConceptsRead.h =================================================================== --- /trunk/psModules/src/concepts/pmConceptsRead.h (revision 11252) +++ /trunk/psModules/src/concepts/pmConceptsRead.h (revision 11253) @@ -1,15 +1,11 @@ -/// @file pmConceptsRead.h -/// -/// @brief Reading concepts from a variety of sources. -/// -/// @ingroup Concepts -/// -/// @author Paul Price, IfA -/// -/// @version $Revision: 1.4 $ $Name: not supported by cvs2svn $ -/// @date $Date: 2006-10-16 22:03:56 $ -/// -/// Copyright 2005-2006 Institute for Astronomy, University of Hawaii -/// +/* @file pmConceptsRead.h + * @brief Reading concepts from a variety of sources. + * + * @author Paul Price, IfA + * + * @version $Revision: 1.5 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:14 $ + * Copyright 2005-2006 Institute for Astronomy, University of Hawaii + */ #ifndef PM_CONCEPTS_READ_H @@ -64,4 +60,4 @@ psDB *db // The database handle ); - +/// @} #endif Index: /trunk/psModules/src/concepts/pmConceptsStandard.h =================================================================== --- /trunk/psModules/src/concepts/pmConceptsStandard.h (revision 11252) +++ /trunk/psModules/src/concepts/pmConceptsStandard.h (revision 11253) @@ -1,24 +1,20 @@ -/// @file pmConceptsStandard.h -/// -/// @brief Private functions for parsing and formatting standard concepts. -/// -/// @ingroup Concepts -/// -/// @author Paul Price, IfA -/// -/// @version $Revision: 1.7 $ $Name: not supported by cvs2svn $ -/// @date $Date: 2007-01-18 03:14:09 $ -/// -/// Copyright 2005-2006 Institute for Astronomy, University of Hawaii -/// +/* @file pmConceptsStandard.h + * @brief Private functions for parsing and formatting standard concepts. + * + * @author Paul Price, IfA + * + * @version $Revision: 1.8 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:15 $ + * Copyright 2005-2006 Institute for Astronomy, University of Hawaii + */ #ifndef PM_CONCEPTS_STANDARD_H #define PM_CONCEPTS_STANDARD_H +/// @addtogroup Concepts Data Abstraction Concepts +/// @{ + #include #include "pmFPA.h" - -// Functions to parse and format the standard concepts - /// Parse the FPA.FILTER concept to apply a lookup table @@ -165,4 +161,4 @@ const pmCell *cell ///< Cell for concept, or NULL ); - +/// @} #endif Index: /trunk/psModules/src/concepts/pmConceptsWrite.h =================================================================== --- /trunk/psModules/src/concepts/pmConceptsWrite.h (revision 11252) +++ /trunk/psModules/src/concepts/pmConceptsWrite.h (revision 11253) @@ -1,18 +1,17 @@ -/// @file pmConceptsWrite.h -/// -/// @brief Writing concepts to a variety of sources. -/// -/// @ingroup Concepts -/// -/// @author Paul Price, IfA -/// -/// @version $Revision: 1.4 $ $Name: not supported by cvs2svn $ -/// @date $Date: 2006-10-16 22:03:56 $ -/// -/// Copyright 2005-2006 Institute for Astronomy, University of Hawaii -/// +/* @file pmConceptsWrite.h + * @brief Writing concepts to a variety of sources. + * + * @author Paul Price, IfA + * + * @version $Revision: 1.5 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:15 $ + * Copyright 2005-2006 Institute for Astronomy, University of Hawaii + */ #ifndef PM_CONCEPTS_WRITE_H #define PM_CONCEPTS_WRITE_H + +/// @addtogroup Concepts Data Abstraction Concepts +/// @{ #include @@ -62,4 +61,4 @@ const psMetadata *concepts ///< The concepts ); - +/// @} #endif Index: /trunk/psModules/src/config/Makefile.am =================================================================== --- /trunk/psModules/src/config/Makefile.am (revision 11252) +++ /trunk/psModules/src/config/Makefile.am (revision 11253) @@ -17,9 +17,7 @@ pmErrorCodes.h -CLEANFILES = *~ - # Error codes. BUILT_SOURCES = pmErrorCodes.h pmErrorCodes.c -CLEANFILES = pmErrorCodes.h pmErrorCodes.c +CLEANFILES = *~ pmErrorCodes.h pmErrorCodes.c pmErrorCodes.h : pmErrorCodes.dat pmErrorCodes.h.in Index: /trunk/psModules/src/detrend/pmBias.h =================================================================== --- /trunk/psModules/src/detrend/pmBias.h (revision 11252) +++ /trunk/psModules/src/detrend/pmBias.h (revision 11253) @@ -1,19 +1,18 @@ -/// @file pmBias.h -/// -/// @brief Subtract the overscan, bias and dark -/// -/// @ingroup Detrend -/// -/// @author George Gusciora, MHPCC -/// @author Paul Price, IfA -/// -/// @version $Revision: 1.2 $ $Name: not supported by cvs2svn $ -/// @date $Date: 2006-11-30 01:03:06 $ -/// -/// Copyright 2004--2006 Institute for Astronomy, University of Hawaii -/// +/* @file pmBias.h + * @brief Subtract the overscan, bias and dark + * + * @author George Gusciora, MHPCC + * @author Paul Price, IfA + * + * @version $Revision: 1.3 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:15 $ + * Copyright 2004--2006 Institute for Astronomy, University of Hawaii + */ #ifndef PM__BIAS_H #define PM__BIAS_H + +/// @addtogroup detrend Detrend Creation and Application +/// @{ #include @@ -66,3 +65,4 @@ ); +/// @} #endif Index: /trunk/psModules/src/detrend/pmDetrendDB.h =================================================================== --- /trunk/psModules/src/detrend/pmDetrendDB.h (revision 11252) +++ /trunk/psModules/src/detrend/pmDetrendDB.h (revision 11253) @@ -1,25 +1,22 @@ -/** @file pmDetrendDB.h -* -* @brief Tools to query the detrend database system -* -* the functions in here do not perform the detrend database queries directly. all interfaces -* to the detrend database go through the external dettools functions. this allows the modules -* and directly dependent program to be sufficiently independent of the database schema that it -* can be used with any properly defined detrend database tables. -* -* XXX place the specific name of the detrend database query command in the configuration data -* -* @ingroup Detrend -* -* @author EAM, IfA -* -* @version $Revision: 1.5 $ $Name: not supported by cvs2svn $ -* @date $Date: 2006-11-04 02:34:01 $ -* -* Copyright 2004-2005 Institute for Astronomy, University of Hawaii -*/ +/* @file pmDetrendDB.h + * @brief Tools to query the detrend database system + * + * the functions in here do not perform the detrend database queries directly. all interfaces + * to the detrend database go through the external dettools functions. this allows the modules + * and directly dependent program to be sufficiently independent of the database schema that it + * can be used with any properly defined detrend database tables. + * + * @author EAM, IfA + * + * @version $Revision: 1.6 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:15 $ + * Copyright 2004-2005 Institute for Astronomy, University of Hawaii + */ #ifndef PM_DETREND_DB_H #define PM_DETREND_DB_H + +/// @addtogroup detrend Detrend Creation and Application +/// @{ #include "pmFPALevel.h" @@ -69,3 +66,4 @@ char *pmDetrendFile (const char *detID, const char *classID); +/// @} # endif Index: /trunk/psModules/src/detrend/pmFlatField.h =================================================================== --- /trunk/psModules/src/detrend/pmFlatField.h (revision 11252) +++ /trunk/psModules/src/detrend/pmFlatField.h (revision 11253) @@ -1,19 +1,18 @@ -/// @file pmFlatField.h -/// -/// @brief Apply flat field calibration -/// -/// @ingroup Detrend -/// -/// @author Ross Harman, MHPCC -/// @author Paul Price, IfA -/// -/// @version $Revision: 1.7 $ $Name: not supported by cvs2svn $ -/// @date $Date: 2006-10-24 03:48:42 $ -/// -/// Copyright 2004-2006 Institute for Astronomy, University of Hawaii -/// +/* @file pmFlatField.h + * @brief Apply flat field calibration + * + * @author Ross Harman, MHPCC + * @author Paul Price, IfA + * + * @version $Revision: 1.8 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:15 $ + * Copyright 2004-2006 Institute for Astronomy, University of Hawaii + */ #ifndef PM_FLAT_FIELD_H #define PM_FLAT_FIELD_H + +/// @addtogroup detrend Detrend Creation and Application +/// @{ #include "pmFPA.h" @@ -29,5 +28,4 @@ const pmReadout *flat ///< Readout with flat image ); - - +/// @} #endif Index: /trunk/psModules/src/detrend/pmFlatNormalize.h =================================================================== --- /trunk/psModules/src/detrend/pmFlatNormalize.h (revision 11252) +++ /trunk/psModules/src/detrend/pmFlatNormalize.h (revision 11253) @@ -1,22 +1,21 @@ -/// @file pmFlatNormalize.h -/// -/// @brief Normalize flat-field measurements -/// -/// @ingroup Detrend -/// -/// @author Paul Price, IfA -/// -/// @version $Revision: 1.5 $ $Name: not supported by cvs2svn $ -/// @date $Date: 2006-10-17 20:49:10 $ -/// -/// Copyright 2004-2006 Institute for Astronomy, University of Hawaii -/// +/* @file pmFlatNormalize.h + * @brief Normalize flat-field measurements + * + * @author Paul Price, IfA + * + * @version $Revision: 1.6 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:15 $ + * Copyright 2004-2006 Institute for Astronomy, University of Hawaii + */ #ifndef PM_FLAT_NORMALIZE_H #define PM_FLAT_NORMALIZE_H +/// @addtogroup detrend Detrend Creation and Application +/// @{ + #include -/// Normalise flat-field measurements +/// Normalize flat-field measurements /// /// 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 @@ -31,3 +30,4 @@ ); +/// @} #endif Index: /trunk/psModules/src/detrend/pmFringeStats.h =================================================================== --- /trunk/psModules/src/detrend/pmFringeStats.h (revision 11252) +++ /trunk/psModules/src/detrend/pmFringeStats.h (revision 11253) @@ -1,19 +1,18 @@ -/// @file pmFringeStats.h -/// -/// @brief Measure fringe statistics, and apply correction -/// -/// @ingroup Detrend -/// -/// @author Eugene Magnier, IfA -/// @author Paul Price, IfA -/// -/// @version $Revision: 1.11 $ $Name: not supported by cvs2svn $ -/// @date $Date: 2006-11-13 22:19:52 $ -/// -/// Copyright 2004-2006 Institute for Astronomy, University of Hawaii -/// +/* @file pmFringeStats.h + * @brief Measure fringe statistics, and apply correction + * + * @author Eugene Magnier, IfA + * @author Paul Price, IfA + * + * @version $Revision: 1.12 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:15 $ + * Copyright 2004-2006 Institute for Astronomy, University of Hawaii + */ #ifndef PM_FRINGE_STATS #define PM_FRINGE_STATS + +/// @addtogroup detrend Detrend Creation and Application +/// @{ ////////////////////////////////////////////////////////////////////////////////////////////////////////////// @@ -212,5 +211,4 @@ float keepFrac ///< Minimum fraction of regions to keep, for pmFringeScaleMeasure ); - - +/// @} #endif Index: /trunk/psModules/src/detrend/pmMaskBadPixels.h =================================================================== --- /trunk/psModules/src/detrend/pmMaskBadPixels.h (revision 11252) +++ /trunk/psModules/src/detrend/pmMaskBadPixels.h (revision 11253) @@ -1,19 +1,18 @@ -/// @file pmMaskBadPixels.h -/// -/// @brief Mask bad pixels -/// -/// @ingroup Detrend -/// -/// @author Ross Harman, MHPCC -/// @author Eugene Magnier, IfA -/// -/// @version $Revision: 1.11 $ $Name: not supported by cvs2svn $ -/// @date $Date: 2006-11-17 01:17:59 $ -/// -/// Copyright 2004 Institute for Astronomy, University of Hawaii -/// +/* @file pmMaskBadPixels.h + * @brief Mask bad pixels + * + * @author Ross Harman, MHPCC + * @author Eugene Magnier, IfA + * + * @version $Revision: 1.12 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:15 $ + * Copyright 2004 Institute for Astronomy, University of Hawaii + */ #ifndef PM_MASK_BAD_PIXELS_H #define PM_MASK_BAD_PIXELS_H + +/// @addtogroup detrend Detrend Creation and Application +/// @{ #include @@ -56,7 +55,4 @@ psMaskType maskVal ///< Value to set for bad pixels ); - - - - +/// @} #endif Index: /trunk/psModules/src/detrend/pmNonLinear.h =================================================================== --- /trunk/psModules/src/detrend/pmNonLinear.h (revision 11252) +++ /trunk/psModules/src/detrend/pmNonLinear.h (revision 11253) @@ -1,19 +1,18 @@ -/// @file pmNonLinear.h -/// -/// @brief Perform non-linear correction through polynomial or table lookup -/// -/// @ingroup Detrend -/// -/// @author George Gusciora, MHPCC -/// @author Paul Price, IfA -/// -/// @version $Revision: 1.4 $ $Name: not supported by cvs2svn $ -/// @date $Date: 2006-10-17 22:57:27 $ -/// -/// Copyright 2004 Institute for Astronomy, University of Hawaii -/// +/* @file pmNonLinear.h + * @brief Perform non-linear correction through polynomial or table lookup + * + * @author George Gusciora, MHPCC + * @author Paul Price, IfA + * + * @version $Revision: 1.5 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:15 $ + * Copyright 2004 Institute for Astronomy, University of Hawaii + */ #ifndef PM_NON_LINEAR_H #define PM_NON_LINEAR_H + +/// @addtogroup detrend Detrend Creation and Application +/// @{ #include @@ -36,3 +35,4 @@ ); +/// @} #endif Index: /trunk/psModules/src/detrend/pmShutterCorrection.h =================================================================== --- /trunk/psModules/src/detrend/pmShutterCorrection.h (revision 11252) +++ /trunk/psModules/src/detrend/pmShutterCorrection.h (revision 11253) @@ -1,63 +1,62 @@ -/// @file pmShutterCorrection.h -/// -/// @brief Functions to build and apply a shutter exposure-time correction. -/// -/// @ingroup Detrend -/// -/// @author Eugene Magnier, IfA -/// @author Paul Price, IfA -/// -/// @version $Revision: 1.10 $ $Name: not supported by cvs2svn $ -/// @date $Date: 2006-11-15 00:40:49 $ -/// -/// Copyright 2006 Institute for Astronomy, University of Hawaii -/// - - -/// A mechanical shutter may not yield uniform exposure times as a function of -/// position on the detector. The typical error consists of a constant -/// exposure-time offset relative to the requested value, ie exposure time is -/// T_o + dT(x,y). The exposure error, dT, may be measured with the following -/// scheme. Obtain a set of exposures with different exposures times taken of -/// the same flat-field source; the source must be spatially stable between the -/// exposures, but need not have a stable amplitude. For an illuminating flux -/// of intensity F(x,y) = F_o f(x,y), the signal recorded by any pixel in the -/// detector is given by: S(t,x,y) = F_o(t) f(x,y) (T_o + dT(x,y)) where F_o is -/// the F_o(t) is the (variable) overall intensity of the illuminating source -/// and f(x,y) is the spatial illumination patter times the flat-field response. -/// Choose a reference location in the image (eg, the detector center) and -/// divide by the value of that region (ie, mean or median): -/// -/// s(t,x,y) = S(t,x,y) / S(t,0,0) -/// 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)) -/// s(t,x,y) = f(x,y) (T_o + dT(x,y)) / f(0,0) (T_o + dT(0,0)) -/// -/// we can absorb the term f(0,0) into f(x,y) as we have no motivation for the -/// scale of f(x,y). For any single pixel, over the set of exposures, we thus -/// need to solve for dT(x,y), dT(0,0), and f'(x,y) in the equation: -/// s(t,x,y) = f'(x,y) (T_o + dT(x,y)) / (T_o + dT(0,0)) -/// -/// we avoid directly fitting these values as the process would be a non-linear -/// least-squares problem for every pixel in the image, and thus very time -/// consuming. There are linear options which may be used instead. -/// First, as T_o goes to a large value, s() approaches the value of f'(x,y). -/// Next, as T_o goes to a very small value, s() approaches the value of -/// f'(x,y)*dT(x,y)/dT(0,0). Finally, when s() has the value of -/// f'(x,y)*(1 + dT(x,y)/dT(0,0))/2, T_o has the value of dT(0,0). with data -/// points covering a reasonable dynamic range, we can solve for these three -/// values by interpolation and/or extrapolation. -/// -/// To take the strategy one step further, we could use the above recipe to -/// obtain a guess for the three parameters and then apply non-linear fitting to -/// solve more accurately for the parameters. If we limit this operation to a -/// handful of positions in the image (user defined, but the obvious choice would -/// be positions near the center, edges, and corners), then we may determine a -/// good value for dT(0,0). Since there is only one dT(0,0) for the image, we -/// can apply the resulting measurement to the rest of the pixels in the image. -/// If dT(0,0) is not a free parameter, then the fitting process is linear in -/// terms of dT(x,y) and f'(x,y) +/* @file pmShutterCorrection.h + * @brief Functions to build and apply a shutter exposure-time correction. + * + * @author Eugene Magnier, IfA + * @author Paul Price, IfA + * + * @version $Revision: 1.11 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:15 $ + * Copyright 2006 Institute for Astronomy, University of Hawaii + */ #ifndef PM_SHUTTER_CORRECTION_H #define PM_SHUTTER_CORRECTION_H + +/// @addtogroup detrend Detrend Creation and Application +/// @{ + +/* A mechanical shutter may not yield uniform exposure times as a function of + * position on the detector. The typical error consists of a constant + * exposure-time offset relative to the requested value, ie exposure time is + * T_o + dT(x,y). The exposure error, dT, may be measured with the following + * scheme. Obtain a set of exposures with different exposures times taken of + * the same flat-field source; the source must be spatially stable between the + * exposures, but need not have a stable amplitude. For an illuminating flux + * of intensity F(x,y) = F_o f(x,y), the signal recorded by any pixel in the + * detector is given by: S(t,x,y) = F_o(t) f(x,y) (T_o + dT(x,y)) where F_o is + * the F_o(t) is the (variable) overall intensity of the illuminating source + * and f(x,y) is the spatial illumination patter times the flat-field response. + * Choose a reference location in the image (eg, the detector center) and + * divide by the value of that region (ie, mean or median): + * + * s(t,x,y) = S(t,x,y) / S(t,0,0) + * 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)) + * s(t,x,y) = f(x,y) (T_o + dT(x,y)) / f(0,0) (T_o + dT(0,0)) + * + * we can absorb the term f(0,0) into f(x,y) as we have no motivation for the + * scale of f(x,y). For any single pixel, over the set of exposures, we thus + * need to solve for dT(x,y), dT(0,0), and f'(x,y) in the equation: + * s(t,x,y) = f'(x,y) (T_o + dT(x,y)) / (T_o + dT(0,0)) + * + * we avoid directly fitting these values as the process would be a non-linear + * least-squares problem for every pixel in the image, and thus very time + * consuming. There are linear options which may be used instead. + * First, as T_o goes to a large value, s() approaches the value of f'(x,y). + * Next, as T_o goes to a very small value, s() approaches the value of + * f'(x,y)*dT(x,y)/dT(0,0). Finally, when s() has the value of + * f'(x,y)*(1 + dT(x,y)/dT(0,0))/2, T_o has the value of dT(0,0). with data + * points covering a reasonable dynamic range, we can solve for these three + * values by interpolation and/or extrapolation. + * + * To take the strategy one step further, we could use the above recipe to + * obtain a guess for the three parameters and then apply non-linear fitting to + * solve more accurately for the parameters. If we limit this operation to a + * handful of positions in the image (user defined, but the obvious choice would + * be positions near the center, edges, and corners), then we may determine a + * good value for dT(0,0). Since there is only one dT(0,0) for the image, we + * can apply the resulting measurement to the rest of the pixels in the image. + * If dT(0,0) is not a free parameter, then the fitting process is linear in + * terms of dT(x,y) and f'(x,y) + */ #include @@ -130,3 +129,4 @@ ); +/// @} #endif Index: /trunk/psModules/src/detrend/pmSkySubtract.h =================================================================== --- /trunk/psModules/src/detrend/pmSkySubtract.h (revision 11252) +++ /trunk/psModules/src/detrend/pmSkySubtract.h (revision 11253) @@ -1,18 +1,19 @@ -/** @file pmSubtractSky.h +/* @file pmSubtractSky.h * - * This file will contain a module which will create a model of the - * background sky and subtract that from the input image. + * This file will contain a module which will create a model of the + * background sky and subtract that from the input image. * - * @author GLG, MHPCC + * @author GLG, MHPCC * - * @version $Revision: 1.1 $ $Name: not supported by cvs2svn $ - * @date $Date: 2006-11-30 00:52:21 $ - * - * Copyright 2004 Maui High Performance Computing Center, University of Hawaii - * + * @version $Revision: 1.2 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:15 $ + * Copyright 2004 Maui High Performance Computing Center, University of Hawaii */ #ifndef PM_SUBTRACT_SKY_H #define PM_SUBTRACT_SKY_H + +/// @addtogroup detrend Detrend Creation and Application +/// @{ #include @@ -34,3 +35,5 @@ psStats *stats, float clipSD); + +/// @} #endif Index: /trunk/psModules/src/extras/pmKapaPlots.c =================================================================== --- /trunk/psModules/src/extras/pmKapaPlots.c (revision 11252) +++ /trunk/psModules/src/extras/pmKapaPlots.c (revision 11253) @@ -7,6 +7,6 @@ * @author EAM, IfA * - * @version $Revision: 1.5 $ $Name: not supported by cvs2svn $ - * @date $Date: 2007-01-01 21:03:41 $ + * @version $Revision: 1.6 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:15 $ * * Copyright 2006 Institute for Astronomy, University of Hawaii @@ -148,5 +148,5 @@ # include "pmKapaPlots.h" - int pmKapaOpen () + int pmKapaOpen (bool showWindow) { return -1; Index: /trunk/psModules/src/extras/pmKapaPlots.h =================================================================== --- /trunk/psModules/src/extras/pmKapaPlots.h (revision 11252) +++ /trunk/psModules/src/extras/pmKapaPlots.h (revision 11253) @@ -1,18 +1,17 @@ -/** @file pmKapaPlots.h -* -* @brief functions to make plots with the external program 'kapa' -* -* @ingroup extras -* -* @author EAM, IfA -* -* @version $Revision: 1.4 $ $Name: not supported by cvs2svn $ -* @date $Date: 2007-01-01 21:03:41 $ -* -* Copyright 2006 Institute for Astronomy, University of Hawaii -*/ +/* @file pmKapaPlots.h + * @brief functions to make plots with the external program 'kapa' + * + * @author EAM, IfA + * + * @version $Revision: 1.5 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:15 $ + * Copyright 2006 Institute for Astronomy, University of Hawaii + */ #ifndef PM_KAPA_PLOTS_H #define PM_KAPA_PLOTS_H + +/// @addtogroup Extras Miscellaneous Funtions +/// @{ // move to psLib or psModules @@ -31,3 +30,4 @@ # endif +/// @} #endif // PM_KAPA_PLOTS_H Index: /trunk/psModules/src/extras/psIOBuffer.h =================================================================== --- /trunk/psModules/src/extras/psIOBuffer.h (revision 11252) +++ /trunk/psModules/src/extras/psIOBuffer.h (revision 11253) @@ -1,18 +1,17 @@ -/** @file psPipe.h -* -* @brief 3-stream pipe -* -* @ingroup misc -* -* @author EAM, IfA -* -* @version $Revision: 1.1 $ $Name: not supported by cvs2svn $ -* @date $Date: 2006-12-10 18:27:26 $ -* -* Copyright 2004-2005 Institute for Astronomy, University of Hawaii -*/ +/* @file IOBuffer.h + * @brief input/output character buffer + * + * @author EAM, IfA + * + * @version $Revision: 1.2 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:15 $ + * Copyright 2004-2005 Institute for Astronomy, University of Hawaii + */ #ifndef PS_IO_BUFFER_H #define PS_IO_BUFFER_H + +/// @addtogroup Extras Miscellaneous Funtions +/// @{ typedef struct @@ -32,3 +31,4 @@ int psIOBufferReadEmpty (psIOBuffer *buffer, int maxRetries, int fd); +/// @} # endif Index: /trunk/psModules/src/extras/psPipe.h =================================================================== --- /trunk/psModules/src/extras/psPipe.h (revision 11252) +++ /trunk/psModules/src/extras/psPipe.h (revision 11253) @@ -1,18 +1,17 @@ -/** @file psPipe.h -* -* @brief 3-stream pipe -* -* @ingroup misc -* -* @author EAM, IfA -* -* @version $Revision: 1.1 $ $Name: not supported by cvs2svn $ -* @date $Date: 2006-12-10 18:27:26 $ -* -* Copyright 2004-2005 Institute for Astronomy, University of Hawaii -*/ +/* @file psPipe.h + * @brief 3-stream pipe + * + * @author EAM, IfA + * + * @version $Revision: 1.2 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:15 $ + * Copyright 2004-2005 Institute for Astronomy, University of Hawaii + */ #ifndef PS_PIPE_H #define PS_PIPE_H + +/// @addtogroup Extras Miscellaneous Funtions +/// @{ // move these to pslib?? @@ -31,3 +30,4 @@ int psPipeClose (psPipe *pipe); +/// @} # endif Index: /trunk/psModules/src/extras/psVectorBracket.h =================================================================== --- /trunk/psModules/src/extras/psVectorBracket.h (revision 11252) +++ /trunk/psModules/src/extras/psVectorBracket.h (revision 11253) @@ -1,5 +1,17 @@ +/* @file psVectorBracket.h + * @brief vector bracket functions + * + * @author EAM, IfA + * + * @version $Revision: 1.2 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:15 $ + * Copyright 2004-2005 Institute for Astronomy, University of Hawaii + */ # ifndef PS_VECTOR_BRACKET_H # define PS_VECTOR_BRACKET_H + +/// @addtogroup Extras Miscellaneous Funtions +/// @{ int psVectorBracket(const psVector *index, psF32 key, bool above); @@ -7,3 +19,4 @@ psF32 psVectorInterpolate(const psVector *index, const psVector *value, psF32 key); +/// @} # endif /* PS_VECTOR_BRACKET_H */ Index: /trunk/psModules/src/imcombine/pmImageCombine.h =================================================================== --- /trunk/psModules/src/imcombine/pmImageCombine.h (revision 11252) +++ /trunk/psModules/src/imcombine/pmImageCombine.h (revision 11253) @@ -1,20 +1,21 @@ -/** @file pmImageCombine.h +/* @file pmImageCombine.h * - * This file will perform image combination of several images of the - * same field, produce a list of questionable pixels, then tag some - * of those pixels as cosmic rays. + * This file will perform image combination of several images of the + * same field, produce a list of questionable pixels, then tag some + * of those pixels as cosmic rays. * - * @author Paul Price, IfA (original prototype) - * @author GLG, MHPCC + * @author Paul Price, IfA (original prototype) + * @author GLG, MHPCC * - * @version $Revision: 1.4 $ $Name: not supported by cvs2svn $ - * @date $Date: 2007-01-16 23:51:51 $ - * - * Copyright 2004 Maui High Performance Computing Center, University of Hawaii - * + * @version $Revision: 1.5 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:15 $ + * Copyright 2004 Maui High Performance Computing Center, University of Hawaii */ #ifndef PM_IMAGE_COMBINE_H #define PM_IMAGE_COMBINE_H + +/// @addtogroup imcombine Image Combinations +/// @{ #include @@ -43,3 +44,5 @@ psF32 gradLimit ///< Gradient limit ); + +/// @} #endif Index: /trunk/psModules/src/imcombine/pmImageSubtract.h =================================================================== --- /trunk/psModules/src/imcombine/pmImageSubtract.h (revision 11252) +++ /trunk/psModules/src/imcombine/pmImageSubtract.h (revision 11253) @@ -1,19 +1,20 @@ -/** @file ImageSubtract.h +/* @file ImageSubtract.h * - * This file will contain code which creates a set of kernel basis - * functions, solves for their solution, and applies them to an image. + * This file will contain code which creates a set of kernel basis + * functions, solves for their solution, and applies them to an image. * - * @author Paul Price, IfA (original prototype) - * @author GLG, MHPCC + * @author Paul Price, IfA (original prototype) + * @author GLG, MHPCC * - * @version $Revision: 1.2 $ $Name: not supported by cvs2svn $ - * @date $Date: 2006-10-18 02:29:15 $ - * - * Copyright 2004 Maui High Performance Computing Center, University of Hawaii - * + * @version $Revision: 1.3 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:15 $ + * Copyright 2004 Maui High Performance Computing Center, University of Hawaii */ #ifndef PM_IMAGE_COMBINE_H #define PM_IMAGE_COMBINE_H + +/// @addtogroup imcombine Image Combinations +/// @{ #include @@ -120,3 +121,4 @@ ); +/// @} #endif Index: /trunk/psModules/src/imcombine/pmReadoutCombine.h =================================================================== --- /trunk/psModules/src/imcombine/pmReadoutCombine.h (revision 11252) +++ /trunk/psModules/src/imcombine/pmReadoutCombine.h (revision 11253) @@ -1,20 +1,18 @@ -/// @file pmReadoutCombine.h -/// -/// @brief Combine multiple readouts -/// -/// @ingroup Image combination -/// -/// @author George Gusciora, MHPCC -/// @author Paul Price, IfA -/// -/// @version $Revision: 1.9 $ $Name: not supported by cvs2svn $ -/// @date $Date: 2006-11-29 01:27:03 $ -/// -/// Copyright 2004-2006 Institute for Astronomy, University of Hawaii -/// -/// +/* @file pmReadoutCombine.h + * @brief Combine multiple readouts + * + * @author George Gusciora, MHPCC + * @author Paul Price, IfA + * + * @version $Revision: 1.10 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:15 $ + * Copyright 2004-2006 Institute for Astronomy, University of Hawaii + */ #ifndef PM_READOUT_COMBINE_H #define PM_READOUT_COMBINE_H + +/// @addtogroup imcombine Image Combinations +/// @{ #include @@ -50,3 +48,4 @@ ); +/// @} #endif Index: /trunk/psModules/src/objects/pmGrowthCurve.h =================================================================== --- /trunk/psModules/src/objects/pmGrowthCurve.h (revision 11252) +++ /trunk/psModules/src/objects/pmGrowthCurve.h (revision 11253) @@ -1,5 +1,17 @@ +/* @file pmGrowthCurve.h + * @brief functions to manipulate the curve-of-growth data + * + * @author EAM, IfA + * + * @version $Revision: 1.7 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:15 $ + * Copyright 2006 Institute for Astronomy, University of Hawaii + */ # ifndef PM_GROWTH_CURVE_H # define PM_GROWTH_CURVE_H + +/// @addtogroup Objects Object Detection / Analysis Functions +/// @{ typedef struct @@ -18,3 +30,4 @@ psF32 pmGrowthCurveCorrect (pmGrowthCurve *growth, psF32 radius); +/// @} # endif /* PM_GROWTH_CURVE_H */ Index: /trunk/psModules/src/objects/pmModel.h =================================================================== --- /trunk/psModules/src/objects/pmModel.h (revision 11252) +++ /trunk/psModules/src/objects/pmModel.h (revision 11253) @@ -1,18 +1,18 @@ -/** @file pmObjects.h +/* @file pmObjects.h + * @brief Functions to define and manipulate object models * - * Functions to define and manipulate object models + * @author GLG, MHPCC + * @author EAM, IfA * - * @author GLG, MHPCC - * @author EAM, IfA - * - * @version $Revision: 1.5 $ $Name: not supported by cvs2svn $ - * @date $Date: 2006-10-31 19:38:44 $ - * - * Copyright 2004 Maui High Performance Computing Center, University of Hawaii - * + * @version $Revision: 1.6 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:15 $ + * Copyright 2004 Maui High Performance Computing Center, University of Hawaii */ # ifndef PM_MODEL_H # define PM_MODEL_H + +/// @addtogroup Objects Object Detection / Analysis Functions +/// @{ // type of model carried by the pmModel structure @@ -125,3 +125,4 @@ ); +/// @} # endif /* PM_MODEL_H */ Index: /trunk/psModules/src/objects/pmModelGroup.h =================================================================== --- /trunk/psModules/src/objects/pmModelGroup.h (revision 11252) +++ /trunk/psModules/src/objects/pmModelGroup.h (revision 11253) @@ -1,21 +1,22 @@ -/** @file pmModelGroup.h - * - * The object model function types are defined to allow for the flexible addition - * of new object models. Every object model, with parameters represented by - * pmModel, has an associated set of functions which provide necessary support - * operations. A set of abstract functions allow the programmer to select the - * approriate function or property for a specific named object model. - * - * @author EAM, IfA - * - * @version $Revision: 1.6 $ $Name: not supported by cvs2svn $ - * @date $Date: 2006-11-29 02:36:07 $ - * - * Copyright 2004 Maui High Performance Computing Center, University of Hawaii - * +/* @file pmModelGroup.h + * + * The object model function types are defined to allow for the flexible addition + * of new object models. Every object model, with parameters represented by + * pmModel, has an associated set of functions which provide necessary support + * operations. A set of abstract functions allow the programmer to select the + * approriate function or property for a specific named object model. + * + * @author EAM, IfA + * + * @version $Revision: 1.7 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:15 $ + * Copyright 2004 Maui High Performance Computing Center, University of Hawaii */ # ifndef PM_MODEL_GROUP_H # define PM_MODEL_GROUP_H + +/// @addtogroup Objects Object Detection / Analysis Functions +/// @{ // This function is the model chi-square minimization function for this model. @@ -200,3 +201,4 @@ ); +/// @} # endif /* PM_MODEL_GROUP_H */ Index: /trunk/psModules/src/objects/pmMoments.h =================================================================== --- /trunk/psModules/src/objects/pmMoments.h (revision 11252) +++ /trunk/psModules/src/objects/pmMoments.h (revision 11253) @@ -1,17 +1,17 @@ -/** @file pmMoments.h +/* @file pmMoments.h + * @brief Definitions of the moments structure * - * Definitions of the moments structure + * @author GLG, MHPCC * - * @author GLG, MHPCC - * - * @version $Revision: 1.2 $ $Name: not supported by cvs2svn $ - * @date $Date: 2006-04-17 18:01:05 $ - * - * Copyright 2004 Maui High Performance Computing Center, University of Hawaii - * + * @version $Revision: 1.3 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:15 $ + * Copyright 2004 Maui High Performance Computing Center, University of Hawaii */ # ifndef PM_MOMENTS_H # define PM_MOMENTS_H + +/// @addtogroup Objects Object Detection / Analysis Functions +/// @{ /** pmMoments data structure @@ -43,3 +43,4 @@ pmMoments *pmMomentsAlloc(); +/// @} # endif Index: /trunk/psModules/src/objects/pmObjects.h =================================================================== --- /trunk/psModules/src/objects/pmObjects.h (revision 11252) +++ /trunk/psModules/src/objects/pmObjects.h (revision 11253) @@ -1,3 +1,3 @@ -/** @file pmObjects.h +/* @file pmObjects.h * * The process of finding, measuring, and classifying astronomical sources on @@ -8,15 +8,16 @@ * construct a complete object measurement suite. * - * @author GLG, MHPCC + * @author GLG, MHPCC * - * @version $Revision: 1.7 $ $Name: not supported by cvs2svn $ - * @date $Date: 2006-10-18 02:29:15 $ - * - * Copyright 2004 Maui High Performance Computing Center, University of Hawaii - * + * @version $Revision: 1.8 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:15 $ + * Copyright 2004 Maui High Performance Computing Center, University of Hawaii */ #ifndef PM_OBJECTS_H #define PM_OBJECTS_H + +/// @addtogroup Objects Object Detection / Analysis Functions +/// @{ #include @@ -64,4 +65,4 @@ ); - +/// @} #endif Index: /trunk/psModules/src/objects/pmPSF.h =================================================================== --- /trunk/psModules/src/objects/pmPSF.h (revision 11252) +++ /trunk/psModules/src/objects/pmPSF.h (revision 11253) @@ -1,16 +1,19 @@ -/** @file pmPSF.h +/* @file pmPSF.h * * This file contains typedefs for the Point-Spread Function and prototypes * for functions that calculate the PSF. * - * @author EAM, IfA + * @author EAM, IfA * - * - * Copyright 2004 Maui High Performance Computing Center, University of Hawaii - * + * @version $Revision: 1.11 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:15 $ + * Copyright 2004 Maui High Performance Computing Center, University of Hawaii */ # ifndef PM_PSF_H # define PM_PSF_H + +/// @addtogroup Objects Object Detection / Analysis Functions +/// @{ typedef enum { @@ -96,3 +99,4 @@ pmPSF *pmPSFBuildSimple (char *typeName, float sxx, float syy, float sxy, ...); +/// @} # endif Index: /trunk/psModules/src/objects/pmPSF_IO.h =================================================================== --- /trunk/psModules/src/objects/pmPSF_IO.h (revision 11252) +++ /trunk/psModules/src/objects/pmPSF_IO.h (revision 11253) @@ -1,18 +1,19 @@ -/** @file pmPSF.h +/* @file pmPSF.h * * This file contains typedefs for the Point-Spread Function and prototypes * for functions that calculate the PSF. * - * @author EAM, IfA + * @author EAM, IfA * - * @version $Revision: 1.4 $ $Name: not supported by cvs2svn $ - * @date $Date: 2006-12-03 18:48:10 $ - * - * Copyright 2004 Maui High Performance Computing Center, University of Hawaii - * + * @version $Revision: 1.5 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:15 $ + * Copyright 2004 Maui High Performance Computing Center, University of Hawaii */ # ifndef PM_PSF_IO_H # define PM_PSF_IO_H + +/// @addtogroup Objects Object Detection / Analysis Functions +/// @{ psMetadata *pmPSFtoMetadata (psMetadata *metadata, pmPSF *psf); @@ -30,3 +31,4 @@ bool pmReadoutReadPSFmodel (pmReadout *readout, const pmFPAview *view, pmFPAfile *file, pmConfig *config); +/// @} # endif Index: /trunk/psModules/src/objects/pmPSFtry.h =================================================================== --- /trunk/psModules/src/objects/pmPSFtry.h (revision 11252) +++ /trunk/psModules/src/objects/pmPSFtry.h (revision 11253) @@ -1,14 +1,12 @@ -/** @file pmPSFtry.h +/* @file pmPSFtry.h * * This file contains code that allows the user to try to fit several * PSF models to an image. * - * @author EAM, IfA + * @author EAM, IfA * - * @version $Revision: 1.10 $ $Name: not supported by cvs2svn $ - * @date $Date: 2006-11-26 22:21:50 $ - * - * Copyright 2004 Maui High Performance Computing Center, University of Hawaii - * + * @version $Revision: 1.11 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:15 $ + * Copyright 2004 Maui High Performance Computing Center, University of Hawaii */ @@ -16,4 +14,6 @@ # define PM_PSF_TRY_H +/// @addtogroup Objects Object Detection / Analysis Functions +/// @{ /** @@ -125,3 +125,4 @@ bool pmPSFFromPSFtry (pmPSFtry *psfTry, bool applyWeights); +/// @} # endif Index: /trunk/psModules/src/objects/pmPeaks.h =================================================================== --- /trunk/psModules/src/objects/pmPeaks.h (revision 11252) +++ /trunk/psModules/src/objects/pmPeaks.h (revision 11253) @@ -1,3 +1,3 @@ -/** @file pmPeaks.h +/* @file pmPeaks.h * * The process of finding, measuring, and classifying astronomical sources on @@ -8,15 +8,16 @@ * construct a complete object measurement suite. * - * @author GLG, MHPCC + * @author GLG, MHPCC * - * @version $Revision: 1.5 $ $Name: not supported by cvs2svn $ - * @date $Date: 2007-01-19 04:36:53 $ - * - * Copyright 2004 Maui High Performance Computing Center, University of Hawaii - * + * @version $Revision: 1.6 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:15 $ + * Copyright 2004 Maui High Performance Computing Center, University of Hawaii */ # ifndef PM_PEAKS_H # define PM_PEAKS_H + +/// @addtogroup Objects Object Detection / Analysis Functions +/// @{ /** pmPeakType @@ -147,3 +148,4 @@ int pmPeaksCompareDescend (const void **a, const void **b); +/// @} # endif /* PM_PEAKS_H */ Index: /trunk/psModules/src/objects/pmSource.h =================================================================== --- /trunk/psModules/src/objects/pmSource.h (revision 11252) +++ /trunk/psModules/src/objects/pmSource.h (revision 11253) @@ -1,15 +1,16 @@ -/** @file pmSource.h - * - * @author EAM, IfA; GLG, MHPCC - * - * @version $Revision: 1.9 $ $Name: not supported by cvs2svn $ - * @date $Date: 2007-01-20 02:01:20 $ - * - * Copyright 2004 Maui High Performance Computing Center, University of Hawaii - * +/* @file pmSource.h + * + * @author EAM, IfA; GLG, MHPCC + * + * @version $Revision: 1.10 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:15 $ + * Copyright 2004 Maui High Performance Computing Center, University of Hawaii */ # ifndef PM_SOURCE_H # define PM_SOURCE_H + +/// @addtogroup Objects Object Detection / Analysis Functions +/// @{ /** @@ -228,3 +229,4 @@ pmModel *pmSourceSelectModel (pmSource *source); +/// @} # endif /* PM_SOURCE_H */ Index: /trunk/psModules/src/objects/pmSourceContour.h =================================================================== --- /trunk/psModules/src/objects/pmSourceContour.h (revision 11252) +++ /trunk/psModules/src/objects/pmSourceContour.h (revision 11253) @@ -1,15 +1,16 @@ -/** @file pmSourceContour.h +/* @file pmSourceContour.h * - * @author EAM, IfA; GLG, MHPCC + * @author EAM, IfA; GLG, MHPCC * - * @version $Revision: 1.2 $ $Name: not supported by cvs2svn $ - * @date $Date: 2006-04-17 18:01:05 $ - * - * Copyright 2004 Maui High Performance Computing Center, University of Hawaii - * + * @version $Revision: 1.3 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:15 $ + * Copyright 2004 Maui High Performance Computing Center, University of Hawaii */ # ifndef PM_SOURCE_CONTOUR_H # define PM_SOURCE_CONTOUR_H + +/// @addtogroup Objects Object Detection / Analysis Functions +/// @{ psArray *pmSourceContour (psImage *image, int xc, int yc, float threshold); @@ -35,3 +36,4 @@ ); +/// @} # endif /* PM_SOURCE_PHOTOMETRY_H */ Index: /trunk/psModules/src/objects/pmSourceFitModel.h =================================================================== --- /trunk/psModules/src/objects/pmSourceFitModel.h (revision 11252) +++ /trunk/psModules/src/objects/pmSourceFitModel.h (revision 11253) @@ -1,15 +1,16 @@ -/** @file pmSourceFitModel.h +/* @file pmSourceFitModel.h * - * @author EAM, IfA; GLG, MHPCC + * @author EAM, IfA; GLG, MHPCC * - * @version $Revision: 1.4 $ $Name: not supported by cvs2svn $ - * @date $Date: 2006-11-29 02:44:21 $ - * - * Copyright 2004 Maui High Performance Computing Center, University of Hawaii - * + * @version $Revision: 1.5 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:15 $ + * Copyright 2004 Maui High Performance Computing Center, University of Hawaii */ # ifndef PM_SOURCE_FIT_MODEL_H # define PM_SOURCE_FIT_MODEL_H + +/// @addtogroup Objects Object Detection / Analysis Functions +/// @{ typedef enum { @@ -71,3 +72,4 @@ ); +/// @} # endif /* PM_SOURCE_FIT_MODEL_H */ Index: /trunk/psModules/src/objects/pmSourceIO.h =================================================================== --- /trunk/psModules/src/objects/pmSourceIO.h (revision 11252) +++ /trunk/psModules/src/objects/pmSourceIO.h (revision 11253) @@ -1,10 +1,10 @@ -/** @file pmSourceIO.h +/* @file pmSourceIO.h + * @brief functions to read and write object files * - * @author EAM, IfA; GLG, MHPCC + * @author EAM, IfA; GLG, MHPCC * - * @version $Revision: 1.4 $ $Name: not supported by cvs2svn $ - * @date $Date: 2006-12-03 18:48:10 $ - * - * Copyright 2004 Maui High Performance Computing Center, University of Hawaii + * @version $Revision: 1.5 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:15 $ + * Copyright 2004 Maui High Performance Computing Center, University of Hawaii * */ @@ -12,4 +12,7 @@ # ifndef PM_SOURCE_IO_H # define PM_SOURCE_IO_H + +/// @addtogroup Objects Object Detection / Analysis Functions +/// @{ int pmSourceDophotType (pmSource *source); @@ -42,3 +45,4 @@ bool pmReadoutWriteObjects (pmReadout *readout, const pmFPAview *view, pmFPAfile *file, pmConfig *config); +/// @} # endif /* PM_SOURCE_IO_H */ Index: /trunk/psModules/src/objects/pmSourcePhotometry.h =================================================================== --- /trunk/psModules/src/objects/pmSourcePhotometry.h (revision 11252) +++ /trunk/psModules/src/objects/pmSourcePhotometry.h (revision 11253) @@ -1,15 +1,17 @@ -/** @file pmSourcePhotometry.h +/* @file pmSourcePhotometry.h + * @brief functions to measure source photometry * - * @author EAM, IfA; GLG, MHPCC + * @author EAM, IfA; GLG, MHPCC * - * @version $Revision: 1.7 $ $Name: not supported by cvs2svn $ - * @date $Date: 2006-11-17 23:02:21 $ - * - * Copyright 2004 Maui High Performance Computing Center, University of Hawaii - * + * @version $Revision: 1.8 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:15 $ + * Copyright 2004 Maui High Performance Computing Center, University of Hawaii */ # ifndef PM_SOURCE_PHOTOMETRY_H # define PM_SOURCE_PHOTOMETRY_H + +/// @addtogroup Objects Object Detection / Analysis Functions +/// @{ /** @@ -55,3 +57,5 @@ double pmSourceWeight(const pmSource *Mi, int term, const bool unweighted_sum); + +/// @} # endif /* PM_SOURCE_PHOTOMETRY_H */ Index: /trunk/psModules/src/objects/pmSourcePlots.h =================================================================== --- /trunk/psModules/src/objects/pmSourcePlots.h (revision 11252) +++ /trunk/psModules/src/objects/pmSourcePlots.h (revision 11253) @@ -1,18 +1,17 @@ -/** @file pmSourcePlots.h -* -* @brief functions to create plots illustrating source properties -* -* @ingroup none -* -* @author EAM, IfA -* -* @version $Revision: 1.1 $ $Name: not supported by cvs2svn $ -* @date $Date: 2006-12-23 04:00:30 $ -* -* Copyright 2006 Institute for Astronomy, University of Hawaii -*/ +/* @file pmSourcePlots.h + * @brief functions to create plots illustrating source properties + * + * @author EAM, IfA + * + * @version $Revision: 1.2 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:15 $ + * Copyright 2006 Institute for Astronomy, University of Hawaii + */ #ifndef PM_SOURCE_PLOTS_H #define PM_SOURCE_PLOTS_H + +/// @addtogroup Objects Object Detection / Analysis Functions +/// @{ typedef struct @@ -38,3 +37,4 @@ bool pmSourcePlotMoments (const pmFPAview *view, pmFPAfile *file, pmConfig *config, pmSourcePlotLayout *layout); +/// @} #endif // PM_SOURCE_PLOTS_H Index: /trunk/psModules/src/objects/pmSourceSky.h =================================================================== --- /trunk/psModules/src/objects/pmSourceSky.h (revision 11252) +++ /trunk/psModules/src/objects/pmSourceSky.h (revision 11253) @@ -1,15 +1,15 @@ -/** @file pmSourceSky.h +/* @file pmSourceSky.h + * @author EAM, IfA; GLG, MHPCC * - * @author EAM, IfA; GLG, MHPCC - * - * @version $Revision: 1.2 $ $Name: not supported by cvs2svn $ - * @date $Date: 2006-04-17 18:01:05 $ - * - * Copyright 2004 Maui High Performance Computing Center, University of Hawaii - * + * @version $Revision: 1.3 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:15 $ + * Copyright 2004 Maui High Performance Computing Center, University of Hawaii */ # ifndef PM_SOURCE_SKY_H # define PM_SOURCE_SKY_H + +/// @addtogroup Objects Object Detection / Analysis Functions +/// @{ /** pmSourceLocalSky() @@ -40,3 +40,4 @@ ); +/// @} # endif /* PM_SOURCE_PHOTOMETRY_H */