Changeset 1671

Timestamp:

Sep 1, 2004, 1:40:14 PM (22 years ago)

Author:

Paul Price

Message:

TBD-ed the astronomical objects section.

File:

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

trunk/doc/pslib/psLibSDRS.tex

@@ -1 @@
-%%% $Id: psLibSDRS.tex,v 1.97 2004-09-01 03:48:19 price Exp $
+%%% $Id: psLibSDRS.tex,v 1.98 2004-09-01 23:40:14 price Exp $
 \documentclass[panstarrs,spec]{panstarrs}
 
@@ -2383 +2383 @@
 is derived from the statistics of the pixels at that direction
 coordinate.  The statistic used to derive the output vector value is
-specified by \code{stats}.  If \code{coords} is not \code{NULL}, the
-calculated coordinates along the slice are returned in this vector.
-Only one of the statistics choices may be specified, otherwise the
-function must return an error.  This function must be defined for the
-following types: \code{psS8}, \code{psU16}, \code{psF32},
-\code{psF64}.
+specified by \code{stats}.  If \code{mask} is non-\code{NULL}, pixels
+for which the corresponding \code{mask} pixel matches \code{maskVal}
+are excluded from operations.  If \code{coords} is not \code{NULL},
+the calculated coordinates along the slice are returned in this
+vector.  Only one of the statistics choices may be specified,
+otherwise the function must return an error.  This function must be
+defined for the following types: \code{psS8}, \code{psU16},
+\code{psF32}, \code{psF64}.
 
 \begin{verbatim}
@@ -2422 +2424 @@
 statistic used to derive the output vector value is specified by
 \code{stats}.  Only one of the statistics choices may be specified,
-otherwise the function must return an error.  The \code{mask} and
-\code{maskVal} entries are passed to the psLib statistics function
-used to calculate the ensemble statistics.  This function must be
-defined for the following types: \code{psS8}, \code{psU16},
+otherwise the function must return an error.  If \code{mask} is
+non-\code{NULL}, pixels for which the corresponding \code{mask} pixel
+matches \code{maskVal} are excluded from operations.  This function
+must be defined for the following types: \code{psS8}, \code{psU16},
 \code{psF32}, \code{psF64}.
 
@@ -2459 +2461 @@
 corresponding set of input image pixels based on the statistics
 specified by \code{stats}.  Only one of the statistics choices may be
-specified, otherwise the function must return an error.  The
-\code{mask} and \code{maskVal} entries are passed to the psLib
-statistics function used to calculate the ensemble statistics.  This
-function must be defined for the following types: \code{psU8},
+specified, otherwise the function must return an error.  If
+\code{mask} is non-\code{NULL}, pixels for which the corresponding
+\code{mask} pixel matches \code{maskVal} are excluded from operations.
+This function must be defined for the following types: \code{psU8},
 \code{psU16}, \code{psS8}, \code{psS16}, \code{psF32}, \code{psF64},
 \code{psC32}, \code{psC64}.
@@ -2560 +2562 @@
 following types: \code{psS8}, \code{psU16}, \code{psF32}, \code{psF64}.
 
-\tbd{does this need to define the mask?}
+\tbd{Do we need to include a mask for psImagePixelInterpolate?}
 
 \begin{verbatim}
@@ -2595 +2597 @@
 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 will only
-read images of the native FITS image types (\code{psU8}, \code{psU16},
-\code{psU32}, \code{psF32}, \code{psF64}).  The user is expected to
+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}.  
  
@@ -3270 +3272 @@
     psMetadataType type;                ///< type of this item
     const union {
+        bool bool;                      ///< boolean value
         psS32 S32;                      ///< integer value
         psF32 F32;                      ///< floating value
@@ -3292 +3295 @@
 typedef enum {                          ///< type of data.item is:
     PS_META_ITEM_SET = 0,               ///< NULL; metadata is in psMetadataType.items
+    PS_META_BOOL,                       ///< bool (.bool)
     PS_META_S32,                        ///< int (.S32)
     PS_META_F32,                        ///< float (.F32)
@@ -3805 +3809 @@
 \subsection{Astronomical objects}
 
+\tbd{These functions are all of low priority, have not yet been
+defined in detail, and are not immediately required.}
+
 \subsubsection{Positions of Major SS Objects}
 
-\tbd{We require the ability to calculate the position of major Solar System
-objects, as well as Lunar phase.}
+We may require the ability to calculate the position of major Solar System
+objects, as well as Lunar phase.
 
 \begin{verbatim}