Merge pull request #55 from lmichel/model-presentation

Model presentation

doc/MANGO.tex

@@ -236,11 +236,13 @@ \section{Model Overview}
 \begin{figure}
      \includegraphics[width=1.0\textwidth]{../model/overview.png}
      \caption{Model overview}
-     \label{overview}
+     \label{fig:overview}
 \end{figure}
 
-The root class of the model \texttt{MANGOObject} which has only
-one mandatory attribute, an \texttt{identifier}.
+Figure \ref{fig:overview} shows the general structure of the model.
+
+The root class is \texttt{MANGOObject}]. 
+It has only one mandatory attribute, an \texttt{identifier}.
 Identifiers should be unique within a collection, e.g. a data table, although 
 this feature is not required by the model.
 
@@ -266,6 +268,42 @@ \subsection{Properties}
         \label{fig:property}
       \end{figure}
 
+\subsubsection{Supported Properties}
+
+\begin{table}[h!]
+\small
+\begin{center}
+\begin{tabular}{|| p{3.5cm} | p{3.5cm} |  p{3.5cm} ||} 
+ \hline\hline
+ \textbf{Property} & \textbf{Purpose} & \textbf{Example} \\ 
+  \hline\hline
+ \texttt{Status} & Attach explicit labels to flag values & Chandra detection flag  \\ 
+ \hline
+ \texttt{Label} & Attach semantics to text label & Object name \\
+ \hline
+ \texttt{PhysicalProperty} & Hook for \texttt{Measure} classes & Model a columns as a time stamp \\
+ \hline
+ \texttt{Shape} & String serialization of shapes & Sky Coverage of a dust cloud \\
+ \hline
+ \texttt{EpochPosition} & Grouping of position with velocity and time & Parameters to solve the epoch propagation case\\  
+ \hline
+ \texttt{PhotometricProperty} & Flux or Magnitude & many \\ 
+ \hline
+ \texttt{Color} & Hardness ratio or magnitude ratio & many  \\ [1ex] 
+ \hline
+ \texttt{DataLink} & Flat representation of DataLink responses & Links to associated data given as column values\\ [1ex] 
+ \hline
+\end{tabular}
+\caption{Properties supported by MANGO.}
+\label{table:properties}
+\end{center}
+ \end{table}
+This initial release supports a limited list of properties, listed in table \ref{table:properties}, that address the most common use cases.
+
+
+
+All of these components are described in alphabetical order in the next section.
+
 \subsubsection{Property Identification}
 Since the set of properties associated with a particular instance is not defined by the model,
 MANGO cannot define a specific role for each property. However, the model provides different ways
@@ -296,6 +334,8 @@ \subsubsection{MANGO and MIVOT: Structuring Tabular Data}
     \item Scattered Independent Quantities: Each table row is considered as a collection of independent quantities.
 \end{itemize}
 
+\hfill \break
+
 MIVOT annotations support both approaches:
 
 \begin{itemize}[noitemsep,topsep=0pt,parsep=0pt,partopsep=0pt]

doc/Makefile

@@ -7,7 +7,7 @@ DOCNAME = MANGO
 DOCVERSION = 0.1
 
 # Publication date, ISO format; update manually for "releases"
-DOCDATE = 2024-10-17
+DOCDATE = 2024-10-20
 
 # What is it you're writing: NOTE, WD, PR, REC, PEN, or EN
 DOCTYPE = WD

doc/ivoatexmeta.tex

@@ -1,7 +1,7 @@
 % GENERATED FILE -- edit this in the Makefile
 \newcommand{\ivoaDocversion}{0.1}
-\newcommand{\ivoaDocdate}{2024-10-17}
-\newcommand{\ivoaDocdatecode}{20241017}
+\newcommand{\ivoaDocdate}{2024-10-20}
+\newcommand{\ivoaDocdatecode}{20241020}
 \newcommand{\ivoaDoctype}{WD}
 \newcommand{\ivoaDocname}{MANGO}
 \renewcommand{\ivoaBaseURL}{https://www.ivoa.net/documents/MANGO}

doc/model.tex

@@ -132,7 +132,7 @@ \section{Model: mango }
 
 
   \label{sect:EpochPosition}
-    This class is a view of \texttt{Astronomical Coordinates and Coordinate Systems} \citep{2022ivoa.specQ1004R} components 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. All components share 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} The \texttt{EpochPosition} error is modeled by specific classes supporting covariance and/or correlation between components. All individual components have their own units which must be consistent to each others. This consistency is not enforced by the model. Possible correlations between \texttt{EpochPosition} parameters are handle by the \texttt{EpochPositionCorrelation} class.
+    This class (fig \ref{fig:EpochPosition}) is a view of \texttt{Astronomical Coordinates and Coordinate Systems} \citep{2022ivoa.specQ1004R} components 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. All components share 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} The \texttt{EpochPosition} error is modeled by specific classes supporting covariance and/or correlation between components. All individual components have their own units which must be consistent to each others. This consistency is not enforced by the model. Possible correlations between \texttt{EpochPosition} parameters are handle by the \texttt{EpochPositionCorrelation} class.
 
     \subsubsection{EpochPosition.longitude}
       \textbf{vodml-id: EpochPosition.longitude} \newline
