tests.py 14.7 KB
Newer Older
1
2
3
import unittest
import numpy as np
import os
Gregory Ashton's avatar
Gregory Ashton committed
4
5
import shutil
import pyfstat
6
import lalpulsar
Gregory Ashton's avatar
Gregory Ashton committed
7

8

Gregory Ashton's avatar
Gregory Ashton committed
9
class Test(unittest.TestCase):
Gregory Ashton's avatar
Gregory Ashton committed
10
11
    outdir = 'TestData'

Gregory Ashton's avatar
Gregory Ashton committed
12
    @classmethod
Gregory Ashton's avatar
Gregory Ashton committed
13
14
15
    def setUpClass(self):
        if os.path.isdir(self.outdir):
            shutil.rmtree(self.outdir)
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
        h0 = 1
        sqrtSX = 1
        F0 = 30
        F1 = -1e-10
        F2 = 0
        minStartTime = 700000000
        duration = 2 * 86400
        Alpha = 5e-3
        Delta = 1.2
        tref = minStartTime
        Writer = pyfstat.Writer(F0=F0, F1=F1, F2=F2, label='test',
                                h0=h0, sqrtSX=sqrtSX,
                                outdir=self.outdir, tstart=minStartTime,
                                Alpha=Alpha, Delta=Delta, tref=tref,
                                duration=duration,
                                Band=4)
        Writer.make_data()
        self.sftfilepath = Writer.sftfilepath
        self.minStartTime = minStartTime
        self.maxStartTime = minStartTime + duration
        self.duration = duration
37

Gregory Ashton's avatar
Gregory Ashton committed
38
    @classmethod
Gregory Ashton's avatar
Gregory Ashton committed
39
40
41
    def tearDownClass(self):
        if os.path.isdir(self.outdir):
            shutil.rmtree(self.outdir)
Gregory Ashton's avatar
Gregory Ashton committed
42
43


44
class Writer(Test):
Gregory Ashton's avatar
Gregory Ashton committed
45
    label = "TestWriter"
46
47

    def test_make_cff(self):
Gregory Ashton's avatar
Gregory Ashton committed
48
        Writer = pyfstat.Writer(self.label, outdir=self.outdir)
49
        Writer.make_cff()
50
51
        self.assertTrue(os.path.isfile(
            './{}/{}.cff'.format(self.outdir, self.label)))
52
53

    def test_run_makefakedata(self):
54
        Writer = pyfstat.Writer(self.label, outdir=self.outdir, duration=3600)
55
56
57
        Writer.make_cff()
        Writer.run_makefakedata()
        self.assertTrue(os.path.isfile(
58
            './{}/H-2_H1_1800SFT_TestWriter-700000000-3600.sft'
59
            .format(self.outdir)))
60
61

    def test_makefakedata_usecached(self):
62
        Writer = pyfstat.Writer(self.label, outdir=self.outdir, duration=3600)
63
64
        if os.path.isfile(Writer.sftfilepath):
            os.remove(Writer.sftfilepath)
Gregory Ashton's avatar
Gregory Ashton committed
65
        Writer.make_cff()
66
        Writer.run_makefakedata()
67
        time_first = os.path.getmtime(Writer.sftfilepath)
68
        Writer.run_makefakedata()
69
        time_second = os.path.getmtime(Writer.sftfilepath)
70
71
72
        self.assertTrue(time_first == time_second)
        os.system('touch {}'.format(Writer.config_file_name))
        Writer.run_makefakedata()
73
        time_third = os.path.getmtime(Writer.sftfilepath)
74
75
76
        self.assertFalse(time_first == time_third)


77
class Bunch(Test):
Gregory Ashton's avatar
Gregory Ashton committed
78
79
80
81
82
    def test_bunch(self):
        b = pyfstat.core.Bunch(dict(x=10))
        self.assertTrue(b.x == 10)


