Skip to content
Merged
Show file tree
Hide file tree
Changes from all 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
2 changes: 1 addition & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
name: Check the IVOA document

env:
doc_name: HighEnergyObsCoreExt
doc_name: HighEnergyObsCoreExt

on:
pull_request:
Expand Down
3 changes: 2 additions & 1 deletion .github/workflows/preview.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,14 +30,15 @@ jobs:

- name: Setup dependencies
run: |
sudo apt update
sudo apt update
sudo apt install texlive-latex-base texlive-latex-recommended \
texlive-latex-extra texlive-fonts-recommended \
librsvg2-bin latexmk \
pdftk xsltproc latexmk cm-super

- name: Build the document
run: make biblio ${{ env.doc_name }}-draft.pdf
make ${{ env.doc_name }}-draft.pdf

- name: Check the output
run: |
Expand Down
139 changes: 89 additions & 50 deletions HighEnergyObsCoreExt.tex
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,19 @@
\ivoagroup{High Energy Interest Group}

\author{
I. Evans (SAO/CXC, \href{mailto:ievans@cfa.harvard.edu}{ievans@cfa.harvard.edu},
M. Servillat (LUX - Observatoire de Paris, \href{mailto:mathieu.servillat@obspm.fr}{mathieu.servillat@obspm.fr},
B. Khélifi (APC - Université de Paris Cité/CNRS, \href{mailto:khelifi@in2p3.fr}{khelifi@in2p3.fr}),
J. Evans (SAO/CXC, \href{mailto:janet@cfa.harvard.edu}{janet@cfa.harvard.edu}),
M. Louys (CDS and ICube - Université de Strasbourg, \href{mailto:mireille.louys@unistra.fr}{mireille.louys@unistra.fr}),
M. Kettenis (Joint Institute for VLBI ERIC, \href{mailto:kettenis@jive.eu}{kettenis@jive.eu}),
F. Bonnarel (IVOA, \href{mailto:francois.bonnarel@gmail.com}{francois.bonnarel@gmail.com}),
L. Michel (SSC-XMM/SVOM - Strasbourg Observatory, \href{mailto:laurent.michel@astro.unistra.fr}{laurent.michel@astro.unistra.fr}),
C. Boisson (LUX - Observatoire de Paris, \href{mailto:catherine.boisson@obspm.fr}{catherine.boisson@obspm.fr}),
M. Cresitello-Dittmar (SAO/CXC, \href{mailto:mdittmar@cfa.harvard.edu}{mdittmar@cfa.harvard.edu}),
O. Ates (LUX - ObsParis, \href{mailto:onur.ates@obspm.fr}{onur.ates@obspm.fr}),
K. Kosack (IRFU - CEA/Université Paris-Saclay, \href{mailto:karl.kosack@cea.fr}{karl.kosack@cea.fr}),
J. Schnabel (ECAP, \href{mailto:jutta.schnabel@fau.de}{jutta.schnabel@fau.de}),
I. Evans (SAO/CXC, \href{mailto:ievans@cfa.harvard.edu}{ievans@cfa.harvard.edu},\\
M. Servillat (LUX - Observatoire de Paris, \href{mailto:mathieu.servillat@obspm.fr}{mathieu.servillat@obspm.fr},\\
B. Khélifi (APC - Université de Paris Cité/CNRS, \href{mailto:khelifi@in2p3.fr}{khelifi@in2p3.fr}),\\
J. Evans (SAO/CXC, \href{mailto:janet@cfa.harvard.edu}{janet@cfa.harvard.edu}),\\
M. Louys (CDS and ICube - Université de Strasbourg, \href{mailto:mireille.louys@unistra.fr}{mireille.louys@unistra.fr}),\\
M. Kettenis (Joint Institute for VLBI ERIC, \href{mailto:kettenis@jive.eu}{kettenis@jive.eu}),\\
F. Bonnarel (IVOA, \href{mailto:francois.bonnarel@gmail.com}{francois.bonnarel@gmail.com}),\\
L. Michel (SSC-XMM/SVOM - Strasbourg Observatory, \href{mailto:laurent.michel@astro.unistra.fr}{laurent.michel@astro.unistra.fr}),\\
C. Boisson (LUX - Observatoire de Paris, \href{mailto:catherine.boisson@obspm.fr}{catherine.boisson@obspm.fr}),\\
M. Cresitello-Dittmar (SAO/CXC, \href{mailto:mdittmar@cfa.harvard.edu}{mdittmar@cfa.harvard.edu}),\\
O. Ates (LUX - ObsParis, \href{mailto:onur.ates@obspm.fr}{onur.ates@obspm.fr}),\\
K. Kosack (IRFU - CEA/Université Paris-Saclay, \href{mailto:karl.kosack@cea.fr}{karl.kosack@cea.fr}),\\
J. Schnabel (ECAP, \href{mailto:jutta.schnabel@fau.de}{jutta.schnabel@fau.de}),\\
S. Hallmann (DESY Zeuthen, \href{mailto:steffen.hallmann@desy.de}{steffen.hallmann@desy.de}),
}

Expand All @@ -37,24 +37,27 @@
\usepackage{lscape}
%\usepackage{minted}
\setlength {\marginparwidth }{2cm}

\usepackage{todonotes}
\usepackage{array}
\usepackage{amsmath}
\usepackage{amssymb}
\usepackage[nopostdot,style=super,nonumberlist,toc]{glossaries}
\usepackage{hyperref}
\usepackage{hyperref}
\usepackage{hyperref}
\usepackage{hyperref}
\usepackage{hyperref}
\usepackage{hyperref}
\usepackage{hyperref}
\usepackage{hyperref}
\usepackage{hyperref}
\usepackage{hyperref}
\usepackage{hyperref}
\usepackage{hyperref}


% mireille : in order to flag changes to fill
\newcommand{\TODO}[1]{%
\noindent%
\colorbox{todocolor}{%
\parbox{0.85\linewidth}{\sffamily \textbf{TODO:}\\
#1}
}%
\vspace{2pt}
}


%glossary
\newacronym{IVOA}{IVOA}{International Virtual Observatory Alliance}
\newacronym{VO}{VO}{Virtual Observatory}
\newacronym{HE}{HE}{High Energy}
Expand Down Expand Up @@ -408,6 +411,8 @@ \subsubsection{Event Bundle}

An {\bf event-bundle} might for example consist of an {\bf event-list} and the associated {\bf response-function}s used to calibrate the dataset, and may also contain provenance information, data quality time-series, and preview images or plots.



\subsubsection{Advanced Data Products}

In addition to data product types that focus on event data, we note that existing ObsCore definitions do not adequately span the breadth of advanced data products (typically with {\em calib\_level\/}${}\ge 3$) that may be generated from astronomical observations. The computational complexity of analyzing \gls{HEA} data robustly in the extreme Poisson regime ({\em e.g.\/}, Bayesian X-ray aperture photometry applied simultaneously to multiple overlapping detections and observations) means that data providers may choose to provide such analysis products directly to the end user.
Expand Down Expand Up @@ -599,48 +604,82 @@ \subsection{MIME-type Enhancements}\label{sec:mimetypes}
\section{Proposed ivoa.obscore\_hea Table Attributes}\label{sec:ibscoreext}

This section summarizes the proposal for the \gls{HEA} extension of ObsCore. We use the term {\em ivoa.obscore\_hea\/} to described the extension here and in Appendix~\ref{sec:uc}.
% start mireille ucd update

\begin{landscape}
\begin{center}
%\begin{longtable}{ | m{2.5cm} | m{3em} | m{3em} | m{3em} | m{6cm} | m{2.3em} |}
\begin{longtable}{ | p{0.125\linewidth} | p{0.075\linewidth} | p{0.075\linewidth} | p{0.075\linewidth} | p{0.6\linewidth} | p{0.05\linewidth} |}
\hline
{\centering \bf Column Name} &{\centering \bf UType} &{\centering \bf Unit} &{\centering \bf Type} &{\centering \bf Description} &{\centering \bf MAN}\\
\hline
{\em ev\_xel\/} & TBD & unitless & integer & Number of events in an event list & NO \\
\begin{longtable}{ | m{2.5cm} | m{4em} | m{3em} | m{3em} | m{6cm} | m{2.3em} |}
\hline
{\em s\_ref\_energy\/} & TBD & eV & double & Energy at which the ObsCore spatial characterization attributes {\em s\_fov\/}, {\em s\_region\/}, {\em s\_resolution\/} are defined & NO \\

{\centering \bf Column Name} &{\centering \bf UCD} &{\centering \bf Unit} &{\centering \bf Type} &{\centering \bf Description} &{\centering \bf MAN}\\
\hline
{\em em\_ref\_energy\/} & TBD & eV & double & Energy at which the ObsCore spectral characterization attributes {\em em\_res\_power\/}, {\em em\_resolution} are defined & NO \\
ev\_xel & \ucd{meta.number;obs.event} & unitless & int & {\footnotesize Number of events in an event\_list }& NO \\
\hline
{\em s\_ref\_oaa\/} & TBD & deg & double & Off-axis angle ({\em i.e.\/}, the angular separation of the target or source from the telescope optical axis) at which the ObsCore spatial characterization attributes {\em s\_fov\/}, {\em s\_region\/}, {\em s\_resolution\/} are defined & NO \\
s\_ref\_energy & \ucd{meta.ref;em.energy;pos} & eV & float & {\footnotesize Energy at which the ObsCore spatial characterisation attributes s\_fov , s\_region, s\_resolution are defined} & NO \\
\hline
{\em em\_ref\_oaa\/} & TBD & deg & double & Off-axis angle ({\em i.e.\/}, the angular separation of the target or source from the telescope optical axis) at which the ObsCore spectral characterization attributes {\em em\_res\_power\/}, {\em em\_resolution\/} are defined & NO \\
em\_ref\_energy & \ucd{meta.ref;em.energy;em} & eV & float & {\footnotesize Energy at which the ObsCore spatial characterisation attributes em\_res\_power, em\_resolution are defined} & NO \\
\hline
{\em t\_intervals\/} & TBD & unitless & string & List of observation intervals or stable/good time intervals describing the exact observation time coverage as a TMOC & NO \\
s\_ref\_oaa & \ucd{pos.posAng;instr.offset;pos} & deg & float & {\footnotesize Off-axis angle (i.e., the angular separation of the target or source from the telescope optical axis) at which the ObsCore spatial characterisation attributes s\_fov , s\_region, s\_resolution are defined} & NO \\
\hline
{\em energy\_min\/} & TBD & eV & double & Energy associated to the ObsCore attribute {\em em\_max\/}, describing the minimum energy of the dataset & NO \\
em\_ref\_oaa & \ucd{pos.posAng;instr.offset;em} & deg & float & {\footnotesize Off-axis angle (i.e., the angular separation of the target or source from the telescope optical axis) at which the ObsCore spectral characterisation attributes em\_res\_power, em\_resolution are defined} & NO \\
\hline
{\em energy\_max\/} & TBD & eV & double & Energy associated to the ObsCore attribute {\em em\_min\/}, describing the maximum energy of the dataset & NO \\
t\_intervals & \ucd{?? }& unitless & TMOC & {\footnotesize List of observation intervals or stable/good time intervals describing the exact observation time coverage} & NO \\
\hline
{\em obs\_mode\/} & TBD & unitless & string & Observation mode of an observation & NO \\
energy\_min & \ucd{em.energy;stat.min} & float & eV & {\footnotesize Energy associated to the Obscore attribute em\_max, describing the minimal energy of the dataset} & NO \\
\hline
{\em tracking\_type\/} & TBD & unitless & string & Tracking type of an observation & NO \\
energy\_max & \ucd{em.energy;stat.max} & float & eV & {\footnotesize Energy associated to the Obscore attribute em\_min, describing the maximal energy of the dataset} & NO \\
\hline
{\em scan\_mode\/} & TBD & unitless & string & Scan mode of an observation & NO \\
obs\_mode & \ucd{meta.code;obs.param} & unitless & string &{\footnotesize Observation mode of the observation (e.g. TBU)} & NO \\
\hline
{\em pointing\_mode\/} & TBD & unitless & string & Pointing mode of an observation & NO \\
tracking\_mode & \ucd{meta.code;obs.param} & unitless & string & {\footnotesize Tracking mode of an observation (e.g., sidereal rate, moving target [solar system] tracking, drift scans)} & NO \\
\hline
{\em analysis\_mode\/} & TBD & unitless & string & Data reduction/analysis mode & NO \\
analysis\_mode & \ucd{meta.code;obs.param} & unitless & string &{\footnotesize Data reduction/analysis mode}& NO \\
\hline
{\em event\_type\/} & TBD & unitless & string & Event subset indicator ({\em e.g.\/}, data quality flag for the events) & NO \\
event\_type & \ucd{meta.code.qual;obs.event} & unitless & string &{\footnotesize Data quality flag of the events (e.g. ``good psf'', ``good rejection'', ``Nhit (100,200)''} & NO \\
\hline
\caption{Attributes for the \gls{HEA} Extension of ObsCore}
\label{tab:hea_ext_attr}
\end{longtable}
\end{center}
\end{landscape}

%\end{center}


% end mireille ucd update
%\begin{landscape}
%\begin{center}
%%\begin{longtable}{ | m{2.5cm} | m{3em} | m{3em} | m{3em} | m{6cm} | m{2.3em} |}
%\begin{longtable}{ | p{0.125\linewidth} | p{0.075\linewidth} | p{0.075\linewidth} | p{0.075\linewidth} | p{0.6\linewidth} | p{0.05\linewidth} |}
%\hline
%{\centering \bf Column Name} &{\centering \bf UType} &{\centering \bf Unit} &{\centering \bf Type} &{\centering \bf Description} &{\centering \bf MAN}\\
%\hline
%{\em ev\_xel\/} & TBD & unitless & integer & Number of events in an event list & NO \\
%\hline
%{\em s\_ref\_energy\/} & TBD & eV & double & Energy at which the ObsCore spatial characterization attributes {\em s\_fov\/}, {\em s\_region\/}, {\em s\_resolution\/} are defined & NO \\
%\hline
%{\em em\_ref\_energy\/} & TBD & eV & double & Energy at which the ObsCore spectral characterization attributes {\em em\_res\_power\/}, {\em em\_resolution} are defined & NO \\
%\hline
%{\em s\_ref\_oaa\/} & TBD & deg & double & Off-axis angle ({\em i.e.\/}, the angular separation of the target or source from the telescope optical axis) at which the ObsCore spatial characterization attributes {\em s\_fov\/}, {\em s\_region\/}, {\em s\_resolution\/} are defined & NO \\
%\hline
%{\em em\_ref\_oaa\/} & TBD & deg & double & Off-axis angle ({\em i.e.\/}, the angular separation of the target or source from the telescope optical axis) at which the ObsCore spectral characterization attributes {\em em\_res\_power\/}, {\em em\_resolution\/} are defined & NO \\
%\hline
%{\em t\_intervals\/} & TBD & unitless & string & List of observation intervals or stable/good time intervals describing the exact observation time coverage as a TMOC & NO \\
%\hline
%{\em energy\_min\/} & TBD & eV & double & Energy associated to the ObsCore attribute {\em em\_max\/}, describing the minimum energy of the dataset & NO \\
%\hline
%{\em energy\_max\/} & TBD & eV & double & Energy associated to the ObsCore attribute {\em em\_min\/}, describing the maximum energy of the dataset & NO \\
%\hline
%{\em obs\_mode\/} & TBD & unitless & string & Observation mode of an observation & NO \\
%\hline
%{\em tracking\_type\/} & TBD & unitless & string & Tracking type of an observation & NO \\
%\hline
%{\em scan\_mode\/} & TBD & unitless & string & Scan mode of an observation & NO \\
%\hline
%{\em pointing\_mode\/} & TBD & unitless & string & Pointing mode of an observation & NO \\
%\hline
%{\em analysis\_mode\/} & TBD & unitless & string & Data reduction/analysis mode & NO \\
%\hline
%{\em event\_type\/} & TBD & unitless & string & Event subset indicator ({\em e.g.\/}, data quality flag for the events) & NO \\
%\hline
%\caption{Attributes for the \gls{HEA} Extension of ObsCore}
%\label{tab:hea_ext_attr}
%\end{longtable}
%\end{center}
%\end{landscape}

\pagebreak
%\printglossaries
Expand Down
4 changes: 2 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@ DOCNAME = HighEnergyObsCoreExt
DOCVERSION = 1.0

# Publication date, ISO format; update manually for "releases"
DOCDATE = 2025-11-12
DOCDATE = 2026-04-27

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

# An e-mail address of the person doing the submission to the document
# repository (can be empty until a make upload is being made)
AUTHOR_EMAIL=???
AUTHOR_EMAIL=ian.evans@ , bruno.khelifi@, mathieu.servillat@

# Source files for the TeX document (but the main file must always
# be called $(DOCNAME).tex)
Expand Down
102 changes: 102 additions & 0 deletions VEP/VEP-25_response-function.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
Vocabulary: http://www.ivoa.net/rdf/response-type
Author: Mireille Louys for HEIG IG <mireille.louys@unistra.fr>
Date: 2025-11-13

New Term: response-function
Action: Addition
Label: response-function
Description:
A data product type describing instrumental response functions for calibration and analysis.

Relationships: response-function is a top level term.
Usually related to an event-list data product in high energy astrophysics.

Used-in: Data sets made accessible via the Chandra CS2 catalog

Rationale:
The distribution of event-list data in multi-messenger astronomy.
For example, Chandra primary products distributed via the Chandra
Data Archive include around half a dozen different types of products neces-
sary to analyse Chandra data (for example, L2 event-list, Aspect solution,
bad pixel map, spacecraft ephemeris, V&V Report).
For VHE gamma rays and neutrinos, the DL3 event-lists should manda-
torily be associated to their associated IRFs files. The links between the
event-list and these IRFs should be well defined in the event-bundle.
----------
New Term: Point Spread Function
Action: Addition
Label: psf
Description: A dataset that records the probability density function of
spatial/angular spreading of incident photons from a point source caused
by the instrument (detector and/or mirror and/or analysis)

Relationships: narrower than #response-function

Used-in: HESS test data release (https://doi.org/10.5281/zenodo.1421099)


----------
New Term: Effective Area
Action: Addition
Label: aeff
Description: A dataset that records the “effective area” of a telescope
and/or instrument. The effective area is the geometric area
of the telescope and/or instrument reduced by efficiency factors
such as reflectivity and vignetting, cuts efficiency, among other effects

Relationships: narrower than #response-function

Used-in: HESS test data release (https://doi.org/10.5281/zenodo.1421099)

----------
New Term: Ancillary Response File
Action: Addition
Label: arf
Description: A dataset that records the
combined telescope/instru-
ment effective area and
detector quantum efficiency as
a function of energy

Relationships: narrower than #response-function

Used-in: XMM data products ?

----------
New Term: Background Rate
Action: Addition
Label: bkgrate
Description: A dataset that models the rate of residual events that are
not from the expected source type (e.g. for gamma-ray instrument it
measures residual non-gamma-ray events coming).

Relationships: narrower than #response-function

Used-in: HESS test data release (https://doi.org/10.5281/zenodo.1421099)
----------
New Term: Energy Dispersion
Action: Addition
Label: edisp
Description: A dataset that records the
probability density of detecting an event with an energy estimator given the true
energy of the event.

Relationships: narrower than #response-function

Used-in: HESS test data release (https://doi.org/10.5281/zenodo.1421099)

----------
New Term: Redistribution Matrix File
Action: Addition
Label: rmf
Description: A dataset that records the probability density function
mapping from energy space into detector pulse height (or position) space

Relationships: narrower than #response-function

Used-in: Chandra response data products ?

Reference:
- IVOA Note: https://github.com/ivoa/HighEnergyObsCoreExt section 5.1.5
- IVOA Note Virtual Observatory and High Energy Astrophysics Version 1.0
https://ivoa.net/documents/Notes/VOHE/20241112/VOHE-Note-draft_1.0.pdf
18 changes: 18 additions & 0 deletions VEPforUCD/VEP-UCD-27-stat_confidencelevel.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
Vocabulary extension proposal for UCDs /

Vocabulary: http://www.ivoa.net/rdf/datalink/core
Author: mireille.louys@astro.unistra.fr with EST solar group
Date: 2026-02-11
Nb of terms discussed together : 1
-----------------------

New Term: stat.confidenceLevel
Action: Amendement
Label: Level of confidence for *a statistical measure*, detection or classification process

Description: statistical confidence level to assess a statistical distribution.
In the analysis of statistical products, the stat confidence levels is used to establish data quality.

Rationale: Enhance definition of term to include statistical measures

Used_in: Statistical data sets
Loading
Loading