| Name | micropolarray JSON |
| Version |
1.2.9
JSON |
| download |
| home_page | https://github.com/Hevil33/micropolarray_master |
| Summary | micropolarizer array data utilities |
| upload_time | 2024-02-08 09:50:18 |
| maintainer | |
| docs_url | None |
| author | Hervé Haudemand |
| requires_python | >=3.8 |
| license | BSD 3-Clause License Copyright (c) 2023, Hevil33 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
micropolarizer
polarcam
polarization
astronomy
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# micropolarray
Python open-source module for loading and using micropolarizer array and PolarCam images.
## Installation
Run one of the following commands in your terminal:
```
pip install micropolarray
```
OR
```
pip install git+https://github.com/Hevil33/micropolarray_master
```
If an error message about wheels appear, launch it again.
You can run the `test.py` script to verify the correct installation of the micopolarray package.
## Features
- Automatic polarization calculation
- Fast and optimized operations on the micropolarizer array
- Basic image cleaning (dark/flat subtraction)
## Documentation
Documentation is hosted at ReadTheDocs and can be found [HERE](https://micropolarray.readthedocs.io/en/latest/) (html format).
## Usage
Get the simple [jupyter tutorial](https://github.com/Hevil33/micropolarray_master/blob/main/TUTORIAL.ipynb) for a brief introduction.
After installation, you can import the library in your python application
```
import micropolarray as ml
```
The main class is `MicropolImage()`, which can be initialized from
1. A `numpy` 2D array
2. A list of .fits filenames
3. Another `MicropolImage()`
Some useful member functions are :
MicropolImage()
- .show()
- .show_with_pol_params()
- .rebin()
- .demosaic()
Information on polarization is automatically calculated and stored in the class members as `numpy` arrays
MicropolImage()
- .data
- single_pol_subimages
- .Stokes_vec
- .I.data
- .Q.data
- .U.data
- pB.data (polarized brightness)
- AoLP.data (angle of linear polarization)
- DoLP.data (degree of linear polarization)
## Additional modules
micropolarray:
- .processing
- .congrid (_experimental_) : fast congrid operations
- .convert : raw (binary) files to fits conversion
- .new_demodulation : image demodulation and demodulation tensor calculation
- .demosaic : fast image demosaicing
- .nrgf : occulter finding and roi selection, nrgf filter
- .rebin : fast image binning
- .shift : image shifting
- .cameras (_experimental_) : classes for sensor informations
- .image : general image handling
- .utils
Raw data
{
"_id": null,
"home_page": "https://github.com/Hevil33/micropolarray_master",
"name": "micropolarray",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "micropolarizer,polarcam,polarization,astronomy",
"author": "Herv\u00e9 Haudemand",
"author_email": "Herve Haudemand <herve.haudemand@inaf.it>",
"download_url": "https://files.pythonhosted.org/packages/af/4a/c49cc1f874abe1aea6bea5e3e22a73db335d1641cce5323ebfa47405af90/micropolarray-1.2.9.tar.gz",
"platform": null,
"description": "# micropolarray\n\nPython open-source module for loading and using micropolarizer array and PolarCam images.\n\n\n## Installation \n\nRun one of the following commands in your terminal:\n\n```\npip install micropolarray\n```\n\nOR\n\n```\npip install git+https://github.com/Hevil33/micropolarray_master\n```\n\nIf an error message about wheels appear, launch it again.\nYou can run the `test.py` script to verify the correct installation of the micopolarray package.\n\n## Features\n\n- Automatic polarization calculation\n- Fast and optimized operations on the micropolarizer array\n- Basic image cleaning (dark/flat subtraction)\n\n\n## Documentation\n\nDocumentation is hosted at ReadTheDocs and can be found [HERE](https://micropolarray.readthedocs.io/en/latest/) (html format).\n\n\n## Usage\n\nGet the simple [jupyter tutorial](https://github.com/Hevil33/micropolarray_master/blob/main/TUTORIAL.ipynb) for a brief introduction.\n\nAfter installation, you can import the library in your python application\n\n```\nimport micropolarray as ml\n```\n\nThe main class is `MicropolImage()`, which can be initialized from\n\n1. A `numpy` 2D array \n2. A list of .fits filenames\n3. Another `MicropolImage()`\n\n\nSome useful member functions are :\n\nMicropolImage()\n- .show()\n- .show_with_pol_params()\n- .rebin()\n- .demosaic()\n\nInformation on polarization is automatically calculated and stored in the class members as `numpy` arrays\n\nMicropolImage()\n- .data\n- single_pol_subimages\n- .Stokes_vec\n- .I.data\n- .Q.data\n- .U.data\n- pB.data (polarized brightness)\n- AoLP.data (angle of linear polarization)\n- DoLP.data (degree of linear polarization)\n\n\n## Additional modules\n\nmicropolarray:\n\n- .processing\n - .congrid (_experimental_) : fast congrid operations\n - .convert : raw (binary) files to fits conversion\n - .new_demodulation : image demodulation and demodulation tensor calculation\n - .demosaic : fast image demosaicing\n - .nrgf : occulter finding and roi selection, nrgf filter\n - .rebin : fast image binning\n - .shift : image shifting\n- .cameras (_experimental_) : classes for sensor informations\n- .image : general image handling\n- .utils \n",
"bugtrack_url": null,
"license": "BSD 3-Clause License Copyright (c) 2023, Hevil33 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ",
"summary": "micropolarizer array data utilities",
"version": "1.2.9",
"project_urls": {
"Documentation": "https://micropolarray.readthedocs.io/en/latest/",
"Homepage": "https://github.com/Hevil33/micropolarray_master",
"Source code": "https://github.com/Hevil33/micropolarray_master"
},
"split_keywords": [
"micropolarizer",
"polarcam",
"polarization",
"astronomy"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8b19ea9ac2c3f7b4f83e4ed8805ce4ca6ce8f72a10b54b804b8137b3dd1fe9da",
"md5": "3b1b17fbcd7d447530541f35399eb38c",
"sha256": "d9d8f08a4f8e1d2748ecf99c93879828ebd5b8a97bbde89252028c0014fdafce"
},
"downloads": -1,
"filename": "micropolarray-1.2.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3b1b17fbcd7d447530541f35399eb38c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 50024,
"upload_time": "2024-02-08T09:50:16",
"upload_time_iso_8601": "2024-02-08T09:50:16.558487Z",
"url": "https://files.pythonhosted.org/packages/8b/19/ea9ac2c3f7b4f83e4ed8805ce4ca6ce8f72a10b54b804b8137b3dd1fe9da/micropolarray-1.2.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "af4ac49cc1f874abe1aea6bea5e3e22a73db335d1641cce5323ebfa47405af90",
"md5": "2fe9810c8a25a57b3b514eed236c500a",
"sha256": "9be98072d9fde9d982e0ad7c8793dcf2df6951c5fef63ec0918bbe68fdd236b0"
},
"downloads": -1,
"filename": "micropolarray-1.2.9.tar.gz",
"has_sig": false,
"md5_digest": "2fe9810c8a25a57b3b514eed236c500a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 48640,
"upload_time": "2024-02-08T09:50:18",
"upload_time_iso_8601": "2024-02-08T09:50:18.737273Z",
"url": "https://files.pythonhosted.org/packages/af/4a/c49cc1f874abe1aea6bea5e3e22a73db335d1641cce5323ebfa47405af90/micropolarray-1.2.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-08 09:50:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Hevil33",
"github_project": "micropolarray_master",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "micropolarray"
}
