~sotirisp/parallaxis

92b197ab78f2afddfce3612f1836e4e3a85ca8ad — Sotiris Papatheodorou 1 year, 6 months ago 01e4d44
Update README
1 files changed, 17 insertions(+), 16 deletions(-)

M README.md
M README.md => README.md +17 -16
@@ 8,7 8,7 @@ Microsoft Kinect and the Intel Realsense series. Depth images are normalized to
make them easier to inspect visually and can optionally be displayed using a
colormap. It is also possible to normalize all images to the same range so that
there is no flickering when scrolling through them. Parallaxis requires a C++17
compliant compiler and OpenCV 3.
compliant compiler and OpenCV 3/4.





@@ 39,7 39,7 @@ compliant compiler and OpenCV 3.
or a combination of images and directories. If no arguments are provided then
any images in the current working directory will be shown.

``` bash
``` sh
parallaxis depth1.png depth2.pgm  # multiple images
parallaxis dir/                   # images in directory
parallaxis                        # images in current directory


@@ 49,35 49,36 @@ parallaxis -N dir/ depth/         # common normalization for images in 2 directo
Only grayscale images are normalized and shown using a colormap. RGB images are
shown unchanged.

Run `parallaxis --help` for more info about the command line arguments.
Run `man parallaxis` or `parallaxis --help` for more info about the program.



## Keybindings

| Action                      | Key(s)             |
|:--------------------        |:------------------:|
| Next image                  | `l`, `j`, `→`, `↓` |
| Previous image              | `h`, `k`, `←`, `↑` |
| Toggle normalization        | `n`                |
| Toggle common normalization | `N`                |
| Toggle colormap             | `c`                |
| Next colormap               | `C`                |
| Invert colors               | `i`                |
| Quit                        | `q`                |
| Action                      | Key(s)          |
| :-------------------------- | :-------------: |
| Next image                  | `l` `j` `→` `↓` |
| Previous image              | `h` `k` `←` `↑` |
| Toggle normalization        | `n`             |
| Toggle common normalization | `N`             |
| Toggle colormap             | `c`             |
| Next colormap               | `C`             |
| Invert colors               | `i`             |
| Quit                        | `q`             |



## Installation

Tested on Ubuntu 18.04 and Debian 10 Buster. Install the dependencies:
Tested on Ubuntu 18.04, Ubuntu 20.04 and Debian 10 Buster. Install the
dependencies:

- GCC 6+ or clang 6+ (for `std::filesystem` from C++17)
- OpenCV 3
- OpenCV 3/4

Compile the executable and install it along with the manpage:

``` bash
``` sh
make
sudo make install
```