py3dtiles package

class py3dtiles.B3dm

Bases: TileContent

static from_array(array)

Parameters

array : numpy.array

Returns

t : TileContent

static from_glTF(gltf, bt=None)

Parameters

gltfGlTF

glTF object representing a set of objects

btBatch Table (optional)

BatchTable object containing per-feature metadata

Returns

tile : TileContent

class py3dtiles.BatchTable

Bases: object

Only the JSON header has been implemented for now. According to the batch table documentation, the binary body is useful for storing long arrays of data (better performances)

add_property_from_array(property_name, array)

to_array()

class py3dtiles.BoundingVolumeBox

Bases: BoundingVolume

A box bounding volume as defined in the 3DTiles specifications i.e. an array of 12 numbers that define an oriented bounding box: - The first three elements define the x, y, and z values for the

center of the box.

• The next three elements (with indices 3, 4, and 5) define the x axis direction and half-length.

• The next three elements (with indices 6, 7, and 8) define the y axis direction and half-length.

• The last three elements (indices 9, 10, and 11) define the z axis direction and half-length.”

Note that, by default, a box bounding volume doesn’t need to be aligned with the coordinate axis. Still in general, computing the box bounding volume of two box bounding volumes won’t necessarily yield a box that is aligned with the coordinate axis (although this computation might require some fitting algorithm e.g. the principal component analysis method. Yet in sake of simplification (and numerical efficiency), when asked to “add” (i.e. to find the enclosing box of) two (or more) box bounding volumes this class resolves to compute the “canonical” fitting/enclosing box i.e. a box that is parallel to the coordinate axis.

add(other: BoundingVolumeBox) → None

Compute the ‘canonical’ bounding volume fitting this bounding volume together with the added bounding volume. Again (refer above to the class definition) the computed fitting bounding volume is generically not the smallest one (due to its alignment with the coordinate axis). :param other: another box bounding volume to be added with this one

static get_box_array_from_mins_maxs(mins_maxs: list | ndarray) → ndarray

Parameters:

mins_maxs – the list [x_min, y_min, z_min, x_max, y_max, z_max] that is the boundaries of the box along each coordinate axis

Returns:

the smallest box (as an array, as opposed to a BoundingVolumeBox instance) that encloses the given list of (3D) points and that is parallel to the coordinate axis.

static get_box_array_from_point(points: list[list[float]]) → ndarray

Parameters:

points – a list of 3D points

Returns:

the smallest box (as an array, as opposed to a BoundingVolumeBox instance) that encloses the given list of (3D) points and that is parallel to the coordinate axis.

get_canonical_as_array() → ndarray

Returns:

the smallest enclosing box (as an array) that is parallel to the coordinate axis

get_center() → ndarray

get_corners() → list

Returns:

the corners (3D points) of the box as a list

is_box() → bool

static is_valid(box) → tuple[bool, str]

set_from_array(box_array: ndarray) → None

set_from_list(box_list: list) → None

set_from_mins_maxs(mins_maxs: list | ndarray) → None

Parameters:

mins_maxs – the list [x_min, y_min, z_min, x_max, y_max, z_max] that is the boundaries of the box along each coordinate axis

set_from_points(points: list) → None

sync_with_children(owner: Tile) → None

to_dict() → dict

transform(transform: list[float] | ndarray) → None

Apply the provided transformation matrix (4x4) to the box :param transform: transformation matrix (4x4) to be applied

translate(offset: list | ndarray) → None

Translate the box center with the given offset “vector” :param offset: the 3D vector by which the box should be translated

class py3dtiles.Extendable

Bases: object

One the 3DTiles notions defined as an abstract data model through a schema of the 3DTiles specifications (either core of extensions).

add_extension(extension: Extension) → None

get_extension(extension_name: str) → Extension

get_extensions() → list[Extension]

has_extensions() → bool

class py3dtiles.Extension(name: str)

Bases: object

An instance of some ExtensionType.

to_dict() → dict

class py3dtiles.Feature

Bases: object

static from_array(positions_dtype, positions, colors_dtype=None, colors=None)

Parameters

positions_dtype : numpy.dtype

positionsnumpy.array

Array of uint8.

colors_dtype : numpy.dtype

colorsnumpy.array

Array of uint8.

Returns

f : Feature

static from_values(x, y, z, red=None, green=None, blue=None)

to_array()

class py3dtiles.GlTF

Bases: object

CHUNK_HEADER_LENGTH = 8

HEADER_LENGTH = 12

static from_array(array)

Parameters

array : numpy.array

Returns

glTF : GlTf

static from_binary_arrays(arrays, transform, batched=True, uri=None, texture_uri=None)

Parameters

arraysarray of dictionaries

Each dictionary has the data for one geometry arrays[‘position’]: binary array of vertex positions arrays[‘normal’]: binary array of vertex normals arrays[‘uv’]: binary array of vertex texture coordinates

(Not implemented yet)

arrays[‘bbox’]: geometry bounding box (numpy.array)

transformnumpy.array

World coordinates transformation flattend matrix

Returns

glTF : GlTF

to_array()

class py3dtiles.Pnts

Bases: TileContent

static from_array(array)

Parameters

array : numpy.array

Returns

t : TileContent

static from_features(pd_type, cd_type, features)

Parameters

dtypenumpy.dtype

Numpy description of a single feature

features : Feature[]

Returns

tile : TileContent

class py3dtiles.Tile(geometric_error=500, bounding_volume=None, refine_mode='ADD')

Bases: Extendable

add_child(tile: Tile) → None

get_children() → list[Tile]

Returns:

the recursive (across the children tree) list of the children tiles

get_content() → TileContent

get_content_uri() → str

get_direct_children() → list[Tile]

get_refine_mode() → str

get_transform() → list[float]

has_children() → bool

set_content(content: TileContent, force=True) → None

set_content_uri(uri: str) → None

set_refine_mode(mode: str) → None

set_transform(transform: list[float]) → None

Parameters:

transform – a flattened transformation matrix

Returns:

sync_bounding_volume_with_children() → None

to_dict() → dict

write_content(directory: Path) → None

Write (or overwrite) the tile _content_ to the directory specified as parameter and withing the relative filename designated by the tile’s content uri. Note that it is the responsibility of the owning TileSet to

• set those uris

• to explicitly invoke write_content() (this is to be opposed with the Tile attributes which get serialized when recursing on the TileSet attributes) :param directory: the target directory

class py3dtiles.TileContent

Bases: object

save_as(path: Path)

sync()

Allow to synchronize headers with contents.

to_array()

to_hex_str()

class py3dtiles.TileContentReader

Bases: object

static read_array(array: np.ndarray) → TileContent | None

static read_file(tile_path: Path) → TileContent

class py3dtiles.TileSet(geometric_error=500)

Bases: Extendable

add_asset_extras(comment: str) → None

Parameters:

comment – the comment on original data, pre-processing, possible ownership to be added as asset extra.

set_transform(transform: List[float]) → None

Parameters:

transform – a flattened transformation matrix

Returns:

to_dict() → dict

Convert to json string possibly mentioning used schemas

to_json() → str

write_as_json(directory: Path) → None

Write the tileset as a JSON file. :param directory: the target directory name

write_to_directory(directory: Path) → None

Write (or overwrite), to the directory whose name is provided, the TileSet that is:

• the tileset as a json file and

• all the tiles content of the Tiles used by the Tileset.

Parameters:

directory – the target directory name

class py3dtiles.TriangleSoup

Bases: object

static from_wkb_multipolygon(wkb, associated_data=None)

Parameters

wkbstring

Well-Known Binary binary string describing a multipolygon

associated_dataarray

array of multipolygons containing data attached to the wkb parameter multipolygon. Must be the same size as wkb.

Returns

ts : TriangleSoup

get_bbox()

Parameters

Returns

Array [[minX, minY, minZ],[maxX, maxY, maxZ]]

get_data_array(index)

Parameters

index: int

The index of the associated data

Returns

Binary array of vertex data

get_normal_array()

Parameters

Returns

Binary array of vertice normals

get_position_array()

Parameters

Returns

Binary array of vertex positions

py3dtiles.convert_to_ecef(x, y, z, epsg_input)

Subpackages

• py3dtiles.points package
  • Subpackages
    • py3dtiles.points.task package
  • Submodules
    • py3dtiles.points.distance module
    • py3dtiles.points.node module
    • py3dtiles.points.node_catalog module
    • py3dtiles.points.points_grid module
    • py3dtiles.points.shared_node_store module
    • py3dtiles.points.transformations module
    • py3dtiles.points.utils module

Submodules

• py3dtiles.b3dm module
  • B3dm
    • B3dm.from_array()
    • B3dm.from_glTF()
  • B3dmBody
    • B3dmBody.from_array()
    • B3dmBody.from_glTF()
    • B3dmBody.to_array()
  • B3dmHeader
    • B3dmHeader.BYTELENGTH
    • B3dmHeader.from_array()
    • B3dmHeader.sync()
    • B3dmHeader.to_array()
• py3dtiles.batch_table module
  • BatchTable
    • BatchTable.add_property_from_array()
    • BatchTable.to_array()
• py3dtiles.bounding_volume module
  • BoundingVolume
    • BoundingVolume.is_box()
    • BoundingVolume.is_region()
    • BoundingVolume.is_sphere()
• py3dtiles.bounding_volume_box module
  • BoundingVolumeBox
    • BoundingVolumeBox.add()
    • BoundingVolumeBox.get_box_array_from_mins_maxs()
    • BoundingVolumeBox.get_box_array_from_point()
    • BoundingVolumeBox.get_canonical_as_array()
    • BoundingVolumeBox.get_center()
    • BoundingVolumeBox.get_corners()
    • BoundingVolumeBox.is_box()
    • BoundingVolumeBox.is_valid()
    • BoundingVolumeBox.set_from_array()
    • BoundingVolumeBox.set_from_list()
    • BoundingVolumeBox.set_from_mins_maxs()
    • BoundingVolumeBox.set_from_points()
    • BoundingVolumeBox.sync_with_children()
    • BoundingVolumeBox.to_dict()
    • BoundingVolumeBox.transform()
    • BoundingVolumeBox.translate()
• py3dtiles.command_line module
• py3dtiles.constants module
• py3dtiles.convert module
• py3dtiles.earcut module
  • deviation()
  • earcut()
  • flatten()
• py3dtiles.exceptions module
  • Py3dtilesException
  • SrsInMissingException
  • SrsInMixinException
  • WorkerException
• py3dtiles.export module
• py3dtiles.extendable module
  • Extendable
    • Extendable.add_extension()
    • Extendable.get_extension()
    • Extendable.get_extensions()
    • Extendable.has_extensions()
• py3dtiles.extension module
  • Extension
    • Extension.to_dict()
• py3dtiles.feature_table module
  • Feature
    • Feature.from_array()
    • Feature.from_values()
    • Feature.to_array()
  • FeatureTable
    • FeatureTable.feature()
    • FeatureTable.from_array()
    • FeatureTable.from_features()
    • FeatureTable.nb_points()
    • FeatureTable.to_array()
  • FeatureTableBody
    • FeatureTableBody.colors()
    • FeatureTableBody.from_array()
    • FeatureTableBody.from_features()
    • FeatureTableBody.positions()
    • FeatureTableBody.to_array()
  • FeatureTableHeader
    • FeatureTableHeader.from_array()
    • FeatureTableHeader.from_dtype()
    • FeatureTableHeader.to_array()
    • FeatureTableHeader.to_json()
  • SemanticPoint
    • SemanticPoint.BATCH_ID
    • SemanticPoint.NONE
    • SemanticPoint.NORMAL
    • SemanticPoint.NORMAL_OCT16P
    • SemanticPoint.POSITION
    • SemanticPoint.POSITION_QUANTIZED
    • SemanticPoint.RGB
    • SemanticPoint.RGB565
    • SemanticPoint.RGBA
• py3dtiles.gltf module
  • GlTF
    • GlTF.CHUNK_HEADER_LENGTH
    • GlTF.HEADER_LENGTH
    • GlTF.from_array()
    • GlTF.from_binary_arrays()
    • GlTF.to_array()
  • compute_binary()
  • compute_header()
• py3dtiles.info module
  • init_parser()
  • main()
  • print_b3dm_info()
  • print_pnts_info()
• py3dtiles.merger module
  • build_tileset_quadtree()
  • extract_content_uris()
  • init()
  • init_parser()
  • is_tileset_inside()
  • main()
  • merge()
  • quadtree_split()
  • remove_tileset()
• py3dtiles.pnts module
  • Pnts
    • Pnts.from_array()
    • Pnts.from_features()
  • PntsBody
    • PntsBody.from_array()
    • PntsBody.to_array()
  • PntsHeader
    • PntsHeader.BYTE_LENGTH
    • PntsHeader.from_array()
    • PntsHeader.sync()
    • PntsHeader.to_array()
• py3dtiles.tile module
  • Tile
    • Tile.add_child()
    • Tile.get_children()
    • Tile.get_content()
    • Tile.get_content_uri()
    • Tile.get_direct_children()
    • Tile.get_refine_mode()
    • Tile.get_transform()
    • Tile.has_children()
    • Tile.set_content()
    • Tile.set_content_uri()
    • Tile.set_refine_mode()
    • Tile.set_transform()
    • Tile.sync_bounding_volume_with_children()
    • Tile.to_dict()
    • Tile.write_content()
• py3dtiles.tile_content module
  • TileContent
    • TileContent.save_as()
    • TileContent.sync()
    • TileContent.to_array()
    • TileContent.to_hex_str()
  • TileContentBody
    • TileContentBody.to_array()
  • TileContentHeader
    • TileContentHeader.from_array()
    • TileContentHeader.sync()
    • TileContentHeader.to_array()
  • TileContentType
    • TileContentType.BATCHED_3D_MODEL
    • TileContentType.POINT_CLOUD
    • TileContentType.UNKNOWN
• py3dtiles.tileset module
  • TileSet
    • TileSet.add_asset_extras()
    • TileSet.set_transform()
    • TileSet.to_dict()
    • TileSet.to_json()
    • TileSet.write_as_json()
    • TileSet.write_to_directory()
• py3dtiles.utils module
  • TileContentReader
    • TileContentReader.read_array()
    • TileContentReader.read_file()
  • convert_to_ecef()
  • str_to_CRS()
• py3dtiles.wkb_utils module
  • TriangleSoup
    • TriangleSoup.from_wkb_multipolygon()
    • TriangleSoup.get_bbox()
    • TriangleSoup.get_data_array()
    • TriangleSoup.get_normal_array()
    • TriangleSoup.get_position_array()
  • face_attribute_to_array()
  • parse()
  • triangulate()
  • unflatten()
  • vertex_attribute_to_array()