Skip to content

Commit

Permalink
update readme with new vanilla input method
Browse files Browse the repository at this point in the history
  • Loading branch information
gabrielfelipeg committed Jul 11, 2019
1 parent 5a7434c commit 9a0ee50
Showing 1 changed file with 4 additions and 36 deletions.
40 changes: 4 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,54 +39,22 @@ Umbu has one optional flag:
python main.py -um AEMMF.tif 0.5 -chunk=100000000 -type=linearWithIndifference 1 0.5
```

Umbu and Fast Promethee only support linear and linearWithIndifference functions and pixels Not-a-Number are treated as out of the zone of study.
Vanilla supports:

### Txt Format
The input data should be specified in two directories; one describes the evaluation of the alternatives to each considered criterion, the other describes the preference function to compare alternatives.

In the alternatives directory, the user should add a file to each criterion, following the `NAME_OF_CRITERION.input` convention. These files indicate the evaluation of each alternative according to the criterion specified, in a matrix format, separated by an empty space and new lines separator.

The second directory, which specifies the preference functions, should have a file to each criterion, using the `NAME_OF_CRITERION.meta` convention. Each file should follow the pattern:
```
weight
function_name
parameters
is_max
```
In which `weight` is the value of weight of the criterion specified, `function_name` is the name of the function, `parameters` are the parameters, separated by an empty space, for the specific function, and `is_max indicates` if in the comparison greater values are desired over the smaller ones (0 if smaller values are desired, 1 for greater values).

Example:
```
0.2
level
0.5 1
1
```

We support all the prefence functions described in the literature. See below how each one of them should be declared in the `function_name` parameter:

```
Usual => usual
Quasi (U-shape) => quasi
Linear (V-shape) => linear
Level => level
Linear with Indifference => linearWithIndifference
Gaussian => gaussian
```

For the optimized version, we support the Linear shape (as the proposed method is restricted to Linear functions). Note that, however, our implementation only supports linear comparison, one can use the parameter `p = 0` and linear comparison will behave usual comparison.

#### Out of Zone of Study
Umbu and Fast Promethee only support linear and linearWithIndifference functions.

In cases where not all of the alternatives must be counted to calculate the Flow, it is possible to ignore them by using "nan" (case sensitive) in the `NAME_OF_CRITERION.input` files.
#### Out of Zone of Study

Example:
```
nan 2.0 nan
3.5 4.8 6.5
nan nan 5.7
```
The alternative is determined by row and column in the matrix, so "nan" must be in the same positions to all criterion matrix.
You can use Not-a-Number instead of value of alternative, this alternatives will not be considered. This can be useful if you need run Promethee to calculate a subregion of Tiff file.

## References

Expand Down

0 comments on commit 9a0ee50

Please sign in to comment.