Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jlblancoc committed Jan 9, 2017
1 parent ac6a8e2 commit f1da8ff
Showing 1 changed file with 52 additions and 2 deletions.
54 changes: 52 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,60 @@ An application for generating Digital Elevation Models (DEM) with Gaussian Marko
* A C++ compiler: GCC, clang, Visual C++ 2012 or above recommended.
* [MRPT](www.mrpt.org) >= 1.4.0

# Input file formats

* XYZ: Plain text file, each row containing one height (Z) measurement: (separated by whitespaces or commas `,`)

X Y Z

* XYZS: Plain text file, each row containing one height (Z) measurement and its uncertainty (standard deviation): (separated by whitespaces or commas `,`)

X Y Z STD_DEV

# Usage

* Show all available parameters:
dem-gmrf [--no-gui] [--skip-variance] [--std-obs <0.20>] [--std-prior
<1.0>] [-c <0.01>] [-o <demgmrf_out>] [-r <1.0>] -i <xyz.txt>
[--] [--version] [-h]


Where:

--no-gui
Do not show the graphical window with the 3D visualization at end.

--skip-variance
Skip variance estimation

--std-obs <0.20>
Default standard deviation of each XYZ point observation [meters]

--std-prior <1.0>
Standard deviation of the prior constraints (`smoothness` or
`tolerance`of the terrain) [meters]

-c <0.01>, --checkpoint-ratio <0.01>
Ratio (1.0=all,0.0=none) of data points to use as checkpoints. They
will not be inserted in the DEM. (Default=0.01)

-o <demgmrf_out>, --output-prefix <demgmrf_out>
Prefix for all output filenames

-r <1.0>, --resolution <1.0>
Resolution (side length) of each cell in the DEM (meters)

-i <xyz.txt>, --input <xyz.txt>
(required) Input dataset file: X,Y,Z points in plain text format

--, --ignore_rest
Ignores the rest of the labeled arguments following this flag.

--version
Displays version information and exits.

dem-gmrf --help
-h, --help
Displays usage information and exits.


0 comments on commit f1da8ff

Please sign in to comment.