Changeset 1496 for trunk/psLib/src/astro/psCoord.h

Timestamp:

Aug 11, 2004, 3:23:20 PM (22 years ago)

Author:

desonia

Message:

doxygen cleanup.

File:

• trunk/psLib/src/astro/psCoord.h (modified) (6 diffs)

trunk/psLib/src/astro/psCoord.h

@@ -11 +11 @@
 *  @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 +117 @@
 /** Projection type for projection/deprojection
  * 
- *  @seealso psProject, psDeproject
+ *  @see psProject, psDeproject
  *
  */
@@ -133 +133 @@
 /** Parameter set for projection/deprojection
  * 
- *  @seealso psProject, psDeproject
+ *  @see psProject, psDeproject
  *
  */
@@ -148 +148 @@
 /** Mode for Offset calculation between two sky positions
  *
- *  @seealso  psSphereGetOffset, psSphereSetOffset
+ *  @see  psSphereGetOffset, psSphereSetOffset
  *
  */
@@ -158 +158 @@
 /** The units of the offset
  *
- *  @seealso  psSphereGetOffset, psSphereSetOffset
+ *  @see  psSphereGetOffset, psSphereSetOffset
  *
  */
@@ -170 +170 @@
 /** 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
+);
 
 /// @}