feat: allow to specify geometric correction factor k during fit

AFM-analysis · Jan 7, 2022 · 45bf36a · 45bf36a
1 parent dd7f92d
commit 45bf36a
Show file tree

Hide file tree

Showing 8 changed files with 506 additions and 4 deletions.
diff --git a/CHANGELOG b/CHANGELOG
@@ -1,3 +1,7 @@
+3.5.0
+ - feat: allow to specify geometric correction factor k during fit
+   (tip position is multiplied by k and contact point is modified
+   directly before and after fit)
 3.4.0
  - feat: allow to load fitting models from external Python files
  - enh: add method to deregister NaniteFitModels

diff --git a/docs/fitting_geometry.png b/docs/fitting_geometry.png
diff --git a/docs/fitting_geometry.svg b/docs/fitting_geometry.svg
diff --git a/docs/sec_develop.rst b/docs/sec_develop.rst
@@ -198,6 +198,15 @@ A few things should be noted:
   You may define your own ``residual`` function in your model file, but this
   is discouraged. The same is true for the ``model`` function, which defaults
   to :func:`nanite.model.residuals.model_direction_agnostic`.
+- You should always name the contact point parameter ``contact_point``.
+  Otherwise fitting will not work. If the :ref:`geometric correction factor
+  <sec_fitting_gcfk>` :math:`k` is used, the ``contact_point`` parameter is modified
+  internally before and after the fit. If you don't use ``contact_point``,
+  then your fit results will be wrong when using :math:`k \ne 1`.
+- You should always name the parameter describing the Young's modulus ``E``.
+  This is important for higher-level functionalities in e.g. PyJibe and for
+  plotting the Young's modulus over the indentation depth.
+
 
 Now it is time for a quick sanity check: