Skip to content
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

Model presentation #62

Open
wants to merge 9 commits into
base: wd-v1.0
Choose a base branch
from
Open

Model presentation #62

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
ec876ad
create a superclass for the photometric properties
lmichel Dec 5, 2024
4871647
add reference to Coords DM
lmichel Dec 5, 2024
59ac022
remove super class for 2D parameters
lmichel Dec 5, 2024
507ac9b
update version
lmichel Dec 5, 2024
975a2e8
description of the photometric super class
lmichel Dec 5, 2024
fe76087
description of a new class
lmichel Dec 5, 2024
cbb49a6
update generated stuff
lmichel Dec 5, 2024
87c432c
remove duplicated error field
lmichel Dec 5, 2024
1f79406
add to errors an attribute giving the statistical distribution.
lmichel Dec 5, 2024
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
2 changes: 1 addition & 1 deletion doc/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ DOCNAME = MANGO
DOCVERSION = 0.1

# Publication date, ISO format; update manually for "releases"
DOCDATE = 2024-10-20
DOCDATE = 2024-12-05

# What is it you're writing: NOTE, WD, PR, REC, PEN, or EN
DOCTYPE = WD
Expand Down
4 changes: 2 additions & 2 deletions doc/ivoatexmeta.tex
View file
Open in desktop
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}{2024-10-20}
\newcommand{\ivoaDocdatecode}{20241020}
\newcommand{\ivoaDocdate}{2024-12-05}
\newcommand{\ivoaDocdatecode}{20241205}
\newcommand{\ivoaDoctype}{WD}
\newcommand{\ivoaDocname}{MANGO}
\renewcommand{\ivoaBaseURL}{https://www.ivoa.net/documents/MANGO}
54 changes: 30 additions & 24 deletions doc/model.tex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,16 @@ \section{Model: mango }
\label{sect:BitField}
Property for which each possible value is represented by a bit, so that multiple states can be contained in the same integer value. The possible values are defined in the associated \texttt{StatusValues}, which must correspond to a bit pattern (each value must be a power of 2). This constraint is not enforced by the model.

\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).

\subsubsection{Brightness.photCal}
\textbf{vodml-id: Brightness.photCal} \newline
\textbf{type: Phot:PhotCal} \newline
\textbf{multiplicity: 1} \newline
Photometric calibration that applies to the photometric property. It must be an instance of \texttt{photdm:PhotCal}.

\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.
Expand Down Expand Up @@ -282,26 +292,26 @@ \section{Model: mango }

\subsubsection{EpochPositionErrors.parallax}
\textbf{vodml-id: EpochPositionErrors.parallax} \newline
\textbf{type: \hyperref[sect:error.Symmetric1D]{mango:error.Symmetric1D}} \newline
\textbf{multiplicity: 0..1} \newline
\textbf{type: \hyperref[sect:error.PropertyError]{mango:error.PropertyError}} \newline
\textbf{multiplicity: 1} \newline
Parallax error. This error is meant to be symmetrical in the current model version.

\subsubsection{EpochPositionErrors.radialVelocity}
\textbf{vodml-id: EpochPositionErrors.radialVelocity} \newline
\textbf{type: \hyperref[sect:error.Symmetric1D]{mango:error.Symmetric1D}} \newline
\textbf{multiplicity: 0..1} \newline
\textbf{type: \hyperref[sect:error.PropertyError]{mango:error.PropertyError}} \newline
\textbf{multiplicity: 1} \newline
Error in the radial velocity. This error is meant to be symmetrical in the current model version.

\subsubsection{EpochPositionErrors.position}
\textbf{vodml-id: EpochPositionErrors.position} \newline
\textbf{type: \hyperref[sect:error.PropertyError2D]{mango:error.PropertyError2D}} \newline
\textbf{multiplicity: 0..1} \newline
Position error; can be an ellipse, a correlation matrix or a covariance matrix.

