docs: update

docs/sec_code_reference.rst

@@ -74,6 +74,15 @@ Preprocessing
    :members:
    :undoc-members:
 
+.. _sec_ref_poc:
+
+Contact point estimation
+========================
+
+.. automodule:: nanite.poc
+   :members:
+   :undoc-members:
+
 
 .. _sec_ref_model:
 

docs/sec_getting_started.rst

@@ -99,6 +99,6 @@ You can find more examples in the :ref:`examples <sec_examples>` section.
 
 
 How to cite
------------
+===========
 If you use nanite in a scientific publication, please cite
 Müller et al., *BMC Bioinformatics* (2019) :cite:`Mueller19nanite`.

nanite/poc.py

@@ -9,6 +9,11 @@
 
 
 def compute_preproc_clip_approach(force):
+    """Clip the approach part (discard the retract part)
+
+    This POC preprocessing method may be applied before
+    applying the POC estimation method.
+    """
     # get data
     fg0 = np.array(force, copy=True)
     # Only use the (initial) approach part of the curve.

nanite/preproc.py

@@ -209,10 +209,10 @@ def correct_force_offset(apret):
         ]
         )
     def correct_tip_offset(apret, method="deviation_from_baseline"):
-        """Correct the offset of the tip position
+        """Estimate the point of contact
 
-        An estimate of the tip position is used to compute the
-        contact point.
+        An estimate of the contact point is subtracted from the
+        tip position.
         """
         cpid = poc.compute_poc(force=apret["force"], method=method)
         apret["tip position"] -= apret["tip position"][cpid]