llama.files package¶

A collection of FileHandler classes for a given pipeline.

class llama.files.LvcSkymapFits¶

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

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 = frozenset({<class 'llama.files.skymap_info.SkymapInfo'>})¶

class llama.files.LvcSkymapHdf5¶

Bases: llama.files.healpix.HEALPixSkyMapFileHandler

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 = frozenset({<class 'llama.files.lvc_skymap.LvcSkymapFits'>})¶

class llama.files.LvcDistancesJson¶

Bases: llama.filehandler.JSONFile

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 = 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.IceCubeNeutrinoList¶

Bases: llama.filehandler.JSONFile, llama.files.healpix.skymap.HEALPixPSF

Required input files for llama.files.i3.json.IceCubeNeutrinoList (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.i3.json.IceCubeNeutrinoList to be generated.¶

Takes a list of dictionaries describing neutrinos and saves it to a text file. Validates the neutrino data to make sure each neutrino contains (minimally) the following properties:

mjd
zenith
azimuth
sigma
energy
type (one the values found in NEUTRINO_TYPES)

If this file is generated within the temporal search window for neutrinos, it is possible not all neutrinos needed for the final result will be available. In this case, the file will automatically become obsolete and will be regenerated after the window has elapsed.

Neutrinos from IceCube can be delayed due to communications issues; to combat this, when neutrinos are pulled from the online data stream after the temporal search window has elapsed, a check will be run to see if the next neutrino after the end of the search window is yet available. If it is not available, it is assumed that not all neutrinos needed for the search have arrived from south pole, and a GenerationError will be raised, allowing the pipeline to cooldown and retry the neutrino pull later.

Neutrinos pulled from before MJD_TOPIC_SWITCH_17_TO_BLANK will be automatically pulled from local GFU archives (stored online on LLAMA S3 and cached locally after use in llama.utils.CACHEDIR in *.npy format). Neutrinos from after this date will be pulled from the online GFU stream.

DEPENDENCIES = (<class 'llama.files.skymap_info.SkymapInfo'>,)¶

DETECTORS = (Detector(name='IceCube', abbrev='i3', fullname='IceCube', url='http://wiki.icecube.wisc.edu', summary='IceCube', description='', citations=ImmutableDict({})),)¶

FILENAME = 'icecube_neutrino_list.json'¶

MANIFEST_TYPES = (<class 'llama.files.i3.json.IceCubeNeutrinoList'>,)¶

UR_DEPENDENCIES = (<class 'llama.files.skymap_info.SkymapInfo'>,)¶

UR_DEPENDENCY_TREE = frozenset({<class 'llama.files.skymap_info.SkymapInfo'>})¶

downselect(ra=None, dec=None, ntype=None)¶

Downselect the neutrino list to match given criteria. Save the old neutrino list with the original filename prefixed by a timestamp and replace it with the downselected list.

Parameters

ra (list) – Right-ascension intervals (in degrees) that the neutrinos must fall into, e.g. [(21, 41),(92, 102)]
dec (list) – Decliination intervals (in degrees) that the neutrinos must fall into, e.g. [(-3, 20)]
ntype (str) – A type that the neutrino must match, e.g. 'observation' for real neutrinos.

end_of_neutrino_window()¶: The GPS time at which all neutrinos should be in under normal circumstances.

is_complete()¶: Whether the list of neutrinos is complete. Assumes incomplete if no complete key specified.

is_obsolete(checked=None, **kwargs)¶: IceCubeNeutrinoList files can be fetched immediately after a GW event becomes available. However, we want to eventually run our analysis on all neutrinos in a certain time window around an event. We therefore want to re-fetch the neutrinos in that time window after the time window has passed (allowing a safety factor for the IceCube GFU API to process new neutrino triggers). To do this, we mark the IceCubeNeutrinoList as obsolete if the current time is after the time window + safety margin has elapsed and the neutrino list was generated before that time had passed (meaning there might have been new neutrinos saved that are useful for the analysis after the file was originally generated). Standard FileHandler obsolescence criteria are also used to determine obsolescence through a call to super.

property neutrinos¶: Return a list containing a Neutrino object for each neutrino; more convenient to work with when writing formulae than dealing directly with the neutrino dictionaries.

property num_triggers¶: The number of triggers described by this file. Useful mostly for quickly determining if this trigger list is empty.

source_locations()¶: Returns a list of tuples of (RA, Dec, sigma) for all point-like sources, where (RA, Dec) is the central sky position and sigma is the standard deviation of the Gaussian PSF. Since this depends on the structure of data in the relevant file handler, it must be specified for each subclass.

property template_skymap_filehandler¶: The HEALPixSkyMapFileHandler whose HEALPix parameters should be used as a template for the HEALPixSkyMap output by this FileHandler. It is assumed that this HEALPixSkyMapFileHandler only returns one skymap in its list; consequently, only the first skymap loaded by this file handler will be used. Note that the template skymap file handler is likely not a dependency of this file handler; it is only used as a default for formatting generated skymaps from this file handler’s data.

class llama.files.IceCubeNeutrinoListTxt¶

Bases: llama.filehandler.FileHandler

Required input files for llama.files.i3.txt.IceCubeNeutrinoListTxt (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.i3.txt.IceCubeNeutrinoListTxt to be generated.¶

A space-delimited, table-formatted list of neutrinos formatted for human consumption in GCN Circulars.

DEPENDENCIES = (<class 'llama.files.i3.json.IceCubeNeutrinoList'>, <class 'llama.files.skymap_info.SkymapInfo'>)¶

FILENAME = 'icecube_neutrino_list.txt'¶

MANIFEST_TYPES = (<class 'llama.files.i3.txt.IceCubeNeutrinoListTxt'>,)¶

UR_DEPENDENCIES = (<class 'llama.files.skymap_info.SkymapInfo'>, <class 'llama.files.i3.json.IceCubeNeutrinoList'>)¶

UR_DEPENDENCY_TREE = ImmutableDict({<class 'llama.files.i3.json.IceCubeNeutrinoList'>: ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})}), <class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})})¶

class llama.files.IceCubeNeutrinoListCoincTxt¶

Bases: llama.filehandler.FileHandler

Required input files for llama.files.i3.txt.IceCubeNeutrinoListCoincTxt (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.i3.txt.IceCubeNeutrinoListCoincTxt to be generated.¶

A space-delimited, table-formatted list of neutrinos meant for human consumption in GCN Circulars. Contains coincidence significance measures in addition to the base neutrino properties.

DEPENDENCIES = (<class 'llama.files.i3.json.IceCubeNeutrinoList'>, <class 'llama.files.skymap_info.SkymapInfo'>, <class 'llama.files.coinc_significance.opa.CoincSignificanceI3Lvc'>)¶

FILENAME = 'icecube_neutrino_list_coinc.txt'¶

MANIFEST_TYPES = (<class 'llama.files.i3.txt.IceCubeNeutrinoListCoincTxt'>,)¶

UR_DEPENDENCIES = (<class 'llama.files.skymap_info.SkymapInfo'>, <class 'llama.files.lvc_skymap.LvcSkymapFits'>, <class 'llama.files.i3.json.IceCubeNeutrinoList'>, <class 'llama.files.gracedb.LVCGraceDbEventData'>, <class 'llama.files.lvc_skymap.LvcDistancesJson'>, <class 'llama.files.lvc_skymap.LvcSkymapHdf5'>, <class 'llama.files.gracedb.PAstro'>, <class 'llama.files.coinc_significance.opa.CoincSignificanceI3Lvc'>)¶

UR_DEPENDENCY_TREE = ImmutableDict({<class 'llama.files.coinc_significance.opa.CoincSignificanceI3Lvc'>: ImmutableDict({<class 'llama.files.gracedb.PAstro'>: ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})}), <class 'llama.files.lvc_skymap.LvcSkymapHdf5'>: ImmutableDict({<class 'llama.files.lvc_skymap.LvcSkymapFits'>: ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})})}), <class 'llama.files.lvc_skymap.LvcDistancesJson'>: ImmutableDict({<class 'llama.files.lvc_skymap.LvcSkymapFits'>: ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})})}), <class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({}), <class 'llama.files.gracedb.LVCGraceDbEventData'>: ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})}), <class 'llama.files.i3.json.IceCubeNeutrinoList'>: ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})})}), <class 'llama.files.i3.json.IceCubeNeutrinoList'>: ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})}), <class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})})¶

class llama.files.IceCubeNeutrinoListTex¶

Bases: llama.filehandler.FileHandler

Required input files for llama.files.i3.tex.IceCubeNeutrinoListTex (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.i3.tex.IceCubeNeutrinoListTex to be generated.¶

A list of neutrinos and their reconstructed properties as well as the significance of the joint event) in LaTeX format suitable for use in papers and coincident skymap summary plots.