\subsubsection{EpochPositionErrors.properMotion}
\textbf{vodml-id: EpochPositionErrors.properMotion} \newline
\textbf{type: \hyperref[sect:error.PropertyError2D]{mango:error.PropertyError2D}} \newline
\textbf{multiplicity: 0..1} \newline
\textbf{type: \hyperref[sect:error.PropertyError]{mango:error.PropertyError}} \newline
\textbf{multiplicity: 1} \newline
Position error; can be an ellipse, a correlation matrix or a covariance matrix.

\subsubsection{EpochPositionErrors.Position}
\textbf{vodml-id: EpochPositionErrors.Position} \newline
\textbf{type: \hyperref[sect:error.PropertyError]{mango:error.PropertyError}} \newline
\textbf{multiplicity: 1} \newline
Position error; can be an ellipse, a correlation matrix or a covariance matrix.

\subsection{Label}
Expand Down Expand Up @@ -344,7 +354,7 @@ \section{Model: mango }

\subsection{PhotometricProperty}
\label{sect:PhotometricProperty}
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).
Super class for all photometric properties of the \texttt{MangoObject}.

\subsubsection{PhotometricProperty.value}
\textbf{vodml-id: PhotometricProperty.value} \newline
Expand All @@ -355,14 +365,8 @@ \section{Model: mango }
\subsubsection{PhotometricProperty.error}
\textbf{vodml-id: PhotometricProperty.error} \newline
\textbf{type: meas:Uncertainty} \newline
\textbf{multiplicity: 0..1} \newline
Error on the \texttt{PhotometricProperty}, imported from \texttt{meas:Uncertainty}.

\subsubsection{PhotometricProperty.photCal}
\textbf{vodml-id: PhotometricProperty.photCal} \newline
\textbf{type: Phot:PhotCal} \newline
\textbf{multiplicity: 1} \newline
Photometric calibration that applies to the photometric property. It must be an instance of \texttt{photdm:PhotCal}.
Error on the \texttt{PhotometricProperty}, imported from \texttt{meas:Uncertainty}.

\subsection{PhysicalProperty}
\label{sect:PhysicalProperty}
Expand Down Expand Up @@ -601,7 +605,7 @@ \section{Package: error }

\subsection{Ellipse}
\label{sect:error.Ellipse}
Elliptic error for 2D parameters such as sky positions. Major axis and minor axis have their own units, which must be the same for both. This is not enforced by the model.
Elliptic error for 2D parameters such as sky positions. Major axis and minor axis have their own units, which must be the same for both. This is not enforced by the model. The definition of the ellipse attribute is imported from \texttt{coords:Ellipse}.

\subsubsection{Ellipse.semiMajorAxis}
\textbf{vodml-id: error.Ellipse.semiMajorAxis} \newline
Expand Down Expand Up @@ -675,9 +679,11 @@ \section{Package: error }
\textbf{multiplicity: 1} \newline
Confidence level of the error. The confidence level must be in $[0, 1]$ (not enforced by the VO-DML schema).

\subsection{PropertyError2D (Abstract)}
\label{sect:error.PropertyError2D}
Super (abstract) class for all errors of 2D parameters
\subsubsection{PropertyError.distribution}
\textbf{vodml-id: error.PropertyError.distribution} \newline
\textbf{type: \hyperref[sect:ivoa]{ivoa:string}} \newline
\textbf{multiplicity: 1} \newline
TODO : Missing description : please, update your UML model asap.

