Maintenance will be performed on git.ligo.org, chat.ligo.org, containers.ligo.org, and docs.ligo.org on Tuesday 26 May 2020 starting at approximately 10am CDT. It is expected to take around 30 minutes and will involve a short period of downtime, around 5 minutes, towards the end of the maintenance period. Please address any questions, comments, or concerns to uwm-help@cgca.uwm.edu.

Commit 1766c517 authored by Leo Pound Singer's avatar Leo Pound Singer

Change UNIQ column to a signed integer

Fixes #115.

See also lscsoft/ligo.skymap!109, lscsoft/ligo.skymap!110.
parent fb5fc3be
No preview for this file type
This diff is collapsed.
......@@ -20,6 +20,31 @@ Version 10 (unreleased)
.. rubric:: Alert Contents
* Changed the data type of the ``UNIQ`` column of the multi-order sky map
format from an unsigned integer to a signed integer as specified by the
`MOC-in-FITS standard`_.
This will improve interoperability with the `mrdfits`_ function from the `IDL
Astronomy User's Library`_ and the `fv FITS Viewer`_ from `FTOOLS`_, both of
which were reported to have problems with the old unsigned integer column. It
will also make it simpler to work with Numpy indexing operations, since Numpy
uses a signed integer type for indexing.
This change will go into effect in the LIGO/Virgo low-latency alert system on
2019-08-06.
Users of `ligo.skymap`_ should update to version 0.1.8 or newer because older
versions will be unable to read old files with unsigned ``UNIQ`` columns. The
new version of ``ligo.skymap`` can read files with either signed or unsigned
``UNIQ`` columns.
.. _`MOC-in-FITS standard`: http://www.ivoa.net/documents/MOC/
.. _`mrdfits`: https://idlastro.gsfc.nasa.gov/ftp/pro/fits/mrdfits.pro
.. _`IDL Astronomy User's Library`: https://idlastro.gsfc.nasa.gov/homepage.html
.. _`fv FITS Viewer`: https://heasarc.gsfc.nasa.gov/ftools/fv/
.. _`FTOOLS`: https://heasarc.gsfc.nasa.gov/ftools/
.. _`ligo.skymap`: https://lscsoft.docs.ligo.org/ligo.skymap/
.. rubric:: Sample Code
Version 9 (2019-06-13)
......
......@@ -68,6 +68,7 @@ Mpc
multimessenger
Nissanke
Nitz
Numpy
observability
offline
online
......
......@@ -162,7 +162,6 @@ Let's look at the FITS header:
TFIELDS = 5 / number of table fields
TTYPE1 = 'UNIQ '
TFORM1 = 'K '
TZERO1 = 9223372036854775808
TTYPE2 = 'PROBDENSITY'
TFORM2 = 'D '
TUNIT2 = 'sr-1 '
......@@ -175,7 +174,6 @@ Let's look at the FITS header:
TTYPE5 = 'DISTNORM'
TFORM5 = 'D '
TUNIT5 = 'Mpc-2 '
NEST = T
PIXTYPE = 'HEALPIX ' / HEALPIX pixelisation
ORDERING= 'NUNIQ ' / Pixel ordering scheme: RING, NESTED, or NUNIQ
COORDSYS= 'C ' / Ecliptic, Galactic or Celestial (equatorial)
......@@ -189,14 +187,14 @@ Let's look at the FITS header:
DATE = '2018-11-01T22:34:49.000000' / UTC date of file creation
CREATOR = 'BAYESTAR' / Program that created this file
ORIGIN = 'LIGO/Virgo' / Organization responsible for this FITS file
RUNTIME = 9.0 / Runtime in seconds of the CREATOR program
RUNTIME = 3.24746292643249 / Runtime in seconds of the CREATOR program
DISTMEAN= 39.76999609489013 / Posterior mean distance (Mpc)
DISTSTD = 8.308435058808886 / Posterior standard deviation of distance (Mpc)
LOGBCI = 13.64819688928804 / Log Bayes factor: coherent vs. incoherent
LOGBSN = 261.0250944470225 / Log Bayes factor: signal vs. noise
VCSVERS = 'ligo.skymap 0.1.2' / Software version
VCSREV = '04e3cf9b553c471b50b6a5903fbc7d6555132b0b' / Software revision (Git)
DATE-BLD= '2019-02-28T20:40:29' / Software build date
VCSVERS = 'ligo.skymap 0.1.8' / Software version
VCSREV = 'becb07110491d799b753858845b5c24c82705404' / Software revision (Git)
DATE-BLD= '2019-07-25T22:36:58' / Software build date
HISTORY
HISTORY Generated by calling the following Python function:
HISTORY ligo.skymap.bayestar.localize(event=..., waveform='o2-uberbank', f_low=3
......@@ -205,8 +203,7 @@ Let's look at the FITS header:
HISTORY False, chain_dump=None, enable_snr_series=True, f_high_truncate=0.95)
HISTORY
HISTORY This was the command line that started the program:
HISTORY bayestar-localize-lvalert --enable-multiresolution -N G298107 -o bayesta
HISTORY r.fits
HISTORY bayestar-localize-lvalert -N G298107 -o bayestar.multiorder.fits
This should look very similar to the FITS header for the standard HEALPix file
from the :doc:`previous section <./skymaps>`. The key differences are:
......
......@@ -62,7 +62,6 @@ tools like funhead_ from Funtools_, imhead_ from WCSTools_, or
TTYPE4 = 'DISTNORM'
TFORM4 = 'D '
TUNIT4 = 'Mpc-2 '
NEST = T
PIXTYPE = 'HEALPIX ' / HEALPIX pixelisation
ORDERING= 'NESTED ' / Pixel ordering scheme: RING, NESTED, or NUNIQ
COORDSYS= 'C ' / Ecliptic, Galactic or Celestial (equatorial)
......@@ -72,18 +71,18 @@ tools like funhead_ from Funtools_, imhead_ from WCSTools_, or
REFERENC= 'https://example.org/superevents/MS181101ab/view/' / URL of this event
INSTRUME= 'H1,L1,V1' / Instruments that triggered this event
DATE-OBS= '2018-11-01T22:22:46.654437' / UTC date of the observation
MJD-OBS = 58423.93248442635 / modified Julian date of the observation
MJD-OBS = 58423.93248442613 / modified Julian date of the observation
DATE = '2018-11-01T22:34:49.000000' / UTC date of file creation
CREATOR = 'BAYESTAR' / Program that created this file
ORIGIN = 'LIGO/Virgo' / Organization responsible for this FITS file
RUNTIME = 9.0 / Runtime in seconds of the CREATOR program
RUNTIME = 3.24746292643249 / Runtime in seconds of the CREATOR program
DISTMEAN= 39.76999609489013 / Posterior mean distance (Mpc)
DISTSTD = 8.308435058808886 / Posterior standard deviation of distance (Mpc)
LOGBCI = 13.64819688928804 / Log Bayes factor: coherent vs. incoherent
LOGBSN = 261.0250944470225 / Log Bayes factor: signal vs. noise
VCSVERS = 'ligo.skymap 0.1.2' / Software version
VCSREV = '04e3cf9b553c471b50b6a5903fbc7d6555132b0b' / Software revision (Git)
DATE-BLD= '2019-02-28T20:40:29' / Software build date
VCSVERS = 'ligo.skymap 0.1.8' / Software version
VCSREV = 'becb07110491d799b753858845b5c24c82705404' / Software revision (Git)
DATE-BLD= '2019-07-25T22:36:58' / Software build date
HISTORY
HISTORY Generated by calling the following Python function:
HISTORY ligo.skymap.bayestar.localize(event=..., waveform='o2-uberbank', f_low=3
......@@ -92,8 +91,7 @@ tools like funhead_ from Funtools_, imhead_ from WCSTools_, or
HISTORY False, chain_dump=None, enable_snr_series=True, f_high_truncate=0.95)
HISTORY
HISTORY This was the command line that started the program:
HISTORY bayestar-localize-lvalert --enable-multiresolution -N G298107 -o bayesta
HISTORY r.fits
HISTORY bayestar-localize-lvalert -N G298107 -o bayestar.multiorder.fits
There are several useful pieces of information here:
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment