| Name | ellipsinator JSON |
| Version |
0.3.0
JSON |
| download |
| home_page | |
| Summary | Ellipse tools for Python |
| upload_time | 2023-10-25 17:09:57 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | Copyright (c) 2023 Nicholas McKibben Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
Ellipsinator
============
Tools for working with ellipses in Python.
Installation
============
Should be an easy pip install:
.. code-block:: bash
pip install ellipsinator
Usage
=====
To fit an ellipse:
.. code-block:: python
from ellipsinator import fit_ellipse_halir
c = fit_ellipse_halir(x, y)
from ellipsinator import fit_ellipse_fitzgibon
c = fit_ellipse_fitzgibon(x, y)
from ellipsinator import fast_guaranteed_ellipse_estimate
c = fast_guaranteed_ellipse_estimate(x, y)
You can also pass in the measured points as a complex number,
`x + 1j*y`:
.. code-block:: python
from ellipsinator import fit_ellipse_halir
c = fit_ellipse_halir(x)
Fitting multiple ellipses simultaneously is also possible
with `fit_ellipse_halir` and `fast_guaranteed_ellipse_estimate`:
.. code-block:: python
assert x.shape == (num_ellipses, num_pts)
assert y.shape == (num_ellipses, num_pts)
c1 = fit_ellipse_halir(x, y)
c2 = fast_guaranteed_ellipse_estimate(x, y)
assert c1.shape == (num_ellipses, 6)
assert c2.shape == (num_ellipses, 6)
Raw data
{
"_id": null,
"home_page": "",
"name": "ellipsinator",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "Nicholas McKibben <nicholas.bgp@gmail.com>",
"keywords": "",
"author": "",
"author_email": "Nicholas McKibben <nicholas.bgp@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/a5/35/8015241c15970aac8d16242dae15a74fa116679d5b606e36a6c211b7c431/ellipsinator-0.3.0.tar.gz",
"platform": null,
"description": "Ellipsinator\n============\n\nTools for working with ellipses in Python.\n\nInstallation\n============\n\nShould be an easy pip install:\n\n.. code-block:: bash\n\n pip install ellipsinator\n\n\nUsage\n=====\n\nTo fit an ellipse:\n\n.. code-block:: python\n\n from ellipsinator import fit_ellipse_halir\n c = fit_ellipse_halir(x, y)\n\n from ellipsinator import fit_ellipse_fitzgibon\n c = fit_ellipse_fitzgibon(x, y)\n\n from ellipsinator import fast_guaranteed_ellipse_estimate\n c = fast_guaranteed_ellipse_estimate(x, y)\n\nYou can also pass in the measured points as a complex number,\n`x + 1j*y`:\n\n.. code-block:: python\n\n from ellipsinator import fit_ellipse_halir\n c = fit_ellipse_halir(x)\n\nFitting multiple ellipses simultaneously is also possible\nwith `fit_ellipse_halir` and `fast_guaranteed_ellipse_estimate`:\n\n.. code-block:: python\n\n assert x.shape == (num_ellipses, num_pts)\n assert y.shape == (num_ellipses, num_pts)\n c1 = fit_ellipse_halir(x, y)\n c2 = fast_guaranteed_ellipse_estimate(x, y)\n assert c1.shape == (num_ellipses, 6)\n assert c2.shape == (num_ellipses, 6)\n",
"bugtrack_url": null,
"license": "Copyright (c) 2023 Nicholas McKibben Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Ellipse tools for Python",
"version": "0.3.0",
"project_urls": {
"Homepage": "https://github.com/mckib2/ellipsinator"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5e57283ffc6fdb244a5c8ab571211046cb80246f763fe378c062a9904a1fbb32",
"md5": "92b864835176f83ac4c7ed862f3b9c44",
"sha256": "ad49e2635b15b8bd521562c8bfb9ce1da5f24b508a8e2c91c96398321e23a68f"
},
"downloads": -1,
"filename": "ellipsinator-0.3.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "92b864835176f83ac4c7ed862f3b9c44",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.8",
"size": 26477,
"upload_time": "2023-10-25T17:09:55",
"upload_time_iso_8601": "2023-10-25T17:09:55.338231Z",
"url": "https://files.pythonhosted.org/packages/5e/57/283ffc6fdb244a5c8ab571211046cb80246f763fe378c062a9904a1fbb32/ellipsinator-0.3.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a5358015241c15970aac8d16242dae15a74fa116679d5b606e36a6c211b7c431",
"md5": "ac471f08d49ca529bfc074cd1f822131",
"sha256": "134bb932e0d34df5dd95192eed3c68c4690d1b30ecd51a49a7d15d8a147cc2a6"
},
"downloads": -1,
"filename": "ellipsinator-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "ac471f08d49ca529bfc074cd1f822131",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 19867,
"upload_time": "2023-10-25T17:09:57",
"upload_time_iso_8601": "2023-10-25T17:09:57.301806Z",
"url": "https://files.pythonhosted.org/packages/a5/35/8015241c15970aac8d16242dae15a74fa116679d5b606e36a6c211b7c431/ellipsinator-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-25 17:09:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mckib2",
"github_project": "ellipsinator",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "ellipsinator"
}
