make_sfts.py 21.2 KB
Newer Older
Gregory Ashton's avatar
Gregory Ashton committed
1
""" pyfstat tools to generate sfts """
2
from __future__ import division, absolute_import, print_function
Gregory Ashton's avatar
Gregory Ashton committed
3
4
5
6

import numpy as np
import logging
import os
7
import glob
8
import pkgutil
Gregory Ashton's avatar
Gregory Ashton committed
9

Gregory Ashton's avatar
Gregory Ashton committed
10
import lal
Gregory Ashton's avatar
Gregory Ashton committed
11
12
import lalpulsar

Gregory Ashton's avatar
Gregory Ashton committed
13
from pyfstat.core import BaseSearchClass, tqdm, args, predict_fstat
14
import pyfstat.helper_functions as helper_functions
Gregory Ashton's avatar
Gregory Ashton committed
15
16


17
18
19
20
class KeyboardInterruptError(Exception):
    pass


Gregory Ashton's avatar
Gregory Ashton committed
21
class Writer(BaseSearchClass):
22
    """ Instance object for generating SFTs """
Gregory Ashton's avatar
Gregory Ashton committed
23
24
    @helper_functions.initializer
    def __init__(self, label='Test', tstart=700000000, duration=100*86400,
25
                 tref=None, F0=30, F1=1e-10, F2=0, Alpha=5e-3,
Gregory Ashton's avatar
Gregory Ashton committed
26
27
                 Delta=6e-2, h0=0.1, cosi=0.0, psi=0.0, phi=0, Tsft=1800,
                 outdir=".", sqrtSX=1, Band=4, detectors='H1',
David Keitel's avatar
David Keitel committed
28
29
                 minStartTime=None, maxStartTime=None, add_noise=True,
                 transientWindowType='none'):
Gregory Ashton's avatar
Gregory Ashton committed
30
31
32
33
34
        """
        Parameters
        ----------
        label: string
            a human-readable label to be used in naming the output files
35
36
        tstart, duration : int
            start and duration (in gps seconds) of the total observation span
Gregory Ashton's avatar
Gregory Ashton committed
37
38
39
40
41
42
43
44
45
46
47
48
49
50
        tref: float or None
            reference time (default is None, which sets the reference time to
            tstart)
        F0, F1, F2, Alpha, Delta, h0, cosi, psi, phi: float
            frequency, sky-position, and amplitude parameters
        Tsft: float
            the sft duration
        minStartTime, maxStartTime: float
            if not None, the total span of data, this can be used to generate
            transient signals

        see `lalapps_Makefakedata_v5 --help` for help with the other paramaters
        """

51
        self.set_ephemeris_files()
Gregory Ashton's avatar
Gregory Ashton committed
52
53
54
55
56
        self.basic_setup()
        self.calculate_fmin_Band()

        self.tbounds = [self.tstart, self.tend]
        logging.info('Using segment boundaries {}'.format(self.tbounds))
57

Gregory Ashton's avatar
Gregory Ashton committed
58
59
60
    def basic_setup(self):
        self.tstart = int(self.tstart)
        self.duration = int(self.duration)
Gregory Ashton's avatar
Gregory Ashton committed
61
62
63
64
65
        self.tend = self.tstart + self.duration
        if self.minStartTime is None:
            self.minStartTime = self.tstart
        if self.maxStartTime is None:
            self.maxStartTime = self.tend
Gregory Ashton's avatar
Gregory Ashton committed
66
67
68
69
70
71
        self.minStartTime = int(self.minStartTime)
        self.maxStartTime = int(self.maxStartTime)
        self.duration_days = (self.tend-self.tstart) / 86400

        self.data_duration = self.maxStartTime - self.minStartTime
        numSFTs = int(float(self.data_duration) / self.Tsft)
Gregory Ashton's avatar
Gregory Ashton committed
72

Gregory Ashton's avatar
Gregory Ashton committed
73
        self.theta = np.array([self.phi, self.F0, self.F1, self.F2])
