Changeset 9525

Timestamp:

Oct 12, 2006, 2:30:38 PM (20 years ago)

Author:

Paul Price

Message:

Updating to match implementation; noting where functions are not yet
coded (and may not be in the near future).

File:

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

trunk/doc/pslib/psLibSDRS.tex

@@ -1 @@
-%%% $Id: psLibSDRS.tex,v 1.430 2006-09-19 21:56:42 price Exp $
+%%% $Id: psLibSDRS.tex,v 1.431 2006-10-13 00:30:38 price Exp $
 \documentclass[panstarrs,spec]{panstarrs}
 
@@ -1700 +1700 @@
 Office within Pan-STARRS.
 
+\tbd{psErrorRegister is not yet coded.}
+
 \paragraph{Error Codes for PSLib}
 
@@ -2694 +2696 @@
         psList *list;                   ///< psList entry
         psMetadata *md;                 ///< psMetadata entry
+        psString str;                   ///< string data
         psPtr V;                        ///< other type
     } data;                             ///< value of metadata
@@ -3009 +3012 @@
 \code{psList} iterators.
 \begin{prototype}
-psMetadataIterator *psMetadataIteratorAlloc(psMetadata *md, long location, const char *regex);
+psMetadataIterator *psMetadataIteratorAlloc(const psMetadata *md, long location,
+                                            const char *regex);
 bool psMetadataIteratorSet(psMetadataIterator *iterator, long location);
 psMetadataItem *psMetadataGetAndIncrement(psMetadataIterator *iterator);
@@ -3995 +3999 @@
 
 \begin{prototype}
-psDB *psDBInit(const char *host, const char *user, const char *passwd, const char *dbname);
+psDB *psDBInit(const char *host, const char *user, const char *passwd,
+               const char *dbname, unsigned int port);
 void psDBCleanup(psDB *dbh);
 bool psDBCreate(psDB *dbh, const char *dbname);
@@ -4392 +4397 @@
 
 \begin{prototype}
-bool psFitsWriteBlank(psFits *fits, const psMetadata *output);
+bool psFitsWriteBlank(psFits *fits, const psMetadata *output, const char *extname);
 \end{prototype}
 This function creates a header in the \code{fits} file for a 0 length
-image.  The resulting header shall have \code{NAXIS = 0}.  Any
-\code{NAXISi} elements present in the header shall be maintained as
-reference data.
+image, setting the extension name to \code{extname}.  The resulting
+header shall have \code{NAXIS = 0}.  Any \code{NAXISi} elements
+present in the header shall be maintained as reference data.
 
 \begin{prototype}
@@ -4412 +4417 @@
 \code{false}.
 
-
 \begin{prototype}
 bool psFitsIsImage(psMetadata *header);
@@ -4422 +4426 @@
 \code{psFitsIsTable} shall return \code{true} if the FITS
 \code{header} corresponds to that of a FITS table.
+
+\tbd{psFitsIsImage and psFitsIsTable are not yet coded.}
 
 \subsubsection{FITS Image I/O Functions}
@@ -4502 +4508 @@
 \end{prototype}
 
+\tbd{psFitsInsertImageCube is not yet coded.}
+
 
 \subsubsection{FITS Table I/O Functions}
@@ -4532 +4540 @@
 somewhere (and the file pointer location, for that matter).}
 
+\tbd{psFitsReadTableRowRaw is not yet coded.}
+
 \begin{prototype}
 psArray *psFitsReadTableColumn(const psFits *fits, const char *colname);
@@ -4559 +4569 @@
 the needed byte-swapping on the data in each row based on the
 description of the table data in the table header.
+
+\tbd{psFitsReadTableRaw is not yet coded.}
 
 \begin{prototype}
@@ -5611 +5623 @@
 \code{psS8}, \code{psU16}, \code{psF32}, \code{psF64}. 
 
+\tbd{The state of psImageCut is currently uncertain; the API in the
+code does not match the above.}
+
 \begin{prototype}
 psVector *psImageRadialCut(psVector *out, 
@@ -6827 +6842 @@
 struct timeval *psTimeToTimeval(const psTime *time);
 struct tm *psTimeToTM(const psTime *time);
-psString *psTimeStrftime(const psTime *time, const char *format);
+psString psTimeStrftime(const psTime *time, const char *format);
 \end{prototype}