oxvox 0.7.1

Performant operations on array & pointcloud data, written in Rust

OxVox - Oxidised Voxelised toolkit

A collection of operations on arrays and pointclouds implemented in Rust

Installation

Precompiled (from PyPI, recommended)

pip install oxvox

Manual

Checkout this repo and enter a virtual environment, then run

maturin develop --release

Usage

Indexing by field

In [7]: from oxvox.indexing import indices_by_field
   ...: 
   ...: TEST_ARRAY = np.array(
   ...:     [
   ...:         (2, "a"),
   ...:         (3, "b"),
   ...:         (2, "a"),
   ...:         (3, "c"),
   ...:         (4, "a"),
   ...:         (4, "c"),
   ...:     ],
   ...:     dtype=[
   ...:         ("score", np.int32),
   ...:         ("initial", "|O"),
   ...:     ],
   ...: )
   ...: 
   ...: for row_values, row_indices in indices_by_field(arr=TEST_ARRAY, fields=["score"]):
   ...:     print(f"Unique value: {row_values.tolist()} at row indices {row_indices}")
   ...: 
Unique value: (2,) at row indices [0 2]
Unique value: (3,) at row indices [1 3]
Unique value: (4,) at row indices [4 5]

Nearest Neighbour Search (NNS)

Basic usage, query a block of query points in sparse mode:

import numpy as np
from oxvox.nns import OxVoxNNS

NUM_POINTS = 100_000
TEST_POINTS = np.random.random((NUM_POINTS, 3))

indices, distances = OxVoxNNS(
    search_points=TEST_POINTS,
    max_dist=0.05,
).find_neighbours(
    query_points=TEST_POINTS,
    num_neighbours=1000,
    sparse=True,
)

More complex usage, using a single NNS object for multiple exact mode queries (e.g. to distribute the nns object and perform queries in parallel, or to query from a large number of query points in batches/chunks)

# same imports and test data as above

nns = ox_vox_nns.OxVoxNNS(TEST_POINTS, 0.1)

for query_points_chunk in query_points_chunks:
    chunk_indices, chunk_distances = nns.find_neighbours(
        query_points=query_points_chunk,
        num_neighbours=1,
        sparse=False,
    )

Tests

All test files are executable for spot-testing functionality

To run all tests:

make test

Performance

See performance tests under performance_tests directory

Building & Pushing to PyPI

1. Generate CI YAML (still TODO: run tests after building before pushing to PyPI)

maturin generate-ci > .github/workflows/CI.yml

2. Update cargo.toml

[package]
name = "oxvox"
version = "0.7.1"
...

3. Tag with version number and push

git commit -am "Push version 0.7.1"
git tag 0.7.1
git push --tags