Changeset 9604 for trunk/psModules/src/camera/pmHDU.h

Timestamp:

Oct 16, 2006, 5:35:58 PM (20 years ago)

Author:

Paul Price

Message:

Documenting pmHDU.[ch]

File:

• trunk/psModules/src/camera/pmHDU.h (modified) (1 diff)

trunk/psModules/src/camera/pmHDU.h

@@ +1 @@
+/// @file pmHDU.h
+///
+/// @brief Define a header data unit (from a FITS file), with functions to read and write
+///
+/// @ingroup Camera
+///
+/// @author Paul Price, IfA
+///
+/// @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
+/// @date $Date: 2006-10-17 03:35:58 $
+///
+/// Copyright 2005-2006 Institute for Astronomy, University of Hawaii
+///
+
 #ifndef PM_HDU_H
 #define PM_HDU_H
 
-// An instance of the FITS Header Data Unit
+/// An instance of the FITS Header Data Unit
+///
+/// Of course, it is not an exact replica of a FITS HDU --- they have no mask and weight data, but these are
+/// stored here for convenience --- it keeps all the relevant data about the image in one place.
 typedef struct
 {
-    psString extname;                   // The extension name
-    bool blankPHU;                      // Is this a blank FITS Primary Header Unit, i.e., no data?
-    psMetadata *format;                 // The camera format
-    psMetadata *header;                 // The FITS header, or NULL if primary for FITS; or section info
-    psArray *images;                    // The pixel data
-    psArray *weights;                   // The pixel data
-    psArray *masks;                     // The pixel data
-    psArray *table;                     // The table data
+    psString extname;                   ///< The extension name
+    bool blankPHU;                      ///< Is this a blank FITS Primary Header Unit, i.e., no data?
+    psMetadata *format;                 ///< The camera format
+    psMetadata *header;                 ///< The FITS header, or NULL if primary for FITS; or section info
+    psArray *images;                    ///< The pixel data
+    psArray *weights;                   ///< The pixel data
+    psArray *masks;                     ///< The pixel data
 }
 pmHDU;
 
 
-// Allocators
+/// Allocator for pmHDU
 pmHDU *pmHDUAlloc(const char *extname);
 
-// Read the header
-bool pmHDUReadHeader(pmHDU *hdu,        // HDU for which to read header
-                     psFits *fits       // FITS file from which to read
+/// Read the HDU header only
+bool pmHDUReadHeader(pmHDU *hdu,        ///< HDU for which to read header
+                     psFits *fits       ///< FITS file from which to read
                     );
 
-// Read the HDU
-bool pmHDURead(pmHDU *hdu,              // HDU to read
-               psFits *fits             // FITS file to read from
+/// Read the HDU header and pixels
+bool pmHDURead(pmHDU *hdu,              ///< HDU to read
+               psFits *fits             ///< FITS file to read from
               );
 
-// Write the HDU
-bool pmHDUWrite(pmHDU *hdu,             // HDU to write
-                psFits *fits            // FITS file to write to
+/// Write the HDU header and pixels
+bool pmHDUWrite(pmHDU *hdu,             ///< HDU to write
+                psFits *fits            ///< FITS file to write to
                );