\datafield[string]{format_version}{The version of the data format with the following format: (v|V)[1-9][0-9]+}
\datafield[float with 0.1 precision, min: 0.0]{UTC_validity_from}{The begin of the valid time range for the detector description in seconds.}
\datafield[float with 0.1 precision, max: 999999999999.9]{UTC_validity_to}{The end of the valid time range for the detector description in seconds.}
\datafield[string]{UTM_ref_grid}{The reference grid, composed of the string \verb|UTM|, the reference ellipsoid and the UTM grid of the detector, e.g. "UTM WGS84 33N" for the ARCA site in Italy.}
\datafield[string]{UTM_ref_grid}{The reference grid, composed of the string UTM, the reference ellipsoid and the UTM grid of the detector, e.g. "UTM WGS84 33N" for the ARCA site in Italy.}
\datafield[int]{UTM_ref_easting, UTM_ref_northing, UTM_ref_z}{Easting, Northing and z-position of the reference point in the UTM grid. See Section~\ref{section:utm_grid} for more information.}
\datafield[unsigned int]{ndoms}{Number of optical modules, can be 0, which automatically means the ``end of the file''.}
\datafield[int]{dom_id}{The unique optical module ID. For real detectors, the number is part of the product number and is usually the last 9 digits of the CLBs MAC address.}
\alertinfo{Within each DOM section, the PMTs are listed according to an ascending order of their DAQ channel ID, starting at 0.}
\subsubsection{UTM Grid}
\label{section:utm_grid}
The KM3NeT coordinate system is proposed in \verb|KM3NeT_SOFT_WD_2016_002|, the reference
point for the ARCA site is defined within the building block one with:
\begin{itemize}
\item UTM reference ellipsoid: WGS84
\item UTM grid zone: 33N (where N is for North\footnote{A note of caution: The method used here simply adds N or S following the zone number to indicate Northern or Southern hemisphere. See \url{https://en.wikipedia.org/wiki/Universal_Transverse_Mercator_coordinate_system\#Notation} for a general discussion on the grid zone notation})
\item The elevation (\verb|UTM_ref_z|) above is the orthometric height calculated relative to the mean sea surface (MSS) as defined by \verb|DTU132|. The see \verb|WGS84| geoid height can be deduced by adding the \verb|EGM96| Geoid height which is \SI{30.9(0.1)}{\meter} at the reference point, as provided by the \verb|NGA EGM96 Geoid Calculator|; the orthometric height of the seafloor at that point is \SI{-3454(1)}{\meter} and the mean for the ARCA building block is \SI{-3452}{\meter}.
\end{itemize}
\subsubsection*{Example}
Example for ARCA28 (D0ARCA028, detector-ID 160):
...
...
@@ -230,7 +218,7 @@ for every PMT and comment lines at the beginning of the file to store meta data.
\datafield[string]{format_version}{The version of the data format with the following format: (v|V)[1-9][0-9]+}
\datafield[float with 0.1 precision, min: 0.0]{UTC_validity_from}{The begin of the valid time range for the detector description in seconds.}
\datafield[float with 0.1 precision, max: 999999999999.9]{UTC_validity_to}{The end of the valid time range for the detector description in seconds.}
\datafield[string]{UTM_ref_grid}{The reference grid, composed of the string \verb|UTM|, the reference ellipsoid and the UTM grid of the detector, e.g. "UTM WGS84 33N" for the ARCA site in Italy.}
\datafield[string]{UTM_ref_grid}{The reference grid, composed of the string UTM, the reference ellipsoid and the UTM grid of the detector, e.g. "UTM WGS84 33N" for the ARCA site in Italy.}
\datafield[int]{UTM_ref_easting, UTM_ref_northing, UTM_ref_z}{Easting, Northing and z-position of the reference point in the UTM grid. See Section~\ref{section:utm_grid} for more information.}
\datafield[unsigned int]{ndoms}{Number of optical modules, can be 0, which automatically means the ``end of the file''.}
\datafield[int]{dom_id}{The unique optical module ID. For real detectors, the number is part of the product number and is usually the last 9 digits of the CLBs MAC address.}
...
...
@@ -241,7 +229,7 @@ for every PMT and comment lines at the beginning of the file to store meta data.
\datafield[int or float]{x, y, z}{The position of the PMT with reference to the UTM coordinate with x (y) defining the relative distance in Easting (Northing) in metres.}
\datafield[int or float]{dx, dy, dz}{The direction where the PMT is pointing at.}
\datafield[int or float]{t0}{The calibration time offset which has to be added to the detected hit times.}
\datafield[int]{PMT_STATUS}{MSB: default = 0 means PMT OK for analysis; 1 = PMT NOT OK for analysis; other status flags to be updated}
\datafield[int]{PMT_STATUS}{MSB: default = 0 means PMT OK for analysis; 1 = PMT NOT OK for analysis; other status flags to be updated. The status bit definitions can be found here (updated regularly): \url{https://git.km3net.de/common/km3net-dataformat/-/blob/master/definitions/module_status.csv}}
\end{fieldspecs}
\alertinfo{Within each DOM section, the PMTs are listed according to an ascending order of their DAQ channel ID, starting at 0.}
...
...
@@ -292,7 +280,7 @@ for defining non-optical modules (like base modules).
\datafield[string]{format_version}{The version of the data format with the following format: (v|V)[1-9][0-9]+}
\datafield[float with 0.1 precision, min: 0.0]{UTC_validity_from}{The begin of the valid time range for the detector description in seconds.}
\datafield[float with 0.1 precision, max: 999999999999.9]{UTC_validity_to}{The end of the valid time range for the detector description in seconds.}
\datafield[string]{UTM_ref_grid}{The reference grid, composed of the string \verb|UTM|, the reference ellipsoid and the UTM grid of the detector, e.g. "UTM WGS84 33N" for the ARCA site in Italy.}
\datafield[string]{UTM_ref_grid}{The reference grid, composed of the string UTM, the reference ellipsoid and the UTM grid of the detector, e.g. "UTM WGS84 33N" for the ARCA site in Italy.}
\datafield[int]{UTM_ref_easting, UTM_ref_northing, UTM_ref_z}{Easting, Northing and z-position of the reference point in the UTM grid. See Section~\ref{section:utm_grid} for more information.}
\datafield[unsigned int]{nmodules}{Number of optical modules, can be 0, which automatically means the ``end of the file''.}
\datafield[int]{module_id}{The unique optical module ID. For real detectors, the number is part of the product number and is usually the last 9 digits of the CLBs MAC address.}
...
...
@@ -306,7 +294,7 @@ for defining non-optical modules (like base modules).
\datafield[int or float]{p_x, p_y, p_z}{The position of the PMT with reference to the UTM coordinate with x (y) defining the relative distance in Easting (Northing) in metres.}
\datafield[int or float]{dx, dy, dz}{The direction where the PMT is pointing at.}
\datafield[int or float]{p_t0}{The calibration time offset which has to be added to the detected hit times.}
\datafield[int]{PMT_STATUS}{MSB: default = 0 means PMT OK for analysis; 1 = PMT NOT OK for analysis; other status flags to be updated}
\datafield[int]{PMT_STATUS}{MSB: default = 0 means PMT OK for analysis; 1 = PMT NOT OK for analysis; other status flags to be updated. The status bit definitions can be found here (updated regularly): \url{https://git.km3net.de/common/km3net-dataformat/-/blob/master/definitions/module_status.csv}}
\end{fieldspecs}
\alertinfo{Within each module section, the PMTs are listed according to an ascending order of their DAQ channel ID, starting at 0.}
...
...
@@ -358,7 +346,7 @@ The main additions in the fifth version of the DETX format is the COMPONENTESTAT
\datafield[string]{format_version}{The version of the data format with the following format: (v|V)[1-9][0-9]+}
\datafield[float with 0.1 precision, min: 0.0]{UTC_validity_from}{The begin of the valid time range for the detector description in seconds.}
\datafield[float with 0.1 precision, max: 999999999999.9]{UTC_validity_to}{The end of the valid time range for the detector description in seconds.}
\datafield[string]{UTM_ref_grid}{The reference grid, composed of the string \verb|UTM|, the reference ellipsoid and the UTM grid of the detector, e.g. "UTM WGS84 33N" for the ARCA site in Italy.}
\datafield[string]{UTM_ref_grid}{The reference grid, composed of the string UTM, the reference ellipsoid and the UTM grid of the detector, e.g. "UTM WGS84 33N" for the ARCA site in Italy.}
\datafield[int]{UTM_ref_easting, UTM_ref_northing, UTM_ref_z}{Easting, Northing and z-position of the reference point in the UTM grid. See Section~\ref{section:utm_grid} for more information.}
\datafield[unsigned int]{nmodules}{Number of optical modules, can be 0, which automatically means the ``end of the file''.}
\datafield[int]{module_id}{The unique module ID. For real detectors, the number is part of the product number and is usually the last 9 digits of the CLBs MAC address.}
...
...
@@ -372,7 +360,7 @@ The main additions in the fifth version of the DETX format is the COMPONENTESTAT
\datafield[int or float]{p_x, p_y, p_z}{The position of the PMT with reference to the UTM coordinate with x (y) defining the relative distance in Easting (Northing) in metres.}
\datafield[int or float]{dx, dy, dz}{The direction where the PMT is pointing at.}
\datafield[int or float]{p_t0}{The calibration time offset which has to be added to the detected hit times.}
\datafield[int]{PMT_STATUS}{MSB: default = 0 means PMT OK for analysis; 1 = PMT NOT OK for analysis; other status flags to be updated}
\datafield[int]{PMT_STATUS}{MSB: default = 0 means PMT OK for analysis; 1 = PMT NOT OK for analysis; other status flags to be updated. The status bit definitions can be found here (updated regularly): \url{https://git.km3net.de/common/km3net-dataformat/-/blob/master/definitions/module_status.csv}}
\end{fieldspecs}
\alertinfo{Within each module section, the PMTs are listed according to an ascending order of their DAQ channel ID, starting at 0.}
The corresponding Google drive document: https://drive.google.com/open?id=0B6l8SNtndcwaUTZPOWZOXzd6R3M
The corresponding Google drive document: \url{https://drive.google.com/open?id=0B6l8SNtndcwaUTZPOWZOXzd6R3M}
\section{UTM Grid}
\label{section:utm_grid}
The KM3NeT coordinate system is proposed in \verb|KM3NeT_SOFT_WD_2016_002|, the reference
point for the ARCA site is defined within the building block one with:
\begin{itemize}
\item UTM reference ellipsoid: WGS84
\item UTM grid zone: 33N (where N is for North\footnote{A note of caution: The method used here simply adds N or S following the zone number to indicate Northern or Southern hemisphere. See \url{https://en.wikipedia.org/wiki/Universal_Transverse_Mercator_coordinate_system\#Notation} for a general discussion on the grid zone notation})
\item The elevation (\verb|UTM_ref_z|) above is the orthometric height calculated relative to the mean sea surface (MSS) as defined by \verb|DTU132|. The see \verb|WGS84| geoid height can be deduced by adding the \verb|EGM96| Geoid height which is \SI{30.9(0.1)}{\meter} at the reference point, as provided by the \verb|NGA EGM96 Geoid Calculator|; the orthometric height of the seafloor at that point is \SI{-3454(1)}{\meter} and the mean for the ARCA building block is \SI{-3452}{\meter}.
