README.md 2.08 KB
Newer Older
Luc Hermitte's avatar
Luc Hermitte committed
1
# General
Luc Hermitte's avatar
Luc Hermitte committed
2

Luc Hermitte's avatar
Luc Hermitte committed
3
[![Build Status](https://travis-ci.org/orfeotoolbox/remote-module-template.svg?branch=master)](https://travis-ci.org/orfeotoolbox/remote-module-template)
Luc Hermitte's avatar
Luc Hermitte committed
4

Luc Hermitte's avatar
Luc Hermitte committed
5 6 7 8
This is an Orfeo Toolbox (https://www.orfeo-toolbox.org/) remote module that
provides support applications for
[S1Tiling chain](https://gitlab.orfeo-toolbox.org/s1-tiling/s1tiling).

Luc Hermitte's avatar
Luc Hermitte committed
9
It is designed to work with OTB >= 7.0
Luc Hermitte's avatar
Luc Hermitte committed
10 11 12 13 14

This module can be built as a remote module or as a standalone module

The module provides the following applications:

Luc Hermitte's avatar
Luc Hermitte committed
15 16 17
- MultitempFilteringFilter: that implements Quegan speckle filter for
  SAR Images.
- MultitempFilteringOutcore: that computes the outcore of the filter.
Luc Hermitte's avatar
Luc Hermitte committed
18 19 20 21 22 23 24

# Getting Started

## Compiling from sources...

### ...Alongside OTB
This module can either be compiled alongside your OTB compilation. To do so,
Luc Hermitte's avatar
Luc Hermitte committed
25
copy `S1TilingSupportApplications.remote.cmake` into your
Luc Hermitte's avatar
Luc Hermitte committed
26 27 28 29 30 31 32 33 34 35 36 37 38
`{your_otb_sources_dir}/Modules/Remote` directory.

### ...Independently
Or it could be compiled independently, given you have an OTB
installation that permits the compilation of external modules.

First prepare your environment

```bash
mypath=~/where/i/want/to/work
cd "${mypath}"
mkdir -p S1TilingApps/build
cd S1TilingApps
Luc Hermitte's avatar
Luc Hermitte committed
39
git clone https://gitlab.orfeo-toolbox.org/s1-tiling/S1TilingSupportApplications
Luc Hermitte's avatar
Luc Hermitte committed
40
```
Luc Hermitte's avatar
Luc Hermitte committed
41 42 43 44 45

And then compile and install

```bash
cd build
Luc Hermitte's avatar
Luc Hermitte committed
46
cmake ../S1TilingSupportApplications -DOTB_BUILD_MODULE_AS_STANDALONE=ON -DCMAKE_INSTALL_PREFIX=~/where/i/want/to/install/S1TilingSupportApplications -DCMAKE_BUILD_TYPE=<Release or Debug>
Luc Hermitte's avatar
Luc Hermitte committed
47
make -j 4 && make install
Luc Hermitte's avatar
Luc Hermitte committed
48
```
Luc Hermitte's avatar
Luc Hermitte committed
49 50 51 52

#### Lmod bonus
Bonus: if you're using
[lmod](https://lmod.readthedocs.io/en/latest/index.html) `module`, a
Luc Hermitte's avatar
Luc Hermitte committed
53 54
modulefile for `S1TilingSupportApplications` will be automatically generated
into `~/where/i/want/to/install/S1TilingSupportApplications/modulefiles`.
Luc Hermitte's avatar
Luc Hermitte committed
55 56 57 58 59 60 61 62 63 64 65 66 67 68

If you have loaded your OTB environment through a `module load otb`
before running `cmake`, a dependency toward the actual `otb` module will
be automatically added.

# License

This software is distributed under the Apache License. Please see LICENSE for
details.

# Authors

Thierry Koleck (CNES)
Luc Hermitte (CSGroup)