Commit c1d537d4295ac14fcb6806ef44c01dd2ceb7b64f

Authored by Louis Baetens
1 parent 9494c555
Exists in master

UPDATE

Showing 2 changed files with 33 additions and 21 deletions   Show diff stats
ALCD/readme.md
... ... @@ -64,7 +64,7 @@ Called by: /
64 64  
65 65  
66 66 ## Getting Started
67   -You need to set the parameters as described in the [user manual](ALCD_user_manual.pdf).
  67 +You need to set the parameters as described in the [user manual](../ALCD_user_manual.pdf).
68 68 Then you can simply run
69 69 ```
70 70 python all_run_alcd.py -f true -s 0 -l Arles -d 20171002 -c 20171005
... ...
PCC/readme.md
... ... @@ -3,39 +3,39 @@
3 3 This tools allows the user to compare the output of cloud detection processing chains against a reference.
4 4 The reference is created with ALCD beforehand. The current supported processing chains (PC) are MAJA, Sen2Cor and Fmask
5 5  
6   -This readme describes quickly the use of each python file, the general use of the tool is described in the [user manual](http://tully.ups-tlse.fr/baetensl/clouds_detection/blob/master/ALCD_user_manual.pdf) in the parent directory.
  6 +This readme describes quickly the use of each python file, the general use of the tool is described in the [user manual](../ALCD_user_manual.pdf) in the parent directory.
7 7  
8 8 ## Description of each file
9   -- [all_run_pcc.py](http://tully.ups-tlse.fr/baetensl/clouds_detection/blob/master/PCC/all_run_pcc.py)
10   -main file, calls the other files. Run the full PCC code.
  9 +- [all_run_pcc.py](all_run_pcc.py)
  10 +main file, calls the other files. Run the full PCC code.
11 11 Called by: /
12   -- [masks_conversion.py](http://tully.ups-tlse.fr/baetensl/clouds_detection/blob/master/PCC/masks_conversion.py)
13   -used to convert the output from the 3 PC to the ALCD equivalent one.
  12 +- [masks_conversion.py](masks_conversion.py)
  13 +used to convert the output from the 3 PC to the ALCD equivalent one.
14 14 Called by: all_run_pcc.py
15   -- [find_chain_directory_paths.py](http://tully.ups-tlse.fr/baetensl/clouds_detection/blob/master/PCC/find_chain_directory_paths.py)
16   -to search for the paths of the chains outputs.
  15 +- [find_chain_directory_paths.py](find_chain_directory_paths.py)
  16 +to search for the paths of the chains outputs.
17 17 Called by: all_run_pcc.py
18   -- [comparison.py](http://tully.ups-tlse.fr/baetensl/clouds_detection/blob/master/PCC/comparison.py)
19   -compares the converted masks output by the PCs against the ALCD reference.
  18 +- [comparison.py](comparison.py)
  19 +compares the converted masks output by the PCs against the ALCD reference.
20 20 Called by: all_run_pcc.py
21   -- [metrics_grapher.py](http://tully.ups-tlse.fr/baetensl/clouds_detection/blob/master/PCC/metrics_grapher.py)
22   -plots the metrics (accuracy, f1-score, recall, precision) for a scene, with the condition that the 3 PCs have been run on it.
  21 +- [metrics_grapher.py](metrics_grapher.py)
  22 +plots the metrics (accuracy, f1-score, recall, precision) for a scene, with the condition that the 3 PCs have been run on it.
23 23 Called by: all_run_pcc.py
24   -- [alcd_labellisation_posttreatment.py](http://tully.ups-tlse.fr/baetensl/clouds_detection/blob/master/PCC/alcd_labellisation_posttreatment.py)
25   -used to perform morphological operations on labeled GTiffs
  24 +- [alcd_labellisation_posttreatment.py](alcd_labellisation_posttreatment.py)
  25 +used to perform morphological operations on labeled GTiffs
26 26 Called by: masks_conversion.py
27   -- [png_converter.py](http://tully.ups-tlse.fr/baetensl/clouds_detection/blob/master/PCC/png_converter.py)
28   -converts Gtiffs to pngs, and adds a text to them (PC name, location and date of the scene)
  27 +- [png_converter.py](png_converter.py)
  28 +converts Gtiffs to pngs, and adds a text to them (PC name, location and date of the scene)
29 29 Called by: all_run_pcc.py
30   -- [statistics_synthesis.py](http://tully.ups-tlse.fr/baetensl/clouds_detection/blob/master/PCC/statistics_synthesis.py)
31   -gives global statistics on all the scenes. Needs to be run independantly.
  30 +- [statistics_synthesis.py](statistics_synthesis.py)
  31 +gives global statistics on all the scenes.
32 32 Called by: /
33   -- [pixels_features_analysis.py](http://tully.ups-tlse.fr/baetensl/clouds_detection/blob/master/PCC/pixels_features_analysis.py)
34   -analyses the features values of the original image, given their ALCD reference class. It is now deprecated. Needs to be run independantly.
  33 +- [pixels_features_analysis.py](pixels_features_analysis.py)
  34 +analyses the features values of the original image, given their ALCD reference class. It is now deprecated.
35 35 Called by: all_run_pcc.py
36 36  
37 37 ## Getting Started
38   -You need to set the parameters as described in the [user manual](http://tully.ups-tlse.fr/baetensl/clouds_detection/blob/master/ALCD_user_manual.pdf).
  38 +You need to set the parameters as described in the [user manual](../ALCD_user_manual.pdf).
39 39 Then you can simply run
40 40 ```
41 41 python all_run_pcc.py -l Arles -d 20171002 -b True
... ... @@ -45,3 +45,15 @@ Once you did it for all the scenes, you can aggregate the results with
45 45 ```
46 46 python statistics_synthesis.py
47 47 ```
  48 +
  49 +
  50 +## Outputs
  51 +For each scene, a `root_scene/` output dir will be created.
  52 +In this directory you will find after having run PCC, among other things:
  53 +- `root_scene/Binary_classif/` --- contains the conversion of the original masks to the binary valid/invalid classification
  54 +- `root_scene/Binary_difference/` --- contains the comparison of the binary masks against the ALCD reference
  55 +- `root_scene/Multi_classif/` --- contains the conversion of the original masks to the ALCD multi-class classification equivalent
  56 +- `root_scene/Multi_difference/` --- contains the comparison of the multi-class masks against the ALCD reference
  57 +- `root_scene/Original_data/` --- contains the original masks, realigned and resampled to the desired resolution
  58 +- `root_scene/Out/` --- contains the .png of the binary differences, the quicklook from the original image and the contours of the ALCD reference overlayed on it
  59 +- `root_scene/Statistics/` --- contains the statistics from the differences
... ...