Skip to content

Update model_toc.tex #107

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
SebastienDerriere wants to merge 1 commit into from
Closed

Update model_toc.tex #107

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
40 changes: 20 additions & 20 deletions doc/model_toc.tex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,13 +83,13 @@ \section{Model: mango}
\textbf{vodml-id: VocabularyTerm.uri} \newline
\textbf{type: \hyperref[sect:ivoa]{ivoa:string}} \newline
\textbf{multiplicity: 1} \newline
URI the vocabulary term
URI of the vocabulary term

\subsubsection{VocabularyTerm.label}
\textbf{vodml-id: VocabularyTerm.label} \newline
\textbf{type: \hyperref[sect:ivoa]{ivoa:string}} \newline
\textbf{multiplicity: 0..1} \newline
Label attached to the vocabulary term. This is necessary because the URI may not contain any explicit label. This was the case for the IUA vocabulary until the Registry WG introduced rewriting rules that fix the issue.
Label attached to the vocabulary term. This is necessary because the URI may not contain any explicit label. This was the case for the UAT vocabulary until the Registry WG introduced rewriting rules that fix the issue.

\section{Date Time Types}
The abstract primitive type \texttt{ivoa:datetime} has been extended to include:
Expand Down Expand Up @@ -125,7 +125,7 @@ \section{Epoch Position Properties}
\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} 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}
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}

\subsubsection{EpochPosition.longitude}
\textbf{vodml-id: EpochPosition.longitude} \newline
Expand Down Expand Up @@ -191,13 +191,13 @@ \section{Epoch Position Properties}
\textbf{vodml-id: EpochPosition.spaceSys} \newline
\textbf{type: coords:SpaceSys} \newline
\textbf{multiplicity: 1} \newline
System that applies the space coordinates.
System that applies to the space coordinates.

\subsubsection{EpochPosition.timeSys}
\textbf{vodml-id: EpochPosition.timeSys} \newline
\textbf{type: coords:TimeSys} \newline
\textbf{multiplicity: 1} \newline
System that applies the time coordinates (the epoch).
System that applies to the time coordinates (the epoch).

