Index: trunk/ppTranslate/documentation/ICD/PSDC-940-005.tex =================================================================== --- trunk/ppTranslate/documentation/ICD/PSDC-940-005.tex (revision 34509) +++ trunk/ppTranslate/documentation/ICD/PSDC-940-005.tex (revision 34695) @@ -2,7 +2,6 @@ \documentclass[panstarrs,spec]{panstarrs} \usepackage{nonfloat} - -\newcommand{\sccomment}[1]{% - \textcolor{green}{SC: #1}} +\usepackage{caption} + \newcommand{\outformatversion}{% \texttt{PS1\_DV3}} @@ -12,5 +11,5 @@ \subtitle{Pan-STARRS IPP-MOPS ICD for PS-1} \shorttitle{IPP-MOPS ICD} -\author{Eugene Magnier, Larry Denneau, Jr., Robert Jedicke} +\author{\parbox{3in}{Serge Chastel; Larry Denneau, Jr.; Denver Green; Robert Jedicke; Eugene Magnier}} \audience{Pan-STARRS PMO} \group{Pan-STARRS IPP \& MOPS} @@ -26,11 +25,13 @@ \RevisionsStart % version Date Description -03 & 2012 Oct 04 & \texttt{PS1\_DV3}: Fitted trails, new parameters\\ -\hline -02 & 2011 Apr 19 & Synchronization with "ICD Lite" wiki page \\ -\hline -01 & 2010 Oct 27 & New CMF Parameters \\ -\hline -00 & 2006 Mar 01 & Initial version \\ \hline +04 & 2012 Nov 20 & Answers to DG comments/questions \\ +\hline +03 & 2012 Oct 04 & \texttt{PS1\_DV3}: Fitted trails, new parameters\\ +\hline +02 & 2011 Apr 19 & Synchronization with "ICD Lite" wiki page \\ +\hline +01 & 2010 Oct 27 & New CMF Parameters \\ +\hline +00 & 2006 Mar 01 & Initial version \\ \hline \RevisionsEnd @@ -116,4 +117,24 @@ \DocumentsEnd +\subsection{Acronyms} + +\begin{table} + \small + \caption{Acronyms used in this document\label{table-acronyms}} + \begin{tabular}{ll} + \hline + {\bf Acronym} & {\bf Definition} \\ + \hline + ADU & Analog to Digital Units (counts in an image) \\ + ICRS & International Celestial Reference System \\ + IPP & Pan-STARRS Image Processing Pipeline \\ + FPA & Focal Plane Array \\ + MOPS & Pan-STARRS Moving Object Processing System \\ + MPC & Center for Astrophysics Minor Planet Center \\ + TTI & Transient-Time Interval (about 60 minutes) \\ + \hline + \end{tabular} +\end{table} + \section{Interface Overview} @@ -144,10 +165,10 @@ This document discusses the software interface between IPP and MOPS. -IPP must send transient detection descriptions to the MOPS; MOPS -must be able to query the IPP regarding whether a particular (RA, -Dec) pair could have been detected in a particular focal plane array (FPA). This document -defines the data to be transferred between IPP and MOPS and the -mechanisms to be used for that interchange. These interfaces are -identified as \#005 in Figure~\ref{fig:overview}. The Interfaces +IPP must send transient detection descriptions to the MOPS; MOPS must +be able to query the IPP regarding whether a particular (RA, Dec) pair +could have been detected in a particular focal plane array (FPA). +This document defines the data to be transferred between IPP and MOPS +and the mechanisms to be used for that interchange. These interfaces +are identified as \#005 in Figure~\ref{fig:overview}. The Interfaces addressed by this document are marked in the table. @@ -235,5 +256,9 @@ Though efforts have been made to avoid this from occurring, where header keyword names are longer than the usual 8 character maximum, -the HIERARCH convention will be used. +the HIERARCH convention will be used (see the NASA webpages: +\htmladdnormallink{Registered FITS + Convention}{http://fits.gsfc.nasa.gov/registry/hierarch_keyword.html} +and \htmladdnormallink{4.12.4 HIERARCH Convention for Extended Keyword + Names}{http://heasarc.nasa.gov/docs/software/fitsio/c/f_user/node28.html}). \subsection{IPP-MOPS Exchange} @@ -241,8 +266,10 @@ MOPS requires from the IPP a stream of transient detections and their FPA metadata obtained from processing of difference images acquired by -the PS-1 camera. IPP is additionally required by MOPS to be able to -indicate whether a set of detections (with RA, Dec, flux, length, -orientation, etc.) on a previously acquired FPA was detectable by the -PS-1 telescope. +the PS-1 camera. + +IPP is additionally required by MOPS to be able to indicate whether a +set of detections (with RA, Dec, flux, length, orientation, etc.) on a +previously acquired FPA was detectable by the PS-1 telescope. This +functionality is provided through the detectability server. \subsubsection{Conventions} @@ -305,8 +332,9 @@ \begin{itemize} -\item{EXTNAME} - Giving a unique name for the metadata table. Such a - name shall contain only the characters a-z, and ``\_''. -\item{CMFVERSION} - A string specifying the version of the table - description file for this table. +\item{EXTNAME} - A \emph{string} giving a unique name for the metadata + table. Such a name shall contain only the characters a-z, A-Z, and + ``\_''. +\item{CMFVERSION} - A \emph{string} specifying the version of the + table description file for this table. \end{itemize} @@ -389,259 +417,348 @@ exposure. -In addition to the required BINTABLE extension header keywords -described above, the FITS header shall include the keywords shown in -table \ref{trans-keywords}. The subsequent FITS table, with EXTNAME -of \code{MOPS_TRANSIENT_DETECTIONS}, shall include columns whose -definitions are listed in table \ref{trans-table}. - {\centering% - \tabcaption{IPP-MOPS Transient Detection Keywords\label{trans-keywords}} - \begin{longtable}{|lcp{0.5in}p{3in}|} - \hline \hline {\bf FITS Keyword} - & \parbox{0.5in}{\textbf{Version}} - & {\bf Precision} & {\bf Description}\\ - \hline \hline - \multicolumn{4}{|l|}{\null\hspace{10mm}\textbf{Version Information}}\\ - \hline - SWSOURCE & 1+ & string & source of software (e.g., "60eb6cdc-a59c-4636-a4e0-dba66a9721fd")\\ - \hline - SWVERSN & 1+ & string & version of software (e.g., "trunk/ppMops@24658")\\ - \hline - HIERARCH\_CMFVERSION & 2+ & char(7) & PS1\_DV1 or PS1\_DV2 or PS1\_DV3 \\ - \hline - \multicolumn{4}{|l|}{\null\hspace{10mm}\textbf{Provenance Information}}\\ - \hline - EXP\_NAME & 1+ & string & Exposure name (e.g., "o1234g5678")\\ - \hline - EXP\_ID & 1+ & S64 & Exposure identifier \\ - \hline - CHIP\_ID & 1+ & S64 & Chip stage identifier \\ - \hline - CAM\_ID & 1+ & S64 & Camera stage identifier \\ - \hline - FAKE\_ID & 1+ & S64 & Fake stage identifier \\ - \hline - WARP\_ID & 1+ & S64 & Warp stage identifier \\ - \hline - DIFF\_ID & 1+ & S64 & Diff stage \\ - \hline - DIFF\_POS & 1+ & boolean & Sense of subtraction; T for forward, F for backward\\ - \hline - \multicolumn{4}{|l|}{\null\hspace{10mm}\textbf{Exposure Details}}\\ - \hline MJD-OBS & 0+ - & F64 & midpoint time of the exposure as a MJD and day fraction \\ - \hline - RA & 0+ - & {\tiny HH:MM:SS.SSS} & field center RA at exposure midpoint, string \\ - \hline - DEC & 0+ & - {\tiny sDD:MM:SS}& (s is + or -) field center declination at exposure midpoint, string \\ - \hline - EXPTIME & 0+ - & F64 & exposure time in seconds \\ - \hline - ROTANGLE & 0+ - & F64 & image rotation of the y-axis in degrees, from local N toward E \\ - \hline - FILTER & 0+ & char(3) & effective filter used for the exposure, - one of g, r, i, z, y, B, V, w - appended with '.00000'\\ - \hline - AIRMASS & 0+ & F64 - & airmass at exposure midpoint \\ - \hline - OBSCODE & 0+ & char(5) & MPC three-character observatory code \\ - \hline - TEL\_ALT & 0+ & F64 & telescope altitude at exposure midpoint, in degrees \\ - \hline - TEL\_AZ & 0+ & F64 & telescope azimuth at exposure midpoint, in degrees \\ - \hline - SEEING & 1+ & F32 & Measured seeing at diff stage, arcsec \\ - \hline - MAGZP & 1+ & F32 & Magnitude zero point \\ - \hline - MAGZPERR & 1+ & F32 & Error in magnitude zero point \\ - \hline - ASTRORMS & 1+ & F32 & RMS of astrometric fit, arcsec \\ - \hline - COMMENT & 3+ & String & Comment associated to the exposure\\ - \hline - OBS\_MODE & 3+ & String & Observation mode (e.g. MD, 3PI...)\\ - \hline - DIFFTYPE & 3+ & String & Difference type: WW (Warp-Warp Difference), WS (Warp-Stack Difference)\\ - \hline - SKY & 3+ & F64 & Exposure average sky background \\ - \hline - SHUTOUTC & 3+ & String & Camera exposure shutter open (UTC) \\ - \hline + \tabcaption{IPP-MOPS Data Types Definition\label{table-datatypes}} + \begin{longtable}{|cp{5in}|} + \hline + \textbf{Alias} & \textbf{Description} \\ + \texttt{bool} & (Not a FITS type) An enumerated type defining a Boolean + value, either \texttt{true} or \texttt{false}\\ + \texttt{char($n$)} & (Not a FITS type) A sequence of exactly $n$ bytes that + can be interpreted + as a sequence of ASCII characters\\ + \texttt{HH:MM:SS.sss} & (Not a FITS type) a \texttt{char(12)} encoding + a time or an angle: (1) the hours \texttt{HH} are encoded with two + decimal figures; (2) a separator \texttt{:} between the hours and + the minutes; (3) the minutes \texttt{MM} are encoded with two + decimal figures; (4) a separator \texttt{:} between the minutes + and the seconds; (5) the seconds \texttt{SS} are encoded with two + decimal figures; (6) a separator \texttt{.} between the seconds + and the milli(arc)seconds; (7) + the milli(arc)seconds \texttt{ss} are encoded with three decimal figures; \\ + \texttt{sDD:MM:SS} & (Not a FITS type) a \texttt{char(9)} encoding an + angle. (1) \texttt{s} is either the \texttt{+} or \texttt{-} sign; + (2) \texttt{DD} is the number of degrees encoded with two decimal + figures; (3) a separator \texttt{:} between the degrees and the + minutes; (4) the minutes \texttt{MM} are encoded with two decimal + figures; (5) a separator \texttt{:} between the minutes and the + seconds; (6) the + seconds \texttt{SS} are encoded with two decimal figures;\\ + \texttt{enum} & (Not a FITS type) a \texttt{string} having a fixed number of + different values. The explicit set of values shall be expressed in + this ICD.\\ + \texttt{F32} & (FITS type) IEEE 32-bit single precision floating point real numbers \\ + \texttt{F64} & (FITS type) IEEE 64-bit double precision floating point real numbers \\ + \texttt{S16} & (FITS type) 16-bit signed integer \\ + \texttt{S32} & (FITS type) 32-bit signed integer \\ + \texttt{S64} & (FITS type) 64-bit signed integer \\ + \texttt{string} & (Not a FITS type) Sequence of bytes of arbitrary length + usually interpreted as a sequence of ASCII characters \\ + \texttt{U16} & (FITS type) 16-bit unsigned integer \\ + \texttt{U32} & (FITS type) 32-bit unsigned integer \\ \hline \end{longtable} } -{\centering - \tabcaption{IPP-MOPS Transient Detection Table Columns\label{trans-table}} - \begin{longtable}{|lclp{3.5in}|} +In addition to the required BINTABLE extension header keywords +described above (TODO: Where? What?), the FITS header shall include the +keywords shown in tables relative to versioning +\ref{table-keywords-versioning}, data provenance +\ref{table-keywords-provenance}, and exposure +\ref{table-keywords-exposure}. The subsequent FITS table, with EXTNAME +of \code{MOPS_TRANSIENT_DETECTIONS}, shall include columns whose +definitions are listed in table \ref{table-detections} and, when trail +fitting has been succesfully performed, \ref{table-detections-ext}. + +\begin{center} + \begin{longtable}{|lcp{0.5in}p{3in}|} + \caption{IPP-MOPS Transient Detection Keywords:\\ Version Information}\label{table-keywords-versioning}\\ + \hline\hline + \multicolumn{4}{|l|}{\null\hspace*{1in}\textbf{Version Information}}\\ + \hline\hline + {\bf FITS Keyword} + & \parbox{0.5in}{\textbf{Version}} + & {\bf Precision} + & {\bf Description} \\ + \hline + SWSOURCE & 1+ & \texttt{string} & source of software (e.g., "60eb6cdc-a59c-4636-a4e0-dba66a9721fd") \\ + \hline + SWVERSN & 1+ & \texttt{string} & version of software (e.g., "trunk/ppMops@24658") \\ + \hline + HIERARCH CMFVERSION & 2+ & \texttt{enum} & \texttt{PS1\_DV3} \\ + \hline\hline + \end{longtable} +\end{center} + +\begin{center} + \begin{longtable}{|lcp{0.5in}p{3in}|} + \caption{IPP-MOPS Transient Detection Keywords:\\ Provenance Information}\label{table-keywords-provenance}\\ + \hline\hline + \multicolumn{4}{|l|}{\null\hspace{10mm}\textbf{Provenance Information}}\\ \hline \hline - {\bf Column} & \textbf{Version} & {\bf Precision} & {\bf Description} \\ - \hline - RA & 1+ & F64 & detection center coordinates in degrees\\ - \hline - RA\_ERR & 1+ & F64 & error in the detection center, in degrees \\ - \hline - DEC & 1+ & F64 & detection center coordinates in degrees \\ - \hline - DEC\_ERR & 1+ & F64 & error in the detection center, in degrees \\ - \hline - MAG & 1+ & F32 & Magnitude \\ - \hline - MAG\_ERR & 1+ & F32 & Magnitude error \\ - \hline - PSF\_CHI2 & 1+ & F32 & $\chi^2$ of PSF fit \\ - \hline - PSF\_DOF & 1+ & S32 & Degrees of freedom of PSF fit \\ - \hline - CR\_SIGNIFICANCE & 1+ & F32 & Significance of Cosmic Ray \\ - \hline - EXT\_SIGNIFICANCE & 1+ & F32 & Significance of extendedness \\ - \hline - PSF\_MAJOR & 1+ & F32 & PSF major axis (pixels) \\ - \hline - PSF\_MINOR & 1+ & F32 & PSF minor axis (pixels) \\ - \hline - PSF\_THETA & 1+ & F32 & PSF position angle (deg on chip) \\ - \hline - PSF\_QUALITY & 1+ & F32 & PSF quality factor \\ - \hline - PSF\_NPIX & 1+ & S32 & Number of pixels in PSF \\ - \hline - MOMENTS\_XX & 1+ & F32 & xx moment \\ - \hline - MOMENTS\_XY & 1+ & F32 & xy moment \\ - \hline - MOMENTS\_YY & 1+ & F32 & yy moment \\ - \hline - N\_POS & 1+ & S32 & Number of positive pixels \\ - \hline - F\_POS & 1+ & F32 & Fraction of positive pixels \\ - \hline - RATIO\_BAD & 1+ & F32 & Ratio of positive pixels to negative \\ - \hline - RATIO\_MASK & 1+ & F32 & Ratio of positive pixels to masked \\ - \hline - RATIO\_ALL & 1+ & F32 & Ratio of positive pixels to all \\ - \hline - FLAGS & 1+ & U32 & Detection bit flags\footnote{See \htmladdnormallink{http://svn.pan-starrs.ifa.hawaii.edu/trac/ipp/wiki/PSPSFlags\#StackDetectionFull.infoFlagsFLAGS232FLAGS}{http://svn.pan-starrs.ifa.hawaii.edu/trac/ipp/wiki/PSPSFlags\#StackDetectionFull.infoFlagsFLAGS232FLAGS} for the meaning of each bit}\\ - \hline - DIFF\_SKYFILE\_ID & 1+ & S64 & Identifier for diff skyfile. A - diff\_id (for Warp-Warp difference) or a stack\_id - (for Warp-Stack difference) \\ - \hline - IPP\_IDET & 2+ & U32 & IPP detection identifier index \\ - \hline - PSF\_INST\_FLUX & 2+ & F32 & PSF fit instrumental magnitude \\ - \hline - PSF\_INST\_FLUX\_SIG & 2+ & F32 & Sigma of PSF instrumental magnitude \\ - \hline - AP\_MAG & 2+ & F32 & magnitude in standard aperture \\ - \hline - AP\_MAG\_RAW & 2+ & F32 & magnitude in real aperture \\ - \hline - AP\_MAG\_RADIUS & 2+ & F32 & radius used for aperture mags \\ - \hline - AP\_FLUX & 2+ & F32 & instrumental flux in standard aperture \\ - \hline - AP\_FLUX\_SIG & 2+ & F32 & aperture flux error \\ - \hline - PEAK\_FLUX\_AS\_MAG & 2+ & F32 & Peak flux expressed as magnitude \\ - \hline - CAL\_PSF\_MAG & 2+ & F32 & PSF Magnitude using supplied calibration \\ - \hline - CAL\_PSF\_MAG\_SIG & 2+ & F32 & measured scatter of zero point calibration \\ - \hline - SKY & 2+ & F32 & Sky level \\ - \hline - SKY\_SIGMA & 2+ & F32 & Sigma of sky level \\ - \hline - PSF\_QF\_PERFECT & 2+ & F32 & PSF coverage/quality factor (poor) \\ - \hline - MOMENTS\_R1 & 2+ & F32 & first radial moment \\ - \hline - MOMENTS\_RH & 2+ & F32 & half radial moment \\ - \hline - KRON\_FLUX & 2+ & F32 & Kron Flux (in 2.5 R1) \\ - \hline - KRON\_FLUX\_ERR & 2+ & F32 & Kron Flux Error \\ - \hline - KRON\_FLUX\_INNER & 2+ & F32 & Kron Flux (in 1.0 R1) \\ - \hline - KRON\_FLUX\_OUTER & 2+ & F32 & Kron Flux (in 4.0 R1) \\ - \hline - DIFF\_R\_P & 2+ & F32 & distance to positive match source \\ - \hline - DIFF\_SN\_P & 2+ & F32 & signal-to-noise of pos match src \\ - \hline - DIFF\_R\_M & 2+ & F32 & distance to negative match source \\ - \hline - DIFF\_SN\_M & 2+ & F32 & signal-to-noise of neg match src \\ + {\bf FITS Keyword} + & \parbox{0.5in}{\textbf{Version}} + & {\bf Precision} + & {\bf Description} \\ + \hline + EXP\_NAME & 1+ & \texttt{string} & Exposure name (e.g., "o1234g5678")\\ + \hline + EXP\_ID & 1+ & \texttt{S64} & Exposure identifier \\ + \hline + CHIP\_ID & 1+ & \texttt{S64} & Chip stage identifier \\ + \hline + CAM\_ID & 1+ & \texttt{S64} & Camera stage identifier \\ + \hline + FAKE\_ID & 1+ & \texttt{S64} & Fake stage identifier \\ + \hline + WARP\_ID & 1+ & \texttt{S64} & Warp stage identifier \\ + \hline + DIFF\_ID & 1+ & \texttt{S64} & Diff stage \\ + \hline + DIFF\_POS & 1+ & \texttt{bool} & Sense of subtraction; \texttt{true} for forward, + \texttt{false} for backward\\ + \hline + \end{longtable} +\end{center} + +\begin{center} + \begin{longtable}{|lcp{0.5in}p{3in}c|} + \caption{IPP-MOPS Transient Detection Keywords:\\ Exposure Details}\label{table-keywords-exposure}\\ + \hline \hline + \multicolumn{5}{|l|}{\null\hspace{10mm}\textbf{Exposure Details}}\\ + \hline \hline {\bf FITS Keyword} + & \parbox{0.5in}{\textbf{Version}} & {\bf Precision} & {\bf + Description} + & \textbf{Units}\\ + \hline MJD-OBS & 0+ & \texttt{F64} & midpoint time of the exposure + as a MJD and day fraction + & N/A\\ + \hline RA & 0+ & {\tiny \texttt{HH:MM:SS.SSS}} + & Field center RA at exposure midpoint & N/A \\ + \hline DEC & 0+ & {\tiny \texttt{sDD:MM:SS}} & + (s is + or -) Field center declination at exposure midpoint & N/A \\ + \hline EXPTIME & 0+ & \texttt{F64} + & Exposure time & seconds \\ + \hline ROTANGLE & 0+ & \texttt{F64} + & Image rotation of the y-axis from local N toward E & degrees \\ + \hline FILTER & 0+ & \texttt{char(7)} & Effective filter used for + the exposure, one of \texttt{g}, \texttt{r}, \texttt{i}, + \texttt{z}, \texttt{y}, \texttt{B}, + \texttt{V}, \texttt{w} appended with '.00000' & N/A \\ + \hline AIRMASS & 0+ & \texttt{F64} + & Airmass at exposure midpoint & N/A\\ + \hline OBSCODE & 0+ & char(5) & + MPC 3-character observatory code (F51 for PS1) & N/A \\ + \hline TEL\_ALT & 0+ & \texttt{F64} & + Telescope altitude at exposure midpoint & degrees \\ + \hline TEL\_AZ & 0+ & \texttt{F64} + & Telescope azimuth at exposure midpoint & degrees \\ + \hline SEEING & 1+ & \texttt{F32} & + Measured seeing at diff stage & arcsec \\ + \hline MAGZP & 1+ & \texttt{F32} & + Magnitude zero point & N/A \\ + \hline MAGZPERR & 1+ & \texttt{F32} & + Error in magnitude zero point & N/A \\ + \hline ASTRORMS & 1+ & \texttt{F32} & + RMS of astrometric fit & arcsec \\ + \hline CMMTOBS & 3+ & \texttt{string} & + Comment associated to the exposure & N/A\\ + \hline OBS\_MODE & 3+ & \texttt{enum} & Observation modes list: + 3PI, CNP, ESS, M31, MD, MSS, OSS, PI, STD (Note: The exposures + having the following PS1 observation modes are not used by MOPS: + CAL, PR201108, SAS2, SS, STS, STS2A, STS2B) & N/A\\ + \hline DIFFTYPE & 3+ & \texttt{enum} & + Difference type: \texttt{WW} (Warp-Warp Difference), \texttt{WS} (Warp-Stack Difference) & N/A\\ + \hline SKY & 3+ & \texttt{F64} & + Exposure average sky background & counts/pixel \\ + \hline SHUTOUTC & 3+ & \texttt{string} & + Camera exposure shutter open (UTC) & N/A \\ + \hline \hline + \end{longtable} +\end{center} + +\begin{center} + \begin{longtable}{|lclp{3.5in}c|} + \caption{IPP-MOPS Transient Detection Table Columns:\\ Detection Details}\label{table-detections}\\ + \hline \hline + \multicolumn{5}{|l|}{\null\hspace{10mm}\textbf{Detection Details}}\\ + \hline \hline + {\bf Column} & \textbf{Version} & {\bf Precision} & {\bf Description} & \textbf{Units}\\ + \hline + RA & 1+ & F64 & Detection center coordinates & degrees\\ + \hline + RA\_ERR & 1+ & F64 & Error in the detection center & degrees \\ + \hline + DEC & 1+ & F64 & Detection center coordinates & degrees \\ + \hline + DEC\_ERR & 1+ & F64 & Error in the detection center & degrees \\ + \hline + MAG & 1+ & F32 & Filter magnitude & N/A \\ + \hline + MAG\_ERR & 1+ & F32 & Filter magnitude error & N/A \\ + \hline + PSF\_CHI2 & 1+ & F32 & $\chi^2$ of PSF fit & N/A \\ + \hline + PSF\_DOF & 1+ & S32 & Degrees of freedom of PSF fit & N/A \\ + \hline + CR\_SIGNIFICANCE & 1+ & F32 & Significance of cosmic ray (source: \emph{src/psphot/psphotSourceSize.c}) & N/A \\ + \hline + EXT\_SIGNIFICANCE & 1+ & F32 & Significance of extendedness (source: \emph{src/psphot/psphotSourceSize.c}) & N/A \\ + \hline + PSF\_MAJOR & 1+ & F32 & PSF major axis & pixels \\ + \hline + PSF\_MINOR & 1+ & F32 & PSF minor axis & pixels \\ + \hline + PSF\_THETA & 1+ & F32 & PSF position angle on chip & degrees \\ + \hline + PSF\_QUALITY & 1+ & F32 & PSF quality factor & N/A \\ + \hline + PSF\_NPIX & 1+ & S32 & Number of pixels in PSF & N/A \\ + \hline + MOMENTS\_XX & 1+ & F32 & xx moment & N/A \\ + \hline + MOMENTS\_XY & 1+ & F32 & xy moment & N/A \\ + \hline + MOMENTS\_YY & 1+ & F32 & yy moment & N/A \\ + \hline + N\_POS & 1+ & S32 & Number of positive pixels & N/A \\ + \hline + F\_POS & 1+ & F32 & Fraction of positive pixels & N/A \\ + \hline + RATIO\_BAD & 1+ & F32 & Ratio of positive pixels to negative & N/A \\ + \hline + RATIO\_MASK & 1+ & F32 & Ratio of positive pixels to masked & N/A \\ + \hline + RATIO\_ALL & 1+ & F32 & Ratio of positive pixels to all & N/A \\ + \hline + FLAGS & 1+ & U32 & Detection bit flags\footnote{See \htmladdnormallink{http://svn.pan-starrs.ifa.hawaii.edu/trac/ipp/wiki/PSPSFlags\#StackDetectionFull.infoFlagsFLAGS232FLAGS}{http://svn.pan-starrs.ifa.hawaii.edu/trac/ipp/wiki/PSPSFlags\#StackDetectionFull.infoFlagsFLAGS232FLAGS} for the meaning of each bit}. The PM\_SOURCE\_MODE\_EXTENDED\_FIT flag (at position 0x00800000) is set when the Trail Fitting is attempted. It does not mean that the Trail Fitting is successful. \\ + \hline DIFF\_SKYFILE\_ID & 1+ & S64 & Identifier for diff + skyfile. Either a diff\_id (for Warp-Warp difference) or a + stack\_id + (for Warp-Stack difference) & N/A \\ + \hline + IPP\_IDET & 2+ & U32 & IPP detection identifier index & N/A \\ + \hline + PSF\_INST\_FLUX & 2+ & F32 & PSF fit instrumental magnitude & N/A \\ + \hline + PSF\_INST\_FLUX\_SIG & 2+ & F32 & Sigma of PSF instrumental magnitude & N/A \\ + \hline + AP\_MAG & 2+ & F32 & magnitude in standard aperture (i.e. 25 pixels radius) & N/A \\ + \hline + AP\_MAG\_RAW & 2+ & F32 & magnitude in real aperture & N/A \\ + \hline + AP\_MAG\_RADIUS & 2+ & F32 & radius used for aperture mags & pixels \\ + \hline + AP\_FLUX & 2+ & F32 & instrumental flux in standard aperture & ADU \\ + \hline + AP\_FLUX\_SIG & 2+ & F32 & aperture flux error & N/A \\ + \hline + PEAK\_FLUX\_AS\_MAG & 2+ & F32 & Peak flux expressed as magnitude & N/A \\ + \hline + CAL\_PSF\_MAG & 2+ & F32 & PSF Magnitude using supplied calibration & N/A \\ + \hline + CAL\_PSF\_MAG\_SIG & 2+ & F32 & Measured standard-deviation of zero point calibration & N/A \\ + \hline + SKY & 2+ & F32 & Sky level & counts/pixel \\ + \hline + SKY\_SIGMA & 2+ & F32 & Sigma of sky level & counts/pixel\\ + \hline PSF\_QF\_PERFECT & 2+ & F32 & PSF coverage/quality factor + (poor): PSF value weighted by unmasked pixels + (source: psmodules/src/objects/pmSourcePhotometry.c) & N/A \\ + \hline + MOMENTS\_R1 & 2+ & F32 & first radial moment & N/A \\ + \hline + MOMENTS\_RH & 2+ & F32 & half radial moment & N/A \\ + \hline + KRON\_FLUX & 2+ & F32 & Kron Flux (that is, flux in 2.5 $\times$ first radial moment) & N/A \\ + \hline + KRON\_FLUX\_ERR & 2+ & F32 & Kron Flux Error & N/A \\ + \hline + KRON\_FLUX\_INNER & 2+ & F32 & Inner Kron Flux (that is, flux in 1.0 $\times$ first radial moment) & N/A \\ + \hline + KRON\_FLUX\_OUTER & 2+ & F32 & Outer Kron Flux (that is, flux in 4.0 $\times$ first radial moment) & N/A \\ + \hline + DIFF\_R\_P & 2+ & F32 & distance from detection to positive matching source & pixels \\ + \hline + DIFF\_SN\_P & 2+ & F32 & signal-to-noise of pos match src & N/A \\ + \hline + DIFF\_R\_M & 2+ & F32 & distance from detectionto negative match source & pixels \\ + \hline + DIFF\_SN\_M & 2+ & F32 & signal-to-noise of neg match src & N/A \\ \hline FLAGS2 & 2+ & U32 & psphot analysis flags (group 2)\footnote{See \htmladdnormallink{http://svn.pan-starrs.ifa.hawaii.edu/trac/ipp/wiki/PSPSFlags\#StackDetectionFull.infoFlagsFLAGS232FLAGS}{http://svn.pan-starrs.ifa.hawaii.edu/trac/ipp/wiki/PSPSFlags\#StackDetectionFull.infoFlagsFLAGS232FLAGS} for the meaning of each bit}\\ \hline - N\_FRAMES & 2+ & U16 & Number of frames overlapping source center \\ + N\_FRAMES & 2+ & U16 & Number of exposures overlapping source center \\ \hline PADDING & 2+ & S16 & padding \\ - \hline - \multicolumn{4}{|c|}{\textbf{Extended (trail fitting) parameters}}\\ - \multicolumn{4}{|c|}{Values like \texttt{NaN} mean that the extended parameters are undefined for the detection}\\ - \hline - X\_EXT & 2+ & F32 & Extended model X coordinate \\ - \hline - Y\_EXT & 2+ & F32 & Extended model Y coordinate \\ - \hline - X\_EXT\_SIG & 2+ & F32 & Sigma in extended model X coordinate \\ - \hline - Y\_EXT\_SIG & 2+ & F32 & Sigma in extended model Y coordinate \\ - \hline - EXT\_INST\_MAG & 2+ & F32 & Extended fit instrumental magnitude \\ - \hline - EXT\_INST\_SIG\_MAG & 2+ & F32 & Sigma of extended fit instrumental magnitude \\ - \hline - NPARAMS & 2+ & F32 & Number of model parameters \\ - \hline - EXT\_WIDTH\_MAJ & 2+ & F32 & EXT width (major axis), length for trail \\ - \hline - EXT\_WIDTH\_MIN & 2+ & F32 & EXT width (minor axis), sigma for trail \\ - \hline - EXT\_THETA & 2+ & F32 & EXT orientation angle\\ - \hline - EXT\_WIDTH\_MAJ\_ERR & 2+ & F32 & EXT width error (major axis)\\ - \hline - EXT\_WIDTH\_MIN\_ERR & 2+ & F32 & EXT width error (minor axis)\\ - \hline - EXT\_THETA\_ERR & 2+ & F32 & EXT orientation angle (error)\\ - \hline - RA\_EXT & 3+ & F32 & Fitted centroid RA \\ - \hline - RA\_EXT\_SIGMA & 3+ & F32 & Fitted RA sigma \\ - \hline - DEC\_EXT & 3+ & F32 & Fitted centroid DEC \\ - \hline - DEC\_EXT\_SIGMA & 3+ & F32 & Fitted DEC sigma \\ - \hline - POSANG\_EXT & 3+ & F32 & Fitted position angle \\ - \hline - PLTSCALE\_EXT & 3+ & F32 & Plate scale at centroid \\ - \hline - EXT\_FLUX & 3+ & F32 & Fitted flux \\ - \hline - EXT\_CAL\_MAG & 3+ & F32 & Calibrated magnitude \\ - \hline - EXT\_MAG\_SIG & 3+ & F32 & Sigma of calibrated magnitude \\ - \hline - EXT\_CHISQ & 3+ & F32 & $\chi^2$ of fit \\ - \hline - EXT\_NDOF & 3+ & S32 & Fit degrees of freedom \\ - \hline + \hline \hline \end{longtable} -} +\end{center} + +\begin{center} + \begin{longtable}{|lclp{3.5in}c|} + \caption{IPP-MOPS Transient Detection Table Columns:\\ Extended (Trail Fitting) Details}\label{table-detections-ext}\\ + \hline \hline + \multicolumn{5}{|c|}{\textbf{Extended (trail fitting) parameters}}\\ + \multicolumn{5}{|c|}{Values like \texttt{NaN} mean that the extended parameters are undefined for the detection}\\ + \hline + X\_EXT & 2+ & F32 & + Extended model X coordinate & pixels\\ + \hline + Y\_EXT & 2+ & F32 & + Extended model Y coordinate & pixels \\ + \hline + X\_EXT\_SIG & 2+ & F32 & + Sigma in extended model X coordinate & pixels \\ + \hline + Y\_EXT\_SIG & 2+ & F32 & + Sigma in extended model Y coordinate & pixels \\ + \hline + EXT\_INST\_MAG & 2+ & F32 & + Extended fit instrumental magnitude & N/A \\ + \hline + EXT\_INST\_SIG\_MAG & 2+ & F32 & + Sigma of extended fit instrumental magnitude & N/A \\ + \hline + NPARAMS & 2+ & S32 & + Number of model parameters (TODO: Reference to PV paper for details) & N/A \\ + \hline + EXT\_WIDTH\_MAJ & 2+ & F32 & % The name is weird but it's because of normalization + Length of trail & pixels \\ % in the IPP: Check if MOPS want to change it + \hline + EXT\_WIDTH\_MIN & 2+ & F32 & % The name is weird but it's because of normalization + Sigma of trail & pixels \\ % in the IPP: Check if MOPS want to change it + \hline + EXT\_THETA & 2+ & F32 & EXT orientation angle & radians \\ + \hline + EXT\_WIDTH\_MAJ\_ERR & 2+ & F32 & EXT width error (major axis) & pixels \\ + \hline + EXT\_WIDTH\_MIN\_ERR & 2+ & F32 & EXT width error (minor axis) & pixels \\ + \hline + EXT\_THETA\_ERR & 2+ & F32 & EXT orientation angle (error) & radians \\ + \hline + RA\_EXT & 3+ & F32 & Fitted centroid RA & degrees \\ + \hline + RA\_EXT\_SIGMA & 3+ & F32 & Fitted RA sigma & degrees? \\ + \hline + DEC\_EXT & 3+ & F32 & Fitted centroid DEC & degrees \\ + \hline + DEC\_EXT\_SIGMA & 3+ & F32 & Fitted DEC sigma & degrees? \\ + \hline + POSANG\_EXT & 3+ & F32 & Fitted position angle & degrees \\ + \hline + PLTSCALE\_EXT & 3+ & F32 & Plate scale at centroid & arcsec/pixel \\ + \hline + EXT\_FLUX & 3+ & F32 & Fitted flux & ADU \\ + \hline + EXT\_CAL\_MAG & 3+ & F32 & Calibrated magnitude & N/A \\ + \hline + EXT\_MAG\_SIG & 3+ & F32 & Sigma of calibrated magnitude & N/A \\ + \hline + EXT\_CHISQ & 3+ & F32 & $\chi^2$ of fit & N/A \\ + \hline + EXT\_NDOF & 3+ & S32 & Fit degrees of freedom & N/A \\ + \hline + \end{longtable} +\end{center} \subsection{MOPS Detectability Query} @@ -764,7 +881,120 @@ \pagebreak + +\section{Changes} + +\subsection{Changes in PS1\_DV3 from PS1\_DV2} + +\subsubsection{New Keywords} + +\paragraph{Per Exposure (in FITS header)} +\begin{itemize} +\item CMMTOBS +\item OBS\_MODE +\item DIFFTYPE +\item SKY +\item SHUTOUTC +\end{itemize} + +\paragraph{Per Detection (in FITS extension)} +\begin{itemize} +\item RA\_EXT +\item RA\_EXT\_SIGMA +\item DEC\_EXT +\item DEC\_EXT\_SIGMA +\item POSANG\_EXT +\item PLTSCALE\_EXT +\item EXT\_FLUX +\item EXT\_CAL\_MAG +\item EXT\_MAG\_SIG +\item EXT\_CHISQ +\item EXT\_NDOF +\end{itemize} + +\subsubsection{Removed Keywords} + +None + +\subsubsection{Datatypes} +\begin{itemize} +\item NPARAMS is now a S32 and no more a F32. +\end{itemize} + +\subsubsection{Known Bugs and Associated Fix} + +\begin{itemize} +\item None +\end{itemize} + +\newpage + \appendix -\section{Appendix} +\section{The IPP Data Workflow} + +The objective of this section is to provide some details about the IPP +Workflow. It is intentionnally MOPS oriented in the sense that some +details have been voluntarily omitted. + +\begin{minipage}{0.65\linewidth} + The IPP receives "exposures" from the telescope. An "exposure" is an + image of 60 OTAs (see figure~\ref{fig-exposure-otas}) taken by the + GPC1 camera and its associated metadata. All science exposures + (which are interesting MOPS) are processed in the IPP according to + the following stages. + + The first stage is the CHIP stage. Detrending and objects detections + are performed on each OTA at this stage. + + The second stage is the CAMERA stage. Calibration and astrometry are + performed on the exposure at this stage. + + The third stage is the WARP stage\footnote{For simplicity and since + nothing is performed in this stage, the FAKE stage has been + ommitted.}. The image pixels are warped to fit a predefined sky + tessellation (it is actually a covering). Cells of the tessellation + are called \emph{skycells} and each pixel in a skycell has a size of + $0.25" \times 0.25"$. The skycell is oriented so that increasing X + (wrt Y) pixel coordinate corresponds to a move toward the West (wrt + North). + + The fourth stage is the DIFF stage. The difference between two + skycells having the same spatial coordinates but being distant in + time (by less than the TTI) is computed. To avoid deconvolution, + the image difference can be performed in bothways When the newer + image is diffed with the older image, the difference image is called + the \emph{positive} image. When the older image is diffed with the + newer image, the difference image is called the \emph{negative} + image. + + Another stage is executed in parallel of the fourth stage: the STACK + stage. Its products (the stacks, that is, "average" observations in + a skycell) can be used in the DIFF stage to compute WARP-STACK + differences (e.g for MD observations). STACK-WARP are not computed + (so far). + + The fifth and last stage is the PPMOPS stage. The exposure is + rebuilt from the differences obtained in each skycell of the DIFF + stage. For detections falling in areas covered by two or more + skycells, the data of the detection being the nearest to a skycell + center are taken. +\end{minipage}\hfill\begin{minipage}{0.3\linewidth} + \begin{center} + \includegraphics[width=\linewidth]{figures/ipp_workflow.eps} + \captionof{figure}{Caption for figure} + \label{fig-ipp-workflow} + \end{center} +\end{minipage} + +\begin{center} + \includegraphics[width=4in]{figures/exposure_ota.eps} + \captionof{figure}{Exposure / OTA TODO + Move somewhere else} + \label{fig-exposure-otas} +\end{center} + +\newpage +\section{Obsolete Stuff?} + +TODO (SC): The following stuff seems obsolete. Tell me if I can remove it. \subsection{IPP to MOPS} @@ -797,24 +1027,4 @@ \hline Detectability Query & \code{MOPS_DETECTABILITY_QUERY} & table of detectability query tuples (RA, Dec, FPA) \\ -\end{tabular} -\end{center} -\end{table} - -\subsection{Acronyms} - -\begin{table}[htbp] -\begin{center} -\small -\caption{Acronyms used in this document\label{table-acronyms}} -\begin{tabular}{ll} -\hline -\hline -{\bf Acronym} & {\bf Definition} \\ -\hline -MOPS & Pan-STARRS Moving Object Processing System \\ -IPP & Pan-STARRS Image Processing Pipeline \\ -FPA & Focal plane array \\ -MPC & Center for Astrophysics Minor Planet Center \\ -\hline \end{tabular} \end{center} @@ -841,101 +1051,4 @@ \end{itemize} -\subsection{Example} -\label{sec-example} - -\begin{verbatim} -XTENSION= 'BINTABLE' / binary table extension -BITPIX = 8 / 8-bit bytes -NAXIS = 2 / 2-dimensional binary table -NAXIS1 = 120 / width of table in bytes -NAXIS2 = 42032 / number of rows in table -PCOUNT = 0 / size of special data area -GCOUNT = 1 / one data group (required keyword) -TFIELDS = 25 / number of fields in each row -TTYPE1 = 'RA ' / label for field 1 -TFORM1 = '1D ' / data format of field: 8-byte DOUBLE -TTYPE2 = 'RA_ERR ' / label for field 2 -TFORM2 = '1D ' / data format of field: 8-byte DOUBLE -TTYPE3 = 'DEC ' / label for field 3 -TFORM3 = '1D ' / data format of field: 8-byte DOUBLE -TTYPE4 = 'DEC_ERR ' / label for field 4 -TFORM4 = '1D ' / data format of field: 8-byte DOUBLE -TTYPE5 = 'MAG ' / label for field 5 -TFORM5 = '1E ' / data format of field: 4-byte REAL -TTYPE6 = 'MAG_ERR ' / label for field 6 -TFORM6 = '1E ' / data format of field: 4-byte REAL -TTYPE7 = 'PSF_CHI2' / label for field 7 -TFORM7 = '1E ' / data format of field: 4-byte REAL -TTYPE8 = 'PSF_DOF ' / label for field 8 -TFORM8 = '1J ' / data format of field: 4-byte INTEGER -TTYPE9 = 'CR_SIGNIFICANCE' / label for field 9 -TFORM9 = '1E ' / data format of field: 4-byte REAL -TTYPE10 = 'EXT_SIGNIFICANCE' / label for field 10 -TFORM10 = '1E ' / data format of field: 4-byte REAL -TTYPE11 = 'PSF_MAJOR' / label for field 11 -TFORM11 = '1E ' / data format of field: 4-byte REAL -TTYPE12 = 'PSF_MINOR' / label for field 12 -TFORM12 = '1E ' / data format of field: 4-byte REAL -TTYPE13 = 'PSF_THETA' / label for field 13 -TFORM13 = '1E ' / data format of field: 4-byte REAL -TTYPE14 = 'PSF_QUALITY' / label for field 14 -TFORM14 = '1E ' / data format of field: 4-byte REAL -TTYPE15 = 'PSF_NPIX' / label for field 15 -TFORM15 = '1J ' / data format of field: 4-byte INTEGER -TTYPE16 = 'MOMENTS_XX' / label for field 16 -TFORM16 = '1E ' / data format of field: 4-byte REAL -TTYPE17 = 'MOMENTS_XY' / label for field 17 -TFORM17 = '1E ' / data format of field: 4-byte REAL -TTYPE18 = 'MOMENTS_YY' / label for field 18 -TFORM18 = '1E ' / data format of field: 4-byte REAL -TTYPE19 = 'N_POS ' / label for field 19 -TFORM19 = '1J ' / data format of field: 4-byte INTEGER -TTYPE20 = 'F_POS ' / label for field 20 -TFORM20 = '1E ' / data format of field: 4-byte REAL -TTYPE21 = 'RATIO_BAD' / label for field 21 -TFORM21 = '1E ' / data format of field: 4-byte REAL -TTYPE22 = 'RATIO_MASK' / label for field 22 -TFORM22 = '1E ' / data format of field: 4-byte REAL -TTYPE23 = 'RATIO_ALL' / label for field 23 -TFORM23 = '1E ' / data format of field: 4-byte REAL -TTYPE24 = 'FLAGS ' / label for field 24 -TFORM24 = '1J ' / data format of field: 4-byte INTEGER -TZERO24 = 2147483648 / offset for unsigned integers -TSCAL24 = 1 / data are not scaled -TTYPE25 = 'DIFF_SKYFILE_ID' / label for field 25 -TFORM25 = '1K ' / data format of field: 8-byte INTEGER -SWSOURCE= '60eb6cdc-a59c-4636-a4e0-dba66a9721fd' / Software source -SWVERSN = 'branches/pap_mops/ppMops@25227' / Software version -HISTORY ppMops at 2009-09-02T03:48:46.695783 -HISTORY psLib version: branches/pap_mops/psLib@25227 -HISTORY psLib source: 60eb6cdc-a59c-4636-a4e0-dba66a9721fd -HISTORY ppMops version: branches/pap_mops/ppMops@25227 -HISTORY ppMops source: 60eb6cdc-a59c-4636-a4e0-dba66a9721fd -EXP_NAME= 'o4995g0129o' / Exposure name -EXP_ID = 77164 / Exposure identifier -CHIP_ID = 24019 / Chip stage identifier -CAM_ID = 17726 / Cam stage identifier -FAKE_ID = 10227 / Fake stage identifier -WARP_ID = 8842 / Warp stage identifier -DIFF_ID = 19219 / Diff stage identifier -DIFF_POS= F / Positive subtraction? -MJD-OBS = 54995.4740598313 / MJD of exposure midpoint -RA = '18:25:01.988' / Right Ascension of boresight -DEC = '-17:20:40.069' / Declination of boresight -TEL_ALT = 51.951873 / Telescope altitude -TEL_AZ = 179.483883 / Telescope azimuth -EXPTIME = 38. / Exposure time (sec) -ROTANGLE= 333.1039 / Rotator position angle -FILTER = 'r.00000 ' / Filter name -AIRMASS = 1.269 / Airmass of exposure -OBSCODE = 'F51 ' / IAU Observatory code -SEEING = 1.678401 / Mean seeing -MAGZP = 28.65226 / Magnitude zero point -MAGZPERR= 0.353063 / Error in magnitude zero point -ASTRORMS= 0.3111496 / RMS of astrometric fit -EXTNAME = 'MOPS_TRANSIENT_DETECTIONS' -\end{verbatim} - - \end{document}