Commit 26a333715c8d92b9aa0703c8c240c13c6bc50f25

Authored by Louis Baetens
1 parent fc3d2c58
Exists in master

UPDATE of the readme

Showing 1 changed file with 11 additions and 2 deletions   Show diff stats
PCC/readme.md
1 1 # Processing Chains Comparator (PCC)
2 2  
3   -This tools allows the user to compare the output of cloud detection processing chain against a reference.
  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 the use of each python file, the general use of the tool is described in the user manual 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 in the parent directory.
7 7  
8 8 ## Description of each file
9 9 - [all_run_pcc.py](http://tully.ups-tlse.fr/baetensl/clouds_detection/blob/master/PCC/all_run_pcc.py)
10 10 main file, calls the other files. Run the full PCC code.
  11 +Called by: /
11 12 - [masks_conversion.py](http://tully.ups-tlse.fr/baetensl/clouds_detection/blob/master/PCC/masks_conversion.py)
12 13 used to convert the output from the 3 PC to the ALCD equivalent one.
  14 +Called by: all_run_pcc.py
13 15 - [find_chain_directory_paths.py](http://tully.ups-tlse.fr/baetensl/clouds_detection/blob/master/PCC/find_chain_directory_paths.py)
14 16 to search for the paths of the chains outputs.
  17 +Called by: all_run_pcc.py
15 18 - [comparison.py](http://tully.ups-tlse.fr/baetensl/clouds_detection/blob/master/PCC/comparison.py)
16 19 compares the converted masks output by the PCs against the ALCD reference.
  20 +Called by: all_run_pcc.py
17 21 - [metrics_grapher.py](http://tully.ups-tlse.fr/baetensl/clouds_detection/blob/master/PCC/metrics_grapher.py)
18 22 Plot the metrics (accuracy, f1-score, recall, precision) for a scene, with the condition that the 3 PCs have been run on it.
  23 +Called by: all_run_pcc.py
19 24 - [alcd_labellisation_posttreatment.py](http://tully.ups-tlse.fr/baetensl/clouds_detection/blob/master/PCC/alcd_labellisation_posttreatment.py)
20 25 used to perform morphological operation on label GTiffs
  26 +Called by: masks_conversion.py
21 27 - [png_converter.py](http://tully.ups-tlse.fr/baetensl/clouds_detection/blob/master/PCC/png_converter.py)
22 28 converts Gtiffs to pngs, and adds a text to them (PC name, location and date of the scene)
  29 +Called by: all_run_pcc.py
23 30 - [statistics_synthesis.py](http://tully.ups-tlse.fr/baetensl/clouds_detection/blob/master/PCC/statistics_synthesis.py)
24 31 gives global statistics on all the scenes. Needs to be run independantly.
  32 +Called by: /
25 33 - [pixels_features_analysis.py](http://tully.ups-tlse.fr/baetensl/clouds_detection/blob/master/PCC/pixels_features_analysis.py)
26 34 analyses the features values of the original image, given their ALCD reference class. It is now deprecated. Needs to be run independantly.
  35 +Called by: all_run_pcc.py
27 36  
28 37 ## Getting Started
29 38  
... ...