# binvox-rw-py

**Repository Path**: mirrors_lepy/binvox-rw-py

## Basic Information

- **Project Name**: binvox-rw-py
- **Description**: Python module to read and write .binvox files.
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: public
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-25
- **Last Updated**: 2025-07-02

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# binvox-rw-py

Small Python module to read and write `.binvox` files. The voxel data is
represented as dense 3-dimensional Numpy arrays in Python (a direct if somewhat
wasteful representation for sparse models) or as an array of 3D coordinates
(more memory-efficient for large and sparse models).

[Binvox](http://www.cs.princeton.edu/~min/binvox/) is a neat little program to
convert 3D models into binary voxel format. The `.binvox` file format is a
simple run length encoding format described
[here](http://www.cs.princeton.edu/~min/binvox/binvox.html).

## Code example

Suppose you have a voxelized chair model, `chair.binvox` (you can try it on the
one in the repo).  Here's how it looks in
[`viewvox`](http://www.cs.princeton.edu/~min/viewvox/):

![chair](https://raw.githubusercontent.com/dimatura/binvox-rw-py/public/chair.png)

Then

    >>> import binvox_rw
    >>> with open('chair.binvox', 'rb') as f:
    ...     model = binvox_rw.read_as_3d_array(f)
    ...
    >>> model.dims
    [32, 32, 32]
    >>> model.scale
    41.133000000000003
    >>> model.translate
    [0.0, 0.0, 0.0]
    >>> model.data
    array([[[ True, False, False, ..., False, False, False],
            [ True, False, False, ..., False, False, False],
            [ True, False, False, ..., False, False, False],
            ...,
           [[False, False, False, ..., False, False, False],
            [False, False, False, ..., False, False, False],
            [False, False, False, ..., False, False, False],
            ...,
            [False, False, False, ..., False, False, False],
            [False, False, False, ..., False, False, False],
            [False, False, False, ..., False, False, False]]], dtype=bool)

You get the idea. `model.data` has the boolean 3D array. You can then
manipulate however you wish. For example, here we dilate it with
`scipy.ndimage` and write the dilated version to disk:

    >>> import scipy.ndimage
    >>> scipy.ndimage.binary_dilation(model.data.copy(), output=model.data)
    >>> model.write('dilated.binvox')

Then we get a fat chair:

![fat chair](https://raw.githubusercontent.com/dimatura/binvox-rw-py/public/fat_chair.png)

## Sparse representation

To get the data as an array of coordinates, look at `binvox_rw.read_coords`.

## Installation

This is a really simple, 200-line module. You should just stick into whatever
project you're using.  Or copy it to `/usr/share/lib/pythonX.Y/site-packages`
if you really want a system-wide installation.

---

Daniel Maturana
`dimatura@cmu.edu`