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

Error 2D limited to Symmetrical2D or Ellipse #76

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

Error 2D limited to Symmetrical2D or Ellipse #76

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bbfdc5f
Error 2D limited to Symmetrical2D(sigma1, sigma2) or Ellipse(maj, min,
lmichel Feb 6, 2025
800fcea
answer to #73
lmichel Feb 6, 2025
0014cc5
refer to Symmetrical2D
lmichel Feb 6, 2025
124b58c
typo
lmichel Feb 6, 2025
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 = 2025-02-03
DOCDATE = 2025-02-06

# 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}{2025-02-03}
\newcommand{\ivoaDocdatecode}{20250203}
\newcommand{\ivoaDocdate}{2025-02-06}
\newcommand{\ivoaDocdatecode}{20250206}
\newcommand{\ivoaDoctype}{WD}
\newcommand{\ivoaDocname}{MANGO}
\renewcommand{\ivoaBaseURL}{https://www.ivoa.net/documents/MANGO}
96 changes: 34 additions & 62 deletions doc/model.tex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ \section{Model: mango }


\label{sect:EpochPosition}
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.
This class (fig \ref{fig:EpochPosition}) is a view of \texttt{Astronomical Coordinates and Coordinate Systems} \citep{2022ivoa.specQ1004R} components that have been combined to form a consistent description of the position of an object moving in time. It consists of a celestial position, a proper motion, a radial velocity and a parallax. 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
Expand Down Expand Up @@ -306,13 +306,13 @@ \section{Model: mango }
\textbf{vodml-id: EpochPositionErrors.properMotion} \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.
Proper motion error; can be an ellipse or a matrix.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should be ellipse or Symmetrical2D, the same as for Position error. The same text appears in diffs for multiple files, I don't know which if any is the original source.

Copy link
Collaborator Author

@lmichel lmichel Feb 6, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The process of creating the document is quite hard. (see utils/README.md)


\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.
Position error; can be an \texttt{Ellipse} or a \texttt{Symmetrical2D}.

\subsection{Label}
\label{sect:Label}
Expand Down Expand Up @@ -549,21 +549,21 @@ \section{Package: error }

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}
Asymmetric error for 1D parameters
\subsection{Asymmetrical1D}
\label{sect:error.Asymmetrical1D}
Asymmetrical error for 1D parameters

\subsubsection{Asymmetric1D.high}
\textbf{vodml-id: error.Asymmetric1D.high} \newline
\subsubsection{Asymmetrical1D.high}
\textbf{vodml-id: error.Asymmetrical1D.high} \newline
\textbf{type: \hyperref[sect:ivoa]{ivoa:RealQuantity}} \newline
\textbf{multiplicity: 1} \newline
High limit for the asymmetric error for 1D parameters
High limit for the asymmetrical error for 1D parameters

\subsubsection{Asymmetric1D.low}
\textbf{vodml-id: error.Asymmetric1D.low} \newline
\subsubsection{Asymmetrical1D.low}
\textbf{vodml-id: error.Asymmetrical1D.low} \newline
\textbf{type: \hyperref[sect:ivoa]{ivoa:RealQuantity}} \newline
\textbf{multiplicity: 1} \newline
Low limit for the asymmetric error for 1D parameters
Low limit for the asymmetrical error for 1D parameters

\subsection{Ellipse}
\label{sect:error.Ellipse}
Expand All @@ -587,50 +587,6 @@ \section{Package: error }
\textbf{multiplicity: 1} \newline
Angle between the North Polar Cape (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.

\subsection{ErrorCorrMatrix}
\label{sect:error.ErrorCorrMatrix}
Correlation matrix for the error of a 2D quantities. The correlation matrix is symmetrical.

\subsubsection{ErrorCorrMatrix.sigma1}
\textbf{vodml-id: error.ErrorCorrMatrix.sigma1} \newline
\textbf{type: \hyperref[sect:ivoa]{ivoa:RealQuantity}} \newline
\textbf{multiplicity: 1} \newline
Error on the first dimension (right ascension in case of sky coordinates)

\subsubsection{ErrorCorrMatrix.sigma2}
\textbf{vodml-id: error.ErrorCorrMatrix.sigma2} \newline
\textbf{type: \hyperref[sect:ivoa]{ivoa:RealQuantity}} \newline
\textbf{multiplicity: 1} \newline
Error on the second dimension (declination in case of sky coordinates)

\subsubsection{ErrorCorrMatrix.correlation}
\textbf{vodml-id: error.ErrorCorrMatrix.correlation} \newline
\textbf{type: \hyperref[sect:ivoa]{ivoa:real}} \newline
\textbf{multiplicity: 1} \newline
Correlation coefficient between the 2 axis

\subsection{ErrorCovMatrix}
\label{sect:error.ErrorCovMatrix}
Covariance matrix for the error of a 2D quantities. The covariance matrix is symmetrical.

\subsubsection{ErrorCovMatrix.variance1}
\textbf{vodml-id: error.ErrorCovMatrix.variance1} \newline
\textbf{type: \hyperref[sect:ivoa]{ivoa:RealQuantity}} \newline
\textbf{multiplicity: 1} \newline
Variance of the first dimension (right ascension in case of sky coordinates)

\subsubsection{ErrorCovMatrix.variance2}
\textbf{vodml-id: error.ErrorCovMatrix.variance2} \newline
\textbf{type: \hyperref[sect:ivoa]{ivoa:RealQuantity}} \newline
\textbf{multiplicity: 1} \newline
Variance of the second dimension (declination in case of sky coordinates)

\subsubsection{ErrorCovMatrix.covariance}
\textbf{vodml-id: error.ErrorCovMatrix.covariance} \newline
\textbf{type: \hyperref[sect:ivoa]{ivoa:RealQuantity}} \newline
\textbf{multiplicity: 1} \newline
Covariance of the 2 axis

\subsection{PropertyError (Abstract)}
\label{sect:error.PropertyError}
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.
Expand All @@ -647,15 +603,31 @@ \section{Package: error }
\textbf{multiplicity: 1} \newline
Statistical distribution of the error. The Value must comply with VO vocabulary TBD (not enforced by the VO-DML schema).

\subsection{Symmetric1D}
\label{sect:error.Symmetric1D}
Symmetric error for 1D parameters
\subsection{Symmetrical1D}
\label{sect:error.Symmetrical1D}
Symmetrical error for 1D parameters

\subsubsection{Symmetric1D.sigma}
\textbf{vodml-id: error.Symmetric1D.sigma} \newline
\subsubsection{Symmetrical1D.sigma}
\textbf{vodml-id: error.Symmetrical1D.sigma} \newline
\textbf{type: \hyperref[sect:ivoa]{ivoa:RealQuantity}} \newline
\textbf{multiplicity: 1} \newline
Amplitude of the symmetric error on a one-dimensional parameter
Amplitude of the symmetrical error on a one-dimensional parameter

\subsection{Symmetrical2D}
\label{sect:error.Symmetrical2D}
Symmetrical error for 2D quantities.

\subsubsection{Symmetrical2D.sigma1}
\textbf{vodml-id: error.Symmetrical2D.sigma1} \newline
\textbf{type: \hyperref[sect:ivoa]{ivoa:RealQuantity}} \newline
\textbf{multiplicity: 1} \newline
Error on the first dimension (right ascension in case of sky coordinates)

\subsubsection{Symmetrical2D.sigma2}
\textbf{vodml-id: error.Symmetrical2D.sigma2} \newline
\textbf{type: \hyperref[sect:ivoa]{ivoa:RealQuantity}} \newline
\textbf{multiplicity: 1} \newline
Error on the second dimension (declination in case of sky coordinates)

\pagebreak
\section{Package: dataorigin }
Expand Down
Loading