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.filehandler.GenerateOnceMixin
,llama.files.healpix.LvcHEALPixSkyMapFileHandler
,llama.filehandler.mixins.OnlineVetoMixin
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
= frozenset({<class 'llama.files.skymap_info.SkymapInfo'>})¶
-
-
class
llama.files.lvc_skymap.
LvcDistancesJson
¶ Bases:
llama.filehandler.JSONFile
A simple JSON file with the reconstructed distances to an event. Contains the mean reconstructed distance as
distmean
and the standard deviation asdiststd
.-
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
= frozenset({<class 'llama.files.lvc_skymap.LvcSkymapFits'>})¶
-
property
distmean
¶ The mean distance to the event; a probability-weighted average of reconstructed distances. Extracted from the original LVC skymap.
-
property
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
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
= frozenset({<class 'llama.files.lvc_skymap.LvcSkymapFits'>})¶
-
-
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