Skip to main content

POLAR package

Project description

POint cloud LAtent Registration

Getting started

POLAR is a method to simultaneously register numerous highly degraded point clouds corresponding to views of the same unknown reference object.

Installation

[!WARNING] PyTorch3D is required by POLAR. Since its installation is quite specific, you need to install it manually.

If you want to user POLAR with the provided pretrained autoencoder, run

pip install polaregistration

If you want to retrain the autoencoder on your own, run

pip install polaregistration[train]

If you want to use the interactive visualization function, run

pip install polaregistration[vis]

Finally, to install everything, run

pip install polaregistration[all]

Minimal example

from polar import load_sample_data, POLAR

X, degradations, R_abs_gt = load_sample_data()

model = POLAR(**degradations)
X_hat = model.fit_transform(X)

POLAR partially respects the Scikit-Learn Estimator API. Specifically, it has the two main methods:

  • fit(X: Tensor | Sequence[Tensor]) -> None
  • fit_transform(X: Tensor | Sequence[Tensor]) -> Tensor | Sequence[Tensor]

They take a list of PyTorch tensors (each of shape $(K_i, 3)$ if point clouds are of varying lengths) or a single batch tensor of shape $(N, K, 3)$ containing all the (same length) views.

Documentation

A documentation, containing full api reference as well as small showcases is available here.

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

polaregistration-0.1.1.tar.gz (64.9 MB view details)

Uploaded Source

Built Distribution

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

polaregistration-0.1.1-py3-none-any.whl (63.6 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: polaregistration-0.1.1.tar.gz
  • Upload date:
  • Size: 64.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.8.18

File hashes

Hashes for polaregistration-0.1.1.tar.gz
Algorithm Hash digest
SHA256 678ff85381b7db6ca605b409a286d47e5c150124ce09d7de16df260d2493982d
MD5 4fb1e42a6d3e77a67d27be5abab7adc6
BLAKE2b-256 9dc25009e6faf75a90d047934df7b043da480f7d2ab7ffcec1f20464a2d320b7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for polaregistration-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4004508d98f845e372ef447a3b5bb9d6636d0a04312735d6b89b6d3d08de9241
MD5 31fde39e8ea18eb7e6e172803181a5df
BLAKE2b-256 4d5614a240220f8d6f24e54c80e6bbbc0391bc51bf81a1f99a8b5f0373cbe4ff

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