From 51d2a65b985021183d8cb08b36cf4a17d397c927 Mon Sep 17 00:00:00 2001
From: Tristan Walter <twalter@orn.mpg.de>
Date: Fri, 30 Oct 2020 16:38:00 +0100
Subject: [PATCH] * silencing debug messages * updating docs

---
 Application/src/tracker/VideoOpener.cpp | 10 +++++++++-
 docs/parameters_tgrabs.rst              |  8 ++++----
 2 files changed, 13 insertions(+), 5 deletions(-)

diff --git a/Application/src/tracker/VideoOpener.cpp b/Application/src/tracker/VideoOpener.cpp
index 71dc7d3..e02915b 100644
--- a/Application/src/tracker/VideoOpener.cpp
+++ b/Application/src/tracker/VideoOpener.cpp
@@ -115,9 +115,13 @@ VideoOpener::VideoOpener() {
                 guard.unlock();
                 try {
                     auto path = ptr->_path;
+#ifndef NDEBUG
                     Debug("Removing stale buffer '%S'...", &path.str());
+#endif
                     ptr = nullptr;
+#ifndef NDEBUG
                     Debug("Removed stale buffer '%S'.", &path.str());
+#endif
                 } catch(const std::exception& e) {
                     Except("Exception while freeing stale buffer '%s'.", e.what());
                 }
@@ -125,12 +129,16 @@ VideoOpener::VideoOpener() {
                 
                 ++i;
             }
-            
+      
+#ifndef NDEBUG
             if(i)
                 Debug("Removed %d stale buffers", i);
+#endif
         }
         
+#ifndef NDEBUG
         Debug("Quit stale thread.");
+#endif
     });
     
     _horizontal = std::make_shared<gui::HorizontalLayout>();
diff --git a/docs/parameters_tgrabs.rst b/docs/parameters_tgrabs.rst
index b660fa9..4cb5e0e 100644
--- a/docs/parameters_tgrabs.rst
+++ b/docs/parameters_tgrabs.rst
@@ -34,7 +34,7 @@ TGrabs parameters
 	**default value:** 100
 
 
-	Number of samples taken to generate an average image. Usually has to be less if `average_method` is set to max.
+	Number of samples taken to generate an average image. Usually fewer are necessary for `average_method`s max, and min.
 
 	.. seealso:: :func:`average_method`, 
 
@@ -46,9 +46,9 @@ TGrabs parameters
 
 	**possible values:**
 		- `mean`: Sum all samples and divide by N.
-		- `mode`: Calculate a per-pixel median of the samples.
-		- `max`: Use a per-pixel minimum across samples.
-		- `min`: Use a per-pixel maximum across samples.
+		- `mode`: Calculate a per-pixel median of the samples to avoid noise. More computationally involved than mean, but often better results.
+		- `max`: Use a per-pixel minimum across samples. Usually a good choice for short videos with black backgrounds and individuals that do not move much.
+		- `min`: Use a per-pixel maximum across samples. Usually a good choice for short videos with white backgrounds and individuals that do not move much.
 
 	Determines the way in which the background samples are combined. The background generated in the process will be used to subtract background from foreground objects during conversion.
 
-- 
GitLab