Changeset 9603 for trunk/psModules/src/camera/pmHDUGenerate.h

Timestamp:

Oct 16, 2006, 5:29:08 PM (20 years ago)

Author:

Paul Price

Message:

Documenting pmHDUGenerate.[ch]

File:

• trunk/psModules/src/camera/pmHDUGenerate.h (modified) (2 diffs)

trunk/psModules/src/camera/pmHDUGenerate.h

@@ +1 @@
+/// @file pmHDUGenerate.h
+///
+/// @brief Generate HDU pixels from FPA components that have pixels
+///
+/// @ingroup Camera
+///
+/// @author Paul Price, IfA
+///
+/// @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
+/// @date $Date: 2006-10-17 03:29:08 $
+///
+/// Copyright 2005-2006 Institute for Astronomy, University of Hawaii
+///
+
 #ifndef PM_HDU_GENERATE_H
 #define PM_HDU_GENERATE_H
@@ -4 +18 @@
 #include "pmFPA.h"
 
-// Generate an HDU for a cell with pixels
-bool pmHDUGenerateForCell(pmCell *cell  // The cell for which to generate an HDU
+/// Generate an HDU (with CELL.TRIMSEC, CELL.BIASSEC and pixels) for a cell with pixels
+///
+/// The write functions for the FPA hierarchy use pmHDUWrite, which assumes that the images in the readouts
+/// are subimages of the pixels in the HDU structure.  If this is not the case, the HDU pixels can be
+/// generated using some simple assumptions.  Splices the images and overscans together without regard for
+/// CELL.X0 and CELL.Y0 (for a proper mosaic, see pmFPAMosaic), though it should respect CELL.READDIR (so that
+/// the bias and trim sections match properly).  A warning may be generated after running this function if the
+/// bias and trim sections are specified in the camera format by default values rather than in the header.
+/// Failure of this function is often due to a bad camera format file.
+bool pmHDUGenerateForCell(pmCell *cell  ///< The cell for which to generate an HDU
                          );
 
-// Generate an HDU for a cell with pixels
-bool pmHDUGenerateForChip(pmChip *chip  // The chip for which to generate an HDU
+/// Generate an HDU (with CELL.TRIMSEC, CELL.BIASSEC and pixels) for a cell with pixels
+///
+/// The write functions for the FPA hierarchy use pmHDUWrite, which assumes that the images in the readouts
+/// are subimages of the pixels in the HDU structure.  If this is not the case, the HDU pixels can be
+/// generated using some simple assumptions.  Splices the images and overscans together without regard for
+/// CELL.X0 and CELL.Y0 (for a proper mosaic, see pmFPAMosaic), though it should respect CELL.READDIR (so that
+/// the bias and trim sections match properly).  A warning may be generated after running this function if the
+/// bias and trim sections are specified in the camera format by default values rather than in the header.
+/// Failure of this function is often due to a bad camera format file.
+bool pmHDUGenerateForChip(pmChip *chip  ///< The chip for which to generate an HDU
                          );
 
-// Generate an HDU from an FPA with pixels
-bool pmHDUGenerateForFPA(pmFPA *fpa     // The fpa for which to generate an HDU
+// Generate an HDU (with CELL.TRIMSEC, CELL.BIASSEC and pixels) from an FPA with pixels
+///
+/// The write functions for the FPA hierarchy use pmHDUWrite, which assumes that the images in the readouts
+/// are subimages of the pixels in the HDU structure.  If this is not the case, the HDU pixels can be
+/// generated using some simple assumptions.  Splices the images and overscans together without regard for
+/// CELL.X0 and CELL.Y0 (for a proper mosaic, see pmFPAMosaic), though it should respect CELL.READDIR (so that
+/// the bias and trim sections match properly).  A warning may be generated after running this function if the
+/// bias and trim sections are specified in the camera format by default values rather than in the header.
+/// Failure of this function is often due to a bad camera format file.
+bool pmHDUGenerateForFPA(pmFPA *fpa     ///< The fpa for which to generate an HDU
                         );