pmConceptsAverage.h

Go to the documentation of this file.
00001 /* @file pmConceptsAverage.h
00002  * @brief Average the values of multiple concepts
00003  *
00004  * @author Paul Price, IfA
00005  *
00006  * @version $Revision: 1.5 $ $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_CONCEPTS_AVERAGE_H
00012 #define PM_CONCEPTS_AVERAGE_H
00013 
00014 /// @addtogroup Concepts Data Abstraction Concepts
00015 /// @{
00016 
00017 #include <pslib.h>
00018 #include "pmFPA.h"
00019 
00020 /// Set a variety of concepts in a cell by averaging over several
00021 ///
00022 /// In some instances, we want to combine the values of a concept for several cells into a single concept for
00023 /// a single cell (e.g., when mosaicking multiple cells into a chip with one "cell").  This function averages
00024 /// the values of various concepts:
00025 /// - CELL.GAIN
00026 /// - CELL.READNOISE
00027 /// - CELL.EXPOSURE
00028 /// - CELL.DARKTIME
00029 /// - CELL.TIME
00030 /// For other concepts, it ensures the values are consistent:
00031 /// - CELL.READDIR
00032 /// - CELL.TIMESYS
00033 /// And for others, it takes the "worst" possible value:
00034 /// - CELL.SATURATION
00035 /// - CELL.BAD
00036 bool pmConceptsAverageCells(pmCell *target,///< Target cell
00037                             psList *sources, ///< List of source cells
00038                             psRegion *trimsec, ///< The new trim section
00039                             psRegion *biassec ///< The new bias section
00040                            );
00041 
00042 /// @}
00043 #endif

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