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

Timestamp:

May 18, 2005, 10:45:01 AM (21 years ago)

Author:

Paul Price

Message:

Adding more functions that have been already implemented

File:

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

trunk/doc/pslib/psLibSDRS.tex

@@ -1 @@
-%%% $Id: psLibSDRS.tex,v 1.224 2005-05-17 04:06:00 price Exp $
+%%% $Id: psLibSDRS.tex,v 1.225 2005-05-18 20:45:01 price Exp $
 \documentclass[panstarrs,spec]{panstarrs}
 
@@ -1493 +1493 @@
 \begin{verbatim}
 psImage *psImageAlloc (int width, int height, psElemType type);
-\end{verbatim}
-Create an image of a specified \code{width}, \code{height}, and data
+psImage* psImageRecycle(psImage* old, int numCols, int numRows, const psElemType type);
+\end{verbatim}
+
+\code{psImageAlloc} shall create an image of a specified \code{width}, \code{height}, and data
 \code{type}.  This function must allow any of the valid image data
 types and not restrict to the valid FITS BITPIX types.  The image
 dimensionality must be 2.  
+
+\code{psImageRecycle} shall recycle the input \code{old} image, such
+that the output \code{psImage} matches the specified size
+(\code{numCols}$\times$\code{numRows}) and \code{type}.  In the event
+that the input \code{old} image is \code{NULL}, a new \code{psImage}
+shall be allocated and returned.
+
+\begin{verbatim}
+int psImageFreeChildren(psImage* image);
+\end{verbatim}
+
+\code{psImageFreeChildren} shall free all child images of the given
+\code{image}.
 
 \subsection{Math Casting}
@@ -2716 +2731 @@
 region in the form \code{[x0:x1,y0:y1]}, used for header entries such
 as \code{BIASSEC}, into the corresponding \code{psRegion} structure.
-
-\begin{verbatim}
-psRegion psRegionSet (float x0, float x1, float y0, float y1);
-psRegion psRegionFromString (char *region);
+We also define a function that converts a \code{psRegion} to the
+corresponding IRAF description.
+
+\begin{verbatim}
+psRegion psRegionSet(float x0, float x1, float y0, float y1);
+psRegion psRegionFromString(const char *region);
+char *psRegionToString(const psRegion region);
 \end{verbatim}
 
@@ -4637 +4655 @@
 
 Gets the current HDU's type (table or image).
+
+\begin{verbatim}
+char *psFitsGetExtName(const psFits* fits);
+bool psFitsSetExtName(const psFits* fits, const char* name);
+\end{verbatim}
+
+\code{psFitsGetExtName} shall return the name of the current extension
+for the given \code{fits} file (as specified by the \code{EXTNAME}
+header).  \code{psFitsSetExtName} shall change the name of the current
+extension for the given \code{fits} file to \code{name}, returning
+\code{true} upon success and \code{false} otherwise.
 
 \subsubsection{FITS Header I/O Functions}