Format helpers

Format detection and constants for Gaussian splatting PLY files.

gsply.formats.detect_format(file_path)

Detect PLY format type and SH degree.

Parameters:

file_path (str | Path) – Path to PLY file

Return type:

tuple[bool, int | None]

Returns:

Tuple of (is_compressed, sh_degree) where is_compressed is True if compressed format, False if uncompressed, and sh_degree is 0-3 for uncompressed, None for compressed or unknown

Example

>>> is_compressed, sh_degree = detect_format("model.ply")
>>> if is_compressed:
...     print("Compressed format")
... else:
...     print(f"Uncompressed SH degree {sh_degree}")

gsply.formats.get_sh_degree_from_property_count(property_count)

Get SH degree from property count.

Parameters:

property_count (int) – Number of properties in vertex element

Return type:

int | None

Returns:

SH degree (0-3) or None if unknown