diff --git a/.gitattributes b/.gitattributes
index 4174c2c11802378444130abb951faf7df71ac9b6..9a86c3d222d972b10eb5fdf50fe8f73fe26cb7dc 100755
--- a/.gitattributes
+++ b/.gitattributes
@@ -9,3 +9,4 @@ tests/gws-1-1.h5 filter=lfs diff=lfs merge=lfs -text
tests/gws-2-0.h5 filter=lfs diff=lfs merge=lfs -text
tests/glitch-1-1.h5 filter=lfs diff=lfs merge=lfs -text
tests/glitch-1-0.h5 filter=lfs diff=lfs merge=lfs -text
+tests/glitch-1-3.h5 filter=lfs diff=lfs merge=lfs -text
diff --git a/lisainstrument/containers.py b/lisainstrument/containers.py
index 2d11729aa4bd1d2dc09ea07921a3399bd3828ea8..af9dcfe76520b903c1862d363cbba134862d421b 100644
--- a/lisainstrument/containers.py
+++ b/lisainstrument/containers.py
@@ -133,7 +133,7 @@ class ForEachObject(abc.ABC):
plt.xlabel("Time [s]")
plt.ylabel("Signal")
plt.title(title)
- # Save or show glitch
+ # Save or show
if output is not None:
logger.info("Saving plot to %s", output)
plt.savefig(output, bbox_inches='tight')
diff --git a/lisainstrument/instrument.py b/lisainstrument/instrument.py
index cde4fff7aa36e86b026ed630021bf823bedb8524..c625da8779cc6de01c04e1be077494d0fba585b3 100755
--- a/lisainstrument/instrument.py
+++ b/lisainstrument/instrument.py
@@ -781,32 +781,90 @@ class Instrument:
* test-mass glitches `tm_ij` [m/s]
* laser glitches `laser_ij` [Hz]
+ * readout glitches in the carrier ISIs `readout_isi_carrier_ij` [Hz]
+ * readout glitches in the upper sideband ISIs `readout_isi_usb_ij` [Hz]
+ * readout glitches in the carrier TMIs `readout_tmi_carrier_ij` [Hz]
+ * readout glitches in the upper sideband TMIs `readout_tmi_usb_ij` [Hz]
+ * readout glitches in the carrier RFIs `readout_rfi_carrier_ij` [Hz]
+ * readout glitches in the upper sideband RFIs `readout_rfi_usb_ij` [Hz]
"""
if isinstance(glitches, str):
+ interpolate = lambda x, y, newx: InterpolatedUnivariateSpline(x, y, k=5, ext='const')(newx)
+
self.glitch_file = glitches
logger.info("Interpolating glitch signals from glitch file '%s'", self.glitch_file)
with File(self.glitch_file, 'r') as glitchf:
version = Version(glitchf.attrs['version'])
logger.debug("Using glitch file version %s", version)
- if version.is_devrelease:
+ if version.is_devrelease or version.local is not None:
logger.warning("You are using a glitch file in a development version")
- if version in SpecifierSet('~= 1.0', True):
+ if version >= Version('1.3.dev'):
+ logger.warning(
+ "You are using a glitch file in a version that might not be fully supported")
+ if version >= Version('1.3.dev'):
+ # Readout glitches
+ self.glitch_readout_isi_carriers = ForEachMOSA(lambda mosa:
+ 0 if f'readout_isi_carrier_{mosa}' not in glitchf else \
+ interpolate(glitchf['t'][:], glitchf[f'readout_isi_carrier_{mosa}'][:], self.physics_t)
+ )
+ self.glitch_readout_isi_usbs = ForEachMOSA(lambda mosa:
+ 0 if f'readout_isi_usb_{mosa}' not in glitchf else \
+ interpolate(glitchf['t'][:], glitchf[f'readout_isi_usb_{mosa}'][:], self.physics_t)
+ )
+ self.glitch_readout_tmi_carriers = ForEachMOSA(lambda mosa:
+ 0 if f'readout_tmi_carrier_{mosa}' not in glitchf else \
+ interpolate(glitchf['t'][:], glitchf[f'readout_tmi_carrier_{mosa}'][:], self.physics_t)
+ )
+ self.glitch_readout_tmi_usbs = ForEachMOSA(lambda mosa:
+ 0 if f'readout_tmi_usb_{mosa}' not in glitchf else \
+ interpolate(glitchf['t'][:], glitchf[f'readout_tmi_usb_{mosa}'][:], self.physics_t)
+ )
+ self.glitch_readout_rfi_carriers = ForEachMOSA(lambda mosa:
+ 0 if f'readout_rfi_carrier_{mosa}' not in glitchf else \
+ interpolate(glitchf['t'][:], glitchf[f'readout_rfi_carrier_{mosa}'][:], self.physics_t)
+ )
+ self.glitch_readout_rfi_usbs = ForEachMOSA(lambda mosa:
+ 0 if f'readout_rfi_usb_{mosa}' not in glitchf else \
+ interpolate(glitchf['t'][:], glitchf[f'readout_rfi_usb_{mosa}'][:], self.physics_t)
+ )
+ # Test-mass glitches
self.glitch_tms = ForEachMOSA(lambda mosa:
0 if f'tm_{mosa}' not in glitchf else \
- InterpolatedUnivariateSpline(
- glitchf['t'][:], glitchf[f'tm_{mosa}'][:], k=5, ext='const')(self.physics_t)
+ interpolate(glitchf['t'][:], glitchf[f'tm_{mosa}'][:], self.physics_t)
)
+ # Laser glitches
self.glitch_lasers = ForEachMOSA(lambda mosa:
0 if f'laser_{mosa}' not in glitchf else \
- InterpolatedUnivariateSpline(
- glitchf['t'][:], glitchf[f'laser_{mosa}'][:], k=5, ext='const')(self.physics_t)
+ interpolate(glitchf['t'][:], glitchf[f'laser_{mosa}'][:], self.physics_t)
+ )
+ elif version >= Version('1.0'):
+ # Readout glitches
+ self.glitch_readout_isi_carriers = ForEachMOSA(0)
+ self.glitch_readout_isi_usbs = ForEachMOSA(0)
+ self.glitch_readout_tmi_carriers = ForEachMOSA(0)
+ self.glitch_readout_tmi_usbs = ForEachMOSA(0)
+ self.glitch_readout_rfi_carriers = ForEachMOSA(0)
+ self.glitch_readout_rfi_usbs = ForEachMOSA(0)
+ # Test-mass glitches
+ self.glitch_tms = ForEachMOSA(lambda mosa:
+ 0 if f'tm_{mosa}' not in glitchf else \
+ interpolate(glitchf['t'][:], glitchf[f'tm_{mosa}'][:], self.physics_t)
+ )
+ # Laser glitches
+ self.glitch_lasers = ForEachMOSA(lambda mosa:
+ 0 if f'laser_{mosa}' not in glitchf else \
+ interpolate(glitchf['t'][:], glitchf[f'laser_{mosa}'][:], self.physics_t)
)
- else:
- raise ValueError(f"unsupported glitch file version '{version}'")
elif glitches is None:
logger.debug("No glitches")
self.glitch_file = None
+ self.glitch_readout_isi_carriers = ForEachMOSA(0)
+ self.glitch_readout_isi_usbs = ForEachMOSA(0)
+ self.glitch_readout_tmi_carriers = ForEachMOSA(0)
+ self.glitch_readout_tmi_usbs = ForEachMOSA(0)
+ self.glitch_readout_rfi_carriers = ForEachMOSA(0)
+ self.glitch_readout_rfi_usbs = ForEachMOSA(0)
self.glitch_tms = ForEachMOSA(0)
self.glitch_lasers = ForEachMOSA(0)
else:
@@ -1058,7 +1116,8 @@ class Instrument:
logger.debug("Computing inter-spacecraft carrier beatnote fluctuations on TPS")
self.tps_isi_carrier_fluctuations = \
self.distant_isi_carrier_fluctuations - self.local_isi_carrier_fluctuations \
- + self.central_freq * self.oms_isi_carrier_noises
+ + self.central_freq * self.oms_isi_carrier_noises \
+ + self.glitch_readout_isi_carriers
logger.debug("Computing inter-spacecraft upper sideband beatnote offsets on TPS")
self.tps_isi_usb_offsets = \
@@ -1067,7 +1126,8 @@ class Instrument:
logger.debug("Computing inter-spacecraft upper sideband beatnote fluctuations on TPS")
self.tps_isi_usb_fluctuations = \
self.distant_isi_usb_fluctuations - self.local_isi_usb_fluctuations \
- + self.central_freq * self.oms_isi_usb_noises
+ + self.central_freq * self.oms_isi_usb_noises \
+ + self.glitch_readout_isi_usbs
## Inter-spacecraft DWS measurements on TPS (high-frequency)
@@ -1131,7 +1191,8 @@ class Instrument:
logger.debug("Computing test-mass carrier beatnote fluctuations on TPS")
self.tps_tmi_carrier_fluctuations = \
self.adjacent_tmi_carrier_fluctuations - self.local_tmi_carrier_fluctuations \
- + self.central_freq * self.oms_tmi_carrier_noises
+ + self.central_freq * self.oms_tmi_carrier_noises \
+ + self.glitch_readout_tmi_carriers
logger.debug("Computing test-mass upper sideband beatnote offsets on TPS")
self.tps_tmi_usb_offsets = \
@@ -1140,7 +1201,8 @@ class Instrument:
logger.debug("Computing test-mass upper sideband beatnote fluctuations on TPS")
self.tps_tmi_usb_fluctuations = \
self.adjacent_tmi_usb_fluctuations - self.local_tmi_usb_fluctuations \
- + self.central_freq * self.oms_tmi_usb_noises
+ + self.central_freq * self.oms_tmi_usb_noises \
+ + self.glitch_readout_tmi_usbs
## Reference interferometer local beams
@@ -1185,7 +1247,8 @@ class Instrument:
logger.debug("Computing reference carrier beatnote fluctuations on TPS")
self.tps_rfi_carrier_fluctuations = \
self.adjacent_rfi_carrier_fluctuations - self.local_rfi_carrier_fluctuations \
- + self.central_freq * self.oms_rfi_carrier_noises
+ + self.central_freq * self.oms_rfi_carrier_noises \
+ + self.glitch_readout_rfi_carriers
logger.debug("Computing reference upper sideband beatnote offsets on TPS")
self.tps_rfi_usb_offsets = \
@@ -1194,7 +1257,8 @@ class Instrument:
logger.debug("Computing reference upper sideband beatnote fluctuations on TPS")
self.tps_rfi_usb_fluctuations = \
self.adjacent_rfi_usb_fluctuations - self.local_rfi_usb_fluctuations \
- + self.central_freq * self.oms_rfi_usb_noises
+ + self.central_freq * self.oms_rfi_usb_noises \
+ + self.glitch_readout_rfi_usbs
## Sampling beatnotes, DWS measurements, and measured pseudo-ranges to THE grid
diff --git a/tests/glitch-1-3.h5 b/tests/glitch-1-3.h5
new file mode 100644
index 0000000000000000000000000000000000000000..6a8fc55d1ca3fac140ad9bf3d78d673a1f68acfb
--- /dev/null
+++ b/tests/glitch-1-3.h5
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:f23b2661a1740eb1b4a1b829404754d7a9eb02127366837b88c898ddf11e4701
+size 122992
diff --git a/tests/test_glitch.py b/tests/test_glitch.py
index 30df75e9d3b01577e30d6300fe38b7a09548cdad..b568d8f202d69a1e17217c66f285a7edd991946e 100644
--- a/tests/test_glitch.py
+++ b/tests/test_glitch.py
@@ -2,7 +2,6 @@
# -*- coding: utf-8 -*-
"""Test reading of glitch files."""
-import numpy as np
from pytest import approx
from h5py import File
from lisaconstants import c
@@ -179,3 +178,102 @@ def test_glitch_file_1_1():
else:
assert approx(instru.local_tmi_usb_fluctuations[mosa]) == \
instru.local_usb_fluctuations[mosa]
+
+def test_glitch_file_1_3():
+ """Test that we can read test-mass and laser glitches from files v1.3.
+
+ Test glitch file can be generated using LISA Glitch and the following script.
+
+ from lisaglitch import ShapeletGlitch
+ path = 'tests/glitch-1-3.h5'
+ ShapeletGlitch(beta=2, quantum_n=1, inj_point='tm_12', t_inj=10.0, size=200).write(path, mode='w')
+ ShapeletGlitch(beta=1, quantum_n=2, inj_point='tm_23', t_inj=0.0).write(path)
+ ShapeletGlitch(beta=3, quantum_n=2, inj_point='tm_31', t_inj=5.0).write(path)
+ ShapeletGlitch(beta=4, quantum_n=1, inj_point='laser_12', t_inj=0.0).write(path)
+ ShapeletGlitch(beta=4, quantum_n=3, inj_point='laser_31', t_inj=0.0).write(path)
+ ShapeletGlitch(beta=3, quantum_n=2, inj_point='readout_isi_carrier_12', t_inj=0.0).write(path)
+ ShapeletGlitch(beta=1, quantum_n=1, inj_point='readout_isi_carrier_23', t_inj=0.0).write(path)
+ ShapeletGlitch(beta=4, quantum_n=1, inj_point='readout_isi_carrier_31', t_inj=0.0).write(path)
+ ShapeletGlitch(beta=3, quantum_n=2, inj_point='readout_isi_usb_12', t_inj=0.0).write(path)
+ ShapeletGlitch(beta=3, quantum_n=3, inj_point='readout_isi_usb_32', t_inj=0.0).write(path)
+ ShapeletGlitch(beta=4, quantum_n=2, inj_point='readout_isi_usb_13', t_inj=0.0).write(path)
+ ShapeletGlitch(beta=4, quantum_n=2, inj_point='readout_tmi_carrier_12', t_inj=0.0).write(path)
+ ShapeletGlitch(beta=3, quantum_n=3, inj_point='readout_tmi_usb_32', t_inj=0.0).write(path)
+ ShapeletGlitch(beta=3, quantum_n=2, inj_point='readout_rfi_carrier_23', t_inj=0.0).write(path)
+ ShapeletGlitch(beta=2, quantum_n=1, inj_point='readout_rfi_usb_13', t_inj=0.0).write(path)
+ """
+
+ glitch_file = 'tests/glitch-1-3.h5'
+ glitchf = File(glitch_file, 'r')
+
+ instru = Instrument(
+ size=glitchf.attrs['size'],
+ t0=glitchf.attrs['t0'],
+ dt=glitchf.attrs['dt'],
+ physics_upsampling=1,
+ aafilter=None,
+ lock='six',
+ glitches=glitch_file,
+ orbits='tests/keplerian-orbits-1-0-2.h5')
+ instru.disable_all_noises()
+
+ assert instru.glitch_file is glitch_file
+ for mosa in instru.MOSAS:
+
+ # Missing datasets should be zero
+ tm_dataset = f'tm_{mosa}'
+ if tm_dataset in glitchf:
+ assert instru.glitch_tms[mosa] == approx(glitchf[tm_dataset][:])
+ else:
+ assert instru.glitch_tms[mosa] == 0
+
+ laser_dataset = f'laser_{mosa}'
+ if laser_dataset in glitchf:
+ assert instru.glitch_lasers[mosa] == approx(glitchf[laser_dataset][:])
+ else:
+ assert instru.glitch_lasers[mosa] == 0
+
+ readout_isi_carrier_dataset = f'readout_isi_carrier_{mosa}'
+ if readout_isi_carrier_dataset in glitchf:
+ assert instru.glitch_readout_isi_carriers[mosa] \
+ == approx(glitchf[readout_isi_carrier_dataset][:])
+ else:
+ assert instru.glitch_readout_isi_carriers[mosa] == 0
+
+ readout_isi_usb_dataset = f'readout_isi_usb_{mosa}'
+ if readout_isi_usb_dataset in glitchf:
+ assert instru.glitch_readout_isi_usbs[mosa] \
+ == approx(glitchf[readout_isi_usb_dataset][:])
+ else:
+ assert instru.glitch_readout_isi_usbs[mosa] == 0
+
+ readout_tmi_carrier_dataset = f'readout_tmi_carrier_{mosa}'
+ if readout_tmi_carrier_dataset in glitchf:
+ assert instru.glitch_readout_tmi_carriers[mosa] \
+ == approx(glitchf[readout_tmi_carrier_dataset][:])
+ else:
+ assert instru.glitch_readout_tmi_carriers[mosa] == 0
+
+ readout_tmi_usb_dataset = f'readout_tmi_usb_{mosa}'
+ if readout_tmi_usb_dataset in glitchf:
+ assert instru.glitch_readout_tmi_usbs[mosa] \
+ == approx(glitchf[readout_tmi_usb_dataset][:])
+ else:
+ assert instru.glitch_readout_tmi_usbs[mosa] == 0
+
+ readout_rfi_carrier_dataset = f'readout_rfi_carrier_{mosa}'
+ if readout_rfi_carrier_dataset in glitchf:
+ assert instru.glitch_readout_rfi_carriers[mosa] \
+ == approx(glitchf[readout_rfi_carrier_dataset][:])
+ else:
+ assert instru.glitch_readout_rfi_carriers[mosa] == 0
+
+ readout_rfi_usb_dataset = f'readout_rfi_usb_{mosa}'
+ if readout_rfi_usb_dataset in glitchf:
+ assert instru.glitch_readout_rfi_usbs[mosa] \
+ == approx(glitchf[readout_rfi_usb_dataset][:])
+ else:
+ assert instru.glitch_readout_rfi_usbs[mosa] == 0
+
+ instru.simulate()
+ instru.write(mode='w')