Skip to content

API Reference

This section is generated from the splax source with mkdocstrings.

Module Description
splax render and the low-level project / rasterize / rasterize_depth / spherical_harmonics primitives
splax.mcmc Fixed-budget MCMC training utilities
splax.io 3DGS .ply load and write, and the parameter conversions around it

Parameters and activated arrays

Splat arrays come in two spaces, the unconstrained parameters and the activated arrays, both described under Rendering.

Function Space it takes
splax.render parameter
splax.io.load_ply / splax.io.write_ply parameter, stored verbatim
splax.mcmc.relocate / splax.mcmc.inject_noise parameter
splax.project activated
splax.rasterize / splax.rasterize_depth activated
splax.spherical_harmonics parameter coefficients, returns activated colors
splax.viewer.Viewer.add_splats parameter

splax.io.apply_activations and splax.io.invert_activations convert the geometry between the two spaces, splax.io.sh_to_rgb and splax.io.rgb_to_sh the base color, and splax.spherical_harmonics evaluates a full set of coefficients along a view direction.

Use the sidebar to browse the full generated reference.