Add function to compute Gabor kernels.

NAMESPACE

@@ -123,6 +123,7 @@ export(fps)
 export(frame)
 export(full)
 export(gaussianBlur)
+export(getGaborKernel)
 export(getPerspectiveTransform)
 export(getProp)
 export(getTextSize)

R/ImageClass.R

@@ -653,7 +653,7 @@ readMulti <- function(x, colorspace = "BGR") {
 }
 
 
-#' @title Wrtie a Multi-Page Image
+#' @title Write a Multi-Page Image
 #'
 #' @description \code{writeMulti} writes a list of \code{\link{Image}} objects
 #'  to a multi-page image.

R/filters.R

@@ -1363,3 +1363,42 @@ invert <- function(image, target = "new", in_place = NULL) {
     stop("Invalid target.")
   }
 }
+
+
+#' @title Gabor Filter Kernels
+#'
+#' @description \code{getGaborKernel} is a convenience function to create Gabor
+#'  kernels that can be used to filter images with \code{\link{filter2D}}.
+#'
+#' @param width The width in pixels of the kernel (default: 31).
+#'
+#' @param height The height in pixels of the kernel (default: 31).
+#'
+#' @param sigma The standard deviation of the Gaussian envelope (default: 5).
+#'
+#' @param theta The orientation of the normal to the parallel stripes of a Gabor
+#'  function (default: \code{\link{pi}}).
+#'
+#' @param lambda The wavelength of the sinusoidal factor (default: 31).
+#'
+#' @param gamma The spatial aspect ratio (default: 5).
+#'
+#' @param psi A phase offset (default: 0).
+#'
+#' @return A matrix of Gabor coefficients.
+#'
+#' @note For more details about Gabor filter equations and parameters,
+#'  see: \href{https://en.wikipedia.org/wiki/Gabor_filter}{Gabor filter}.
+#'
+#' @author Simon Garnier, \email{garnier@@njit.edu}
+#'
+#' @seealso \code{\link{filter2D}}
+#'
+#' @examples
+#' getGaborKernel()
+#'
+#' @export
+getGaborKernel <- function(width = 31, height = 31, sigma = 5, theta = pi,
+                           lambda = 31, gamma = 5, psi = 0) {
+  `_getGaborKernel`(width, height, sigma, theta, lambda, gamma, psi)
+}

docs/pkgdown.yml

@@ -8,7 +8,7 @@ articles:
   z4_inplace: z4_inplace.html
   z5_gpu: z5_gpu.html
   z6_queue: z6_queue.html
-last_built: 2022-09-01T18:20Z
+last_built: 2022-09-12T12:43Z
 urls:
   reference: https://swarm-lab.github.io/ROpenCVLite/reference
   article: https://swarm-lab.github.io/ROpenCVLite/articles