Commit fc3d2c58a1e05e5e2df925100c8700c148c1e502

Authored by Louis Baetens
1 parent 2478387c
Exists in master

UPDATE of the readme

Showing 1 changed file with 22 additions and 45 deletions   Show diff stats
PCC/readme.md
... ... @@ -6,56 +6,33 @@ The reference is created with ALCD beforehand. The current supported processing
6 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.
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) main file, calls the other files. Run the full PCC code.
10   -- [masks_conversion.py] used to convert the output from the 3 PC to the ALCD equivalent one.
11   -- [find_chain_directory_paths]
  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.
  11 +- [masks_conversion.py](http://tully.ups-tlse.fr/baetensl/clouds_detection/blob/master/PCC/masks_conversion.py)
  12 +used to convert the output from the 3 PC to the ALCD equivalent one.
  13 +- [find_chain_directory_paths.py](http://tully.ups-tlse.fr/baetensl/clouds_detection/blob/master/PCC/find_chain_directory_paths.py)
  14 +to search for the paths of the chains outputs.
  15 +- [comparison.py](http://tully.ups-tlse.fr/baetensl/clouds_detection/blob/master/PCC/comparison.py)
  16 +compares the converted masks output by the PCs against the ALCD reference.
  17 +- [metrics_grapher.py](http://tully.ups-tlse.fr/baetensl/clouds_detection/blob/master/PCC/metrics_grapher.py)
  18 +Plot the metrics (accuracy, f1-score, recall, precision) for a scene, with the condition that the 3 PCs have been run on it.
  19 +- [alcd_labellisation_posttreatment.py](http://tully.ups-tlse.fr/baetensl/clouds_detection/blob/master/PCC/alcd_labellisation_posttreatment.py)
  20 +used to perform morphological operation on label GTiffs
  21 +- [png_converter.py](http://tully.ups-tlse.fr/baetensl/clouds_detection/blob/master/PCC/png_converter.py)
  22 +converts Gtiffs to pngs, and adds a text to them (PC name, location and date of the scene)
  23 +- [statistics_synthesis.py](http://tully.ups-tlse.fr/baetensl/clouds_detection/blob/master/PCC/statistics_synthesis.py)
  24 +gives global statistics on all the scenes. Needs to be run independantly.
  25 +- [pixels_features_analysis.py](http://tully.ups-tlse.fr/baetensl/clouds_detection/blob/master/PCC/pixels_features_analysis.py)
  26 +analyses the features values of the original image, given their ALCD reference class. It is now deprecated. Needs to be run independantly.
12 27  
13 28 ## Getting Started
14 29  
15   -These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
16   -
17   -### Prerequisites
18   -
19   -What things you need to install the software and how to install them
20   -
21   -```
22   -Give examples
23   -```
24   -
25   -### Installing
26   -
27   -A step by step series of examples that tell you how to get a development env running
28   -
29   -Say what the step will be
30   -
  30 +You can simply run
31 31 ```
32   -Give the example
33   -```
34   -
35   -And repeat
36   -
  32 +python all_run_pcc.py -l Arles -d 20171002 -b True
37 33 ```
38   -until finished
39   -```
40   -
41   -End with an example of getting some data out of the system or using it for a little demo
42   -
43   -## Running the tests
44   -
45   -Explain how to run the automated tests for this system
46   -
47   -### Break down into end to end tests
48   -
49   -Explain what these tests test and why
50   -
51   -```
52   -Give an example
53   -```
54   -
55   -### And coding style tests
56   -
57   -Explain what these tests test and why
58 34  
  35 +Then, once you did it for all the scenes, you can aggregate the results with
59 36 ```
60   -Give an example
  37 +python statistics_synthesis.py
61 38 ```
... ...