Skip to content
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions doc/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ DOCNAME = MANGO
DOCVERSION = 0.1

# Publication date, ISO format; update manually for "releases"
DOCDATE = 2025-05-19
DOCDATE = 2025-05-27

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

# An e-mail address of the person doing the submission to the document
# repository (can be empty until a make upload is being made)
Expand Down
6 changes: 3 additions & 3 deletions doc/ivoatexmeta.tex
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
% GENERATED FILE -- edit this in the Makefile
\newcommand{\ivoaDocversion}{0.1}
\newcommand{\ivoaDocdate}{2025-05-19}
\newcommand{\ivoaDocdatecode}{20250519}
\newcommand{\ivoaDoctype}{WD}
\newcommand{\ivoaDocdate}{2025-05-27}
\newcommand{\ivoaDocdatecode}{20250527}
\newcommand{\ivoaDoctype}{PR}
\newcommand{\ivoaDocname}{MANGO}
\renewcommand{\ivoaBaseURL}{https://www.ivoa.net/documents/MANGO}
Empty file added doc/mango.latex
Empty file.
58 changes: 51 additions & 7 deletions doc/model.tex
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ \section{Model: mango }

\subsection{Brightness}
\label{sect:Brightness}
Observed brightness of the \texttt{MangoObject}. The distinction between fluxes and magnitudes is made by the unit. This property should refer to a photometric calibration as defined by the \texttt{Phot} data model (1.1).
Observed brightness of the \texttt{MangoObject}. The purpose of this property is to gather a brightness value with its error and the its photometric calibration The distinction between fluxes and magnitudes is made by the unit. The photometric calibration is modeled by the \texttt{Phot} data model (1.1).

\subsubsection{Brightness.value}
\textbf{vodml-id: Brightness.value} \newline
Expand All @@ -86,7 +86,7 @@ \section{Model: mango }

\subsection{Color}
\label{sect:Color}
Property that describes a color of the \texttt{MangoObject}. The color is not an intrinsic property of the MANGO object, but a value relative to two filters or energy bands.
Property that describes a color of the \texttt{MangoObject}. The purpose of this property is to gather a color value with its error and the 2 related filters (high and low) The color can be given as a magnitude difference or an hardness ratio.

\subsubsection{Color.value}
\textbf{vodml-id: Color.value} \newline
Expand Down Expand Up @@ -181,20 +181,36 @@ \section{Model: mango }
\end{figure}



\begin{figure}[h]
\includegraphics[width=1.0\textwidth]{../model/EpochPosition.png}
\caption{Class EpochPosition}
\label{fig:EpochPosition}
\end{figure}



\begin{figure}[h]
\includegraphics[width=1.0\textwidth]{../model/EpochPosition.png}
\caption{Class EpochPosition}
\label{fig:EpochPosition}
\end{figure}


\label{sect:EpochPosition}
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} 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}

