# Burst waveform
This package hosts the python version of the burst waveform used in coherentWaveBurst(cWB) search.
## Installation from source
```bash
make install
```
## Usage
The `Burst-Waveform` package provides four burst waveform models: `SineGaussian`, `SineGaussianQ`, `WhiteNoiseBurst`,
and `Ringdown`.
The waveforms can be generated by calling the instance of the waveform model after initializing it with the desired
parameters.
For example, to generate a `SineGaussianQ` waveform,
```python
from burst_waveform.models import SineGaussianQ
from matplotlib import pyplot as plt
params = {
"amplitude": 1.0,
"frequency": 300.0,
"Q": 9
}
model = SineGaussianQ(params)
strain = model()
plt.plot(strain)
plt.show()
```
For `WhiteNoiseBurst` waveform,
```python
from burst_waveform.models import WhiteNoiseBurst
import matplotlib.pyplot as plt
params = {
'frequency': 300,
'bandwidth': 50,
'duration': 0.005,
'inj_length': 1,
'mode': 1
}
WNB = WhiteNoiseBurst(params)
wnb_strain = WNB()
plt.plot(wnb_strain)
plt.xlim(0.5 - 10 * params['duration'], 0.5 + 10 * params['duration'])
plt.show()
```
For `Ringdown` waveform,
```python
from burst_waveform.models import Ringdown
from matplotlib import pyplot as plt
params = {
"tau": 0.3,
"frequency": 10.0,
"iota": 90.0,
}
model = Ringdown(params)
hp, hc = model()
plt.plot(hp)
plt.plot(hc)
plt.show()
```
Raw data
{
"_id": null,
"home_page": "https://git.ligo.org/yumeng.xu/setup.py",
"name": "burst-waveform",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "ligo, sine-gaussian, white noise burst, gravitational waves, burst, waveform model",
"author": "Yumeng Xu",
"author_email": "The PycWB team <yumeng.xu@ligo.org>",
"download_url": "https://files.pythonhosted.org/packages/9d/4f/8b33c3d28f58f08f0a213111985e39e0427725efb46c8af75103a42d6002/burst_waveform-0.3.0.tar.gz",
"platform": null,
"description": "# Burst waveform\n\nThis package hosts the python version of the burst waveform used in coherentWaveBurst(cWB) search.\n\n## Installation from source\n\n```bash\nmake install\n```\n\n## Usage\n\nThe `Burst-Waveform` package provides four burst waveform models: `SineGaussian`, `SineGaussianQ`, `WhiteNoiseBurst`,\nand `Ringdown`. \n\nThe waveforms can be generated by calling the instance of the waveform model after initializing it with the desired\nparameters.\n\nFor example, to generate a `SineGaussianQ` waveform,\n\n```python\nfrom burst_waveform.models import SineGaussianQ\nfrom matplotlib import pyplot as plt\n\nparams = {\n \"amplitude\": 1.0,\n \"frequency\": 300.0,\n \"Q\": 9\n}\n\nmodel = SineGaussianQ(params)\nstrain = model()\n\nplt.plot(strain)\nplt.show()\n```\n\nFor `WhiteNoiseBurst` waveform,\n\n```python\nfrom burst_waveform.models import WhiteNoiseBurst\nimport matplotlib.pyplot as plt\n\nparams = {\n 'frequency': 300,\n 'bandwidth': 50,\n 'duration': 0.005,\n 'inj_length': 1,\n 'mode': 1\n}\n\nWNB = WhiteNoiseBurst(params)\nwnb_strain = WNB()\n\nplt.plot(wnb_strain)\nplt.xlim(0.5 - 10 * params['duration'], 0.5 + 10 * params['duration'])\nplt.show()\n```\n\nFor `Ringdown` waveform,\n\n```python\nfrom burst_waveform.models import Ringdown\nfrom matplotlib import pyplot as plt\n\nparams = {\n \"tau\": 0.3,\n \"frequency\": 10.0,\n \"iota\": 90.0,\n}\n\nmodel = Ringdown(params)\nhp, hc = model()\n\nplt.plot(hp)\nplt.plot(hc)\nplt.show()\n```\n",
"bugtrack_url": null,
"license": null,
"summary": "A Python package for gravitational wave burst waveform",
"version": "0.3.0",
"project_urls": {
"Homepage": "https://git.ligo.org/yumeng.xu/setup.py"
},
"split_keywords": [
"ligo",
" sine-gaussian",
" white noise burst",
" gravitational waves",
" burst",
" waveform model"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9d4f8b33c3d28f58f08f0a213111985e39e0427725efb46c8af75103a42d6002",
"md5": "8baa84bbeedbb66b6f1cd4d0a5d83af9",
"sha256": "7793ada1cd3e6a70c683c91656e8fd0201eccdf38d95dd93ab1b3c90b95e453d"
},
"downloads": -1,
"filename": "burst_waveform-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "8baa84bbeedbb66b6f1cd4d0a5d83af9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 157099,
"upload_time": "2024-07-11T13:15:52",
"upload_time_iso_8601": "2024-07-11T13:15:52.878703Z",
"url": "https://files.pythonhosted.org/packages/9d/4f/8b33c3d28f58f08f0a213111985e39e0427725efb46c8af75103a42d6002/burst_waveform-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-11 13:15:52",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "burst-waveform"
}
JSON