Index: trunk/psLib/src/astronomy/psCoord.h =================================================================== --- trunk/psLib/src/astronomy/psCoord.h (revision 1393) +++ trunk/psLib/src/astronomy/psCoord.h (revision 1407) @@ -1,2 +1,3 @@ + /** @file psCoord.h * @@ -10,19 +11,19 @@ * @author George Gusciora, MHPCC * -* @version $Revision: 1.9 $ $Name: not supported by cvs2svn $ -* @date $Date: 2004-08-05 19:38:51 $ +* @version $Revision: 1.10 $ $Name: not supported by cvs2svn $ +* @date $Date: 2004-08-07 00:06:06 $ * * Copyright 2004 Maui High Performance Computing Center, University of Hawaii */ -# ifndef PS_COORD_H -# define PS_COORD_H - -#include "psType.h" -#include "psImage.h" -#include "psArray.h" -#include "psList.h" -#include "psFunctions.h" -#include "psTime.h" +#ifndef PS_COORD_H +# define PS_COORD_H + +# include "psType.h" +# include "psImage.h" +# include "psArray.h" +# include "psList.h" +# include "psFunctions.h" +# include "psTime.h" /// @addtogroup CoordinateTransform @@ -38,8 +39,8 @@ typedef struct { - double x; ///< x position - double y; ///< y position - double xErr; ///< Error in x position - double yErr; ///< Error in y position + double x; // /< x position + double y; // /< y position + double xErr; // /< Error in x position + double yErr; // /< Error in y position } psPlane; @@ -54,8 +55,8 @@ typedef struct { - double r; ///< RA - double d; ///< Dec - double rErr; ///< Error in RA - double dErr; ///< Error in Dec + double r; // /< RA + double d; // /< Dec + double rErr; // /< Error in RA + double dErr; // /< Error in Dec } psSphere; @@ -71,6 +72,6 @@ typedef struct { - psDPolynomial2D *x; ///< 2D polynomial transform of X coordinates - psDPolynomial2D *y; ///< 2D polynomial transform of Y coordinates + psDPolynomial2D *x; // /< 2D polynomial transform of X coordinates + psDPolynomial2D *y; // /< 2D polynomial transform of Y coordinates } psPlaneTransform; @@ -90,6 +91,6 @@ typedef struct { - psDPolynomial4D *x; ///< 4D polynomial transform of X coordinates - psDPolynomial4D *y; ///< 4D polynomial transform of Y coordinates + psDPolynomial4D *x; // /< 4D polynomial transform of X coordinates + psDPolynomial4D *y; // /< 4D polynomial transform of Y coordinates } psPlaneDistort; @@ -107,8 +108,8 @@ typedef struct { - double sinPhi; ///< sin of North Pole lattitude - double cosPhi; ///< cos of North Pole lattitude - double Xo; ///< First PT of Ares lon - double xo; ///< First PT of Ares equiv lon + double sinPhi; // /< sin of North Pole lattitude + double cosPhi; // /< cos of North Pole lattitude + double Xo; // /< First PT of Ares lon + double xo; // /< First PT of Ares equiv lon } psSphereTransform; @@ -120,12 +121,12 @@ */ typedef enum { - PS_PROJ_TAN, ///< Tangent projection - PS_PROJ_SIN, ///< Sine projection - PS_PROJ_AIT, ///< Aitoff projection - PS_PROJ_PAR, ///< Par projection - PS_PROJ_GLS, ///< GLS projection - PS_PROJ_CAR, ///< CAR projection - PS_PROJ_MER, ///< MER projection - PS_PROJ_NTYPE ///< Number of types; must be last. + PS_PROJ_TAN, // /< Tangent projection + PS_PROJ_SIN, // /< Sine projection + PS_PROJ_AIT, // /< Aitoff projection + PS_PROJ_PAR, // /< Par projection + PS_PROJ_GLS, // /< GLS projection + PS_PROJ_CAR, // /< CAR projection + PS_PROJ_MER, // /< MER projection + PS_PROJ_NTYPE // /< Number of types; must be last. } psProjectionType; @@ -137,9 +138,9 @@ typedef struct { - double R; ///< Coordinates of projection center - double D; ///< Coordinates of projection center - double Xs; ///< plate-scale in X direction - double Ys; ///< plate-scale in Y direction - psProjectionType type; ///< Projection type + double R; // /< Coordinates of projection center + double D; // /< Coordinates of projection center + double Xs; // /< plate-scale in X direction + double Ys; // /< plate-scale in Y direction + psProjectionType type; // /< Projection type } psProjection; @@ -151,6 +152,6 @@ */ typedef enum { - PS_SPHERICAL, ///< offset corresponds to an angular offset - PS_LINEAR ///< offset corresponds to a linear offset + PS_SPHERICAL, // /< offset corresponds to an angular offset + PS_LINEAR // /< offset corresponds to a linear offset } psSphereOffsetMode; @@ -161,8 +162,8 @@ */ typedef enum { - PS_ARCSEC, ///< Arcseconds - PS_ARCMIN, ///< Arcminutes - PS_DEGREE, ///< Degrees - PS_RADIAN ///< Radians + PS_ARCSEC, // /< Arcseconds + PS_ARCMIN, // /< Arcminutes + PS_DEGREE, // /< Degrees + PS_RADIAN // /< Radians } psSphereOffsetUnit; @@ -170,75 +171,55 @@ * */ -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. -); +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 -); +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 -); - +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 -); - -psSphereTransform *psSphereTransformICRStoGalatic( void ); - -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 -); +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); + +psSphereTransform *psSphereTransformICRStoGalatic(void); + +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); /// @}