Index: trunk/psModules/src/camera/pmFPARead.h
===================================================================
--- trunk/psModules/src/camera/pmFPARead.h	(revision 7555)
+++ trunk/psModules/src/camera/pmFPARead.h	(revision 9599)
@@ -1,8 +1,32 @@
+/// @file pmFPAMosaic.h
+///
+/// @brief Functions to mosaic FPA components into a single entity
+///
+/// @ingroup Camera
+///
+/// @author Paul Price, IfA
+///
+/// @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
+/// @date $Date: 2006-10-17 03:00:30 $
+///
+/// Copyright 2005-2006 Institute for Astronomy, University of Hawaii
+///
+
 #ifndef PM_FPA_READ_H
 #define PM_FPA_READ_H
 
-#include "pslib.h"
+#include <pslib.h>
 #include "pmFPA.h"
 
+/// Read a readout incrementally
+///
+/// Multiple calls to this function moves through a readout within a cell incrementally.  It is required to
+/// pass the readout previously acquired (or a newly-allocated one) in order to preserve state information
+/// (where the read is at).  Only a maximum of numRows rows are read at a time.  Returns true if pixels are
+/// read, and false otherwise.  To facilitate looping, no error is generated for reading a plane that doesn't
+/// exist.  Note that this function doesn't put pixels in the HDU.  It is therefore NOT COMPATIBLE with
+/// pmCellWrite, pmChipWrite, and pmFPAWrite (or any function that uses or creates an HDU for that matter).
+/// Use pmReadoutWriteNext to write the data that's read by this function.  This function is intended for
+/// reading in many readouts into memory at once (e.g., for stacking) where the input is not written out.
 bool pmReadoutReadNext(pmReadout *readout, // Readout into which to read
                        psFits *fits,    // FITS file from which to read
@@ -11,4 +35,8 @@
                       );
 
+/// Read an entire cell
+///
+/// Reads the appropriate HDU, ingests concepts from the header, and portions pixels into readouts.  Pixels
+/// are converted to F32.
 bool pmCellRead(pmCell *cell,           // Cell to read into
                 psFits *fits,           // FITS file from which to read
@@ -16,4 +44,7 @@
                );
 
+/// Read a chip
+///
+/// Iterates over component cells, reading each with pmCellRead.
 bool pmChipRead(pmChip *chip,           // Chip to read into
                 psFits *fits,           // FITS file from which to read
@@ -21,4 +52,7 @@
                );
 
+/// Read an FPA
+///
+/// Iterates over component chips, reading each with pmChipRead.
 bool pmFPARead(pmFPA *fpa,              // FPA to read into
                psFits *fits,            // FITS file from which to read
@@ -26,4 +60,7 @@
               );
 
+/// Read an entire cell into the mask
+///
+/// Same as pmCellRead, but reads into the mask element of the readouts.
 bool pmCellReadMask(pmCell *cell,           // Cell to read into
                     psFits *fits,           // FITS file from which to read
@@ -31,4 +68,7 @@
                    );
 
+/// Read an entire chip into the mask
+///
+/// Same as pmChipRead, but reads into the mask element of the readouts.
 bool pmChipReadMask(pmChip *chip,           // Chip to read into
                     psFits *fits,           // FITS file from which to read
@@ -36,4 +76,7 @@
                    );
 
+/// Read an entire FPA into the mask
+///
+/// Same as pmFPARead, but reads into the mask element of the readouts.
 bool pmFPAReadMask(pmFPA *fpa,              // FPA to read into
                    psFits *fits,            // FITS file from which to read
@@ -41,4 +84,7 @@
                   );
 
+/// Read an entire cell into the weight
+///
+/// Same as pmCellRead, but reads into the weight element of the readouts.
 bool pmCellReadWeight(pmCell *cell,           // Cell to read into
                       psFits *fits,           // FITS file from which to read
@@ -46,4 +92,7 @@
                      );
 
+/// Read an entire chip into the weight
+///
+/// Same as pmChipRead, but reads into the weight element of the readouts.
 bool pmChipReadWeight(pmChip *chip,           // Chip to read into
                       psFits *fits,           // FITS file from which to read
@@ -51,4 +100,7 @@
                      );
 
+/// Read an entire FPA into the weight
+///
+/// Same as pmFPARead, but reads into the weight element of the readouts.
 bool pmFPAReadWeight(pmFPA *fpa,              // FPA to read into
                      psFits *fits,            // FITS file from which to read
@@ -56,41 +108,3 @@
                     );
 
-bool pmCellReadPHU(pmCell *cell,        // Cell to read into
-                   psFits *fits         // FITS file from which to read
-                  );
-
-bool pmChipReadPHU(pmChip *chip,        // Chip to read into
-                   psFits *fits         // FITS file from which to read
-                  );
-
-bool pmFPAReadPHU(pmFPA *fpa,           // FPA to read into
-                  psFits *fits          // FITS file from which to read
-                 );
-
-
-#if 0
-bool pmFPARead(pmFPA *fpa,              // FPA to read into
-               psFits *fits,            // FITS file from which to read
-               psMetadata *phu,         // Primary header
-               psDB *db                 // Database handle, for concept ingest
-              );
-
-psString p_pmFPATranslateName(const psString name, // The name to translate
-                              const pmCell *cell // The cell for which to translate
-                             );
-
-psString p_pmFPATranslateFileExt(psString *extName, // Extension name, to be returned
-                                 const psString filenameExt, // The string to parse into filename and ext
-                                 const pmCell *cell // The cell
-                                );
-
-bool pmFPAReadMask(pmFPA *fpa,          // FPA to read into
-                   psFits *source       // Source FITS file (for the original data)
-                  );
-
-bool pmFPAReadWeight(pmFPA *fpa,        // FPA to read into
-                     psFits *source     // Source FITS file (for the original data)
-                    );
 #endif
-
-#endif