83
class par(Test):
Gregory Ashton's avatar
Gregory Ashton committed
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
    label = 'TestPar'

    def test(self):
        os.system('mkdir {}'.format(self.outdir))
        os.system(
            'echo "x=100\ny=10" > {}/{}.par'.format(self.outdir, self.label))

        par = pyfstat.core.read_par(
            '{}/{}.par'.format(self.outdir, self.label), return_type='Bunch')
        self.assertTrue(par.x == 100)
        self.assertTrue(par.y == 10)

        par = pyfstat.core.read_par(outdir=self.outdir, label=self.label,
                                    return_type='dict')
        self.assertTrue(par['x'] == 100)
        self.assertTrue(par['y'] == 10)
100
        os.system('rm -r {}'.format(self.outdir))
Gregory Ashton's avatar
Gregory Ashton committed
101
102


103
class BaseSearchClass(Test):
104
105
106
    def test_shift_matrix(self):
        BSC = pyfstat.BaseSearchClass()
        dT = 10
107
        a = BSC._shift_matrix(4, dT)
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
        b = np.array([[1, 2*np.pi*dT, 2*np.pi*dT**2/2.0, 2*np.pi*dT**3/6.0],
                      [0, 1, dT, dT**2/2.0],
                      [0, 0, 1, dT],
                      [0, 0, 0, 1]])
        self.assertTrue(np.array_equal(a, b))

    def test_shift_coefficients(self):
        BSC = pyfstat.BaseSearchClass()
        thetaA = np.array([10., 1e2, 10., 1e2])
        dT = 100

        # Calculate the 'long' way
        thetaB = np.zeros(len(thetaA))
        thetaB[3] = thetaA[3]
        thetaB[2] = thetaA[2] + thetaA[3]*dT
        thetaB[1] = thetaA[1] + thetaA[2]*dT + .5*thetaA[3]*dT**2
        thetaB[0] = thetaA[0] + 2*np.pi*(thetaA[1]*dT + .5*thetaA[2]*dT**2
                                         + thetaA[3]*dT**3 / 6.0)

        self.assertTrue(
            np.array_equal(
129
                thetaB, BSC._shift_coefficients(thetaA, dT)))
130
131
132
133
134

    def test_shift_coefficients_loop(self):
        BSC = pyfstat.BaseSearchClass()
        thetaA = np.array([10., 1e2, 10., 1e2])
        dT = 1e1
135
        thetaB = BSC._shift_coefficients(thetaA, dT)
136
137
        self.assertTrue(
            np.allclose(
138
                thetaA, BSC._shift_coefficients(thetaB, -dT),
139
140
141
                rtol=1e-9, atol=1e-9))


142
class ComputeFstat(Test):
Gregory Ashton's avatar
Gregory Ashton committed
143
    label = "TestComputeFstat"
144
145

    def test_run_computefstatistic_single_point(self):
Gregory Ashton's avatar
Gregory Ashton committed
146
        Writer = pyfstat.Writer(self.label, outdir=self.outdir, duration=86400,
147
                                h0=1, sqrtSX=1, detectors='H1,L1')
148
149
150
        Writer.make_data()
        predicted_FS = Writer.predict_fstat()

151
152
153
154
155
156
        search_H1L1 = pyfstat.ComputeFstat(
            tref=Writer.tref,
            sftfilepattern='{}/*{}*sft'.format(Writer.outdir, Writer.label))
        FS = search_H1L1.get_fullycoherent_twoF(
            Writer.tstart, Writer.tend, Writer.F0, Writer.F1, Writer.F2,
            Writer.Alpha, Writer.Delta)
Gregory Ashton's avatar
Gregory Ashton committed
157
        self.assertTrue(np.abs(predicted_FS-FS)/FS < 0.3)
158
159
160

        Writer.detectors = 'H1'
        predicted_FS = Writer.predict_fstat()
161
162
163
164
165
166
167
        search_H1 = pyfstat.ComputeFstat(
            tref=Writer.tref, detectors='H1',
            sftfilepattern='{}/*{}*sft'.format(Writer.outdir, Writer.label),
            SSBprec=lalpulsar.SSBPREC_RELATIVISTIC)
        FS = search_H1.get_fullycoherent_twoF(
            Writer.tstart, Writer.tend, Writer.F0, Writer.F1, Writer.F2,
            Writer.Alpha, Writer.Delta)
