Fix type of drawChArUcoBoard and add example

Author: basvandijk

opencv-extra/opencv-extra.cabal

@@ -43,7 +43,7 @@ library
       , inline-c          >= 0.5.5.5
       , inline-c-cpp      >= 0.1
       , linear            >= 1.20.4
-      , opencv            == 0.0.0
+      , opencv            >= 0.0.0.0
       , primitive         >= 0.6.1
       , template-haskell  >= 2.10
       , transformers      >= 0.4.2
@@ -96,6 +96,7 @@ test-suite doc-images-opencv-extra
       , directory
       , Glob
       , haskell-src-exts
+      , JuicyPixels
       , linear
       , opencv
       , opencv-extra

opencv-extra/opencv-extra.nix

@@ -22,6 +22,7 @@
 , directory
 , Glob
 , haskell-src-exts
+, JuicyPixels
 }:
 mkDerivation {
   pname = "opencv-extra";
@@ -66,6 +67,7 @@ mkDerivation {
     directory
     Glob
     haskell-src-exts
+    JuicyPixels
   ];
 
   libraryPkgconfigDepends = [ opencv3 ];

opencv-extra/src/OpenCV/Extra.hs

@@ -4,9 +4,9 @@ module OpenCV.Extra
   ( module Extra
   ) where
 
+import OpenCV.Extra.ArUco       as Extra
 import OpenCV.Extra.Bgsegm      as Extra
 import OpenCV.Extra.Tracking    as Extra
 import OpenCV.Extra.XFeatures2d as Extra
 import OpenCV.Extra.XPhoto      as Extra
 import OpenCV.Extra.XPhoto.WhiteBalancer  as Extra
-

opencv-extra/src/OpenCV/Extra/ArUco.hs

@@ -35,6 +35,7 @@ import "opencv" OpenCV.Internal.Exception
 import "base" Control.Monad (guard)
 import "primitive" Control.Monad.Primitive
 import "base" Data.Monoid ((<>))
+import "base" Data.Word ( Word8 )
 import qualified "vector" Data.Vector.Storable as SV
 import "base" Foreign.C
 import "base" Foreign.ForeignPtr (ForeignPtr, withForeignPtr)
@@ -47,7 +48,6 @@ import qualified "inline-c" Language.C.Inline.Unsafe as CU
 import "linear" Linear
 import "opencv" OpenCV
 import "opencv" OpenCV.Core.Types.Vec (Vec3d)
-import "opencv" OpenCV.Exception
 import "this" OpenCV.Extra.Internal.C.Inline ( openCvExtraCtx )
 import "this" OpenCV.Extra.Internal.C.Types
 import "opencv" OpenCV.Internal
@@ -490,19 +490,45 @@ getPredefinedDictionary name =
 
 {-| Draw a ChArUco board, ready to be printed and used for calibration/marke
 detection.
+
+Example:
+
+@
+drawChArUcoBoardImg
+    :: forall (w :: Nat) (h :: Nat)
+     . (w ~ 500, h ~ 500)
+    => Mat ('S '[ 'S h, 'S w]) ('S 1) ('S Word8)
+drawChArUcoBoardImg =
+    drawChArUcoBoard charucoBoard (Proxy :: Proxy w) (Proxy :: Proxy h)
+  where
+    charucoBoard :: ChArUcoBoard
+    charucoBoard = createChArUcoBoard 10 10 20 5 dictionary
+
+    dictionary :: Dictionary
+    dictionary = getPredefinedDictionary DICT_7X7_1000
+@
+
+<<doc/generated/examples/drawChArUcoBoardImg.png drawChArUcoBoardImg>>
 -}
-drawChArUcoBoard :: ChArUcoBoard -> Mat ('S '[h, w]) ('S 1) depth
-drawChArUcoBoard charucoBoard = unsafePerformIO $ do
+drawChArUcoBoard
+    :: (ToInt32 w, ToInt32 h)
+    => ChArUcoBoard
+    -> w -- ^ width
+    -> h -- ^ height
+    -> Mat ('S '[DSNat h, DSNat w]) ('S 1) ('S Word8)
+drawChArUcoBoard charucoBoard width height = unsafePerformIO $ do
     dst <- newEmptyMat
     withPtr charucoBoard $ \c'board ->
       withPtr dst $ \dstPtr ->
         [C.block| void {
           Mat & board = * $(Mat * dstPtr);
           Ptr<CharucoBoard> & charucoBoard = *$(Ptr_CharucoBoard * c'board);
-          charucoBoard->draw(cv::Size(500, 500), board);
+          charucoBoard->draw(cv::Size($(int32_t w), $(int32_t h)), board);
         }|]
     pure (unsafeCoerceMat dst)
-
+  where
+    w = toInt32 width
+    h = toInt32 height
 
 --------------------------------------------------------------------------------
 withPtrs