DEPENDENCIES = (<class 'llama.files.i3.json.IceCubeNeutrinoList'>, <class 'llama.files.skymap_info.SkymapInfo'>, <class 'llama.files.coinc_significance.opa.CoincSignificanceI3Lvc'>)¶

FILENAME = 'IceCubeNeutrinoList.tex'¶

MANIFEST_TYPES = (<class 'llama.files.i3.tex.IceCubeNeutrinoListTex'>,)¶

UR_DEPENDENCIES = (<class 'llama.files.skymap_info.SkymapInfo'>, <class 'llama.files.lvc_skymap.LvcSkymapFits'>, <class 'llama.files.i3.json.IceCubeNeutrinoList'>, <class 'llama.files.gracedb.LVCGraceDbEventData'>, <class 'llama.files.lvc_skymap.LvcDistancesJson'>, <class 'llama.files.lvc_skymap.LvcSkymapHdf5'>, <class 'llama.files.gracedb.PAstro'>, <class 'llama.files.coinc_significance.opa.CoincSignificanceI3Lvc'>)¶

UR_DEPENDENCY_TREE = ImmutableDict({<class 'llama.files.coinc_significance.opa.CoincSignificanceI3Lvc'>: ImmutableDict({<class 'llama.files.gracedb.PAstro'>: ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})}), <class 'llama.files.lvc_skymap.LvcSkymapHdf5'>: ImmutableDict({<class 'llama.files.lvc_skymap.LvcSkymapFits'>: ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})})}), <class 'llama.files.lvc_skymap.LvcDistancesJson'>: ImmutableDict({<class 'llama.files.lvc_skymap.LvcSkymapFits'>: ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})})}), <class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({}), <class 'llama.files.gracedb.LVCGraceDbEventData'>: ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})}), <class 'llama.files.i3.json.IceCubeNeutrinoList'>: ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})})}), <class 'llama.files.i3.json.IceCubeNeutrinoList'>: ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})}), <class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})})¶

class llama.files.FermiGRBsJSON¶

Bases: llama.filehandler.JSONFile, llama.files.healpix.skymap.HEALPixPSF

Required input files for llama.files.fermi_grb.FermiGRBsJSON (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.fermi_grb.FermiGRBsJSON to be generated.¶

New and historical Fermi GRB triggers saved in a JSON file. Triggers are in a list of JSON objects, where each trigger will have (at least) the following properties:

rafloat: Right ascension in degrees.
decfloat: Declination in degrees.
sigmafloat: Angular uncertainty in degrees.
gps_timefloat: GPS time of the trigger.

Additional properties might include:

graceidstr: GraceID of the event, if available.
skymap_urlstr: URL of a FITS skymap, if available.

DEPENDENCIES = (<class 'llama.files.skymap_info.SkymapInfo'>,)¶

DETECTORS = (Detector(name='Fermi', abbrev='frm', fullname='Fermi', url=None, summary='Fermi', description='', citations=ImmutableDict({})),)¶

FILENAME = 'fermi_grbs.json'¶

MANIFEST_TYPES = (<class 'llama.files.fermi_grb.FermiGRBsJSON'>,)¶

UR_DEPENDENCIES = (<class 'llama.files.skymap_info.SkymapInfo'>,)¶

UR_DEPENDENCY_TREE = frozenset({<class 'llama.files.skymap_info.SkymapInfo'>})¶

property num_triggers¶: The number of triggers described by this file. Useful mostly for quickly determining if this trigger list is empty.

source_locations()¶: Returns a list of tuples of (RA, Dec, sigma) for all point-like sources, where (RA, Dec) is the central sky position and sigma is the standard deviation of the Gaussian PSF. Since this depends on the structure of data in the relevant file handler, it must be specified for each subclass.

property template_skymap_filehandler¶: The HEALPixSkyMapFileHandler whose HEALPix parameters should be used as a template for the HEALPixSkyMap output by this FileHandler. It is assumed that this HEALPixSkyMapFileHandler only returns one skymap in its list; consequently, only the first skymap loaded by this file handler will be used. Note that the template skymap file handler is likely not a dependency of this file handler; it is only used as a default for formatting generated skymaps from this file handler’s data.

class llama.files.CoincSignificanceI3Lvc¶

Bases: llama.filehandler.JSONFile

Required input files for llama.files.coinc_significance.opa.CoincSignificanceI3Lvc (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.coinc_significance.opa.CoincSignificanceI3Lvc to be generated.¶

Calculates the significance (Bayes Factor) of a joint GW+HEN event.

DEPENDENCIES = (<class 'llama.files.skymap_info.SkymapInfo'>, <class 'llama.files.i3.json.IceCubeNeutrinoList'>, <class 'llama.files.lvc_skymap.LvcSkymapHdf5'>, <class 'llama.files.gracedb.LVCGraceDbEventData'>, <class 'llama.files.lvc_skymap.LvcDistancesJson'>, <class 'llama.files.gracedb.PAstro'>)¶

DETECTORS = (Detector(name='IceCube', abbrev='i3', fullname='IceCube', url='http://wiki.icecube.wisc.edu', summary='IceCube', description='', citations=ImmutableDict({})), Detector(name='LVC', abbrev='lvc', fullname='LVC', url='http://wiki.ligo.org', summary='LVC', description='', citations=ImmutableDict({})))¶

FILENAME = 'significance_lvc-i3.json'¶

MANIFEST_TYPES = (<class 'llama.files.coinc_significance.opa.CoincSignificanceI3Lvc'>,)¶

TIMEOUT = 600¶

UR_DEPENDENCIES = (<class 'llama.files.skymap_info.SkymapInfo'>, <class 'llama.files.lvc_skymap.LvcSkymapFits'>, <class 'llama.files.i3.json.IceCubeNeutrinoList'>, <class 'llama.files.gracedb.LVCGraceDbEventData'>, <class 'llama.files.lvc_skymap.LvcDistancesJson'>, <class 'llama.files.lvc_skymap.LvcSkymapHdf5'>, <class 'llama.files.gracedb.PAstro'>)¶

UR_DEPENDENCY_TREE = ImmutableDict({<class 'llama.files.gracedb.PAstro'>: ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})}), <class 'llama.files.lvc_skymap.LvcSkymapHdf5'>: ImmutableDict({<class 'llama.files.lvc_skymap.LvcSkymapFits'>: ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})})}), <class 'llama.files.lvc_skymap.LvcDistancesJson'>: ImmutableDict({<class 'llama.files.lvc_skymap.LvcSkymapFits'>: ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})})}), <class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({}), <class 'llama.files.gracedb.LVCGraceDbEventData'>: ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})}), <class 'llama.files.i3.json.IceCubeNeutrinoList'>: ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})})})¶

property combined_p_value¶: Return the combined p-value for the whole event.

odds()¶: Return a list of the odds ratios calculated. Ordering corresponds to the ordering of neutrinos in the IceCubeNeutrinoList file used to calculate the odds ratios.

property p_values¶: Return a list of the p-values calculated. Ordering corresponds to the ordering of neutrinos in the IceCubeNeutrinoList file used to calculate the odds ratios.

class llama.files.CoincScatterI3LvcPdf¶

Bases: llama.files.coinc_plots.CoincScatterI3Lvc

Required input files for llama.files.coinc_plots.CoincScatterI3LvcPdf (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.coinc_plots.CoincScatterI3LvcPdf to be generated.¶

Human-readable joint Neutrino/Gravitational Wave skymap plot in PDF format.

DEPENDENCIES = (<class 'llama.files.lvc_skymap.LvcSkymapHdf5'>, <class 'llama.files.i3.json.IceCubeNeutrinoList'>)¶

FILEEXT = 'pdf'¶

FILENAME = 'scatterplot_lvc-i3.pdf'¶

MANIFEST_TYPES = (<class 'llama.files.coinc_plots.CoincScatterI3LvcPdf'>,)¶

UR_DEPENDENCIES = (<class 'llama.files.skymap_info.SkymapInfo'>, <class 'llama.files.lvc_skymap.LvcSkymapFits'>, <class 'llama.files.lvc_skymap.LvcSkymapHdf5'>, <class 'llama.files.i3.json.IceCubeNeutrinoList'>)¶

UR_DEPENDENCY_TREE = ImmutableDict({<class 'llama.files.i3.json.IceCubeNeutrinoList'>: ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})}), <class 'llama.files.lvc_skymap.LvcSkymapHdf5'>: ImmutableDict({<class 'llama.files.lvc_skymap.LvcSkymapFits'>: ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})})})})¶

class llama.files.CoincScatterI3LvcPng¶

Bases: llama.files.coinc_plots.CoincScatterI3Lvc

Required input files for llama.files.coinc_plots.CoincScatterI3LvcPng (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.coinc_plots.CoincScatterI3LvcPng to be generated.¶

Human-readable joint Neutrino/Gravitational Wave skymap plot in PNG format.

DEPENDENCIES = (<class 'llama.files.lvc_skymap.LvcSkymapHdf5'>, <class 'llama.files.i3.json.IceCubeNeutrinoList'>)¶

FILEEXT = 'png'¶

FILENAME = 'scatterplot_lvc-i3.png'¶

MANIFEST_TYPES = (<class 'llama.files.coinc_plots.CoincScatterI3LvcPng'>,)¶

UR_DEPENDENCIES = (<class 'llama.files.skymap_info.SkymapInfo'>, <class 'llama.files.lvc_skymap.LvcSkymapFits'>, <class 'llama.files.lvc_skymap.LvcSkymapHdf5'>, <class 'llama.files.i3.json.IceCubeNeutrinoList'>)¶

UR_DEPENDENCY_TREE = ImmutableDict({<class 'llama.files.i3.json.IceCubeNeutrinoList'>: ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})}), <class 'llama.files.lvc_skymap.LvcSkymapHdf5'>: ImmutableDict({<class 'llama.files.lvc_skymap.LvcSkymapFits'>: ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})})})})¶

class llama.files.CoincSummaryI3LvcTex¶

Bases: llama.filehandler.FileHandler

Required input files for llama.files.coinc_plots.CoincSummaryI3LvcTex (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.coinc_plots.CoincSummaryI3LvcTex to be generated.¶

LaTeX file for a human-viewable joint Neutrino/Gravitational Wave skymap plot complete with a list of neutrinos and their properties. Gets compiled to a PDF file.

DEPENDENCIES = (<class 'llama.files.skymap_info.SkymapInfo'>, <class 'llama.files.coinc_plots.CoincScatterI3LvcPdf'>, <class 'llama.files.coinc_significance.opa.CoincSignificanceI3Lvc'>, <class 'llama.files.i3.tex.IceCubeNeutrinoListTex'>, <class 'llama.files.i3.json.IceCubeNeutrinoList'>)¶

FILENAME = 'summary_lvc-I3.tex'¶

MANIFEST_TYPES = (<class 'llama.files.coinc_plots.CoincSummaryI3LvcTex'>,)¶

UR_DEPENDENCIES = (<class 'llama.files.skymap_info.SkymapInfo'>, <class 'llama.files.lvc_skymap.LvcSkymapFits'>, <class 'llama.files.i3.json.IceCubeNeutrinoList'>, <class 'llama.files.gracedb.LVCGraceDbEventData'>, <class 'llama.files.lvc_skymap.LvcDistancesJson'>, <class 'llama.files.lvc_skymap.LvcSkymapHdf5'>, <class 'llama.files.gracedb.PAstro'>, <class 'llama.files.coinc_significance.opa.CoincSignificanceI3Lvc'>, <class 'llama.files.i3.tex.IceCubeNeutrinoListTex'>, <class 'llama.files.coinc_plots.CoincScatterI3LvcPdf'>)¶

UR_DEPENDENCY_TREE = ImmutableDict({<class 'llama.files.coinc_significance.opa.CoincSignificanceI3Lvc'>: ImmutableDict({<class 'llama.files.gracedb.PAstro'>: ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})}), <class 'llama.files.lvc_skymap.LvcSkymapHdf5'>: ImmutableDict({<class 'llama.files.lvc_skymap.LvcSkymapFits'>: ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})})}), <class 'llama.files.lvc_skymap.LvcDistancesJson'>: ImmutableDict({<class 'llama.files.lvc_skymap.LvcSkymapFits'>: ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})})}), <class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({}), <class 'llama.files.gracedb.LVCGraceDbEventData'>: ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})}), <class 'llama.files.i3.json.IceCubeNeutrinoList'>: ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})})}), <class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({}), <class 'llama.files.coinc_plots.CoincScatterI3LvcPdf'>: ImmutableDict({<class 'llama.files.i3.json.IceCubeNeutrinoList'>: ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})}), <class 'llama.files.lvc_skymap.LvcSkymapHdf5'>: ImmutableDict({<class 'llama.files.lvc_skymap.LvcSkymapFits'>: ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})})})}), <class 'llama.files.i3.json.IceCubeNeutrinoList'>: ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})}), <class 'llama.files.i3.tex.IceCubeNeutrinoListTex'>: ImmutableDict({<class 'llama.files.coinc_significance.opa.CoincSignificanceI3Lvc'>: ImmutableDict({<class 'llama.files.gracedb.PAstro'>: ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})}), <class 'llama.files.lvc_skymap.LvcSkymapHdf5'>: ImmutableDict({<class 'llama.files.lvc_skymap.LvcSkymapFits'>: ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})})}), <class 'llama.files.lvc_skymap.LvcDistancesJson'>: ImmutableDict({<class 'llama.files.lvc_skymap.LvcSkymapFits'>: ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})})}), <class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({}), <class 'llama.files.gracedb.LVCGraceDbEventData'>: ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})}), <class 'llama.files.i3.json.IceCubeNeutrinoList'>: ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})})}), <class 'llama.files.i3.json.IceCubeNeutrinoList'>: ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})}), <class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})})})¶

class llama.files.CoincSummaryI3LvcPdf¶

Bases: llama.filehandler.FileHandler

Required input files for llama.files.coinc_plots.CoincSummaryI3LvcPdf (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.coinc_plots.CoincSummaryI3LvcPdf to be generated.¶

Human-viewable joint Neutrino/Gravitational Wave skymap plot complete with a list of neutrinos and their properties in PDF form. Useful for quick human checks of the output of the pipeline on an event.

DEPENDENCIES = (<class 'llama.files.coinc_plots.CoincSummaryI3LvcTex'>, <class 'llama.files.coinc_plots.CoincScatterI3LvcPdf'>)¶

FILENAME = 'summary_lvc-I3.pdf'¶

MANIFEST_TYPES = (<class 'llama.files.coinc_plots.CoincSummaryI3LvcPdf'>,)¶

UR_DEPENDENCIES = (<class 'llama.files.skymap_info.SkymapInfo'>, <class 'llama.files.lvc_skymap.LvcSkymapFits'>, <class 'llama.files.i3.json.IceCubeNeutrinoList'>, <class 'llama.files.gracedb.LVCGraceDbEventData'>, <class 'llama.files.lvc_skymap.LvcDistancesJson'>, <class 'llama.files.lvc_skymap.LvcSkymapHdf5'>, <class 'llama.files.gracedb.PAstro'>, <class 'llama.files.coinc_significance.opa.CoincSignificanceI3Lvc'>, <class 'llama.files.i3.tex.IceCubeNeutrinoListTex'>, <class 'llama.files.coinc_plots.CoincScatterI3LvcPdf'>, <class 'llama.files.coinc_plots.CoincSummaryI3LvcTex'>)¶

UR_DEPENDENCY_TREE = ImmutableDict({<class 'llama.files.coinc_plots.CoincSummaryI3LvcTex'>: ImmutableDict({<class 'llama.files.coinc_significance.opa.CoincSignificanceI3Lvc'>: ImmutableDict({<class 'llama.files.gracedb.PAstro'>: ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})}), <class 'llama.files.lvc_skymap.LvcSkymapHdf5'>: ImmutableDict({<class 'llama.files.lvc_skymap.LvcSkymapFits'>: ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})})}), <class 'llama.files.lvc_skymap.LvcDistancesJson'>: ImmutableDict({<class 'llama.files.lvc_skymap.LvcSkymapFits'>: ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})})}), <class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({}), <class 'llama.files.gracedb.LVCGraceDbEventData'>: ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})}), <class 'llama.files.i3.json.IceCubeNeutrinoList'>: ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})})}), <class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({}), <class 'llama.files.coinc_plots.CoincScatterI3LvcPdf'>: ImmutableDict({<class 'llama.files.i3.json.IceCubeNeutrinoList'>: ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})}), <class 'llama.files.lvc_skymap.LvcSkymapHdf5'>: ImmutableDict({<class 'llama.files.lvc_skymap.LvcSkymapFits'>: ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})})})}), <class 'llama.files.i3.json.IceCubeNeutrinoList'>: ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})}), <class 'llama.files.i3.tex.IceCubeNeutrinoListTex'>: ImmutableDict({<class 'llama.files.coinc_significance.opa.CoincSignificanceI3Lvc'>: ImmutableDict({<class 'llama.files.gracedb.PAstro'>: ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})}), <class 'llama.files.lvc_skymap.LvcSkymapHdf5'>: ImmutableDict({<class 'llama.files.lvc_skymap.LvcSkymapFits'>: ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})})}), <class 'llama.files.lvc_skymap.LvcDistancesJson'>: ImmutableDict({<class 'llama.files.lvc_skymap.LvcSkymapFits'>: ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})})}), <class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({}), <class 'llama.files.gracedb.LVCGraceDbEventData'>: ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})}), <class 'llama.files.i3.json.IceCubeNeutrinoList'>: ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})})}), <class 'llama.files.i3.json.IceCubeNeutrinoList'>: ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})}), <class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})})}), <class 'llama.files.coinc_plots.CoincScatterI3LvcPdf'>: ImmutableDict({<class 'llama.files.i3.json.IceCubeNeutrinoList'>: ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})}), <class 'llama.files.lvc_skymap.LvcSkymapHdf5'>: ImmutableDict({<class 'llama.files.lvc_skymap.LvcSkymapFits'>: ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})})})})})¶

