add hyperspace calorie detector

Author: Gin

SerialPrograms/Source/PokemonLZA/Inference/PokemonLZA_HyperspaceCalorieDetector.cpp

@@ -0,0 +1,61 @@
+/*  Hyperspace Calorie Detector
+ *
+ *  From: https://github.com/PokemonAutomation/
+ *
+ */
+
+#include "CommonFramework/ImageTools/ImageStats.h"
+#include "CommonFramework/VideoPipeline/VideoOverlay.h"
+#include "CommonFramework/VideoPipeline/VideoOverlayScopes.h"
+#include "CommonTools/Images/SolidColorTest.h"
+#include "CommonTools/OCR/OCR_NumberReader.h"
+#include "PokemonLZA_HyperspaceCalorieDetector.h"
+
+namespace PokemonAutomation{
+namespace NintendoSwitch{
+namespace PokemonLZA{
+
+
+HyperspaceCalorieDetector::HyperspaceCalorieDetector(Logger& logger)
+: m_logger(logger)
+, m_calorie_number_box{0.036, 0.118, 0.119, 0.059}
+{}
+
+void HyperspaceCalorieDetector::make_overlays(VideoOverlaySet& items) const{
+    items.add(COLOR_WHITE, m_calorie_number_box);
+}
+
+bool HyperspaceCalorieDetector::detect(const ImageViewRGB32& screen){
+    const ImageViewRGB32 calorie_image_crop = extract_box_reference(screen, m_calorie_number_box);
+
+    const bool text_inside_range = true;
+    const bool prioritize_numeric_only_results = true;
+    const size_t width_max = SIZE_MAX;
+    // The calorie crop includes the "," in Calorie numbers like "1,000".
+    // We have to use `min_digit_area` to filter out "," when doing OCR.
+    // The min digit area computation is that any dot with size smaller than calorie_image_crop.height()/5 is filtered out when OCR.
+    const size_t min_digit_area = calorie_image_crop.height()*calorie_image_crop.height() / 25;
+    m_calorie_number = 0;
+    int number = OCR::read_number_waterfill_multifilter(m_logger, calorie_image_crop,
+        {
+            {0xff808080, 0xffffffff},
+            {0xffa0a0a0, 0xffffffff},
+            {0xffc0c0c0, 0xffffffff},
+            {0xffe0e0e0, 0xffffffff},
+            {0xfff0f0f0, 0xffffffff},
+        },
+        text_inside_range, prioritize_numeric_only_results, width_max, min_digit_area
+    );
+    if (number <= 0 || number > 9999){
+        return false;
+    }
+    m_calorie_number = static_cast<uint16_t>(number);
+    return true;
+}
+
+
+
+
+}
+}
+}

SerialPrograms/Source/PokemonLZA/Inference/PokemonLZA_HyperspaceCalorieDetector.h

@@ -0,0 +1,47 @@
+/*  Hyperspace Calorie Detector
+ *
+ *  From: https://github.com/PokemonAutomation/
+ *
+ */
+
+#ifndef PokemonAutomation_PokemonLZA_HyperspaceCalorieDetector_H
+#define PokemonAutomation_PokemonLZA_HyperspaceCalorieDetector_H
+
+//#include <optional>
+#include "Common/Cpp/Color.h"
+#include "CommonFramework/ImageTools/ImageBoxes.h"
+#include "CommonFramework/VideoPipeline/VideoOverlayScopes.h"
+#include "CommonTools/VisualDetector.h"
+#include "CommonTools/InferenceCallbacks/VisualInferenceCallback.h"
+
+namespace PokemonAutomation{
+    class Logger;
+namespace NintendoSwitch{
+namespace PokemonLZA{
+
+
+class HyperspaceCalorieDetector : public StaticScreenDetector{
+public:
+    HyperspaceCalorieDetector(Logger& logger);
+
+    virtual void make_overlays(VideoOverlaySet& items) const override;
+
+    //  This is not const so that detectors can save/cache state.
+    virtual bool detect(const ImageViewRGB32& screen) override;
+
+    uint16_t calorie_number() const { return m_calorie_number; }
+
+private:
+    Logger& m_logger;
+    ImageFloatBox m_calorie_number_box;
+
+    uint16_t m_calorie_number = 0;
+};
+
+
+
+
+}
+}
+}
+#endif

