Changeset 5373

Timestamp:

Oct 18, 2005, 5:12:34 PM (21 years ago)

Author:

eugene

Message:

added notes for psRegion concerns

Location:

trunk/doc/pslib

Files:

• ChangeLogSDRS.tex (modified) (3 diffs)
• psLibSDRS.tex (modified) (13 diffs)

trunk/doc/pslib/ChangeLogSDRS.tex

@@ -1 @@
-%%% $Id: ChangeLogSDRS.tex,v 1.173 2005-09-16 22:25:26 price Exp $
+%%% $Id: ChangeLogSDRS.tex,v 1.174 2005-10-19 03:12:34 eugene Exp $
 
 \subsection{Changes from version 00 to version 01}
@@ -791 +791 @@
 \end{itemize}
 
-\subsection{Changes from Revision 16 (13 Sept 2005) to present}
+\subsection{Changes from Revision 16 (13 Sept 2005) to Revision 17 (18 Oct 2005)}
 
 \begin{itemize}
@@ -799 +799 @@
 \item changed psPolynomial masks from char to psU8.
 \item changed \code{psImage.col0,row0} changed from const.
-\item Removed \code{{psMath}
-
-\end{itemize}
-
+\item Removed \code{psMath}
+\item set \code{psPolynomial} order elements (nX, nY, etc)
+\end{itemize}
+

trunk/doc/pslib/psLibSDRS.tex

@@ -1 @@
-%%% $Id: psLibSDRS.tex,v 1.347 2005-10-19 02:57:36 eugene Exp $
+%%% $Id: psLibSDRS.tex,v 1.348 2005-10-19 03:12:34 eugene Exp $
 \documentclass[panstarrs,spec]{panstarrs}
 
@@ -11 +11 @@
 \project{Pan-STARRS Image Processing Pipeline}
 \organization{Institute for Astronomy}
-\version{16}
+\version{17}
 \docnumber{PSDC-430-007}
 
@@ -48 +48 @@
 15 & 2005 Jun 15 & draft for cycle 7 \\ \hline
 16 & 2005 Sep 13 & final for cycle 8 \\ \hline
+17 & 2005 Sep 13 & draft for cycle 9 \\ \hline
 \RevisionsEnd
 
@@ -3599 +3600 @@
 lower bounds of the image, the coordinates should saturate on those
 limits.  The output of this function is always a valid region, though
-it may define an area of 0 pixels.
+it may define an area of 0 pixels. \tbd{if Image is a subimage, do
+region coordinates refer to image or subimage?}
 
 
@@ -4082 +4084 @@
 \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.
+successful operation and 1 for an error.  \tbd{is region in the frame
+of input or of disk image?  how do image coordinates relate to disk
+image coords?}
 
 \begin{prototype}
@@ -5013 +5017 @@
 region.  In the event that \code{region.x1} or \code{region.y1} are
 negative, they shall be interpreted as being relative to the size of
-the parent image in that dimension.
+the parent image in that dimension. \tbd{how is region interpreted if
+image is a subimage?}
 
 The function shall generate an error if the specified region is
@@ -5066 +5071 @@
 the region.  In the event that \code{region.x1} or \code{region.y1}
 are negative, they shall be interpreted as being relative to the size
-of the parent image in that dimension.
+of the parent image in that dimension. \tbd{how is region interpreted
+  if input is a subimage?}
 
 The input region is collapsed in the direction perpendicular to that
@@ -5101 +5107 @@
 corresponding mask value is \code{maskVal} are not included in the
 interpolation.  This function must be defined for the following types:
-\code{psS8}, \code{psU16}, \code{psF32}, \code{psF64}.
+\code{psS8}, \code{psU16}, \code{psF32}, \code{psF64}. \tbd{how is
+region interpreted if input is a subimage?}
 
 \begin{prototype}
@@ -5243 +5250 @@
 \code{region} (size \code{region.x1 - region.x0} by \code{region.y1 -
 region.y0}, with \code{out->x0 = region.x0} and \code{out->y0 =
-region.y0}).
+region.y0}).  \tbd{is this subimage-safe}
 
 If the \code{inputMask} is non-\code{NULL}, those pixels in the
@@ -5301 +5308 @@
 This function returns the number of pixels in the image region which
 satisfy any of the mask bits.  An error (eg, invalid image, invalid
-region) results in a return value of -1.
+region) results in a return value of -1. \tbd{how should region be
+interpreted if mask is a subimage?}
 
 \begin{prototype}
@@ -5424 +5432 @@
 \end{prototype}
 
-\code{psPixelsToMask} shall return an image of type \code{psMaskType} with
-the \code{pixels} lying within the specified \code{region} set to the
-\code{maskVal}.  The \code{out} image shall be modified if supplied,
-or allocated and returned if \code{NULL}.  The size of the output
-image shall be \code{region.x1 - region.x0} by \code{region.y1 -
-region.y0}, with \code{out->x0 = region.x0} and \code{out->y0 =
+\code{psPixelsToMask} shall return an image of type \code{psMaskType}
+with the \code{pixels} lying within the specified \code{region} set to
+the \code{maskVal}.  The \code{out} image shall be modified if
+supplied, or allocated and returned if \code{NULL}.  The size of the
+output image shall be \code{region.x1 - region.x0} by \code{region.y1
+- region.y0}, with \code{out->x0 = region.x0} and \code{out->y0 =
 region.y0}.  In the event that either of \code{pixels} or
 \code{region} are \code{NULL}, the function shall generate an error
-and return \code{NULL}.
+and return \code{NULL}. \tbd{is this subimage-safe?}
 
 \code{psMaskToPixels} shall return a \code{psPixels} containing the
@@ -5454 +5462 @@
 by combining the existing pixel value and the given \code{maskValue}
 with a logical operation.  The allowed operations are \code{=},
-\code{AND}, \code{OR} and \code{XOR}.
+\code{AND}, \code{OR} and \code{XOR}. \tbd{is this subimage-safe?}
 
 \begin{prototype}
@@ -6467 +6475 @@
 return the inverse transformation.  In the event that \code{out} is
 \code{NULL}, a new \code{psPlaneTransform} shall be allocated and
-returned.
+returned. \tbd{is this subimage-safe?}
 
 \code{psPlaneTransformCombine} takes two transformations