class llama.files.LvcGcnXml¶

Bases: llama.filehandler.EventTriggeredFileHandler

llama.files.lvc_gcn_xml.LvcGcnXml is created from external triggers. It therefore has no LLAMA-representable input dependencies, but instead acts as initial input for other FileHandler classes.¶

A VOEvent XML file received from GCN corresponding to an LVC event notice.

FILENAME = 'lvc_gcn.xml'¶

MANIFEST_TYPES = (<class 'llama.files.lvc_gcn_xml.LvcGcnXml'>,)¶

UR_DEPENDENCIES = ()¶

UR_DEPENDENCY_TREE = frozenset({})¶

property alert_type¶: Get the alert type for this VOEvent.

property etree¶: Return an lxml.etree for this VOEvent.

property event_time_gps¶: Get the time of the observed event up to nanosecond precision (less accurate than this in practice) in GPS time format.

property event_time_gps_nanoseconds¶: Get the number of nanoseconds past the last GPS second at the time of the observed event. Ostensibly provides nanosecond precision, but is less accurate than this in practice.

property event_time_gps_seconds¶: Get the time of the observed event in GPS seconds (truncated to the nearest second).

property event_time_mjd¶: Get the time of the observed event in UTC MJD format.

property event_time_str¶: Get a unicode string with the ISO date and time of the observed event straight from the VOEvent file. UTC time.

property far¶: Get the false alarm rate of this VOEvent as a float value.

get_alert_type()¶: Read the alert type of this GCN Notice.

get_param(param)¶: Get this VOEventParam for this event.

property graceid¶: Get the GraceID corresponding to this VOEvent.

property ivorn¶: Get the IVORN, a unique identifier for this GCN Notice.

property notice_time_str¶: Get a unicode string with the date and time of creation of the notification associated with this VOEvent, rather than the time of detection of the event itself. Should be in ISO format.

property pipeline¶: Return an ALL-CAPS name of the pipeline used to generate this event, e.g. GSTLAL or CWB.

property role¶: Get the role of this VOEvent as specified in the header.

property skymap_filename¶: Get the filename for this skymap as it appears on GraceDB.

class llama.files.LvcRetractionXml¶

Bases: llama.files.lvc_gcn_xml.LvcGcnXml

llama.files.lvc_gcn_xml.LvcRetractionXml is created from external triggers. It therefore has no LLAMA-representable input dependencies, but instead acts as initial input for other FileHandler classes.¶

A VOEvent XML file retracting a GCN notice.

FILENAME = 'lvc_gcn_retraction.xml'¶

class llama.files.LVAlertJSON¶

Bases: llama.filehandler.EventTriggeredFileHandler, llama.filehandler.JSONFile

llama.files.lvalert_json.LVAlertJSON is created from external triggers. It therefore has no LLAMA-representable input dependencies, but instead acts as initial input for other FileHandler classes.¶

An LVAlert JSON object containing skymap info.

FILENAME = 'lvalert.json'¶

MANIFEST_TYPES = (<class 'llama.files.lvalert_json.LVAlertJSON'>,)¶

UR_DEPENDENCIES = ()¶

UR_DEPENDENCY_TREE = frozenset({})¶

property alert_type¶: Get the alert_type of this LVAlert.

property base_filename¶

Get the unversioned filename for this file. This only works for LVAlerts corresponding to uploads.

Returns: base_filename – The skymap filename as a SkymapFilename instance.
Return type: files.lvc_skymap.utils.SkymapFilename
Raises: KeyError – If this LVAlert does not contain a filename.

property far¶: The False Alarm Rate of this trigger.

property graceid¶: The GraceID, a unique ID used on GraceDB to register gravitational wave triggers.

property notice_time_str¶: Get the time at which the LVAlert was created.

property skymap_filename¶

Get the exact filename, including version information, for this file. If this LVAlert does not correspond to a skymap upload, try to pull down the most recently generated skymap.

Returns: filename – The full canonical filename as a SkymapFilename instance.
Return type: files.lvc_skymap.utils.SkymapFilename

property skymap_version¶

Get the version of the skymap with this particular filename. This only works for LVAlerts corresponding to uploads.

Returns: version – File version corresponding to this upload.
Return type: int

class llama.files.SkymapInfo¶

Bases: llama.filehandler.EventTriggeredFileHandler, llama.filehandler.JSONFile

llama.files.skymap_info.SkymapInfo is created from external triggers. It therefore has no LLAMA-representable input dependencies, but instead acts as initial input for other FileHandler classes.¶

A JSON file containing information on where to find the latest and greatest skymap for this event. Any incoming alert file should also generate this file. The resulting file is a simple JSON object with key:value pairs concerning information about the event and the current skymap to be used.

FILENAME = 'skymap_info.json'¶

MANIFEST_TYPES = (<class 'llama.files.skymap_info.SkymapInfo'>,)¶

UR_DEPENDENCIES = ()¶

UR_DEPENDENCY_TREE = frozenset({})¶

property alert_file_handler¶: Get the file handler for this alert file type. For a manually-generated instance of this file, the return value is None; otherwise, it is a FileHandler instance matched to this event.

property alert_type¶

Get the type of the alert, i.e. how this trigger was made in the LLAMA pipeline. For example, if this trigger was made as part of a gstlal offline subthreshold search, the value would be “gstlal-offline”. Look in SkymapInfo._alert_types for allowed alert type values.

NB: This is NOT related to the ``alert_type`` key in LVAlerts!

property event_time_gps¶: Get the time of the observed event up to nanosecond precision (less accurate than this in practice).

property event_time_gps_nanoseconds¶: Get the number of nanoseconds past the last GPS second at the time of the observed event. Ostensibly provides nanosecond precision, but is less accurate than this in practice.

property event_time_gps_seconds¶: Get the time of the observed event in GPS seconds (truncated to the nearest second).

property event_time_mjd¶: Get the time of the observed event in Modified Julian Day format (UTC time).

property event_time_str¶: Get a unicode string with the ISO date and time of the observed event straight from the VOEvent file. UTC time.

property far¶: Get the false alarm rate of this VOEvent as a float value.

generate_from_gracedb(graceid: str, skymap_filename: str = None)¶: Supplement the original filename with data pulled from the GraceDB API on the event. Used for manually generating skymap_info.

generate_from_gracedb_superevent(graceid: str, skymap_filename: str = None)¶: Supplement the original filename with data pulled from the GraceDB API on the superevent. Used for manually generating skymap_info from a superevent. If no skymap is provided, pull down the most recently uploaded one defined in llama.files.lvc_skymap.SKYMAP_FILENAMES.

generate_from_lvc_gcn_xml(voe: llama.files.lvc_gcn_xml.LvcGcnXml)¶: Generate this file from LvcGcnXml VOEvent. Used for implementation.

property gracedb_url¶: Get the GraceDB URL for this GraceID, assuming it is in the expected format for GraceIDs. Will autodetect if this is a superevent or regular event. Returns None if this doesn’t look like a valid GraceID (but will not check on the actual gracedb server).

property graceid¶: Get the GraceID corresponding to this VOEvent.

property human_url¶: Get the human-viewable URL for this file (i.e. the one that can be accessed from a web-browser using interactive authentication)

property is_super¶: Check whether this GraceID corresponds to an event or a superevent.

property notice_time_str¶: Get a unicode string with the date and time of creation of the notification associated with this VOEvent, rather than the time of detection of the event itself.

property pipeline¶: Return an ALL-CAPS name of the pipeline used to generate this event, e.g. GSTLAL or CWB.

property skymap_filename¶: Get the filename of the skymap as a SkymapFilename as stored on GraceDB.

class llama.files.LVCGraceDbEventData¶

Bases: llama.filehandler.JSONFile, llama.filehandler.mixins.OnlineVetoMixin