\subsubsection{EpochPosition.longitude}
\textbf{vodml-id: EpochPosition.longitude} \newline
\textbf{type: \hyperref[sect:ivoa]{ivoa:RealQuantity}} \newline
\textbf{multiplicity: 1} \newline
The longitude of the Point, as a Quantity with angular units (see \texttt{coords:LonLatPoint.lon}.
This parameter is a clone of the \texttt{coords:LonLatPoint.lat} component of \texttt{meas:Position} but applied to the \texttt{mango:EpochPosition} context. It matches the description given by \texttt{coords} data model: The longitude of the Point, as a Quantity with angular units (see \texttt{coords:LonLatPoint.lon}.

\subsubsection{EpochPosition.latitude}
\textbf{vodml-id: EpochPosition.latitude} \newline
\textbf{type: \hyperref[sect:ivoa]{ivoa:RealQuantity}} \newline
\textbf{multiplicity: 1} \newline
The latitude of the Point, as a Quantity with angular units (see \texttt{coords:LonLatPoint.lat}.
This parameter is a clone of the \texttt{coords:LonLatPoint.lat} component of \texttt{meas:Position} but applied to the \texttt{mango:EpochPosition} context. It matches the description given by \texttt{coords} data model: The latitude of the Point, as a Quantity with angular units (see \texttt{coords:LonLatPoint.lon}).

\subsubsection{EpochPosition.parallax}
\textbf{vodml-id: EpochPosition.parallax} \newline
Expand All @@ -206,19 +222,19 @@ \section{Model: mango }
\textbf{vodml-id: EpochPosition.radialVelocity} \newline
\textbf{type: \hyperref[sect:ivoa]{ivoa:RealQuantity}} \newline
\textbf{multiplicity: 1} \newline
The measured Velocity along of the radius axis (see \texttt{meas:Velocity.coord} in \cite{2022ivoa.spec.1004R}).
This parameter is a clone of the \texttt{coords:Coords.point} component of \texttt{meas:Velocity} but applied to the \texttt{mango:EpochPosition} context. It matches the description given by the \texttt{coords} data model: The measured Velocity along of the radial axis (see \texttt{meas:Velocity.coord} in \cite{2022ivoa.spec.1004R}).

\subsubsection{EpochPosition.pmLongitude}
\textbf{vodml-id: EpochPosition.pmLongitude} \newline
\textbf{type: \hyperref[sect:ivoa]{ivoa:RealQuantity}} \newline
\textbf{multiplicity: 1} \newline
Velocity along the longitude axis in angular distance per unit time (see \texttt{meas:ProperMotion.coord}).
This parameter is a clone of the \texttt{coords:LonLatPoint.lon} component of \texttt{meas:ProperMotion} but applied to the \texttt{mango:EpochPosition} context. It matches the description given by \texttt{coords} data model: Velocity along the longitude axis in angular distance per unit time (see \texttt{meas:ProperMotion.coord}).

\subsubsection{EpochPosition.pmLatitude}
\textbf{vodml-id: EpochPosition.pmLatitude} \newline
\textbf{type: \hyperref[sect:ivoa]{ivoa:RealQuantity}} \newline
\textbf{multiplicity: 1} \newline
Velocity along the latitude axis in angular distance per unit time (see \texttt{meas:ProperMotion.coord}).
This parameter is a clone of the \texttt{coords:LonLatPoint.lat} component of \texttt{meas:ProperMotion} but applied to the \texttt{mango:EpochPosition} context. It matches the description given by \texttt{coords} data model: Velocity along the latitude axis in angular distance per unit time (see \texttt{meas:ProperMotion.coord}).

\subsubsection{EpochPosition.obsDate}
\textbf{vodml-id: EpochPosition.obsDate} \newline
Expand Down Expand Up @@ -562,6 +578,20 @@ \section{Package: error }
\end{figure}


\begin{figure}[h]
\includegraphics[width=1.0\textwidth]{../model/error.png}
\caption{package error}
\label{fig:error}
\end{figure}


\begin{figure}[h]
\includegraphics[width=1.0\textwidth]{../model/error.png}
\caption{package error}
\label{fig:error}
\end{figure}



% INSERT FIGURE HERE
%\begin{figure}[h]
Expand Down Expand Up @@ -662,6 +692,20 @@ \section{Package: origin }
\end{figure}


\begin{figure}[h]
\includegraphics[width=1.0\textwidth]{../model/origin.png}
\caption{package origin}
\label{fig:origin}
\end{figure}


\begin{figure}[h]
\includegraphics[width=1.0\textwidth]{../model/origin.png}
\caption{package origin}
\label{fig:origin}
\end{figure}



% INSERT FIGURE HERE
%\begin{figure}[h]
Expand Down
44 changes: 37 additions & 7 deletions doc/model_toc.tex
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,16 @@ \section{Epoch Position Properties}
in order to facilitate the annotation process and the job of the clients
that have to interpret them.
\subsection{EpochPosition}
\begin{figure}[h]
\includegraphics[width=1.0\textwidth]{../model/EpochPosition.png}
\caption{Class EpochPosition}
\label{fig:EpochPosition}
\end{figure}
\begin{figure}[h]
\includegraphics[width=1.0\textwidth]{../model/EpochPosition.png}
\caption{Class EpochPosition}
\label{fig:EpochPosition}
\end{figure}
\begin{figure}[h]
\includegraphics[width=1.0\textwidth]{../model/EpochPosition.png}
\caption{Class EpochPosition}
Expand All @@ -122,13 +132,13 @@ \section{Epoch Position Properties}
\textbf{vodml-id: EpochPosition.longitude} \newline
\textbf{type: \hyperref[sect:ivoa]{ivoa:RealQuantity}} \newline
\textbf{multiplicity: 1} \newline
The longitude of the Point, as a Quantity with angular units (see \texttt{coords:LonLatPoint.lon}.
This parameter is a clone of the \texttt{coords:LonLatPoint.lat} component of \texttt{meas:Position} but applied to the \texttt{mango:EpochPosition} context. It matches the description given by \texttt{coords} data model: The longitude of the Point, as a Quantity with angular units (see \texttt{coords:LonLatPoint.lon}.

\subsubsection{EpochPosition.latitude}
\textbf{vodml-id: EpochPosition.latitude} \newline
\textbf{type: \hyperref[sect:ivoa]{ivoa:RealQuantity}} \newline
\textbf{multiplicity: 1} \newline
The latitude of the Point, as a Quantity with angular units (see \texttt{coords:LonLatPoint.lat}.
This parameter is a clone of the \texttt{coords:LonLatPoint.lat} component of \texttt{meas:Position} but applied to the \texttt{mango:EpochPosition} context. It matches the description given by \texttt{coords} data model: The latitude of the Point, as a Quantity with angular units (see \texttt{coords:LonLatPoint.lon}).

\subsubsection{EpochPosition.parallax}
\textbf{vodml-id: EpochPosition.parallax} \newline
Expand All @@ -140,19 +150,19 @@ \section{Epoch Position Properties}
\textbf{vodml-id: EpochPosition.radialVelocity} \newline
\textbf{type: \hyperref[sect:ivoa]{ivoa:RealQuantity}} \newline
\textbf{multiplicity: 1} \newline
The measured Velocity along of the radius axis (see \texttt{meas:Velocity.coord} in \cite{2022ivoa.spec.1004R}).
This parameter is a clone of the \texttt{coords:Coords.point} component of \texttt{meas:Velocity} but applied to the \texttt{mango:EpochPosition} context. It matches the description given by the \texttt{coords} data model: The measured Velocity along of the radial axis (see \texttt{meas:Velocity.coord} in \cite{2022ivoa.spec.1004R}).

\subsubsection{EpochPosition.pmLongitude}
\textbf{vodml-id: EpochPosition.pmLongitude} \newline
\textbf{type: \hyperref[sect:ivoa]{ivoa:RealQuantity}} \newline
\textbf{multiplicity: 1} \newline
Velocity along the longitude axis in angular distance per unit time (see \texttt{meas:ProperMotion.coord}).
This parameter is a clone of the \texttt{coords:LonLatPoint.lon} component of \texttt{meas:ProperMotion} but applied to the \texttt{mango:EpochPosition} context. It matches the description given by \texttt{coords} data model: Velocity along the longitude axis in angular distance per unit time (see \texttt{meas:ProperMotion.coord}).

\subsubsection{EpochPosition.pmLatitude}
\textbf{vodml-id: EpochPosition.pmLatitude} \newline
\textbf{type: \hyperref[sect:ivoa]{ivoa:RealQuantity}} \newline
\textbf{multiplicity: 1} \newline
Velocity along the latitude axis in angular distance per unit time (see \texttt{meas:ProperMotion.coord}).
This parameter is a clone of the \texttt{coords:LonLatPoint.lat} component of \texttt{meas:ProperMotion} but applied to the \texttt{mango:EpochPosition} context. It matches the description given by \texttt{coords} data model: Velocity along the latitude axis in angular distance per unit time (see \texttt{meas:ProperMotion.coord}).

\subsubsection{EpochPosition.obsDate}
\textbf{vodml-id: EpochPosition.obsDate} \newline
Expand Down Expand Up @@ -312,7 +322,7 @@ \section{Photometric Properties}

\subsection{Brightness}
\label{sect:Brightness}
Observed brightness of the \texttt{MangoObject}. The distinction between fluxes and magnitudes is made by the unit. This property should refer to a photometric calibration as defined by the \texttt{Phot} data model (1.1).
Observed brightness of the \texttt{MangoObject}. The purpose of this property is to gather a brightness value with its error and the its photometric calibration The distinction between fluxes and magnitudes is made by the unit. The photometric calibration is modeled by the \texttt{Phot} data model (1.1).

\subsubsection{Brightness.value}
\textbf{vodml-id: Brightness.value} \newline
Expand All @@ -334,7 +344,7 @@ \section{Photometric Properties}

\subsection{Color}
\label{sect:Color}
Property that describes a color of the \texttt{MangoObject}. The color is not an intrinsic property of the MANGO object, but a value relative to two filters or energy bands.
Property that describes a color of the \texttt{MangoObject}. The purpose of this property is to gather a color value with its error and the 2 related filters (high and low) The color can be given as a magnitude difference or an hardness ratio.

\subsubsection{Color.value}
\textbf{vodml-id: Color.value} \newline
Expand Down Expand Up @@ -541,6 +551,16 @@ \section{Other Properties}
\normalsize

\section{Package: error}
\begin{figure}[h]
\includegraphics[width=1.0\textwidth]{../model/error.png}
\caption{package error}
\label{fig:error}
\end{figure}
\begin{figure}[h]
\includegraphics[width=1.0\textwidth]{../model/error.png}
\caption{package error}
\label{fig:error}
\end{figure}
\begin{figure}[h]
\includegraphics[width=1.0\textwidth]{../model/error.png}
\caption{package error}
Expand Down Expand Up @@ -629,6 +649,16 @@ \section{Package: error}
Error on the second dimension (declination in case of sky coordinates)

\section{Package: origin}
\begin{figure}[h]
\includegraphics[width=1.0\textwidth]{../model/origin.png}
\caption{package origin}
\label{fig:origin}
\end{figure}
\begin{figure}[h]
\includegraphics[width=1.0\textwidth]{../model/origin.png}
\caption{package origin}
\label{fig:origin}
\end{figure}
\begin{figure}[h]
\includegraphics[width=1.0\textwidth]{../model/origin.png}
\caption{package origin}
Expand Down
3 changes: 2 additions & 1 deletion mivot/mango/mango.Brightness.xml
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
<INSTANCE dmrole="" dmtype="mango:Brightness">
<!-- Observed brightness of the \texttt{MangoObject}.
The purpose of this property is to gather a brightness value with its error and the its photometric calibration
The distinction between fluxes and magnitudes is made by the unit.
This property should refer to a photometric calibration as defined by the \texttt{Phot} data model (1.1)." -->
The photometric calibration is modeled by the \texttt{Phot} data model (1.1)." -->
<INSTANCE dmrole="mango:Property.semantics" dmtype="mango:VocabularyTerm">
<!-- Class holder for a term of a standardized vocabulary that applies to a property." -->
<ATTRIBUTE dmrole="mango:VocabularyTerm.uri" dmtype="ivoa:string" ref="@@@@@" value=""/>
Expand Down
4 changes: 2 additions & 2 deletions mivot/mango/mango.Color.xml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<INSTANCE dmrole="" dmtype="mango:Color">
<!-- Property that describes a color of the \texttt{MangoObject}.
The color is not an intrinsic property of the MANGO object,
but a value relative to two filters or energy bands.
The purpose of this property is to gather a color value with its error and the 2 related filters (high and low)
The color can be given as a magnitude difference or an hardness ratio.
" -->
<INSTANCE dmrole="mango:Property.semantics" dmtype="mango:VocabularyTerm">
<!-- Class holder for a term of a standardized vocabulary that applies to a property." -->
Expand Down
12 changes: 12 additions & 0 deletions mivot/mango/mango.EpochPosition.xml
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,18 @@ All components use the same coordinate systems for both time and space coordinat
\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.


All components have their own units which must be consistent with each other.
This consistency is not enforced by the model.

Expand Down
Loading