Skip to content

Commit 004df90

Browse files
authored
Merge pull request #113 from lmichel/final-review
Final review
2 parents ac3251c + 4019236 commit 004df90

23 files changed

Lines changed: 404 additions & 418 deletions

.github/workflows/preview.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ env:
1616
on:
1717
push:
1818
branches:
19-
- brigita_review
19+
- final-review
2020
- pr-1.0
2121

2222
jobs:

doc/MANGO.tex

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -252,11 +252,11 @@ \section{Model Overview}
252252
Identifiers should be unique within a collection, e.g. a data table, although
253253
this feature is not required by the model.
254254

255-
In addition to its identifier, \texttt{MangoObject} objects have 2 components:
255+
In addition to their identifier, \texttt{MangoObject} objects have 2 elements :
256256

257257
\begin{itemize}[noitemsep,topsep=0pt,parsep=0pt,partopsep=0pt]
258258

259-
\item \texttt{queryOrigin} (origin of the \texttt{MangoObject}) : The structure of this class is based on
259+
\item \texttt{queryOrigin} (reference to the origin of the \texttt{MangoObject}) : The structure of this class is based on
260260
the recommendations of the DCP interest group \footnote{https://ivoa.net/documents/DataOrigin/index.html}.
261261
\item \texttt{propertyDock} (place holder for all the \texttt{MangoObject} properties) :
262262
This is an open-ended collection.

doc/Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ DOCNAME = MANGO
77
DOCVERSION = 1.0
88

99
# Publication date, ISO format; update manually for "releases"
10-
DOCDATE = 2026-02-26
10+
DOCDATE = 2026-03-05
1111

1212
# What is it you're writing: NOTE, WD, PR, REC, PEN, or EN
1313
DOCTYPE = PR

doc/ivoatexmeta.tex

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
% GENERATED FILE -- edit this in the Makefile
22
\newcommand{\ivoaDocversion}{1.0}
3-
\newcommand{\ivoaDocdate}{2026-02-26}
4-
\newcommand{\ivoaDocdatecode}{20260226}
3+
\newcommand{\ivoaDocdate}{2026-03-05}
4+
\newcommand{\ivoaDocdatecode}{20260305}
55
\newcommand{\ivoaDoctype}{PR}
66
\newcommand{\ivoaDocname}{MANGO}
77
\renewcommand{\ivoaBaseURL}{https://www.ivoa.net/documents/MANGO}

doc/model.tex

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,7 @@ \section{Model: mango }
178178

179179

180180
\label{sect:EpochPosition}
181-
This class (fig \ref{fig:EpochPosition}) is a flattened view of objects/concepts from the Astronomical Measurements Model \citep{2022ivoa.specQ1004R} that have been put together to form a consistent description of the position of an object moving over time. It consists of a celestial position, a proper motion, a radial velocity and a parallax and their associated errors encapsulated into the \texttt{EpochPositionErrors} class. The values of these properties are pulled from the underlying Astronomical Coordinates and Coordinate Systems model \citep{2022ivoa.spec.1004R}. At a high level the properties map as follows: \begin{itemize} \item celestial position -> \texttt{meas:Position} \item proper motion -> \texttt{meas:ProperMotion} \item radial velocity -> \texttt{meas.Velocity} \item parallax -> no suitable counterpart at this time \end{itemize} All components use the same coordinate systems for both time and space coordinates. \begin{itemize} \item Both position and proper motion reuse \texttt{coords:LonLatPoint} elements. \item The space coordinate system is imported from \texttt{coords:SpaceSys}. \item The time coordinate system is imported from \texttt{coords:TimeSys}. \end{itemize} It is recommended to use the \texttt{ObsDate} field to store the epoch of the observation instead of the \texttt{epoch} field of \texttt{coords:SpaceSys}. There are 2 reasons for this: \begin{itemize} \item Using the epoch of \texttt{coords:SpaceSys} requires to work with the \texttt{coords:CustomRefLocation} class to carry the reference location. This class does not support the standard reference locations such as e.g. BARYCENTER. \item The observation date can be read in a column and therefore change with each data row. In this case, it cannot be stored as an element of the space coordinate system but as an \texttt{EpochPosition} attribute. \end{itemize} All components have their own units which must be consistent with each other. This consistency is not enforced by the model. Possible correlations between \texttt{EpochPosition} parameters are handled by the \texttt{EpochPositionCorrelations} class. Errors along the different axes are grouped in the \texttt{EpochPositionErrors} class. In some cases the errors might conflict with the correlations: \begin{itemize} \item \texttt{Ellipse} errors on position or proper motion must not be used together with the \texttt{longitudeLatitude} (or \texttt{pmLongitudePmLatitude}) correlation fields. In fact, using elliptical errors implies a correlation between the two spatial axes which must not conflict with the correlations defined in \texttt{EpochPositionCorrelations}. \end{itemize}
181+
This class (fig \ref{fig:EpochPosition}) is a flattened view of objects/concepts from the Astronomical Measurements Model \citep{2022ivoa.specQ1004R} that have been put together to form a consistent description of the position of an object moving over time. It consists of a celestial position, a proper motion, a radial velocity and a parallax and their associated errors encapsulated into the \texttt{EpochPositionErrors} class. The values of these properties are pulled from the underlying Astronomical Coordinates and Coordinate Systems model \citep{2022ivoa.spec.1004R}. At a high level the properties map as follows: \begin{itemize} \item celestial position -> \texttt{meas:Position} \item proper motion -> \texttt{meas:ProperMotion} \item radial velocity -> \texttt{meas.Velocity} \item parallax -> no suitable counterpart at this time \end{itemize} All components use the same coordinate systems for both time and space coordinates. \begin{itemize} \item Both position and proper motion reuse \texttt{coords:LonLatPoint} elements. \item The space coordinate system is imported from \texttt{coords:SpaceSys}. \item The time coordinate system is imported from \texttt{coords:TimeSys}. \end{itemize} It is recommended to use the \texttt{obsDate} field to store the epoch of the observation instead of the \texttt{epoch} field of \texttt{coords:SpaceSys}. There are 2 reasons for this: \begin{itemize} \item The epoch of \texttt{coords:SpaceSys} is for the epoch of the reference location position, not for the measurement epoch. \item The observation date can be read in a column and therefore change with each data row. In this case, it cannot be stored as an element of the space coordinate system but as an \texttt{EpochPosition} attribute. \end{itemize} All components have their own units which must be consistent with each other. This consistency is not enforced by the model. Possible correlations between \texttt{EpochPosition} parameters are handled by the \texttt{EpochPositionCorrelations} class. Errors along the different axes are grouped in the \texttt{EpochPositionErrors} class. In some cases the errors might conflict with the correlations: \begin{itemize} \item \texttt{Ellipse} errors on position or proper motion must not be used together with the \texttt{longitudeLatitude} (or \texttt{pmLongitudePmLatitude}) correlation fields. In fact, using elliptical errors implies a correlation between the two spatial axes which must not conflict with the correlations defined in \texttt{EpochPositionCorrelations}. \end{itemize}
182182

183183
\subsubsection{EpochPosition.longitude}
184184
\textbf{vodml-id: EpochPosition.longitude} \newline
@@ -220,7 +220,7 @@ \section{Model: mango }
220220
\textbf{vodml-id: EpochPosition.obsDate} \newline
221221
\textbf{type: \hyperref[sect:ivoa]{ivoa:datetime}} \newline
222222
\textbf{multiplicity: 1} \newline
223-
Observation date expressed within the common time system if present. This attribute, if set, supersedes the epoch possibly given with the spatial coordinate system (see the above). Figure \ref{datetime} shows up the hierarchy of the primitive types representing the observation dates.
223+
Observation date expressed within the common time system if present. Figure \ref{datetime} shows up the hierarchy of the primitive types representing the observation dates.
224224

225225
\subsubsection{EpochPosition.pmCosLatApplied}
226226
\textbf{vodml-id: EpochPosition.pmCosLatApplied} \newline
@@ -402,13 +402,13 @@ \section{Model: mango }
402402
\textbf{vodml-id: MangoObject.mangoObjects} \newline
403403
\textbf{type: \hyperref[sect:AssociatedMangoObject]{mango:AssociatedMangoObject}} \newline
404404
\textbf{multiplicity: 0..*} \newline
405-
Reference to particular datasets (\texttt{mango:MangoObject} instances) that are associated with the MANGO object via \texttt{mango:AssociatedMangoObject} instances.
405+
Collection of particular datasets (\texttt{mango:MangoObject} instances) that are associated with the MANGO object via \texttt{mango:AssociatedMangoObject} instances.
406406

407407
\subsubsection{MangoObject.queryOrigin}
408408
\textbf{vodml-id: MangoObject.queryOrigin} \newline
409409
\textbf{type: \hyperref[sect:origin.QueryOrigin]{mango:origin.QueryOrigin}} \newline
410410
\textbf{multiplicity: 0..1} \newline
411-
Reference to the description of the origin of the \texttt{MangoObject}.
411+
Reference to the description of the origin of the dataset to which the \texttt{MangoObject} belongs.
412412

413413
\subsection{PhysicalProperty}
414414
\label{sect:PhysicalProperty}
@@ -586,7 +586,7 @@ \section{Package: error }
586586
%\end{center}
587587
%\end{figure}
588588

589-
The \texttt{error} package (fig \ref{fig:error}) groups the MANGO built-in error classes. All these classes are derived from \texttt{meas:Uncertainty} to make them reusable by \texttt{meas:Measure} instances. Mango errors all have an attribute that specifies the confidence level.
589+
The \texttt{error} package (fig \ref{fig:error}) groups the MANGO built-in error classes. Mango errors all have an attribute that specifies the confidence level.
590590

591591
\subsection{PErrorAsym1D}
592592
\label{sect:error.PErrorAsym1D}
@@ -654,7 +654,7 @@ \section{Package: error }
654654

655655
\subsection{PropertyError (Abstract)}
656656
\label{sect:error.PropertyError}
657-
Root (abstract) class of the errors that can be attached to a MANGO property. The class inherits from \texttt{meas:uncertainty} in order to be usable in the context of properties based on \texttt{Measures} classes.
657+
Root (abstract) class of the errors that can be attached to a MANGO property.
658658

659659
\subsubsection{PropertyError.confidenceLevel}
660660
\textbf{vodml-id: error.PropertyError.confidenceLevel} \newline

doc/model_toc.tex

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,13 @@ \section{Model: mango}
2323
\textbf{vodml-id: MangoObject.mangoObjects} \newline
2424
\textbf{type: \hyperref[sect:AssociatedMangoObject]{mango:AssociatedMangoObject}} \newline
2525
\textbf{multiplicity: 0..*} \newline
26-
Reference to particular datasets (\texttt{mango:MangoObject} instances) that are associated with the MANGO object via \texttt{mango:AssociatedMangoObject} instances.
26+
Collection of particular datasets (\texttt{mango:MangoObject} instances) that are associated with the MANGO object via \texttt{mango:AssociatedMangoObject} instances.
2727

2828
\subsubsection{MangoObject.queryOrigin}
2929
\textbf{vodml-id: MangoObject.queryOrigin} \newline
3030
\textbf{type: \hyperref[sect:origin.QueryOrigin]{mango:origin.QueryOrigin}} \newline
3131
\textbf{multiplicity: 0..1} \newline
32-
Reference to the description of the origin of the \texttt{MangoObject}.
32+
Reference to the description of the origin of the dataset to which the \texttt{MangoObject} belongs.
3333

3434
\subsection{AssociatedMangoObject}
3535
\label{sect:AssociatedMangoObject}
@@ -133,7 +133,7 @@ \section{Epoch Position Properties}
133133
\label{fig:EpochPosition}
134134
\end{figure}
135135
\label{sect:EpochPosition}
136-
This class (fig \ref{fig:EpochPosition}) is a flattened view of objects/concepts from the Astronomical Measurements Model \citep{2022ivoa.specQ1004R} that have been put together to form a consistent description of the position of an object moving over time. It consists of a celestial position, a proper motion, a radial velocity and a parallax and their associated errors encapsulated into the \texttt{EpochPositionErrors} class. The values of these properties are pulled from the underlying Astronomical Coordinates and Coordinate Systems model \citep{2022ivoa.spec.1004R}. At a high level the properties map as follows: \begin{itemize} \item celestial position -> \texttt{meas:Position} \item proper motion -> \texttt{meas:ProperMotion} \item radial velocity -> \texttt{meas.Velocity} \item parallax -> no suitable counterpart at this time \end{itemize} All components use the same coordinate systems for both time and space coordinates. \begin{itemize} \item Both position and proper motion reuse \texttt{coords:LonLatPoint} elements. \item The space coordinate system is imported from \texttt{coords:SpaceSys}. \item The time coordinate system is imported from \texttt{coords:TimeSys}. \end{itemize} It is recommended to use the \texttt{ObsDate} field to store the epoch of the observation instead of the \texttt{epoch} field of \texttt{coords:SpaceSys}. There are 2 reasons for this: \begin{itemize} \item Using the epoch of \texttt{coords:SpaceSys} requires to work with the \texttt{coords:CustomRefLocation} class to carry the reference location. This class does not support the standard reference locations such as e.g. BARYCENTER. \item The observation date can be read in a column and therefore change with each data row. In this case, it cannot be stored as an element of the space coordinate system but as an \texttt{EpochPosition} attribute. \end{itemize} All components have their own units which must be consistent with each other. This consistency is not enforced by the model. Possible correlations between \texttt{EpochPosition} parameters are handled by the \texttt{EpochPositionCorrelations} class. Errors along the different axes are grouped in the \texttt{EpochPositionErrors} class. In some cases the errors might conflict with the correlations: \begin{itemize} \item \texttt{Ellipse} errors on position or proper motion must not be used together with the \texttt{longitudeLatitude} (or \texttt{pmLongitudePmLatitude}) correlation fields. In fact, using elliptical errors implies a correlation between the two spatial axes which must not conflict with the correlations defined in \texttt{EpochPositionCorrelations}. \end{itemize}
136+
This class (fig \ref{fig:EpochPosition}) is a flattened view of objects/concepts from the Astronomical Measurements Model \citep{2022ivoa.specQ1004R} that have been put together to form a consistent description of the position of an object moving over time. It consists of a celestial position, a proper motion, a radial velocity and a parallax and their associated errors encapsulated into the \texttt{EpochPositionErrors} class. The values of these properties are pulled from the underlying Astronomical Coordinates and Coordinate Systems model \citep{2022ivoa.spec.1004R}. At a high level the properties map as follows: \begin{itemize} \item celestial position -> \texttt{meas:Position} \item proper motion -> \texttt{meas:ProperMotion} \item radial velocity -> \texttt{meas.Velocity} \item parallax -> no suitable counterpart at this time \end{itemize} All components use the same coordinate systems for both time and space coordinates. \begin{itemize} \item Both position and proper motion reuse \texttt{coords:LonLatPoint} elements. \item The space coordinate system is imported from \texttt{coords:SpaceSys}. \item The time coordinate system is imported from \texttt{coords:TimeSys}. \end{itemize} It is recommended to use the \texttt{obsDate} field to store the epoch of the observation instead of the \texttt{epoch} field of \texttt{coords:SpaceSys}. There are 2 reasons for this: \begin{itemize} \item The epoch of \texttt{coords:SpaceSys} is for the epoch of the reference location position, not for the measurement epoch. \item The observation date can be read in a column and therefore change with each data row. In this case, it cannot be stored as an element of the space coordinate system but as an \texttt{EpochPosition} attribute. \end{itemize} All components have their own units which must be consistent with each other. This consistency is not enforced by the model. Possible correlations between \texttt{EpochPosition} parameters are handled by the \texttt{EpochPositionCorrelations} class. Errors along the different axes are grouped in the \texttt{EpochPositionErrors} class. In some cases the errors might conflict with the correlations: \begin{itemize} \item \texttt{Ellipse} errors on position or proper motion must not be used together with the \texttt{longitudeLatitude} (or \texttt{pmLongitudePmLatitude}) correlation fields. In fact, using elliptical errors implies a correlation between the two spatial axes which must not conflict with the correlations defined in \texttt{EpochPositionCorrelations}. \end{itemize}
137137

138138
\subsubsection{EpochPosition.longitude}
139139
\textbf{vodml-id: EpochPosition.longitude} \newline
@@ -175,7 +175,7 @@ \section{Epoch Position Properties}
175175
\textbf{vodml-id: EpochPosition.obsDate} \newline
176176
\textbf{type: \hyperref[sect:ivoa]{ivoa:datetime}} \newline
177177
\textbf{multiplicity: 1} \newline
178-
Observation date expressed within the common time system if present. This attribute, if set, supersedes the epoch possibly given with the spatial coordinate system (see the above). Figure \ref{datetime} shows up the hierarchy of the primitive types representing the observation dates.
178+
Observation date expressed within the common time system if present. Figure \ref{datetime} shows up the hierarchy of the primitive types representing the observation dates.
179179

180180
\subsubsection{EpochPosition.pmCosLatApplied}
181181
\textbf{vodml-id: EpochPosition.pmCosLatApplied} \newline
@@ -514,11 +514,11 @@ \section{Package: error}
514514
\caption{error package}
515515
\label{fig:error}
516516
\end{figure}
517-
The \texttt{error} package (fig \ref{fig:error}) groups the MANGO built-in error classes. All these classes are derived from \texttt{meas:Uncertainty} to make them reusable by \texttt{meas:Measure} instances. Mango errors all have an attribute that specifies the confidence level.
517+
The \texttt{error} package (fig \ref{fig:error}) groups the MANGO built-in error classes. Mango errors all have an attribute that specifies the confidence level.
518518

519519
\subsection{PropertyError (Abstract)}
520520
\label{sect:error.PropertyError}
521-
Root (abstract) class of the errors that can be attached to a MANGO property. The class inherits from \texttt{meas:uncertainty} in order to be usable in the context of properties based on \texttt{Measures} classes.
521+
Root (abstract) class of the errors that can be attached to a MANGO property.
522522

523523
\subsubsection{PropertyError.confidenceLevel}
524524
\textbf{vodml-id: error.PropertyError.confidenceLevel} \newline

doc/usecases.tex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@ \subsubsection{Client Use-cases}
199199
\item does this table contain sky positions, or HEALPix tiles, or both?
200200
What's the best way to represent it on the sky?
201201

202-
\item what is the meaning of such URL found out in a tables?
202+
\item what is the meaning of the URL stored in a table column?
203203
\end{itemize}
204204

205205
But there are some other cases like:

model/EpochPosition.png

1.5 KB
Loading

model/error.png

2.08 KB
Loading

0 commit comments

Comments
 (0)