Gregory Ashton's avatar
Gregory Ashton committed
168
        self.assertTrue(np.abs(predicted_FS-FS)/FS < 0.3)
169

170
    def run_computefstatistic_single_point_no_noise(self):
171
172
173
        Writer = pyfstat.Writer(
            self.label, outdir=self.outdir, add_noise=False, duration=86400,
            h0=1, sqrtSX=1)
174
175
176
177
178
        Writer.make_data()
        predicted_FS = Writer.predict_fstat()

        search = pyfstat.ComputeFstat(
            tref=Writer.tref, assumeSqrtSX=1,
179
            sftfilepattern='{}/*{}*sft'.format(Writer.outdir, Writer.label))
180
181
182
        FS = search.get_fullycoherent_twoF(
            Writer.tstart, Writer.tend, Writer.F0, Writer.F1, Writer.F2,
            Writer.Alpha, Writer.Delta)
183
        self.assertTrue(np.abs(predicted_FS-FS)/FS < 0.3)
Gregory Ashton's avatar
Gregory Ashton committed
184

185
    def test_injectSources(self):
186
187
188
189
        # This seems to be writing with a signal...
        Writer = pyfstat.Writer(
            self.label, outdir=self.outdir, add_noise=False, duration=86400,
            h0=1, sqrtSX=1)
190
191
192
193
194
195
196
197
        Writer.make_cff()
        injectSources = Writer.config_file_name

        search = pyfstat.ComputeFstat(
            tref=Writer.tref, assumeSqrtSX=1, injectSources=injectSources,
            minCoverFreq=28, maxCoverFreq=32, minStartTime=Writer.tstart,
            maxStartTime=Writer.tstart+Writer.duration,
            detectors=Writer.detectors)
198
        FS_from_file = search.get_fullycoherent_twoF(
199
200
            Writer.tstart, Writer.tend, Writer.F0, Writer.F1, Writer.F2,
            Writer.Alpha, Writer.Delta)
201
202
        Writer.make_data()
        predicted_FS = Writer.predict_fstat()
Gregory Ashton's avatar
Gregory Ashton committed
203
        self.assertTrue(np.abs(predicted_FS-FS_from_file)/FS_from_file < 0.3)
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219

        injectSourcesdict = pyfstat.core.read_par(Writer.config_file_name)
        injectSourcesdict['F0'] = injectSourcesdict['Freq']
        injectSourcesdict['F1'] = injectSourcesdict['f1dot']
        injectSourcesdict['F2'] = injectSourcesdict['f2dot']
        search = pyfstat.ComputeFstat(
            tref=Writer.tref, assumeSqrtSX=1, injectSources=injectSourcesdict,
            minCoverFreq=28, maxCoverFreq=32, minStartTime=Writer.tstart,
            maxStartTime=Writer.tstart+Writer.duration,
            detectors=Writer.detectors)
        FS_from_dict = search.get_fullycoherent_twoF(
            Writer.tstart, Writer.tend, Writer.F0, Writer.F1, Writer.F2,
            Writer.Alpha, Writer.Delta)
        self.assertTrue(FS_from_dict == FS_from_file)


