Changeset 6853

Timestamp:

Apr 13, 2006, 5:01:25 PM (20 years ago)

Author:

Paul Price

Message:

Adding pmReadoutReadNext demonstration.

File:

• trunk/doc/modules/CameraImages.tex (modified) (1 diff)

trunk/doc/modules/CameraImages.tex

@@ -455 +455 @@
 components is used for the output.  The \code{fpa} should contain
 sufficient information with which to write the FITS images.
+
+\tbd{Following the reworking of the focal plane hierarchy in April
+2006, much of this document needs to be updated.  I'm including the below
+before I forget them --- PAP.}
+
+\begin{prototype}
+bool pmReadoutReadNext(pmReadout *readout, psFits *fits, int z, int numRows);
+bool pmCellRead(pmCell *cell, psFits *fits, psDB *db);
+bool pmChipRead(pmChip *chip, psFits *fits, psDB *db);
+bool pmFPARead(pmFPA *fpa, psFits *fits, psDB *db);
+\end{prototype}
+
+\tbd{Explanation here.}
+
+Here's a demonstration of the use of \code{pmReadoutReadNext}:
+\begin{verbatim}
+    pmReadout *readout = pmReadoutAlloc(cell);
+    for (int z = 0; pmReadoutReadNext(readout, inFile, z, 100); z++) {
+        do {
+            somethingWithTheReadout(readout);
+        } while (pmReadoutReadNext(readout, inFile, z, 2048));
+    }
+    psFree(readout);
+\end{verbatim}
+
 
 \subsubsection{Mask and weight input/output}