Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update Readme with PotreeConverter Usage #572

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 31 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,36 @@ Potree.loadPointCloud(url).then(e => {
});

```

## PotreeConverter Usage
Converts las files to the potree file format. You can list multiple input files. If a directory is specified, all files inside the directory will be converted.
```
$ PotreeConverter -h
-i [ --source ] input files
-h [ --help ] prints usage
-p [ --generate-page ] Generates a ready to use web page with the given name.
-o [ --outdir ] output directory
-s [ --spacing ] Distance between points at root level. Distance halves each level.
-d [ --spacing-by-diagonal-fraction ] Maximum number of points on the diagonal in the first level (sets spacing). spacing = diagonal value
-l [ --levels ] Number of levels that will be generated. 0: only root, 1: root and its children, ...
-f [ --input-format ] Input format. xyz: cartesian coordinates as floats, rgb: colors as numbers, i: intensity as number
--color-range
--intensity-range
--output-format Output format can be BINARY, LAS or LAZ. Default is BINARY
-a [ --output-attributes ] can be any combination of RGB, INTENSITY and CLASSIFICATION. Default is RGB.
--scale Scale of the X, Y, Z coordinate in LAS and LAZ files.
--aabb Bounding cube as "minX minY minZ maxX maxY maxZ". If not provided it is automatically computed
--incremental Add new points to existing conversion
--overwrite Replace existing conversion at target directory
--source-listing-only Create a sources.json but no octree.
--projection Specify projection in proj4 format.
--list-of-files A text file containing a list of files to be converted.
--source Source file. Can be LAS, LAZ, PTX or PLY
--title Page title
--description Description to be shown in the page.
--edl-enabled Enable Eye-Dome-Lighting.
--show-skybox
--material RGB, ELEVATION, INTENSITY, INTENSITY_GRADIENT, RETURN_NUMBER, SOURCE, LEVEL_OF_DETAIL
```
# Alternatives

PotreeConverter 2.0 produces a very different format than previous iterations. If you find issues, you can still try previous converters or alternatives:
Expand Down Expand Up @@ -111,4 +140,4 @@ Performance comparison (Ryzen 2700, NVMe SSD):

# License

PotreeConverter is available under the [BSD 2-clause license](./LICENSE).
PotreeConverter is available under the [BSD 2-clause license](./LICENSE).