kmeans

sgoldenlab · Nov 26, 2024 · 8ed7fc6 · 8ed7fc6
1 parent ca21383
commit 8ed7fc6
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/simba/data_processors/circling_detector.py b/simba/data_processors/circling_detector.py
@@ -32,6 +32,10 @@ class CirclingDetector(ConfigReader):
 
         Circling is detected as `absent` when not present.
 
+    .. note::
+
+       We pass the names of the left and right ears, as the method will use body-parts to compute the `nape` location of the animal.
+
     :param Union[str, os.PathLike] data_dir: Path to directory containing pose-estimated body-part data in CSV format.
     :param Union[str, os.PathLike] config_path: Path to SimBA project config file.
     :param Optional[str] nose_name: The name of the pose-estimated nose body-part. Defaults to 'nose'.