Required input files for llama.files.gracedb.LVCGraceDbEventData (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.gracedb.LVCGraceDbEventData to be generated.¶

The event dictionary as returned by the GraceDb API. Includes richer information on the single-detector and multi-detector inspiral parameters than is provided in LVAlerts or GCN Notices. Convenience methods are provided for certain commonly-used reconstructed parameters, but full data can always be accessed by running read_json.

DEPENDENCIES = (<class 'llama.files.skymap_info.SkymapInfo'>,)¶

FILENAME = 'lvc_gracedb_event_data.json'¶

GW_DETECTORS = {'H1', 'L1', 'V1'}¶

MANIFEST_TYPES = (<class 'llama.files.gracedb.LVCGraceDbEventData'>,)¶

UR_DEPENDENCIES = (<class 'llama.files.skymap_info.SkymapInfo'>,)¶

UR_DEPENDENCY_TREE = frozenset({<class 'llama.files.skymap_info.SkymapInfo'>})¶

property chirp_mass¶: The chirp mass. Raises a KeyError if it is not defined.

property instruments¶: A sorted list of the interferometers that participated in creating this trigger, e.g. ['H1', 'L1']. Raises a ValueError if unexpected instruments are found. Raises a KeyError if it is not defined.

property offline¶: Whether this trigger was generated offline.

property snr¶: The coincident signal-to-noise ratio (SNR). Raises a KeyError if it is not defined.

property total_mass¶: The total binary mass. Raises a KeyError if it is not defined.

class llama.files.PAstro¶

Bases: llama.files.gracedb.GraceDBPollingFileHandler, llama.filehandler.JSONFile

Required input files for llama.files.gracedb.PAstro (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.gracedb.PAstro to be generated.¶

A classification of an event’s possible sources by probability.

FILENAME = 'p_astro.json'¶

MANIFEST_TYPES = (<class 'llama.files.gracedb.PAstro'>,)¶

UR_DEPENDENCIES = (<class 'llama.files.skymap_info.SkymapInfo'>,)¶

UR_DEPENDENCY_TREE = frozenset({<class 'llama.files.skymap_info.SkymapInfo'>})¶

property most_likely_population¶: Get the population that this event most likely belongs too by seeing whether it is more likely than not to contain NS matter. More precisely, compares p_bbh to p_bns + p_nsbh + p_mass_gap, returning 'bbh' if the former is larger and 'bns' if the latter is larger. p_terr is ignored in this calculation.

property p_bbh¶: The probability that this was a BBH (binary black hole) merger.

property p_bns¶: The probability that this was a BNS (binary neutron star) merger.

property p_mass_gap¶: The probability that at least one of the compact objects in the merger was in the ambiguous mass gap between definite BH and definite NS.

property p_nsbh¶: The probability that this was a NSBH (neutron star/black hole) merger.

property p_terr¶: The probability that this event was terrestrial noise.

property remote_filename¶: The name of the required data in a format recognizable by the remote resource’s API. This is quite possibly dynamically generated, and so it must be considered separate from the file handler’s name for this file.

class llama.files.Advok¶

Bases: llama.filehandler.EventTriggeredFileHandler, llama.filehandler.JSONFile

llama.files.advok.Advok is created from external triggers. It therefore has no LLAMA-representable input dependencies, but instead acts as initial input for other FileHandler classes.¶

The existence of this file should be taken as an indication that the event has been marked as ADVOK. This may have occured either through the actual application of the ADVOK label to the event on GraceDB, or through the sending of a GCN notice for this event (which has happened even when ADVOK was not applied, as in G298048), or when a LLAMA operator chooses to manually mark the event as EM followup ready by creating this file. Once this file exists, dependent files will assume that the event is legitimate and will carry on with any communication efforts they are programmed to perform.

Should be created either simultaneously with a GCN notice or simultaneously with an LVAlert adding the ADVOK label to an event (these are the use cases at time of writing, anyway).

FILENAME = 'advok.json'¶

MANIFEST_TYPES = (<class 'llama.files.advok.Advok'>,)¶

UR_DEPENDENCIES = ()¶

UR_DEPENDENCY_TREE = frozenset({})¶

property alert_file_handler¶: Get the file handler which tells us that this event is ready for EM followup.

property alert_type¶: A string describing the provenance of this trigger, i.e. what “alert” caused us to create this event (and with it, this SkymapInfo file).

property time¶: The time at which this became ADVOK.

class llama.files.LVAlertAdvok¶

Bases: llama.filehandler.EventTriggeredFileHandler, llama.filehandler.JSONFile

llama.files.lvalert_advok.LVAlertAdvok is created from external triggers. It therefore has no LLAMA-representable input dependencies, but instead acts as initial input for other FileHandler classes.¶

If the event was tagged ADVOK via an LVAlert, this file will contain the LVAlert JSON data.

FILENAME = 'lvalert_advok.json'¶

MANIFEST_TYPES = (<class 'llama.files.lvalert_advok.LVAlertAdvok'>,)¶

UR_DEPENDENCIES = ()¶

UR_DEPENDENCY_TREE = frozenset({})¶

class llama.files.RctSlkI3CoincSummaryI3LvcPdf¶

Bases: llama.files.slack.SlackReceiptIcecube

Required input files for llama.files.coinc_plots.RctSlkI3CoincSummaryI3LvcPdf (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.coinc_plots.RctSlkI3CoincSummaryI3LvcPdf to be generated.¶

DEPENDENCIES = (<class 'llama.files.coinc_plots.CoincSummaryI3LvcPdf'>, <class 'llama.files.skymap_info.SkymapInfo'>)¶

FILENAME = 'rct_slk_i3_summary_lvc-I3.pdf.json'¶

FILENAME_FMT = 'rct_slk_i3_{}.json'¶

MANIFEST_TYPES = (<class 'llama.files.coinc_plots.RctSlkI3CoincSummaryI3LvcPdf'>,)¶

UPLOAD¶: alias of CoincSummaryI3LvcPdf

UR_DEPENDENCIES = (<class 'llama.files.skymap_info.SkymapInfo'>, <class 'llama.files.lvc_skymap.LvcSkymapFits'>, <class 'llama.files.i3.json.IceCubeNeutrinoList'>, <class 'llama.files.gracedb.LVCGraceDbEventData'>, <class 'llama.files.lvc_skymap.LvcDistancesJson'>, <class 'llama.files.lvc_skymap.LvcSkymapHdf5'>, <class 'llama.files.gracedb.PAstro'>, <class 'llama.files.coinc_significance.opa.CoincSignificanceI3Lvc'>, <class 'llama.files.i3.tex.IceCubeNeutrinoListTex'>, <class 'llama.files.coinc_plots.CoincScatterI3LvcPdf'>, <class 'llama.files.coinc_plots.CoincSummaryI3LvcTex'>, <class 'llama.files.coinc_plots.CoincSummaryI3LvcPdf'>)¶

UR_DEPENDENCY_TREE = frozenset({<class 'llama.files.coinc_plots.CoincSummaryI3LvcPdf'>})¶

class_vetoes = ((<function icecube_upload_flag_false>, None),)¶

class llama.files.RctSlkLmaCoincSummaryI3LvcPdf¶

Bases: llama.files.slack.SlackReceiptLlama

Required input files for llama.files.coinc_plots.RctSlkLmaCoincSummaryI3LvcPdf (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.coinc_plots.RctSlkLmaCoincSummaryI3LvcPdf to be generated.¶

DEPENDENCIES = (<class 'llama.files.coinc_plots.CoincSummaryI3LvcPdf'>, <class 'llama.files.skymap_info.SkymapInfo'>)¶

FILENAME = 'rct_slk_lma_summary_lvc-I3.pdf.json'¶

FILENAME_FMT = 'rct_slk_lma_{}.json'¶

MANIFEST_TYPES = (<class 'llama.files.coinc_plots.RctSlkLmaCoincSummaryI3LvcPdf'>,)¶

UPLOAD¶: alias of CoincSummaryI3LvcPdf

UR_DEPENDENCIES = (<class 'llama.files.skymap_info.SkymapInfo'>, <class 'llama.files.lvc_skymap.LvcSkymapFits'>, <class 'llama.files.i3.json.IceCubeNeutrinoList'>, <class 'llama.files.gracedb.LVCGraceDbEventData'>, <class 'llama.files.lvc_skymap.LvcDistancesJson'>, <class 'llama.files.lvc_skymap.LvcSkymapHdf5'>, <class 'llama.files.gracedb.PAstro'>, <class 'llama.files.coinc_significance.opa.CoincSignificanceI3Lvc'>, <class 'llama.files.i3.tex.IceCubeNeutrinoListTex'>, <class 'llama.files.coinc_plots.CoincScatterI3LvcPdf'>, <class 'llama.files.coinc_plots.CoincSummaryI3LvcTex'>, <class 'llama.files.coinc_plots.CoincSummaryI3LvcPdf'>)¶

UR_DEPENDENCY_TREE = frozenset({<class 'llama.files.coinc_plots.CoincSummaryI3LvcPdf'>})¶

class_vetoes = ()¶

class llama.files.RctSlkLmaCoincScatterI3LvcPdf¶

Bases: llama.files.slack.SlackReceiptLlama

Required input files for llama.files.coinc_plots.RctSlkLmaCoincScatterI3LvcPdf (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.coinc_plots.RctSlkLmaCoincScatterI3LvcPdf to be generated.¶

DEPENDENCIES = (<class 'llama.files.coinc_plots.CoincScatterI3LvcPdf'>, <class 'llama.files.skymap_info.SkymapInfo'>)¶

FILENAME = 'rct_slk_lma_scatterplot_lvc-i3.pdf.json'¶

FILENAME_FMT = 'rct_slk_lma_{}.json'¶

MANIFEST_TYPES = (<class 'llama.files.coinc_plots.RctSlkLmaCoincScatterI3LvcPdf'>,)¶

UPLOAD¶: alias of CoincScatterI3LvcPdf

UR_DEPENDENCIES = (<class 'llama.files.skymap_info.SkymapInfo'>, <class 'llama.files.lvc_skymap.LvcSkymapFits'>, <class 'llama.files.lvc_skymap.LvcSkymapHdf5'>, <class 'llama.files.i3.json.IceCubeNeutrinoList'>, <class 'llama.files.coinc_plots.CoincScatterI3LvcPdf'>)¶

UR_DEPENDENCY_TREE = frozenset({<class 'llama.files.coinc_plots.CoincScatterI3LvcPdf'>})¶

class_vetoes = ()¶

class llama.files.RctSlkLmaCoincScatterI3LvcPng¶

Bases: llama.files.slack.SlackReceiptLlama

Required input files for llama.files.coinc_plots.RctSlkLmaCoincScatterI3LvcPng (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.coinc_plots.RctSlkLmaCoincScatterI3LvcPng to be generated.¶

DEPENDENCIES = (<class 'llama.files.coinc_plots.CoincScatterI3LvcPng'>, <class 'llama.files.skymap_info.SkymapInfo'>)¶

FILENAME = 'rct_slk_lma_scatterplot_lvc-i3.png.json'¶

FILENAME_FMT = 'rct_slk_lma_{}.json'¶

MANIFEST_TYPES = (<class 'llama.files.coinc_plots.RctSlkLmaCoincScatterI3LvcPng'>,)¶

UPLOAD¶: alias of CoincScatterI3LvcPng

UR_DEPENDENCIES = (<class 'llama.files.skymap_info.SkymapInfo'>, <class 'llama.files.lvc_skymap.LvcSkymapFits'>, <class 'llama.files.lvc_skymap.LvcSkymapHdf5'>, <class 'llama.files.i3.json.IceCubeNeutrinoList'>, <class 'llama.files.coinc_plots.CoincScatterI3LvcPng'>)¶

UR_DEPENDENCY_TREE = frozenset({<class 'llama.files.coinc_plots.CoincScatterI3LvcPng'>})¶

class_vetoes = ()¶

class llama.files.RctSlkLmaCoincScatterZtfI3LvcPdf¶

Bases: llama.files.slack.SlackReceiptLlama

Required input files for llama.files.coinc_plots.RctSlkLmaCoincScatterZtfI3LvcPdf (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.coinc_plots.RctSlkLmaCoincScatterZtfI3LvcPdf to be generated.¶

DEPENDENCIES = (<class 'llama.files.coinc_plots.CoincScatterZtfI3LvcPdf'>, <class 'llama.files.skymap_info.SkymapInfo'>)¶

FILENAME = 'rct_slk_lma_scatterplot_lvc-i3-ztf.pdf.json'¶

FILENAME_FMT = 'rct_slk_lma_{}.json'¶

MANIFEST_TYPES = (<class 'llama.files.coinc_plots.RctSlkLmaCoincScatterZtfI3LvcPdf'>,)¶

UPLOAD¶: alias of CoincScatterZtfI3LvcPdf

UR_DEPENDENCIES = (<class 'llama.files.skymap_info.SkymapInfo'>, <class 'llama.files.lvc_skymap.LvcSkymapFits'>, <class 'llama.files.lvc_skymap.LvcSkymapHdf5'>, <class 'llama.files.ztf_trigger_list.ZtfTriggerList'>, <class 'llama.files.i3.json.IceCubeNeutrinoList'>, <class 'llama.files.coinc_plots.CoincScatterZtfI3LvcPdf'>)¶

UR_DEPENDENCY_TREE = frozenset({<class 'llama.files.coinc_plots.CoincScatterZtfI3LvcPdf'>})¶

class_vetoes = ()¶

class llama.files.RctSlkLmaCoincScatterZtfI3LvcPng¶

Bases: llama.files.slack.SlackReceiptLlama

Required input files for llama.files.coinc_plots.RctSlkLmaCoincScatterZtfI3LvcPng (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.coinc_plots.RctSlkLmaCoincScatterZtfI3LvcPng to be generated.¶

DEPENDENCIES = (<class 'llama.files.coinc_plots.CoincScatterZtfI3LvcPng'>, <class 'llama.files.skymap_info.SkymapInfo'>)¶

FILENAME = 'rct_slk_lma_scatterplot_lvc-i3-ztf.png.json'¶

FILENAME_FMT = 'rct_slk_lma_{}.json'¶

MANIFEST_TYPES = (<class 'llama.files.coinc_plots.RctSlkLmaCoincScatterZtfI3LvcPng'>,)¶

UPLOAD¶: alias of CoincScatterZtfI3LvcPng

UR_DEPENDENCIES = (<class 'llama.files.skymap_info.SkymapInfo'>, <class 'llama.files.lvc_skymap.LvcSkymapFits'>, <class 'llama.files.lvc_skymap.LvcSkymapHdf5'>, <class 'llama.files.ztf_trigger_list.ZtfTriggerList'>, <class 'llama.files.i3.json.IceCubeNeutrinoList'>, <class 'llama.files.coinc_plots.CoincScatterZtfI3LvcPng'>)¶

UR_DEPENDENCY_TREE = frozenset({<class 'llama.files.coinc_plots.CoincScatterZtfI3LvcPng'>})¶

class_vetoes = ()¶

class llama.files.RctSlkLmaCoincScatterZtfLVCPdf¶

Bases: llama.files.slack.SlackReceiptLlama

Required input files for llama.files.coinc_plots.RctSlkLmaCoincScatterZtfLVCPdf (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.coinc_plots.RctSlkLmaCoincScatterZtfLVCPdf to be generated.¶

DEPENDENCIES = (<class 'llama.files.coinc_plots.CoincScatterZtfLVCPdf'>, <class 'llama.files.skymap_info.SkymapInfo'>)¶

FILENAME = 'rct_slk_lma_scatterplot_lvc-ztf.pdf.json'¶

FILENAME_FMT = 'rct_slk_lma_{}.json'¶

MANIFEST_TYPES = (<class 'llama.files.coinc_plots.RctSlkLmaCoincScatterZtfLVCPdf'>,)¶

UPLOAD¶: alias of CoincScatterZtfLVCPdf

UR_DEPENDENCIES = (<class 'llama.files.skymap_info.SkymapInfo'>, <class 'llama.files.lvc_skymap.LvcSkymapFits'>, <class 'llama.files.lvc_skymap.LvcSkymapHdf5'>, <class 'llama.files.ztf_trigger_list.ZtfTriggerList'>, <class 'llama.files.coinc_plots.CoincScatterZtfLVCPdf'>)¶

UR_DEPENDENCY_TREE = frozenset({<class 'llama.files.coinc_plots.CoincScatterZtfLVCPdf'>})¶

class_vetoes = ()¶

class llama.files.RctSlkLmaCoincScatterZtfLVCPng¶

Bases: llama.files.slack.SlackReceiptLlama

Required input files for llama.files.coinc_plots.RctSlkLmaCoincScatterZtfLVCPng (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.coinc_plots.RctSlkLmaCoincScatterZtfLVCPng to be generated.¶

DEPENDENCIES = (<class 'llama.files.coinc_plots.CoincScatterZtfLVCPng'>, <class 'llama.files.skymap_info.SkymapInfo'>)¶

FILENAME = 'rct_slk_lma_scatterplot_lvc-ztf.png.json'¶

FILENAME_FMT = 'rct_slk_lma_{}.json'¶

MANIFEST_TYPES = (<class 'llama.files.coinc_plots.RctSlkLmaCoincScatterZtfLVCPng'>,)¶

UPLOAD¶: alias of CoincScatterZtfLVCPng

UR_DEPENDENCIES = (<class 'llama.files.skymap_info.SkymapInfo'>, <class 'llama.files.lvc_skymap.LvcSkymapFits'>, <class 'llama.files.lvc_skymap.LvcSkymapHdf5'>, <class 'llama.files.ztf_trigger_list.ZtfTriggerList'>, <class 'llama.files.coinc_plots.CoincScatterZtfLVCPng'>)¶

UR_DEPENDENCY_TREE = frozenset({<class 'llama.files.coinc_plots.CoincScatterZtfLVCPng'>})¶

class_vetoes = ()¶

class llama.files.RctSlkLmaCoincSignificanceI3Lvc¶

Bases: llama.files.slack.SlackReceiptLlama

Required input files for llama.files.coinc_significance.opa.RctSlkLmaCoincSignificanceI3Lvc (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.coinc_significance.opa.RctSlkLmaCoincSignificanceI3Lvc to be generated.¶

DEPENDENCIES = (<class 'llama.files.coinc_significance.opa.CoincSignificanceI3Lvc'>, <class 'llama.files.skymap_info.SkymapInfo'>)¶

FILENAME = 'rct_slk_lma_significance_lvc-i3.json.json'¶

FILENAME_FMT = 'rct_slk_lma_{}.json'¶

MANIFEST_TYPES = (<class 'llama.files.coinc_significance.opa.RctSlkLmaCoincSignificanceI3Lvc'>,)¶

UPLOAD¶: alias of CoincSignificanceI3Lvc

UR_DEPENDENCIES = (<class 'llama.files.skymap_info.SkymapInfo'>, <class 'llama.files.lvc_skymap.LvcSkymapFits'>, <class 'llama.files.i3.json.IceCubeNeutrinoList'>, <class 'llama.files.gracedb.LVCGraceDbEventData'>, <class 'llama.files.lvc_skymap.LvcDistancesJson'>, <class 'llama.files.lvc_skymap.LvcSkymapHdf5'>, <class 'llama.files.gracedb.PAstro'>, <class 'llama.files.coinc_significance.opa.CoincSignificanceI3Lvc'>)¶

UR_DEPENDENCY_TREE = frozenset({<class 'llama.files.coinc_significance.opa.CoincSignificanceI3Lvc'>})¶

class_vetoes = ()¶

class llama.files.RctSlkLmaLVAlertJSON¶

Bases: llama.files.slack.SlackReceiptLlama

Required input files for llama.files.slack.RctSlkLmaLVAlertJSON (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.slack.RctSlkLmaLVAlertJSON to be generated.¶

DEPENDENCIES = (<class 'llama.files.lvalert_json.LVAlertJSON'>, <class 'llama.files.skymap_info.SkymapInfo'>)¶

FILENAME = 'rct_slk_lma_lvalert.json.json'¶

FILENAME_FMT = 'rct_slk_lma_{}.json'¶

MANIFEST_TYPES = (<class 'llama.files.slack.RctSlkLmaLVAlertJSON'>,)¶

UPLOAD¶: alias of llama.files.lvalert_json.LVAlertJSON

UR_DEPENDENCIES = (<class 'llama.files.lvalert_json.LVAlertJSON'>, <class 'llama.files.skymap_info.SkymapInfo'>)¶

UR_DEPENDENCY_TREE = frozenset({<class 'llama.files.lvalert_json.LVAlertJSON'>})¶

class_vetoes = ()¶

class llama.files.RctSlkLmaLVCGraceDbEventData¶

Bases: llama.files.slack.SlackReceiptLlama

Required input files for llama.files.gracedb.RctSlkLmaLVCGraceDbEventData (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.gracedb.RctSlkLmaLVCGraceDbEventData to be generated.¶

DEPENDENCIES = (<class 'llama.files.gracedb.LVCGraceDbEventData'>, <class 'llama.files.skymap_info.SkymapInfo'>)¶

FILENAME = 'rct_slk_lma_lvc_gracedb_event_data.json.json'¶

FILENAME_FMT = 'rct_slk_lma_{}.json'¶

MANIFEST_TYPES = (<class 'llama.files.gracedb.RctSlkLmaLVCGraceDbEventData'>,)¶

UPLOAD¶: alias of LVCGraceDbEventData

UR_DEPENDENCIES = (<class 'llama.files.skymap_info.SkymapInfo'>, <class 'llama.files.gracedb.LVCGraceDbEventData'>)¶

UR_DEPENDENCY_TREE = frozenset({<class 'llama.files.gracedb.LVCGraceDbEventData'>})¶

class_vetoes = ()¶

class llama.files.RctSlkLmaLvcGcnXml¶

Bases: llama.files.slack.SlackReceiptLlama

Required input files for llama.files.slack.RctSlkLmaLvcGcnXml (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.slack.RctSlkLmaLvcGcnXml to be generated.¶

DEPENDENCIES = (<class 'llama.files.lvc_gcn_xml.LvcGcnXml'>, <class 'llama.files.skymap_info.SkymapInfo'>)¶

FILENAME = 'rct_slk_lma_lvc_gcn.xml.json'¶

FILENAME_FMT = 'rct_slk_lma_{}.json'¶

MANIFEST_TYPES = (<class 'llama.files.slack.RctSlkLmaLvcGcnXml'>,)¶

UPLOAD¶: alias of llama.files.lvc_gcn_xml.LvcGcnXml

UR_DEPENDENCIES = (<class 'llama.files.lvc_gcn_xml.LvcGcnXml'>, <class 'llama.files.skymap_info.SkymapInfo'>)¶

UR_DEPENDENCY_TREE = frozenset({<class 'llama.files.lvc_gcn_xml.LvcGcnXml'>})¶

class_vetoes = ()¶

class llama.files.RctSlkLmaLvcRetractionXml¶

Bases: llama.files.slack.SlackReceiptLlama

Required input files for llama.files.slack.RctSlkLmaLvcRetractionXml (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.slack.RctSlkLmaLvcRetractionXml to be generated.¶

DEPENDENCIES = (<class 'llama.files.lvc_gcn_xml.LvcRetractionXml'>, <class 'llama.files.skymap_info.SkymapInfo'>)¶

FILENAME = 'rct_slk_lma_lvc_gcn_retraction.xml.json'¶

FILENAME_FMT = 'rct_slk_lma_{}.json'¶

MANIFEST_TYPES = (<class 'llama.files.slack.RctSlkLmaLvcRetractionXml'>,)¶

UPLOAD¶: alias of llama.files.lvc_gcn_xml.LvcRetractionXml

UR_DEPENDENCIES = (<class 'llama.files.lvc_gcn_xml.LvcRetractionXml'>, <class 'llama.files.skymap_info.SkymapInfo'>)¶

UR_DEPENDENCY_TREE = frozenset({<class 'llama.files.lvc_gcn_xml.LvcRetractionXml'>})¶

class_vetoes = ()¶

class llama.files.RctSlkLmaSkymapInfo¶

Bases: llama.files.slack.SlackReceiptLlama

Required input files for llama.files.slack.RctSlkLmaSkymapInfo (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.slack.RctSlkLmaSkymapInfo to be generated.¶

DEPENDENCIES = (<class 'llama.files.skymap_info.SkymapInfo'>,)¶

FILENAME = 'rct_slk_lma_skymap_info.json.json'¶

FILENAME_FMT = 'rct_slk_lma_{}.json'¶

MANIFEST_TYPES = (<class 'llama.files.slack.RctSlkLmaSkymapInfo'>,)¶

UPLOAD¶: alias of llama.files.skymap_info.SkymapInfo

UR_DEPENDENCIES = (<class 'llama.files.skymap_info.SkymapInfo'>,)¶

UR_DEPENDENCY_TREE = frozenset({<class 'llama.files.skymap_info.SkymapInfo'>})¶

class_vetoes = ()¶

class llama.files.RctSlkLmaLvcDistancesJson¶

Bases: llama.files.slack.SlackReceiptLlama

Required input files for llama.files.lvc_skymap.RctSlkLmaLvcDistancesJson (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.RctSlkLmaLvcDistancesJson to be generated.¶

DEPENDENCIES = (<class 'llama.files.lvc_skymap.LvcDistancesJson'>, <class 'llama.files.skymap_info.SkymapInfo'>)¶

FILENAME = 'rct_slk_lma_lvc_skymap_distances.json.json'¶

FILENAME_FMT = 'rct_slk_lma_{}.json'¶

MANIFEST_TYPES = (<class 'llama.files.lvc_skymap.RctSlkLmaLvcDistancesJson'>,)¶

UPLOAD¶: alias of LvcDistancesJson

UR_DEPENDENCIES = (<class 'llama.files.skymap_info.SkymapInfo'>, <class 'llama.files.lvc_skymap.LvcSkymapFits'>, <class 'llama.files.lvc_skymap.LvcDistancesJson'>)¶

UR_DEPENDENCY_TREE = frozenset({<class 'llama.files.lvc_skymap.LvcDistancesJson'>})¶

class_vetoes = ()¶

class llama.files.ZtfTriggerList¶

Bases: llama.filehandler.JSONFile, llama.files.healpix.skymap.HEALPixPSF

Required input files for llama.files.ztf_trigger_list.ZtfTriggerList (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.ztf_trigger_list.ZtfTriggerList to be generated.¶

Takes a list of dictionaries describing neutrinos and saves it to a text file. Validates the neutrino data to make sure each neutrino contains (minimally) the following properties:

gps
ra
dec

The sigma value is always expected to be negligible and is hence given as a small value (relative to GW skymap pixel sizes).

DEPENDENCIES = (<class 'llama.files.skymap_info.SkymapInfo'>,)¶

DETECTORS = (Detector(name='ZTF', abbrev='ztf', fullname='Zwicky Transient Facility', url='https://www.ptf.caltech.edu/page/ztf_technical', summary='ZTF', description='', citations=ImmutableDict({'The Zwicky Transient Facility (Bellm 2014)': 'http://adsabs.harvard.edu/abs/2014arXiv1410.8185B', 'The unblinking eye on the sky (Bellm and Kulkarni 2017)': 'http://adsabs.harvard.edu/abs/2017NatAs...1E..71B', 'The Zwicky Transient Facility Camera (Dekany et al. 2016)': 'http://adsabs.harvard.edu/abs/2016SPIE.9908E..5MD', 'The Zwicky transient facility observing system (Smith et al. 2014)': 'http://adsabs.harvard.edu/abs/2014SPIE.9147E..79S'})),)¶

FILENAME = 'ztf_trigger_list.json'¶

MANIFEST_TYPES = (<class 'llama.files.ztf_trigger_list.ZtfTriggerList'>,)¶

SIGMA = 0.1¶

UR_DEPENDENCIES = (<class 'llama.files.skymap_info.SkymapInfo'>,)¶

UR_DEPENDENCY_TREE = frozenset({<class 'llama.files.skymap_info.SkymapInfo'>})¶

class_vetoes = ((<function always_veto>, None),)¶

property num_triggers¶: The number of triggers described by this file. Useful mostly for quickly determining if this trigger list is empty.

source_locations()¶: Returns a list of tuples of (RA, Dec, sigma) for all point-like sources, where (RA, Dec) is the central sky position and sigma is the standard deviation of the Gaussian PSF. Since this depends on the structure of data in the relevant file handler, it must be specified for each subclass.

property template_skymap_filehandler¶: The HEALPixSkyMapFileHandler whose HEALPix parameters should be used as a template for the HEALPixSkyMap output by this FileHandler. It is assumed that this HEALPixSkyMapFileHandler only returns one skymap in its list; consequently, only the first skymap loaded by this file handler will be used. Note that the template skymap file handler is likely not a dependency of this file handler; it is only used as a default for formatting generated skymaps from this file handler’s data.

property triggers¶: Return a list containing a ZtfTrigger object for each trigger; more convenient to work with when writing formulae than dealing directly with the neutrino dictionaries.

class llama.files.CoincScatterZtfLVCPdf¶

Bases: llama.files.coinc_plots.CoincScatterZtfLVC

Required input files for llama.files.coinc_plots.CoincScatterZtfLVCPdf (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.coinc_plots.CoincScatterZtfLVCPdf to be generated.¶

Human-readable joint ZTF/Gravitational Wave skymap plot in PDF format.

DEPENDENCIES = (<class 'llama.files.lvc_skymap.LvcSkymapHdf5'>, <class 'llama.files.ztf_trigger_list.ZtfTriggerList'>)¶

FILEEXT = 'pdf'¶

FILENAME = 'scatterplot_lvc-ztf.pdf'¶

MANIFEST_TYPES = (<class 'llama.files.coinc_plots.CoincScatterZtfLVCPdf'>,)¶

UR_DEPENDENCIES = (<class 'llama.files.skymap_info.SkymapInfo'>, <class 'llama.files.lvc_skymap.LvcSkymapFits'>, <class 'llama.files.lvc_skymap.LvcSkymapHdf5'>, <class 'llama.files.ztf_trigger_list.ZtfTriggerList'>)¶

UR_DEPENDENCY_TREE = ImmutableDict({<class 'llama.files.ztf_trigger_list.ZtfTriggerList'>: ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})}), <class 'llama.files.lvc_skymap.LvcSkymapHdf5'>: ImmutableDict({<class 'llama.files.lvc_skymap.LvcSkymapFits'>: ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})})})})¶

class llama.files.CoincScatterZtfLVCPng¶

Bases: llama.files.coinc_plots.CoincScatterZtfLVC

Required input files for llama.files.coinc_plots.CoincScatterZtfLVCPng (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.coinc_plots.CoincScatterZtfLVCPng to be generated.¶

Human-readable joint ZTF/Gravitational Wave skymap plot in PNG format.

DEPENDENCIES = (<class 'llama.files.lvc_skymap.LvcSkymapHdf5'>, <class 'llama.files.ztf_trigger_list.ZtfTriggerList'>)¶

FILEEXT = 'png'¶

FILENAME = 'scatterplot_lvc-ztf.png'¶

MANIFEST_TYPES = (<class 'llama.files.coinc_plots.CoincScatterZtfLVCPng'>,)¶

UR_DEPENDENCIES = (<class 'llama.files.skymap_info.SkymapInfo'>, <class 'llama.files.lvc_skymap.LvcSkymapFits'>, <class 'llama.files.lvc_skymap.LvcSkymapHdf5'>, <class 'llama.files.ztf_trigger_list.ZtfTriggerList'>)¶

UR_DEPENDENCY_TREE = ImmutableDict({<class 'llama.files.ztf_trigger_list.ZtfTriggerList'>: ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})}), <class 'llama.files.lvc_skymap.LvcSkymapHdf5'>: ImmutableDict({<class 'llama.files.lvc_skymap.LvcSkymapFits'>: ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})})})})¶

class llama.files.CoincScatterZtfI3LvcPdf¶

Bases: llama.files.coinc_plots.CoincScatterZtfI3Lvc

Required input files for llama.files.coinc_plots.CoincScatterZtfI3LvcPdf (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.coinc_plots.CoincScatterZtfI3LvcPdf to be generated.¶

Human-readable joint ZTF/Gravitational Wave/High Energy Neutrino skymap plot in PDF format.

DEPENDENCIES = (<class 'llama.files.lvc_skymap.LvcSkymapHdf5'>, <class 'llama.files.i3.json.IceCubeNeutrinoList'>, <class 'llama.files.ztf_trigger_list.ZtfTriggerList'>)¶

FILEEXT = 'pdf'¶

FILENAME = 'scatterplot_lvc-i3-ztf.pdf'¶

MANIFEST_TYPES = (<class 'llama.files.coinc_plots.CoincScatterZtfI3LvcPdf'>,)¶

UR_DEPENDENCIES = (<class 'llama.files.skymap_info.SkymapInfo'>, <class 'llama.files.lvc_skymap.LvcSkymapFits'>, <class 'llama.files.lvc_skymap.LvcSkymapHdf5'>, <class 'llama.files.ztf_trigger_list.ZtfTriggerList'>, <class 'llama.files.i3.json.IceCubeNeutrinoList'>)¶

UR_DEPENDENCY_TREE = ImmutableDict({<class 'llama.files.i3.json.IceCubeNeutrinoList'>: ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})}), <class 'llama.files.ztf_trigger_list.ZtfTriggerList'>: ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})}), <class 'llama.files.lvc_skymap.LvcSkymapHdf5'>: ImmutableDict({<class 'llama.files.lvc_skymap.LvcSkymapFits'>: ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})})})})¶

