Changeset 9596 for trunk/psModules/src/camera/pmFPAMosaic.h

Timestamp:

Oct 16, 2006, 4:33:55 PM (20 years ago)

Author:

Paul Price

Message:

Documenting pmFPAMosaic.[ch]

File:

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

trunk/psModules/src/camera/pmFPAMosaic.h

@@ +1 @@
+/// @file pmFPAMosaic.h
+///
+/// @brief Functions to mosaic FPA components into a single entity
+///
+/// @ingroup Camera
+///
+/// @author Paul Price, IfA
+/// @author Eugene Magnier, IfA
+///
+/// @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
+/// @date $Date: 2006-10-17 02:33:55 $
+///
+/// Copyright 2005-2006 Institute for Astronomy, University of Hawaii
+///
+
 #ifndef PM_CHIP_MOSAIC_H
 #define PM_CHIP_MOSAIC_H
@@ -4 +19 @@
 #include "pmFPA.h"
 
-// Mosaic all cells within a chip
+/// Mosaic all cells within a chip
+///
+/// Mosaics all cells within the source into a single cell within the target (which must have only a single
+/// cell).  Cells are placed on the chip according to the CELL.X0 and CELL.Y0 offsets.  This is useful for
+/// getting an image of the chip on the sky.  The mosaicking is done so as to avoid performing a deep copy of
+/// the pixels, if possible.
 bool pmChipMosaic(pmChip *target,       // Target chip --- may contain only a single cell
                   const pmChip *source  // Source chip whose cells will be mosaicked
                  );
 
-// Mosaic all cells within an FPA
+/// Mosaic all cells within an FPA
+///
+/// Mosaics all cells within the source into a single chip with single cell within the target (which must have
+/// only a single chip with single cell).  Cells are placed on the FPA according to the CHIP.X0, CHIP.Y0,
+/// CELL.X0 and CELL.Y0 offsets.  This is useful for getting an image of the FPA on the sky.  The mosaicking
+/// is done so as to avoid performing a deep copy of the pixels, if possible.
 bool pmFPAMosaic(pmFPA *target,         // Target FPA --- may contain only a single chip with a single cell
                  const pmFPA *source    // FPA whose chips and cells will be mosaicked