220
class SemiCoherentSearch(Test):
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
    label = "TestSemiCoherentSearch"

    def test_get_semicoherent_twoF(self):
        duration = 10*86400
        Writer = pyfstat.Writer(
            self.label, outdir=self.outdir, duration=duration, h0=1, sqrtSX=1)
        Writer.make_data()

        search = pyfstat.SemiCoherentSearch(
            label=self.label, outdir=self.outdir, nsegs=2,
            sftfilepattern='{}/*{}*sft'.format(Writer.outdir, Writer.label),
            tref=Writer.tref, minStartTime=Writer.tstart,
            maxStartTime=Writer.tend)

        search.get_semicoherent_twoF(
            Writer.F0, Writer.F1, Writer.F2, Writer.Alpha, Writer.Delta,
            record_segments=True)

        # Compute the predicted semi-coherent Fstat
        minStartTime = Writer.tstart
        maxStartTime = Writer.tend

        Writer.maxStartTime = minStartTime + duration / 2.0
        FSA = Writer.predict_fstat()

        Writer.tstart = minStartTime + duration / 2.0
        Writer.tend = maxStartTime
        FSB = Writer.predict_fstat()

        FSs = np.array([FSA, FSB])
        diffs = (np.array(search.detStat_per_segment) - FSs) / FSs
        self.assertTrue(np.all(diffs < 0.3))

    def test_get_semicoherent_BSGL(self):
        duration = 10*86400
        Writer = pyfstat.Writer(
            self.label, outdir=self.outdir, duration=duration,
            detectors='H1,L1')
        Writer.make_data()

        search = pyfstat.SemiCoherentSearch(
            label=self.label, outdir=self.outdir, nsegs=2,
            sftfilepattern='{}/*{}*sft'.format(Writer.outdir, Writer.label),
            tref=Writer.tref, minStartTime=Writer.tstart,
            maxStartTime=Writer.tend, BSGL=True)

        BSGL = search.get_semicoherent_twoF(
            Writer.F0, Writer.F1, Writer.F2, Writer.Alpha, Writer.Delta,
            record_segments=True)
        self.assertTrue(BSGL > 0)
271
272


273
class SemiCoherentGlitchSearch(Test):
Gregory Ashton's avatar
Gregory Ashton committed
274
    label = "TestSemiCoherentGlitchSearch"
Gregory Ashton's avatar
Gregory Ashton committed
275

276
    def test_get_semicoherent_nglitch_twoF(self):
Gregory Ashton's avatar
Gregory Ashton committed
277
278
        duration = 10*86400
        dtglitch = .5*duration
279
        delta_F0 = 0
Gregory Ashton's avatar
Gregory Ashton committed
280
281
        h0 = 1
        sqrtSX = 1
282
        Writer = pyfstat.GlitchWriter(
Gregory Ashton's avatar
Gregory Ashton committed
283
            self.label, outdir=self.outdir, duration=duration, dtglitch=dtglitch,
Gregory Ashton's avatar
Gregory Ashton committed
284
            delta_F0=delta_F0, sqrtSX=sqrtSX, h0=h0)
285
286
287
288

        Writer.make_data()

        search = pyfstat.SemiCoherentGlitchSearch(
Gregory Ashton's avatar
Gregory Ashton committed
289
            label=self.label, outdir=self.outdir,
290
            sftfilepattern='{}/*{}*sft'.format(Writer.outdir, Writer.label),
291
292
            tref=Writer.tref, minStartTime=Writer.tstart,
            maxStartTime=Writer.tend, nglitch=1)
293

294
295
296
        FS = search.get_semicoherent_nglitch_twoF(
            Writer.F0, Writer.F1, Writer.F2, Writer.Alpha, Writer.Delta,
            Writer.delta_F0, Writer.delta_F1, search.minStartTime+dtglitch)
297
298

        # Compute the predicted semi-coherent glitch Fstat
299
300
        minStartTime = Writer.tstart
        maxStartTime = Writer.tend
301

302
        Writer.maxStartTime = minStartTime + dtglitch
303
304
        FSA = Writer.predict_fstat()

305
306
        Writer.tstart = minStartTime + dtglitch
        Writer.tend = maxStartTime
307
308
        FSB = Writer.predict_fstat()

309
        print FSA, FSB
310
311
312
        predicted_FS = (FSA + FSB)

        print(predicted_FS, FS)
Gregory Ashton's avatar
Gregory Ashton committed
313
        self.assertTrue(np.abs((FS - predicted_FS))/predicted_FS < 0.3)
314
315


316
class MCMCSearch(Test):
Gregory Ashton's avatar
Gregory Ashton committed
317
    label = "TestMCMCSearch"
318
319

    def test_fully_coherent(self):
Gregory Ashton's avatar
Gregory Ashton committed
320
321
        h0 = 1
        sqrtSX = 1
322
323
324
        F0 = 30
        F1 = -1e-10
        F2 = 0
325
        minStartTime = 700000000
Gregory Ashton's avatar
Gregory Ashton committed
326
        duration = 1 * 86400
327
        maxStartTime = minStartTime + duration
