clean up code

Author: Gin

SerialPrograms/Source/CommonTools/ImageMatch/WaterfillTemplateMatcher.h

@@ -52,8 +52,8 @@ class WaterfillTemplateMatcher{
     //  before computing RMSD.
     //  The part of the image template where alpha is 0 is not used to compare with the corresponding part in the input image.
     //  In case the image is invalid, return a large value.
-    //  It also calls the virtual function `check_image()` on the image.
-    //  If the function returns false, then return a large value. 
+    //  It also calls the virtual function `check_image(input_resolution, image)` on the image, where `input_resolution` is
+    //  the full screen resolution where the image is from. If the function returns false, then return a large value. 
     double rmsd(Resolution input_resolution, const ImageViewRGB32& image) const;
 
     //  Compute RMSD of the object on the image against the template.
@@ -86,6 +86,12 @@ class WaterfillTemplateMatcher{
     const ImageRGB32& image_template() const { return m_matcher->image_template(); }
 
 protected:
+    // This function is called inside each rmsd...() function before the actual RMSD computation.
+    // Derived classes can override this function to offer additional checks before computing RMSD.
+    // rmsd...() functions will proceed to RMSD computation if this function returns true. If false
+    // returns a large value.
+    // input_resolution: resolution of the full screen where the input image is from. This is useful for checks on
+    // input image pixel count or minimum size.
     virtual bool check_image(Resolution input_resolution, const ImageViewRGB32& image) const{ return true; };
     bool check_aspect_ratio(size_t candidate_width, size_t candidate_height) const;
     bool check_area_ratio(double candidate_area_ratio) const;

SerialPrograms/Source/CommonTools/Images/WaterfillUtilities.h

@@ -46,6 +46,7 @@ std::pair<PackedBinaryMatrix, size_t> remove_center_pixels(
 // checking aspect ratio thresholds, area thresholds and RMSD threshold.
 // If a template match is found, call the function `check_matched_object()` on it.
 //
+// input_resolution: full screen resolution. If WaterfillTemplateMatcher implements a `check_image()` member function
 // image: the image.
 // matcher: the template matcher holding the template. It is also responsible for checking aspect ratio thresholds.
 // filters: each filter is parameterized by min and max color thresholds for detected pixels. For each filter, the function checks

SerialPrograms/Source/PokemonLZA/Inference/PokemonLZA_DialogDetector.cpp

@@ -133,12 +133,12 @@ const static ImageFloatBox DIALOG_ARROW_BOX{0.727, 0.868, 0.037, 0.086};
 
 // detect the white arrow in blue dialog box and transparent battle dialog box
 bool detect_white_arrow(const ImageViewRGB32& screen, PokemonAutomation::ImageFloatBox& found_box){
-    double screen_rel_size = (screen.height() / 1080.0);
-    double screen_rel_size_2 = screen_rel_size * screen_rel_size;
+    const double screen_rel_size = (screen.height() / 1080.0);
+    const double screen_rel_size_2 = screen_rel_size * screen_rel_size;
 
-    double min_area_1080p = 150.0;
-    double rmsd_threshold = 120.0;
-    size_t min_area = size_t(screen_rel_size_2 * min_area_1080p);
+    const double min_area_1080p = 150.0;
+    const double rmsd_threshold = 120.0;
+    const size_t min_area = size_t(screen_rel_size_2 * min_area_1080p);
 
     const std::vector<std::pair<uint32_t, uint32_t>> FILTERS = {
         {0xffc0c0c0, 0xffffffff},
@@ -194,107 +194,6 @@ bool detect_blue_arrow(const ImageViewRGB32& screen, PokemonAutomation::ImageFlo
 
 
 
- 
-NormalDialogDetector::NormalDialogDetector(Logger& logger, VideoOverlay& overlay, bool stop_on_detected)
-    : VisualInferenceCallback("NormalDialogDetector")
-    , m_stop_on_detected(stop_on_detected)
-    , m_detected(false)
-    , m_title_green_line_box(0.224, 0.727, 0.016, 0.056)
-{}
-void NormalDialogDetector::make_overlays(VideoOverlaySet& items) const{
-    items.add(COLOR_RED, m_title_green_line_box);
-    items.add(COLOR_RED, DIALOG_ARROW_BOX);
-}
-bool NormalDialogDetector::process_frame(const ImageViewRGB32& frame, WallClock timestamp){
-    const double screen_rel_size = (frame.height() / 1080.0);
-    const double screen_rel_size_2 = screen_rel_size * screen_rel_size;
-
-    bool found_green_title_line = false;
-    bool found_black_arrow = false;
-
-    // Example green pixels from screenshots:
-    // 194,230,70
-    // 212,235,127
-    // 176,212,62
-    const std::vector<std::pair<uint32_t, uint32_t>> green_line_filters = {
-        {combine_rgb(160,200,55), combine_rgb(220, 240, 130)}
-    };
-  
-    const double min_green_line_size_1080P = 100.0;
-    const double green_line_rmsd_threshold = 50.0;
-    const size_t min_green_line_size = size_t(screen_rel_size_2 * min_green_line_size_1080P);
-    match_template_by_waterfill(
-        frame.size(),
-        extract_box_reference(frame, m_title_green_line_box), 
-        DialogTitleGreenLineMatcher::instance(),
-        green_line_filters,
-        {min_green_line_size, SIZE_MAX},
-        green_line_rmsd_threshold,
-        [&](Kernels::Waterfill::WaterfillObject& object) -> bool {
-            found_green_title_line = true;
-            return true;
-        }
-    );
-
-    // Example green pixels from screenshots:
-    // [37,34,6] [20,15,55]
-    // [39,42,58] [60,56,74] [50,49,63]
-    const std::vector<std::pair<uint32_t, uint32_t>> black_arrow_filters = {
-        {combine_rgb(0,0,0), combine_rgb(100, 100, 100)}
-    };
-  
-    const double min_black_arrow_size_1080P = 150.0;
-    const double black_arrow_rmsd_threshold = 120.0;
-    const size_t min_black_arrow_size = size_t(screen_rel_size_2 * min_black_arrow_size_1080P);
-    match_template_by_waterfill(
-        frame.size(),
-        extract_box_reference(frame, DIALOG_ARROW_BOX), 
-        DialogBlackArrowMatcher::instance(),
-        black_arrow_filters,
-        {min_black_arrow_size, SIZE_MAX},
-        black_arrow_rmsd_threshold,
-        [&](Kernels::Waterfill::WaterfillObject& object) -> bool {
-            found_black_arrow = true;
-            return true;
-        }
-    );
-
-    bool is_dialog_box = found_green_title_line & found_black_arrow;
-
-    if (is_dialog_box){
-        m_detected.store(is_dialog_box);
-    }
-
-    return is_dialog_box & m_stop_on_detected;
-
-
-    // size_t hits = 0;
-
-    // const ImageStats title_top = image_stats(extract_box_reference(frame, m_title_top));
-    // const ImageStats title_bottom = image_stats(extract_box_reference(frame, m_title_bottom));
-    // const ImageStats title_left = image_stats(extract_box_reference(frame, m_title_left));
-    // const ImageStats title_right = image_stats(extract_box_reference(frame, m_title_right));
-
-    // ImageStats top_white = image_stats(extract_box_reference(frame, m_top_white));
-    // hits += is_white(top_white, 480, 30) ? 1 : 0;
-
-    // ImageStats bottom_white = image_stats(extract_box_reference(frame, m_bottom_white));
-    // hits += is_white(bottom_white, 480, 30) ? 1 : 0;
-
-    // ImageStats left_white = image_stats(extract_box_reference(frame, m_left_white));
-    // hits += is_white(left_white, 480, 30) ? 1 : 0;
-
-    // ImageStats right_white = image_stats(extract_box_reference(frame, m_right_white));
-    // hits += is_white(right_white, 480, 30) ? 1 : 0;
-
-    // bool detected = hits == 5;
-    // m_detected.store(detected, std::memory_order_release);
-
-    // return detected && m_stop_on_detected;
-}
-
-
-
 FlatWhiteDialogDetector::FlatWhiteDialogDetector(Color color, VideoOverlay* overlay)
     : m_color(color)
     , m_overlay(overlay)

SerialPrograms/Source/PokemonLZA/Inference/PokemonLZA_DialogDetector.h

@@ -20,31 +20,6 @@ namespace PokemonAutomation{
 namespace NintendoSwitch{
 namespace PokemonLZA{
 
-//  Detect normal dialogue that is used in cases like when you talk to npcs in most situations.
-//
-//  Don't use this as there are lot of different dialogs. Use one of the newer
-//  ones below. This was done using official screenshots before launch before
-//  we knew there were so many different dialogs.
-//
-class NormalDialogDetector : public VisualInferenceCallback{
-public:
-    NormalDialogDetector(Logger& logger, VideoOverlay& overlay, bool stop_on_detected);
-
-    bool detected() const{
-        return m_detected.load(std::memory_order_acquire);
-    }
-
-    virtual void make_overlays(VideoOverlaySet& items) const override;
-    virtual bool process_frame(const ImageViewRGB32& frame, WallClock timestamp) override;
-
-private:
-    bool m_stop_on_detected;
-    std::atomic<bool> m_detected;
-    ImageFloatBox m_title_green_line_box;
-};
-
-
-
 
 // Common white dialog box
 class FlatWhiteDialogDetector : public StaticScreenDetector{

SerialPrograms/Source/Tests/PokemonLZA_Tests.h

@@ -18,8 +18,6 @@
 
  class ImageViewRGB32;
 
- 
- int test_pokemonZLA_NormalDialogBoxDetector(const ImageViewRGB32& image, bool target);
 
  int test_pokemonLZA_FlatWhiteDialogDetector(const ImageViewRGB32& image, bool target);
 

SerialPrograms/Source/Tests/TestMap.cpp

@@ -288,7 +288,6 @@ const std::map<std::string, TestFunction> TEST_MAP = {
     {"PokemonSV_MapFlyMenuDetector", std::bind(image_bool_detector_helper, test_pokemonSV_MapFlyMenuDetector, _1)},
     {"PokemonSV_SandwichPlateDetector", std::bind(image_words_detector_helper, test_pokemonSV_SandwichPlateDetector, _1)},
     {"PokemonSV_RecentlyBattledDetector", std::bind(image_bool_detector_helper, test_pokemonSV_RecentlyBattledDetector, _1)},
-    {"PokemonLZA_NormalDialogBoxDetector", std::bind(image_bool_detector_helper, test_pokemonZLA_NormalDialogBoxDetector, _1)},
     {"PokemonLZA_FlatWhiteDialogDetector", std::bind(image_bool_detector_helper, test_pokemonLZA_FlatWhiteDialogDetector, _1)},
     {"PokemonLZA_BlueDialogDetector", std::bind(image_bool_detector_helper, test_pokemonLZA_BlueDialogDetector, _1)},
     {"PokemonLZA_TransparentBattleDialogDetector", std::bind(image_bool_detector_helper, test_pokemonLZA_TransparentBattleDialogDetector, _1)},