llama.files.lvc_skymap package

FileHandler classes related to working with skymaps provided by the LIGO-Virgo Collaboration (LVC).

exception llama.files.lvc_skymap.SkymapNotFoundError

Bases: OSError

Raised when a valid skymap cannot be found or downloaded from GraceDb.

class llama.files.lvc_skymap.LvcSkymapFits

Bases: llama.files.healpix.LvcHEALPixSkyMapFileHandler, llama.filehandler.GenerateOnceMixin, llama.filehandler.mixins.ObservingVetoMixin

digraph "llama.files.lvc_skymap.LvcSkymapFits" { charset="utf-8" splines=ortho bgcolor=none margin=0 rankdir=LR "llama.files.lvc_skymap.LvcSkymapFits" [label=<{{<B>LvcSkymapFits</B>|<I>lvc_skymap.fits.gz</I>|LvcHEALPixSkyMapFileHandler<BR/>GenerateOnceMixin<BR/>ObservingVetoMixin}}>, shape="record", style=filled, target=_top, URL="/llama.files.lvc_skymap.html#llama.files.lvc_skymap.LvcSkymapFits", fillcolor="#cccccc"]; "llama.files.skymap_info.SkymapInfo" [label=<{{<B>SkymapInfo</B>|<I>skymap_info.json</I>|EventTriggeredFileHandler<BR/>JSONFile}}>, shape="record", style=filled, target=_top, URL="/llama.files.skymap_info.html#llama.files.skymap_info.SkymapInfo", fillcolor="#cccccc"]; "llama.files.skymap_info.SkymapInfo" -> "llama.files.lvc_skymap.LvcSkymapFits" [arrowtail="none", color="red", ]; }

Required input files for llama.files.lvc_skymap.LvcSkymapFits (located on the far right of the graph). For a typical trigger, the leftmost files will be generated as triggers become available. They will be used as input for files to their right, eventually allowing llama.files.lvc_skymap.LvcSkymapFits to be generated.

The skymap suggested by the LVC Initial GCN Notice.

DEPENDENCIES = (<class 'llama.files.skymap_info.SkymapInfo'>,)
DETECTORS = (Detector(name='LVC', abbrev='lvc', fullname='LVC', url='http://wiki.ligo.org', summary='LVC', description='', citations=ImmutableDict({})),)
FILENAME = 'lvc_skymap.fits.gz'
MANIFEST_TYPES = (<class 'llama.files.lvc_skymap.LvcSkymapFits'>,)
UR_DEPENDENCIES = (<class 'llama.files.skymap_info.SkymapInfo'>,)
UR_DEPENDENCY_TREE = ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})})
class llama.files.lvc_skymap.LvcDistancesJson

Bases: llama.filehandler.JSONFile

digraph "llama.files.lvc_skymap.LvcDistancesJson" { charset="utf-8" splines=ortho bgcolor=none margin=0 rankdir=LR "llama.files.lvc_skymap.LvcDistancesJson" [label=<{{<B>LvcDistancesJson</B>|<I>lvc_skymap_distances.json</I>|JSONFile}}>, shape="record", style=filled, target=_top, URL="/llama.files.lvc_skymap.html#llama.files.lvc_skymap.LvcDistancesJson", fillcolor="#cccccc"]; "llama.files.lvc_skymap.LvcSkymapFits" [label=<{{<B>LvcSkymapFits</B>|<I>lvc_skymap.fits.gz</I>|LvcHEALPixSkyMapFileHandler<BR/>GenerateOnceMixin<BR/>ObservingVetoMixin}}>, shape="record", style=filled, target=_top, URL="/llama.files.lvc_skymap.html#llama.files.lvc_skymap.LvcSkymapFits", fillcolor="#cccccc"]; "llama.files.skymap_info.SkymapInfo" [label=<{{<B>SkymapInfo</B>|<I>skymap_info.json</I>|EventTriggeredFileHandler<BR/>JSONFile}}>, shape="record", style=filled, target=_top, URL="/llama.files.skymap_info.html#llama.files.skymap_info.SkymapInfo", fillcolor="#cccccc"]; "llama.files.lvc_skymap.LvcSkymapFits" -> "llama.files.lvc_skymap.LvcDistancesJson" [arrowtail="none", color="red", ]; "llama.files.skymap_info.SkymapInfo" -> "llama.files.lvc_skymap.LvcSkymapFits" [arrowtail="none", color="red", ]; }

