Adds TimeDomainCBCWaveformGenerator

[EthanMarx]

Moves the WaveformGenerator from amplfi, and adds conditioning of waveform before transforming into the time domain. The conditioning mimics that done in lalsimulation: https://git.ligo.org/lscsoft/lalsuite/-/blob/master/lalsimulation/python/lalsimulation/gwsignal/core/waveform_conditioning.py?ref_type=heads#L248

One thing we are still missing that lalsimulation does is a butterworth highpass. I haven't seen a straightforward torch api for this so we may have to implement it ourselves. I've compared our outputs using a scipy butterworth and they are very close to identical.

I will also test out how the highpass that occurs during our whitening step compares between the ml4gw waveforms and lalsimulation.

[EthanMarx]

@deepchatterjeeligo will write some tests where I compare against lalsimulation.SimInspiralTD. The only caveat is I'll have to use scipy.butterworth to filter our waveforms in the tests since we don't yet have a torch based highpass.

[EthanMarx]

@deepchatterjeeligo @wbenoit26 could you take a look at this?

I'll post some plots comparing conditioned vs unconditioned waveforms

[EthanMarx]

Also, tested out Ravis highpass filter and was able to match scipys. So, will directly incorporate that into the Generator once it gets merged in

[EthanMarx]

@wbenoit26 @deepchatterjeeligo this should be ready to go.

I did some minor refactoring and added some documentation so might be worth looking over again.

One thing to note is that there is an off by one error when trying to align the ml4gw waveforms with the gwsignal waveforms that is parameter dependent. I have a quirky work around in the tests that compares the waveforms unshifted, and shifted by one, and asserts True if either is within tolerance.

This obviously should be ironed out down the line, but I don't think this is a huge problem.

[wbenoit26]

Looks good to me, just a couple minor nitpicks

[github-actions]

Coverage report

Click to see where and how coverage changed

File	Statements	Missing	Coverage	Coverage (new stmts)	Lines missing
ml4gw
__init__.py
distributions.py
ml4gw/dataloading
hdf5_dataset.py
ml4gw/transforms
__init__.py
ml4gw/waveforms
generator.py					77, 86, 90
ml4gw/waveforms/cbc
coefficients.py
utils.py
Project Total

This report was generated by python-coverage-comment-action