Gregory Ashton's avatar
Gregory Ashton committed
74
75
76
77
78

        if os.path.isdir(self.outdir) is False:
            os.makedirs(self.outdir)
        if self.tref is None:
            self.tref = self.tstart
Gregory Ashton's avatar
Gregory Ashton committed
79
        self.config_file_name = "{}/{}.cff".format(self.outdir, self.label)
Gregory Ashton's avatar
Gregory Ashton committed
80
81
82
83
84
85
86
        self.sftfilenames = [
            lalpulsar.OfficialSFTFilename(
                dets[0], dets[1], numSFTs, self.Tsft, self.minStartTime,
                self.data_duration, self.label)
            for dets in self.detectors.split(',')]
        self.sftfilepath = ';'.join([
            '{}/{}'.format(self.outdir, fn) for fn in self.sftfilenames])
Gregory Ashton's avatar
Gregory Ashton committed
87
88
        self.IFOs = (
            ",".join(['"{}"'.format(d) for d in self.detectors.split(",")]))
Gregory Ashton's avatar
Gregory Ashton committed
89
90
91
92
93
94

    def make_data(self):
        ''' A convienience wrapper to generate a cff file then sfts '''
        self.make_cff()
        self.run_makefakedata()

95
    def get_base_template(self, i, Alpha, Delta, h0, cosi, psi, phi, F0,
Gregory Ashton's avatar
Gregory Ashton committed
96
                          F1, F2, tref):
97
        return (
Gregory Ashton's avatar
Gregory Ashton committed
98
99
100
101
102
103
104
105
106
107
"""[TS{}]
Alpha = {:1.18e}
Delta = {:1.18e}
h0 = {:1.18e}
cosi = {:1.18e}
psi = {:1.18e}
phi0 = {:1.18e}
Freq = {:1.18e}
f1dot = {:1.18e}
f2dot = {:1.18e}
108
109
refTime = {:10.6f}""")

Gregory Ashton's avatar
Gregory Ashton committed
110
111
112
113
114
115
116
117
118
119
120
121
    def get_single_config_line_cw(
            self, i, Alpha, Delta, h0, cosi, psi, phi, F0, F1, F2, tref):
        template = (self.get_base_template(
            i, Alpha, Delta, h0, cosi, psi, phi, F0, F1, F2, tref) + """\n""")
        return template.format(
            i, Alpha, Delta, h0, cosi, psi, phi, F0, F1, F2, tref)

    def get_single_config_line_tcw(
            self, i, Alpha, Delta, h0, cosi, psi, phi, F0, F1, F2, tref,
            window, tstart, duration_days):
        template = (self.get_base_template(
            i, Alpha, Delta, h0, cosi, psi, phi, F0, F1, F2, tref) + """
David Keitel's avatar
David Keitel committed
122
123
124
transientWindowType = {:s}
transientStartTime = {:10.3f}
transientTauDays = {:1.3f}\n""")
Gregory Ashton's avatar
Gregory Ashton committed
125
        return template.format(i, Alpha, Delta, h0, cosi, psi, phi, F0, F1,
David Keitel's avatar
David Keitel committed
126
                               F2, tref, window, tstart, duration_days)
Gregory Ashton's avatar
Gregory Ashton committed
127

128
129
    def get_single_config_line(self, i, Alpha, Delta, h0, cosi, psi, phi, F0,
                               F1, F2, tref, window, tstart, duration_days):
Gregory Ashton's avatar
Gregory Ashton committed
130
131
132
        if window == 'none':
            return self.get_single_config_line_cw(
                i, Alpha, Delta, h0, cosi, psi, phi, F0, F1, F2, tref)
133
        else:
Gregory Ashton's avatar
Gregory Ashton committed
134
135
136
            return self.get_single_config_line_tcw(
                i, Alpha, Delta, h0, cosi, psi, phi, F0, F1, F2, tref, window,
                tstart, duration_days)
137

