Changeset 9822 for trunk/psModules/src/detrend/pmFringeStats.h

Timestamp:

Nov 1, 2006, 12:39:53 PM (20 years ago)

Author:

Paul Price

Message:

Adding functions to read/write an array of fringe statistics to a single table. This allows us to use multiple readouts as the different fringe components, and then add a table containing the fringe measurements.

File:

• trunk/psModules/src/detrend/pmFringeStats.h (modified) (2 diffs)

trunk/psModules/src/detrend/pmFringeStats.h

@@ -8 +8 @@
 /// @author Paul Price, IfA
 ///
-/// @version $Revision: 1.8 $ $Name: not supported by cvs2svn $
-/// @date $Date: 2006-10-17 22:03:32 $
+/// @version $Revision: 1.9 $ $Name: not supported by cvs2svn $
+/// @date $Date: 2006-11-01 22:39:53 $
 ///
 /// Copyright 2004-2006 Institute for Astronomy, University of Hawaii
@@ -142 +142 @@
 
 //////////////////////////////////////////////////////////////////////////////////////////////////////////////
+// Input/output for multiple pmFringeStats
+//////////////////////////////////////////////////////////////////////////////////////////////////////////////
+
+/// Write an array of fringes measurements to a FITS table.
+///
+/// Writes an array of fringe measurements for the same FPA component as a FITS table.  The array of fringe
+/// statistics must all use the same fringe regions (or there is no point in storing them all together).  The
+/// header is supplemented with scalar values dX, dY, nX and nY (as PSFRNGDX, PSFRNGDY, PSFRNGNX, PSFRNGNY)
+/// from the fringe regions, while the fringe coordinates and mask are written as a FITS table (as x, y,
+/// mask, f, df; f and df are vectors).
+bool pmFringesWriteFits(psFits *fits,    ///< FITS file to which to write
+                        psMetadata *header, ///< Header, or NULL
+                        const psArray *fringes, ///< Array of pmFringeStats, all for the same pmFringeRegion
+                        const char *extname ///< Extension name for table
+                       );
+
+/// Reads an array of fringes measurements from a FITS table.
+///
+/// The fringes are read from the FITS file, at the given extension name.  The table provides the region and
+/// the (possibly multiple) fringe statistics for that region.  The current extension is used if the extension
+/// name is not provided.
+psArray *pmFringesReadFits(psMetadata *header, ///< Header to read, or NULL
+                           psFits *fits,///< FITS file from which to read
+                           const char *extname ///< Extension name to read, or NULL
+                          );
+
+
+//////////////////////////////////////////////////////////////////////////////////////////////////////////////
 // pmFringeScale
 //////////////////////////////////////////////////////////////////////////////////////////////////////////////