@@ -581,7 +581,7 @@ \section{Package: error }
   %\end{center}
   %\end{figure}
 
-  The \texttt{error} package 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{Asymmetric1D}
   \label{sect:error.Asymmetric1D}
@@ -707,7 +707,7 @@ \section{Package: dataorigin }
   %\end{center}
   %\end{figure}
 
-  Package grouping together all the components needed to model the origin of \texttt{MangoObject}.
+  Package grouping together all the components needed to model the origin of \texttt{MangoObject} (fig \ref{fig:dataorigin}).
 
   \subsection{Article}
   \label{sect:dataorigin.Article}

doc/role_diagram.xml

@@ -78,15 +78,15 @@ of the various sections) to have the box centered.
   <rec name="VODML" x="512" y="195" w="46"/>
 <!--   <rec name="SimDM" x="473" y="230" w="44"/> -->
   <rec name="STC" x="580" y="255" w="30"/>
-  <rec name="CharDM" x="470.5" y="255" w="49"/>
-  <rec name="SSLDM" x="572.5" y="280" w="45"/>
-  <rec name="SpectralDM" x="461.5" y="280" w="67"/>
+<!--  <rec name="CharDM" x="470.5" y="255" w="49"/> -->  
+<!--   <rec name="SSLDM" x="572.5" y="280" w="45"/>-->  
+<!--   <rec name="SpectralDM" x="461.5" y="280" w="67"/>-->  
   <rec name="PhotDM" x="571" y="305" w="48"/>
   <rec name="Meas" x="456" y="305" w="35"/>
   <rec name="Coords" x="501" y="305" w="44"/>
-  <prerec name="Transform" x="465" y="330" w="60"/>
+<!--   <prerec name="Transform" x="465" y="330" w="60"/> -->
   <prerec name="DatasetDM" x="490" y="380" w="65"/>
-  <prerec name="CubeDM" x="497" y="405" w="51"/>
+<!--     <prerec name="CubeDM" x="497" y="405" w="51"/> -->
   <rec name="ProvDM" x="571" y="330" w="48"/>
 
   <!-- GWS: all over the place -->

mivot/mango/mango.EpochPosition.xml

@@ -1,5 +1,5 @@
 <INSTANCE dmrole="" dmtype="mango:EpochPosition">
-   <!-- This class is a view of \texttt{Astronomical Coordinates and Coordinate
+   <!-- This class (fig \ref{fig:EpochPosition}) is a view of \texttt{Astronomical Coordinates and Coordinate
 Systems} \citep{2022ivoa.specQ1004R} components 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 

vo-dml/desc.mango.vo-dml.xml

@@ -701,7 +701,7 @@ This constraint is not enforced by the model.</description>
   <objectType>
     <vodml-id>EpochPosition</vodml-id>
     <name>EpochPosition</name>
-    <description>This class is a view of \texttt{Astronomical Coordinates and Coordinate
+    <description>This class (fig \ref{fig:EpochPosition}) is a view of \texttt{Astronomical Coordinates and Coordinate
 Systems} \citep{2022ivoa.specQ1004R} components 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 
@@ -1076,7 +1076,7 @@ providers to convey whether or not the factor has been applied (see \texttt{meas
   <package>
     <vodml-id>error</vodml-id>
     <name>error</name>
-    <description>The \texttt{error} package groups the MANGO built-in error classes. 
+    <description>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</description>
@@ -1316,7 +1316,7 @@ The correlation matrix is symmetrical.
   <package>
     <vodml-id>dataorigin</vodml-id>
     <name>dataorigin</name>
-    <description>Package grouping together all the components needed to model the origin of \texttt{MangoObject}.</description>
+    <description>Package grouping together all the components needed to model the origin of \texttt{MangoObject} (fig \ref{fig:dataorigin}).</description>
     <objectType>
       <vodml-id>dataorigin.DataOrigin</vodml-id>
       <name>DataOrigin</name>

vo-dml/desc/desc.EpochPosition.txt

@@ -1,4 +1,4 @@
-This class is a view of \texttt{Astronomical Coordinates and Coordinate
+This class (fig \ref{fig:EpochPosition}) is a view of \texttt{Astronomical Coordinates and Coordinate
 Systems} \citep{2022ivoa.specQ1004R} components 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 

vo-dml/desc/desc.dataorigin.txt

@@ -1 +1 @@
-Package grouping together all the components needed to model the origin of \texttt{MangoObject}.
+Package grouping together all the components needed to model the origin of \texttt{MangoObject} (fig \ref{fig:dataorigin}).

vo-dml/desc/desc.error.txt

@@ -1,4 +1,4 @@
-The \texttt{error} package groups the MANGO built-in error classes. 
+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