Skip to content

Commit

Permalink
docs: update CLI documentation for coregistration
Browse files Browse the repository at this point in the history
  • Loading branch information
vschaffn committed Nov 12, 2024
1 parent 21cb32d commit 51d023c
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion doc/source/quick_start.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,14 +119,25 @@ The xDEM package can be executed from the command line using the `xdem` command.
### Usage

```bash
xdem path_ref path_sec [options]
xdem [options] [command] path_ref path_tba
```

### Options

- `--loglevel`: Set the logging level (default: INFO).
- `-v`, `--version`: Show the version of the xDEM package.

### Commands

- `coregister`: Perform a coregistration between `path_ref` and `path_tba`.

### Example
```bash
xdem coregister examples/data/Longyearbyen/data/DEM_2009_ref.tif examples/data/Longyearbyen/data/DEM_1990.tif
```
This will perform a coregistration between the reference DEM (`DEM_2009_ref.tif`) and the DEM to be aligned
(`DEM_1990.tif`), then save the aligned DEM and inlier mask as `aligned_dem.tif` and `inlier_mask.npy`, respectively.

(quick-gallery)=
## More examples

Expand Down

0 comments on commit 51d023c

Please sign in to comment.