Merge pull request #1 from loicgasser/prepare_release

Prepare release

.dockerignore

@@ -0,0 +1,10 @@
+CPotree.ipynb
+CPotree.sln
+CPotree.vcxproj.filters
+PotreeElevationProfile.vcxproj
+PotreeExtractRegion.vcxproj
+docs
+.gitignore
+.git
+README.md
+.vscode

.gitignore

@@ -4,4 +4,8 @@ obj
 CPotree.sdf
 .vs
 PotreeExtractRegion.vcxproj.user
-CPotree.vcxproj.user
+CPotree.vcxproj.user
+*.o
+PotreeElevationProfile
+PotreeExtractRegion
+.vscode

Dockerfile

@@ -0,0 +1,6 @@
+FROM debian:stretch
+RUN apt update && apt install -y build-essential libbsd0 libbsd-dev
+RUN mkdir -p /app/build
+COPY . /app
+WORKDIR /app
+CMD ["./scripts/make-package.sh"]

README.md

@@ -1,69 +1,92 @@
 # CPotree
-
-# write output to stdout
-.\PotreeElevationProfile.exe "D:/dev/pointclouds/converted/CA13/cloud.js" ^
- --coordinates "{693550.968, 3915914.169},{693890.618, 3916387.819},{694584.820, 3916458.180},{694786.239, 3916307.199}" ^
- --width 14.0 --min-level 0 --max-level 3 ^
- --stdout  
-
+
+## prepare release for debian
+
+## write output to stdout
+
+```bash
+.\PotreeElevationProfile "/dev/pointclouds/converted/CA13/cloud.js" \
+ --coordinates "{693550.968, 3915914.169},{693890.618, 3916387.819},{694584.820, 3916458.180},{694786.239, 3916307.199}" \
+ --width 14.0 --min-level 0 --max-level 3 \
+ --stdout
+
 # write output to "result.las"
-.\PotreeElevationProfile.exe "D:/dev/pointclouds/converted/CA13/cloud.js" ^
- --coordinates "{693550.968, 3915914.169},{693890.618, 3916387.819},{694584.820, 3916458.180},{694786.239, 3916307.199}" ^
- --width 14.0 --min-level 0 --max-level 3 ^
+.\PotreeElevationProfile "/dev/pointclouds/converted/CA13/cloud.js" \
+ --coordinates "{693550.968, 3915914.169},{693890.618, 3916387.819},{694584.820, 3916458.180},{694786.239, 3916307.199}" \
+ --width 14.0 --min-level 0 --max-level 3 \
  -o result.las
- 
+
 # write output to "result.potree"
-.\PotreeElevationProfile.exe "D:/dev/pointclouds/converted/CA13/cloud.js" ^
- --coordinates "{693550.968, 3915914.169},{693890.618, 3916387.819},{694584.820, 3916458.180},{694786.239, 3916307.199}" ^
- --width 14.0 --min-level 0 --max-level 3 ^
+.\PotreeElevationProfile "/dev/pointclouds/converted/CA13/cloud.js" \
+ --coordinates "{693550.968, 3915914.169},{693890.618, 3916387.819},{694584.820, 3916458.180},{694786.239, 3916307.199}" \
+ --width 14.0 --min-level 0 --max-level 3 \
  -o result.potree
- 
+
 # only write POSITION_CARTESIAN and INTENSITY attributes to the output
-.\PotreeElevationProfile.exe "D:/dev/pointclouds/converted/CA13/cloud.js" ^
- --coordinates "{693550.968, 3915914.169},{693890.618, 3916387.819},{694584.820, 3916458.180},{694786.239, 3916307.199}" ^
- --width 14.0 --min-level 0 --max-level 3 ^
+.\PotreeElevationProfile "/dev/pointclouds/converted/CA13/cloud.js" \
+ --coordinates "{693550.968, 3915914.169},{693890.618, 3916387.819},{694584.820, 3916458.180},{694786.239, 3916307.199}" \
+ --width 14.0 --min-level 0 --max-level 3 \
  --stdout --output-attributes POSITION_CARTESIAN RGB
 
-
 
-.\PotreeExtractRegion.exe ^
- "D:/dev/pointclouds/converted/CA13/cloud.js" ^
- --box "169.1, 0, 0, 0, 0, 169.1, 0, 0, 0, 0, 269.95, 0, 694704.38, 3916411, 17.9, 1" ^
- --min-level 0 ^
- --max-level 8 ^
+
+.\PotreeExtractRegion \
+ "/dev/pointclouds/converted/CA13/cloud.js" \
+ --box "169.1, 0, 0, 0, 0, 169.1, 0, 0, 0, 0, 269.95, 0, 694704.38, 3916411, 17.9, 1" \
+ --min-level 0 \
+ --max-level 8 \
  -o result.las
-
-
---output-format			POTREE, LAS, CSV
-						default: POTREE
-
---output-attributes		POSITION_CARTESIAN, POSITION_PROJECTED_PROFILE, COLOR_PACKED, RGB, RGBA, INTENSITY, CLASSIFICATION		
-						default: same as input point cloud + POSITION_PROJECTED_PROFILE
-
---stdout <format>		Write the result to stdout in the given file format.
-						<format>: POTREE, LAS, CSV
-
--o <file>				Write the result to the specified file. Supported file types are .potree, .las and .csv
-						default: no file
-
---estimate-workload		Instead of points, return an estimation of how many nodes and points will have to be processed.
 
---width					Width of the profile
 
---coordinates			Vertices of the polyline, specified as "{x1,y1},{x2,y2},..."
+--output-format       POTREE, LAS, CSV
+                      default: POTREE
+
+--output-attributes   POSITION_CARTESIAN, POSITION_PROJECTED_PROFILE, COLOR_PACKED, RGB, RGBA, INTENSITY, CLASSIFICATION
+                      default: same as input point cloud + POSITION_PROJECTED_PROFILE
+
+--stdout <format>     Write the result to stdout in the given file format.
+                      <format>: POTREE, LAS, CSV
+
+-o <file>             Write the result to the specified file. Supported file types are .potree, .las and .csv
+                      default: no file
+
+--estimate-workload   Instead of points, return an estimation of how many nodes and points will have to be processed.
 
---min-level				The result will contain points starting from this level 
+--width               Width of the profile
 
---max-level				The result will contain points up to this level
+--coordinates         Vertices of the polyline, specified as "{x1,y1},{x2,y2},..."
 
+--min-level           The result will contain points starting from this level
 
+--max-level           The result will contain points up to this level
+```
 
+## Create binary
 
+Via docker for debian stretch.
 
+```bash
+docker pull loicgasser/cpotree:debian-stretch
+mkdir -p $HOME/cpotree/build
+docker run \
+       -v $HOME/cpotree/build:/app/build:rw \
+       loicgasser/cpotree:debian-stretch
+ls -la $HOME/cpotree/build
+```
 
+Note that you will have to change the group and ownership of the resulting files.
 
+Create a local version of the libs
 
+```bash
+./scripts/make-package
+```
 
+### Local test
 
- 
+These are sample requests for me!
 
+```bash
+./build/PotreeElevationProfile "/home/loic/potree/output/cloud.js" --coordinates "{1850000, 670000},{1854999, 674999}" --width 14.0 --min-level 0 --max-level 3 --stdout
+./build/PotreeElevationProfile /home/loic/potree/output/cloud.js --coordinates "{1851000, 671000},{1852000, 672000},{1853999, 673999}" --width 10.0 --stdout
+```