============
BeamProfiler
============
.. image:: https://img.shields.io/pypi/v/beamprofiler.svg
:target: https://pypi.python.org/pypi/beamprofiler
.. image:: https://app.travis-ci.com/wagnojunior/beamprofiler.svg?branch=main
:target: https://app.travis-ci.com/wagnojunior/beamprofiler
.. image:: https://readthedocs.org/projects/beamprofiler/badge/?version=latest
:target: https://beamprofiler.readthedocs.io/en/latest/?version=latest
:alt: Documentation Status
**BeamProfiler** is a Python package for laser beam analysis and characterization
according to ISO 13694, ISO 11145, and other non-ISO definitions commonly used
in the industry.
* Free software: GNU General Public License v3
* Documentation: https://beamprofiler.readthedocs.io.
Features
--------
**BeamProfiler** imports the power density distribution of a laser beam and
generates a `.xlsx` report with the following items:
ISO parameters:
total power, clip-level power, maximum power density, clip-level
power density, clip-level average power density, clip-level irradiation
area, beam aspect ratio, fractional power, flatness factor, beam
uniformity, plateau uniformity, edge steepness, beam centroid, beam width.
Non-ISO parameters:
clip-level beam width, clip-level edge width, modified plateau uniformity,
top-hat factor.
Auxiliary graphs
histogram, 2D heat map, 3D heat map, normalized energy curve.
Below are some illustrations:
.. figure:: docs/images/example_report.png
:width: 100 %
:alt: Beam analysis report of ISO parameters
Beam analysis report of ISO and non-ISO parameters
.. figure:: docs/images/example_histogram_2.png
:width: 50 %
:alt: Histogram
Histogram
.. figure:: docs/images/example_2d_heatmap_1.png
:width: 50 %
:alt: 2D heat map
2D heat map
.. figure:: docs/images/example_3d_heatmap_1.png
:width: 50 %
:alt: 3D heat map
3D heat map
.. figure:: docs/images/example_energy_curve.png
:width: 50 %
:alt: Normalized energy curve
Normalized energy curve
Credits
-------
This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
=======
History
=======
Version 1
---------
* 1.2.0 (2023.03.13)
- New features:
+ Reference rectangle on 2D, 3D heat maps (issue #7): add a reference rectangle of any size and position to the 2D, 3D heat maps
+ Test for auxiliary graphs: check whether the graphs are generated
- Documentation
+ Added new feature
* 1.1.0 (2022.09.16)
- New features:
+ User-defined file format for auxiliary graphs (issue #5): save the auxiliary graphs using any format
- Documentation
+ Added new feature
+ Improved clarity
+ Corrected typos
* 1.0.1 (2022.09.02)
- Bug fixes
+ Removed unecessary imports
+ Corrected Travis CI address
+ Fixed truncated output file name (issue #3)
- Documentation
+ Fixed typos
* 1.0.0 (2022.08.15)
- First release on PyPI.
Version 0
---------
* 0.1.3 (2022-08-01)
- Fourth pre-release on PyPI
* 0.1.2 (2022-08-01)
- Third pre-release on PyPI
* 0.1.1 (2022-07-31)
- Second pre-release on PyPI
* 0.1.0 (2022-07-28)
- First pre-release on PyPI
Raw data
{
"_id": null,
"home_page": "https://github.com/wagnojunior/beamprofiler",
"name": "beamprofiler",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "beamprofiler",
"author": "Wagno Alves Braganca Jr.",
"author_email": "wagnojunior@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/3b/ee/30a7437fbfbf74d41adde666c998cfa198b0e27a13cc73187e424c1f8430/beamprofiler-1.2.0.tar.gz",
"platform": null,
"description": "============\nBeamProfiler\n============\n\n\n.. image:: https://img.shields.io/pypi/v/beamprofiler.svg\n :target: https://pypi.python.org/pypi/beamprofiler\n\n.. image:: https://app.travis-ci.com/wagnojunior/beamprofiler.svg?branch=main\n :target: https://app.travis-ci.com/wagnojunior/beamprofiler\n\n.. image:: https://readthedocs.org/projects/beamprofiler/badge/?version=latest\n :target: https://beamprofiler.readthedocs.io/en/latest/?version=latest\n :alt: Documentation Status\n\n\n**BeamProfiler** is a Python package for laser beam analysis and characterization\naccording to ISO 13694, ISO 11145, and other non-ISO definitions commonly used\nin the industry.\n\n\n* Free software: GNU General Public License v3\n* Documentation: https://beamprofiler.readthedocs.io.\n\n\nFeatures\n--------\n\n**BeamProfiler** imports the power density distribution of a laser beam and\ngenerates a `.xlsx` report with the following items:\n\n\nISO parameters:\n total power, clip-level power, maximum power density, clip-level\n power density, clip-level average power density, clip-level irradiation\n area, beam aspect ratio, fractional power, flatness factor, beam\n uniformity, plateau uniformity, edge steepness, beam centroid, beam width.\n\n\nNon-ISO parameters:\n clip-level beam width, clip-level edge width, modified plateau uniformity,\n top-hat factor.\n \nAuxiliary graphs\n histogram, 2D heat map, 3D heat map, normalized energy curve.\n \n\nBelow are some illustrations:\n\n.. figure:: docs/images/example_report.png\n :width: 100 %\n :alt: Beam analysis report of ISO parameters\n \n Beam analysis report of ISO and non-ISO parameters\n \n\n.. figure:: docs/images/example_histogram_2.png\n :width: 50 %\n :alt: Histogram\n \n Histogram \n\n\n.. figure:: docs/images/example_2d_heatmap_1.png\n :width: 50 %\n :alt: 2D heat map\n \n 2D heat map\n \n \n.. figure:: docs/images/example_3d_heatmap_1.png\n :width: 50 %\n :alt: 3D heat map\n \n 3D heat map \n\n \n.. figure:: docs/images/example_energy_curve.png\n :width: 50 %\n :alt: Normalized energy curve\n \n Normalized energy curve\n\n\nCredits\n-------\n\nThis package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.\n\n.. _Cookiecutter: https://github.com/audreyr/cookiecutter\n.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage\n\n\n=======\nHistory\n=======\n\nVersion 1\n---------\n\n* 1.2.0 (2023.03.13)\n\n - New features:\n + Reference rectangle on 2D, 3D heat maps (issue #7): add a reference rectangle of any size and position to the 2D, 3D heat maps\n + Test for auxiliary graphs: check whether the graphs are generated\n\n - Documentation\n + Added new feature\n\n\n* 1.1.0 (2022.09.16)\n - New features:\n + User-defined file format for auxiliary graphs (issue #5): save the auxiliary graphs using any format\n\n - Documentation\n + Added new feature\n + Improved clarity\n + Corrected typos\n\n\n* 1.0.1 (2022.09.02)\n - Bug fixes\n + Removed unecessary imports \n + Corrected Travis CI address\n + Fixed truncated output file name (issue #3)\n\n - Documentation\n + Fixed typos\n\n* 1.0.0 (2022.08.15)\n - First release on PyPI.\n\t \nVersion 0\n---------\n\n* 0.1.3 (2022-08-01)\n\n - Fourth pre-release on PyPI\n\n* 0.1.2 (2022-08-01)\n\n - Third pre-release on PyPI\n\n* 0.1.1 (2022-07-31)\n\n - Second pre-release on PyPI\n\n* 0.1.0 (2022-07-28)\n\n - First pre-release on PyPI\n\n",
"bugtrack_url": null,
"license": "GNU General Public License v3",
"summary": "BeamProfiler is a Python package for laser beam analysis and characterization according to ISO 13694, ISO 11145, and other non-ISO definitions commonly used in the industry.",
"version": "1.2.0",
"split_keywords": [
"beamprofiler"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f79ea6ce6e377803e49e82d7b8838745cafa34ab706cf857246264c985a2dce8",
"md5": "1826c85d2273b6bc49c94667c53fab68",
"sha256": "e9a4ef3c18c4c87bbf220789d210c078993f8d144db0ee107d883720e36379da"
},
"downloads": -1,
"filename": "beamprofiler-1.2.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "1826c85d2273b6bc49c94667c53fab68",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.6",
"size": 22761,
"upload_time": "2023-03-13T04:43:03",
"upload_time_iso_8601": "2023-03-13T04:43:03.417826Z",
"url": "https://files.pythonhosted.org/packages/f7/9e/a6ce6e377803e49e82d7b8838745cafa34ab706cf857246264c985a2dce8/beamprofiler-1.2.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3bee30a7437fbfbf74d41adde666c998cfa198b0e27a13cc73187e424c1f8430",
"md5": "6e26a937f8e381cb9ce4cc8d7a986f5d",
"sha256": "04d871e628a227693a3848b52086b9c0e7f21f9847421a6c926094901a607043"
},
"downloads": -1,
"filename": "beamprofiler-1.2.0.tar.gz",
"has_sig": false,
"md5_digest": "6e26a937f8e381cb9ce4cc8d7a986f5d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 1921083,
"upload_time": "2023-03-13T04:43:06",
"upload_time_iso_8601": "2023-03-13T04:43:06.858963Z",
"url": "https://files.pythonhosted.org/packages/3b/ee/30a7437fbfbf74d41adde666c998cfa198b0e27a13cc73187e424c1f8430/beamprofiler-1.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-13 04:43:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "wagnojunior",
"github_project": "beamprofiler",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"requirements": [],
"tox": true,
"lcname": "beamprofiler"
}
JSON
