Information for tracking

Author: AntSimi

doc/custom_tracking.rst

@@ -1,3 +1,12 @@
 ==================
 Customize tracking
-==================
+==================
+
+
+Code my own tracking
+********************
+
+To use your own tracking method, you just need to create a class which inherit
+from :meth:`py_eddy_tracker.observations.observation.EddiesObservations` and set this class in yaml file like
+we see in the previous topic.
+

doc/run_tracking.rst

@@ -2,6 +2,10 @@
 Tracking
 ========
 
+
+Default method
+**************
+
 To run a tracking just create an yaml file with minimal specification (*FILES_PATTERN* and *SAVE_DIR*).
 
 Example of yaml
@@ -24,10 +28,45 @@ To run:
 
     EddyTracking conf.yaml -v DEBUG
 
+It will use default tracker:
+
+- No travel longer than 125 km between two observation
+- Amplitude and speed radius must be close to previous observation
+- In case of several candidate only closest is kept
+
 
 It will produce 4 files by run:
 
 - A file of correspondances which will contains all the information to merge all identifications file
 - A file which will contains all the observations which are alone
 - A file which will contains all the short track which are shorter than TRACK_DURATION_MIN
-- A file which will contains all the long track which are longer than TRACK_DURATION_MIN
+- A file which will contains all the long track which are longer than TRACK_DURATION_MIN
+
+
+Choose a tracker
+****************
+
+With yaml you could also select another tracker:
+
+.. code-block:: yaml
+
+    PATHS:
+      # Files produces with EddyIdentification
+      FILES_PATTERN: MY/IDENTIFICATION_PATH/Anticyclonic*.nc
+      SAVE_DIR: MY_OUTPUT_PATH
+
+    # Number of timestep for missing detection
+    VIRTUAL_LENGTH_MAX: 3
+    # Minimal time to consider as a full track
+    TRACK_DURATION_MIN: 10
+
+    CLASS:
+        # Give the module to import,
+        # must be available when you do "import module" in python
+        MODULE: py_eddy_tracker.featured_tracking.old_tracker_reference
+        # Give class name which must be inherit from
+        # py_eddy_tracker.observations.observation.EddiesObservations
+        CLASS: CheltonTracker
+
+This tracker is like described in CHELTON11[https://doi.org/10.1016/j.pocean.2011.01.002].
+Code is here :meth:`py_eddy_tracker.featured_tracking.old_tracker_reference`