IPP Software Navigation Tools IPP Links Communication Pan-STARRS Links

Changeset 21360


Ignore:
Timestamp:
Feb 5, 2009, 3:37:17 PM (17 years ago)
Author:
giebink
Message:

ppSub Doxygen tags and Doxygen configuration files added

Location:
trunk
Files:
2 added
19 edited

Legend:

Unmodified
Added
Removed

  • trunk/ppSub/src/ppSub.c

    r21257 r21360  
     1/** @file ppSub.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup ppSub
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.10 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-06 01:37:17 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113#include "ppSub.h"
    214

  • trunk/ppSub/src/ppSub.h

    r21257 r21360  
     1/** @file ppSub.h
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup ppSub
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.6 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-06 01:37:17 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113#ifndef PP_SUB_H
    214#define PP_SUB_H
    … …  
    1224#include <psphot.h>
    1325#include <ppStats.h>
     26
     27/// @addtogroup ppSub
     28/// @{
    1429
    1530#define PPSUB_RECIPE "PPSUB"            /// Name of the recipe to use
    … …  
    115130bool psMetadataCopySingle(psMetadata *target, psMetadata *source, const char *name);
    116131
     132///@}
    117133#endif

  • trunk/ppSub/src/ppSubArguments.c

    r21257 r21360  
     1/** @file ppSubArguments.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup ppSub
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.56 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-06 01:37:17 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113#include "ppSub.h"
    214
    … …  
    5062}
    5163
    52 // Get a string value from the command-line and add it to the target
     64/**
     65 * Get a string value from the command-line and add it to the target
     66 */
    5367static bool valueArgStr(psMetadata *arguments, // Command-line arguments
    5468                        const char *argName, // Argument name in the command-line arguments
    … …  
    6478}
    6579
    66 // Get a string value from the command-line or recipe and add it to the target
     80/**
     81 * Get a string value from the command-line or recipe and add it to the target
     82 */
    6783static bool valueArgRecipeStr(psMetadata *arguments, // Command-line arguments
    6884                              psMetadata *recipe, // Recipe
    … …  
    85101}
    86102
    87 // Get a vector from the command-line or recipe, and add it to the target
     103/**
     104 * Get a vector from the command-line or recipe, and add it to the target
     105 */
    88106static bool vectorArgRecipe(psMetadata *arguments, // Command-line arguments
    89107                            const char *argName, // Argument name in the command-line arguments
    … …  
    146164}
    147165
    148 // Add a single filename to the arguments as an array, so that it can be used with pmFPAfileBindFromArgs, etc
     166/**
     167 * Add a single filename to the arguments as an array, so that it can be used with pmFPAfileBindFromArgs, etc
     168 */
    149169static void fileList(const char *file, // The symbolic name for the file
    150170                     const char *name, // The name of the file

  • trunk/ppSub/src/ppSubBackground.c

    r21257 r21360  
     1/** @file ppSubBackground.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup ppSub
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.6 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-06 01:37:17 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113#include "ppSub.h"
    214
    3 // Based on ppImageSubtractBackground()
     15/**
     16 * Based on ppImageSubtractBackground()
     17 */
    418bool ppSubBackground(pmConfig *config, const pmFPAview *view)
    519{

  • trunk/ppSub/src/ppSubCamera.c

    r21257 r21360  
     1/** @file ppSubCamera.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup ppSub
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.32 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-06 01:37:17 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113#include "ppSub.h"
    214

  • trunk/ppSub/src/ppSubDefineOutput.c

    r21257 r21360  
     1/** @file ppSubDefineOutput.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup ppSub
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-06 01:37:17 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113#include "ppSub.h"
    214

  • trunk/ppSub/src/ppSubExtras.c

    r21257 r21360  
     1/** @file ppSubExtras.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup ppSub
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-06 01:37:17 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113#include "ppSub.h"
    214
    … …  
    416// psModules or psLib.
    517
    6 // Copy every instance of a single keyword from one metadata to another
     18/**
     19 * Copy every instance of a single keyword from one metadata to another
     20 */
    721bool psMetadataCopySingle(psMetadata *target, psMetadata *source, const char *name)
    822{

  • trunk/ppSub/src/ppSubKernel.c

    r20053 r21360  
     1/** @file ppSubKernel.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup ppSub
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-06 01:37:17 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113#ifdef HAVE_CONFIG_H
    214#include <config.h>
    … …  
    719#include <psmodules.h>
    820
    9 #define KERNEL_MOSAIC 2                 // Half-number of kernel instances in the mosaic image
     21#define KERNEL_MOSAIC 2                 ///< Half-number of kernel instances in the mosaic image
    1022
    1123

  • trunk/ppSub/src/ppSubLoop.c

    r21257 r21360  
     1/** @file ppSubLoop.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup ppSub
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.23 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-06 01:37:17 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113#include "ppSub.h"
    214

  • trunk/ppSub/src/ppSubMakePSF.c

    r21257 r21360  
     1/** @file ppSubMakePSF.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup ppSub
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-06 01:37:17 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113#include "ppSub.h"
    214
    3 // Photometry stage 1: measure the PSF from the minuend image
     15/**
     16 * Photometry stage 1: measure the PSF from the minuend image
     17 */
    418bool ppSubMakePSF (pmConfig *config, const pmFPAview *view) {
    519

  • trunk/ppSub/src/ppSubMatchPSFs.c

    r21257 r21360  
     1/** @file ppSubMatchPSFs.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup ppSub
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-06 01:37:17 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113#include "ppSub.h"
    214
    3 // Generate the PSF-matching kernel and convolve the images as needed.  Most of this function
    4 // involves looking up the parameters in the recipe and supplying them to the function
    5 // pmSubtractionMatch();
     15/** Generate the PSF-matching kernel and convolve the images as needed.  Most of this function
     16 * involves looking up the parameters in the recipe and supplying them to the function
     17 * pmSubtractionMatch();
     18 */
    619
    720bool ppSubMatchPSFs (pmConfig *config, const pmFPAview *view) {

  • trunk/ppSub/src/ppSubReadout.c

    r21257 r21360  
     1/** @file ppSubReadout.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup ppSub
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.111 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-06 01:37:17 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113#include "ppSub.h"
    214

  • trunk/ppSub/src/ppSubReadoutPhotometry.c

    r21257 r21360  
     1/** @file ppSubReadoutPhotometry.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup ppSub
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-06 01:37:17 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113#include "ppSub.h"
    214
    3 // Photometry stage 2: find and measure sources on the subtracted image
     15/**
     16 * Photometry stage 2: find and measure sources on the subtracted image
     17 */
    418bool ppSubReadoutPhotometry (pmConfig *config, psMetadata *stats, const pmFPAview *view) {
    519

  • trunk/ppSub/src/ppSubReadoutRenorm.c

    r21257 r21360  
     1/** @file ppSubReadoutRenorm.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup ppSub
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-06 01:37:17 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113#include "ppSub.h"
    214
    … …  
    2335}
    2436
    25 // old-style variance renormalization
     37/**
     38 * old-style variance renormalization
     39 */
    2640bool ppSubReadoutRenormPhot (pmConfig *config, psMetadata *recipe, pmReadout *readout) {
    2741

  • trunk/ppSub/src/ppSubReadoutSubtract.c

    r21257 r21360  
     1/** @file ppSubReadoutSubtract.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup ppSub
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-06 01:37:17 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113#include "ppSub.h"
    214#define WCS_TOLERANCE 0.001             // Tolerance for WCS

  • trunk/ppSub/src/ppSubReadoutUpdate.c

    r21257 r21360  
     1/** @file ppSubReadoutUpdate.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup ppSub
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-06 01:37:17 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113#include "ppSub.h"
    214
    3 // Renormalize, update headers and generate JPEGs
     15/**
     16 * Renormalize, update headers and generate JPEGs
     17 */
    418bool ppSubReadoutUpdate (pmConfig *config, const pmFPAview *view) {
    519

  • trunk/ppSub/src/ppSubSetMasks.c

    r21257 r21360  
     1/** @file ppSubSetMasks.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup ppSub
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-06 01:37:17 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113#include "ppSub.h"
    214
    3 // this function generates (if needed) and sets or updates the masks for both the input and
    4 // reference images.  this function also has the code for interpolation over bad pixels, but it
    5 // is currently if-def-ed out
     15/** this function generates (if needed) and sets or updates the masks for both the input and
     16 * reference images.  this function also has the code for interpolation over bad pixels, but it
     17 * is currently if-def-ed out
     18 */
    619
    720bool ppSubSetMasks (pmConfig *config, const pmFPAview *view) {

  • trunk/ppSub/src/ppSubVarianceFactors.c

    r21257 r21360  
     1/** @file ppSubVarianceFactors.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup ppSub
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-06 01:37:17 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113#include "ppSub.h"
    214
    3 // Calculate the variance factor for the output image based on the input images
     15/**
     16 * Calculate the variance factor for the output image based on the input images
     17 */
    418bool ppSubVarianceFactors (pmConfig *config, psMetadata *stats, const pmFPAview *view) {
    519

  • trunk/ppSub/src/ppSubVersion.c

    r21257 r21360  
     1/** @file ppSubVersion.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup ppSub
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-06 01:37:17 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113#include "ppSub.h"
    214
    3 static const char *cvsTag = "$Name: not supported by cvs2svn $";// CVS tag name
     15static const char *cvsTag = "$Name: not supported by cvs2svn $";///< CVS tag name
    416
    517psString ppSubVersion(void)
Note: See TracChangeset for help on using the changeset viewer.