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/astro/psCoord.h

    r1325 r1374  
    11/** @file  psCoord.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.6 $ $Name: not supported by cvs2svn $
    13  *  @date $Date: 2004-07-29 02:08:02 $
    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.7 $ $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_COORD_H
    … …  
    2626#include "psTime.h"
    2727
     28/// @addtogroup CoordinateTransform
     29/// @{
     30
    2831typedef struct
    29 {
    30     double x;      ///< x position
    31     double y;      ///< y position
    32     double xErr;   ///< Error in x position
    33     double yErr;   ///< Error in y position
    34 }
     32    {
     33        double x;      ///< x position
     34        double y;      ///< y position
     35        double xErr;   ///< Error in x position
     36        double yErr;   ///< Error in y position
     37    }
    3538psPlane;
    3639
    3740typedef struct
    38 {
    39     double r;      ///< RA
    40     double d;      ///< Dec
    41     double rErr;   ///< Error in RA
    42     double dErr;   ///< Error in Dec
    43 }
     41    {
     42        double r;      ///< RA
     43        double d;      ///< Dec
     44        double rErr;   ///< Error in RA
     45        double dErr;   ///< Error in Dec
     46    }
    4447psSphere;
    4548
    4649typedef struct
    47 {
    48     psDPolynomial2D *x;
    49     psDPolynomial2D *y;
    50 }
     50    {
     51        psDPolynomial2D *x;
     52        psDPolynomial2D *y;
     53    }
    5154psPlaneTransform;
    5255
    5356typedef struct
    54 {
    55     psDPolynomial4D *x;
    56     psDPolynomial4D *y;
    57 }
     57    {
     58        psDPolynomial4D *x;
     59        psDPolynomial4D *y;
     60    }
    5861psPlaneDistort;
    5962
    6063typedef struct
    61 {
    62     double sinPhi;                    ///< sin of North Pole lattitude
    63     double cosPhi;                    ///< cos of North Pole lattitude
    64     double Xo;                        ///< First PT of Ares lon
    65     double xo;                        ///< First PT of Ares equiv lon
    66 }
     64    {
     65        double sinPhi;                    ///< sin of North Pole lattitude
     66        double cosPhi;                    ///< cos of North Pole lattitude
     67        double Xo;                        ///< First PT of Ares lon
     68        double xo;                        ///< First PT of Ares equiv lon
     69    }
    6770psSphereTransform;
    6871
    6972typedef enum {
    70     PS_PROJ_TAN,       ///< Tangent projection
    71     PS_PROJ_SIN,       ///< Sine projection
    72     PS_PROJ_AIT,       ///< Aitoff projection
    73     PS_PROJ_PAR,       ///< Par projection
    74     PS_PROJ_GLS,       ///< GLS projection
    75     PS_PROJ_CAR,       ///< CAR projection
    76     PS_PROJ_MER,       ///< MER projection
     73    PS_PROJ_TAN,        ///< Tangent projection
     74    PS_PROJ_SIN,        ///< Sine projection
     75    PS_PROJ_AIT,        ///< Aitoff projection
     76    PS_PROJ_PAR,        ///< Par projection
     77    PS_PROJ_GLS,        ///< GLS projection
     78    PS_PROJ_CAR,        ///< CAR projection
     79    PS_PROJ_MER,        ///< MER projection
    7780    PS_PROJ_NTYPE      ///< Number of types; must be last.
    7881} psProjectionType;
    7982
    8083typedef struct
    81 {
    82     double R;     ///< Coordinates of projection center
    83     double D;     ///< Coordinates of projection center
    84     double Xs;    ///< plate-scale in X direction
    85     double Ys;    ///< plate-scale in Y direction
    86     psProjectionType type;  ///< Projection type
    87 }
     84    {
     85        double R;     ///< Coordinates of projection center
     86        double D;     ///< Coordinates of projection center
     87        double Xs;    ///< plate-scale in X direction
     88        double Ys;    ///< plate-scale in Y direction
     89        psProjectionType type;  ///< Projection type
     90    }
    8891psProjection;
    8992
    … …  
    100103} psSphereOffsetUnit;
    101104
    102 psPlane *psPlaneTransformApply(psPlane *out,
    103                                const psPlaneTransform *transform,
    104                                const psPlane *coords);
     105psPlane *psPlaneTransformApply( psPlane *out,
     106                                const psPlaneTransform *transform,
     107                                const psPlane *coords );
     108                               
     109psPlane *psPlaneDistortApply( psPlane *out,
     110                              const psPlaneDistort *transform,
     111                              const psPlane *coords,
     112                              float term3,
     113                              float term4 );
     114                             
     115                             
     116// New function prototype.
     117psSphereTransform *psSphereTransformAlloc( double NPlat,
     118        double Xo,
     119        double xo );
     120       
     121void p_psSphereTransformFree( psSphereTransform *trans );
    105122
    106 psPlane *psPlaneDistortApply(psPlane *out,
    107                              const psPlaneDistort *transform,
    108                              const psPlane *coords,
    109                              float term3,
    110                              float term4);
     123psSphere *psSphereTransformApply( psSphere *out,
     124                                  const psSphereTransform *transform,
     125                                  const psSphere *coord );
     126                                 
     127psSphereTransform *psSphereTransformICRStoEcliptic( psTime time );
     128psSphereTransform *psSphereTransformEcliptictoICRS( psTime time );
     129psSphereTransform *psSphereTransformICRStoGalatic( void );
     130psSphereTransform *psSphereTransformGalatictoICRS( void );
    111131
    112 
    113 // New function prototype.
    114 psSphereTransform *psSphereTransformAlloc(double NPlat,
    115         double Xo,
    116         double xo);
    117 
    118 void p_psSphereTransformFree(psSphereTransform *trans);
    119 
    120 psSphere *psSphereTransformApply(psSphere *out,
    121                                  const psSphereTransform *transform,
    122                                  const psSphere *coord);
    123 
    124 psSphereTransform *psSphereTransformICRStoEcliptic(psTime time);
    125 psSphereTransform *psSphereTransformEcliptictoICRS(psTime time);
    126 psSphereTransform *psSphereTransformICRStoGalatic(void);
    127 psSphereTransform *psSphereTransformGalatictoICRS(void);
    128 
    129 psPlane *psProject(const psSphere *coord,
    130                    const psProjection *projection);
    131 
    132 psSphere *psDeproject(const psPlane *coord,
    133                       const psProjection *projection);
    134 
    135 psSphere *psSphereGetOffset(const psSphere *restrict position1,
    136                             const psSphere *restrict position2,
    137                             psSphereOffsetMode mode,
    138                             psSphereOffsetUnit unit);
    139 
    140 psSphere *psSphereSetOffset(const psSphere *restrict position,
    141                             const psSphere *restrict offset,
    142                             psSphereOffsetMode mode,
    143                             psSphereOffsetUnit unit);
    144 
     132psPlane *psProject( const psSphere *coord,
     133                    const psProjection *projection );
     134                   
     135psSphere *psDeproject( const psPlane *coord,
     136                       const psProjection *projection );
     137                       
     138psSphere *psSphereGetOffset( const psSphere *restrict position1,
     139                             const psSphere *restrict position2,
     140                             psSphereOffsetMode mode,
     141                             psSphereOffsetUnit unit );
     142                             
     143psSphere *psSphereSetOffset( const psSphere *restrict position,
     144                             const psSphere *restrict offset,
     145                             psSphereOffsetMode mode,
     146                             psSphereOffsetUnit unit );
     147                             
     148/// @}
    145149
    146150#endif
Note: See TracChangeset for help on using the changeset viewer.