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, 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.

The implementation is written entirely in Python and 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, tolerance=3e-4)

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

Test

To run tests, first install pytest, then:

python -m pytest

Notable Difference from C++ Code

  • In intersect_bsplines.py, the math_BFGS method is polyfilled and used in place of math_FRPR, as neither math_BFGS nor math_FRPR is usable in OCP due to the lack of math_Vector exposure. The intersect detection algorithm has been improved for both speed and reliability.
  • In the _solve() function of bspline_approx_interp.py, regularization has been added to prevent singular matrix issues, which can occur in cases such as when the input curve is a B-spline derived from a circle.
  • A new file, misc.py, has been introduced to implement missing OCP utilities. The primary additions include clone_bspline and math_BFGS.
  • Modified curve_network_sorter.py, bspline_algorithms.py, and interpolate_curve_network.py to allow a single point to be used as either a profile or a guide.

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.17.tar.gz (117.9 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.17-py3-none-any.whl (52.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ocp_gordon-0.1.17.tar.gz
  • Upload date:
  • Size: 117.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for ocp_gordon-0.1.17.tar.gz
Algorithm Hash digest
SHA256 4325378a7a53b4030806c29b489c91408cc1060524ba377741edf50c5065bfef
MD5 cade1ed04978cb152793c7cef4ecbd54
BLAKE2b-256 b87f049a34c640932046b6ee6f11cf737dfb98282d3da50a9195a0f59a97c625

See more details on using hashes here.

Provenance

The following attestation bundles were made for ocp_gordon-0.1.17.tar.gz:

Publisher: release.yml on gongfan99/ocp_gordon

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

  • Download URL: ocp_gordon-0.1.17-py3-none-any.whl
  • Upload date:
  • Size: 52.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for ocp_gordon-0.1.17-py3-none-any.whl
Algorithm Hash digest
SHA256 6372b9b88da87553b5da18d3b9195c71311a1a08e9a1512d5e95a5b940d15e8f
MD5 87ab454a73e3d23c920e33c3e27a3024
BLAKE2b-256 fb4e2e94d19aae0680038a95cdcae4764e3aab67ef73a055d32430bad679923a

See more details on using hashes here.

Provenance

The following attestation bundles were made for ocp_gordon-0.1.17-py3-none-any.whl:

Publisher: release.yml on gongfan99/ocp_gordon

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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