class llama.files.CoincScatterZtfI3LvcPng¶

Bases: llama.files.coinc_plots.CoincScatterZtfI3Lvc

Required input files for llama.files.coinc_plots.CoincScatterZtfI3LvcPng (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.coinc_plots.CoincScatterZtfI3LvcPng to be generated.¶

Human-readable joint ZTF/Gravitational Wave/High Energy Neutrino skymap plot in PNG format.

DEPENDENCIES = (<class 'llama.files.lvc_skymap.LvcSkymapHdf5'>, <class 'llama.files.i3.json.IceCubeNeutrinoList'>, <class 'llama.files.ztf_trigger_list.ZtfTriggerList'>)¶

FILEEXT = 'png'¶

FILENAME = 'scatterplot_lvc-i3-ztf.png'¶

MANIFEST_TYPES = (<class 'llama.files.coinc_plots.CoincScatterZtfI3LvcPng'>,)¶

UR_DEPENDENCIES = (<class 'llama.files.skymap_info.SkymapInfo'>, <class 'llama.files.lvc_skymap.LvcSkymapFits'>, <class 'llama.files.lvc_skymap.LvcSkymapHdf5'>, <class 'llama.files.ztf_trigger_list.ZtfTriggerList'>, <class 'llama.files.i3.json.IceCubeNeutrinoList'>)¶

UR_DEPENDENCY_TREE = ImmutableDict({<class 'llama.files.i3.json.IceCubeNeutrinoList'>: ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})}), <class 'llama.files.ztf_trigger_list.ZtfTriggerList'>: ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})}), <class 'llama.files.lvc_skymap.LvcSkymapHdf5'>: ImmutableDict({<class 'llama.files.lvc_skymap.LvcSkymapFits'>: ImmutableDict({<class 'llama.files.skymap_info.SkymapInfo'>: ImmutableDict({})})})})¶

Subpackages

Submodules