Skip to main content

A Python library for Gordon Surface interpolation using B-splines.

Project description

Gordon Surface Library for CadQuery's OCP

This library provides a Python implementation for creating Gordon surfaces, which are a method for interpolating a network of curves to generate a smooth surface. It is designed to be compatible with CadQuery's OCP and leverages B-spline mathematics.

It is adapted from the original C++ code in occ_gordon

Features

  • Gordon surface interpolation from profile and guide curves.
  • Compatibility with B-spline representations.
  • Integration with CadQuery's OCP (OpenCASCADE Python) for geometric primitives.

Installation

This package can be installed using pip.

pip install ocp_gordon

Dependencies

  • OCP (OpenCASCADE Python)
  • NumPy
  • SciPy

Usage

Here's a basic example of how to use the library:

# Assume you have profile_curves and guide_curves defined as lists of B-spline objects
# profile_curves = [...] # List of Geom_BSplineCurve objects
# guide_curves = [...]   # List of Geom_BSplineCurve objects

from ocp_gordon import interpolate_curve_network

gordon_surface = interpolate_curve_network(profile_curves, guide_curves)

For more detailed examples, please refer to the examples/ directory in the source code.

Test

To run tests, first install pytest, then:

cd tests
python test_all.py

Notable Difference from C++ Code

  • In intersect_bsplines.py, a polyfilled math_BFGS is used instead of math_FRPR because both math_BFGS and math_FRPR are not usable in OCP because OCP does not expose math_Vector. The activate() function in this file has also been changed since the original one does not work well.
  • In the _solve() function in bspline_approx_interp.py, the regularization is added to prevent singular matrix which occurs in some cases for example when the input curve is a bspline converted from a circle.
  • A new file misc.py is added to implement some missing classes/functions from OCP. The major ones are clone_bspline and math_BFGS.

License

This project is licensed under the Apache 2.0 License - see the LICENSE file for details.

Citing

The algorithm was originally described in:

Siggel M. et. al. (2019), TiGL: An Open Source Computational Geometry Library for Parametric Aircraft Design

@article{siggel2019tigl,
	title={TiGL: an open source computational geometry library for parametric aircraft design},
	author={Siggel, Martin and Kleinert, Jan and Stollenwerk, Tobias and Maierl, Reinhold},
	journal={Mathematics in Computer Science},
	volume={13},
	number={3},
	pages={367--389},
	year={2019},
	publisher={Springer},
    doi={10.1007/s11786-019-00401-y}
}

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

ocp_gordon-0.1.1.tar.gz (62.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ocp_gordon-0.1.1-py3-none-any.whl (47.9 kB view details)

Uploaded Python 3

File details

Details for the file ocp_gordon-0.1.1.tar.gz.

File metadata

  • Download URL: ocp_gordon-0.1.1.tar.gz
  • Upload date:
  • Size: 62.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.0

File hashes

Hashes for ocp_gordon-0.1.1.tar.gz
Algorithm Hash digest
SHA256 cf5f6af3dc52827c20c1a80682c8bd3088b152555974ca7ca9a4696dbc73f503
MD5 1c738e9385baf0a716d116b72b24c819
BLAKE2b-256 9a17cd64d7533a175ae2ddb5a93d1d4e6373a64d2c17b84c13b0a5f6bf422ca0

See more details on using hashes here.

File details

Details for the file ocp_gordon-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: ocp_gordon-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 47.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.0

File hashes

Hashes for ocp_gordon-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f33f5b9606a87287c830e30a003ea86688c486104d370924a44d107cbed0f2c2
MD5 20e5abbab1f99dd759a83a1a90a4d1a9
BLAKE2b-256 f55265e61271d6f29a46340ad6047bab07387fc7756faf287ba2a9cf907e6d43

See more details on using hashes here.

Supported by

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