refactor: rename resolution enum to model and update initialization method

SensuiYagi · SensuiYagi · commit 9975e7019fea · 2025-08-06T15:46:01.000+09:00
diff --git a/tools/include/retinify/tools/pipeline.hpp b/tools/include/retinify/tools/pipeline.hpp
@@ -12,8 +12,8 @@
 namespace retinify::tools
 {
 /// @brief
-/// The resolution options for stereo matching pipelines.
-enum class Resolution : std::uint8_t
+/// The model options for stereo matching pipelines.
+enum class Model : std::uint8_t
 {
     /// height=320, width=640
     SMALL,
@@ -36,12 +36,12 @@ class RETINIFY_API StereoMatchingPipeline
     auto operator=(StereoMatchingPipeline &&other) noexcept -> StereoMatchingPipeline & = delete;
 
     /// @brief
-    /// Initializes the stereo matching pipeline with the specified processing resolution.
-    /// @param resolution
-    /// The processing resolution to use for the stereo matching pipeline.
+    /// Initializes the stereo matching pipeline with the specified processing model.
+    /// @param model
+    /// The processing model to use for the stereo matching pipeline.
     /// @return
     /// A Status object indicating whether initialization succeeded.
-    [[nodiscard]] auto Initialize(Resolution resolution = Resolution::LARGE) noexcept -> Status;
+    [[nodiscard]] auto Initialize(Model model = Model::LARGE) noexcept -> Status;
 
     /// @brief
     /// Runs the stereo matching pipeline.
@@ -53,6 +53,9 @@ class RETINIFY_API StereoMatchingPipeline
     /// The output disparity map as a `cv::Mat`.
     /// @return
     /// A Status object indicating whether the operation succeeded.
+    /// @note
+    /// Input images are resized internally, so as long as the left and right
+    /// images share the same dimensions, their original sizes don’t matter.
     [[nodiscard]] auto Run(const cv::Mat &leftImage, const cv::Mat &rightImage, cv::Mat &disparity) const noexcept -> Status;
 
     /// @brief
@@ -68,6 +71,9 @@ class RETINIFY_API StereoMatchingPipeline
     /// If the value is less than or equal to 0, the check will be skipped.
     /// @return
     /// A Status object indicating whether the operation succeeded.
+    /// @note
+    /// Input images are resized internally, so as long as the left and right
+    /// images share the same dimensions, their original sizes don’t matter.
     [[nodiscard]] auto RunWithLeftRightConsistencyCheck(const cv::Mat &leftImage, const cv::Mat &rightImage, cv::Mat &disparity, //
                                                         float maxDisparityDifference = 1.0F) const noexcept -> Status;
 
diff --git a/tools/src/pipeline.cpp b/tools/src/pipeline.cpp
@@ -62,24 +62,24 @@ static inline auto LRConsistencyCheck(const cv::Mat &leftDisparity, const cv::Ma
     return true;
 }
 
-auto StereoMatchingPipeline::Initialize(Resolution resolution) noexcept -> Status
+auto StereoMatchingPipeline::Initialize(Model model) noexcept -> Status
 {
-    switch (resolution)
+    switch (model)
     {
-    case Resolution::SMALL:
+    case Model::SMALL:
         matchingHeight_ = 320;
         matchingWidth_ = 640;
         break;
-    case Resolution::MEDIUM:
+    case Model::MEDIUM:
         matchingHeight_ = 480;
         matchingWidth_ = 640;
         break;
-    case Resolution::LARGE:
+    case Model::LARGE:
         matchingHeight_ = 720;
         matchingWidth_ = 1280;
         break;
     default:
-        LogError("Invalid resolution specified for LRConsistencyPipeline.");
+        LogError("Invalid model specified for StereoMatchingPipeline.");
         return Status{StatusCategory::USER, StatusCode::INVALID_ARGUMENT};
     }
 
diff --git a/tools/src/utils.cpp b/tools/src/utils.cpp
@@ -13,7 +13,7 @@ cv::Mat ColorizeDisparity(const cv::Mat &disparity, int maxDisparity)
     if (disparity.empty())
     {
         retinify::LogError("Disparity map is empty.");
-        return cv::Mat::zeros(disparity.size(), CV_32FC1);
+        return cv::Mat();
     }
 
     cv::Mat coloredDisparity;

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ cv::Mat ColorizeDisparity(const cv::Mat &disparity, int maxDisparity)`
`13`	`13`	`if (disparity.empty())`
`14`	`14`	`{`
`15`	`15`	`retinify::LogError("Disparity map is empty.");`
`16`		`- return cv::Mat::zeros(disparity.size(), CV_32FC1);`
	`16`	`+ return cv::Mat();`
`17`	`17`	`}`
`18`	`18`
`19`	`19`	`cv::Mat coloredDisparity;`