From a93027c4588b56355eca1b11053f4436065ce5dd Mon Sep 17 00:00:00 2001
From: Plougonven Erwan <eplougonven@uliege.be>
Date: Thu, 16 May 2024 15:33:50 +0000
Subject: [PATCH] Update README.md

---
 README.md | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 947f604..b66b5f1 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,7 @@
 
 ## Description
 
-Python code for converting profilometry data from a Veeco Wyko NT9100 into another format for further processing. In the Veeco software, the file should be saved in ASC format.
+Python code for reading profilometry data from a Veeco Wyko NT9100,  preprocessing it, and saving it into another format for further processing. In the Veeco software, the file should be saved in ASC format.
 
 ## Usage
 
@@ -15,7 +15,11 @@ Illustration of the steps the code performs, form left to right: reading, cleani
 ![Illustration of the three steps, reading, cleaning, filling.](assets/Example.png)
 
 ## Functions
+The data passed between function is stored in a [NumPy array](https://numpy.org/doc/stable/reference/arrays.html).
 ### `extract_Wyko_ASCII_data`
+Simple usage, the only parameter is the input file name. It outputs the profilometry data, what I call the height field `hfld`, as well as an intensity field `ifld`. Here's an illustration of the intensity field from the data shown in the example above:
+![Illustration of an intensity field.](assets/Example_intensity.png)
+
 ### `removePeaks`
 ### `fill_novals`
 ### Saving functions
-- 
GitLab