Index: trunk/psLib/src/astro/psCoord.h =================================================================== --- trunk/psLib/src/astro/psCoord.h (revision 1491) +++ trunk/psLib/src/astro/psCoord.h (revision 1496) @@ -11,6 +11,6 @@ * @author George Gusciora, MHPCC * -* @version $Revision: 1.13 $ $Name: not supported by cvs2svn $ -* @date $Date: 2004-08-09 23:40:54 $ +* @version $Revision: 1.14 $ $Name: not supported by cvs2svn $ +* @date $Date: 2004-08-12 01:23:20 $ * * Copyright 2004 Maui High Performance Computing Center, University of Hawaii @@ -117,5 +117,5 @@ /** Projection type for projection/deprojection * - * @seealso psProject, psDeproject + * @see psProject, psDeproject * */ @@ -133,5 +133,5 @@ /** Parameter set for projection/deprojection * - * @seealso psProject, psDeproject + * @see psProject, psDeproject * */ @@ -148,5 +148,5 @@ /** Mode for Offset calculation between two sky positions * - * @seealso psSphereGetOffset, psSphereSetOffset + * @see psSphereGetOffset, psSphereSetOffset * */ @@ -158,5 +158,5 @@ /** The units of the offset * - * @seealso psSphereGetOffset, psSphereSetOffset + * @see psSphereGetOffset, psSphereSetOffset * */ @@ -170,56 +170,127 @@ /** Applies the psPlaneTransform transform to a specified coordinate * - */ -psPlane* psPlaneTransformApply(psPlane* out, ///< a psPlane to recycle. If NULL, a new one is generated. - const psPlaneTransform* transform, ///< the transform to apply - const psPlane* coords ///< the coordinate to apply the transform above. - ); + * @return psPlane* resulting coordinate based on transform + */ +psPlane* psPlaneTransformApply( + psPlane* out, ///< a psPlane to recycle. If NULL, a new one is generated. + const psPlaneTransform* transform, ///< the transform to apply + const psPlane* coords ///< the coordinate to apply the transform above. +); /** Applies the psPlaneDistort transform to a specified coordinate * - */ -psPlane* psPlaneDistortApply(psPlane* out, ///< a psPlane to recycle. If NULL, a new one is generated. - const psPlaneDistort* transform, ///< the transform to apply - const psPlane* coords, ///< the coordinate to apply the transform above. - float term3, ///< third term -- maybe magnitude - float term4 ///< forth term -- maybe color - ); + * @return psPlane* resulting coordinate based on transform + */ +psPlane* psPlaneDistortApply( + psPlane* out, ///< a psPlane to recycle. If NULL, a new one is generated. + const psPlaneDistort* transform, ///< the transform to apply + const psPlane* coords, ///< the coordinate to apply the transform above. + float term3, ///< third term -- maybe magnitude + float term4 ///< forth term -- maybe color +); /** Allocator for psSphereTransform * - */ -psSphereTransform* psSphereTransformAlloc(double NPlat, ///< north pole latitude - double Xo, ///< First PT of Ares lon - double xo ///< First PT of Ares equiv lon - ); + * @return psSphereTransform* newly allocated struct + */ +psSphereTransform* psSphereTransformAlloc( + double NPlat, ///< north pole latitude + double Xo, ///< First PT of Ares lon + double xo ///< First PT of Ares equiv lon +); /** Applies the psSphereTransform transform for a specified coordinate * - */ -psSphere* psSphereTransformApply(psSphere* out, ///< a psSphere to recycle. If NULL, a new one is - // generated. - const psSphereTransform* transform, ///< the transform to apply - const psSphere* coord ///< the coordinate to apply the transform above.x - ); - -psSphereTransform* psSphereTransformICRStoEcliptic(psTime time); - -psSphereTransform* psSphereTransformEcliptictoICRS(psTime time); - + * @return psSphere* resulting coordinate based on transform + */ +psSphere* psSphereTransformApply( + psSphere* out, ///< a psSphere to recycle. If NULL, a new one is generated. + const psSphereTransform* transform,///< the transform to apply + const psSphere* coord ///< the coordinate to apply the transform above.x +); + +/** Creates the appropriate transform for converting from ICRS to Ecliptic + * coordinate systems. + * + * @return psSphereTransform* transform for ICRS->Ecliptic coordinate systems + */ +psSphereTransform* psSphereTransformICRStoEcliptic( + psTime time ///< the time for which the resulting transform will be valid +); + +/** Creates the appropriate transform for converting from Ecliptic to ICRS + * coordinate systems. + * + * @return psSphereTransform* transform for Ecliptic->ICRS coordinate systems + */ +psSphereTransform* psSphereTransformEcliptictoICRS( + psTime time ///< the time for which the resulting transform will be valid +); + +/** Creates the appropriate transform for converting from ICRS to Galatic + * coordinate systems. + * + */ psSphereTransform* psSphereTransformICRStoGalatic(void); +/** Creates the appropriate transform for converting from Galatic to ICRS + * coordinate systems. + * + */ psSphereTransform* psSphereTransformGalatictoICRS(void); -psPlane* psProject(const psSphere* coord, const psProjection* projection); - -psSphere* psDeproject(const psPlane* coord, const psProjection* projection); - -psSphere* psSphereGetOffset(const psSphere* restrict position1, - const psSphere* restrict position2, - psSphereOffsetMode mode, psSphereOffsetUnit unit); - -psSphere* psSphereSetOffset(const psSphere* restrict position, - const psSphere* restrict offset, - psSphereOffsetMode mode, psSphereOffsetUnit unit); +/** Projects a spherical coordinate to a linear coordinate system + * + * @return psPlane* projected coordinate + */ +psPlane* psProject( + const psSphere* coord, ///< coordinate to project + const psProjection* projection ///< parameters of the projection +); + +/** Reverse projection of a linear coordinate to a spherical coordinate system + * + * @return psPlane* projected coordinate + */ +psSphere* psDeproject( + const psPlane* coord, ///< coordinate to project + const psProjection* projection ///< parameters of the projection +); + +/** Determines the offset (RA,Dec) on the sky between two positions. + * + * Both an offset mode and an offset unit may be defined. The mode may be + * either PS_SPHERICAL, in which case the specified offset corresponds to an + * offset in angles, or it may be PS_LINEAR, in which case the offset + * corresponds to a linear offset in a local projection. The offset unit may + * be in one of PS_ARCSEC, PS_ARCMIN, PS_DEGREE, and PS_RADIAN, which + * specifies the units of the offset only. + * + * @return psSphere* the offset between position1 and position2 + */ +psSphere* psSphereGetOffset( + const psSphere* restrict position1, + const psSphere* restrict position2, + psSphereOffsetMode mode, + psSphereOffsetUnit unit +); + +/** Applies the given offset to a coordinate. + * + * Both an offset mode and an offset unit may be defined. The mode may be + * either PS_SPHERICAL, in which case the specified offset corresponds to an + * offset in angles, or it may be PS_LINEAR, in which case the offset + * corresponds to a linear offset in a local projection. The offset unit may + * be in one of PS_ARCSEC, PS_ARCMIN, PS_DEGREE, and PS_RADIAN, which + * specifies the units of the offset only. + * + * @return psSphere* the given position with the given offset applied. + */ +psSphere* psSphereSetOffset( + const psSphere* restrict position, + const psSphere* restrict offset, + psSphereOffsetMode mode, + psSphereOffsetUnit unit +); /// @} Index: trunk/psLib/src/astro/psTime.h =================================================================== --- trunk/psLib/src/astro/psTime.h (revision 1491) +++ trunk/psLib/src/astro/psTime.h (revision 1496) @@ -13,6 +13,6 @@ * @author Ross Harman, MHPCC * - * @version $Revision: 1.10 $ $Name: not supported by cvs2svn $ - * @date $Date: 2004-08-09 23:40:54 $ + * @version $Revision: 1.11 $ $Name: not supported by cvs2svn $ + * @date $Date: 2004-08-12 01:23:20 $ * * Copyright 2004 Maui High Performance Computing Center, University of Hawaii @@ -39,14 +39,13 @@ /** Definition of psTime. * - * The psTime struct is used by psLib to represent time values critical to astronomical calculations. This - * structure represents a time which is equivalent to TAI (International Atomic Time) and is measured in - * both seconds and microseconds. + * The psTime struct is used by psLib to represent time values critical to + * astronomical calculations. This structure represents a time which is + * equivalent to TAI (International Atomic Time) and is measured in both + * seconds and microseconds. */ typedef struct { - - time_t tv_sec; /**< Seconds since epoch, Jan 1, 1970. */ - - suseconds_t tv_usec; /**< Microseconds since last second. */ + time_t tv_sec; ///< Seconds since epoch, Jan 1, 1970. + suseconds_t tv_usec; ///< Microseconds since last second. } psTime; @@ -65,68 +64,66 @@ */ -psTime psTimeGetTime(void - /** No argument. */ - ); +psTime psTimeGetTime(void); /** Convert psTime to ISO time in TAI units. * - * Converts psTime to a null terminated string in the form of: YYYY/MM/DD,HH:MM:SS.SSS. This function assumes - * the input time already is in TAI time and does not add or subtract leapseconds. + * Converts psTime to a null terminated string in the form of: + * YYYY/MM/DD,HH:MM:SS.SSS. This function assumes the input time already is + * in TAI time and does not add or subtract leapseconds. * * @return char*: Pointer null terminated array of chars in ISO time. */ -char *psTimeToISO(psTime time - /** Input time to be converted. */ - ); +char *psTimeToISO( + psTime time ///< Input time to be converted. +); /** Convert psTime to UTC time. * - * Converts psTime to UTC time in double precision floating point notation. The input to this must already be - * int TAI time. The result from this function is not in TAI units, but that of UTC, which does not contain - * leapseconds. + * Converts psTime to UTC time in double precision floating point notation. + * The input to this must already be int TAI time. The result from this + * function is not in TAI units, but that of UTC, which does not contain + * leapseconds. * * @return psTime: UTC time psTime format. */ -psTime psTimeToUTC(psTime time - /** Input time to be converted. */ - ); +psTime psTimeToUTC( + psTime time ///< Input time to be converted. +); /** Convert psTime to modified Julian date time. * - * Converts psTime to modified Julian date (MJD) time. This function assumes the input time already is in TAI - * time and does not add or subtract leapseconds. + * Converts psTime to modified Julian date (MJD) time. This function assumes + * the input time already is in TAI time and does not add or subtract + * leapseconds. * * @return double: Modified Julian Days (MJD) time. */ - -double psTimeToMJD(psTime time - /** Input time to be converted. */ - ); +double psTimeToMJD( + psTime time ///< Input time to be converted. +); /** Convert psTime to Julian date time. * - * Converts psTime to Julian date (JD) time. This function assumes the input time already is in TAI time and - * does not add or subtract leapseconds. + * Converts psTime to Julian date (JD) time. This function assumes the input + * time already is in TAI time and does not add or subtract leapseconds. * * @return double: Julian Date (JD) time. */ - -double psTimeToJD(psTime time - /** Input time to be converted. */ - ); +double psTimeToJD( + psTime time ///< Input time to be converted. +); /** Convert psTime to timeval time. * - * Converts psTime to timeval time. This function assumes the input time already is in TAI time and does not - * add or subtract leapseconds. + * Converts psTime to timeval time. This function assumes the input time + * already is in TAI time and does not add or subtract leapseconds. * * @return timeval: timeval struct time. */ - -struct timeval psTimeToTimeval(psTime time - /** Input time to be converted. */ - ); +struct timeval psTimeToTimeval( + psTime time ///< Input time to be converted. + ); /** Convert psTime to tm time. @@ -137,80 +134,73 @@ * @return tm: tm struct time. */ - -struct tm *psTimeToTM(psTime time - /** Input time to be converted. */ - ); +struct tm *psTimeToTM( + psTime time ///< Input time to be converted. + ); /** Convert ISO to psTime. * - * Converts ISO time to psTime. This function assumes the input time already is in TAI time and does not add - * or subtract leapseconds. + * Converts ISO time to psTime. This function assumes the input time already + * is in TAI time and does not add or subtract leapseconds. * * @return psTime: time */ - -psTime psISOToTime(char *time - /** Input time to be converted. */ - ); +psTime psISOToTime( + char *time ///< Input time to be converted. +); /** Convert UTC to psTime. * - * Converts UTC time to psTime. This function assumes the input time already is in TAI time and add or - * subtracts the necessary leapseconds. + * Converts UTC time to psTime. This function assumes the input time already + * is in TAI time and add or subtracts the necessary leapseconds. * * @return psTime: time in TAI units. */ - -psTime psUTCToTime(psTime time - /** Input time to be converted. */ - ); +psTime psUTCToTime( + psTime time ///< Input time to be converted. +); /** Convert MJD to psTime. * - * Converts MJD time to psTime. This function assumes the input time already is in TAI time and does not add - * or subtract leapseconds. - * - * @return psTime: time. - */ - -psTime psMJDToTime(double time - /** Input time to be converted. */ - ); + * Converts MJD time to psTime. This function assumes the input time already + * is in TAI time and does not add or subtract leapseconds. + * + * @return psTime: time. + */ +psTime psMJDToTime( + double time ///< Input time to be converted. +); /** Convert JD to psTime. * - * Converts JD time to psTime. This function assumes the input time already is in TAI time and does not add - * or subtract leapseconds. - * - * @return psTime: time. - */ - -psTime psJDToTime(double time - /** Input time to be converted. */ - ); + * Converts JD time to psTime. This function assumes the input time already + * is in TAI time and does not add or subtract leapseconds. + * + * @return psTime: time. + */ +psTime psJDToTime( + double time ///< Input time to be converted. +); /** Convert timeval to psTime. * - * Converts timeval time to psTime. This function assumes the input time already is in TAI time and does not - * add or subtract leapseconds. - * - * @return psTime: time. - */ - -psTime psTimevalToTime(struct timeval *time - /** Input time to be converted. */ - ); + * Converts timeval time to psTime. This function assumes the input time + * already is in TAI time and does not add or subtract leapseconds. + * + * @return psTime: time. + */ +psTime psTimevalToTime( + struct timeval *time ///< Input time to be converted. +); /** Convert tm time to psTime. * - * Converts tm time to psTime. This function assumes the input time already is in TAI time and does not add - * or subtract leapseconds. - * - * @return psTime: time. - */ - -psTime psTMToTime(struct tm *time - /** Input time to be converted. */ - ); + * Converts tm time to psTime. This function assumes the input time already + * is in TAI time and does not add or subtract leapseconds. + * + * @return psTime: time. + */ +psTime psTMToTime( + struct tm *time ///< Input time to be converted. +); /// @}