Circle-Fit
A Circle Fitting Library for Python
Given a collection of points in 2D space, a common problem is finding the parameters of a circle that best approximate these points. This library implements a collection of different circle fitting algorithms:
- hyperLSQ() : Least squares circle fit with "hyperaccuracy" by Kenichi Kanatani, Prasanna Rangarajan
- standardLSQ() : Least squares circle fit, standard version.
- riemannSWFLa() : Riemann circle fit, SWFL version A
- lm() : Levenberg-Marquardt in the full (a,b,R) parameter space
- prattSVD() : Algebraic circle fit by V. Pratt
- taubinSVD() : Algebraic circle fit by G. Taubin
- hyperSVD() : Algebraic circle fit with "hyperaccuracy"
- kmh() : Consistent circle fit by A. Kukush, I. Markovsky, S. Van Huffel
Most of these algorithms are based on the original MATLAB implementations by Nikolai Chernov: https://people.cas.uab.edu/~mosya/cl/MATLABcircle.html
Each algorithm may work better in specific cases. If you are in doubt about which to use, taubinSVD()
is a good starting point.
Installation
circle-fit is available from PyPi. Run the following in a command line terminal:
pip install circle-fit
Example
Fit a circle to four (x,y) points.
from circle_fit import taubinSVD
point_coordinates = [[1, 0], [-1, 0], [0, 1], [0, -1]]
xc, yc, r, sigma = taubinSVD(point_coordinates)
Data format
Your data must have at least two points in 2-D space. The algorithms in circle-fit expects either
a 2D List or numpy ndarray of shape (n, 2), where n is the number of points in your dataset.
All the algorithms available in this library return four values:
- xc : x-coordinate of solution center (float)
- yc : y-coordinate of solution center (float)
- r : Radius of solution (float)
- sigma : Residual error of solution (float)
View the fit
The function plot_data_circle(coords, xc, yc, r) can be used to open a plot window which shows you data points with
a circle fit overlaid on top. Example use:
xc, yc, r, sigma = taubinSVD(point_coordinates)
plot_data_circle(point_coordinates, xc, yc, r)
Contributors and Maintainers
This library is a community collaboration, all work is voluntary.
To Contribute
Please open a pull request with the changes you would like to contribute (example)
Contact
As we are volunteers, please be patient when requesting support. You can either open an issue if you think you've found a bug with the code, or contact one of us directly if you have a user issue:
Metadata
Release files for circle-fit 0.2.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| circle_fit-0.2.1.tar.gz | 273.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| circle_fit-0.2.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 282.6 kB
Release files / circle_fit-0.2.1.tar.gz
| Download URL | circle_fit-0.2.1.tar.gz |
|---|---|
| Size | 273.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
54a8f361887fdcbcec15fd681e55051de7d4e8143e45353c082c58ba32e7dcb4
|
|
BLAKE2b-256 checksum How to use checksums |
1c4ec6263534b6fdf1a33d19deada6846c8e063c8c8d2b16e57bd41b79a4b346
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.9.16
|
Release files / circle_fit-0.2.1-py3-none-any.whl
| Download URL | circle_fit-0.2.1-py3-none-any.whl |
|---|---|
| Size | 9.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
45c3813638e29354fd3b65eb9c03dea37125b31d2c8dad2e7f98c5edcdb2f428
|
|
BLAKE2b-256 checksum How to use checksums |
1df4078a419a977e74663033fc9e299d8421a2f0ac991251345a23d8b69c1342
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.9.16
|