diff --git a/README.md b/README.md index 947f60458644e89f77195471ffc63ec54b60b040..b66b5f1f089884be701050e56b7a5ae0455be9a8 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  ## 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: + + ### `removePeaks` ### `fill_novals` ### Saving functions