\subsection{Symmetric1D}
\label{sect:error.Symmetric1D}
Expand Down
14 changes: 14 additions & 0 deletions mivot/mango/mango.Brightness.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<INSTANCE dmrole="" dmtype="mango: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)." -->
<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=""/>
<ATTRIBUTE dmrole="mango:VocabularyTerm.label" dmtype="ivoa:string" ref="@@@@@" value=""/>
</INSTANCE>
<ATTRIBUTE dmrole="mango:Property.description" dmtype="ivoa:string" ref="@@@@@" value=""/>
<ATTRIBUTE dmrole="mango:PhotometricProperty.value" dmtype="ivoa:RealQuantity" unit="" ref="@@@@@" value=""/>
<INSTANCE dmrole="mango:PhotometricProperty.error" dmtype="meas:Uncertainty"/>
<INSTANCE dmrole="mango:Brightness.photCal" dmtype="Phot:PhotCal"/>
</INSTANCE>
24 changes: 8 additions & 16 deletions mivot/mango/mango.EpochPosition.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,22 +35,14 @@ Possible correlations between \texttt{EpochPosition} parameters are handle by th
<ATTRIBUTE dmrole="mango:EpochPosition.pmCosLat_applied" dmtype="ivoa:boolean" unit="" ref="@@@@@" value=""/>
<INSTANCE dmrole="mango:EpochPosition.errors" dmtype="mango:EpochPositionErrors">
<!-- Class holder for the errors of the EpochPosition attributes" -->
<INSTANCE dmrole="mango:EpochPositionErrors.parallax" dmtype="mango:error.Symmetric1D">
<!-- Symmetric error for 1D parameters" -->
<INSTANCE dmrole="meas:Uncertainty" dmtype="meas:Uncertainty"/>
<ATTRIBUTE dmrole="mango:error.PropertyError.confidenceLevel" dmtype="ivoa:real" unit="" ref="@@@@@" value=""/>
<ATTRIBUTE dmrole="mango:error.Symmetric1D.sigma" dmtype="ivoa:RealQuantity" unit="" ref="@@@@@" value=""/>
</INSTANCE>
<INSTANCE dmrole="mango:EpochPositionErrors.radialVelocity" dmtype="mango:error.Symmetric1D">
<!-- Symmetric error for 1D parameters" -->
<INSTANCE dmrole="meas:Uncertainty" dmtype="meas:Uncertainty"/>
<ATTRIBUTE dmrole="mango:error.PropertyError.confidenceLevel" dmtype="ivoa:real" unit="" ref="@@@@@" value=""/>
<ATTRIBUTE dmrole="mango:error.Symmetric1D.sigma" dmtype="ivoa:RealQuantity" unit="" ref="@@@@@" value=""/>
</INSTANCE>
<!-- Put here a concrete INSTANCE of error.PropertyError2D or left blank -->
<INSTANCE dmrole="mango:EpochPositionErrors.position" dmtype="mango:error.PropertyError2D"/>
<!-- Put here a concrete INSTANCE of error.PropertyError2D or left blank -->
<INSTANCE dmrole="mango:EpochPositionErrors.properMotion" dmtype="mango:error.PropertyError2D"/>
<!-- Put here a concrete INSTANCE of error.PropertyError or left blank -->
<INSTANCE dmrole="mango:EpochPositionErrors.parallax" dmtype="mango:error.PropertyError"/>
<!-- Put here a concrete INSTANCE of error.PropertyError or left blank -->
<INSTANCE dmrole="mango:EpochPositionErrors.radialVelocity" dmtype="mango:error.PropertyError"/>
<!-- Put here a concrete INSTANCE of error.PropertyError or left blank -->
<INSTANCE dmrole="mango:EpochPositionErrors.properMotion" dmtype="mango:error.PropertyError"/>
<!-- Put here a concrete INSTANCE of error.PropertyError or left blank -->
<INSTANCE dmrole="mango:EpochPositionErrors.Position" dmtype="mango:error.PropertyError"/>
</INSTANCE>
<INSTANCE dmrole="mango:EpochPosition.correlations" dmtype="mango:EpochPositionCorrelations">
<!-- Class holder for the correlation coefficients between the \texttt{EpochPosition} components." -->
Expand Down
24 changes: 8 additions & 16 deletions mivot/mango/mango.EpochPositionErrors.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,11 @@
<INSTANCE dmrole="" dmtype="mango:EpochPositionErrors">
<!-- Class holder for the errors of the EpochPosition attributes" -->
<INSTANCE dmrole="mango:EpochPositionErrors.parallax" dmtype="mango:error.Symmetric1D">
<!-- Symmetric error for 1D parameters" -->
<INSTANCE dmrole="meas:Uncertainty" dmtype="meas:Uncertainty"/>
<ATTRIBUTE dmrole="mango:error.PropertyError.confidenceLevel" dmtype="ivoa:real" unit="" ref="@@@@@" value=""/>
<ATTRIBUTE dmrole="mango:error.Symmetric1D.sigma" dmtype="ivoa:RealQuantity" unit="" ref="@@@@@" value=""/>
</INSTANCE>
<INSTANCE dmrole="mango:EpochPositionErrors.radialVelocity" dmtype="mango:error.Symmetric1D">
<!-- Symmetric error for 1D parameters" -->
<INSTANCE dmrole="meas:Uncertainty" dmtype="meas:Uncertainty"/>
<ATTRIBUTE dmrole="mango:error.PropertyError.confidenceLevel" dmtype="ivoa:real" unit="" ref="@@@@@" value=""/>
<ATTRIBUTE dmrole="mango:error.Symmetric1D.sigma" dmtype="ivoa:RealQuantity" unit="" ref="@@@@@" value=""/>
</INSTANCE>
<!-- Put here a concrete INSTANCE of error.PropertyError2D or left blank -->
<INSTANCE dmrole="mango:EpochPositionErrors.position" dmtype="mango:error.PropertyError2D"/>
<!-- Put here a concrete INSTANCE of error.PropertyError2D or left blank -->
<INSTANCE dmrole="mango:EpochPositionErrors.properMotion" dmtype="mango:error.PropertyError2D"/>
<!-- Put here a concrete INSTANCE of error.PropertyError or left blank -->
<INSTANCE dmrole="mango:EpochPositionErrors.parallax" dmtype="mango:error.PropertyError"/>
<!-- Put here a concrete INSTANCE of error.PropertyError or left blank -->
<INSTANCE dmrole="mango:EpochPositionErrors.radialVelocity" dmtype="mango:error.PropertyError"/>
<!-- Put here a concrete INSTANCE of error.PropertyError or left blank -->
<INSTANCE dmrole="mango:EpochPositionErrors.properMotion" dmtype="mango:error.PropertyError"/>
<!-- Put here a concrete INSTANCE of error.PropertyError or left blank -->
<INSTANCE dmrole="mango:EpochPositionErrors.Position" dmtype="mango:error.PropertyError"/>
</INSTANCE>
6 changes: 2 additions & 4 deletions mivot/mango/mango.PhotometricProperty.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
<INSTANCE dmrole="" dmtype="mango:PhotometricProperty">
<!-- 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)." -->
<!-- Super class for all photometric properties of the \texttt{MangoObject}.
" -->
<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 All @@ -10,5 +9,4 @@ This property should refer to a photometric calibration as defined by the \textt
<ATTRIBUTE dmrole="mango:Property.description" dmtype="ivoa:string" ref="@@@@@" value=""/>
<ATTRIBUTE dmrole="mango:PhotometricProperty.value" dmtype="ivoa:RealQuantity" unit="" ref="@@@@@" value=""/>
<INSTANCE dmrole="mango:PhotometricProperty.error" dmtype="meas:Uncertainty"/>
<INSTANCE dmrole="mango:PhotometricProperty.photCal" dmtype="Phot:PhotCal"/>
</INSTANCE>
1 change: 1 addition & 0 deletions mivot/mango/mango.error.Asymmetric1D.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
<!-- Asymmetric error for 1D parameters" -->
<INSTANCE dmrole="meas:Uncertainty" dmtype="meas:Uncertainty"/>
<ATTRIBUTE dmrole="mango:error.PropertyError.confidenceLevel" dmtype="ivoa:real" unit="" ref="@@@@@" value=""/>
<ATTRIBUTE dmrole="mango:error.PropertyError.distribution" dmtype="ivoa:string" ref="@@@@@" value=""/>
<ATTRIBUTE dmrole="mango:error.Asymmetric1D.high" dmtype="ivoa:RealQuantity" unit="" ref="@@@@@" value=""/>
<ATTRIBUTE dmrole="mango:error.Asymmetric1D.low" dmtype="ivoa:RealQuantity" unit="" ref="@@@@@" value=""/>
</INSTANCE>
3 changes: 2 additions & 1 deletion mivot/mango/mango.error.Ellipse.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
<INSTANCE dmrole="" dmtype="mango:error.Ellipse">
<!-- Elliptic error for 2D parameters such as sky positions.
Major axis and minor axis have their own units, which must be the same for both.
This is not enforced by the model." -->
This is not enforced by the model. The definition of the ellipse attribute is imported from \texttt{coords:Ellipse}. " -->
<INSTANCE dmrole="meas:Uncertainty" dmtype="meas:Uncertainty"/>
<ATTRIBUTE dmrole="mango:error.PropertyError.confidenceLevel" dmtype="ivoa:real" unit="" ref="@@@@@" value=""/>
<ATTRIBUTE dmrole="mango:error.PropertyError.distribution" dmtype="ivoa:string" ref="@@@@@" value=""/>
<ATTRIBUTE dmrole="mango:error.Ellipse.semiMajorAxis" dmtype="ivoa:RealQuantity" unit="" ref="@@@@@" value=""/>
<ATTRIBUTE dmrole="mango:error.Ellipse.semiMinorAxis" dmtype="ivoa:RealQuantity" unit="" ref="@@@@@" value=""/>
<ATTRIBUTE dmrole="mango:error.Ellipse.angle" dmtype="ivoa:RealQuantity" unit="" ref="@@@@@" value=""/>
Expand Down
1 change: 1 addition & 0 deletions mivot/mango/mango.error.ErrorCorrMatrix.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ The correlation matrix is symmetrical.
" -->
<INSTANCE dmrole="meas:Uncertainty" dmtype="meas:Uncertainty"/>
<ATTRIBUTE dmrole="mango:error.PropertyError.confidenceLevel" dmtype="ivoa:real" unit="" ref="@@@@@" value=""/>
<ATTRIBUTE dmrole="mango:error.PropertyError.distribution" dmtype="ivoa:string" ref="@@@@@" value=""/>
<ATTRIBUTE dmrole="mango:error.ErrorCorrMatrix.sigma1" dmtype="ivoa:RealQuantity" unit="" ref="@@@@@" value=""/>
<ATTRIBUTE dmrole="mango:error.ErrorCorrMatrix.sigma2" dmtype="ivoa:RealQuantity" unit="" ref="@@@@@" value=""/>
<ATTRIBUTE dmrole="mango:error.ErrorCorrMatrix.correlation" dmtype="ivoa:real" unit="" ref="@@@@@" value=""/>
Expand Down
1 change: 1 addition & 0 deletions mivot/mango/mango.error.ErrorCovMatrix.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
The covariance matrix is symmetrical." -->
<INSTANCE dmrole="meas:Uncertainty" dmtype="meas:Uncertainty"/>
<ATTRIBUTE dmrole="mango:error.PropertyError.confidenceLevel" dmtype="ivoa:real" unit="" ref="@@@@@" value=""/>
<ATTRIBUTE dmrole="mango:error.PropertyError.distribution" dmtype="ivoa:string" ref="@@@@@" value=""/>
<ATTRIBUTE dmrole="mango:error.ErrorCovMatrix.variance1" dmtype="ivoa:RealQuantity" unit="" ref="@@@@@" value=""/>
<ATTRIBUTE dmrole="mango:error.ErrorCovMatrix.variance2" dmtype="ivoa:RealQuantity" unit="" ref="@@@@@" value=""/>
<ATTRIBUTE dmrole="mango:error.ErrorCovMatrix.covariance" dmtype="ivoa:RealQuantity" unit="" ref="@@@@@" value=""/>
Expand Down
1 change: 1 addition & 0 deletions mivot/mango/mango.error.Symmetric1D.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,6 @@
<!-- Symmetric error for 1D parameters" -->
<INSTANCE dmrole="meas:Uncertainty" dmtype="meas:Uncertainty"/>
<ATTRIBUTE dmrole="mango:error.PropertyError.confidenceLevel" dmtype="ivoa:real" unit="" ref="@@@@@" value=""/>
<ATTRIBUTE dmrole="mango:error.PropertyError.distribution" dmtype="ivoa:string" ref="@@@@@" value=""/>
<ATTRIBUTE dmrole="mango:error.Symmetric1D.sigma" dmtype="ivoa:RealQuantity" unit="" ref="@@@@@" value=""/>
</INSTANCE>
Binary file modified model/EpochPosition.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified model/error.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading