Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
yudgugger authored Jun 26, 2024
1 parent cad377d commit 810cfa7
Showing 1 changed file with 0 additions and 1 deletion.
1 change: 0 additions & 1 deletion doc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -506,7 +506,6 @@ Following the first processing step (see section <a href="https://github.com/CEA
<ul align="justify" width="100%">
<li>Processing parameters for the 1st step are stored in a JSON file named <code>datacube_to_nanoloop_s1_params.json</code>, created with <code>create_json_res</code> or <code>copy_json_res</code> function of the script <code><a href="https://github.com/CEA-MetroCarac/PySSPFM/blob/main/PySSPFM/utils/path_for_runable.py">PySSPFM/utils/path_for_runable.py</a></code></li>
<li>Measurement parameters are contained in the csv measurement sheet that is copied into the result folder</li>
<li>The <code>parameters.txt</code> text file saves all the measurement parameters initially present in the measurement form, along with parameters and information about the first measurement processing step. It is generated by the function <code>save_parameters</code> of the script <code><a href="https://github.com/CEA-MetroCarac/PySSPFM/blob/main/PySSPFM/utils/datacube_to_nanoloop/file.py">utils/datacube_to_nanoloop/file.py</a></code>.</li>
<li>The <code>figs</code> directory contains all the figures generated during the first step, including various graphical representations of the raw data and segments managed by the <code><a href="https://github.com/CEA-MetroCarac/PySSPFM/blob/main/PySSPFM/utils/datacube_to_nanoloop/plot.py">utils/datacube_to_nanoloop/plot.py</a></code> script, phase histograms used for calibration managed by the <code><a href="https://github.com/CEA-MetroCarac/PySSPFM/blob/main/PySSPFM/utils/nanoloop/phase.py">utils/nanoloop/phase.py</a></code> script, and phase, amplitude, piezoresponse and eventually resonance frequency and quality factor nanoloops managed by the <code><a href="https://github.com/CEA-MetroCarac/PySSPFM/blob/main/PySSPFM/utils/nanoloop/plot.py">utils/nanoloop/plot.py</a></code> scripts.</li>
<li>The <code>nanoloops</code> directory contains the processed data following the first step of processing in the extracted measure of amplitude, phase and eventually resonance frequency nanoloops, eventually with uncertainties as a function of polarization voltage, both in off and on field modes, for each measurement file. It can also contain scalar information associated with the segment (topography, adhesion, calculated phase offset ...). This directory is generated using the functions <code>sort_nanoloop_data</code> and <code>save_nanoloop_file</code> of the script located in <code><a href="https://github.com/CEA-MetroCarac/PySSPFM/blob/main/PySSPFM/utils/nanoloop/file.py">utils/nanoloop/file.py</a></code>.</li>
</ul>
Expand Down

0 comments on commit 810cfa7

Please sign in to comment.