Skip to content

Commit d01ef3c

Browse files
committed
updated readme and cli prompt
1 parent a9a0628 commit d01ef3c

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,18 @@
44
Automatically align polygons with gridded (raster) data such as images and surface models.
55

66
## Detail
7-
pixelshift is a CLI tool for automatic conflation of a polygon Shapefile with gridded data. The conflation aligns the geometry using Stochastic Gradient Descent (SGD) optimisaiton.
7+
pixelshift is a command-line interface (CLI) tool for automatic conflation of a polygon Shapefile with grid data such as images and surface models. The conflation aligns a 2D geometry using Stochastic Gradient Descent (SGD) optimisation.
88

9-
pixelshift inputGrid polygonsShapefile maxIterations
10-
displacementMagnitude numCores
9+
pixelshift inputGrid polygonsShapefile maxIterations displacementMagnitude numCores
1110

1211
The parameters are (order matters):
1312

1413
inputGrid = a geotiff.
1514
polygonsShapeFile = Shapefile of polygons in partial alignment with the inputGrid.
1615
maxIterations = number of iterations for SGD.
1716
displacementMagnitude = bound for random distribution used in SGD.
18-
numCores = number of cores used for the optimisation.
17+
numCores = number of cores used for the parallelisation of the optimisation.
18+
outputFilePath = path and name of output file (.shp) of adjusted features.
1919

2020
## Example usage
2121
pixelshift dsmSlopeFile.tif buildingPolygons.shp 100 2 4

win64/pixelshift.exe

22 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)