Skip to main content

scikit-surgery-sphere-fitting implements a least squares sphere fitting algorithm, to read a vtk poly data file, a config file, and outputs the fitted sphere

Project description

Logo GitHub Actions CI status Test coverage Documentation Status DOI - zenodo

Author: Stephen Thompson

scikit-surgery-sphere-fitting is part of the SciKit-Surgery software project, developed at the Wellcome EPSRC Centre for Interventional and Surgical Sciences, part of University College London (UCL).

scikit-surgery-sphere-fitting supports Python 3.6.

scikit-surgery-sphere-fitting fits a sphere to a set of 3D points. It includes a user interface that will read data from a vtk polydata file create an output polydata file showing the fitted sphere. Example usage:

python sksurgeryspherefitting.py polydata_in.vtp --output polydatata_out.vtp --config conf.json

It was created in part to provide a simple demonstration of algorithm development as part of a program of SNAPPY Tutorials, but also provides a useful service should you want to fit a sphere to some data.

Citing

If you use SciKit-Surgery-Sphere-Fitting in your research or teaching please cite it. Individual releases can be cited via the Zenodo tag above. SciKit-Surgery should be cited as:

Thompson S, Dowrick T, Ahmad M, et al. “SciKit-Surgery: compact libraries for surgical navigation.” International Journal of Computer Assisted Radiology and Surgery. 2020 May. DOI: 10.1007/s11548-020-02180-5.

Developing

Cloning

You can clone the repository using the following command:

git clone https://github.com/thompson318/scikit-surgery-sphere-fitting

Running tests

Pytest is used for running unit tests:

pip install pytest
python -m pytest

Linting

This code conforms to the PEP8 standard. Pylint can be used to analyse the code:

pip install pylint
pylint --rcfile=tests/pylintrc sksurgeryspherefitting

Installing

You can pip install directly from the repository as follows:

pip install git+https://github.com/thompson318/scikit-surgery-sphere-fitting

or directly from pypi

pip install scikit-surgery-sphere-fitting

Contributing

Please see the contributing guidelines.

Acknowledgements

Supported by Wellcome and EPSRC.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

scikit-surgery-sphere-fitting-0.0.5.tar.gz (21.5 kB view details)

Uploaded Source

File details

Details for the file scikit-surgery-sphere-fitting-0.0.5.tar.gz.

File metadata

  • Download URL: scikit-surgery-sphere-fitting-0.0.5.tar.gz
  • Upload date:
  • Size: 21.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6

File hashes

Hashes for scikit-surgery-sphere-fitting-0.0.5.tar.gz
Algorithm Hash digest
SHA256 d47c68f63226214e3f297215455e22a96a94c07528f7869e20a96544365cecbd
MD5 a207af98e6a358f0981c388ca44f57a1
BLAKE2b-256 ee5913421ba59c49fdc68ef458d0ec3c4bcea156b1199a1a177ec76a195a3bea

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page