scikit-surgery-sphere-fitting

Logo GitLab-CI test status Test coverage Documentation Status

Author: Stephen Thompson

scikit-surgery-sphere-fitting is part of the SNAPPY 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.

Developing

Cloning

You can clone the repository using the following command:

git clone https://weisslab.cs.ucl.ac.uk/StephenThompson/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://weisslab.cs.ucl.ac.uk/StephenThompson/scikit-surgery-sphere-fitting

or directly from pypi

pip install scikit-surgery-sphere-fitting

Contributing

Please see the contributing guidelines.