Changeset 4720 for trunk/doc/modules/CameraImages.tex

Timestamp:

Aug 5, 2005, 11:34:05 AM (21 years ago)

Author:

Paul Price

Message:

Modified definition of pmFPASelectChip.

File:

• trunk/doc/modules/CameraImages.tex (modified) (2 diffs)

trunk/doc/modules/CameraImages.tex

@@ -377 +377 @@
 
 \begin{prototype}
-int pmFPASelectChip(pmFPA *fpa, int chipNum);
+bool pmFPASelectChip(pmFPA *fpa, int chipNum);
 int pmFPAExcludeChip(pmFPA *fpa, int chipNum);
 \end{prototype}
@@ -383 +383 @@
 These functions are provided to set the \code{valid} booleans within
 an \code{fpa} so that only certain chips within the FITS file are read
-in.  \code{pmFPASelectChip} shall set \code{valid} to \code{true} for
-the specified chip number (\code{chipNum}), and all other chips shall
-have \code{valid} set to \code{false}.  \code{pmFPAExcludeChip} shall
-set \code{valid} to \code{false} only for the specified chip number
-(\code{chipNum}).  In the event that the specified chip number does
-not exist within the \code{fpa}, the function shall generate a
-warning, and perform no action.  Both functions shall return the
-number of chips within the \code{fpa} that have \code{valid} set to
-\code{true} (should be one for \code{pmFPASelectChip}).
+in.
+
+\code{pmFPASelectChip} shall set \code{valid} to \code{true} for the
+specified chip number (\code{chipNum}), and all other chips shall have
+\code{valid} set to \code{false}.  In the event that the specified
+chip number does not exist within the \code{fpa}, the function shall
+return \code{false}.
+
+\code{pmFPAExcludeChip} shall set \code{valid} to \code{false} only
+for the specified chip number (\code{chipNum}).  In the event that the
+specified chip number does not exist within the \code{fpa}, the
+function shall generate a warning, and perform no action.  The
+function shall return the number of chips within the \code{fpa} that
+have \code{valid} set to \code{true}.
 
 \begin{datatype}