francescofugazzi / 3dgsconverter Goto Github PK

3D Gaussian Splatting Converter: A tool to seamlessly convert 3DGS .ply files to a Cloud Compare-friendly format and vice-versa. Features include RGB coloring, density filtering, and flyer removal for enhanced point cloud editing.

License: MIT License

Python 100.00%

gaussian-splatting

3dgsconverter's Introduction

3D Gaussian Splatting Converter

A tool for converting 3D Gaussian Splatting .ply and .parquet files into a format suitable for Cloud Compare and vice-versa. Enhance your point cloud editing with added functionalities like RGB coloring, density filtering, and flyer removal.

Features

Format Conversion: Seamlessly switch between 3DGS .ply and Cloud Compare-friendly .ply formats. Now also .parquet is supported as input file.
RGB Coloring: Add RGB values to your point cloud for better visualization and editing in Cloud Compare.
Density Filtering: Focus on the dense regions of your point cloud by removing sparse data.
Flyer Removal: Get rid of unwanted outliers or floating points in your dataset. Especially useful when combined with the density filter due to its intensive nature.
Bounding box cropping: command for cropping point clouds to focus on specific regions.

Installation

There are two ways to install the 3D Gaussian Splatting Converter:

1. Direct Installation via pip:

Directly install the app from GitHub using pip. This method is straightforward and recommended for most users.

pip install git+https://github.com/francescofugazzi/3dgsconverter.git

2. Installation by Cloning the Repository::

If you prefer to clone the repository and install from the source, follow these steps:

git clone https://github.com/francescofugazzi/3dgsconverter
cd 3dgsconverter
pip install .

Usage

Here are some basic examples to get you started:

1. Conversion from 3DGS to Cloud Compare format with RGB addition:

3dgsconverter -i input_3dgs.ply -o output_cc.ply -f cc --rgb

2. Conversion from Cloud Compare format back to 3DGS::

3dgsconverter -i input_cc.ply -o output_3dgs.ply -f 3dgs

3. Applying Density Filter during conversion::

3dgsconverter -i input_3dgs.ply -o output_cc.ply -f cc --density_filter

4. Applying Density Filter and Removing floaters during conversion::

3dgsconverter -i input_3dgs.ply -o output_cc.ply -f cc --density_filter --remove_flyers

For a full list of parameters and their descriptions, you can use the -h or --help argument:

gsconverter -h

Debug Information

For detailed insights pass the --debug flag (or -d for short) when executing the script.

Contribute

Feel free to open issues or PRs if you have suggestions or improvements for this tool!

3dgsconverter's People

Contributors

Stargazers

Watchers

Forkers

41xu ammarkov andrewhazelden chenhuayou 93yh bluestupidyu

3dgsconverter's Issues

gsconverter->3dgsconverter ?

In the Usage paragraph in Readme, the command was 3dgsconverter when I installed from pip.

Dependencies not listed

Dependencies and their compatible versions not listed.

Brightness/lightlevels changes/are not persistent through conversion

Brightness/lightlevels change when converting. It's not majorly obvious at first glance, but it's there.

Example: https://i.imgur.com/sS3Xn6a.jpg

I'm trying to figure out how to use it on windows 10, I'm using pycharm but your commands don't seem to work!

Typo in example command in README

Says:
--remove fliers

Should be:
--remove_flyers

Errors in saving modified .ply in CloudCompare

Firstly, thank you for what will be an extremely useful tool to clean and modify 3dgs ply files using cloud compare.

My Issue:
After converting using the command line I imported into CC (2.13.0) and edited point cloud as expected.
On saving the modified point cloud as .ply (ASCII) in CC, many errors occur in process such as:

[PLY] 'Failed writing nz of vertex 713880 (ascii output: float)'
[PLY] 'Failed writing ny of vertex 713900 (ascii output: float)'
[PLY] 'Failed writing nx of vertex 714169 (ascii output: float)'
[PLY] 'Failed writing z of vertex 714237 (ascii output: float)'
[PLY] 'Failed writing y of vertex 714357 (ascii output: float)'
[PLY] 'Failed writing x of vertex 714358 (ascii output: float)'
[PLY] 'Failed writing scalar_scal_rot_3 of vertex 714439 (ascii output: float)'
[PLY] 'Failed writing scalar_scal_rot_2 of vertex 714500 (ascii output: float)'
[PLY] 'Failed writing scalar_scal_rot_1 of vertex 714649 (ascii output: float)'
[PLY] 'Failed writing scalar_scal_rot_0 of vertex 714678 (ascii output: float)'

...and so on, for many other parameters of vertex.

I tried exporting as BIN to the same end.

I jammed a fork into the enter key to see what happened if I accepted all the errors, CC kindly finished its process and logged

File '***.ply' saved successfully

On trying to convert output .ply, 3dgsconverter threw errors saying (obviously) PlyElementParseError("early end-of-line", ...

Am I missing something on the CC side to save the parameters?

gsconverter command not found

I have now tried both in linux and windows, I installed the package using pip follwing the readme, but when I try to run the given example commands, I get "gsconverter" command not found error, I added the path where pip showed me the library was installed to my path variable, but still no luck. Please let me know if I am missing something