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 hashes)

Uploaded Source

Built Distribution

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

Uploaded Python 3

Supported by

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