added doc 1/n

sommerc · Oct 30, 2023 · 97b6680 · 97b6680
1 parent 6cb8916
commit 97b6680
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 5 deletions.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -7,15 +7,33 @@ In time-lapse imaging, a motorized microscope repeatedly captures images at spec
 
 The reasons are complex and manifold, but it typically results from error propagation in odometry, thermal expansion, and mechanical movement. Drift poses problems for subsequent image analysis and needs to be corrected.
 
-With Napari-correct-drift provides an extensible solution with similar functionality as Fiji’s Correct-3D-drift macro. It offers efficient cross-correlation using Fourier phase correlation, improved key frame selection, and outlier handling. Users are enabled to select ROIs to effectively stabilize given regions-of-interest in up-to 3D-multi-channel images.
+With Napari-correct-drift provides an extensible solution with similar functionality as Fiji’s Correct-3D-drift macro. It offers efficient cross-correlation using Fourier phase correlationmethod, improved key frame selection, and outlier handling. In Napari users can provide a regions-of-interest (ROI) to effectively stabilize objects in up-to 3D-multi-channel images. Additionally, estimated drifts can be exported, imported, or edited before applying the correction.
 
 When to use this plugin
 -----------------------
 
 #. Your time-series images or volumes exhibit *translational* drift, i. e. rigid movement, without rotation.
-#. Reference channel with fixed object (e. g. beads) visualizing the drift
+#. Reference channel with fixed object (e. g. fiducial) visualizing the drift
 #. Stabilizing objects of interest by using a ROIs
 
+Without Napari viewer
+---------------------
+
+Napari-Correct-Drift can also be used without starting the Napari viewer.
+
+.. code-block:: python
+
+   from napari_correct_drift import CorrectDrift
+
+   # multi-channel 2D-movie
+   cd = CorrectDrift(img_in, "tcyx")
+
+   # estimate drift table
+   drifts = cd.estimate_drift(t0=0, channel=0)
+
+   # correct drift
+   img_cor = cd.apply_drifts(drifts)
+
 Issues and contributing
 -----------------------
 

diff --git a/docs/source/introduction.rst b/docs/source/introduction.rst
@@ -1,10 +1,9 @@
 Introduction
 ============
 
-
 Example
 -------
 
-.. .. raw:: html
+.. raw:: html
 
-..     <video controls  width="640" src="_static/root_2_screencast.mp4"></video>
+    <video controls  width="640" src="https://seafile.ist.ac.at/f/de0c4cff54cf46dcbfbc/?dl=1"></video>