Changeset 283 for trunk/archive/pslib/include/psPhotom.h

Timestamp:

Mar 22, 2004, 6:49:00 PM (22 years ago)

Author:

Paul Price

Message:

Commented the psPhotSystem and psPhotTransform structs.

File:

• trunk/archive/pslib/include/psPhotom.h (modified) (1 diff)

trunk/archive/pslib/include/psPhotom.h

@@ -15 +15 @@
 /** photometry system definition */
 typedef struct {
-    int ID;
-    char *name;
-    char *camera;
-    char *filter;
-    char *detector;
+    int ID;                             //!< ID number for this photometric system
+    char *name;                         //!< Name of photometric system
+    char *camera;                       //!< Camera for photometric system
+    char *filter;                       //!< Filter used for photometric system
+    char *detector;                     //!< Detector used for photometric system
 } psPhotSystem;
 
 /** photometry transformations */
 typedef struct {
-    psPhotSystem src;
-    psPhotSystem dst;
-    psPhotSystem pP, pM;        ///< Colour reference
-    psPhotSystem sP, sM;        ///< Colour reference
-    float pA, sA;               ///< 
-    psPolynomial3D transform;
+    psPhotSystem src;                   //!< Source photometric system
+    psPhotSystem dst;                   //!< Destination photometric system
+    psPhotSystem pP, pM;                ///< Primary colour reference
+    psPhotSystem sP, sM;                ///< Secondary colour reference
+    float pA, sA;                       ///< Colour offset for primary and secondary references
+    psPolynomial3D transform;           //!< Transformation from source to destination
 } psPhotTransform;