IPP Software Navigation Tools IPP Links Communication Pan-STARRS Links

Ignore:
Timestamp:
Mar 18, 2004, 9:37:58 PM (22 years ago)
Author:
eugene
Message:

code cleanup for Doxygen support & readability

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/archive/pslib/include/psPosition.h

    r253 r257  
    66 *  \ingroup AstroGroup
    77 */
     8
     9/** Structures *********************/
    810
    911/** A point in 2-D space, with errors.
     
    2931
    3032/** A polynomial transformation between coordinate frames.  This may be a linear relationship, or may
    31  * represent a higher-order transformation.
     33 *  represent a higher-order transformation.
    3234 */
    3335typedef struct {
     
    3739
    3840/** The optical distortion terms.  The lowest two terms are the x and y axis of the target system.  The higher
    39  * two terms represent magnitude and color terms.
     41 *  two terms represent magnitude and color terms.
    4042 */
    4143typedef struct {
     
    4446} psDistortion;
    4547
    46 psCoord *psCoordXformApply (psCoordXform *frame, psCoord *coords);
     48/** Functions **************************************************************/
     49/** \addtogroup AstroGroup Astronomy-Specific Utilities
     50 *  \{
     51 */
    4752
    48 psCoord *psDistortionApply (psCoordXform *frame, psCoord *coords);
     53/** apply the coordinate transformation to the given coordinate */
     54psCoord *psCoordXformApply (psCoordXform *frame, ///< coordinate transformation
     55                            psCoord *coords) ///< input coordiate
     56;
    4957
    50 /***********************************************************************************************************/
    51 
    52 /* Offsets */
     58/** apply the optical distortion to the given coordinate, magnitude, color */
     59psCoord *psDistortionApply (psDistortion *pattern, ///< optical distortion pattern
     60psCoord *coords,                        ///< input coordinate
     61float mag,                              ///< magnitude of object
     62float color)                            ///< color of object
     63;
    5364
    5465/** Get offset (RA,Dec) on the sky between two positions position1 and position2 may not be identical */
     
    5667psGetOffset(const psCoord *restrict position1, //!< Position 1
    5768            const psCoord *restrict position2, //!< Position 2
    58             char *system
    59             );
     69            char *system)
     70;
    6071
    6172/** Apply an offset to a position */
     
    6374psApplyOffset(const psCoord *restrict position, //!< Position
    6475              const psCoord *restrict offset, //!< Offset
    65               char *system
    66     );
    67 
    68 /***********************************************************************************************************/
     76              char *system)
     77;
    6978
    7079/* Positions of well-known objects */
     
    7281/** Get Sun Position */
    7382psCoord *
    74 psGetSunPos(float mjd                   //!< MJD to get position for
    75             );
     83psGetSunPos(float mjd)                  //!< MJD to get position for
     84;
    7685
    7786/** Get Moon position */
     
    7988psGetMoonPos(float mjd,                 //!< MJD to get position for
    8089             double latitude,           //!< Latitude for apparent position
    81              double longitude           //!< Longitude for apparent position
    82              );
     90             double longitude)          //!< Longitude for apparent position
     91;
    8392
    8493/** Get Moon phase */
    8594float
    86 psGetMoonPhase(float mjd                //!< MJD to get phase for
    87                );
     95psGetMoonPhase(float mjd)               //!< MJD to get phase for
     96;
    8897
    8998/** Get Planet positions */
    9099psCoord *
    91100psGetSolarSystemPos(char *solarSystemObject, //!< Named S.S. object
    92                     float mjd           //!< MJD to get position for
    93     );
     101                    float mjd)          //!< MJD to get position for
     102;
    94103
    95104/***********************************************************************************************************/
     
    99108/** Convert ICRS to Ecliptic */
    100109psCoord *
    101 psCoordinatesItoE(const psCoord *restrict coordinates //!< ICRS coordinates to convert
    102                   );
     110psCoordinatesItoE(const psCoord *restrict coordinates) //!< ICRS coordinates to convert
     111;
    103112
    104113/** Convert Ecliptic to ICRS */
    105114psCoord *
    106 psCoordinatesEtoI(const psCoord *restrict coordinates //!< Ecliptic coordinates to convert
    107                   );
     115psCoordinatesEtoI(const psCoord *restrict coordinates) //!< Ecliptic coordinates to convert
     116;
    108117
    109118/** Convert ICRS to Galactic */
    110119psCoord *
    111 psCoordinatesItoG(const psCoord *restrict coordinates //!< ICRS coordinates to convert
    112                   );
     120psCoordinatesItoG(const psCoord *restrict coordinates) //!< ICRS coordinates to convert
     121;
    113122
    114123/** Convert Galactic to ICRS */
    115124psCoord *
    116 psCoordinatesGtoI(const psCoord *restrict coordinates //!< Galactic coordinates to convert
    117                   );
     125psCoordinatesGtoI(const psCoord *restrict coordinates) //!< Galactic coordinates to convert
     126;
    118127
    119128/***********************************************************************************************************/
     129
     130/* \} */ // End of AstroGroup Functions
     131
    120132#endif
Note: See TracChangeset for help on using the changeset viewer.