Changeset 1384 for trunk/psLib/src/astronomy/psPhotometry.h

Timestamp:

Aug 4, 2004, 1:12:34 PM (22 years ago)

Author:

desonia

Message:

Added doxygen documentation.

File:

• trunk/psLib/src/astronomy/psPhotometry.h (modified) (2 diffs)

trunk/psLib/src/astronomy/psPhotometry.h

@@ -9 +9 @@
 *  @author George Gusciora, MHPCC
 *
-*  @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
-*  @date $Date: 2004-08-04 00:55:17 $
+*  @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
+*  @date $Date: 2004-08-04 23:12:34 $
 *
 *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
@@ -27 +27 @@
 /// @{
 
+/** The photometric system description
+ *
+ *  The photometric system is defined by the psPhotSystem structure. A 
+ *  photometric system is identified by a human-readable name (ie, SDSS.g, 
+ *  Landolt92.B, GPC1.OTA32.r). Each photometric system is given a unique 
+ *  identifier ID. Observations taken with a specific camera, detector, and 
+ *  filter represent their own photometric system, and it may be necessary to 
+ *  perform transformations between these systems. Photometric systems 
+ *  associated with observations from a specific camera/ detector/filter 
+ *  combination can be associated with those components.
+ *
+ */
 typedef struct
     {
-        const int ID;
-        const char *name;
-        const char *camera;
-        const char *filter;
-        const char *detector;
+        const int ID;                  ///< ID number for this photometric system
+        const char *name;              ///< Name of photometric system
+        const char *camera;            ///< Camera for photometric system
+        const char *filter;            ///< Filter used for photometric system
+        const char *detector;          ///< Detector used for photometric system
     }
 psPhotSystem;
 
+/** Photometric system transformation
+ *
+ *  This structure defines the transformation between two photometric systems.
+ *
+ */
 typedef struct
     {
-        psPhotSystem src;
-        psPhotSystem dst;
-        psPhotSystem pP, pM;
-        psPhotSystem sP, sM;
-        float pA, sA;
-        psPolynomial3D transform;
+        psPhotSystem src;                  ///< Source photometric system
+        psPhotSystem dst;                  ///< Destination photometric system
+        psPhotSystem pP;                   ///< Primary color reference
+        psPhotSystem pM;                   ///< Primary color reference
+        psPhotSystem sP;                   ///< Secondary color reference
+        psPhotSystem sM;                   ///< Secondary color reference
+        float pA;                          ///< Color offset for references
+        float sA;                          ///< Color offset for references
+        psPolynomial3D transform;          ///< Transformation from source to destination
     }
 psPhotTransform;