Changeset 9572 for trunk/psModules/src/concepts/pmConceptsAverage.h

Timestamp:

Oct 13, 2006, 4:35:39 PM (20 years ago)

Author:

Paul Price

Message:

Adding const where appropriate. Adding doxygen documentation to header files. Removing comments on functions defined in the header file, so that there's only a single source.

File:

• trunk/psModules/src/concepts/pmConceptsAverage.h (modified) (1 diff)

trunk/psModules/src/concepts/pmConceptsAverage.h

@@ -5 +5 @@
 #include "pmFPA.h"
 
-// Set a variety of concepts in a cell by averaging over several
-bool pmConceptsAverageCells(pmCell *target,// Target cell
-                            psList *sources, // List of source cells
-                            psRegion *trimsec, // The trim section
-                            psRegion *biassec // The bias section
+/// Set a variety of concepts in a cell by averaging over several
+///
+/// In some instances, we want to combine the values of a concept for several cells into a single concept for
+/// a single cell (e.g., when mosaicking multiple cells into a chip with one "cell").  This function averages
+/// the values of various concepts:
+/// - CELL.GAIN
+/// - CELL.READNOISE
+/// - CELL.EXPOSURE
+/// - CELL.DARKTIME
+/// - CELL.TIME
+/// For other concepts, it ensures the values are consistent:
+/// - CELL.READDIR
+/// - CELL.TIMESYS
+/// And for others, it takes the "worst" possible value:
+/// - CELL.SATURATION
+/// - CELL.BAD
+bool pmConceptsAverageCells(pmCell *target,///< Target cell
+                            psList *sources, ///< List of source cells
+                            psRegion *trimsec, ///< The new trim section
+                            psRegion *biassec ///< The new bias section
                            );