Index: /trunk/doc/design/Makefile =================================================================== --- /trunk/doc/design/Makefile (revision 6433) +++ /trunk/doc/design/Makefile (revision 6434) @@ -1,3 +1,3 @@ -# $Id: Makefile,v 1.15 2006-01-22 09:54:47 eugene Exp $ +# $Id: Makefile,v 1.16 2006-02-16 18:57:50 eugene Exp $ PDFLATEX = env TEXINPUTS=../../latex/inputs:$(TEXINPUTS):.: pdflatex @@ -8,10 +8,11 @@ @echo " targets: srs ssdd scd all" -cdr: ippCDR.pdf +scd: ippSCD.pdf srs: ippSRS.pdf ssdd: ippSSDD.pdf -scd: ippSCDps1.pdf -all : srs ssdd scd cdr +scd-draft: ippSCDdraft.pdf + +all : srs ssdd scd ippSRS.pdf : ippSRS.tex @@ -22,12 +23,12 @@ %.pdf: %.tex - $(PSLATEX) $*.tex - $(PSLATEX) $*.tex - dvips -z -t letter -o $*.ps $*.dvi - ps2pdf $*.ps $*.pdf - thumbpdf --modes=dvips $*.pdf - $(PSLATEX) $*.tex - dvips -z -t letter -o $*.ps $*.dvi - ps2pdf $*.ps $*.pdf + $(PSLATEX) $*.tex || exit + $(PSLATEX) $*.tex || exit + dvips -z -t letter -o $*.ps $*.dvi || exit + ps2pdf $*.ps $*.pdf || exit + thumbpdf --modes=dvips $*.pdf || exit + $(PSLATEX) $*.tex || exit + dvips -z -t letter -o $*.ps $*.dvi || exit + ps2pdf $*.ps $*.pdf || exit @rm -f $*.ps $*.dvi $*.aux $*.log $*.tbr $*.tbd $*.lof $*.toc $*.tpm body.tmp head.tmp Index: /trunk/doc/design/ippSCD.tex =================================================================== --- /trunk/doc/design/ippSCD.tex (revision 6433) +++ /trunk/doc/design/ippSCD.tex (revision 6434) @@ -1,9 +1,9 @@ -%%% $Id: ippSCD.tex,v 1.1 2006-01-16 00:39:24 eugene Exp $ +%%% $Id: ippSCD.tex,v 1.2 2006-02-16 18:57:50 eugene Exp $ \documentclass[panstarrs]{panstarrs} % basic document variables \title{Pan-STARRS PS-1 Image Processing Pipeline} -\subtitle{System/Subsystem Design Description} -\shorttitle{IPP SSDD} +\subtitle{System Concept Design} +\shorttitle{IPP SCD} \author{Eugene A. Magnier, Paul A. Price, Josh Hoblitt} \audience{Pan-STARRS PMO} @@ -11,5 +11,5 @@ \project{Pan-STARRS Image Processing Pipeline} \organization{Institute for Astronomy} -\version{00} +\version{01} \docnumber{PSDC-430-011} @@ -28,5 +28,7 @@ DR.04 & 2004.04.13 & Most sections fleshed out \\ \hline DR.05 & 2004.04.29 & Reorganization for consistency \\ \hline -DR.06 & 2004.10.21 & Major revision in prep of PDR \\ \hline +DR.06 & 2004.10.21 & Major revision in prep of PDR \\ \hline \hline +00 & 2004.11.04 & Incorporation of PDR Comments \\ \hline +01 & 2006.01.22 & Name change (SSDD to SCD) before CDR \\ \hline \RevisionsEnd @@ -92,10 +94,10 @@ \subsection{Document Overview} -The Pan-STARRS IPP System/Subsystem Design Description (SSDD) contains -the complete design description of the Pan-STARRS PS-1 IPP in order to +The Pan-STARRS IPP System Concept Definition (SCD) contains the +complete design concepts of the Pan-STARRS PS-1 IPP in order to achieve the requirements specified by the Pan-STARRS PS-1 IPP Software Requirements Specification (SRS; PSDC-430-005). The requirements flow -begun in the SGS and SCD and continued in the SRS is used to guide the -design presented here. +begun in the SGS and full Pan-STARRS SCD and continued in the SRS is +used to guide the design presented here. \subsection{Requirements Definitions} Index: /trunk/doc/design/ippSSDD.tex =================================================================== --- /trunk/doc/design/ippSSDD.tex (revision 6433) +++ /trunk/doc/design/ippSSDD.tex (revision 6434) @@ -1,3 +1,2 @@ -%%% $Id: ippSSDD.tex,v 1.7 2006-01-22 09:54:47 eugene Exp $ \documentclass[panstarrs]{panstarrs} @@ -11,6 +10,6 @@ \project{Pan-STARRS Image Processing Pipeline} \organization{Institute for Astronomy} -\version{00} -\docnumber{PSDC-430-011} +\version{DR.02} +\docnumber{PSDC-430-014} % allow paragraphs to be listed in TOC for now @@ -23,10 +22,6 @@ \RevisionsStart % version Date Description -DR.01 & 2004.01.01 & First draft \\ \hline -DR.02 & 2004.03.05 & Second draft \\ \hline -DR.03 & 2004.03.25 & Section reorganization \\ \hline -DR.04 & 2004.04.13 & Most sections fleshed out \\ \hline -DR.05 & 2004.04.29 & Reorganization for consistency \\ \hline -DR.06 & 2004.10.21 & Major revision in prep of PDR \\ \hline +DR.01 & 2006.01.19 & First draft release to CDR committee \\ \hline +DR.02 & 2006.01.22 & Second draft release to CDR committee \\ \hline \RevisionsEnd @@ -96,6 +91,6 @@ achieve the requirements specified by the Pan-STARRS PS-1 IPP Software Requirements Specification (SRS; PSDC-430-005). The requirements flow -begun in the SGS and SCD and continued in the SRS is used to guide the -design presented here. +which began in the SGS and Pan-STARRS system SCD, and continued in the +IPP SRS and the IPP SCD, is used to guide the design presented here. \subsection{Requirements Definitions} @@ -135,4 +130,5 @@ PSDC-430-007 & Pan-STARRS IPP PSLib Supplementary Design Requirements Specification \\ \hline PSDC-430-010 & Pan-STARRS IPP Perl Code Conventions \\ \hline +PSDC-430-011 & Pan-STARRS IPP System Concept Definition \\ \hline PSDC-430-012 & Pan-STARRS IPP Modules Supplementary Design Requirements Specification \\ \hline PSDC-430-014 & Pan-STARRS IPP PS-1 Cluster Support \\ \hline @@ -140,6 +136,4 @@ Posix Standard & Open Group Based Specifications Issue 6, IEEE Std 1003.1, 2003 \\ \DocumentsEnd - -\tbd{add the other subsystem SDDs} \section{Subsystem Overview} @@ -232,6 +226,4 @@ \subsection{System Design Decisions} -\tbd{add discussion of the AP survey and other survey projects} - Since Pan-STARRS is a survey project, all data from the telescopes will be uniformly analyzed by the Pan-STARRS Image Processing Pipeline @@ -263,22 +255,34 @@ elements. -\subsection{Analysis Tasks and Stages} - -\tbd{this discussion is confusing, and even more so in the context of - the PanTasks definition of a 'task'}. - -Specific programs are required to perform the processing steps listed -above. These can be divided into well-defined analysis stages, each -of which operates on a particular unit of data, such as a single OTA -image or a collection of astronomical objects. Analysis tasks -representing the different analysis stages are performed on the IPP -computer cluster. Note the distinction between the generic analysis -{\em stage} and a specific analysis {\em task}. An analysis stage -represents a type of analysis which is performed, such as the basic -image calibration and object detection analysis. An analysis task is -a particular realization of an analysis stage, e.g., the analysis of -OTA number 61 from exposure 654321 to produce a specific set of output -data products. The analysis stages are discussed in detail in -Section~\ref{sec:AnalysisStages}. +\subsection{Analysis Stages, Programs, and Libraries} + +The processing steps listed above can be divided into well-defined +analysis stages, each of which operates on a particular unit of data, +such as a single OTA image or a collection of astronomical objects. +The different analysis stages defined by the IPP are discussed in +Sections~\ref{sec:AnalysisStages} - \ref{sec:MiscStages}. The +analysis defined by these analysis stages is further divided into +specific programs which perform the particular operation. Some +analysis stages are primarily defined by a single programs; others +require multiple programs and substages. It is also possible for a +single program to be involved in multiple analysis stages. The major +IPP analysis programs are discussed in some detail in +Section~\ref{sec:AnalysisPrograms}. Other important programs in the +collection called \code{ippTools} are used to define the analysis +stages and their interrelationships (Section~\ref{sec:ipptools}). The +IPP software hierarchy is further divided into \code{psModules} +(representing complex analysis operations, often astronomical in +nature) and \code{psLib}, the data and analysis foundation library +(Section~\ref{sec:SoftwareHierarchy}). + +Analysis tasks representing the different analysis stages are +performed on the IPP computer cluster. Note the distinction between +the generic analysis {\em stage} and a specific analysis {\em task}. +An analysis stage represents a type of analysis which is performed, +such as the basic image calibration and object detection analysis. An +analysis task is a particular realization of an analysis stage, e.g., +the analysis of OTA number 61 from exposure 654321 to produce a +specific set of output data products. The analysis stages are +discussed in detail in Section~\ref{sec:AnalysisStages}. A particular stage may process individual images, collections of @@ -507,5 +511,5 @@ monitor the age of images and delete them on some schedule. This functionality currently resides in the IPP Scheduler -(Section~\ref{sec:scheduler}). +(Section~\ref{sec:pantasks}). As shown in Figure~\ref{fig:Nebulous}, Nebulous consists of the @@ -521,6 +525,6 @@ \begin{center} \resizebox{4.5in}{!}{\includegraphics{pics/ImageServer}} -\caption{The components of the IPP Image Server.} -\label{fig:ImageServer} +\caption{The components of Nebulous, the IPP Image/File Server.} +\label{fig:Nebulous} \end{center} \end{figure} @@ -1106,5 +1110,5 @@ detection data, the {\tt Regions} table allows for multiple computers to serve the database tables. The region file specifies the machine -which stores the specific table. Figure~\ref{fig:APDBRegions} +which stores the specific table. Figure~\ref{fig:DVOskyregions} illustrates schematically the subdivision of the sky and the association between different levels of the hierarchy with different @@ -1582,4 +1586,5 @@ \subsection{PanTasks : the IPP Scheduler} +\label{sec:pantasks} PanTasks is the IPP tool which manages the sequencing of data analysis @@ -2148,5 +2153,5 @@ \begin{center} \includegraphics[scale=0.85,angle=-90]{pics/pantasks.05.ps} -\caption{\label{queues} pcontrol job states. Transitions labeled Ux +\caption{\label{JobStates} pcontrol job states. Transitions labeled Ux are issued by the pcontrol user (including PanTasks). Transitions labeled Px are initiated by pcontrol. Transitions labeled Tx are @@ -2250,5 +2255,5 @@ \begin{center} \includegraphics[scale=0.85,angle=-90]{pics/pantasks.07.ps} -\caption{\label{queues} PanTasks queues and MDDB tables} +\caption{\label{Pclient} Pclient monitor loop.} \end{center} \end{figure} @@ -3126,5 +3131,6 @@ %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -\section{System Design : Miscellaneous Tasks} +\section{System Design : Miscellaneous Analysis Stages} +\label{sec:MiscStages} This section discusses additional operations which are performed by @@ -3171,4 +3177,5 @@ \section{Software Hierarchy} +\label{sec:SoftwareHierarchy} In order to facilitate testing and development, and to encourage @@ -3229,6 +3236,4 @@ \subsection{IPP Analysis Programs} -\tbd{clean this up} - The major IPP processing tasks are organized into stages, which consist of multiple modules. Each stage represents a collection of @@ -3240,5 +3245,6 @@ images from multiple telescopes and search for transients). -\section{Top-Level IPP Analysis Routines} +\section{Top-Level IPP Analysis Programs} +\label{sec:AnalysisPrograms} The IPP uses a handful of high-level analysis routines which perform @@ -3904,4 +3910,5 @@ \section{IPPTools} +\label{sec:ipptools} PanTasks is the IPP tool which manages the sequencing of data analysis @@ -5401,5 +5408,5 @@ \section{AP Database Table Contents} -\label{sec:APDBTableContents} +\label{sec:DVOTableContents} \begin{table}[bh] @@ -5700,5 +5707,5 @@ \begin{table}[bh] \begin{center} -\caption{Database Hosts\label{tab:APDBHosts}} +\caption{Database Hosts\label{tab:DVOHosts}} \begin{tabular}{lll} \hline Index: /trunk/doc/dvo/dvo.tex =================================================================== --- /trunk/doc/dvo/dvo.tex (revision 6433) +++ /trunk/doc/dvo/dvo.tex (revision 6434) @@ -1,14 +1,14 @@ \documentclass[panstarrs,spec]{panstarrs} -\title{DVO : the Desktop Virtual Observatory} -\subtitle{Astronomical Object Databasing in the IPP} +\title{DVO Software Design Description} +\subtitle{The Desktop Virtual Observatory: \\ Astronomical Object Databasing in the IPP} \author{Eugene Magnier} \audience{IPP} -\shorttitle{PanTasks for IPP} +\shorttitle{DVO SDD} \group{Pan-STARRS IPP} \project{Pan-STARRS IPP} \organization{Institute for Astronomy} \version{DR} -\docnumber{PSDC-xxx-xxx} +\docnumber{PSDC-430-016} \begin{document} @@ -1029,4 +1029,5 @@ dvo: style -pt 7; cat -all -m 12 18 -g \end{verbatim} +%$ \section{other user tools} Index: /trunk/doc/ipptools/ipptools.tex =================================================================== --- /trunk/doc/ipptools/ipptools.tex (revision 6433) +++ /trunk/doc/ipptools/ipptools.tex (revision 6434) @@ -1,14 +1,14 @@ \documentclass[panstarrs,spec]{panstarrs} -\title{IPPTools, PanTasks \& the IPP Analysis Stages} -\subtitle{Job Relationships and Data Flow} +\title{IPPTools Software Design Description} +\subtitle{The IPP Analysis Stages: \\ Job Relationships, Database Tables, and Data Flow} \author{Eugene Magnier} \audience{IPP} -\shorttitle{PanTasks for IPP} +\shorttitle{IPPTools SDD} \group{Pan-STARRS IPP} \project{Pan-STARRS IPP} \organization{Institute for Astronomy} \version{DR} -\docnumber{PSDC-xxx-xxx} +\docnumber{PSDC-430-019} \begin{document} @@ -928,4 +928,6 @@ particularly true of the \code{submit.Px} type of commands. +\tbd{this section should be reconciled with the section in the SSDD which takes precedence} + \begin{verbatim} Index: /trunk/doc/modules/ChangeLogSDRS.tex =================================================================== --- /trunk/doc/modules/ChangeLogSDRS.tex (revision 6433) +++ /trunk/doc/modules/ChangeLogSDRS.tex (revision 6434) @@ -1,3 +1,3 @@ -%%% $Id: ChangeLogSDRS.tex,v 1.42 2006-01-22 10:45:30 eugene Exp $ +%%% $Id: ChangeLogSDRS.tex,v 1.43 2006-02-16 18:57:51 eugene Exp $ \subsection{Changes from version 00 (16 August 2004) to version 01 (12 October 2004)} @@ -189,5 +189,10 @@ \item modification of bias subtraction API \item updates to object/psphot APIs - \end{itemize} +\subsection{Changes from version 11 (22 Jan 2006) to present} + +\begin{itemize} +\item clarified pmFindImagePeaks to use parent coordinates +\end{itemize} + Index: /trunk/doc/modules/ModulesSDRS.tex =================================================================== --- /trunk/doc/modules/ModulesSDRS.tex (revision 6433) +++ /trunk/doc/modules/ModulesSDRS.tex (revision 6434) @@ -1,3 +1,3 @@ -%%% $Id: ModulesSDRS.tex,v 1.74 2006-02-11 03:16:55 price Exp $ +%%% $Id: ModulesSDRS.tex,v 1.75 2006-02-16 18:57:51 eugene Exp $ \documentclass[panstarrs,spec]{panstarrs} @@ -2405,5 +2405,9 @@ making flat-topped regions have single peaks at the (+x,+y) corner. When selecting the peaks, their type must also be set. The result of -this function is an array of \code{pmPeak} entries. +this function is an array of \code{pmPeak} entries. The resulting set +of peaks should be considered a starting point, not an unambiguous +sample of the only real peaks. If the input image is a subimage, the +output peak coordinates should be in the {\em parent} coordinate +frame. \begin{prototype} @@ -2433,11 +2437,11 @@ The first form defines \code{psImage} subarrays (pixel, weight, and mask) for the source located at coordinates \code{x,y} on the image -set defined by \code{readout}. The pixels defined by this operation -consist of a square window (of full width $2 Radius + 1$) centered on -the pixel which contains the given coordinate, in the frame of the -readout. The window is defined to have limits which are valid within -the boundary of the \code{readout} image, thus if the radius would -fall outside the image pixels, the subimage is truncated to only -consist of valid pixels. If \code{readout->mask} or +set defined by \code{readout} (in parent coords). The pixels defined +by this operation consist of a square window (of full width $2 Radius ++ 1$) centered on the pixel which contains the given coordinate, in +the frame of the readout. The window is defined to have limits which +are valid within the boundary of the \code{readout} image, thus if the +radius would fall outside the image pixels, the subimage is truncated +to only consist of valid pixels. If \code{readout->mask} or \code{readout->weight} are not \code{NULL}, matching subimages are defined for those images as well. This function fails if no valid Index: /trunk/doc/pantasks/pantasks.tex =================================================================== --- /trunk/doc/pantasks/pantasks.tex (revision 6433) +++ /trunk/doc/pantasks/pantasks.tex (revision 6434) @@ -1,14 +1,14 @@ \documentclass[panstarrs,spec]{panstarrs} -\title{PanTasks} -\subtitle{the IPP Scheduler and Controller system} +\title{PanTasks Software Design Description} +\subtitle{The IPP Scheduler and Controller system} \author{Eugene Magnier} \audience{IPP} -\shorttitle{PanTasks} +\shorttitle{PanTasks SDD} \group{Pan-STARRS IPP} \project{Pan-STARRS IPP} \organization{Institute for Astronomy} \version{DR} -\docnumber{PSDC-xxx-xxx} +\docnumber{PSDC-430-017} \begin{document} Index: /trunk/doc/pslib/ChangeLogSDRS.tex =================================================================== --- /trunk/doc/pslib/ChangeLogSDRS.tex (revision 6433) +++ /trunk/doc/pslib/ChangeLogSDRS.tex (revision 6434) @@ -1,3 +1,3 @@ -%%% $Id: ChangeLogSDRS.tex,v 1.193 2006-02-08 03:26:01 jhoblitt Exp $ +%%% $Id: ChangeLogSDRS.tex,v 1.194 2006-02-16 18:57:51 eugene Exp $ \subsection{Changes from version 00 to version 01} @@ -842,4 +842,12 @@ \item convert \code{complex} declarations to be explicitly \code{double complex} \item change \code{psFitsReadTable()}'s \code{fits} param to be \code{const} +\item changes to make image, subimage, and region consistent: +\begin{itemize} +\item all region operations refer to the parent image coordinates +\item all functions which take a psImage and some coordinate refer to the parent coordinate frame +\item psRegionForImage : changed definition of region to refer to parent coords +\item psImageCountPixelMask : changed definition of region to refer to parent coords +\item psImageSubset : specified definition of region to refer to parent coords +\end{itemize} \item Added S8,S16,U8,U16,U32 to \code{psDataType} (bug 579). \item \code{psVector.n} and \code{psArray.n} to be initially set to zero Index: /trunk/doc/pslib/psLibSDRS.tex =================================================================== --- /trunk/doc/pslib/psLibSDRS.tex (revision 6433) +++ /trunk/doc/pslib/psLibSDRS.tex (revision 6434) @@ -1,3 +1,3 @@ -%%% $Id: psLibSDRS.tex,v 1.382 2006-02-08 03:26:01 jhoblitt Exp $ +%%% $Id: psLibSDRS.tex,v 1.383 2006-02-16 18:57:51 eugene Exp $ \documentclass[panstarrs,spec]{panstarrs} @@ -3690,5 +3690,17 @@ limits. The output of this function is always a valid region, though it may define an area of 0 pixels. If \code{image} is a subimage, the -region coordinates refer to the subimage pixel coordinates. +input and output region coordinates refer to the parent pixel +coordinates. The only exception to this statement is that the +negative limits should be applied to the upper limits of the subimage, +not the parent. Thus, if we have an input subimage with +\code{col0,row0} of (10,20), and \code{numCols,numRows} of 1000,1000 +(implying parent image dimensions of at least 1010,1020), we would +have the following conversions: +\begin{verbatim} +(50:100,50:100) -> (50:100,50:100) : no change (region within image) +(0:0,0:0) -> (10:1010,20:1020) : upper and lower limits constrained +(5:-5,5:-5) -> (10:1005,20:1015) +(5:1020,5:1020) -> (10:1010,20:1020) +\end{verbatim} \begin{prototype} @@ -5083,4 +5095,6 @@ \subsubsection{Image Structure Manipulation} +\tbd{clarify that subset and trim regions are in the *parent* coords} + \begin{prototype} psImage *psImageSubset(psImage *image, psRegion region); @@ -5095,9 +5109,12 @@ In the event that \code{x1} or \code{y1} are negative, they shall be interpreted as being relative to the size of the parent image in that -dimension. The entire subraster must be contained within the raster -of the parent image. Note that the \code{refCounter} for the parent -should be incremented. 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}. +dimension. If the input image is a subimage, the region coordinates +refer to the \em{parent} pixel coordinates. The entire subraster must +be contained within the raster of the parent image. Note that the +\code{refCounter} for the parent should be incremented. 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}. \tbd{allow this function to saturate on the edges like +psRegionForImage?} \begin{prototype} @@ -5132,4 +5149,6 @@ \subsubsection{Image Pixel Extractions} + +\tbd{clarify that subset and trim regions are in the *parent* coords} \begin{datatype} @@ -5418,5 +5437,5 @@ region) results in a return value of -1. The \code{region} refers to the pixels of the \code{mask}; if \code{mask} is a subimage, the -region must be defined relative to those subimage pixels. +region must be defined relative to the parent pixel coordinate. \begin{prototype} Index: /trunk/doc/psphot/psphot.tex =================================================================== --- /trunk/doc/psphot/psphot.tex (revision 6433) +++ /trunk/doc/psphot/psphot.tex (revision 6434) @@ -1,14 +1,14 @@ \documentclass[panstarrs,spec]{panstarrs} -\title{PSPhot} % put in your title +\title{PSPhot Sofware Design Description} % put in your title \subtitle{The Pan-STARRS IPP Object Photometry Tool} \author{Eugene Magnier} \audience{IPP} -\shorttitle{PSPhot} +\shorttitle{PSPhot SDD} \group{Pan-STARRS IPP} \project{Pan-STARRS IPP} \organization{Institute for Astronomy} \version{DR} -\docnumber{PSDC-xxx-xxx} +\docnumber{PSDC-430-021} \newcommand\ugriz{$u^\prime g^\prime r^\prime i^\prime z^\prime$}