IPP Software Navigation Tools IPP Links Communication Pan-STARRS Links

Changeset 21409


Ignore:
Timestamp:
Feb 6, 2009, 4:03:34 PM (17 years ago)
Author:
giebink
Message:

Added Doxygen tags

Location:
trunk/psastro/src
Files:
55 edited

Legend:

Unmodified
Added
Removed

  • trunk/psastro/src/gpcModel.c

    r15891 r21409  
     1/** @file gpcModel.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup gpcModel
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-07 02:03:34 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113# include "psastroStandAlone.h"
    214
     15/**
     16 * generate model for gpc based on input model for all but chips
     17 * USAGE: gpcModel (input) (output)
     18 */
    319int main (int argc, char **argv) {
    4 
    5     // USAGE: gpcModel (input) (output)
    6     // generate model for gpc based on input model for all but chips
    720
    821    if (argc != 3) {

  • trunk/psastro/src/psastro.c

    r17934 r21409  
     1/** @file psastro.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup psastro
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.28 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-07 02:03:34 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113# include "psastroStandAlone.h"
    214

  • trunk/psastro/src/psastro.h

    r20805 r21409  
    1 /* This file defines the library functions available to external programs.  It must be included
    2  * by programs which are compiled against psphot functions.
     1/** @file psastro.h
     2 *
     3 *  @brief This file defines the library functions available to external
     4 *  programs. 
     5 *
     6 *  It must be included by programs which are compiled against
     7 *  psphot functions.
     8 *
     9 *  @ingroup psastro
     10 *
     11 *  @author IfA
     12 *  @version $Revision: 1.48 $ $Name: not supported by cvs2svn $
     13 *  @date $Date: 2009-02-07 02:03:34 $
     14 *  Copyright 2009 Institute for Astronomy, University of Hawaii
    315 */
    416
    … …  
    719
    820# include "psastroErrorCodes.h"
    9 # define PSASTRO_RECIPE "PSASTRO" // Name of the recipe to use
     21
     22/// @addtogroup psastro
     23/// @{
     24
     25# define PSASTRO_RECIPE "PSASTRO" ///< Name of the recipe to use
    1026
    1127# define psMemCopy(A)(psMemIncrRefCounter((A)))
    … …  
    1430# define SIGN(X)  (((X) == 0) ? 0 : ((fabs((double)(X))) / (X)))
    1531
    16 // this structure represents a fit to the logN / logS curve for a set of stars
    17 // logN = offset + slope * logS
     32/**
     33 * this structure represents a fit to the logN / logS curve for a set of stars
     34 * logN = offset + slope * logS
     35 */
    1836typedef struct {
    19     double mMin;                        // minimum magnitude bin with data
    20     double mMax;                        // maximum magnitude bin with data
    21     double offset;                      // fitted line offset
    22     double slope;                       // fitted line slope
    23     double mPeak;                       // mag of peak bin
    24     int nPeak;                          // # of stars in peak bin
    25     int sPeak;                          // sum of stars to peak bin
     37    double mMin;                        ///< minimum magnitude bin with data
     38    double mMax;                        ///< maximum magnitude bin with data
     39    double offset;                      ///< fitted line offset
     40    double slope;                       ///< fitted line slope
     41    double mPeak;                       ///< mag of peak bin
     42    int nPeak;                          ///< # of stars in peak bin
     43    int sPeak;                          ///< sum of stars to peak bin
    2644} pmLumFunc;
    2745
    … …  
    123141bool psastroZeroPointFromRecipe (float *zeropt, float *exptime, pmFPA *fpa, psMetadata *recipe);
    124142
     143///@}
    125144# endif /* PSASTRO_H */

  • trunk/psastro/src/psastroAnalysis.c

    r20640 r21409  
     1/** @file psastroAnalysis.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup libpsastro
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.15 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-07 02:03:34 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113# include "psastroInternal.h"
    214

  • trunk/psastro/src/psastroArguments.c

    r20805 r21409  
     1/** @file psastroArguments.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup psastro
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.33 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-07 02:03:34 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113# include "psastroStandAlone.h"
    214

  • trunk/psastro/src/psastroAstromGuess.c

    r21183 r21409  
     1/** @file psastroAstromGuess.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup libpsastro
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.34 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-07 02:03:34 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113# include "psastroInternal.h"
    214# define DEBUG 0
    315
    4 // this function loads the header WCS astrometry terms into the fpa terms and applies the
    5 // astrometry to the detected objects.
    6 
    7 // this function assumes the initial astrometry arrives in the form of WCS keywords in the
    8 // headers corresponding to the chips.
    9 
     16/**
     17 * \brief This function loads the header WCS astrometry terms into the fpa
     18 * terms and applies the astrometry to the detected objects.
     19 *
     20 * This function assumes the initial astrometry arrives in the form of WCS
     21 * keywords in the headers corresponding to the chips.
     22 */
    1023bool psastroAstromGuess (int *nStars, pmConfig *config) {
    1124

  • trunk/psastro/src/psastroChipAstrom.c

    r20269 r21409  
     1/** @file psastroChipAstrom.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup libpsastro
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.29 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-07 02:03:34 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113# include "psastroInternal.h"
    2 # define NONLIN_TOL 0.001 /* tolerance in pixels */
     14# define NONLIN_TOL 0.001 ///< tolerance in pixels
    315
    416bool psastroChipAstrom (pmConfig *config) {

  • trunk/psastro/src/psastroChooseRefstars.c

    r19032 r21409  
     1/** @file psastroChooseRefstars.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup libpsastro
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.21 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-07 02:03:34 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113# include "psastroInternal.h"
    214

  • trunk/psastro/src/psastroCleanup.c

    r20805 r21409  
     1/** @file psastroCleanup.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup psastro
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.7 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-07 02:03:34 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113# include "psastroStandAlone.h"
    214

  • trunk/psastro/src/psastroConvert.c

    r16800 r21409  
     1/** @file psastroConvert.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup libpsastro
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.25 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-07 02:03:34 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113# include "psastroInternal.h"
    214// leak free 2006.04.27
    … …  
    157169}
    158170
    159 // sort by Mag (ascending)
     171/**
     172 * sort by Mag (ascending)
     173 */
    160174int psastroSortByMag (const void *a, const void *b)
    161175{

  • trunk/psastro/src/psastroDataLoad.c

    r17038 r21409  
     1/** @file psastroDataLoad.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup psastro
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.12 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-07 02:03:34 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113# include "psastroStandAlone.h"
    2 // this loop loads the data from the input files and selects the
    3 // brighter stars for astrometry
    4 // at the end of this function, the complete stellar data is loaded
    5 // into the correct fpa structure locations (readout.analysis:PSPHOT.SOURCES)
    614
    715# define ESCAPE { \
    … …  
    1119}
    1220 
    13 // all of the different astrometry analysis modes use the same data load loop
     21/**
     22 * \brief this loop loads the data from the input files and selects the
     23 * brighter stars for astrometry
     24 *
     25 * at the end of this function, the complete stellar data is loaded
     26 * into the correct fpa structure locations (readout.analysis:PSPHOT.SOURCES)
     27 * all of the different astrometry analysis modes use the same data load loop
     28 */
    1429bool psastroDataLoad (pmConfig *config) {
    1530

  • trunk/psastro/src/psastroDataSave.c

    r18007 r21409  
     1/** @file psastroDataSave.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup psastro
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.15 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-07 02:03:34 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113# include "psastroInternal.h"
    214
    … …  
    719}
    820 
    9 // this loop saves the photometry/astrometry data files
     21/**
     22 * this loop saves the photometry/astrometry data files
     23 */
    1024bool psastroDataSave (pmConfig *config) {
    1125

  • trunk/psastro/src/psastroDefineFiles.c

    r20641 r21409  
     1/** @file psastroDefineFiles.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup libpsastro
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.10 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-07 02:03:34 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113# include "psastroInternal.h"
    214

  • trunk/psastro/src/psastroDemoDump.c

    r19511 r21409  
     1/** @file psastroMosaicDemoDump.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup libpsastro
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.11 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-07 02:03:34 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113# include "psastroInternal.h"
    214
    3 // this function is used for test purposes (-trace psastro.dump.psastroAstromGuess 1)
     15/**
     16 * this function is used for test purposes
     17 * (-trace psastro.dump.psastroAstromGuess 1)
     18 */
    419bool psastroDumpStars (psArray *stars, char *filename) {
    520
    … …  
    2035}
    2136
    22 // this function is used for test purposes (-trace psastro.dump.psastroAstromGuess 1)
     37/** this function is used for test purposes
     38 * (-trace psastro.dump.psastroAstromGuess 1)
     39 */
    2340bool psastroDumpRawstars (psArray *rawstars, pmFPA *fpa, pmChip *chip) {
    2441
    … …  
    97114}
    98115
    99 // this function is used for test purposes (-trace psastro.dump.psastroLoadRefstars 1)
     116/**
     117 * this function is used for test purposes
     118 * (-trace psastro.dump.psastroLoadRefstars 1)
     119 */
    100120bool psastroDumpRefstars (psArray *refstars, char *filename) {
    101121
    … …  
    176196}
    177197
    178 // this function is used for test purposes (-trace psastro.dump 1)
     198/**
     199 * this function is used for test purposes (-trace psastro.dump 1)
     200 */
    179201bool psastroDumpGradients (psArray *gradients, char *filename) {
    180202

  • trunk/psastro/src/psastroDemoPlot.c

    r19594 r21409  
     1/** @file psastroMosaicDemoPlot.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup libpsastro
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.12 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-07 02:03:34 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113# include "psastroInternal.h"
    214

  • trunk/psastro/src/psastroErrorCodes.c.in

    r11274 r21409  
     1/** @file psastroErrorCodes.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup psastro
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-07 02:03:34 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
     13#include "pslib.h"
     14#include "psastroErrorCodes.h"
     15
    116/*
    217 * The line
    … …  
    520 * will be replaced by values from errorCodes.dat
    621 */
    7 #include "pslib.h"
    8 #include "psastroErrorCodes.h"
    9 
    1022void psastroErrorRegister(void)
    1123{

  • trunk/psastro/src/psastroErrorCodes.h.in

    r9580 r21409  
     1/** @file psastroErrorCodes.h
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup psastro
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-07 02:03:34 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113#if !defined(PSASTRO_ERROR_CODES_H)
    214#define PSASTRO_ERROR_CODES_H

  • trunk/psastro/src/psastroFixChips.c

    r21183 r21409  
     1/** @file psastroFixChips.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup libpsastro
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.8 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-07 02:03:34 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113# include "psastroInternal.h"
    2 # define NONLIN_TOL 0.001 /* tolerance in pixels */
     14# define NONLIN_TOL 0.001 ///< tolerance in pixels
    315# define DEBUG 0
    416

  • trunk/psastro/src/psastroFixChipsTest.c

    r20271 r21409  
     1/** @file psastroFixChipsTest.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup libpsastro
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-07 02:03:34 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113# include "psastroInternal.h"
    214# define NONLIN_TOL 0.001 /* tolerance in pixels */

  • trunk/psastro/src/psastroInternal.h

    r18007 r21409  
     1/** @file psastroInternal.h
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup psastro
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-07 02:03:34 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113# ifdef HAVE_CONFIG_H
    214# include <config.h>

  • trunk/psastro/src/psastroLoadRefstars.c

    r20805 r21409  
     1/** @file psastroLoadRefstars.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup libpsastro
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.35 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-07 02:03:34 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113# include "psastroInternal.h"
    214# define ELIXIR_MODE 1

  • trunk/psastro/src/psastroLuminosityFunction.c

    r21183 r21409  
     1/** @file psastroLuminosityFunction.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup libpsastro
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.18 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-07 02:03:34 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113# include "psastroInternal.h"
    214# define dMag 0.1

  • trunk/psastro/src/psastroMaskUpdates.c

    r21183 r21409  
     1/** @file psastroMaskUpdates.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup libpsastro
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.7 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-07 02:03:34 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113# include "psastroInternal.h"
    214
    … …  
    1729void psastroMaskRectangle (psImage *mask, psImageMaskType value, int x0, int y0, int x1, int y1);
    1830
    19 // create a mask or mask regions based on the collection of reference stars that are
    20 // in the vicinity of each chip
     31/**
     32 * create a mask or mask regions based on the collection of reference stars that * are in the vicinity of each chip
     33 */
    2134bool psastroMaskUpdates (pmConfig *config) {
    2235
    … …  
    327340}
    328341
    329 // convert chip coords to cell coords, given known cell
     342/**
     343 * convert chip coords to cell coords, given known cell
     344 */
    330345bool pmCellCoordsForChip (float *xCell, float *yCell, pmCell *cell, float xChip, float yChip) {
    331346
    … …  
    351366}
    352367
    353 // convert chip coords to cell coords, given known cell
     368/**
     369 * convert chip coords to cell coords, given known cell
     370 */
    354371bool pmChipCoordsForCell (float *xChip, float *yChip, pmCell *cell, float xCell, float yCell) {
    355372
    … …  
    412429}
    413430
    414 // identify the quadrant and draw the correct line
     431/**
     432 * identify the quadrant and draw the correct line
     433 */
    415434void psastroMaskLine (psImage *mask, psImageMaskType value, double x1, double y1, double x2, double y2, int dW) {
    416435
    … …  
    440459}
    441460
    442 // use the Bresenham line drawing technique
    443 // integer-only Bresenham line-draw version which is fast
     461/**
     462 * use the Bresenham line drawing technique
     463 * integer-only Bresenham line-draw version which is fast
     464 */
    444465void psastroMaskLineBresen (psImage *mask, psImageMaskType value, int X1, int Y1, int X2, int Y2, int dW, int swapcoords) {
    445466

  • trunk/psastro/src/psastroMetadataStats.c

    r18061 r21409  
     1/** @file psastroMetaDataStats.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup psastro
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-07 02:03:34 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113# include "psastroInternal.h"
    214

  • trunk/psastro/src/psastroModel.c

    r15891 r21409  
     1/** @file psastroModel.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup psastroModel
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-07 02:03:34 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113# include "psastroStandAlone.h"
    214

  • trunk/psastro/src/psastroModelAdjust.c

    r19515 r21409  
     1/** @file psastroModelAdjust.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup psastroModel
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-07 02:03:34 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113# include "psastroStandAlone.h"
    2 # define NONLIN_TOL 0.001 /* tolerance in pixels */
     14# define NONLIN_TOL 0.001 ///< tolerance in pixels
    315# define DEBUG 0
    416

  • trunk/psastro/src/psastroModelAnalysis.c

    r19516 r21409  
     1/** @file psastroModelAnalysis.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup psastroModel
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.7 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-07 02:03:34 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113# include "psastroStandAlone.h"
    214# define NONLIN_TOL 0.001

  • trunk/psastro/src/psastroModelArguments.c

    r21390 r21409  
     1/** @file psastroModelArguments.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup psastroModel
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-07 02:03:34 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113# include "psastroStandAlone.h"
    214

  • trunk/psastro/src/psastroModelBoresite.c

    r19578 r21409  
     1/** @file psastroModelBoresite.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup psastroModel
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.4 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-07 02:03:34 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113# include "psastroStandAlone.h"
    214
    3 // the full chisq is built of two associated sums over coordinates:
    4 // chisq = sum ((X_obs - X_fit(t))^2 + (Y_obs - Y_fit(t))^2)
    5 // we use split this into a 2x long vector and use coord[1] to distinguish the X and Y terms:
    6 // coord[0] = measured X or measured Y
    7 // coord[1] =          0 or          1
     15/**
     16 * the full chisq is built of two associated sums over coordinates:
     17 * chisq = sum ((X_obs - X_fit(t))^2 + (Y_obs - Y_fit(t))^2)
     18 * we use split this into a 2x long vector and use coord[1] to distinguish the X and Y terms:
     19 * coord[0] = measured X or measured Y
     20 * coord[1] =          0 or          1
     21 */
    822psF32 psastroModelBoresite (psVector *deriv, const psVector *params, const psVector *coord) {
    923

  • trunk/psastro/src/psastroModelDataLoad.c

    r15891 r21409  
     1/** @file psastroModelDataLoad.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup psastroModel
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-07 02:03:34 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113# include "psastroStandAlone.h"
    2 
    3 // this loop loads the header data from the input files, using the output pmFPAfile to guide
    4 // the chip selection and related issues
    514
    615# define ESCAPE { \
    … …  
    1019}
    1120 
    12 // all of the different astrometry analysis modes use the same data load loop
     21/**
     22 * this loop loads the header data from the input files, using the output
     23 * pmFPAfile to guide the chip selection and related issues
     24 * all of the different astrometry analysis modes use the same data load loop
     25 */
    1326bool psastroModelDataLoad (pmConfig *config) {
    1427

  • trunk/psastro/src/psastroModelDataSave.c

    r19517 r21409  
     1/** @file psastroModelDataSave.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup psastroModel
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-07 02:03:34 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113# include "psastroStandAlone.h"
    2 # define NONLIN_TOL 0.001 /* tolerance in pixels */
     14# define NONLIN_TOL 0.001 ///< tolerance in pixels
    315
    416# define ESCAPE { \

  • trunk/psastro/src/psastroModelFit.c

    r19576 r21409  
     1/** @file psastroModelFit.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup psastroModel
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-07 02:03:34 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113# include "psastroStandAlone.h"
    214

  • trunk/psastro/src/psastroModelFitBoresite.c

    r19577 r21409  
     1/** @file psastroModelFitBoresite.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup psastroModel
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-07 02:03:34 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113# include "psastroStandAlone.h"
    214
    3 // we now have a set of observed L,M values.  fit these to the boresite model
     15/**
     16 * we now have a set of observed L,M values.  fit these to the boresite model
     17 */
    418psVector *psastroModelFitBoresite (psVector *Xo, psVector *Yo, psVector *Po, char *outroot) {
    519

  • trunk/psastro/src/psastroModelParseCamera.c

    r15891 r21409  
     1/** @file psastroModelParseCamera.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup psastroModel
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-07 02:03:34 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113# include "psastroInternal.h"
    214

  • trunk/psastro/src/psastroMosaicAstrom.c

    r20800 r21409  
     1/** @file psastroMosaicAstrom.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup libpsastro
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.30 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-07 02:03:34 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113# include "psastroInternal.h"
    214# define NONLIN_TOL 0.001 /* tolerance in pixels */

  • trunk/psastro/src/psastroMosaicChipAstrom.c

    r20802 r21409  
     1/** @file psastroMosaiciChipAstrom.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup libpsastro
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.15 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-07 02:03:34 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113# include "psastroInternal.h"
    2 # define NONLIN_TOL 0.001 /* tolerance in pixels */
     14# define NONLIN_TOL 0.001 ///< tolerance in pixels
    315
    416bool psastroMosaicChipAstrom (pmFPA *fpa, psMetadata *recipe, int iteration) {

  • trunk/psastro/src/psastroMosaicCorrectDistortion.c

    r19314 r21409  
     1/** @file psastroMosaicCorrectDistortion.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup libpsastro
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-07 02:03:34 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113# include "psastroInternal.h"
    214

  • trunk/psastro/src/psastroMosaicDistortion.c

    r19519 r21409  
     1/** @file psastroMosaicDistortion.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup libpsastro
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-07 02:03:34 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113# include "psastroInternal.h"
    214# define DEBUG 0

  • trunk/psastro/src/psastroMosaicFPtoTP.c

    r21183 r21409  
     1/** @file psastroMosaicFPtoTP.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup libpsastro
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-07 02:03:34 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113# include "psastroInternal.h"
    214
    3 /************************************************/
    415psPlaneTransform *psastroMosaicFitRotAndScale (pmFPA *fpa) {
    516
    … …  
    115126}
    116127
    117 /*****************************/
    118128bool psastroMosaicApplyRotAndScale (pmFPA *fpa, psPlaneTransform *TPtoFP) {
    119129

  • trunk/psastro/src/psastroMosaicGradients.c

    r19311 r21409  
     1/** @file psastroMosaicGradients.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup libpsastro
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.11 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-07 02:03:34 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113# include "psastroInternal.h"
    214static int nPass = 0;

  • trunk/psastro/src/psastroMosaicOneChip.c

    r20803 r21409  
     1/** @file psastroMosaicOneChip.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup libpsastro
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.9 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-07 02:03:34 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113# include "psastroInternal.h"
    214

  • trunk/psastro/src/psastroMosaicSetAstrom.c

    r17108 r21409  
     1/** @file psastroMosaicSetAstrom.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup libpsastro
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.12 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-07 02:03:34 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113# include "psastroInternal.h"
    214

  • trunk/psastro/src/psastroMosaicSetMatch.c

    r20805 r21409  
     1/** @file psastroMosaicSetMatch.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup libpsastro
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.14 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-07 02:03:34 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113# include "psastroInternal.h"
    214

  • trunk/psastro/src/psastroOneChipFit.c

    r20805 r21409  
     1/** @file psastroOneChipFit.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup libpsastro
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.4 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-07 02:03:34 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113# include "psastroInternal.h"
    214

  • trunk/psastro/src/psastroOneChipGrid.c

    r16070 r21409  
     1/** @file psastroOneChipGrid.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup libpsastro
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-07 02:03:34 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113# include "psastroInternal.h"
    214

  • trunk/psastro/src/psastroParseCamera.c

    r19557 r21409  
     1/** @file psastroParseCamera.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup psastro
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.18 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-07 02:03:34 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113# include "psastroInternal.h"
    214

  • trunk/psastro/src/psastroRefstarSubset.c

    r20038 r21409  
     1/** @file psastroRefstarSubset.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup libpsastro
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.13 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-07 02:03:34 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113# include "psastroInternal.h"
    214

  • trunk/psastro/src/psastroRemoveClumps.c

    r20805 r21409  
     1/** @file psastroRemoveClumps.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup libpsastro
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-07 02:03:34 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113# include "psastroInternal.h"
    214
    3 // look for and exclude objects in clumps in the input list
     15/**
     16 * look for and exclude objects in clumps in the input list
     17 */
    418psArray *psastroRemoveClumps (psArray *input, int scale) {
    519
    … …  
    7589
    7690# if (0)
    77 // make a list of the outlier pixels
     91/**
     92 * make a list of the outlier pixels
     93 */
    7894psArray *badpix = psArrayAllocEmpty (16);
    7995for (int iy = 0; iy < count->numRows; iy++) {

  • trunk/psastro/src/psastroStandAlone.h

    r19387 r21409  
     1/** @file psastroStandAlone.h
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup psastro
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.7 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-07 02:03:34 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113# ifdef HAVE_CONFIG_H
    214# include <config.h>

  • trunk/psastro/src/psastroTestFuncs.c

    r15258 r21409  
     1/** @file psastroTestFuncs.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup libpsastro
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.7 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-07 02:03:34 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113# include "psastroInternal.h"
    214
    3 // write out objects
     15/**
     16 * write out objects
     17 */
    418bool psastroWriteStars (char *filename, psArray *sources) {
    519

  • trunk/psastro/src/psastroUseModel.c

    r19520 r21409  
     1/** @file psastroMosiacAstrom.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup libpsastro
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-07 02:03:34 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113# include "psastroInternal.h"
    2 # define NONLIN_TOL 0.001 /* tolerance in pixels */
     14# define NONLIN_TOL 0.001 ///< tolerance in pixels
    315# define DEBUG 0
    416
    5 // apply the generic astrometry model to this image.  this assumes the WCS terms either do not
    6 // exist or are invalid
     17/**
     18 * Apply the generic astrometry model to this image.  This assumes the WCS i
     19 * terms either do not exist or are invalid
     20 */
    721bool psastroUseModel (pmConfig *config, psMetadata *recipe) {
    822

  • trunk/psastro/src/psastroUtils.c

    r20804 r21409  
     1/** @file psastroUtils.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup libpsastro
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.24 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-07 02:03:34 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113# include "psastroInternal.h"
    214# define RENORM 0

  • trunk/psastro/src/psastroVersion.c

    r12806 r21409  
     1/** @file psastroVersion.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup libpsastro
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-07 02:03:34 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113#include "psastroInternal.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 psastroVersion(void)

  • trunk/psastro/src/psastroVisual.c

    r20805 r21409  
    1 /***********************************/
    2 /***Diagnostic plots for psastro****/
    3 /***********************************/
     1/** @file psastroVisual.c
     2 *
     3 *  @brief Diagnostic plots for psastro
     4 *
     5 *  @ingroup libpsastro
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-07 02:03:34 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    413#ifdef HAVE_CONFIG_H
    514#include <config.h>
    … …  
    4756/*****************************/
    4857
    49 /**  start or stop plotting */
     58/** 
     59 * start or stop plotting
     60 */
    5061bool psastroSetVisual (bool mode) {
    5162    isVisual = mode;
    … …  
    5465
    5566
    56 /** open, name, and resize a window if necessary*/
     67/**
     68 * open, name, and resize a window if necessary
     69 */
    5770bool psastroVisualInitWindow( int *kapid, char *name ) {
    5871    if (*kapid == -1) {
    … …  
    6982
    7083
    71 /** ask the user how to proceed*/
     84/**
     85 * ask the user how to proceed
     86 */
    7287bool psastroVisualAskUser( bool *plotflag ) {
    7388    char key[10];
    … …  
    87102
    88103
    89 /** destroy windows at the end of a run*/
     104/**
     105 * destroy windows at the end of a run
     106 */
    90107bool psastroVisualClose() {
    91108    if(kapa != -1)

  • trunk/psastro/src/psastroZeroPoint.c

    r20268 r21409  
     1/** @file psastroMosaicZeroPoint.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup libpsastro
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-07 02:03:34 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113# include "psastroInternal.h"
    214
    … …  
    6981}
    7082
    71 // we measure <dMag> and \sigma_dMag and write them to the header
     83/**
     84 * we measure <dMag> and \sigma_dMag and write them to the header
     85 */
    7286bool psastroZeroPointReadout(pmReadout *readout, float zeropt, float exptime) {
    7387
Note: See TracChangeset for help on using the changeset viewer.