Changeset 2712

Timestamp:

Dec 14, 2004, 9:52:24 AM (22 years ago)

Author:

eugene

Message:

fits mods

Location:

trunk/doc/pslib

Files:

• ChangeLogSDRS.tex (modified) (2 diffs)
• psLibSDRS.tex (modified) (7 diffs)

trunk/doc/pslib/ChangeLogSDRS.tex

@@ -1 @@
-%%% $Id: ChangeLogSDRS.tex,v 1.50 2004-12-11 02:30:17 price Exp $
+%%% $Id: ChangeLogSDRS.tex,v 1.51 2004-12-14 19:52:24 eugene Exp $
 
 \subsection{Changes from version 00 to version 01}
@@ -395 +395 @@
 \item Changed names of \code{psSphereTransform} structure members to conform with ADD.
 \item Altered \code{psList} and \code{psListIterator} to match that in bug 249.
-\end{itemize}
+\item added status element to psMetadataLookupTYPE utilities
+\item dropped psFitsCreateExt per discussion with rdd
+\item fixed error of psHash to psMetadata in psFitsReadHeaderSet
+\item added psFitsWriteImage
+\item changed psFitsWriteImageSection to psFitsUpdateImage {\bf verify}
+\item changed psFitsWriteHeader to psFitsUpdateHeader {\bf verify}
+\item added header entry to psFitsWriteTable
+\item added psFitsUpdateTable 
+\end{itemize}

trunk/doc/pslib/psLibSDRS.tex

@@ -1 @@
-%%% $Id: psLibSDRS.tex,v 1.158 2004-12-11 02:30:23 price Exp $
+%%% $Id: psLibSDRS.tex,v 1.159 2004-12-14 19:52:24 eugene Exp $
 \documentclass[panstarrs,spec]{panstarrs}
 
@@ -3918 +3918 @@
 functions perform the effort of casting the data to the appropriate
 type.  The numerical functions shall return 0.0 if their key is not
-found.
-\begin{verbatim}
-void *psMetadataLookupPtr(const psMetadata *md, const char *key);
-psS32 psMetadataLookupS32(const psMetadata *md, const char *key);
-psF64 psMetadataLookupF64(const psMetadata *md, const char *key);
+found.  If the pointer value of \code{status} is not \code{NULL}, it
+is set to reflect the success or failure of the lookup.
+\begin{verbatim}
+void *psMetadataLookupPtr(bool *status, const psMetadata *md, const char *key);
+psS32 psMetadataLookupS32(bool *status, const psMetadata *md, const char *key);
+psF64 psMetadataLookupF64(bool *status, const psMetadata *md, const char *key);
 \end{verbatim}
 
@@ -4237 +4238 @@
 
 \begin{verbatim}
-int psFitsCreateExt(psFits* fits, psFitsType type, const char* name);
-\end{verbatim}
-
-Creates a new HDU on the end of the file with the given extname and
-type.  The psFits pointer is positioned to the new HDU.  \tbd{does
-this write data to disk or not?}
-
-\begin{verbatim}
 psFitsType psFitsGetExtType(psFits* fits);
 \end{verbatim}
@@ -4264 +4257 @@
 Load a complete set of headers from the \code{psFits} file pointer.
 This function loads the headers from all extensions into a
-\code{psHash}, each entry of which is a pointer to a \code{psMetadata}
-structure containing the header data.  The hash keys are the
-\code{EXTNAME} values for each header (with the value of \code{PHU}
-for the primary header unit).  At the start of the operation, the file
-pointer is rewound to the beginning of the file.  At the end, it is
-positioned where it started when the function was called.
+\code{psMetadata} collection, each entry of which is a pointer to a
+\code{psMetadata} structure containing the header data.  The metadata
+entry names are the \code{EXTNAME} values for each header (with the
+value of \code{PHU} for the primary header unit).  At the start of the
+operation, the file pointer is rewound to the beginning of the file.
+At the end, it is positioned where it started when the function was
+called.
 
 \begin{verbatim}
 bool psFitsWriteHeader(psMetadata *output, const psFits *fits);
+bool psFitsUpdateHeader(psMetadata *output, const psFits *fits);
 \end{verbatim}
 Write metadata into the header of a FITS image file.  The header is
@@ -4300 +4295 @@
 \begin{verbatim}
 bool psFitsWriteImageSection(psFits *fits, const psImage *input, psRegion region, int z);
-\end{verbatim}
+bool psFitsUpdateImage(psFits *fits, const psImage *input, psRegion region, int z);
+\end{verbatim}
+\tbd{we have discussed this as the alternate name} 
 Write an image section to the open \code{psFits} file pointer.  This
 operation may write a portion of an image over the existing bytes of
@@ -4315 +4312 @@
 successful operation and 1 for an error.
 
+\begin{verbatim}
+bool psFitsWriteImage(psFits *fits, psMetadata *header, const psImage *input, int depth);
+\end{verbatim}
+Create a new image based on the dimensions specified for the image and
+the requested depth.  The header and image data segments are written
+in the file at the current position of the \code{psFits} pointer.
+This function will only write images of the 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.
+
 \subsubsection{FITS Table I/O Functions}
 
@@ -4381 +4390 @@
 
 \begin{verbatim}
-bool psFitsWriteTable(psFits* fits, psArray* table); 
+bool psFitsWriteTable(psFits* fits, psMetadata *header, psArray* table); 
 \end{verbatim}
 Accepts a \code{psArray} of \code{psMetadata} and writes it to the
 current HDU.  If the current HDU is not a table type, this will fail
 and return FALSE.
+
+\begin{verbatim}
+bool psFitsUpdateTable(psFits* fits, psMetadata *header, psMetadata* data, int row); 
+\end{verbatim}
+Writes the \code{psMetadata} data to a FITS table at the specified row
+in the current HDU.  If the current HDU is not a table type, this will
+fail and return FALSE.  
 
 \subsection{Detector and Sky Coordinates}