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

Timestamp:

Apr 3, 2006, 5:29:03 PM (20 years ago)

Author:

Paul Price

Message:

Updated psFitsValidateHeader, psFitsWriteImage, psFitsWriteTable;
added psFitsHeaderFromImage, psFitsHeaderFromTable. See bug 733.

File:

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

trunk/doc/pslib/psLibSDRS.tex

@@ -1 @@
-%%% $Id: psLibSDRS.tex,v 1.389 2006-03-30 03:36:41 price Exp $
+%%% $Id: psLibSDRS.tex,v 1.390 2006-04-04 03:29:03 price Exp $
 \documentclass[panstarrs,spec]{panstarrs}
 
@@ -4139 +4139 @@
 \code{psFitsHeaderValidate} shall validate the supplied \code{header}
 so that it is in compliance to the FITS standard for header keyword
-names and types.  The contents should be changed to conform to the
-FITS standard where possible by truncating names and adding (where
-missing) those keywords required by FITS (e.g., \code{SIMPLE}).  If
-the resulting \code{header} conforms to the FITS standard, the
-function shall return \code{true}; otherwise the function shall return
+names and types.  This involves scanning for types that cannot be
+represented in FITS, and changing the keywords to conform to the FITS
+standard where possible by using the \code{HIERARCH} keyword.  If the
+resulting \code{header} conforms to the FITS standard, the function
+shall return \code{true}; otherwise the function shall return
 \code{false}.
+
+\begin{prototype}
+psMetadata *psFitsHeaderFromImage(psMetadata *header, const psImage *image);
+psMetadata *psFitsHeaderFromTable(psMetadata *header, const psArray *table);
+\end{prototype}
+
+\code{psFitsHeaderFromImage} shall format the \code{header} to be
+appropriate for writing the \code{image}.  The function shall update
+the following keywords in the \code{header} on the basis of the
+\code{image}: \code{SIMPLE}, \code{NAXIS}, \code{NAXIS1},
+\code{NAXIS2}, \code{NAXIS3}, \code{BSCALE}, \code{BZERO},
+\code{EXTNAME}.  If the \code{header} is \code{NULL}, a new header
+shall be allocated and returned.  \code{psFitsHeaderFromTable} shall
+do similarly for \code{table}s, setting the appropriate keywords for
+FITS tables.
+
 
 \begin{prototype}
@@ -4205 +4221 @@
 native FITS image types (\code{psU8}, \code{psS16}, \code{psS32},
 \code{psF32}, \code{psF64}).  The user is expected to convert the data
-type as needed with \code{psImageCopy}.  The return value must be 0
-for a successful operation and 1 for an error.  If \code{extname} is
-not \code{NULL}, the \code{EXTNAME} in the \code{header} shall be
-updated to be \code{extname} before writing.
+type as needed with \code{psImageCopy}.  The function shall call
+\code{psFitsHeaderForImage} to obtain the correct FITS headers.  The
+return value must be 0 for a successful operation and 1 for an error.
 
 \begin{prototype}
@@ -4308 +4323 @@
 \end{prototype}
 Accepts a \code{psArray} of \code{psMetadata} and writes it to the end
-of the file with the given \code{extname}.
+of the file with the given \code{extname}.  The function shall call
+\code{psFitsHeaderFromTable} to obtain the correct headers for writing
+the table.
 
 \begin{prototype}