Changeset 25117
- Timestamp:
- Aug 18, 2009, 2:23:03 PM (17 years ago)
- File:
-
- 1 edited
-
trunk/doc/stamps/stampsICD.tex (modified) (14 diffs)
Legend:
- Unmodified
- Added
- Removed
-
trunk/doc/stamps/stampsICD.tex
r18745 r25117 76 76 \end{table} 77 77 78 The IPP will be configured to periodic ly query a set of Data Stores for new request file sets.79 We will refer to each Data Store as a \emph{request or}.80 Each request table submitted by a given requstor must have a unique value for81 the keyword \code{REQ_NAME}.This value is used for the name of the request's output file set.78 The IPP will be configured to periodically query a set of Data Stores for new request file sets. 79 We will refer to each Data Store as a \emph{requester}. 80 Each request table submitted must have a unique value for the keyword \code{REQ_NAME}. 81 This value is used for the name of the request's output file set. 82 82 83 83 The postage stamp server supports three types of "postage stamp" job specified by the value 84 84 the column \code{JOB_TYPE}. If the value is \emph{stamp} postage stamp images will be extracted 85 85 from the images of interest. If the value of \code{JOB_TYPE} is \emph{get\_image} a copy 86 of the selected image(s) with (satel ite streaks removed) will be placed on the output file set.86 of the selected image(s) with (satellite streaks removed) will be placed on the output file set. 87 87 Finally if the \code{JOB_TYPE} is \emph{list} the results file will list the input selected images 88 88 but no postage stamps will be made. … … 100 100 \code{JOB_TYPE} & string & stamp or get\_image & \\ 101 101 \\ 102 \code{STAMP_NAME} & string & letters, numbers, '.', '\-' and '\_' & \\ 103 \code{OPTION_MASK} & U32 & \code{[0-5]} see text & \\ 104 \\ 105 \code{REQ_TYPE} & string & bycoord, byexp, or byid & \\ 102 \code{OPTION_MASK} & U32 & see text & \\ 103 \\ 104 \code{REQ_TYPE} & string & bycoord, byexp, byid, bydiff, or byskycell & \\ 106 105 \code{IMG_TYPE} & string & raw, chip, warp, diff, or stack & \\ 107 \code{ID} & string & depends on project and REQ\_TYPE& \\ 108 \code{CLASS_ID} & string & see text & not null for byid raw \& byexp raw \\ 106 \code{ID} & string & depends on REQ\_TYPE& \\ 107 \code{TESS_ID} & string & see text & \\ 108 \code{COMPONENT} & string & see text & \\ 109 109 \\ 110 110 \code{COORD_MASK} & U32 & \code{[0-3]} see text & not null if \code{JOB_TYPE} = stamp \\ … … 130 130 \subsubsection{Request Types} 131 131 The method used to select the images of interest is determined by the value of the REQ\_TYPE column. 132 There are three all lowed values.132 There are three allowed values. 133 133 134 134 \begin{itemize} 135 135 136 \item{\textbf{bycoord}} The center of the region of interest is specif ed in celestial coordinates.136 \item{\textbf{bycoord}} The center of the region of interest is specified in celestial coordinates. 137 137 Images are selected by querying the project's DVO database for images with the provided 138 138 IMG\_TYPE that contain the center. 139 139 The set of images of interest may be limited by specifying certain criteria as described 140 in Section \ref{ImageFilters}. 140 in Section \ref{ImageFilters}. NOTE: this request type is not yet implemented. 141 141 142 142 \item{\textbf{byexp}} The image of interest is the image resulting from a particular exposure … … 146 146 The ID parameter refers to IPP image database key that corresponds to the IMG\_TYPE. 147 147 e.g: either exp\_id, chip\_id, warp\_id, diff\_id, or stack\_id. 148 149 \item{\textbf{bydiff}} The image with given IMG\_TYPE corresponding to the difference image 150 whose IMAGEID is equal to ID. This type is useful for requesting stamps based on difference detections. 151 152 \item{\textbf{byskycell}} Images are selected from the skycell with skycell\_id equal to the 153 value for COMPONENT from the tessellation identified by TESS\_ID. This request type may be 154 used only with IMG\_TYPE warp, stack, and diff. 155 The set of images may be limited by filter and date as described in Section \ref{ImageFilters}. 156 NOTE: this request type is not yet implemented. 157 148 158 \end{itemize} 149 159 150 C LASS\_IDmust also be supplied for request specifications where all of the following are true160 COMPONENT must also be supplied for request specifications where all of the following are true 151 161 152 162 \begin{itemize} … … 158 168 \item REQ\_TYPE=byexp or REQ\_TYPE=byid 159 169 160 \item IMG\_TYPE=chip or IMG\_TYPE=raw161 162 170 \end{itemize} 163 171 172 The special value 'all' may be used to select all component images but this is not recommended. 164 173 165 174 \subsubsection{Image Selection Filters}\label{ImageFilters} … … 169 178 170 179 The REQFILT parameter may be used to restrict the search for images taken with a given filter. 171 XXX: What is the namespace for filter names. For example Megacam has filter names like U.9301 which 172 IPP maps to u. Which name do we allow? Probably should used the mapped names g r i etc. 180 XXX: What is the name space for filter names. For example Megacam has filter names like U.9301 which 181 IPP maps to u. Which name do we allow? Perhaps use a LIKE query. 182 173 183 174 184 \subsection{The Region of Interest} … … 177 187 a center, width, and height. 178 188 179 The center is defined by the columns CENTER\_X and CENTER\_Y and the dimen ions of the rectangle are189 The center is defined by the columns CENTER\_X and CENTER\_Y and the dimensions of the rectangle are 180 190 the values of WIDTH and HEIGHT. The two least signficant bits in value for the column COORD\_MASK 181 191 determine the type for the coordinates … … 189 199 {\bf COORD\_MASK value} & {\bf Description } \\ 190 200 \hline 191 0 & center in RA/DEC; width \& height in arc seconds\\192 1 & center in pixel coordinates; width and height in arc seconds\\201 0 & center in RA/DEC; width \& height in arc seconds\\ 202 1 & center in pixel coordinates; width and height in arc seconds\\ 193 203 2 & center in RA/DEC; width and height in pixels\\ 194 204 3 & center x/y, width, and height in pixel coordinates\\ … … 198 208 \end{table} 199 209 200 Another way to describe this is that COORD\_MASK is two bit mask that bit mask that210 Another way to describe this is that COORD\_MASK is two bit mask that bit mask that 201 211 determines the format of the ROI values. In the C language: 202 212 … … 212 222 213 223 When pixel coordinates are used the coordinate system is that of the image. (For chip level images, before 214 the stamps are created the cells are mosaic ed into a single image.)224 the stamps are created the cells are mosaicked into a single image.) 215 225 216 226 Any fractional parts in pixel coordinate values are ignored. 217 227 218 The value of \code{OPTION _MASK} is used to select various other options. It is a bitwise or of the following228 The value of \code{OPTION\_MASK} is used to select various other options. It is a bitwise or of the following 219 229 values. 220 230 … … 229 239 1 & create postage stamp of the image pixels \\ 230 240 2 & create postage stamp of the mask pixels \\ 231 4 & create postage stamp of the weight pixels \\ 232 8 & convert WCS to approximate linear transformation in the stamp images\\ 233 \hline 234 \end{tabular} 235 \end{center} 236 \end{table} 241 4 & create postage stamp of the variance pixels \\ 242 1024 & select images based on inverse difference images \\ 243 \hline 244 \end{tabular} 245 \end{center} 246 \end{table} 247 248 Note that bit zero is currently ignored. A stamp of the image pixels is always included. 249 250 For requests with IMG\_TYPE diff or if \code{REQ_TYPE} is bydiff \code{if (OPTION_MASK & 1024)} and 251 the corresponding difference run is a warp versus warp diff (bothways) the images 252 are selected based on the 'inverse' difference images. If this bit is zero the 'positive' 253 images are selected; 237 254 238 255 … … 293 310 \code{REQ_TYPE} & string & \\ 294 311 \code{IMG_TYPE} & string & \\ 295 \code{CLASS_ID} & string & \\ 312 \code{TESS_ID} & string & \\ 313 \code{COMPONENT} & string & \\ 296 314 \\ 297 315 \code{COORD_MASK} & U32 & \\ … … 317 335 IMG\_NAME give the name of the image in the Data Store file set. 318 336 319 If no STAMP\_NAME is provided in the request specifiction the image file names will be in the form 320 \code{ROWNUM_I.fits} where I is an integer that ranges from 1 to the number of jobs that the request 321 specification generated. Mask images will be named \code{ROWNUM_I.mk.fits} and weight images will 337 The image file names will be in the form \code{ROWNUM_I.fits} where I is an integer that ranges from 1 338 to the number of jobs generated for the row's request 339 specification. 340 341 Mask images will be named \code{ROWNUM_I.mk.fits} and variance images will 322 342 have the name \code{ROWNUM_I.mk.fits} 323 343 324 If STAMP\_NAME is provided in the resquest specification, the name of the image, mask, and weight files 325 will be 326 \begin{itemize} 327 \item\code{ROWNUM_I_STAMP_NAME.fits} 328 \item\code{ROWNUM_I_STAMP_NAME.mk.fits}, 329 \item\code{ROWNUM_I_STAMP_NAME.wt.fits} 330 \end{itemize} 331 332 JOB\_ID is the value of the postage stamp server's internal job id. This is provided primarily as a debugging 333 aid. 344 JOB\_ID is the value of the postage stamp server's internal job id. (This is provided primarily as a debugging 345 aid.) 334 346 335 347 The column named PROJECT and following columns are copies from the input request specification. 336 348 337 If ERROR\_CODE is non-zero one or more errors occured processing the request specification.338 The value of ERROR\_CODE is a bitwise or of the values given in thetable\ref{Rerrorcodes}.349 If ERROR\_CODE is non-zero an error occurred when processing the request specification or the job. 350 The values for ERROR\_CODE are listed in table\ref{Rerrorcodes}. 339 351 340 352 … … 348 360 {\bf Name} & {\bf ERROR\_CODE value} & {\bf Description } \\ 349 361 \hline 350 NO\_ERROR & 0 & \\ 351 NO\_MATCHING\_IMAGE & 1 & No image matches the request specification \\ 352 RA\_DEC\_NOT\_ON\_PIXEL & 2 & The central RA, DEC are on a blind area (for example a inter-chip gap) \\ 353 RA\_DEC\_NOT\_IN\_FOV & 4 & Wrong position on sky for given MJD \\ 354 NO\_IMAGE\_FOR\_FILTER & 8 & Image is not in the filter requested \\ 355 NOT\_AVAILABLE\_PERM & 16 & Image matched but is permanantly unavailable\\ 356 NOT\_AVAILABLE\_TEMP & 32 & Image matched but is currently unaccessible\\ 357 INVALID\_REQUEST & 64 & request specification was invalid \\ 358 SYSTEM\_ERROR & 128 & system error \\ 359 \hline 360 \end{tabular} 361 \end{center} 362 \end{table} 363 364 In the case of an error parsing the request table a file containing a textual description of the errror 365 may be added to the resulting file set. 362 PSTAMP\_SUCCESS & 0 & No errors \\ 363 PSTAMP\_SYSTEM\_ERROR & 10 & some unspecified system error occurred during processing\\ 364 PSTAMP\_NOT\_IMPLEMENTED & 11 & Feature not yet implemented \\ 365 PSTAMP\_UNKNOWN\_ERROR & 12 & Unknown error \\ 366 PSTAMP\_DUP\_REQUEST & 20 & Request name is a duplicate \\ 367 PSTAMP\_INVALID\_REQUEST & 21 & Error in a request specification. See parse\_error.txt \\ 368 PSTAMP\_UNKNOWN\_PRODUCT & 22 & Unknown product in request specification \\ 369 PSTAMP\_NO\_IMAGE\_MATCH & 23 & No images matched the request \\ 370 PSTAMP\_NOT\_DESTREAKED & 24 & Image matched, but not yet de-streaked \\ 371 PSTAMP\_NOT\_AVAILABLE & 25 & Image not available (temporary) \\ 372 PSTAMP\_GONE & 26 & Image is no longer available \\ 373 PSTAMP\_NO\_JOBS\_QUEUED & 27 & Request specification yielded no jobs. See parse\_error.txt \\ 374 375 \hline 376 \end{tabular} 377 \end{center} 378 \end{table} 379 380 If parsing of the request specification file results in error output, the contents will be placed 381 in the file 'parse\_error.txt' in the resulting file set. 366 382 367 383 \end{document}
Note:
See TracChangeset
for help on using the changeset viewer.
