| Name | tw-source-finder JSON |
| Version |
1.0.0
JSON |
| download |
| home_page | |
| Summary | super-fast source finder routine using polygon based approach |
| upload_time | 2022-12-07 14:30:44 |
| maintainer | Tony Willis |
| docs_url | None |
| author | Tony Willis |
| requires_python | >=3.8,<4.0 |
| license | MIT |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
tw-source-finder
================
[](https://tw-source-finder.readthedocs.io/en/latest/?badge=latest)
This package leverages a parallelization boiler-plate code to provide a super fast source finder routine which deletes background sources using a polygon based approach.
Watch the video on [YouTube](https://www.youtube.com/watch?v=cO5TYy396xU) for detailed instructions on how to use the data analysis scripts. Hopefully, it will not put you to sleep! More detailed written instructions may follow.
Features
--------
There are two main scripts in the package, viz: `get_morphology_images` and `get_galaxy_parameters`.
**get_morphology_images**
Uses morphological erosion and dilation to remove background sources from a radio astronomy image. It extends the technique described in [Rudnick, 2002](https://iopscience.iop.org/article/10.1086/342499/pdf).
The process can be described through the following equations:
```
o = original image
d = output from erosion/dilation
t = white TopHat, which should show only 'compact' structures
t = o - d
m = mask derived from a comparison where t > some signal m * t = m * (o - d)
o_d = output diffuse image
=o - m * t
=o - (m * o - m * d)
=o - m * o + (m * d)
m*d would add the masked dilated image to the 'diffuse' image and we do not want to do that so we ignore it to get
o_d = o - m * o and
o_c = image of compact objects = m * o
so the original image equates to o_d + o_c
```
We may want to judiciously add selected components of `o_c` to `o_d` to get a final `o*`. We select the components of `o_c` we wish to add by masking their defining polygons to get a mask `m_c`
$$o* = o_d + m_c * o_c$$
**get_galaxy_parameters**
Integrates the signal contained within specified polygon areas of a radio astronomy image to derive integrated flux densities and other parameters of a radio source.
Requirements
------------
The code has been tested with python 3.8 on Ubuntu 20.04. See `pyproject.toml` or `requirements.txt` for package dependencies.
Installation
------------
Install from source
```bash
$ pip install .
```
Use the routine
```bash
$ tw-source-list -f xyz.fits -t 6.5
```
Raw data
{
"_id": null,
"home_page": "",
"name": "tw-source-finder",
"maintainer": "Tony Willis",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "tony.willis.research@gmail.com",
"keywords": "",
"author": "Tony Willis",
"author_email": "tony.willis.research@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/14/08/a44993793f1bac6d639e2c8467072ed91ec0f6b817a0fbf204f89e9a0510/tw_source_finder-1.0.0.tar.gz",
"platform": null,
"description": "tw-source-finder\n================\n\n[](https://tw-source-finder.readthedocs.io/en/latest/?badge=latest)\n\nThis package leverages a parallelization boiler-plate code to provide a super fast source finder routine which deletes background sources using a polygon based approach.\n\nWatch the video on [YouTube](https://www.youtube.com/watch?v=cO5TYy396xU) for detailed instructions on how to use the data analysis scripts. Hopefully, it will not put you to sleep! More detailed written instructions may follow.\n\nFeatures\n--------\nThere are two main scripts in the package, viz: `get_morphology_images` and `get_galaxy_parameters`.\n\n**get_morphology_images**\n\nUses morphological erosion and dilation to remove background sources from a radio astronomy image. It extends the technique described in [Rudnick, 2002](https://iopscience.iop.org/article/10.1086/342499/pdf).\n\nThe process can be described through the following equations:\n\n```\no = original image\n\nd = output from erosion/dilation\n\nt = white TopHat, which should show only 'compact' structures\n\nt = o - d\n\nm = mask derived from a comparison where t > some signal m * t = m * (o - d)\n\no_d = output diffuse image\n\n=o - m * t\n\n=o - (m * o - m * d)\n\n=o - m * o + (m * d)\n\nm*d would add the masked dilated image to the 'diffuse' image and we do not want to do that so we ignore it to get\n\no_d = o - m * o and\n\no_c = image of compact objects = m * o\n\nso the original image equates to o_d + o_c\n```\n\nWe may want to judiciously add selected components of `o_c` to `o_d` to get a final `o*`. We select the components of `o_c` we wish to add by masking their defining polygons to get a mask `m_c`\n\n$$o* = o_d + m_c * o_c$$\n\n**get_galaxy_parameters**\n\nIntegrates the signal contained within specified polygon areas of a radio astronomy image to derive integrated flux densities and other parameters of a radio source.\n\n\nRequirements\n------------\n\nThe code has been tested with python 3.8 on Ubuntu 20.04. See `pyproject.toml` or `requirements.txt` for package dependencies.\n\nInstallation\n------------\n\nInstall from source\n\n```bash\n$ pip install .\n```\n\nUse the routine\n\n```bash\n$ tw-source-list -f xyz.fits -t 6.5\n```\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "super-fast source finder routine using polygon based approach",
"version": "1.0.0",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "6759fd730652368ac346d45986718595",
"sha256": "b01c0fada7bb71332ed007272ae4f0ace50ec191c9c5f38c6dfaec69e2df4186"
},
"downloads": -1,
"filename": "tw_source_finder-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6759fd730652368ac346d45986718595",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 56758,
"upload_time": "2022-12-07T14:30:41",
"upload_time_iso_8601": "2022-12-07T14:30:41.892455Z",
"url": "https://files.pythonhosted.org/packages/bc/c3/e71d780a3ea60dce65fd9709dcda729bde320b5968e2ed3b049e37915bf8/tw_source_finder-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "ebb2de1ad92ac5623f86d986f9fda3c3",
"sha256": "3052c83d5cb80493509b557a49164eccd9fe0127deefbb9ae956fbb36c774fa1"
},
"downloads": -1,
"filename": "tw_source_finder-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "ebb2de1ad92ac5623f86d986f9fda3c3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 45220,
"upload_time": "2022-12-07T14:30:44",
"upload_time_iso_8601": "2022-12-07T14:30:44.252324Z",
"url": "https://files.pythonhosted.org/packages/14/08/a44993793f1bac6d639e2c8467072ed91ec0f6b817a0fbf204f89e9a0510/tw_source_finder-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-07 14:30:44",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "tw-source-finder"
}
