Prepare release.

NAMESPACE

@@ -67,13 +67,8 @@ export("%i^%")
 export("%i|%")
 export("frame<-")
 export(CLAHE)
-export(Image)
 export(LUT)
 export(ORBkeypoints)
-export(Queue)
-export(Stream)
-export(Video)
-export(VideoWriter)
 export(absdiff)
 export(adaptiveThreshold)
 export(add)
@@ -260,7 +255,12 @@ export(writeFrame)
 export(writeMulti)
 export(writerOuput)
 export(zeros)
+exportClasses(Image)
+exportClasses(Queue)
+exportClasses(Stream)
+exportClasses(Video)
 exportClasses(VideoStack)
+exportClasses(VideoWriter)
 import(ROpenCVLite)
 import(Rcpp)
 import(methods)

R/ImageClass.R

@@ -6,10 +6,11 @@
 #'
 #' @docType class
 #'
-#' @description \code{Image} objects are the base objects of the \pkg{\link{Rvision}}
-#'  package. They contain an \href{http://opencv.org/}{OpenCV} image that can
-#'  originate from an image file, an array, a video file or a video stream.
-#'  This image can be manipulated using the functions of \pkg{\link{Rvision}}.
+#' @description \code{Image} objects are the base objects of the
+#'  \pkg{\link{Rvision}} package. They contain an
+#'  \href{http://opencv.org/}{OpenCV} image that can originate from an image
+#'  file, an array, a video file or a video stream. This image can be
+#'  manipulated using the functions of \pkg{\link{Rvision}}.
 #'
 #' @slot depth A function returning the bit depth of the object.
 #'
@@ -34,7 +35,21 @@
 #' @seealso \code{\link{image}}, \code{\link{Video}}, \code{\link{Stream}}
 #'
 #' @export
-"Image"
+setClass("Image",
+  representation(
+    cpp = "C++Object"
+  ),
+  prototype(
+    cpp = NULL
+  ),
+  validity = function(object) {
+    if (is.null(object@cpp) || is(object@cpp, "Rcpp_Image")) {
+      return(TRUE)
+    } else {
+      return(FALSE)
+    }
+  }
+)
 
 
 #' @title Create an Object of Class \code{Image}

R/QueueClass.R

@@ -37,10 +37,24 @@
 #'
 #' @author Simon Garnier, \email{garnier@@njit.edu}
 #'
-#' @seealso \code{\link{Image}}, \code{\link{Video}}, \code{\link{Stream}}
+#' @seealso \code{\link{Video}}, \code{\link{Stream}}
 #'
 #' @export
-"Queue"
+setClass("Queue",
+  representation(
+    cpp = "C++Object"
+  ),
+  prototype(
+    cpp = NULL
+  ),
+  validity = function(object) {
+    if (is.null(object@cpp) || is(object@cpp, "Rcpp_Queue")) {
+      return(TRUE)
+    } else {
+      return(FALSE)
+    }
+  }
+)
 
 
 #' @title Create an Object of Class \code{Queue}

R/StreamClass.R

@@ -20,8 +20,25 @@
 #' @slot release Function to release the object from memory.
 #'
 #' @author Simon Garnier, \email{garnier@@njit.edu}
+#' 
+#' @seealso \code{\link{VideoWriter}}, \code{\link{Stream}}
+#' 
 #' @export
-"Stream"
+setClass("Stream",
+  representation(
+    cpp = "C++Object"
+  ),
+  prototype(
+    cpp = NULL
+  ),
+  validity = function(object) {
+    if (is.null(object@cpp) || is(object@cpp, "Rcpp_Stream")) {
+      return(TRUE)
+    } else {
+      return(FALSE)
+    }
+  }
+)
 
 
 #' @title Create an Object of Class \code{Stream}

R/VideoClass.R

@@ -31,7 +31,21 @@
 #' @author Simon Garnier, \email{garnier@@njit.edu}
 #'
 #' @export
-"Video"
+setClass("Video",
+  representation(
+    cpp = "C++Object"
+  ),
+  prototype(
+    cpp = NULL
+  ),
+  validity = function(object) {
+    if (is.null(object@cpp) || is(object@cpp, "Rcpp_Video")) {
+      return(TRUE)
+    } else {
+      return(FALSE)
+    }
+  }
+)
 
 
 #' @title Create an Object of Class \code{Video}

R/VideoStackClass.R

@@ -19,11 +19,12 @@
 #'
 #' @export
 setClass("VideoStack",
-         contains = "list",
-         slots = c(nframes = "numeric"),
-         prototype = structure(
-           list(),
-           nframes = numeric())
+  contains = "list",
+  slots = c(nframes = "numeric"),
+  prototype = structure(
+    list(),
+    nframes = numeric()
+  )
 )
 
 

R/VideoWriterClass.R

@@ -29,8 +29,23 @@
 #' @slot release Function to release the object from memory.
 #'
 #' @author Simon Garnier, \email{garnier@@njit.edu}
+#' 
 #' @export
-"VideoWriter"
+setClass("VideoWriter",
+  representation(
+    cpp = "C++Object"
+  ),
+  prototype(
+    cpp = NULL
+  ),
+  validity = function(object) {
+    if (is.null(object@cpp) || is(object@cpp, "Rcpp_VideoWriter")) {
+      return(TRUE)
+    } else {
+      return(FALSE)
+    }
+  }
+)
 
 
 #' @title Create an object of class \code{VideoWriter}

R/zzz.R

@@ -1,18 +1,15 @@
 #' @useDynLib Rvision, .registration = TRUE
 #' @import Rcpp
 #' @import methods
-#' @importFrom graphics arrows par plot rasterImage points symbols
-#' @importFrom stats median.default
 #' @import pbapply
 #' @import ROpenCVLite
+#' @importFrom graphics arrows par plot rasterImage points symbols
+#' @importFrom stats median.default
 #' @importFrom grDevices col2rgb
 
 ### Load package module ###
 Rcpp::loadModule("class_Image", TRUE)
 Rcpp::loadModule("class_Capture", TRUE)
-# Rcpp::loadModule("class_Video", TRUE)
-# Rcpp::loadModule("class_BufferedVideo", TRUE)
-# Rcpp::loadModule("class_Stream", TRUE)
 Rcpp::loadModule("class_VideoWriter", TRUE)
 Rcpp::loadModule("methods_Arithmetic", TRUE)
 Rcpp::loadModule("methods_Statistics", TRUE)

docs/pkgdown.yml

@@ -10,7 +10,7 @@ articles:
   z6_queue: z6_queue.html
   z7_stack: z7_stack.html
   z8_calib: z8_calib.html
-last_built: 2024-01-30T00:47Z
+last_built: 2024-01-30T15:18Z
 urls:
   reference: https://swarm-lab.github.io/Rvision/reference
   article: https://swarm-lab.github.io/Rvision/articles