Changeset 6532 for trunk/doc/pslib/psLibSDRS.tex

Timestamp:

Mar 6, 2006, 1:12:53 PM (20 years ago)

Author:

Paul Price

Message:

Added psFitsReadImageCube,psFitsInsertImageCube,psFitsWriteImageCube,psFitsInsertImageCube functions.
Added extname to psFitsWriteTable and psFitsInsertTable to mirror the image versions.

File:

• trunk/doc/pslib/psLibSDRS.tex (modified) (5 diffs)

trunk/doc/pslib/psLibSDRS.tex

@@ -1 @@
-%%% $Id: psLibSDRS.tex,v 1.386 2006-03-03 21:48:12 price Exp $
+%%% $Id: psLibSDRS.tex,v 1.387 2006-03-06 23:12:45 price Exp $
 \documentclass[panstarrs,spec]{panstarrs}
 
@@ -4146 +4146 @@
 
 \begin{prototype}
-psImage *psFitsReadImage(psImage *out, const psFits *fits, psRegion region, int z);
+psImage *psFitsReadImage(const psFits *fits, psRegion region, int z);
 \end{prototype}
 Read an image or subimage from the \code{psFits} file pointer.  This
@@ -4211 +4211 @@
 the entire file following the inserted extension must be rewritten.}
 
+We also provide the following functions that use a \code{psArray} of
+\code{psImages}, so that the user need not worry about updating
+\code{NAXIS} headers:
+
+\begin{prototype}
+psArray *psFitsReadImageCube(const psFits *fits, psRegion region);
+bool psFitsUpdateImageCube(psFits *fits, const psArray *input, int x0, int y0);
+bool psFitsWriteImageCube(psFits *fits, psMetadata *header, const psArray
+*input, const char *extname);
+bool psFitsInsertImageCube(psFits *fits, psMetadata *header, const psArray
+*input, const char *extname, bool after);
+\end{prototype}
+
+
 \subsubsection{FITS Table I/O Functions}
 
@@ -4277 +4291 @@
 
 \begin{prototype}
-bool psFitsWriteTable(psFits* fits, const psMetadata *header, const psArray* table); 
+bool psFitsWriteTable(psFits* fits, const psMetadata *header, const psArray* table
+                      const char *extname); 
 \end{prototype}
 Accepts a \code{psArray} of \code{psMetadata} and writes it to the end
-of the file.
+of the file with the given \code{extname}.
 
 \begin{prototype}
@@ -4291 +4306 @@
 \begin{prototype}
 bool psFitsInsertTable(psFits *fits, const psMetadata *header, const psArray* table,
-                       bool after);
+                       const char *extname, bool after);
 \end{prototype}