Commit 9494c55522e8b4d25c438387c778ea991b86f8c3

Authored by Louis Baetens
1 parent 6eb336ec
Exists in master

UPDATE

Showing 1 changed file with 28 additions and 28 deletions   Show diff stats
ALCD/readme.md
... ... @@ -6,61 +6,61 @@ This readme describes quickly the use of each python file, the general use of th
6 6  
7 7 ## Description of each file
8 8 - [all_run_alcd.py](all_run_alcd.py)
9   -main file, calls the other files. Run the full ALCD code.
10   -\Called by: /
  9 +main file, calls the other files. Run the full ALCD code.
  10 +Called by: /
11 11  
12 12 - [L1C_band_composition.py](L1C_band_composition.py)
13   -creates the features of the full image, taking into account the original image, the cloud-free one and the DEM.
14   -\Called by: all_run_alcd.py, layers_creation.py
  13 +creates the features of the full image, taking into account the original image, the cloud-free one and the DEM.
  14 +Called by: all_run_alcd.py, layers_creation.py
15 15  
16 16 - [OTB_workflow.py](OTB_workflow.py)
17   -core of the program, relies heavily on OTB. Computes statistics on the image, trains a Random Forest, classifies the image.
18   -\Called by: all_run_alcd.py
  17 +core of the program, relies heavily on OTB. Computes statistics on the image, trains a Random Forest, classifies the image.
  18 +Called by: all_run_alcd.py
19 19  
20 20 - [confidence_map_exploitation.py](confidence_map_exploitation.py)
21   -creates the enhanced version of the confidence map. Also computes the evolution of the confidence and of the samples number across the iterations.
22   -\Called by: all_run_alcd.py, OTB_workflow.py
  21 +creates the enhanced version of the confidence map. Also computes the evolution of the confidence and of the samples number across the iterations.
  22 +Called by: all_run_alcd.py, OTB_workflow.py
23 23  
24 24 - [contour_from_labeled.py](contour_from_labeled.py)
25   -creates the contours of the classes from the classification map.
26   -\Called by: OTB_workflow.py
  25 +creates the contours of the classes from the classification map.
  26 +Called by: OTB_workflow.py
27 27  
28 28 - [expand_point_region.py](expand_point_region.py)
29   -increases the number of samples by taking their neighborhood.
30   -\Called by: masks_preprocessing.py
  29 +increases the number of samples by taking their neighborhood.
  30 +Called by: masks_preprocessing.py
31 31  
32 32 - [find_directory_names.py](find_directory_names.py)
33   -gets the path of the L1C directory, and check if the dates given by the user are valid.
34   -\Called by: all_run_alcd.py, L1C_band_composition.py
  33 +gets the path of the L1C directory, and check if the dates given by the user are valid.
  34 +Called by: all_run_alcd.py, L1C_band_composition.py
35 35  
36 36 - [layers_creation.py](layers_creation.py)
37   -generates empty shapefiles layer, one for each class, so the user can populate them afterwards.
38   -\Called by: all_run_alcd.py
  37 +generates empty shapefiles layer, one for each class, so the user can populate them afterwards.
  38 +Called by: all_run_alcd.py
39 39  
40 40 - [masks_preprocessing.py](masks_preprocessing.py)
41   -calls other codes to augment the samples quantity and merge them into one shapefile, and split them between a training and validation set.
42   -\Called by: all_run_alcd.py
  41 +calls other codes to augment the samples quantity and merge them into one shapefile, and split them between a training and validation set.
  42 +Called by: all_run_alcd.py
43 43  
44 44 - [merge_shapefiles.py](merge_shapefiles.py)
45   -merge multiple shapefiles into one, and gives a class number to each point based on the shapefile it comes from.
46   -\Called by: confidence_map_exploitation.py, masks_preprocessing.py
  45 +merge multiple shapefiles into one, and gives a class number to each point based on the shapefile it comes from.
  46 +Called by: confidence_map_exploitation.py, masks_preprocessing.py
47 47  
48 48 - [metrics_exploitation.py](metrics_exploitation.py)
49   -computes various metrics, including accuracy and f1-score for the k-fold.
50   -\Called by: all_run_alcd.py
  49 +computes various metrics, including accuracy and f1-score for the k-fold.
  50 +Called by: all_run_alcd.py
51 51  
52 52 - [quicklook_generator.py](quicklook_generator.py)
53 53 generates quicklooks of all the dates in the L1C directory for given locations.
54   -\Called by: /
  54 +Called by: /
55 55  
56 56 - [split_samples.py](split_samples.py)
57   -separates point from a shapefile in two different shapefiles (training and validation sets).
58   -Also used to split into k different sets, for the k-fold cross-validation. \
59   -\Called by: masks_preprocessing.py
  57 +separates point from a shapefile in two different shapefiles (training and validation sets).
  58 +Also used to split into k different sets, for the k-fold cross-validation.
  59 +Called by: masks_preprocessing.py
60 60  
61 61 - [synthese_alcd_runs.py](synthese_alcd_runs.py)
62   -makes a synthesis of the scenes proceeded with ALCD.\
63   -\Called by: /
  62 +makes a synthesis of the scenes proceeded with ALCD.
  63 +Called by: /
64 64  
65 65  
66 66 ## Getting Started
... ...