Gregory Ashton's avatar
Gregory Ashton committed
138
139
    def make_cff(self):
        """
140
        Generates a .cff file
Gregory Ashton's avatar
Gregory Ashton committed
141
142
143

        """

144
145
        content = self.get_single_config_line(
            0, self.Alpha, self.Delta, self.h0, self.cosi, self.psi,
Gregory Ashton's avatar
Gregory Ashton committed
146
147
            self.phi, self.F0, self.F1, self.F2, self.tref,
            self.transientWindowType, self.tstart, self.duration_days)
Gregory Ashton's avatar
Gregory Ashton committed
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231

        if self.check_if_cff_file_needs_rewritting(content):
            config_file = open(self.config_file_name, "w+")
            config_file.write(content)
            config_file.close()

    def calculate_fmin_Band(self):
        self.fmin = self.F0 - .5 * self.Band

    def check_cached_data_okay_to_use(self, cl_mfd):
        """ Check if cached data exists and, if it does, if it can be used """

        getmtime = os.path.getmtime

        if os.path.isfile(self.sftfilepath) is False:
            logging.info('No SFT file matching {} found'.format(
                self.sftfilepath))
            return False
        else:
            logging.info('Matching SFT file found')

        if getmtime(self.sftfilepath) < getmtime(self.config_file_name):
            logging.info(
                ('The config file {} has been modified since the sft file {} '
                 + 'was created').format(
                    self.config_file_name, self.sftfilepath))
            return False

        logging.info(
            'The config file {} is older than the sft file {}'.format(
                self.config_file_name, self.sftfilepath))
        logging.info('Checking contents of cff file')
        cl_dump = 'lalapps_SFTdumpheader {} | head -n 20'.format(
            self.sftfilepath)
        output = helper_functions.run_commandline(cl_dump)
        calls = [line for line in output.split('\n') if line[:3] == 'lal']
        if calls[0] == cl_mfd:
            logging.info('Contents matched, use old sft file')
            return True
        else:
            logging.info('Contents unmatched, create new sft file')
            return False

    def check_if_cff_file_needs_rewritting(self, content):
        """ Check if the .cff file has changed

        Returns True if the file should be overwritten - where possible avoid
        overwriting to allow cached data to be used
        """
        if os.path.isfile(self.config_file_name) is False:
            logging.info('No config file {} found'.format(
                self.config_file_name))
            return True
        else:
            logging.info('Config file {} already exists'.format(
                self.config_file_name))

        with open(self.config_file_name, 'r') as f:
            file_content = f.read()
            if file_content == content:
                logging.info(
                    'File contents match, no update of {} required'.format(
                        self.config_file_name))
                return False
            else:
                logging.info(
                    'File contents unmatched, updating {}'.format(
                        self.config_file_name))
                return True

    def run_makefakedata(self):
        """ Generate the sft data from the configuration file """

        # Remove old data:
        try:
            os.unlink("{}/*{}*.sft".format(self.outdir, self.label))
        except OSError:
            pass

        cl_mfd = []
        cl_mfd.append('lalapps_Makefakedata_v5')
        cl_mfd.append('--outSingleSFT=TRUE')
        cl_mfd.append('--outSFTdir="{}"'.format(self.outdir))
        cl_mfd.append('--outLabel="{}"'.format(self.label))
Gregory Ashton's avatar
Gregory Ashton committed
232
        cl_mfd.append('--IFOs={}'.format(self.IFOs))
