IPP Software Navigation Tools IPP Links Communication Pan-STARRS Links

Ignore:
Timestamp:
Aug 3, 2004, 2:55:17 PM (22 years ago)
Author:
desonia
Message:

doxygen grouping tweaks.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/psLib/src/astronomy/psCoord2.h

    r1312 r1374  
    11/** @file  psCoord2.h
    2  *
    3  *  @brief Contains basic coordinate transformation definitions and operations
    4  *
    5  *  This file defines the basic types for astronomical coordinate
    6  *  transformation
    7  *
    8  *  @ingroup AstroImage
    9  *
    10  *  @author George Gusciora, MHPCC
    11  *
    12  *  @version $Revision: 1.1 $ $Name: not supported by cvs2svn $
    13  *  @date $Date: 2004-07-28 22:31:19 $
    14  *
    15  *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    16  */
     2*
     3*  @brief Contains basic coordinate transformation definitions and operations
     4*
     5*  This file defines the basic types for astronomical coordinate
     6*  transformation
     7*
     8*  @ingroup CoordinateTransform
     9*
     10*  @author George Gusciora, MHPCC
     11*
     12*  @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
     13*  @date $Date: 2004-08-04 00:55:17 $
     14*
     15*  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
     16*/
    1717
    1818# ifndef PS_COORD2_H
     
    2525#include "psFunctions.h"
    2626
     27/// @addtogroup CoordinateTransform
     28/// @{
     29
    2730typedef struct
    28 {
    29     const double latitude;             ///<
    30     const double sinLat, cosLat;       ///<
    31     const double abberationMag;        ///<
    32     const double height;               ///<
    33     const double temperature;          ///<
    34     const double pressure;             ///<
    35     const double humidity;             ///<
    36     const double wavelength;           ///<
    37     const double lapseRate;            ///<
    38     const double refractA, refractB;   ///<
    39     const double longitudeOffset;      ///<
    40     const double siderealTime;         ///<
    41 }
     31    {
     32        const double latitude;             ///<
     33        const double sinLat, cosLat;       ///<
     34        const double abberationMag;        ///<
     35        const double height;               ///<
     36        const double temperature;          ///<
     37        const double pressure;             ///<
     38        const double humidity;             ///<
     39        const double wavelength;           ///<
     40        const double lapseRate;            ///<
     41        const double refractA, refractB;   ///<
     42        const double longitudeOffset;      ///<
     43        const double siderealTime;         ///<
     44    }
    4245psGrommit;
    4346
    4447typedef struct
    45 {
    46     int nX, nY;               ///<
    47     double x0, y0;            ///<
    48     double xScale, yScale;    ///<
    49     double **x, **y;          ///<
    50 }
     48    {
     49        int nX, nY;               ///<
     50        double x0, y0;            ///<
     51        double xScale, yScale;    ///<
     52        double **x, **y;          ///<
     53    }
    5154psFixedPattern;
    5255
    53 psGrommit *psGrommitAlloc(const psExposure *exp);
     56psGrommit *psGrommitAlloc( const psExposure *exp );
    5457
    55 void p_psGrommitFree(psGrommit *grommit);
     58void p_psGrommitFree( psGrommit *grommit );
    5659
    57 psCell *psCellinFPA(psCell *out,
    58                     const psPlane *coord,
    59                     const psFPA *FPA);
    60 
    61 psChip *psChipinFPA(psChip *out,
    62                     const psPlane *coord,
    63                     const psFPA *FPA);
    64 
    65 psCell *psCellinChip(psCell *out,
     60psCell *psCellinFPA( psCell *out,
    6661                     const psPlane *coord,
    67                      const psChip *chip);
    68 
    69 
    70 
    71 
    72 psPlane *psCoordCelltoChip(psPlane *out,
     62                     const psFPA *FPA );
     63                     
     64psChip *psChipinFPA( psChip *out,
     65                     const psPlane *coord,
     66                     const psFPA *FPA );
     67                     
     68psCell *psCellinChip( psCell *out,
     69                      const psPlane *coord,
     70                      const psChip *chip );
     71                     
     72                     
     73                     
     74                     
     75psPlane *psCoordCelltoChip( psPlane *out,
     76                            const psPlane *in,
     77                            const psCell *cell );
     78                           
     79psPlane *psCoordChipToFPA( psPlane *out,
    7380                           const psPlane *in,
    74                            const psCell *cell);
    75 
    76 psPlane *psCoordChipToFPA(psPlane *out,
     81                           const psChip *chip );
     82                           
     83psPlane *psCoordFPAtoTP( psPlane *out,
     84                         const psPlane *in,
     85                         const psFPA *fpa );
     86                         
     87psSphere *psCoordTPtoSky( psSphere *out,
    7788                          const psPlane *in,
    78                           const psChip *chip);
    79 
    80 psPlane *psCoordFPAtoTP(psPlane *out,
    81                         const psPlane *in,
    82                         const psFPA *fpa);
    83 
    84 psSphere *psCoordTPtoSky(psSphere *out,
     89                          const psGrommit *grommit );
     90                         
     91psPlane *psCoordCellToFPA( psPlane *out,
     92                           const psPlane *in,
     93                           const psCell *cell );
     94                           
     95psSphere *psCoordCelltoSky( psSphere *out,
     96                            const psPlane *in,
     97                            const psCell *cell );
     98                           
     99psSphere *psCoordCelltoSkyQuick( psSphere *out,
     100                                 const psPlane *in,
     101                                 const psCell *cell );
     102                                 
     103psPlane *psCoordSkytoTP( psPlane *out,
     104                         const psSphere *in,
     105                         const psGrommit *grommit );
     106                         
     107psPlane *psCoordTPtoFPA( psPlane *out,
    85108                         const psPlane *in,
    86                          const psGrommit *grommit);
    87 
    88 psPlane *psCoordCellToFPA(psPlane *out,
    89                           const psPlane *in,
    90                           const psCell *cell);
    91 
    92 psSphere *psCoordCelltoSky(psSphere *out,
     109                         const psFPA *fpa );
     110                         
     111psPlane *psCoordFPAtoChip( psPlane *out,
    93112                           const psPlane *in,
    94                            const psCell *cell);
    95 
    96 psSphere *psCoordCelltoSkyQuick(psSphere *out,
    97                                 const psPlane *in,
    98                                 const psCell *cell);
    99 
    100 psPlane *psCoordSkytoTP(psPlane *out,
    101                         const psSphere *in,
    102                         const psGrommit *grommit);
    103 
    104 psPlane *psCoordTPtoFPA(psPlane *out,
    105                         const psPlane *in,
    106                         const psFPA *fpa);
    107 
    108 psPlane *psCoordFPAtoChip(psPlane *out,
    109                           const psPlane *in,
    110                           const psChip *chip);
    111 
    112 psPlane *psCoordChiptoCell(psPlane *out,
    113                            const psPlane *in,
    114                            const psCell *cell);
    115 
    116 psPlane *psCoordSkytoCell(psPlane *out,
    117                           const psSphere *in,
    118                           const psCell *cell);
    119 
    120 psPlane *psCoordSkytoCellQuick(psPlane *out,
    121                                const psSphere *in,
    122                                const psCell *cell);
     113                           const psChip *chip );
     114                           
     115psPlane *psCoordChiptoCell( psPlane *out,
     116                            const psPlane *in,
     117                            const psCell *cell );
     118                           
     119psPlane *psCoordSkytoCell( psPlane *out,
     120                           const psSphere *in,
     121                           const psCell *cell );
     122                           
     123psPlane *psCoordSkytoCellQuick( psPlane *out,
     124                                const psSphere *in,
     125                                const psCell *cell );
     126                               
     127                               
     128/// @}
    123129
    124130#endif
Note: See TracChangeset for help on using the changeset viewer.