API Reference

Complete API documentation for all public functions, classes, and modules. All public symbols are re-exported through the top-level gsply package, so you can import gsply and access everything from a single namespace.

Core Modules

Core I/O

Reader module

Functions: - gsply.plyread() — Read PLY files (auto-detects format) - gsply.read_uncompressed() — Read uncompressed PLY files - gsply.read_compressed() — Read compressed PLY files - gsply.decompress_from_bytes() — Decompress from bytes

SOG Reader module

Functions: - gsply.sogread() — Read SOG format files (requires gsply[sogs])

Writer module

Functions: - gsply.plywrite() — Write PLY files (auto-optimized) - gsply.write_uncompressed() — Write uncompressed PLY files - gsply.write_compressed() — Write compressed PLY files - gsply.compress_to_bytes() — Compress to bytes - gsply.compress_to_arrays() — Compress to arrays

Format helpers

Functions: - gsply.detect_format() — Detect PLY format and SH degree - gsply.get_sh_degree_from_property_count() — Get SH degree from property count

Data Containers

GSData container

Classes: - gsply.GSData — CPU NumPy container

Utilities

Utility helpers

Functions: - gsply.sh2rgb() — Convert spherical harmonics to RGB colors - gsply.rgb2sh() — Convert RGB colors to spherical harmonics - gsply.sigmoid() — Compute sigmoid function - gsply.logit() — Compute logit function

Constants: - gsply.SH_C0 — Spherical harmonic DC coefficient normalization constant

GPU Acceleration

PyTorch Integration

GPU I/O Functions: - gsply.plyread_gpu() — Read compressed PLY directly to GPU - gsply.plywrite_gpu() — Write GSTensor to compressed PLY using GPU compression

GSTensor Data Container: - gsply.GSTensor — GPU PyTorch container

Quick Reference

Reading & Writing

  • gsply.plyread() — Read PLY files (auto-detects format)

  • gsply.plywrite() — Write PLY files (auto-optimized)

  • gsply.sogread() — Read SOG format files (requires gsply[sogs])

  • gsply.plyread_gpu() — Read compressed PLY directly to GPU

  • gsply.plywrite_gpu() — Write GSTensor to compressed PLY using GPU compression

  • gsply.compress_to_bytes() — Compress to bytes

  • gsply.decompress_from_bytes() — Decompress from bytes

Data Containers

  • gsply.GSData — CPU NumPy container

  • gsply.GSTensor — GPU PyTorch container

Format Detection

  • gsply.detect_format() — Detect PLY format and SH degree