=========
breizorro
=========
|Pypi Version|
|Python Versions|
|Project License|
A tool for creating a binary mask given a FITS image
==============
Installation
==============
Installation from source_,
working directory where source is checked out
.. code-block:: bash
$ pip install .
This package is available on *PYPI*, allowing
.. code-block:: bash
$ pip install breizorro
To show help message and exit
.. code-block:: bash
$ breizorro --help
breizorro.breizorro - 2022-08-24 11:07:39,311 INFO - Welcome to breizorro
breizorro.breizorro - 2022-08-24 11:07:39,375 INFO - Version: 0.1.1
breizorro.breizorro - 2022-08-24 11:07:39,375 INFO - Usage: breizorro --help
usage: breizorro [-h] [-r IMAGE] [-m MASK] [-t THRESHOLD] [-b BOXSIZE]
[--savenoise] [--merge MASKs|REGs) [MASK(s|REGs) ...]]
[--subtract MASK(s|REGs) [MASK(s|REGs ...]]
[--number-islands] [--remove-islands N|COORD [N|COORD ...]]
[--ignore-missing-islands]
[--extract-islands N|COORD [N|COORD ...]]
[--minimum-size MINSIZE] [--make-binary] [--invert]
[--dilate R] [--erode N] [--fill-holes] [--sum-peak SUM_PEAK]
[-o OUTFILE] [--gui]
breizorro [options] --restored-image restored_image
optional arguments:
-h, --help show this help message and exit
-r IMAGE, --restored-image IMAGE
Restored image file from which to build mask
-m MASK, --mask-image MASK
Input mask file(s). Either --restored-image or --mask-
image must be specfied.
-t THRESHOLD, --threshold THRESHOLD
Sigma threshold for masking (default = 6.5)
-b BOXSIZE, --boxsize BOXSIZE
Box size over which to compute stats (default = 50)
--savenoise Enable to export noise image as FITS file (default=do
not save noise image)
--merge MASK(s)|REG(s) [MASK(s)|REG(s) ...]
Merge in one or more masks or region files
--subtract MASK(s)|REG(s) [MASK(s)|REG(s) ...]
Subract one or more masks or region files
--number-islands Number the islands detected (default=do not number
islands)
--remove-islands N|COORD [N|COORD ...]
List of islands to remove from input mask. e.g.
--remove-islands 1 18 20 20h10m13s,14d15m20s
--ignore-missing-islands
If an island specified by coordinates does not exist,
do not throw an error
--extract-islands N|COORD [N|COORD ...]
List of islands to extract from input mask. e.g.
--extract-islands 1 18 20 20h10m13s,14d15m20s
--minimum-size MINSIZE
Remove islands that have areas fewer than or equal to
the specified number of pixels
--make-binary Replace all island numbers with 1
--invert Invert the mask
--dilate R Apply dilation with a radius of R pixels
--erode N Apply N iterations of erosion
--fill-holes Fill holes (i.e. entirely closed regions) in mask
--sum-peak SUM_PEAK Sum to peak ratio of flux islands to mask in original
image.e.g. --sum-peak 100 will mask everything with a
ratio above 100
-o OUTFILE, --outfile OUTFILE
Suffix for mask image (default based on input name
--gui Open mask in gui.
=======
License
=======
This project is licensed under the GNU General Public License v3.0 - see license_ for details.
=============
Contribute
=============
Contributions are always welcome! Please ensure that you adhere to our coding
standards pep8_.
.. |Project License| image:: https://img.shields.io/badge/license-GPL-blue.svg
:target: https://github.com/ratt-ru/breizorro/blob/main/LICENSE
:alt:
.. |Python Versions| image:: https://img.shields.io/pypi/pyversions/breizorro.svg
:target: https://pypi.python.org/pypi/breizorro/
:alt:
.. |Pypi Version| image:: https://img.shields.io/pypi/v/breizorro.svg
:target: https://pypi.python.org/pypi/breizorro
:alt:
.. _source: https://github.com/ratt-ru/breizorro
.. _license: https://github.com/ratt-ru/breizorro/blob/main/LICENSE
.. _pep8: https://www.python.org/dev/peps/pep-0008
Raw data
{
"_id": null,
"home_page": "https://github.com/ratt-ru/breizorro",
"name": "breizorro",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "Astronomy,Masking,Imaging",
"author": "Ian Heywood & RATT",
"author_email": "ian.heywood@phyics.ox.ac.uk",
"download_url": "https://files.pythonhosted.org/packages/fa/c9/81b7f65ca83625c04d7c1e8f61630f1881fdb339a137956da137aeac5909/breizorro-0.1.2.tar.gz",
"platform": null,
"description": "=========\nbreizorro\n=========\n|Pypi Version|\n|Python Versions|\n|Project License|\n\nA tool for creating a binary mask given a FITS image\n\n==============\nInstallation\n==============\n\nInstallation from source_,\nworking directory where source is checked out\n\n.. code-block:: bash\n \n $ pip install .\n\nThis package is available on *PYPI*, allowing\n\n.. code-block:: bash\n \n $ pip install breizorro\n\nTo show help message and exit\n\n.. code-block:: bash\n \n $ breizorro --help\n\n breizorro.breizorro - 2022-08-24 11:07:39,311 INFO - Welcome to breizorro\n breizorro.breizorro - 2022-08-24 11:07:39,375 INFO - Version: 0.1.1\n breizorro.breizorro - 2022-08-24 11:07:39,375 INFO - Usage: breizorro --help\n usage: breizorro [-h] [-r IMAGE] [-m MASK] [-t THRESHOLD] [-b BOXSIZE]\n [--savenoise] [--merge MASKs|REGs) [MASK(s|REGs) ...]]\n [--subtract MASK(s|REGs) [MASK(s|REGs ...]]\n [--number-islands] [--remove-islands N|COORD [N|COORD ...]]\n [--ignore-missing-islands]\n [--extract-islands N|COORD [N|COORD ...]]\n [--minimum-size MINSIZE] [--make-binary] [--invert]\n [--dilate R] [--erode N] [--fill-holes] [--sum-peak SUM_PEAK]\n [-o OUTFILE] [--gui]\n\n breizorro [options] --restored-image restored_image\n\n optional arguments:\n -h, --help show this help message and exit\n -r IMAGE, --restored-image IMAGE\n Restored image file from which to build mask\n -m MASK, --mask-image MASK\n Input mask file(s). Either --restored-image or --mask-\n image must be specfied.\n -t THRESHOLD, --threshold THRESHOLD\n Sigma threshold for masking (default = 6.5)\n -b BOXSIZE, --boxsize BOXSIZE\n Box size over which to compute stats (default = 50)\n --savenoise Enable to export noise image as FITS file (default=do\n not save noise image)\n --merge MASK(s)|REG(s) [MASK(s)|REG(s) ...]\n Merge in one or more masks or region files\n --subtract MASK(s)|REG(s) [MASK(s)|REG(s) ...]\n Subract one or more masks or region files\n --number-islands Number the islands detected (default=do not number\n islands)\n --remove-islands N|COORD [N|COORD ...]\n List of islands to remove from input mask. e.g.\n --remove-islands 1 18 20 20h10m13s,14d15m20s\n --ignore-missing-islands\n If an island specified by coordinates does not exist,\n do not throw an error\n --extract-islands N|COORD [N|COORD ...]\n List of islands to extract from input mask. e.g.\n --extract-islands 1 18 20 20h10m13s,14d15m20s\n --minimum-size MINSIZE\n Remove islands that have areas fewer than or equal to\n the specified number of pixels\n --make-binary Replace all island numbers with 1\n --invert Invert the mask\n --dilate R Apply dilation with a radius of R pixels\n --erode N Apply N iterations of erosion\n --fill-holes Fill holes (i.e. entirely closed regions) in mask\n --sum-peak SUM_PEAK Sum to peak ratio of flux islands to mask in original\n image.e.g. --sum-peak 100 will mask everything with a\n ratio above 100\n -o OUTFILE, --outfile OUTFILE\n Suffix for mask image (default based on input name\n --gui Open mask in gui.\n\n=======\nLicense\n=======\n\nThis project is licensed under the GNU General Public License v3.0 - see license_ for details.\n\n=============\nContribute\n=============\n\nContributions are always welcome! Please ensure that you adhere to our coding\nstandards pep8_.\n\n.. |Project License| image:: https://img.shields.io/badge/license-GPL-blue.svg\n :target: https://github.com/ratt-ru/breizorro/blob/main/LICENSE\n :alt:\n\n.. |Python Versions| image:: https://img.shields.io/pypi/pyversions/breizorro.svg\n :target: https://pypi.python.org/pypi/breizorro/\n :alt:\n\n.. |Pypi Version| image:: https://img.shields.io/pypi/v/breizorro.svg\n :target: https://pypi.python.org/pypi/breizorro\n :alt:\n\n.. _source: https://github.com/ratt-ru/breizorro\n.. _license: https://github.com/ratt-ru/breizorro/blob/main/LICENSE\n.. _pep8: https://www.python.org/dev/peps/pep-0008\n\n",
"bugtrack_url": null,
"license": "GNU GPL v3",
"summary": "Creates a binary mask given a FITS image",
"version": "0.1.2",
"project_urls": {
"Homepage": "https://github.com/ratt-ru/breizorro",
"Repository": "https://github.com/ratt-ru/breizorro.git"
},
"split_keywords": [
"astronomy",
"masking",
"imaging"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "462da4ac05a37b08f9458049a2f4449560f457a34658b9b37c677b4e81d58bea",
"md5": "d512a8e5f82bcd1a10833c757d7da16e",
"sha256": "e13ff8bbc6852ccf63cc576521207192d3982c0e89e63334b2381d9c202c6e44"
},
"downloads": -1,
"filename": "breizorro-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d512a8e5f82bcd1a10833c757d7da16e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 20415,
"upload_time": "2023-06-26T10:59:30",
"upload_time_iso_8601": "2023-06-26T10:59:30.850294Z",
"url": "https://files.pythonhosted.org/packages/46/2d/a4ac05a37b08f9458049a2f4449560f457a34658b9b37c677b4e81d58bea/breizorro-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fac981b7f65ca83625c04d7c1e8f61630f1881fdb339a137956da137aeac5909",
"md5": "337da874377f29fd78581e38ed88a9a5",
"sha256": "6d0767fe3b23b159a9d6d20c4574354d120773372a0e6f803f5b020c1aef51b3"
},
"downloads": -1,
"filename": "breizorro-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "337da874377f29fd78581e38ed88a9a5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 19278,
"upload_time": "2023-06-26T10:59:32",
"upload_time_iso_8601": "2023-06-26T10:59:32.650088Z",
"url": "https://files.pythonhosted.org/packages/fa/c9/81b7f65ca83625c04d7c1e8f61630f1881fdb339a137956da137aeac5909/breizorro-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-26 10:59:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ratt-ru",
"github_project": "breizorro",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "breizorro"
}
JSON
