pmHDUGenerate.h

Go to the documentation of this file.
00001 /* @file pmHDUGenerate.h
00002  * @brief Generate HDU pixels from FPA components that have pixels
00003  *
00004  * @author Paul Price, IfA
00005  *
00006  * @version $Revision: 1.3 $ $Name:  $
00007  * @date $Date: 2007/01/24 02:54:14 $
00008  * Copyright 2005-2006 Institute for Astronomy, University of Hawaii
00009  */
00010 
00011 #ifndef PM_HDU_GENERATE_H
00012 #define PM_HDU_GENERATE_H
00013 
00014 /// @addtogroup Camera Camera Layout
00015 /// @{
00016 
00017 #include "pmFPA.h"
00018 
00019 /// Generate an HDU (with CELL.TRIMSEC, CELL.BIASSEC and pixels) for a cell with pixels
00020 ///
00021 /// The write functions for the FPA hierarchy use pmHDUWrite, which assumes that the images in the readouts
00022 /// are subimages of the pixels in the HDU structure.  If this is not the case, the HDU pixels can be
00023 /// generated using some simple assumptions.  Splices the images and overscans together without regard for
00024 /// CELL.X0 and CELL.Y0 (for a proper mosaic, see pmFPAMosaic), though it should respect CELL.READDIR (so that
00025 /// the bias and trim sections match properly).  A warning may be generated after running this function if the
00026 /// bias and trim sections are specified in the camera format by default values rather than in the header.
00027 /// Failure of this function is often due to a bad camera format file.
00028 bool pmHDUGenerateForCell(pmCell *cell  ///< The cell for which to generate an HDU
00029                          );
00030 
00031 /// Generate an HDU (with CELL.TRIMSEC, CELL.BIASSEC and pixels) for a cell with pixels
00032 ///
00033 /// The write functions for the FPA hierarchy use pmHDUWrite, which assumes that the images in the readouts
00034 /// are subimages of the pixels in the HDU structure.  If this is not the case, the HDU pixels can be
00035 /// generated using some simple assumptions.  Splices the images and overscans together without regard for
00036 /// CELL.X0 and CELL.Y0 (for a proper mosaic, see pmFPAMosaic), though it should respect CELL.READDIR (so that
00037 /// the bias and trim sections match properly).  A warning may be generated after running this function if the
00038 /// bias and trim sections are specified in the camera format by default values rather than in the header.
00039 /// Failure of this function is often due to a bad camera format file.
00040 bool pmHDUGenerateForChip(pmChip *chip  ///< The chip for which to generate an HDU
00041                          );
00042 
00043 // Generate an HDU (with CELL.TRIMSEC, CELL.BIASSEC and pixels) from an FPA with pixels
00044 ///
00045 /// The write functions for the FPA hierarchy use pmHDUWrite, which assumes that the images in the readouts
00046 /// are subimages of the pixels in the HDU structure.  If this is not the case, the HDU pixels can be
00047 /// generated using some simple assumptions.  Splices the images and overscans together without regard for
00048 /// CELL.X0 and CELL.Y0 (for a proper mosaic, see pmFPAMosaic), though it should respect CELL.READDIR (so that
00049 /// the bias and trim sections match properly).  A warning may be generated after running this function if the
00050 /// bias and trim sections are specified in the camera format by default values rather than in the header.
00051 /// Failure of this function is often due to a bad camera format file.
00052 bool pmHDUGenerateForFPA(pmFPA *fpa     ///< The fpa for which to generate an HDU
00053                         );
00054 /// @}
00055 #endif

Generated on Fri Feb 2 22:35:28 2007 for Pan-STARRS Module Library by  doxygen 1.5.1