IPP Software Navigation Tools IPP Links Communication Pan-STARRS Links

Ignore:
Timestamp:
May 2, 2013, 5:10:46 PM (13 years ago)
Author:
bills
Message:

Updates for postage stamp request format Version 2

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/doc/stamps/stampsICD.tex

    r33884 r35495  
    99\project{Pan-STARRS IPP}
    1010\organization{Institute for Astronomy}
    11 \version{1.0}
     11\version{2.0}
    1212\docnumber{PSDC-940-011-00}
    1313
    … …  
    4848one or more FITS binary tables called \emph{request tables}.
    4949Each row in a request table contains a postage stamp request specification.
    50 Each request specification causes zero or more postage stamp jobs to be processed.
     50Each request specification causes zero or more postage stamp jobs to be created.
    5151Images are added to the output file set for each successful job.
    5252
    5353The request specification give the parameters that the PSS uses to determine the images of interest
    5454and the Region of Interest.
     55
     56Note: The value "null" for strings or 0 for numbers may be used to disable the application of
     57certain parameters.
    5558
    5659\subsection{Request Table Contents}
    … …  
    6972\hline
    7073\code{EXTNAME}  & string     & \code{PS1_PS_REQUEST} \\
    71 \code{EXTVER}   & string     & 1  \\
     74\code{EXTVER}   & string     & 2  \\
    7275\code{REQ_NAME} & string     & unique name of the request (see text) \\
     76\code{ACTION}   & string     & PROCESS \\
     77\code{EMAIL}    & string     & Email address of submitting user\\
    7378\hline
    7479\end{tabular}
    … …  
    8186This value is used for the name of the request's output file set.
    8287
    83 The postage stamp server supports three types of "postage stamp" job specified by the value
     88
     89The postage stamp server supports two types of "postage stamp" job specified by the value
    8490the column \code{JOB_TYPE}. If the value is \emph{stamp} postage stamp images will be extracted
    8591from the images of interest.  If the value of \code{JOB_TYPE} is \emph{get\_image}
    86 the data from the selected images' "runs"  with (satellite streaks removed) are bundled
    87 in and placed on the output file set.
     92the data from the selected images' "runs" are bundled in the format used by the IPP distribution system
     93and are placed on the output file set.
    8894
    8995\begin{table}[h]
    … …  
    97103\code{ROWNUM}   & U32       &                           &        must be unique in file\\
    98104\code{PROJECT}  & string    & gpc1                      &        \\
     105\code{SURVEY_NAME}  & string    & PS1 survey names      & see table 3        \\
     106\code{IPP_RELEASE}  & string    & IPP release name      & e.g. 3PI.PV1, 3PI.nightly \\
    99107\code{JOB_TYPE} & string    & stamp or get\_image       &        \\
    100108\\
    … …  
    117125\code{MJD_MIN}  &   F64     & Modified Julian Day       & \\
    118126\code{MJD_MAX}  &   F64     &                           & \\
    119 \\
    120 \code{COMMENT}  &   string  & copied to the results flie & \\
     127\code{RUN_TYPE}  &  string  & stack or diff type        & deep, reference, nightly, warp-stack, etc.\\
     128\code{FWHM_MIN}  &   F64    & minimum measured seeing (pixels) & \\
     129\code{FWHM_MAX}  &   F64    & maximum measured seeing (pixels) & \\
     130\\
     131\code{COMMENT}  &   string  & copied to the results file & \\
    121132\hline
    122133\end{tabular}
    … …  
    159170\end{itemize}
    160171
    161 Note that at this time the REQ\_TYPE byexp is not implemented for IMG\_TYPE stack.
     172Note that REQ\_TYPE byexp is not implemented for IMG\_TYPE stack.
    162173
    163174COMPONENT must also be supplied for request specifications where all of the following are true
    … …  
    173184\end{itemize}
    174185
    175 The special value 'all' may be used to select all component images but this is not recommended.
     186The special value "all" may be used to select all component components (chips or skycells) of a run.
     187
    176188
    177189\subsubsection{Image Selection Cuts}\label{ImageCuts}
    178190
    179 A request specification may refer to many images. The scope of the search can be
    180 limited to certain dates with the parameters MJD\_MIN and MJD\_MAX. The specified range is inclusive.
    181 Note: these cuts have no effect for stack stage requests.
     191A request specification may refer to many images. The scope of the search can be reduced by providing
     192the selection parameters.
     193
     194SURVEY\_NAME (new in version 2) restricts the queries to images for a given PS1 survey. Valid values are
     195shown in the table below. The value "null" may also be used.
     196
     197\begin{table}[h]
     198\begin{center}
     199\caption{PS1 SURVEYNAME Values}\label{surveys}
     200\begin{tabular}{ll}
     201\hline
     202\hline
     203{\bf SURVEY\_NAME} &  {\bf Description } \\
     204\hline
     2053PI  & PS1 3PI Survey \\
     206MD01 & PS1 MD01 XMM-LSS-DXS 022224-043000 \\
     207MD02 & PS1 MD02 CDFS/GOODS/GEMS 033224-274800 \\
     208MD03 & PS1 MD03 IFA/Lynx 084300+444000 \\
     209MD04 & PS1 MD04 COSMOS 100000+021200 \\
     210MD05 & PS1 MD05 Lockman-DXS 110000+570000 \\
     211MD06 & PS1 MD06 NGC 4258 121857+471814 \\
     212MD07 & PS1 MD07 VISTA-Video1 140000+050000 \\
     213MD08 & PS1 MD08 EliasN1-DXS 160000+570000 \\
     214MD09 & PS1 MD09 Vimos4-DXS-SSA 220000+003000 \\
     215MD10 & PS1 MD10 Deep2 233000+000000 \\
     216M31  & PS1 M31 Andromeda 004242+411600 \\
     217STS1 & PS1 STS1 Outskirts of Bulge 195048+170339 \\
     218STS2 & PS1 STS2 Hyades 004000+150000 \\
     219STS3 & PS1 STS3 Praesepe 083000+200000 \\
     220SSS  & PS1 Solar System Survey \\
     221\hline
     222\end{tabular}
     223\end{center}
     224\end{table}
     225
     226IPP\_RELEASE (new in version 2) restricts the search for data from a particular "release" of IPP data.
     227If "null" the system choses data from the highest priority release ("best") of the given exposure or skycell.
    182228
    183229DATA\_GROUP restricts the search to runs with the given value. Note that the SQL database lookups
    184 are done with a "LIKE" comparison so SQL wild cards may be used.
     230are done with a "LIKE" comparison so SQL wild cards may be used. With Version 2 of this specification
     231use of DATA\_GROUP is deprecated. It is ignored if a non null value for SURVEY\_NAME or IPP\_RELEASE is
     232supplied.
     233
     234Searches may be limited to certain dates with the parameters MJD\_MIN and MJD\_MAX. The specified range is inclusive.
     235Note: For stack stage requests, these cuts will have no effect on queries for deep or reference stacks.
    185236
    186237The REQFILT parameter may be used to restrict the search for images taken with a given filter.
    187 If the filter is a single character (g, r, i, z, y) the server appends a '\%' character to the
    188 sql query.
     238If the filter is a single character (g, r, i, z, y, w) the server appends a '\%' character to the
     239sql query. If "null" data from all filters is queried.
     240
     241The optional parameter RUN\_TYPE is used for specify the type of stack or difference images to consider as
     242images of interest.
     243
     244For difference images valid values are warp\_warp warp\_stack and stack\_stack.
     245
     246For stacks valid values are "deep", "reference", "nightly", and "notnightly". For stacks, this selector
     247is only applied if SURVEY\_NAME or IPP\_RELEASE is supplied.
     248
    189249
    190250
    … …  
    230290When pixel coordinates are used the coordinate system is that of the image. (For chip level images, before
    231291the stamps are created the cells are mosaicked into a single image.)
     292
     293Note: If the width and height are both equal to zero, the entire input image is included in the stamp. Otherwise
     294values less than or equal to zero will generate an error.
    232295
    233296\subsection{Request Options}
    … …  
    252315PSTAMP\_SELECT\_INVERSE   &    1024  &   make stamps from inverse difference images (applies only for diff) \\
    253316PSTAMP\_SELECT\_UNCONV    &    2048  &   make stamps from unconvolved stack images (applies only for stack) \\
    254 PSTAMP\_RESTORE\_BACKGROUND &  4096  &   (TODO) restore background correction to chip stage images before making stamp \\
     317PSTAMP\_RESTORE\_BACKGROUND &  4096  &   restore background correction to chip stage images before making stamp \\
    255318PSTAMP\_USE\_IMFILE\_ID   &   16384  &   for byid requests select images using image id instead of stage id \\
    256319PSTAMP\_NO\_WAIT\_FOR\_UPDATE &  32768  &   if images are not available because they have been cleaned don't wait \\
    … …  
    299362the pixels for requested images, if possible. This is referred to as the update process.
    300363If the user does not wish to wait for the updates to complete he should include
    301 \code{PSTAMP_NO_WAIT_FOR_UPDATE} in the \code{OPTION_MASK}.
     364\code{PSTAMP_NO_WAIT_FOR_UPDATE} in the \code{OPTION_MASK}. In this case the row will receive the error
     365code PSTAMP\_NOT\_AVAIALABLE.
    302366
    303367
    … …  
    353417\code{EXPTIME}      & F64       &  exposure time of parent image \\
    354418\code{FPA_ID}       & string    &  orginal FPA\_ID used at injection \\
    355 \\
    356 \code{PROJECT}  & string    & Values from initial request specification\\
     419\hline
     420& Values from corresponding row in the request file\\
     421\hline
     422\code{PROJECT}  & string    & \\
     423\code{SURVEY_NAME}  & string    & \\
     424\code{IPP_RELEASE}  & string    & \\
    357425\code{JOB_TYPE} & string    & \\
    358426\\
    … …  
    372440\code{MJD_MAX}  &   F64     & \\
    373441\code{DATA_GROUP}  &   string     & \\
     442\code{RUN_TYPE}  &   string     & \\
     443\code{FWHM_MIN}  &   F64     & \\
     444\code{FWHM_MAX}  &   F64     & \\
    374445\code{COMMENT}  &   string     & \\
    375446\\
    … …  
    393464have the name \code{ROWNUM_I.mk.fits}
    394465
    395 JOB\_ID is the value of the postage stamp server's internal job id. (This is provided primarily as a debugging
     466JOB\_ID is the value of the postage stamp server's internal job id.
    396467aid.)
    397468
    398 The column named PROJECT and following columns are copies from the input request specification.
     469The column named PROJECT and following columns are copied from the input request specification.
    399470
    400471If ERROR\_CODE is non-zero an error occurred when processing the request specification or the job.
    … …  
    419490PSTAMP\_UNKNOWN\_PRODUCT  & 22 &    Unknown product in request specification \\
    420491PSTAMP\_NO\_IMAGE\_MATCH  & 23 &    No images matched the request \\
    421 PSTAMP\_NOT\_DESTREAKED   & 24 &    Image matched, but not yet de-streaked \\
     492PSTAMP\_NOT\_DESTREAKED   & 24 &    Obsolete - No longer used\\
    422493PSTAMP\_NOT\_AVAILABLE    & 25 &    Image not available (temporary) \\
    423494PSTAMP\_GONE              & 26 &    Image is no longer available \\
    424495PSTAMP\_NO\_JOBS\_QUEUED  & 27 &    Request specification yielded no jobs. See parse\_error.txt \\
    425496PSTAMP\_NO\_OVERLAP       & 28 &    Center coordinates are not contained in any image of interest \\
     497PSTAMP\_NOT\_AUTHORIZED   & 29 &    user is not allowed access to the selected data\\
    426498
    427499\hline
Note: See TracChangeset for help on using the changeset viewer.