Index: trunk/doc/pslib/psLibSDRS.tex =================================================================== --- trunk/doc/pslib/psLibSDRS.tex (revision 3174) +++ trunk/doc/pslib/psLibSDRS.tex (revision 3176) @@ -1,3 +1,3 @@ -%%% $Id: psLibSDRS.tex,v 1.178 2005-02-09 22:00:38 price Exp $ +%%% $Id: psLibSDRS.tex,v 1.179 2005-02-10 01:26:56 eugene Exp $ \documentclass[panstarrs,spec]{panstarrs} @@ -11,5 +11,5 @@ \project{Pan-STARRS Image Processing Pipeline} \organization{Institute for Astronomy} -\version{11} +\version{12} \docnumber{PSDC-430-007} @@ -40,6 +40,7 @@ 08 & 2004 Oct 12 & draft for start of cycle 4 \\ \hline 09 & 2004 Nov 15 & final for cycle 4 \\ \hline -10 & 2004 Nov 30 & update for cycle 4 \\ -11 & 2005 Jan 21 & draft for cycle 5 \\ +10 & 2004 Nov 30 & update for cycle 4 \\ \hline +11 & 2005 Jan 21 & draft for cycle 5 \\ \hline +12 & 2005 Feb 09 & final for cycle 5 \\ \RevisionsEnd @@ -136,6 +137,7 @@ \href{heasarc.gsfc.nasa.gov/docs/software/fitsio}{\tt heasarc.gsfc.nasa.gov/docs/software/fitsio} -\item Many of the astronomy routines will wrap the StarLink Positional -Astronomy libraries (SLALib): +\item \tbd{SLALIB support is likely to be dropped} Many of the +astronomy routines will wrap the StarLink Positional Astronomy +libraries (SLALib): \href{star-www.rl.ac.uk/star/docs/sun67.htx/sun67.html}{\tt @@ -2894,57 +2896,4 @@ in a loop. -\subsubsection{Image I/O Functions} - -\tbd{this section is being deprecated and the equivalent of these -functions are being moved to FITS I/O Functions. I will leave this -section here until others may read the section on FITS I/O.} - -\begin{verbatim} -psImage *psImageReadSection(psImage *output, int x0, int y0, int x1, int y1, int z, - const char *extname, int extnum, const char *filename); -\end{verbatim} -Read an image or subimage from a named file. This function is a -wrapper to the FITS library function. The input parameters allow a -full image or a subimage to be read. The starting pixel of the region -is specified by \code{x0,y0}, while the upper right-hand corner of the -requested region is specified by \code{x1,y1}. A negative value for -either of \code{x1} or \code{y1} specifies the size of the region to -be read counting down from the end of the array. - -If the native image is a cube, the value of z specifies the requested -slice of the image. The data is read from the extension specified by -extname (matching the EXTNAME keyword) or by the extnum value (with 0 -representing the primary header unit (PHU), 1 the first extension, -etc). This function must call \code{psError} and return \code{NULL} -if any of the specified parameters are out of range for the data in -the image file, if the specified image file does not exist, or the -image on disk is zero- or one-dimensional. This function need only -read 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}. - -\begin{verbatim} -bool psImageWriteSection(const psImage *input, int x, int y, int z, - const char *extname, int extnum, const char *filename); -\end{verbatim} -Write an image section to the named file, which may exist. This -operation may write a portion of an image over the existing bytes of -an existing image. If the file does not exist, it should be created. -If the specified extension does not exist, it should be created. If -an extension is specified and no PHU exists, a basic PHU should be -created. Care must be taken to interpret x,y,z in the two cases a) -there is already an existing image and b) there is not an existing -image. If the image exists, write the complete psImage data to the -existing image starting at the coordinate x,y,z. If any of these -parameters implies writing pixels outside the existing data area of -the image, return an error (ie, if \code{x + image.nx >= NAXIS1}, -\code{y + image.ny >= NAXIS2}, or \code{z >= NAXIS3}). If the image -does not exist, require x,y,z to be zero. 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{Image Pixel Manipulations} @@ -3509,8 +3458,7 @@ The functions may accept either \code{psTimeType}. The \code{time} is modified and returned. Note that this function must supply the value -UT1-UTC, which is available externally. The value UT1-UTC is -necessary for this an various other SLALIB functions. The following -utility function encapsulates the PSLib mechanism to extract the value -of UT1-UTC: +UT1-UTC, which is available externally (see \code{psTimeGetUT1Delta}). +The following utility function encapsulates the PSLib mechanism to +extract the value of UT1-UTC: \begin{verbatim} double psTimeGetUT1Delta(const psTime *time);