llama.files.ztf_trigger_list module

Methods and FileHandler classes associated with fetching ZTF triggers.

class llama.files.ztf_trigger_list.ZtfTriggerList

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

digraph "llama.files.ztf_trigger_list.ZtfTriggerList" { charset="utf-8" splines=ortho bgcolor=none margin=0 rankdir=LR "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.ztf_trigger_list.ZtfTriggerList" [label=<{{<B>ZtfTriggerList</B>|<I>ztf_trigger_list.json</I>|JSONFile<BR/>HEALPixPSF}}>, shape="record", style=filled, target=_top, URL="/llama.files.ztf_trigger_list.html#llama.files.ztf_trigger_list.ZtfTriggerList", fillcolor="#cccccc"]; "llama.files.skymap_info.SkymapInfo" -> "llama.files.ztf_trigger_list.ZtfTriggerList" [arrowtail="none", color="red", ]; }

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 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', 'The unblinking eye on the sky (Bellm and Kulkarni 2017)': 'http://adsabs.harvard.edu/abs/2017NatAs...1E..71B'})),)
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.

llama.files.ztf_trigger_list.always_veto(eventdir)

Always veto this FileHandler so that it has to be manually added.