Skip to main content

Coherent Point Drift variants (rigid, affine, deformable, PCA/SSM) in NumPy/SciPy

Project description

biocpd

Coherent Point Drift (CPD) registration in pure NumPy/SciPy with fast variants:

  • Rigid and Affine CPD
  • Deformable CPD with low-rank (randomized SVD) and k-d tree accelerated E-step
  • Constrained Deformable CPD with correspondence priors
  • Atlas/SSM-based CPD (AtlasRegistration) optimized in coefficient space

Why biocpd?

  • Fast: sparse k-NN E-step, low-rank kernels, and efficient linear solvers
  • Flexible: rigid, affine, unconstrained and constrained deformable, and SSM/atlas-based
  • Simple: pure NumPy/SciPy implementation; easy to read and extend

Install

pip install -r requirements.txt
# optional (recommended for building)
pip install build wheel

Build wheel

# From repository root
python -m build
# or legacy
python setup.py sdist bdist_wheel

Quickstart

import numpy as np
from biocpd import RigidRegistration, AffineRegistration, DeformableRegistration, ConstrainedDeformableRegistration, AtlasRegistration

rng = np.random.default_rng(0)
X = rng.normal(size=(200, 3))           # target
Y = X + 0.05 * rng.normal(size=(200,3)) # source (noisy)

# Rigid CPD
rig = RigidRegistration(X=X, Y=Y, max_iterations=50, use_kdtree=True, k=10)
TY_rigid, (s, R, t) = rig.register()

# Affine CPD
aff = AffineRegistration(X=X, Y=Y, max_iterations=50, use_kdtree=True, k=10)
TY_affine, (B, t) = aff.register()

# Deformable CPD (low-rank + k-d tree)
defm = DeformableRegistration(X=X, Y=Y, alpha=2.0, beta=2.0, low_rank=True, num_eig=80,
                              use_kdtree=True, k=10, radius_mode=False, w=0.05,
                              max_iterations=50)
TY_def, params = defm.register()

# Constrained Deformable CPD
ids = np.arange(10)
con = ConstrainedDeformableRegistration(X=X, Y=Y, alpha=2.0, beta=2.0, low_rank=True, num_eig=80,
                                        use_kdtree=True, k=10, e_alpha=1e-4,
                                        source_id=ids, target_id=ids,
                                        max_iterations=50)
TY_con, params_con = con.register()

# Atlas / Statistical Shape Model CPD
M, D, K = 200, 3, 12
mean_shape = rng.normal(size=(M, D))
U = rng.normal(size=(M*D, K))
L = np.abs(rng.normal(size=(K,))) + 1e-1
atl = AtlasRegistration(X=X, Y=mean_shape, mean_shape=mean_shape,
                        U=U, eigenvalues=L, lambda_reg=0.1,
                        normalize=True, use_kdtree=True, k=10, radius_mode=False,
                        optimize_similarity=True, with_scale=True, w=0.02,
                        max_iterations=50)
TY_atl, params_atl = atl.register()

Key options

  • use_kdtree, k: enable sparse E-step for speed on large data
  • low_rank, num_eig (deformable): low-rank kernel for fast M-step
  • radius_mode: optional radius gating in sparse E-step (off by default)
  • w: outlier weight (0 ≤ w < 1) in GMM
  • dtype (deformable, constrained deformable, atlas): defaults to np.float32; set dtype=np.float64 when you need the extra precision
  • normalize (atlas): improves stability across scales
  • mean_shape (atlas): with normalize=True, pass mean_shape as (M, D)

Acknowledgements

  • This work builds on the excellent original CPD implementation by Siavash Khallaghi and Anthony Gatti (pycpd, MIT-licensed) and the CPD method by Myronenko and Song.
  • Repository for pycpd: https://github.com/siavashk/pycpd

Citation

If you use this package in academic work, please cite CPD:

  • Myronenko, A. and Song, X., "Point Set Registration: Coherent Point Drift," in IEEE Transactions on Pattern Analysis and Machine Intelligence, 2010.

License

MIT

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

biocpd-1.2.0.tar.gz (22.3 kB view details)

Uploaded Source

Built Distribution

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

biocpd-1.2.0-py3-none-any.whl (22.1 kB view details)

Uploaded Python 3

File details

Details for the file biocpd-1.2.0.tar.gz.

File metadata

  • Download URL: biocpd-1.2.0.tar.gz
  • Upload date:
  • Size: 22.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.20

File hashes

Hashes for biocpd-1.2.0.tar.gz
Algorithm Hash digest
SHA256 78b72ac32f65fc5590bc8b165363eea5f945c89d75ff3403e8d971a06943d903
MD5 a723c9184dcf6b17e152d6b29e601887
BLAKE2b-256 c7557ad988c77f81b7399238ad3847bcfd53ae8f45372321585e52abfdd4fbdb

See more details on using hashes here.

File details

Details for the file biocpd-1.2.0-py3-none-any.whl.

File metadata

  • Download URL: biocpd-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 22.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.20

File hashes

Hashes for biocpd-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8708c99102cc05f2592e44193da4ce8b580fe004202994b7f798a041f630982d
MD5 66a1ca926bcdfcc83c0adcb5da3e275e
BLAKE2b-256 e112687ca2335faa8c561c77067981b1f9423633776a2084de08e65cb41eb2d9

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