Gregory Ashton's avatar
Gregory Ashton committed
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
        if self.add_noise:
            cl_mfd.append('--sqrtSX="{}"'.format(self.sqrtSX))
        if self.minStartTime is None:
            cl_mfd.append('--startTime={:0.0f}'.format(float(self.tstart)))
        else:
            cl_mfd.append('--startTime={:0.0f}'.format(
                float(self.minStartTime)))
        if self.maxStartTime is None:
            cl_mfd.append('--duration={}'.format(int(self.duration)))
        else:
            data_duration = self.maxStartTime - self.minStartTime
            cl_mfd.append('--duration={}'.format(int(data_duration)))
        cl_mfd.append('--fmin={:.16g}'.format(self.fmin))
        cl_mfd.append('--Band={:.16g}'.format(self.Band))
        cl_mfd.append('--Tsft={}'.format(self.Tsft))
        if self.h0 != 0:
            cl_mfd.append('--injectionSources="{}"'.format(
                self.config_file_name))

        cl_mfd = " ".join(cl_mfd)

        if self.check_cached_data_okay_to_use(cl_mfd) is False:
            helper_functions.run_commandline(cl_mfd)

    def predict_fstat(self):
        """ Wrapper to lalapps_PredictFstat """
Gregory Ashton's avatar
Gregory Ashton committed
259
260
261
262
263
        twoF_expected, twoF_sigma = predict_fstat(
            self.h0, self.cosi, self.psi, self.Alpha, self.Delta, self.F0,
            self.sftfilepath, self.minStartTime, self.maxStartTime,
            self.detectors, self.sqrtSX) # detectors OR IFO?
        return twoF_expected
264
265
266
267
268
269
270
271
272
273


class GlitchWriter(Writer):
    """ Instance object for generating SFTs containing glitch signals """
    @helper_functions.initializer
    def __init__(self, label='Test', tstart=700000000, duration=100*86400,
                 dtglitch=None, delta_phi=0, delta_F0=0, delta_F1=0,
                 delta_F2=0, tref=None, F0=30, F1=1e-10, F2=0, Alpha=5e-3,
                 Delta=6e-2, h0=0.1, cosi=0.0, psi=0.0, phi=0, Tsft=1800,
                 outdir=".", sqrtSX=1, Band=4, detectors='H1',
David Keitel's avatar
David Keitel committed
274
275
                 minStartTime=None, maxStartTime=None, add_noise=True,
                 transientWindowType='rect'):
276
277
278
279
280
        """
        Parameters
        ----------
        label: string
            a human-readable label to be used in naming the output files
281
282
        tstart, duration : float
            start and duration (in gps seconds) of the total observation span
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
        dtglitch: float
            time (in gps seconds) of the glitch after tstart. To create data
            without a glitch, set dtglitch=None
        delta_phi, delta_F0, delta_F1: float
            instanteneous glitch magnitudes in rad, Hz, and Hz/s respectively
        tref: float or None
            reference time (default is None, which sets the reference time to
            tstart)
        F0, F1, F2, Alpha, Delta, h0, cosi, psi, phi: float
            frequency, sky-position, and amplitude parameters
        Tsft: float
            the sft duration
        minStartTime, maxStartTime: float
            if not None, the total span of data, this can be used to generate
            transient signals

        see `lalapps_Makefakedata_v5 --help` for help with the other paramaters
        """

Gregory Ashton's avatar
Gregory Ashton committed
302
303
304
305
306
307
308
309
310
        self.basic_setup()
        self.calculate_fmin_Band()

        shapes = np.array([np.shape(x) for x in [self.delta_phi, self.delta_F0,
                                                 self.delta_F1, self.delta_F2]]
                          )
        if not np.all(shapes == shapes[0]):
            raise ValueError('all delta_* must be the same shape: {}'.format(
                shapes))
311

312
313
314
        for d in self.delta_phi, self.delta_F0, self.delta_F1, self.delta_F2:
            if np.size(d) == 1:
                d = np.atleast_1d(d)
Gregory Ashton's avatar
Gregory Ashton committed
315

