Changeset 7715 for trunk/psModules/src/camera/pmFPAMaskWeight.h

Timestamp:

Jun 27, 2006, 6:03:35 PM (20 years ago)

Author:

Paul Price

Message:

Renaming pmReadoutSet{Mask,Weight} as pmReadoutGenerate{Mask,Weight}; adding pmReadoutSet{Mask,Weight}. These changes are in order to generate 'throwaway' masks and weights, in the case where we're using pmReadoutReadNext (which doesn't use the HDU).

File:

• trunk/psModules/src/camera/pmFPAMaskWeight.h (modified) (1 diff)

trunk/psModules/src/camera/pmFPAMaskWeight.h

@@ -21 +21 @@
 } pmMaskValue;
 
+// These functions set an extant mask/weight (or create a throwaway one).
+// The throwaway case is intended for when the user is iterating using pmReadoutReadNext, in which case
+// the HDU can't be generated
 bool pmReadoutSetMask(pmReadout *readout // Readout for which to set mask
                      );
 bool pmReadoutSetWeight(pmReadout *readout // Readout for which to set weight
                        );
-bool pmCellSetMaskWeight(pmCell *cell // Cell for which to set weights
-                        );
-bool pmReadoutSetMaskWeight(pmReadout *readout // Readout for which to set weights
-                           );
+
+// These functions generate a mask/weight suitable for output (complete with HDU entry) and then set them.
+bool pmReadoutGenerateMask(pmReadout *readout // Readout for which to generate mask
+                          );
+bool pmReadoutGenerateWeight(pmReadout *readout // Readout for which to generate weight
+                            );
+
+// These functions are conveniences for pmReadoutGenerateMask and pmReadoutGenerateWeight.
+bool pmCellGenerateMaskWeight(pmCell *cell // Cell for which to generate mask and weights
+                             );
+bool pmReadoutGenerateMaskWeight(pmReadout *readout // Readout for which to generate mask and weights
+                                );