diff --git a/tupak/detector.py b/tupak/detector.py
index a2b5fc9ab85042334a0c24c9b49a335c2c28a8bb..1fdfac291beffa798dfbf837c09aa235dfbc6542 100644
--- a/tupak/detector.py
+++ b/tupak/detector.py
@@ -477,16 +477,10 @@ def get_empty_interferometer(name):
raise ValueError('Interferometer {} not implemented'.format(name))
-# Maintain backward compatibility - should be removed in the future
-H1 = get_empty_interferometer('H1')
-L1 = get_empty_interferometer('L1')
-V1 = get_empty_interferometer('V1')
-GEO600 = get_empty_interferometer('GEO600')
-
-
-def get_interferometer_with_open_data(name, center_time, T=4, alpha=0.25, psd_offset=-1024, psd_duration=100,
- cache=True, outdir='outdir', plot=True, filter_freq=1024, raw_data_file=None,
- **kwargs):
+def get_interferometer_with_open_data(
+ name, center_time, T=4, alpha=0.25, psd_offset=-1024, psd_duration=100,
+ cache=True, outdir='outdir', plot=True, filter_freq=1024,
+ raw_data_file=None, **kwargs):
"""
Helper function to obtain an Interferometer instance with appropriate
PSD and data, given an center_time
@@ -523,11 +517,11 @@ def get_interferometer_with_open_data(name, center_time, T=4, alpha=0.25, psd_of
utils.check_directory_exists_and_if_not_mkdir(outdir)
- strain = get_open_strain_data(
+ strain = utils.get_open_strain_data(
name, center_time-T/2, center_time+T/2, outdir=outdir, cache=cache,
raw_data_file=raw_data_file, **kwargs)
- strain_psd = get_open_strain_data(
+ strain_psd = utils.get_open_strain_data(
name, center_time+psd_offset, center_time+psd_offset+psd_duration,
raw_data_file=raw_data_file,
outdir=outdir, cache=cache, **kwargs)
@@ -585,8 +579,9 @@ def get_interferometer_with_open_data(name, center_time, T=4, alpha=0.25, psd_of
def get_interferometer_with_fake_noise_and_injection(
- name, injection_polarizations, injection_parameters, sampling_frequency=4096, time_duration=4,
- outdir='outdir', plot=True, save=True):
+ name, injection_polarizations, injection_parameters,
+ sampling_frequency=4096, time_duration=4, outdir='outdir', plot=True,
+ save=True):
"""
Helper function to obtain an Interferometer instance with appropriate
PSD and data, given an center_time
@@ -619,11 +614,15 @@ def get_interferometer_with_fake_noise_and_injection(
utils.check_directory_exists_and_if_not_mkdir(outdir)
interferometer = get_empty_interferometer(name)
- interferometer.set_data(sampling_frequency=sampling_frequency, duration=time_duration,
- from_power_spectral_density=True)
- interferometer.inject_signal(waveform_polarizations=injection_polarizations, parameters=injection_parameters)
+ interferometer.set_data(
+ sampling_frequency=sampling_frequency, duration=time_duration,
+ from_power_spectral_density=True)
+ interferometer.inject_signal(
+ waveform_polarizations=injection_polarizations,
+ parameters=injection_parameters)
- interferometer_signal = interferometer.get_detector_response(injection_polarizations, injection_parameters)
+ interferometer_signal = interferometer.get_detector_response(
+ injection_polarizations, injection_parameters)
if plot:
fig, ax = plt.subplots()
@@ -632,7 +631,8 @@ def get_interferometer_with_fake_noise_and_injection(
ax.loglog(interferometer.frequency_array,
interferometer.amplitude_spectral_density_array,
'-C1', lw=0.5, label=name+' ASD')
- ax.loglog(interferometer.frequency_array, abs(interferometer_signal), label='Signal')
+ ax.loglog(interferometer.frequency_array, abs(interferometer_signal),
+ label='Signal')
ax.grid('on')
ax.set_ylabel(r'strain [strain/$\sqrt{\rm Hz}$]')
ax.set_xlabel(r'frequency [Hz]')
@@ -646,30 +646,10 @@ def get_interferometer_with_fake_noise_and_injection(
return interferometer
-def get_open_strain_data(name, t1, t2, outdir, cache=False, raw_data_file=None,
- **kwargs):
- filename = '{}/{}_{}_{}.txt'.format(outdir, name, t1, t2)
- if raw_data_file:
- logging.info('Attempting to use raw_data_file {}'.format(raw_data_file))
- strain = TimeSeries.read(raw_data_file)
- if (t1 > strain.times[0].value) and (t2 < strain.times[-1].value):
- logging.info('Using supplied raw data file')
- strain = strain.crop(t1, t2)
- else:
- raise ValueError('Supplied file does not contain requested data')
- elif os.path.isfile(filename) and cache:
- logging.info('Using cached data from {}'.format(filename))
- strain = TimeSeries.read(filename)
- else:
- logging.info('Fetching open data ...')
- strain = TimeSeries.fetch_open_data(name, t1, t2, **kwargs)
- logging.info('Saving data to {}'.format(filename))
- strain.write(filename)
- return strain
-
-
-def get_event_data(event, interferometer_names=None, time_duration=4, alpha=0.25, psd_offset=-1024, psd_duration=100,
- cache=True, outdir='outdir', plot=True, filter_freq=1024, raw_data_file=None, **kwargs):
+def get_event_data(
+ event, interferometer_names=None, time_duration=4, alpha=0.25,
+ psd_offset=-1024, psd_duration=100, cache=True, outdir='outdir',
+ plot=True, filter_freq=1024, raw_data_file=None, **kwargs):
"""
Get open data for a specified event.
@@ -679,7 +659,8 @@ def get_event_data(event, interferometer_names=None, time_duration=4, alpha=0.25
Parameters
----------
event: str
- Event descriptor, this can deal with some prefixes, e.g., '150914', 'GW150914', 'LVT151012'
+ Event descriptor, this can deal with some prefixes, e.g., '150914',
+ 'GW150914', 'LVT151012'
interferometer_names: list, optional
List of interferometer identifiers, e.g., 'H1'.
If None will look for data in 'H1', 'V1', 'L1'
@@ -717,8 +698,10 @@ def get_event_data(event, interferometer_names=None, time_duration=4, alpha=0.25
for name in interferometer_names:
try:
interferometers.append(get_interferometer_with_open_data(
- name, event_time, T=time_duration, alpha=alpha, psd_offset=psd_offset, psd_duration=psd_duration,
- cache=cache, outdir=outdir, plot=plot, filter_freq=filter_freq, raw_data_file=raw_data_file, **kwargs))
+ name, event_time, T=time_duration, alpha=alpha,
+ psd_offset=psd_offset, psd_duration=psd_duration, cache=cache,
+ outdir=outdir, plot=plot, filter_freq=filter_freq,
+ raw_data_file=raw_data_file, **kwargs))
except ValueError:
logging.info('No data found for {}.'.format(name))
diff --git a/tupak/utils.py b/tupak/utils.py
index 77d3a208e5a90374d0e60187b64b5f6250dd6a25..13a860c4f43b6d856177e7ab0108774d91f29651 100644
--- a/tupak/utils.py
+++ b/tupak/utils.py
@@ -3,6 +3,7 @@ import logging
import os
import numpy as np
from math import fmod
+from gwpy.timeseries import TimeSeries
# Constants
speed_of_light = 299792458.0 # speed of light in m/s
@@ -416,3 +417,50 @@ def get_event_time(event):
except KeyError:
print('Unknown event {}.'.format(event))
return None
+
+
+def get_open_strain_data(
+ name, t1, t2, outdir, cache=False, raw_data_file=None, **kwargs):
+ """ A function which accesses the open strain data
+
+ This uses `gwpy` to download the open data and then saves a cached copy for
+ later use
+
+ Parameters
+ ----------
+ name: str
+ The name of the detector to get data for
+ t1, t2: float
+ The GPS time of the start and end of the data
+ outdir: str
+ The output directory to place data in
+ cache: bool
+ If true, cache the data
+ **kwargs:
+ Passed to `gwpy.timeseries.TimeSeries.fetch_open_data`
+
+ Returns
+ strain: gwpy.timeseries.TimeSeries
+
+ """
+ filename = '{}/{}_{}_{}.txt'.format(outdir, name, t1, t2)
+ if raw_data_file:
+ logging.info('Using raw_data_file {}'.format(raw_data_file))
+ strain = TimeSeries.read(raw_data_file)
+ if (t1 > strain.times[0].value) and (t2 < strain.times[-1].value):
+ logging.info('Using supplied raw data file')
+ strain = strain.crop(t1, t2)
+ else:
+ raise ValueError('Supplied file does not contain requested data')
+ elif os.path.isfile(filename) and cache:
+ logging.info('Using cached data from {}'.format(filename))
+ strain = TimeSeries.read(filename)
+ else:
+ logging.info('Fetching open data ...')
+ strain = TimeSeries.fetch_open_data(name, t1, t2, **kwargs)
+ logging.info('Saving data to {}'.format(filename))
+ strain.write(filename)
+ return strain
+
+
+