SerialPrograms/Source/Tests/PokemonLZA_Tests.cpp

@@ -11,6 +11,7 @@
 #include "PokemonLZA/Inference/PokemonLZA_SelectionArrowDetector.h"
 #include "PokemonLZA/Inference/PokemonLZA_AlertEyeDetector.h"
 #include "PokemonLZA/Inference/PokemonLZA_MainMenuDetector.h"
+#include "PokemonLZA/Inference/PokemonLZA_HyperspaceCalorieDetector.h"
 #include "PokemonLZA/Inference/Boxes/PokemonLZA_BoxDetection.h"
 #include "PokemonLZA/Inference/Boxes/PokemonLZA_BoxInfoDetector.h"
 #include "PokemonLZA/Inference/Map/PokemonLZA_MapIconDetector.h"
@@ -597,5 +598,36 @@ int test_pokemonLZA_MapDetector(const ImageViewRGB32& image, bool target){
     return 0;
 }
 
+int test_pokemonLZA_HyperspaceCalorieDetector(const ImageViewRGB32& image, int expected_calorie){
+    // Expected filename format: <...>_<calorie_number>.png
+    // Where calorie_number is an integer in range [1, 9999]
+    // Examples:
+    //   calorie_100.png -> 100 calories
+    //   calorie_1500.png -> 1500 calories
+    //   calorie_9999.png -> 9999 calories
+
+    if (expected_calorie <= 0 || expected_calorie > 9999){
+        cerr << "Error: expected calorie must be in range [1, 9999], got " << expected_calorie << "." << endl;
+        return 1;
+    }
+
+    // Run detector
+    HyperspaceCalorieDetector detector(global_logger_command_line());
+    bool detected = detector.detect(image);
+
+    if (!detected){
+        cerr << "Error: detector failed to detect calorie number in image." << endl;
+        return 1;
+    }
+
+    uint16_t detected_calorie = detector.calorie_number();
+
+    cout << "Expected calorie: " << expected_calorie << ", Detected calorie: " << detected_calorie << endl;
+
+    TEST_RESULT_EQUAL((int)detected_calorie, expected_calorie);
+
+    return 0;
+}
+
 
 }

SerialPrograms/Source/Tests/PokemonLZA_Tests.h

@@ -43,6 +43,8 @@
 
 int test_pokemonLZA_MapDetector(const ImageViewRGB32& image, bool target);
 
+int test_pokemonLZA_HyperspaceCalorieDetector(const ImageViewRGB32& image, int expected_calorie);
+
  }
 
  #endif

SerialPrograms/Source/Tests/TestMap.cpp

@@ -303,6 +303,7 @@ const std::map<std::string, TestFunction> TEST_MAP = {
     {"PokemonLZA_OverworldPartySelectionDetector", std::bind(image_words_detector_helper, test_pokemonLZA_OverworldPartySelectionDetector, _1)},
     {"PokemonLZA_DirectionArrowDetector", std::bind(image_int_detector_helper, test_pokemonLZA_DirectionArrowDetector, _1)},
     {"PokemonLZA_MapDetector", std::bind(image_bool_detector_helper, test_pokemonLZA_MapDetector, _1)},
+    {"PokemonLZA_HyperspaceCalorieDetector", std::bind(image_int_detector_helper, test_pokemonLZA_HyperspaceCalorieDetector, _1)},
 };
 
 TestFunction find_test_function(const std::string& test_space, const std::string& test_name){

SerialPrograms/cmake/SourceFiles.cmake

@@ -1617,6 +1617,8 @@ file(GLOB LIBRARY_SOURCES
     Source/PokemonLZA/Inference/PokemonLZA_DialogDetector.h
     Source/PokemonLZA/Inference/PokemonLZA_HyperspaceRewardNameReader.cpp
     Source/PokemonLZA/Inference/PokemonLZA_HyperspaceRewardNameReader.h
+    Source/PokemonLZA/Inference/PokemonLZA_HyperspaceCalorieDetector.cpp
+    Source/PokemonLZA/Inference/PokemonLZA_HyperspaceCalorieDetector.h
     Source/PokemonLZA/Inference/PokemonLZA_MainMenuDetector.cpp
     Source/PokemonLZA/Inference/PokemonLZA_MainMenuDetector.h
     Source/PokemonLZA/Inference/PokemonLZA_OverworldPartySelectionDetector.cpp