316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
        if self.dtglitch is None:
            self.tbounds = [self.tstart, self.tend]
        else:
            self.dtglitch = np.atleast_1d(self.dtglitch)
            self.tglitch = self.tstart + self.dtglitch
            self.tbounds = np.concatenate((
                [self.tstart], self.tglitch, [self.tend]))
        logging.info('Using segment boundaries {}'.format(self.tbounds))

        tbs = np.array(self.tbounds)
        self.durations_days = (tbs[1:] - tbs[:-1]) / 86400

        self.delta_thetas = np.atleast_2d(
                np.array([delta_phi, delta_F0, delta_F1, delta_F2]).T)

    def make_cff(self):
        """
        Generates an .cff file for a 'glitching' signal

        """

        thetas = self._calculate_thetas(self.theta, self.delta_thetas,
                                        self.tbounds)

        content = ''
        for i, (t, d, ts) in enumerate(zip(thetas, self.durations_days,
                                           self.tbounds[:-1])):
            line = self.get_single_config_line(
                i, self.Alpha, self.Delta, self.h0, self.cosi, self.psi,
Gregory Ashton's avatar
Gregory Ashton committed
345
346
                t[0], t[1], t[2], t[3], self.tref, self.transientWindowType,
                ts, d)
347
348
349
350
351
352
353

            content += line

        if self.check_if_cff_file_needs_rewritting(content):
            config_file = open(self.config_file_name, "w+")
            config_file.write(content)
            config_file.close()
Gregory Ashton's avatar
Gregory Ashton committed
354
355
356
357
358
359


class FrequencyModulatedArtifactWriter(Writer):
    """ Instance object for generating SFTs containing artifacts """

    @helper_functions.initializer
360
    def __init__(self, label, outdir=".", tstart=700000000,
Gregory Ashton's avatar
Gregory Ashton committed
361
                 duration=86400, F0=30, F1=0, tref=None, h0=10, Tsft=1800,
362
                 sqrtSX=1, Band=4, Pmod=lal.DAYSID_SI, Pmod_phi=0, Pmod_amp=1,
Gregory Ashton's avatar
Gregory Ashton committed
363
364
                 Alpha=None, Delta=None, IFO='H1', minStartTime=None,
                 maxStartTime=None, detectors='H1'):
Gregory Ashton's avatar
Gregory Ashton committed
365
366
367
        """
        Parameters
        ----------
Gregory Ashton's avatar
Gregory Ashton committed
368
        tstart, duration : int
Gregory Ashton's avatar
Gregory Ashton committed
369
            start and duration times (in gps seconds) of the total observation
370
371
372
373
374
        Pmod, F0, F1 h0: float
            Modulation period, freq, freq-drift, and h0 of the artifact
        Alpha, Delta: float
            Sky position, in radians, of a signal of which to add the orbital
            modulation to the artifact, if not `None`.
Gregory Ashton's avatar
Gregory Ashton committed
375
376
377
378
379
380
381
        Tsft: float
            the sft duration
        sqrtSX: float
            Background IFO noise

        see `lalapps_Makefakedata_v4 --help` for help with the other paramaters
        """
Gregory Ashton's avatar
Gregory Ashton committed
382
383
        self.phi = 0
        self.F2 = 0
Gregory Ashton's avatar
Gregory Ashton committed
384

Gregory Ashton's avatar
Gregory Ashton committed
385
        self.basic_setup()
386
        self.set_ephemeris_files()
387
        self.tstart = int(tstart)
Gregory Ashton's avatar
Gregory Ashton committed
388
        self.duration = int(duration)
389

Gregory Ashton's avatar
Gregory Ashton committed
390
391
392
393
394
        if os.path.isdir(self.outdir) is False:
            os.makedirs(self.outdir)
        if tref is None:
            raise ValueError('Input `tref` not specified')

Gregory Ashton's avatar
Gregory Ashton committed
395
396
        self.nsfts = int(np.ceil(self.duration / self.Tsft))
        self.duration = self.duration / 86400.
Gregory Ashton's avatar
Gregory Ashton committed
397
398
399
400
401
        self.calculate_fmin_Band()

        self.cosi = 0
        self.Fmax = F0

402
        if Alpha is not None and Delta is not None:
403
404
405
            self.n = np.array([np.cos(Alpha)*np.cos(Delta),
                               np.sin(Alpha)*np.cos(Delta),
                               np.sin(Delta)])
