IPP Software Navigation Tools IPP Links Communication Pan-STARRS Links

Ignore:
Timestamp:
Aug 9, 2004, 12:44:25 PM (22 years ago)
Author:
desonia
Message:

fixed some stupid indent-induced formating problems and added doxygen
comments.

File:
1 edited

Legend:

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

    r1407 r1426  
    1111*  @author George Gusciora, MHPCC
    1212*
    13 *  @version $Revision: 1.10 $ $Name: not supported by cvs2svn $
    14 *  @date $Date: 2004-08-07 00:06:06 $
     13*  @version $Revision: 1.11 $ $Name: not supported by cvs2svn $
     14*  @date $Date: 2004-08-09 22:44:25 $
    1515*
    1616*  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
     
    3939typedef struct
    4040{
    41     double x;                   // /< x position
    42     double y;                   // /< y position
    43     double xErr;                // /< Error in x position
    44     double yErr;                // /< Error in y position
     41    double x;                   ///< x position
     42    double y;                   ///< y position
     43    double xErr;                ///< Error in x position
     44    double yErr;                ///< Error in y position
    4545}
    4646psPlane;
     
    5555typedef struct
    5656{
    57     double r;                   // /< RA
    58     double d;                   // /< Dec
    59     double rErr;                // /< Error in RA
    60     double dErr;                // /< Error in Dec
     57    double r;                   ///< RA
     58    double d;                   ///< Dec
     59    double rErr;                ///< Error in RA
     60    double dErr;                ///< Error in Dec
    6161}
    6262psSphere;
     
    7272typedef struct
    7373{
    74     psDPolynomial2D *x;         // /< 2D polynomial transform of X coordinates
    75     psDPolynomial2D *y;         // /< 2D polynomial transform of Y coordinates
     74    psDPolynomial2D *x;         ///< 2D polynomial transform of X coordinates
     75    psDPolynomial2D *y;         ///< 2D polynomial transform of Y coordinates
    7676}
    7777psPlaneTransform;
     
    9191typedef struct
    9292{
    93     psDPolynomial4D *x;         // /< 4D polynomial transform of X coordinates
    94     psDPolynomial4D *y;         // /< 4D polynomial transform of Y coordinates
     93    psDPolynomial4D *x;         ///< 4D polynomial transform of X coordinates
     94    psDPolynomial4D *y;         ///< 4D polynomial transform of Y coordinates
    9595}
    9696psPlaneDistort;
     
    108108typedef struct
    109109{
    110     double sinPhi;              // /< sin of North Pole lattitude
    111     double cosPhi;              // /< cos of North Pole lattitude
    112     double Xo;                  // /< First PT of Ares lon
    113     double xo;                  // /< First PT of Ares equiv lon
     110    double sinPhi;              ///< sin of North Pole lattitude
     111    double cosPhi;              ///< cos of North Pole lattitude
     112    double Xo;                  ///< First PT of Ares lon
     113    double xo;                  ///< First PT of Ares equiv lon
    114114}
    115115psSphereTransform;
     
    121121 */
    122122typedef enum {
    123     PS_PROJ_TAN,                // /< Tangent projection
    124     PS_PROJ_SIN,                // /< Sine projection
    125     PS_PROJ_AIT,                // /< Aitoff projection
    126     PS_PROJ_PAR,                // /< Par projection
    127     PS_PROJ_GLS,                // /< GLS projection
    128     PS_PROJ_CAR,                // /< CAR projection
    129     PS_PROJ_MER,                // /< MER projection
    130     PS_PROJ_NTYPE               // /< Number of types; must be last.
     123    PS_PROJ_TAN,                ///< Tangent projection
     124    PS_PROJ_SIN,                ///< Sine projection
     125    PS_PROJ_AIT,                ///< Aitoff projection
     126    PS_PROJ_PAR,                ///< Par projection
     127    PS_PROJ_GLS,                ///< GLS projection
     128    PS_PROJ_CAR,                ///< CAR projection
     129    PS_PROJ_MER,                ///< MER projection
     130    PS_PROJ_NTYPE               ///< Number of types; must be last.
    131131} psProjectionType;
    132132
     
    138138typedef struct
    139139{
    140     double R;                   // /< Coordinates of projection center
    141     double D;                   // /< Coordinates of projection center
    142     double Xs;                  // /< plate-scale in X direction
    143     double Ys;                  // /< plate-scale in Y direction
    144     psProjectionType type;      // /< Projection type
     140    double R;                   ///< Coordinates of projection center
     141    double D;                   ///< Coordinates of projection center
     142    double Xs;                  ///< plate-scale in X direction
     143    double Ys;                  ///< plate-scale in Y direction
     144    psProjectionType type;      ///< Projection type
    145145}
    146146psProjection;
     
    152152 */
    153153typedef enum {
    154     PS_SPHERICAL,               // /< offset corresponds to an angular offset
    155     PS_LINEAR                   // /< offset corresponds to a linear offset
     154    PS_SPHERICAL,               ///< offset corresponds to an angular offset
     155    PS_LINEAR                   ///< offset corresponds to a linear offset
    156156} psSphereOffsetMode;
    157157
     
    162162 */
    163163typedef enum {
    164     PS_ARCSEC,                  // /< Arcseconds
    165     PS_ARCMIN,                  // /< Arcminutes
    166     PS_DEGREE,                  // /< Degrees
    167     PS_RADIAN                   // /< Radians
     164    PS_ARCSEC,                  ///< Arcseconds
     165    PS_ARCMIN,                  ///< Arcminutes
     166    PS_DEGREE,                  ///< Degrees
     167    PS_RADIAN                   ///< Radians
    168168} psSphereOffsetUnit;
    169169
     
    171171 *
    172172 */
    173 psPlane *psPlaneTransformApply(psPlane * out,   // /< a psPlane to recycle.  If NULL, a new one is generated.
    174                                const psPlaneTransform * transform,      // /< the transform to apply
    175                                const psPlane * coords   // /< the coordinate to apply the transform above.
     173psPlane *psPlaneTransformApply(psPlane * out,   ///< a psPlane to recycle.  If NULL, a new one is generated.
     174                               const psPlaneTransform * transform,      ///< the transform to apply
     175                               const psPlane * coords   ///< the coordinate to apply the transform above.
    176176                              );
    177177
     
    179179 *
    180180 */
    181 psPlane *psPlaneDistortApply(psPlane * out,     // /< a psPlane to recycle.  If NULL, a new one is generated.
    182                              const psPlaneDistort * transform,  // /< the transform to apply
    183                              const psPlane * coords,    // /< the coordinate to apply the transform above.
    184                              float term3,       // /< third term -- maybe magnitude
    185                              float term4        // /< forth term -- maybe color
     181psPlane *psPlaneDistortApply(psPlane * out,     ///< a psPlane to recycle.  If NULL, a new one is generated.
     182                             const psPlaneDistort * transform,  ///< the transform to apply
     183                             const psPlane * coords,    ///< the coordinate to apply the transform above.
     184                             float term3,       ///< third term -- maybe magnitude
     185                             float term4        ///< forth term -- maybe color
    186186                            );
    187187
     
    189189 *
    190190 */
    191 psSphereTransform *psSphereTransformAlloc(double NPlat, // /< north pole latitude
    192         double Xo,    // /< First PT of Ares lon
    193         double xo     // /< First PT of Ares equiv lon
     191psSphereTransform *psSphereTransformAlloc(double NPlat, ///< north pole latitude
     192        double Xo,    ///< First PT of Ares lon
     193        double xo     ///< First PT of Ares equiv lon
    194194                                         );
    195195
     
    197197 *
    198198 */
    199 psSphere *psSphereTransformApply(psSphere * out,        // /< a psSphere to recycle.  If NULL, a new one is
     199psSphere *psSphereTransformApply(psSphere * out,        ///< a psSphere to recycle.  If NULL, a new one is
    200200                                 // generated.
    201                                  const psSphereTransform * transform,   // /< the transform to apply
    202                                  const psSphere * coord // /< the coordinate to apply the transform above.x
     201                                 const psSphereTransform * transform,   ///< the transform to apply
     202                                 const psSphere * coord ///< the coordinate to apply the transform above.x
    203203                                );
    204204
Note: See TracChangeset for help on using the changeset viewer.