Skip to main content

Python module for 3D tiles format

Project description

chat link Build pipeline status Py3dtiles version on pypi Supported python versions Code coverage py3dtiles GitLab last commit Py3dtiles license

Py3dtiles

Py3dtiles is a CLI tool and a library writing with Python for creating and manipulating 3D Tiles.

Features

Tileset manipulation

  • Read tileset lazily (to avoid useless memory consumption)

  • Write tilesets with their tile contents

  • Browse the tile structure, access to the properties and tile content with the ability to modify them

  • Read and write pnts and b3dm with the batch table support

Tiling tools

All tiling tools are available with the API and the CLI

  • Convert data into 3d tiles (tileset.json + pnts/b3dm files). The supported file formats are:
    • las/laz

    • xyz

    • ply

    • wkb

  • Merge 3D Tiles tilesets into one tileset

  • Read pnts and b3dm files and print a summary of their contents

Installation

With pip

To install Py3dtiles with pip (recommended method)

pip install py3dtiles

For installing specific format dependencies (las/laz, ply, postgis, install from source…), please read the installation section in the documentation.

With docker

At the moment we only publish on gitlab registry.

docker run -it --rm \
    --mount type=bind,source="$(pwd)",target=/app/data/ \
    --volume /etc/passwd:/etc/passwd:ro --volume /etc/group:/etc/group:ro --user $(id -u):$(id -g) \
    registry.gitlab.com/py3dtiles/py3dtiles:<version> \
    convert <file>

NOTE:

  • the –mount option is necessary for docker to read your source data and to write the result. The way it is written in this example only allows you to read source files in the current folder or in a subfolder

  • This line –volume /etc/passwd:/etc/passwd:ro –volume /etc/group:/etc/group:ro –user $(id -u):$(id -g) is only necessary if your uid is different from 1000.

API basic example

>>> from pathlib import Path
>>>
>>> from py3dtiles.tileset.tileset import TileSet
>>>
>>> tileset = TileSet.from_file(Path("tests/fixtures/tiles/tileset.json"))
>>> all_tiles = (tileset.root_tile, *tileset.root_tile.get_all_children())
>>> for tile in all_tiles:
...     if not tile.has_content():
...         continue
...     tile_content = tile.get_or_fetch_content(tileset.root_uri)
...     print(f"The tile {tile.content_uri} has a content of {type(tile_content)} type")
...     print(f"with this bounding volume: {tile.bounding_volume.to_dict()}")
The tile r.pnts has a content of <class 'py3dtiles.tileset.content.pnts.Pnts'> type
with this bounding volume: {'box': [0.390625, 0.3125, 0.0, 0.390625, 0.0, 0.0, 0.0, 0.3125, 0.0, 0.0, 0.0, 0.0]}
The tile r1.pnts has a...

Result example

The data visualized on this website is generated with the convert and merge CLI command of Py3dtiles: https://giro3d.org/examples/lidar_hd.html

The library used on this site is giro3d but there are other 3dtiles viewers.

Lidar HD data converted into 3d tiles visualized with giro3d

Documentation

The CLI and API documentation with examples are available here:

Roadmap

The objectives are:

  • to support the standard at version 1.1 (mainly gltf as content)

  • to convert more file formats

  • to have a better tiler for geometries

Contributing

We welcome new contributions. This may be fixing an issue or adding a feature, but also:

  • reporting an issue

  • reviewing a MR

  • improving the documentation or creating a tutorial

  • talking about this project to others

  • help others on the [chat room](https://matrix.to/#/#py3dtiles:matrix.org)

We have written a contributing guide to help you for your first contribution.

License

Py3dtiles is distributed under the Apache 2 Licence.

Thanks

The following entities have funded py3dtiles:

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

py3dtiles-8.0.1.tar.gz (809.2 kB view details)

Uploaded Source

Built Distribution

py3dtiles-8.0.1-py3-none-any.whl (93.5 kB view details)

Uploaded Python 3

File details

Details for the file py3dtiles-8.0.1.tar.gz.

File metadata

  • Download URL: py3dtiles-8.0.1.tar.gz
  • Upload date:
  • Size: 809.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.9

File hashes

Hashes for py3dtiles-8.0.1.tar.gz
Algorithm Hash digest
SHA256 8f6b67abce8c4811ec1849db439ed6f71cc898aeabacf9de1c74d4a199e9a666
MD5 8e4ba71e3e31bf2270fb77e5ddf8cbf1
BLAKE2b-256 1454006e6d4284b6519ad54bfdfb3e3a931647760fb8852a4f0986264f458af9

See more details on using hashes here.

File details

Details for the file py3dtiles-8.0.1-py3-none-any.whl.

File metadata

  • Download URL: py3dtiles-8.0.1-py3-none-any.whl
  • Upload date:
  • Size: 93.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.9

File hashes

Hashes for py3dtiles-8.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9432592a967d12f616bd03e06ad2dad527bef6e3e84022a7190a5e159934a26d
MD5 2215916af9960d8d1af33347e158c052
BLAKE2b-256 417c1612fc630451e297e0067aeb02b20b8a41e90b022908369e94653208770e

See more details on using hashes here.

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