Gregory Ashton's avatar
Gregory Ashton committed
406
407

    def get_frequency(self, t):
408
409
        DeltaFDrift = self.F1 * (t - self.tref)

410
411
412
        phir = 2*np.pi*t/self.Pmod + self.Pmod_phi

        if self.Alpha is not None and self.Delta is not None:
413
414
415
416
417
418
419
            spin_posvel = lalpulsar.PosVel3D_t()
            orbit_posvel = lalpulsar.PosVel3D_t()
            det = lal.CachedDetectors[4]
            ephems = lalpulsar.InitBarycenter(self.earth_ephem, self.sun_ephem)
            lalpulsar.DetectorPosVel(
                spin_posvel, orbit_posvel, lal.LIGOTimeGPS(t), det, ephems,
                lalpulsar.DETMOTION_ORBIT)
420
            # Pos and vel returned in units of c
421
            DeltaFOrbital = np.dot(self.n, orbit_posvel.vel) * self.Fmax
Gregory Ashton's avatar
Gregory Ashton committed
422

423
424
425
426
            if self.IFO == 'H1':
                Lambda = lal.LHO_4K_DETECTOR_LATITUDE_RAD
            elif self.IFO == 'L1':
                Lambda = lal.LLO_4K_DETECTOR_LATITUDE_RAD
427

428
429
430
431
432
433
434
            DeltaFSpin = (
                self.Pmod_amp*lal.REARTH_SI/lal.C_SI*2*np.pi/self.Pmod*(
                   np.cos(self.Delta)*np.cos(Lambda)*np.sin(self.Alpha-phir)
                   ) * self.Fmax)
        else:
            DeltaFOrbital = 0
            DeltaFSpin = 2*np.pi*self.Pmod_amp/self.Pmod*np.cos(phir)
435
436

        f = self.F0 + DeltaFDrift + DeltaFOrbital + DeltaFSpin
Gregory Ashton's avatar
Gregory Ashton committed
437
438
439
440
441
        return f

    def get_h0(self, t):
        return self.h0

442
    def concatenate_sft_files(self):
443
        SFTFilename = lalpulsar.OfficialSFTFilename(
444
            self.IFO[0], self.IFO[1], self.nsfts, self.Tsft, int(self.tstart),
Gregory Ashton's avatar
Gregory Ashton committed
445
            int(self.duration), self.label)
446

447
448
        # If the file already exists, simply remove it for now (no caching
        # implemented)
449
        helper_functions.run_commandline(
450
451
            'rm {}/{}'.format(self.outdir, SFTFilename), raise_error=False,
            log_level=10)
452
453

        cl_splitSFTS = (
454
            'lalapps_splitSFTs -fs {} -fb {} -fe {} -o {}/{} -i {}/*sft'
455
            .format(self.fmin, self.Band, self.fmin+self.Band, self.outdir,
456
                    SFTFilename, self.tmp_outdir))
457
        helper_functions.run_commandline(cl_splitSFTS)
458
        helper_functions.run_commandline('rm {} -r'.format(self.tmp_outdir))
459
460
461
462
463
464
465
466
467
468
469
        files = glob.glob('{}/{}*'.format(self.outdir, SFTFilename))
        if len(files) == 1:
            fn = files[0]
            fn_new = fn.split('.')[0] + '.sft'
            helper_functions.run_commandline('mv {} {}'.format(
                fn, fn_new))
        else:
            raise IOError(
                'Attempted to rename file, but multiple files found: {}'
                .format(files))