\subsection{EpochPositionCorrelations}
\label{sect:EpochPositionCorrelations}
Expand Down Expand Up @@ -304,7 +304,7 @@ \section{Photometric and Spectroscopic Properties}
photometric filters are imported from \texttt{PhotDM}.
\subsection{Brightness}
\label{sect: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. The photometric calibration is modeled 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 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 @@ -326,7 +326,7 @@ \section{Photometric and Spectroscopic Properties}

\subsection{Color}
\label{sect:Color}
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.
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 a hardness ratio.

\subsubsection{Color.value}
\textbf{vodml-id: Color.value} \newline
Expand All @@ -348,7 +348,7 @@ \section{Photometric and Spectroscopic Properties}

\subsection{ColorDef}
\label{sect:ColorDef}
Physical color definition giving the way a color is calculated (magnitude difference or hardness ratio) and the filters on which the color is based. In case of hardness ratio, the energy bands might be modeled as instances of \texttt{Phot:PhotometryFilter} with a square transfert function.
Physical color definition giving the way a color is calculated (magnitude difference or hardness ratio) and the filters on which the color is based. In case of hardness ratio, the energy bands might be modeled as instances of \texttt{Phot:PhotometryFilter} with a square transfer function.

\subsubsection{ColorDef.definition}
\textbf{vodml-id: ColorDef.definition} \newline
Expand All @@ -360,13 +360,13 @@ \section{Photometric and Spectroscopic Properties}
\textbf{vodml-id: ColorDef.high} \newline
\textbf{type: Phot:PhotometryFilter} \newline
\textbf{multiplicity: 1} \newline
Reference to the \texttt{Phot:PhotometryFilter} \citep{2022ivoa.spec.1101S} corresponding the higher band of the color.
Reference to the \texttt{Phot:PhotometryFilter} \citep{2022ivoa.spec.1101S} corresponding to the higher band of the color.

\subsubsection{ColorDef.low}
\textbf{vodml-id: ColorDef.low} \newline
\textbf{type: Phot:PhotometryFilter} \newline
\textbf{multiplicity: 1} \newline
Reference to the \texttt{Phot:PhotometryFilter} corresponding the lower band for that color.
Reference to the \texttt{Phot:PhotometryFilter} corresponding to the lower band for that color.

\subsection{ColorDefinition}
\label{sect:ColorDefinition}
Expand Down Expand Up @@ -448,7 +448,7 @@ \section{Other Properties}

\subsection{StatusValue}
\label{sect:StatusValue}
Value allowed for a status; contain the value with a free text description.
Value allowed for a status; contains the value with a free text description.

\subsubsection{StatusValue.value}
\textbf{vodml-id: StatusValue.value} \newline
Expand Down Expand Up @@ -503,10 +503,10 @@ \section{Other Properties}
\section{Package: error}
\begin{figure}[h]
\includegraphics[width=1.0\textwidth]{../model/error.png}
\caption{package error}
\caption{error package}
\label{fig:error}
\end{figure}
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
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.

\subsection{PropertyError (Abstract)}
\label{sect:error.PropertyError}
Expand All @@ -522,7 +522,7 @@ \section{Package: error}
\textbf{vodml-id: error.PropertyError.distribution} \newline
\textbf{type: \hyperref[sect:ivoa]{ivoa:string}} \newline
\textbf{multiplicity: 1} \newline
Statistical distribution of the error. The Value can a vocabulary URI (e.g. \url{https://www.ivoa.net/rdf/uat/2024-06-25/uat.html#poisson-distribution}).
Statistical distribution of the error. The Value can be a vocabulary URI (e.g. \url{https://www.ivoa.net/rdf/uat/2024-06-25/uat.html#poisson-distribution}).

\subsection{PErrorSym1D}
\label{sect:error.PErrorSym1D}
Expand Down Expand Up @@ -570,7 +570,7 @@ \section{Package: error}
\textbf{vodml-id: error.PErrorEllipse.angle} \newline
\textbf{type: \hyperref[sect:ivoa]{ivoa:RealQuantity}} \newline
\textbf{multiplicity: 1} \newline
In theory, this is the angle between the North Polar Cape (NPC) and the major axis. This angle must be positive taking into account that angles are positive from North to the East. The angle has its own unit. In practice, the angle definition is this used by the mapped data set. It is usually the angle between the major axis and the north axis (negative along of the clockwise direction).
In theory, this is the angle between the North Celestial Pole (NCP) and the major axis. This angle must be positive taking into account that angles are positive from North to the East. The angle has its own unit. In practice, the angle definition is this used by the mapped data set. It is usually the angle between the major axis and the north axis (negative along of the clockwise direction).

\subsection{PErrorSym2D}
\label{sect:error.PErrorSym2D}
Expand All @@ -591,10 +591,10 @@ \section{Package: error}
\section{Package: origin}
\begin{figure}[h]
\includegraphics[width=1.0\textwidth]{../model/origin.png}
\caption{package origin}
\caption{origin package}
\label{fig:origin}
\end{figure}
Package grouping together all the components needed to model the origin of the \texttt{MangoObject} (fig \ref{fig:origin}). The design of the package complies with the work of the DCP interest group (see \url{https://ivoa.net/documents/DataOrigin/index.html})
Package grouping together all the components needed to model the origin of the \texttt{MangoObject} (fig \ref{fig:origin}). The design of the package complies with the work of the DCP interest group (see \url{https://ivoa.net/documents/DataOrigin/index.html}).

\subsection{QueryOrigin}
\label{sect:origin.QueryOrigin}
Expand Down Expand Up @@ -622,7 +622,7 @@ \section{Package: origin}
\textbf{vodml-id: origin.QueryOrigin.request} \newline
\textbf{type: \hyperref[sect:ivoa]{ivoa:string}} \newline
\textbf{multiplicity: 1} \newline
Full request URL including a query string. For the simple protocols,put the url-encoded form of the query parameters. For TAP queries, use the /sync UWS \citep{2016ivoa.spec.1024H} URL. The format is free for others request types.
Full request URL including a query string. For the simple protocols, put the url-encoded form of the query parameters. For TAP queries, use the /sync UWS \citep{2016ivoa.spec.1024H} URL. The format is free for other request types.

\subsubsection{QueryOrigin.request\_date}
\textbf{vodml-id: origin.QueryOrigin.request\_date} \newline
Expand Down Expand Up @@ -680,7 +680,7 @@ \section{Package: origin}
\textbf{vodml-id: origin.DataOrigin.creators} \newline
\textbf{type: \hyperref[sect:ivoa]{ivoa:string}} \newline
\textbf{multiplicity: 0..*} \newline
Person(s) mainly involved in the creation of the resource, generally the author
Person(s) mainly involved in the creation of the resource, generally the author(s).

\subsubsection{DataOrigin.cites}
\textbf{vodml-id: origin.DataOrigin.cites} \newline
Expand Down Expand Up @@ -710,7 +710,7 @@ \section{Package: origin}
\textbf{vodml-id: origin.DataOrigin.rights\_uri} \newline
\textbf{type: \hyperref[sect:ivoa]{ivoa:string}} \newline
\textbf{multiplicity: 1} \newline
Licence URI. Following Registry practice, this should come from SPDX (\url{https://spdx.org/licenses}), though Creative Commons URLs (\url{https://creativecommons.org are also admitted}).
Licence URI. Following Registry practice, this should come from SPDX (\url{https://spdx.org/licenses}), though Creative Commons URLs (\url{https://creativecommons.org}) are also admitted.

\subsubsection{DataOrigin.articles}
\textbf{vodml-id: origin.DataOrigin.articles} \newline
Expand Down