pmFPACopy.h

Go to the documentation of this file.
00001 /* @file pmFPACopy.h
00002  * @brief Functions to copy FPA components.
00003  *
00004  * @author Paul Price, IfA
00005  *
00006  * @version $Revision: 1.4 $ $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_FPA_COPY_H
00012 #define PM_FPA_COPY_H
00013 
00014 /// @addtogroup Camera Camera Layout
00015 /// @{
00016 
00017 /// Copy an FPA and components, including the pixels, to a different representation of the same camera
00018 ///
00019 /// This function is useful for converting between different representations of the same camera.  For example,
00020 /// between Megacam "RAW" (one amp per extension) and Megacam "SPLICED" formats (two amps = 1 chip per
00021 /// extension, spliced together).  Components are spliced together as necessary.
00022 bool pmFPACopy(pmFPA *target,           ///< The target FPA
00023                const pmFPA *source      ///< The source FPA, to be copied
00024               );
00025 
00026 /// Copy a chip and components, including the pixels, to a different representation of the same camera
00027 ///
00028 /// This function is useful for converting between different representations of the same camera.  For example,
00029 /// between Megacam "RAW" (one amp per extension) and Megacam "SPLICED" formats (two amps = 1 chip per
00030 /// extension, spliced together).  Components are spliced together as necessary.
00031 bool pmChipCopy(pmChip *target,         ///< The target chip
00032                 const pmChip *source    ///< The source chip, to be copied
00033                );
00034 
00035 /// Copy a cell and components, including the pixels, to a different representation of the same camera
00036 ///
00037 /// This function is useful for converting between different representations of the same camera.  For example,
00038 /// between Megacam "RAW" (one amp per extension) and Megacam "SPLICED" formats (two amps = 1 chip per
00039 /// extension, spliced together).  Components are spliced together as necessary.
00040 bool pmCellCopy(pmCell *target,         ///< The target cell
00041                 const pmCell *source    ///< The source cell, to be copied
00042                );
00043 
00044 
00045 /// Copy an FPA, but not the pixels, to a different representation of the same camera
00046 ///
00047 /// This function the same as pmFPACopy, except that the pixels are not copied (though images of sufficient
00048 /// size are allocated in the target).  Changes the CELL.XBIN and CELL.YBIN according to the provided binning
00049 /// factors.
00050 bool pmFPACopyStructure(pmFPA *target,   ///< The target FPA
00051                         const pmFPA *source, ///< The source FPA, to be copied
00052                         int xBin, int yBin ///< Binning factors in x and y
00053                        );
00054 
00055 /// Copy a chip, but not the pixels, to a different representation of the same camera
00056 ///
00057 /// This function the same as pmChipCopy, except that the pixels are not copied (though images of sufficient
00058 /// size are allocated in the target).  Changes the CELL.XBIN and CELL.YBIN according to the provided binning
00059 /// factors.
00060 bool pmChipCopyStructure(pmChip *target, ///< The target chip
00061                          const pmChip *source, ///< The source chip, to be copied
00062                          int xBin, int yBin ///< Binning factors in x and y
00063                         );
00064 
00065 /// Copy a cell, but not the pixels, to a different representation of the same camera
00066 ///
00067 /// This function the same as pmCellCopy, except that the pixels are not copied (though images of sufficient
00068 /// size are allocated in the target).  Changes the CELL.XBIN and CELL.YBIN according to the provided binning
00069 /// factors.
00070 bool pmCellCopyStructure(pmCell *target, ///< The target cell
00071                          const pmCell *source, ///< The source cell, to be copied
00072                          int xBin, int yBin ///< Binning factors in x and y
00073                         );
00074 /// @}
00075 #endif

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