470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
    def pre_compute_evolution(self):
        logging.info('Precomputing evolution parameters')
        self.lineFreqs = []
        self.linePhis = []
        self.lineh0s = []
        self.mid_times = []

        linePhi = 0
        lineFreq_old = 0
        for i in tqdm(range(self.nsfts)):
            mid_time = self.tstart + (i+.5)*self.Tsft
            lineFreq = self.get_frequency(mid_time)

            self.mid_times.append(mid_time)
            self.lineFreqs.append(lineFreq)
            self.linePhis.append(linePhi + np.pi*self.Tsft*(lineFreq_old+lineFreq))
            self.lineh0s.append(self.get_h0(mid_time))

            lineFreq_old = lineFreq

    def make_ith_sft(self, i):
        try:
            self.run_makefakedata_v4(self.mid_times[i], self.lineFreqs[i],
                                     self.linePhis[i], self.lineh0s[i],
                                     self.tmp_outdir)
        except KeyboardInterrupt:
            raise KeyboardInterruptError()

Gregory Ashton's avatar
Gregory Ashton committed
498
499
500
    def make_data(self):
        self.maxStartTime = None
        self.duration = self.Tsft
501

502
503
        self.tmp_outdir = '{}/{}_tmp'.format(self.outdir, self.label)
        if os.path.isdir(self.tmp_outdir) is True:
504
505
            raise ValueError(
                'Temporary directory {} already exists, please rename'.format(
506
                    self.tmp_outdir))
507
        else:
508
            os.makedirs(self.tmp_outdir)
509

510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
        self.pre_compute_evolution()

        logging.info('Generating SFTs')

        if args.N > 1 and pkgutil.find_loader('pathos') is not None:
            import pathos.pools
            logging.info('Using {} threads'.format(args.N))
            try:
                with pathos.pools.ProcessPool(args.N) as p:
                    list(tqdm(p.imap(self.make_ith_sft, range(self.nsfts)),
                              total=self.nsfts))
            except KeyboardInterrupt:
                p.terminate()
        else:
            logging.info(
                "No multiprocessing requested or `pathos` not install, cont."
                " without multiprocessing")
            for i in tqdm(range(self.nsfts)):
                self.make_ith_sft(i)
Gregory Ashton's avatar
Gregory Ashton committed
529

530
        self.concatenate_sft_files()
531
532

    def run_makefakedata_v4(self, mid_time, lineFreq, linePhi, h0, tmp_outdir):
Gregory Ashton's avatar
Gregory Ashton committed
533
534
535
536
        """ Generate the sft data using the --lineFeature option """
        cl_mfd = []
        cl_mfd.append('lalapps_Makefakedata_v4')
        cl_mfd.append('--outSingleSFT=FALSE')
537
        cl_mfd.append('--outSFTbname="{}"'.format(tmp_outdir))
Gregory Ashton's avatar
Gregory Ashton committed
538
539
        cl_mfd.append('--IFO={}'.format(self.IFO))
        cl_mfd.append('--noiseSqrtSh="{}"'.format(self.sqrtSX))
540
        cl_mfd.append('--startTime={:0.0f}'.format(mid_time-self.Tsft/2.0))
Gregory Ashton's avatar
Gregory Ashton committed
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
        cl_mfd.append('--refTime={:0.0f}'.format(mid_time))
        cl_mfd.append('--duration={}'.format(int(self.duration)))
        cl_mfd.append('--fmin={:.16g}'.format(self.fmin))
        cl_mfd.append('--Band={:.16g}'.format(self.Band))
        cl_mfd.append('--Tsft={}'.format(self.Tsft))
        cl_mfd.append('--Freq={}'.format(lineFreq))
        cl_mfd.append('--phi0={}'.format(linePhi))
        cl_mfd.append('--h0={}'.format(h0))
        cl_mfd.append('--cosi={}'.format(self.cosi))
        cl_mfd.append('--lineFeature=TRUE')
        cl_mfd = " ".join(cl_mfd)
        helper_functions.run_commandline(cl_mfd, log_level=10)


class FrequencyAmplitudeModulatedArtifactWriter(FrequencyModulatedArtifactWriter):
    """ Instance object for generating SFTs containing artifacts """
    def get_h0(self, t):
558
            return self.h0*np.sin(2*np.pi*t/self.Pmod+self. Pmod_phi)