Skip to content

Commit bf91ff8

Browse files
committed
docs: minor update
1 parent 7172fe3 commit bf91ff8

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

docs/sec_interface.rst

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,31 @@ Range:
9595
3. guess optimal indentation depth: The optimal indentation depth
9696
is guessed using the :ref:`E(δ)-curve <sec_ui_fd_tab_edelta>`.
9797

98+
Suppress residuals near contact point:
99+
This option multiplies the residuals with a linear ramp, left and right
100+
of the contact point. The ramp has a value of 0 at the contact point
101+
and a value of 1 at the distance defined by the controls. All other
102+
residuals or not changed.
103+
This feature was designed for biological samples, where the physical
104+
tip-sample interactions near the "contact point" are not well-understood
105+
:cite:`Mueller19nanite`. The contributions near the contact point are
106+
suppressed to give the remainder of the indentation curve more weight.
107+
108+
Ancillary Parameters:
109+
Ancillary parameters (not shown in the screenshot here), are parameters
110+
that are defined in the fitting model. They are computed prior to the
111+
fit and can be set as fitting parameters. Standard models usually do
112+
not have ancillary parameters.
113+
114+
Initial Parameters:
115+
These are the parameters set initially during fitting. In the table, you
116+
may choose which parameters should remain fixed during fitting, what
117+
the initial values should be, and in which interval this value may be
118+
varied.
119+
120+
Results:
121+
The fit results of the varied parameters are shown here.
122+
98123

99124
.. _sec_ui_fd_tab_edelta:
100125

0 commit comments

Comments
 (0)