pyspeckle
=========
by Scott Prahl
.. image:: https://img.shields.io/pypi/v/pyspeckle
:target: https://pypi.org/project/pyspeckle/
:alt: PyPI
.. image:: https://img.shields.io/conda/v/conda-forge/pyspeckle.svg
:target: https://anaconda.org/conda-forge/pyspeckle
:alt: Conda
.. image:: https://zenodo.org/badge/131667397.svg
:target: https://zenodo.org/badge/latestdoi/131667397
|
.. image:: https://img.shields.io/github/license/scottprahl/pyspeckle
:target: https://github.com/scottprahl/pyspeckle/blob/master/LICENSE.txt
:alt: MIT License
.. image:: https://github.com/scottprahl/miepython/actions/workflows/test.yml/badge.svg
:target: https://github.com/scottprahl/miepython/actions/workflows/test.yml
:alt: Testing
.. image:: https://readthedocs.org/projects/pyspeckle2/badge
:target: https://pyspeckle2.readthedocs.io
:alt: Read the Docs
.. image:: https://img.shields.io/pypi/dm/pyspeckle
:target: https://pypi.org/project/pyspeckle/
:alt: Number of PyPI downloads
________
A collection of routines to track and analyze laser speckle. This is a python
port of SimSpeckle Matlab routines described in::
`Duncan & Kirkpatrick, "Algorithms for simulation of speckle (laser and otherwise)," in SPIE Vol. 6855 (2008)
<https://www.researchgate.net/profile/Sean-Kirkpatrick-2/publication/233783056_Algorithms_for_simulation_of_speckle_laser_and_otherwise/links/09e4150b78c4e8fe5f000000/Algorithms-for-simulation-of-speckle-laser-and-otherwise.pdf>`_
To cite the code, then use::
Prahl, S. (2023). pyspeckle: a python module for creation and analysis of laser speckle. (Version 0.5.1) https://doi.org/10.5281/zenodo.8311678
1D speckle
----------
.. image:: https://raw.githubusercontent.com/scottprahl/pyspeckle/master/docs/oneD_example.png
:alt: 1D speckle plot
2D speckle
----------
.. image:: https://raw.githubusercontent.com/scottprahl/pyspeckle/master/docs/twoD_speckle.png
:alt: 2D speckle plot
Documentation and examples for 1D, 2D, and 3D speckle are available at <https://pyspeckle2.readthedocs.io>
Installation
-------------
Use ``pip``::
pip install pyspeckle
or use ``conda``::
conda install -c conda-forge pyspeckle
License
-------
``pyspeckle`` is licensed under the terms of the MIT license.
Raw data
{
"_id": null,
"home_page": "https://github.com/scottprahl/pyspeckle.git",
"name": "pyspeckle",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.4",
"maintainer_email": "",
"keywords": "speckle,objective,subjective,contrast,size,autocorrelation,ACF,PDF,laser",
"author": "Scott Prahl",
"author_email": "scott.prahl@oit.edu",
"download_url": "https://files.pythonhosted.org/packages/5d/83/1b87c63a9000c9fee57df4a6506a59e212bd219e9c4e195b700f198a8000/pyspeckle-0.5.1.tar.gz",
"platform": null,
"description": "pyspeckle\n=========\n\nby Scott Prahl\n\n.. image:: https://img.shields.io/pypi/v/pyspeckle\n :target: https://pypi.org/project/pyspeckle/\n :alt: PyPI\n\n.. image:: https://img.shields.io/conda/v/conda-forge/pyspeckle.svg\n :target: https://anaconda.org/conda-forge/pyspeckle\n :alt: Conda\n\n.. image:: https://zenodo.org/badge/131667397.svg\n :target: https://zenodo.org/badge/latestdoi/131667397\n \n|\n\n.. image:: https://img.shields.io/github/license/scottprahl/pyspeckle\n :target: https://github.com/scottprahl/pyspeckle/blob/master/LICENSE.txt\n :alt: MIT License\n\n.. image:: https://github.com/scottprahl/miepython/actions/workflows/test.yml/badge.svg\n :target: https://github.com/scottprahl/miepython/actions/workflows/test.yml\n :alt: Testing\n\n.. image:: https://readthedocs.org/projects/pyspeckle2/badge\n :target: https://pyspeckle2.readthedocs.io\n :alt: Read the Docs\n\n.. image:: https://img.shields.io/pypi/dm/pyspeckle\n :target: https://pypi.org/project/pyspeckle/\n :alt: Number of PyPI downloads\n\n________\n\nA collection of routines to track and analyze laser speckle. This is a python\nport of SimSpeckle Matlab routines described in::\n\n `Duncan & Kirkpatrick, \"Algorithms for simulation of speckle (laser and otherwise),\" in SPIE Vol. 6855 (2008) \n <https://www.researchgate.net/profile/Sean-Kirkpatrick-2/publication/233783056_Algorithms_for_simulation_of_speckle_laser_and_otherwise/links/09e4150b78c4e8fe5f000000/Algorithms-for-simulation-of-speckle-laser-and-otherwise.pdf>`_\n\nTo cite the code, then use::\n\n Prahl, S. (2023). pyspeckle: a python module for creation and analysis of laser speckle. (Version 0.5.1) https://doi.org/10.5281/zenodo.8311678\n\n1D speckle\n----------\n.. image:: https://raw.githubusercontent.com/scottprahl/pyspeckle/master/docs/oneD_example.png\n :alt: 1D speckle plot\n\n2D speckle\n----------\n.. image:: https://raw.githubusercontent.com/scottprahl/pyspeckle/master/docs/twoD_speckle.png\n :alt: 2D speckle plot\n\nDocumentation and examples for 1D, 2D, and 3D speckle are available at <https://pyspeckle2.readthedocs.io>\n\nInstallation\n-------------\n\nUse ``pip``::\n \n pip install pyspeckle\n\nor use ``conda``::\n \n conda install -c conda-forge pyspeckle\n\nLicense\n-------\n\n``pyspeckle`` is licensed under the terms of the MIT license.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Routines for analysis of laser speckle",
"version": "0.5.1",
"project_urls": {
"Homepage": "https://github.com/scottprahl/pyspeckle.git"
},
"split_keywords": [
"speckle",
"objective",
"subjective",
"contrast",
"size",
"autocorrelation",
"acf",
"pdf",
"laser"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cd14780fe649ef4a3882bf8293f27eb1b61eec19e6ca9fe97e857339b2720bf9",
"md5": "969f9a094fd6da70ea3177409efc85fc",
"sha256": "b67c28c6228adb634ebcf015e3289bc705a7e761ff1fbc98f3a5d4771117a7f4"
},
"downloads": -1,
"filename": "pyspeckle-0.5.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "969f9a094fd6da70ea3177409efc85fc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.4",
"size": 9515,
"upload_time": "2023-09-02T22:59:03",
"upload_time_iso_8601": "2023-09-02T22:59:03.311894Z",
"url": "https://files.pythonhosted.org/packages/cd/14/780fe649ef4a3882bf8293f27eb1b61eec19e6ca9fe97e857339b2720bf9/pyspeckle-0.5.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5d831b87c63a9000c9fee57df4a6506a59e212bd219e9c4e195b700f198a8000",
"md5": "fff4a7a8edfaf6fd0ccdee0ea6d2b05d",
"sha256": "a9a34cede35e1496720389fe65f12a91593126a7fe25099112691fb769fb6533"
},
"downloads": -1,
"filename": "pyspeckle-0.5.1.tar.gz",
"has_sig": false,
"md5_digest": "fff4a7a8edfaf6fd0ccdee0ea6d2b05d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.4",
"size": 14361,
"upload_time": "2023-09-02T22:59:05",
"upload_time_iso_8601": "2023-09-02T22:59:05.014816Z",
"url": "https://files.pythonhosted.org/packages/5d/83/1b87c63a9000c9fee57df4a6506a59e212bd219e9c4e195b700f198a8000/pyspeckle-0.5.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-02 22:59:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "scottprahl",
"github_project": "pyspeckle",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "pyspeckle"
}
JSON
