-
Notifications
You must be signed in to change notification settings - Fork 6
Description
Folks,
I've only had time to review the latest draft through the end of section 4 so far (i.e., prior to the Oct 30 meeting), which gets me about halfway through the document pages. I have a fairly extensive list of comments below. Most of them correct typos, or are grammatical updates, wordsmithing, or more precisely making certain statements within the document. However, there are a number of substantive comments included as well. I expect to continue reviewing the current draft from section 5 onwards over the next several days, and will likely have a similar density of comments.
My plan is to collect up all my comments into a single PR and submit that sometime next week.
Thanks,
--Ian
Page 1 - Update Date in Makefile.
Page 1 - Check author list (for example, I believe it should be "C. Boisson").
Page 5 - "It implies" --> "This requires".
Page 5 - Definitions of X-ray and gamm-ray energies are wrong. Change "(from ~0.1 eV to ~100 keV)" --> "(from ~0.1 keV" to 120 keV)" and "(from 100 MeV" --> "(from 120 keV". The soft gamma ray low energy should match the hard X-ray high energy.
Page 5 - "or other messenger" --> "or other messengers".
Page 5 - "(e.g. CIAO" --> "({\em e.g./}, CIAO".
Page 6 - "Universe" --> "universe".
Page 6 - Footnote "One can cite" --> "For example,".
Page 6 - Footnote "As opposed to signal integrating using a light detector." --> "As opposed to signal integrating ({\em e.g./}, using a photon detector).
Page 6 - "astronomical particle" --> "particle from an astrophysical source". Background counts can also have an astrophysical origin.
Page 6 - End of first paragraph, need to change "{\em event list/}." to "{\bf event-list}." or introduce the terminology we use in the document, for example "{\em event list/}, which we term an {\bf event-list} in this document.".
Page 6 - "{\bf event-lists}" --> "{\bf event-list}s" (two locations).
Page 6 - "The mappings between the observables and physical measurements of the source properties are called IRFs\footnote{...}; using techniques like forward-folding, they enable one to fit a model (with any combination of spectral, spatial, and temporal components) of the true flux of particles from a source arriving at the instrument to the measured quantities."
-->
"The mappings between physical measurements of the source properties and the observables are called Instrument Response Functions (IRFs\footnote{...}). Some IRFs are probabilistic in nature\footnote{...}, and in addition may depend on the set of events selected for analysis by the end user. They are usually not invertible, so methods such as forward-folding fitting (using source models with any combination of spectral, spatial, temporal, and/or polarization components that are estimated) are needed to estimate physical properties, such as the true flux of particles from a source arriving at the instrument, given the measured observable quantities.".
Page 6 - Delete "Some of the IRFs are probabilistic ... physical properties given observables.".
Page 6 - "are required to process HEA data" --> "are required to analyze HEA data".
Page 6 - "density funtion" --> "density function.".
Page 7 - "must be be modified" --> "must be modified".
Page 7 - 'are set to "-1"' --> 'set to "-1"; i.e., remove the "are".
Page 7 - "In addition, the hereafter modification proposal faces to the issue that some values of ObsCore attributes (dataproduct_type and calib_level) are defined both into the ObsCore standard document (Louys and Tody et al., 2017) and in the vocabularies documents (Demleitner and Gray et al., 2023, 2021), which might create some issues for the users. In this context, we have opted to propose in this document some modifications of both standards, even if we would have prefered that everything is uniquely defined in the IVOA Vocabulary. Some harmonization should be taken by the Data Model and Semantics working groups in order to avoid duplications. But until such work is achieved, we require modifications in ObsCore and Vocabulary."
-->
"Currently, some ObsCore attributes (dataproduct_type and calib_level) are formally defined in the ObsCore Recommendation Version 1.1 (Louys and Tody et al., 2017) and also in the vocabularies documents (Demleitner and Gray et al., 2023, 2021)\footnote{Primarily the Data Product Type Vocabulary, \url{https://www.ivoa.net/rdf/product_type}}, which may be referenced in future versions of the ObsCore Recommendation. For completeness, we are proposing in this document modifications to both the existing ObsCore Recommendation and IVOA vocabularies."
It's not our place to be telling the DM & Semantics WGs what they should be doing except in the sense of what is needed for HEA data discovery, and is inappropriate in this document.
Page 7 - After the 1st paragraph under 3.1 dataproduct_type, add "The modifications/additions to the set of ObsCore Recommendation Version 1.1 (Louys and Tody et al., 2017) {\em dataproduct_type/} (and, in some cases, {\em dataproduct_subtype/}) terms described herein apply equally to the IVOA Data Product Type Vocabulary, and will therefore be reperated in \S~5.". You want this here so you don't have to restate the same thing for each new dataproduct_type.
Page 8 - "The ObsCore v1.1 recommendation (Louys and Tody et al., 2017) only defines an event dataproduct_type as:" --> "The ObsCore Recommendation Version 1.1 (Louys and Tody et al., 2017) defines an event dataproduct_type as:"; i.e., remove the "only".
Page 8 - "We propose to add the following dataproduct_type term in both the ObsCore standard and into the IVOA Vocabulary of Data Product Types\footnote{...} to better define a HEA event-list and an event-bundle that includes the event-list and its associated data:"
-->
"We propose to add the following dataproduct_type terms to ObsCore to better define a HEA event-list and an event-bundle that includes the event-list and its associated data:"; also here verify that ObsCore is hyphenated correctly if necessary.
Page 8 - 'the term "event"' --> 'the term {\bf event}'.
Page 8 - "(e.g. VOEvent)" --> "({\em e.g./}, VOEvent)".
Page 8 - 'Using "event-list"' --> 'Using {\bf event-list}'.
Page 9 - "{\bf response-functions}" --> "{\bf response-function}s".
Page 10 - '{\bf dataproduct_type} = "measurements"' --> '{\em dataproduct_type/} = {\bf measurements}'.
Page 10 - "together with" --> "{\bf together} with".
Page 10 - Delete "Note that ... sub-section."
Page 10 - "in section 5" --> "in \S~5".
Page 10 - "In X-ray, this is" --> "This is"; doesn't just apply to X-ray - there are gamma-ray missions that are similar because the spacecraft pointing is not constant during the exposure.
Page 11 - "number of HE data products" --> "number of HEA data products".
Page 11 - "(e.g. to the" --> "({\em e.g./}, to the".
Page 11 - "(e.g. response-functions)." --> "({\em e.g./}, {\bf response-function}s).".
Page 11 - "If DataLink is provided, it should be indicated that the URL points to a Datalink service via the access_format = application/x-votable+xml;content=datalink."
-->
"If a DataLink is provided, {\em access_format/} should be set to ``application/x-votable+xml;content=datalink'' to indicate that the URL points to a DataLink service."
Page 11 - "(especially when the tracking is not fixed in the ICRS system)." --> "(especially when not tracking at sidereal rate or for facilities for which the PSF varies strongly across the telescope field of view)."
Page 12 - "), then we recommend" --> "), we recommend" (two locations).
Page 12 - "do not not encode" --> "do not encode".
Page 13 - "), then we recommend" --> "), we recommend".
Page 13 - "o_ucd=pos.eq,time,phys.pulseHeight." --> "{\em o_ucd=pos.eq;time;phys.pulseHeight/}.".
Page 14 - "{\bf event-lists}s table)." --> "{\bf event-lists}'s table).".
Page 14 - "spatial resolution and sky coverage, and spectral resolution, can" --> "spatial resolution, sky coverage, and spectral resolution can".
=Page 16 - "Since HEA telescopes are event-counting instruments, data can be accumulated even if the pointing moves or rotates relative to the sky during an observation. However, they way in which this happens has an impact on how the data are later processed.'
-->
"Since most HEA facilities record the arrival times of particle events, data accumulated when the telescope pointing moves or rotates relative to the sky during an observation can be located on the sky. The way in which the telescope moves may impact how the data should be processed, especially for observations in which multiple different astrophysical sources may be present within the field of view ({\em e.g./}, a solar system target moving relative to the fixed celestial background).".
Page 16 - "what the center of the field-of view moves with during an observation:" --> "the normal motion of the optical axis of the telescope during an observation:".
Page 16 - 'a "drift scan",' --> "a ``drift scan'',".
Page 16 - "fixed to a celestial body position like a planet or moon, or with no particular fixed coordinate system such as data taken when the instrument is slewing (i.e., where the field of view moves with arbitrary direction and speed while the instrument is repositioning)."
-->
"or fixed to a solar system body ({\em e.g./}, the moon, a planet, or a comet) position.".
Page 17 (from LaTeX file) - "To distinguish these, we propose to add an optional attribute {\bf tracking_type}, using the same values as used in \cite{2021ivoa.spec.0724S} ({\em sidereal}, {\em Solar-system-object-tracking}, {\em Fixed-az-el-transit}). Constraints on tracking mode can provide a simple way to discover data sets for a specific facility/instrument combination. We note that permissible {\bf tracking_type} values are possible beyond the predefined values.
-->
"We propose to add an optional attribute {\bf tracking_type} to distinguish these modes. Constraints on {\bf tracking_type} can provide a simple way to discover data sets for a specific facility/instrument combination. We propose predefined {\bf tracking_type} values for \gls{HEA} data include the following:
\begin{itemize}
\item \texttt{sidereal} : observations pointed at a fixed celstial targetlocation on the sky;
\item \texttt{fixed-az-el-transit} : observations fixed at a given elevation and azimuth;
\item \texttt{solar-system-object-tracking} : observations pointed at a moving target, like the moon or other solar system bodies;
\item \texttt{none} : observations with no telescope tracking.
\end{itemize}
We intend that the name of this attribute harmonizes with the name of the similar attribute in the proposed ``IVOA Obscore Extension for Radio Data''\footnote{\url{https://github.com/ivoa-std/ObsCoreExtensionForRadioData}} and note that the first three predefined values for {\bf tracking_type} also harmonize with that proposal. The \texttt{none} {\bf tracking_type} describes observations obtained while the telescope is not tracking ({\em e.g./}, observations obtained while the telescope is slewing). We further note that permissible {\bf tracking_type} values may vary from facility to facility and from instrument to instrument and additional values beyond the predefined values are possible.".
Page 17 (from LaTeX file) - "\subsection{{\em scan_mode}}
As for the radiotelescope arrays, different modes of observation of the sky are possible for \gls{HEA} instrumemts, leading to different instrument responses and special analysis schemes. The proposal of ObsCore Extension For Radio Data\footnote{The current note can be found \href{https://www.ivoa.net/documents/ObsCoreExtensionForRadioData/20240614/index.html}{here}.} proposes to add the field {\bf scan_mode} to qualify this observation property. The values are up to the data providers but pre-defined names are proposed: {\em on-source}, {\em on-off}, {\em raster-map} (that is the grid obervation for \glspl{IACT}), {\em on-the-fly-cross-map} or OTF (when telescopes are slewing between two points of the sky), {\em on-the-fly-map} (that is the wobble observation for \glspl{IACT}). We note that permissible {\bf scan_mode} values are possible beyond the predefined values."
-->
"\subsection{{\em scan_mode}}
Some \gls{HEA} facilities can obtain observations using different spatial scan modes that will affect the content of the observation, leading to different instrument responses and special analysis schemes. We propose to add an optional attribute {\bf scan_mode} to distinguish these modes. Constraints on {\bf scan_mode} can provide a simple way to discover data sets for a specific facility/instrument combination. We propose predefined {\bf scan_mode} values for \gls{HEA} data include the following:
\begin{itemize}
\item \texttt{on-source} : pointed observation;
\item \texttt{on-off} : switched observations between two spatial positions (source and background);
\item \texttt{raster-map} : observations on a predefined spatial mesh (generally regular and rectangular ({\em e.g./}, a grid observation for \glspl{IACT});
\item \texttt{on-the-fly-cross-scan} : observations along a predefined spatial pattern;
\item \texttt{on-the-fly-cross-map} : observations along parallel directions ({\em e.g./}, a wobble observation for \glspl{IACT});
\item \texttt{slew} : observations taken while the telescope is slewing.
\end{itemize}
We intend that the name of this attribute harmonizes with the name of the similar attribute in the proposed ``IVOA Obscore Extension for Radio Data''\footnote{\url{https://github.com/ivoa-std/ObsCoreExtensionForRadioData}} and note that the first five predefined values for {\bf scan_mode} also harmonize with that proposal. The \texttt{slew} {\bf scan_mode} describes observations obtained while the telescope is slewing ({\em, i.e./}, where the field of view moves with arbitrary direction and speed while the instrument is repositioning), which is a mode used extensively by some satellite-based \gls{HEA} facilities. We further note that permissible {\bf scan_mode} values may vary from facility to facility and from instrument to instrument and additional values beyond the predefined values are possible.".
Page 17 (from LaTeX file) -"\subsection{{\em pointing_mode}}
We are proposing for the \gls{HEA} to use the same fields with the same pre-defined values. For arrays of \glspl{IACT}, telescopes may not point all towards the same direction, convergent or divergent pointings may occur. In order to identify such observations, we propose to use the field {\bf pointing_mode}, with a default value of NULL'' to handle \gls{WCD} and neutrino instruments, and with possible values of {\em parallel}, {\em convergent} and {\em divergent}. Data providers are free to use additional values. For example, if a reference angle is used for a convergent pointing, a provider can use a value like convergent-5d''."
-->
"\subsection{{\em pointing_mode}}
Some \gls{HEA} facilities can obtain observations using multiple telescope simultaneously with the individual telescopes pointing in slightly different directions. For example, for the \glspl{IACT} telescope array, the individual telescope pointings may be in the same direction, convergent, or divergent. We propose to add an optional attribute {\bf pointing_mode}, with a default value of NULL'' to handle \gls{WCD} and neutrino instruments, to distinguish these modes. Constraints on {\bf pointing\_mode} can provide a simple way to discover data sets for a specific facility/instrument combination. We propose predefined {\bf spointing\_mode} values for \gls{HEA} data include the following: \begin{itemize} \item \texttt{parallel} : the telescopes are all pointing in the same direction; \item \texttt{convergent\[-ang\]} : the telescope pointings are convergent; \item \texttt{divergent\[-ang\]} : the telescope pointings are divergent. \end{itemize} The optional suffix [ang]'' specifies a reference angle for a convergent or divergent pointing, for example ``convergent-5d''. We note that permissible {\bf pointing_mode} values may vary from facility to facility and from instrument to instrument.".
Page 17 - "event partitioning based on a data analyis quality" --> "event partitioning, typically based on a data analyis quality".
Page 17 - "It will allow" --> "This attribute will allow".
Page 18 (from LaTeX file) - "Like for the ObsCore Recommandations, it is allowed to add any additional columns that a data provider aims to add. We recommand to add \gls{HEA} extra-columns into the \gls{HEA} Obscore Extension table, and not into the ObsCore table, for coherence purposes."
-->
"Similar to the ObsCore Recommendation, service providers may include additional columns to the ObsCore \gls{HEA} Extension table to expose additional metadata. While the service provider may choose to add additional columns to either the main ObsCore table or the ObsCore \gls{HEA} Extension table, we recommend that \gls{HEA}-data specific metadata columns be added to the ObsCore \gls{HEA} Extension table.".
Throughout - Proper names like "Chandra" need to be reresented consistently. Currently, they are represented differently throughout the text (in some cases {\em Chandra/} but in other cases {\rm Chandra}).