Loading docs/index.rst +2 −0 Original line number Diff line number Diff line Loading @@ -52,8 +52,10 @@ User Guide installation usage ringdowns numerical Developer Guide =============== Loading docs/ringdowns.rst 0 → 100644 +25 −0 Original line number Diff line number Diff line Ringdown Waveforms ================== Minke is capable of producing signals which are based on waveforms based on Binary Black Hole (BBH) ringdowns. BBHRingdown -------------- The BBH Ringdown class in the sources module follows a similar style to other source classes within `minke`. To produce a single ringdown waveform: >>> import minke.sources >>> bbh = minke.sources.BBHRingdown(100.23, 1e-22, np.rad2deg(.1), 10., 0.97, 0.01, 1.0,45.) then the waveforms themselves can be produced by running >>> hp, hx, _, _ = bbh._generate() The waveform will be generated at the LIGO sampling rate (16384 Hz) by default, but this can be changed by specifying a `rate` keyword. The waveforms are also generated for the (2,2) mode by default, but by adding `l` and `m` keywords to the `_generate()` method this can also be changed. Loading
docs/index.rst +2 −0 Original line number Diff line number Diff line Loading @@ -52,8 +52,10 @@ User Guide installation usage ringdowns numerical Developer Guide =============== Loading
docs/ringdowns.rst 0 → 100644 +25 −0 Original line number Diff line number Diff line Ringdown Waveforms ================== Minke is capable of producing signals which are based on waveforms based on Binary Black Hole (BBH) ringdowns. BBHRingdown -------------- The BBH Ringdown class in the sources module follows a similar style to other source classes within `minke`. To produce a single ringdown waveform: >>> import minke.sources >>> bbh = minke.sources.BBHRingdown(100.23, 1e-22, np.rad2deg(.1), 10., 0.97, 0.01, 1.0,45.) then the waveforms themselves can be produced by running >>> hp, hx, _, _ = bbh._generate() The waveform will be generated at the LIGO sampling rate (16384 Hz) by default, but this can be changed by specifying a `rate` keyword. The waveforms are also generated for the (2,2) mode by default, but by adding `l` and `m` keywords to the `_generate()` method this can also be changed.