328
329
        Alpha = 5e-3
        Delta = 1.2
330
        tref = minStartTime
331
332
        Writer = pyfstat.Writer(F0=F0, F1=F1, F2=F2, label=self.label,
                                h0=h0, sqrtSX=sqrtSX,
Gregory Ashton's avatar
Gregory Ashton committed
333
                                outdir=self.outdir, tstart=minStartTime,
334
                                Alpha=Alpha, Delta=Delta, tref=tref,
335
                                duration=duration,
336
                                Band=4)
337
338
339
340

        Writer.make_data()
        predicted_FS = Writer.predict_fstat()

Gregory Ashton's avatar
Gregory Ashton committed
341
342
        theta = {'F0': {'type': 'norm', 'loc': F0, 'scale': np.abs(1e-10*F0)},
                 'F1': {'type': 'norm', 'loc': F1, 'scale': np.abs(1e-10*F1)},
343
344
                 'F2': F2, 'Alpha': Alpha, 'Delta': Delta}

Gregory Ashton's avatar
Gregory Ashton committed
345
        search = pyfstat.MCMCSearch(
Gregory Ashton's avatar
Gregory Ashton committed
346
            label=self.label, outdir=self.outdir, theta_prior=theta, tref=tref,
347
            sftfilepattern='{}/*{}*sft'.format(Writer.outdir, Writer.label),
348
            minStartTime=minStartTime, maxStartTime=maxStartTime,
349
            nsteps=[100, 100], nwalkers=100, ntemps=2, log10beta_min=-1)
350
        search.run(create_plots=False)
351
352
353
354
        _, FS = search.get_max_twoF()

        print('Predicted twoF is {} while recovered is {}'.format(
                predicted_FS, FS))
Gregory Ashton's avatar
Gregory Ashton committed
355
356
        self.assertTrue(
            FS > predicted_FS or np.abs((FS-predicted_FS))/predicted_FS < 0.3)
357
358


359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
class GridSearch(Test):
    F0s = [29, 31, 0.1]
    F1s = [-1e-10, 0, 1e-11]
    tref = 700000000

    def test_grid_search(self):
        search = pyfstat.GridSearch(
            'grid_search', self.outdir, self.sftfilepath, F0s=self.F0s,
            F1s=[0], F2s=[0], Alphas=[0], Deltas=[0], tref=self.tref)
        search.run()
        self.assertTrue(os.path.isfile(search.out_file))

    def test_semicoherent_grid_search(self):
        search = pyfstat.GridSearch(
            'sc_grid_search', self.outdir, self.sftfilepath, F0s=self.F0s,
            F1s=[0], F2s=[0], Alphas=[0], Deltas=[0], tref=self.tref, nsegs=2)
        search.run()
        self.assertTrue(os.path.isfile(search.out_file))

    def test_slice_grid_search(self):
        search = pyfstat.SliceGridSearch(
            'slice_grid_search', self.outdir, self.sftfilepath, F0s=self.F0s,
            F1s=self.F1s, F2s=[0], Alphas=[0], Deltas=[0], tref=self.tref,
            Lambda0=[30, 0, 0, 0])
        search.run()
        self.assertTrue(os.path.isfile('{}/{}_slice_projection.png'
                                       .format(search.outdir, search.label)))

    def test_glitch_grid_search(self):
        search = pyfstat.GridGlitchSearch(
            'grid_grid_search', self.outdir, self.sftfilepath, F0s=self.F0s,
            F1s=self.F1s, F2s=[0], Alphas=[0], Deltas=[0], tref=self.tref,
            tglitchs=[self.tref])
        search.run()
        self.assertTrue(os.path.isfile(search.out_file))

    def test_sliding_window(self):
        search = pyfstat.FrequencySlidingWindow(
            'grid_grid_search', self.outdir, self.sftfilepath, F0s=self.F0s,
            F1=0, F2=0, Alpha=0, Delta=0, tref=self.tref,
            minStartTime=self.minStartTime, maxStartTime=self.maxStartTime)
        search.run()
        self.assertTrue(os.path.isfile(search.out_file))

403
404
if __name__ == '__main__':
    unittest.main()