Required input files for llama.files.lvc_skymap.LvcDistancesJson (located on the far right of the graph). For a typical trigger, the leftmost files will be generated as triggers become available. They will be used as input for files to their right, eventually allowing llama.files.lvc_skymap.LvcDistancesJson to be generated.

A simple JSON file with the reconstructed distances to an event. Contains the mean reconstructed distance as distmean and the standard deviation as diststd.

DEPENDENCIES = (<class 'llama.files.lvc_skymap.LvcSkymapFits'>,)
FILENAME = 'lvc_skymap_distances.json'
MANIFEST_TYPES = (<class 'llama.files.lvc_skymap.LvcDistancesJson'>,)
UR_DEPENDENCIES = (<class 'llama.files.skymap_info.SkymapInfo'>, <class 'llama.files.lvc_skymap.LvcSkymapFits'>)
UR_DEPENDENCY_TREE = ImmutableDict({<class 'llama.files.lvc_skymap.LvcSkymapFits'>: ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})})})
distmean

The mean distance to the event; a probability-weighted average of reconstructed distances. Extracted from the original LVC skymap.

diststd

The probability-weighted standard deviation of the reconstructed distance to the event. Extracted from the original LVC skymap.

class llama.files.lvc_skymap.LvcSkymapHdf5

Bases: llama.files.healpix.HEALPixSkyMapFileHandler

digraph "llama.files.lvc_skymap.LvcSkymapHdf5" { charset="utf-8" splines=ortho bgcolor=none margin=0 rankdir=LR "llama.files.lvc_skymap.LvcSkymapFits" [label=<{{<B>LvcSkymapFits</B>|<I>lvc_skymap.fits.gz</I>|LvcHEALPixSkyMapFileHandler<BR/>GenerateOnceMixin<BR/>ObservingVetoMixin}}>, shape="record", style=filled, target=_top, URL="/llama.files.lvc_skymap.html#llama.files.lvc_skymap.LvcSkymapFits", fillcolor="#cccccc"]; "llama.files.lvc_skymap.LvcSkymapHdf5" [label=<{{<B>LvcSkymapHdf5</B>|<I>lvc_skymap.hdf5</I>|HEALPixSkyMapFileHandler}}>, shape="record", style=filled, target=_top, URL="/llama.files.lvc_skymap.html#llama.files.lvc_skymap.LvcSkymapHdf5", fillcolor="#cccccc"]; "llama.files.skymap_info.SkymapInfo" [label=<{{<B>SkymapInfo</B>|<I>skymap_info.json</I>|EventTriggeredFileHandler<BR/>JSONFile}}>, shape="record", style=filled, target=_top, URL="/llama.files.skymap_info.html#llama.files.skymap_info.SkymapInfo", fillcolor="#cccccc"]; "llama.files.lvc_skymap.LvcSkymapFits" -> "llama.files.lvc_skymap.LvcSkymapHdf5" [arrowtail="none", color="red", ]; "llama.files.skymap_info.SkymapInfo" -> "llama.files.lvc_skymap.LvcSkymapFits" [arrowtail="none", color="red", ]; }

Required input files for llama.files.lvc_skymap.LvcSkymapHdf5 (located on the far right of the graph). For a typical trigger, the leftmost files will be generated as triggers become available. They will be used as input for files to their right, eventually allowing llama.files.lvc_skymap.LvcSkymapHdf5 to be generated.

An HDF5-formatted copy of the initial LVC skymap. Loads more quickly.

DEPENDENCIES = (<class 'llama.files.lvc_skymap.LvcSkymapFits'>,)
DETECTORS = (Detector(name='LVC', abbrev='lvc', fullname='LVC', url='http://wiki.ligo.org', summary='LVC', description='', citations=ImmutableDict({})),)
FILENAME = 'lvc_skymap.hdf5'
MANIFEST_TYPES = (<class 'llama.files.lvc_skymap.LvcSkymapHdf5'>,)
UR_DEPENDENCIES = (<class 'llama.files.skymap_info.SkymapInfo'>, <class 'llama.files.lvc_skymap.LvcSkymapFits'>)
UR_DEPENDENCY_TREE = ImmutableDict({<class 'llama.files.lvc_skymap.LvcSkymapFits'>: ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})})})
llama.files.lvc_skymap.skymap_filenames(filenames)

Return only filenames from filenames that could be skymap filenames.

llama.files.lvc_skymap.available_skymaps(graceid)

Get a list of available skymap logs in ascending order of creation time from GraceDB for a given graceid.

Submodules