gocv

package module
v0.30.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 23, 2022 License: Apache-2.0 Imports: 10 Imported by: 0

README

GoCV

GoCV

Go Reference CircleCI Build status AppVeyor Build status Go Report Card License

The GoCV package provides Go language bindings for the OpenCV 4 computer vision library.

The GoCV package supports the latest releases of Go and OpenCV (v4.5.5) on Linux, macOS, and Windows. We intend to make the Go language a "first-class" client compatible with the latest developments in the OpenCV ecosystem.

GoCV supports CUDA for hardware acceleration using Nvidia GPUs. Check out the CUDA README for more info on how to use GoCV with OpenCV/CUDA.

GoCV also supports Intel OpenVINO. Check out the OpenVINO README for more info on how to use GoCV with the Intel OpenVINO toolkit.

How to use

Hello, video

This example opens a video capture device using device "0", reads frames, and shows the video in a GUI window:

package main

import (
	"gocv.io/x/gocv"
)

func main() {
	webcam, _ := gocv.OpenVideoCapture(0)
	window := gocv.NewWindow("Hello")
	img := gocv.NewMat()

	for {
		webcam.Read(&img)
		window.IMShow(img)
		window.WaitKey(1)
	}
}
Face detect

GoCV

This is a more complete example that opens a video capture device using device "0". It also uses the CascadeClassifier class to load an external data file containing the classifier data. The program grabs each frame from the video, then uses the classifier to detect faces. If any faces are found, it draws a green rectangle around each one, then displays the video in an output window:

package main

import (
	"fmt"
	"image/color"

	"gocv.io/x/gocv"
)

func main() {
    // set to use a video capture device 0
    deviceID := 0

	// open webcam
	webcam, err := gocv.OpenVideoCapture(deviceID)
	if err != nil {
		fmt.Println(err)
		return
	}
	defer webcam.Close()

	// open display window
	window := gocv.NewWindow("Face Detect")
	defer window.Close()

	// prepare image matrix
	img := gocv.NewMat()
	defer img.Close()

	// color for the rect when faces detected
	blue := color.RGBA{0, 0, 255, 0}

	// load classifier to recognize faces
	classifier := gocv.NewCascadeClassifier()
	defer classifier.Close()

	if !classifier.Load("data/haarcascade_frontalface_default.xml") {
		fmt.Println("Error reading cascade file: data/haarcascade_frontalface_default.xml")
		return
	}

	fmt.Printf("start reading camera device: %v\n", deviceID)
	for {
		if ok := webcam.Read(&img); !ok {
			fmt.Printf("cannot read device %v\n", deviceID)
			return
		}
		if img.Empty() {
			continue
		}

		// detect faces
		rects := classifier.DetectMultiScale(img)
		fmt.Printf("found %d faces\n", len(rects))

		// draw a rectangle around each face on the original image
		for _, r := range rects {
			gocv.Rectangle(&img, r, blue, 3)
		}

		// show the image in the window, and wait 1 millisecond
		window.IMShow(img)
		window.WaitKey(1)
	}
}
More examples

There are examples in the cmd directory of this repo in the form of various useful command line utilities, such as capturing an image file, streaming mjpeg video, counting objects that cross a line, and using OpenCV with Tensorflow for object classification.

How to install

To install GoCV, you must first have the matching version of OpenCV installed on your system. The current release of GoCV requires OpenCV 4.5.5.

Here are instructions for Ubuntu, Raspian, macOS, and Windows.

Ubuntu/Linux

Installation

You can use make to install OpenCV 4.5.5 with the handy Makefile included with this repo. If you already have installed OpenCV, you do not need to do so again. The installation performed by the Makefile is minimal, so it may remove OpenCV options such as Python or Java wrappers if you have already installed OpenCV some other way.

Quick Install

First, change directories to where you want to install GoCV, and then use git to clone the repository to your local machine like this:

cd $HOME/folder/with/your/src/
git clone https://github.com/hybridgroup/gocv.git

Make sure to change $HOME/folder/with/your/src/ to where you actually want to save the code.

Once you have cloned the repo, the following commands should do everything to download and install OpenCV 4.5.5 on Linux:

cd gocv
make install

If you need static opencv libraries

make install BUILD_SHARED_LIBS=OFF

If it works correctly, at the end of the entire process, the following message should be displayed:

gocv version: 0.30.0
opencv lib version: 4.5.5

That's it, now you are ready to use GoCV.

Using CUDA with GoCV

See the cuda directory for information.

Using OpenVINO with GoCV

See the openvino directory for information.

Make Install for OpenVINO and Cuda

The following commands should do everything to download and install OpenCV 4.5.5 with CUDA and OpenVINO on Linux. Make sure to change $HOME/folder/with/your/src/ to the directory you used to clone GoCV:

cd $HOME/folder/with/gocv/
make install_all

If you need static opencv libraries

make install_all BUILD_SHARED_LIBS=OFF

If it works correctly, at the end of the entire process, the following message should be displayed:

gocv version: 0.30.0
opencv lib version: 4.5.5-openvino
cuda information:
  Device 0:  "GeForce MX150"  2003Mb, sm_61, Driver/Runtime ver.10.0/10.0
Complete Install

If you have already done the "Quick Install" as described above, you do not need to run any further commands. For the curious, or for custom installations, here are the details for each of the steps that are performed when you run make install.

First, change directories to where you want to install GoCV, and then use git to clone the repository to your local machine like this:

cd $HOME/folder/with/your/src/
git clone https://github.com/hybridgroup/gocv.git

Make sure to change $HOME/folder/with/your/src/ to where you actually want to save the code.

Install required packages

First, you need to change the current directory to the location where you cloned the GoCV repo, so you can access the Makefile:

cd $HOME/folder/with/your/src/gocv

Next, you need to update the system, and install any required packages:

make deps
Download source

Now, download the OpenCV 4.5.5 and OpenCV Contrib source code:

make download
Build

Build everything. This will take quite a while:

make build

If you need static opencv libraries

make build BUILD_SHARED_LIBS=OFF
Install

Once the code is built, you are ready to install:

make sudo_install
Verifying the installation

To verify your installation you can run one of the included examples.

First, change the current directory to the location of the GoCV repo:

cd $HOME/src/gocv.io/x/gocv

Now you should be able to build or run any of the examples:

go run ./cmd/version/main.go

The version program should output the following:

gocv version: 0.30.0
opencv lib version: 4.5.5
Cleanup extra files

After the installation is complete, you can remove the extra files and folders:

make clean
Custom Environment

By default, pkg-config is used to determine the correct flags for compiling and linking OpenCV. This behavior can be disabled by supplying -tags customenv when building/running your application. When building with this tag you will need to supply the CGO environment variables yourself.

For example:

export CGO_CPPFLAGS="-I/usr/local/include"
export CGO_LDFLAGS="-L/usr/local/lib -lopencv_core -lopencv_face -lopencv_videoio -lopencv_imgproc -lopencv_highgui -lopencv_imgcodecs -lopencv_objdetect -lopencv_features2d -lopencv_video -lopencv_dnn -lopencv_xfeatures2d"

Please note that you will need to run these 2 lines of code one time in your current session in order to build or run the code, in order to setup the needed ENV variables. Once you have done so, you can execute code that uses GoCV with your custom environment like this:

go run -tags customenv ./cmd/version/main.go
Docker

The project now provides Dockerfile which lets you build GoCV Docker image which you can then use to build and run GoCV applications in Docker containers. The Makefile contains docker target which lets you build Docker image with a single command:

make docker

By default Docker image built by running the command above ships Go version 1.16.5, but if you would like to build an image which uses different version of Go you can override the default value when running the target command:

make docker GOVERSION='1.15'
Running GUI programs in Docker on macOS

Sometimes your GoCV programs create graphical interfaces like windows eg. when you use gocv.Window type when you display an image or video stream. Running the programs which create graphical interfaces in Docker container on macOS is unfortunately a bit elaborate, but not impossible. First you need to satisfy the following prerequisites:

  • install xquartz. You can also install xquartz using homebrew by running brew cask install xquartz
  • install socat brew install socat

Note, you will have to log out and log back in to your machine once you have installed xquartz. This is so the X window system is reloaded.

Once you have installed all the prerequisites you need to allow connections from network clients to xquartz. Here is how you do that. First run the following command to open xquart so you can configure it:

open -a xquartz

Click on Security tab in preferences and check the "Allow connections" box:

app image

Next, you need to create a TCP proxy using socat which will stream X Window data into xquart. Before you start the proxy you need to make sure that there is no process listening in port 6000. The following command should not return any results:

lsof -i TCP:6000

Now you can start a local proxy which will proxy the X Window traffic into xquartz which acts a your local X server:

socat TCP-LISTEN:6000,reuseaddr,fork UNIX-CLIENT:\"$DISPLAY\"

You are now finally ready to run your GoCV GUI programs in Docker containers. In order to make everything work you must set DISPLAY environment variables as shown in a sample command below:

docker run -it --rm -e DISPLAY=docker.for.mac.host.internal:0 your-gocv-app

Note, since Docker for MacOS does not provide any video device support, you won't be able run GoCV apps which require camera.

Alpine 3.7 Docker image

There is a Docker image with Alpine 3.7 that has been created by project contributor @denismakogon. You can find it located at https://github.com/denismakogon/gocv-alpine.

Raspbian

Installation

We have a special installation for the Raspberry Pi that includes some hardware optimizations. You use make to install OpenCV 4.5.5 with the handy Makefile included with this repo. If you already have installed OpenCV, you do not need to do so again. The installation performed by the Makefile is minimal, so it may remove OpenCV options such as Python or Java wrappers if you have already installed OpenCV some other way.

Quick Install

First, change directories to where you want to install GoCV, and then use git to clone the repository to your local machine like this:

cd $HOME/folder/with/your/src/
git clone https://github.com/hybridgroup/gocv.git

Make sure to change $HOME/folder/with/your/src/ to where you actually want to save the code.

The following make command should do everything to download and install OpenCV 4.5.5 on Raspbian:

cd $HOME/folder/with/your/src/gocv
make install_raspi

If it works correctly, at the end of the entire process, the following message should be displayed:

gocv version: 0.30.0
opencv lib version: 4.5.5

That's it, now you are ready to use GoCV.

macOS

Installation

You can install OpenCV 4.5.5 using Homebrew.

If you already have an earlier version of OpenCV (3.4.x) installed, you should probably remove it before installing the new version:

brew uninstall opencv

You can then install OpenCV 4.5.5:

brew install opencv
pkgconfig Installation

pkg-config is used to determine the correct flags for compiling and linking OpenCV. You can install it by using Homebrew:

brew install pkgconfig
Verifying the installation

To verify your installation you can run one of the included examples.

First, change the current directory to the location of the GoCV repo:

cd $HOME/folder/with/your/src/gocv

Now you should be able to build or run any of the examples:

go run ./cmd/version/main.go

The version program should output the following:

gocv version: 0.30.0
opencv lib version: 4.5.5
Custom Environment

By default, pkg-config is used to determine the correct flags for compiling and linking OpenCV. This behavior can be disabled by supplying -tags customenv when building/running your application. When building with this tag you will need to supply the CGO environment variables yourself.

For example:

export CGO_CXXFLAGS="--std=c++11"
export CGO_CPPFLAGS="-I/usr/local/Cellar/opencv/4.5.5/include"
export CGO_LDFLAGS="-L/usr/local/Cellar/opencv/4.5.5/lib -lopencv_stitching -lopencv_superres -lopencv_videostab -lopencv_aruco -lopencv_bgsegm -lopencv_bioinspired -lopencv_ccalib -lopencv_dnn_objdetect -lopencv_dpm -lopencv_face -lopencv_photo -lopencv_fuzzy -lopencv_hfs -lopencv_img_hash -lopencv_line_descriptor -lopencv_optflow -lopencv_reg -lopencv_rgbd -lopencv_saliency -lopencv_stereo -lopencv_structured_light -lopencv_phase_unwrapping -lopencv_surface_matching -lopencv_tracking -lopencv_datasets -lopencv_dnn -lopencv_plot -lopencv_xfeatures2d -lopencv_shape -lopencv_video -lopencv_ml -lopencv_ximgproc -lopencv_calib3d -lopencv_features2d -lopencv_highgui -lopencv_videoio -lopencv_flann -lopencv_xobjdetect -lopencv_imgcodecs -lopencv_objdetect -lopencv_xphoto -lopencv_imgproc -lopencv_core"

Please note that you will need to run these 3 lines of code one time in your current session in order to build or run the code, in order to setup the needed ENV variables. Once you have done so, you can execute code that uses GoCV with your custom environment like this:

go run -tags customenv ./cmd/version/main.go

Windows

Installation

The following assumes that you are running a 64-bit version of Windows 10.

In order to build and install OpenCV 4.5.5 on Windows, you must first download and install MinGW-W64 and CMake, as follows.

MinGW-W64

Download and run the MinGW-W64 compiler installer from https://sourceforge.net/projects/mingw-w64/files/Toolchains%20targetting%20Win32/Personal%20Builds/mingw-builds/8.1.0/.

The latest version of the MinGW-W64 toolchain is 8.1.0, but any version from 8.X on should work.

Choose the options for "posix" threads, and for "seh" exceptions handling, then install to the default location c:\Program Files\mingw-w64\x86_64-8.1.0-posix-seh-rt_v6-rev0.

Add the C:\Program Files\mingw-w64\x86_64-8.1.0-posix-seh-rt_v6-rev0\mingw64\bin path to your System Path.

CMake

Download and install CMake https://cmake.org/download/ to the default location. CMake installer will add CMake to your system path.

OpenCV 4.5.5 and OpenCV Contrib Modules

The following commands should do everything to download and install OpenCV 4.5.5 on Windows:

chdir %GOPATH%\src\gocv.io\x\gocv
win_build_opencv.cmd

It might take up to one hour.

Last, add C:\opencv\build\install\x64\mingw\bin to your System Path.

Verifying the installation

Change the current directory to the location of the GoCV repo:

chdir %GOPATH%\src\gocv.io\x\gocv

Now you should be able to build or run any of the command examples:

go run cmd\version\main.go

The version program should output the following:

gocv version: 0.30.0
opencv lib version: 4.5.5

That's it, now you are ready to use GoCV.

Custom Environment

By default, OpenCV is expected to be in C:\opencv\build\install\include. This behavior can be disabled by supplying -tags customenv when building/running your application. When building with this tag you will need to supply the CGO environment variables yourself.

Due to the way OpenCV produces DLLs, including the version in the name, using this method is required if you're using a different version of OpenCV.

For example:

set CGO_CXXFLAGS="--std=c++11"
set CGO_CPPFLAGS=-IC:\opencv\build\install\include
set CGO_LDFLAGS=-LC:\opencv\build\install\x64\mingw\lib -lopencv_core455 -lopencv_face455 -lopencv_videoio455 -lopencv_imgproc455 -lopencv_highgui455 -lopencv_imgcodecs455 -lopencv_objdetect455 -lopencv_features2d455 -lopencv_video455 -lopencv_dnn455 -lopencv_xfeatures2d455 -lopencv_plot455 -lopencv_tracking455 -lopencv_img_hash455

Please note that you will need to run these 3 lines of code one time in your current session in order to build or run the code, in order to setup the needed ENV variables. Once you have done so, you can execute code that uses GoCV with your custom environment like this:

go run -tags customenv cmd\version\main.go

Android

There is some work in progress for running GoCV on Android using Gomobile. For information on how to install OpenCV/GoCV for Android, please see: https://gist.github.com/ogero/c19458cf64bd3e91faae85c3ac887481

See original discussion here: https://github.com/hybridgroup/gocv/issues/235

Profiling

Since memory allocations for images in GoCV are done through C based code, the go garbage collector will not clean all resources associated with a Mat. As a result, any Mat created must be closed to avoid memory leaks.

To ease the detection and repair of the resource leaks, GoCV provides a Mat profiler that records when each Mat is created and closed. Each time a Mat is allocated, the stack trace is added to the profile. When it is closed, the stack trace is removed. See the runtime/pprof documentation.

In order to include the MatProfile custom profiler, you MUST build or run your application or tests using the -tags matprofile build tag. For example:

go run -tags matprofile cmd/version/main.go

You can get the profile's count at any time using:

gocv.MatProfile.Count()

You can display the current entries (the stack traces) with:

var b bytes.Buffer
gocv.MatProfile.WriteTo(&b, 1)
fmt.Print(b.String())

This can be very helpful to track down a leak. For example, suppose you have the following nonsense program:

package main

import (
	"bytes"
	"fmt"

	"gocv.io/x/gocv"
)

func leak() {
	gocv.NewMat()
}

func main() {
	fmt.Printf("initial MatProfile count: %v\n", gocv.MatProfile.Count())
	leak()

	fmt.Printf("final MatProfile count: %v\n", gocv.MatProfile.Count())
	var b bytes.Buffer
	gocv.MatProfile.WriteTo(&b, 1)
	fmt.Print(b.String())
}

Running this program produces the following output:

initial MatProfile count: 0
final MatProfile count: 1
gocv.io/x/gocv.Mat profile: total 1
1 @ 0x40b936c 0x40b93b7 0x40b94e2 0x40b95af 0x402cd87 0x40558e1
#	0x40b936b	gocv.io/x/gocv.newMat+0x4b	/go/src/gocv.io/x/gocv/core.go:153
#	0x40b93b6	gocv.io/x/gocv.NewMat+0x26	/go/src/gocv.io/x/gocv/core.go:159
#	0x40b94e1	main.leak+0x21			/go/src/github.com/dougnd/gocvprofexample/main.go:11
#	0x40b95ae	main.main+0xae			/go/src/github.com/dougnd/gocvprofexample/main.go:16
#	0x402cd86	runtime.main+0x206		/usr/local/Cellar/go/1.11.1/libexec/src/runtime/proc.go:201

We can see that this program would leak memory. As it exited, it had one Mat that was never closed. The stack trace points to exactly which line the allocation happened on (line 11, the gocv.NewMat()).

Furthermore, if the program is a long running process or if GoCV is being used on a web server, it may be helpful to install the HTTP interface )). For example:

package main

import (
	"net/http"
	_ "net/http/pprof"
	"time"

	"gocv.io/x/gocv"
)

func leak() {
	gocv.NewMat()
}

func main() {
	go func() {
		ticker := time.NewTicker(time.Second)
		for {
			<-ticker.C
			leak()
		}
	}()

	http.ListenAndServe("localhost:6060", nil)
}

This will leak a Mat once per second. You can see the current profile count and stack traces by going to the installed HTTP debug interface: http://localhost:6060/debug/pprof/gocv.io/x/gocv.Mat.

How to contribute

Please take a look at our CONTRIBUTING.md document to understand our contribution guidelines.

Then check out our ROADMAP.md document to know what to work on next.

Why this project exists

The https://github.com/go-opencv/go-opencv package for Go and OpenCV does not support any version above OpenCV 2.x, and work on adding support for OpenCV 3 had stalled for over a year, mostly due to the complexity of SWIG. That is why we started this project.

The GoCV package uses a C-style wrapper around the OpenCV 4 C++ classes to avoid having to deal with applying SWIG to a huge existing codebase. The mappings are intended to match as closely as possible to the original OpenCV project structure, to make it easier to find things, and to be able to figure out where to add support to GoCV for additional OpenCV image filters, algorithms, and other features.

For example, the OpenCV videoio module wrappers can be found in the GoCV package in the videoio.* files.

This package was inspired by the original https://github.com/go-opencv/go-opencv project, the blog post https://medium.com/@peterleyssens/using-opencv-3-from-golang-5510c312a3c and the repo at https://github.com/sensorbee/opencv thank you all!

License

Licensed under the Apache 2.0 license. Copyright (c) 2017-2021 The Hybrid Group.

Logo generated by GopherizeMe - https://gopherize.me

Documentation

Overview

Package gocv is a wrapper around the OpenCV 4.x computer vision library. It provides a Go language interface to the latest version of OpenCV.

OpenCV (Open Source Computer Vision Library: http://opencv.org) is an open-source BSD-licensed library that includes several hundreds of computer vision algorithms.

For further details, please see: http://docs.opencv.org/master/d1/dfb/intro.html

Index

Examples

Constants

View Source
const (
	// MatChannels1 is a single channel Mat.
	MatChannels1 = 0

	// MatChannels2 is 2 channel Mat.
	MatChannels2 = 8

	// MatChannels3 is 3 channel Mat.
	MatChannels3 = 16

	// MatChannels4 is 4 channel Mat.
	MatChannels4 = 24
)
View Source
const (
	// MatTypeCV8U is a Mat of 8-bit unsigned int
	MatTypeCV8U MatType = 0

	// MatTypeCV8S is a Mat of 8-bit signed int
	MatTypeCV8S MatType = 1

	// MatTypeCV16U is a Mat of 16-bit unsigned int
	MatTypeCV16U MatType = 2

	// MatTypeCV16S is a Mat of 16-bit signed int
	MatTypeCV16S MatType = 3

	// MatTypeCV16SC2 is a Mat of 16-bit signed int with 2 channels
	MatTypeCV16SC2 = MatTypeCV16S + MatChannels2

	// MatTypeCV32S is a Mat of 32-bit signed int
	MatTypeCV32S MatType = 4

	// MatTypeCV32F is a Mat of 32-bit float
	MatTypeCV32F MatType = 5

	// MatTypeCV64F is a Mat of 64-bit float
	MatTypeCV64F MatType = 6

	// MatTypeCV8UC1 is a Mat of 8-bit unsigned int with a single channel
	MatTypeCV8UC1 = MatTypeCV8U + MatChannels1

	// MatTypeCV8UC2 is a Mat of 8-bit unsigned int with 2 channels
	MatTypeCV8UC2 = MatTypeCV8U + MatChannels2

	// MatTypeCV8UC3 is a Mat of 8-bit unsigned int with 3 channels
	MatTypeCV8UC3 = MatTypeCV8U + MatChannels3

	// MatTypeCV8UC4 is a Mat of 8-bit unsigned int with 4 channels
	MatTypeCV8UC4 = MatTypeCV8U + MatChannels4

	// MatTypeCV8SC1 is a Mat of 8-bit signed int with a single channel
	MatTypeCV8SC1 = MatTypeCV8S + MatChannels1

	// MatTypeCV8SC2 is a Mat of 8-bit signed int with 2 channels
	MatTypeCV8SC2 = MatTypeCV8S + MatChannels2

	// MatTypeCV8SC3 is a Mat of 8-bit signed int with 3 channels
	MatTypeCV8SC3 = MatTypeCV8S + MatChannels3

	// MatTypeCV8SC4 is a Mat of 8-bit signed int with 4 channels
	MatTypeCV8SC4 = MatTypeCV8S + MatChannels4

	// MatTypeCV16UC1 is a Mat of 16-bit unsigned int with a single channel
	MatTypeCV16UC1 = MatTypeCV16U + MatChannels1

	// MatTypeCV16UC2 is a Mat of 16-bit unsigned int with 2 channels
	MatTypeCV16UC2 = MatTypeCV16U + MatChannels2

	// MatTypeCV16UC3 is a Mat of 16-bit unsigned int with 3 channels
	MatTypeCV16UC3 = MatTypeCV16U + MatChannels3

	// MatTypeCV16UC4 is a Mat of 16-bit unsigned int with 4 channels
	MatTypeCV16UC4 = MatTypeCV16U + MatChannels4

	// MatTypeCV16SC1 is a Mat of 16-bit signed int with a single channel
	MatTypeCV16SC1 = MatTypeCV16S + MatChannels1

	// MatTypeCV16SC3 is a Mat of 16-bit signed int with 3 channels
	MatTypeCV16SC3 = MatTypeCV16S + MatChannels3

	// MatTypeCV16SC4 is a Mat of 16-bit signed int with 4 channels
	MatTypeCV16SC4 = MatTypeCV16S + MatChannels4

	// MatTypeCV32SC1 is a Mat of 32-bit signed int with a single channel
	MatTypeCV32SC1 = MatTypeCV32S + MatChannels1

	// MatTypeCV32SC2 is a Mat of 32-bit signed int with 2 channels
	MatTypeCV32SC2 = MatTypeCV32S + MatChannels2

	// MatTypeCV32SC3 is a Mat of 32-bit signed int with 3 channels
	MatTypeCV32SC3 = MatTypeCV32S + MatChannels3

	// MatTypeCV32SC4 is a Mat of 32-bit signed int with 4 channels
	MatTypeCV32SC4 = MatTypeCV32S + MatChannels4

	// MatTypeCV32FC1 is a Mat of 32-bit float int with a single channel
	MatTypeCV32FC1 = MatTypeCV32F + MatChannels1

	// MatTypeCV32FC2 is a Mat of 32-bit float int with 2 channels
	MatTypeCV32FC2 = MatTypeCV32F + MatChannels2

	// MatTypeCV32FC3 is a Mat of 32-bit float int with 3 channels
	MatTypeCV32FC3 = MatTypeCV32F + MatChannels3

	// MatTypeCV32FC4 is a Mat of 32-bit float int with 4 channels
	MatTypeCV32FC4 = MatTypeCV32F + MatChannels4

	// MatTypeCV64FC1 is a Mat of 64-bit float int with a single channel
	MatTypeCV64FC1 = MatTypeCV64F + MatChannels1

	// MatTypeCV64FC2 is a Mat of 64-bit float int with 2 channels
	MatTypeCV64FC2 = MatTypeCV64F + MatChannels2

	// MatTypeCV64FC3 is a Mat of 64-bit float int with 3 channels
	MatTypeCV64FC3 = MatTypeCV64F + MatChannels3

	// MatTypeCV64FC4 is a Mat of 64-bit float int with 4 channels
	MatTypeCV64FC4 = MatTypeCV64F + MatChannels4
)
View Source
const (
	//IMWriteJpegQuality is the quality from 0 to 100 for JPEG (the higher is the better). Default value is 95.
	IMWriteJpegQuality = 1

	// IMWriteJpegProgressive enables JPEG progressive feature, 0 or 1, default is False.
	IMWriteJpegProgressive = 2

	// IMWriteJpegOptimize enables JPEG optimization, 0 or 1, default is False.
	IMWriteJpegOptimize = 3

	// IMWriteJpegRstInterval is the JPEG restart interval, 0 - 65535, default is 0 - no restart.
	IMWriteJpegRstInterval = 4

	// IMWriteJpegLumaQuality separates luma quality level, 0 - 100, default is 0 - don't use.
	IMWriteJpegLumaQuality = 5

	// IMWriteJpegChromaQuality separates chroma quality level, 0 - 100, default is 0 - don't use.
	IMWriteJpegChromaQuality = 6

	// IMWritePngCompression is the compression level from 0 to 9 for PNG. A
	// higher value means a smaller size and longer compression time.
	// If specified, strategy is changed to IMWRITE_PNG_STRATEGY_DEFAULT (Z_DEFAULT_STRATEGY).
	// Default value is 1 (best speed setting).
	IMWritePngCompression = 16

	// IMWritePngStrategy is one of cv::IMWritePNGFlags, default is IMWRITE_PNG_STRATEGY_RLE.
	IMWritePngStrategy = 17

	// IMWritePngBilevel is the binary level PNG, 0 or 1, default is 0.
	IMWritePngBilevel = 18

	// IMWritePxmBinary for PPM, PGM, or PBM can be a binary format flag, 0 or 1. Default value is 1.
	IMWritePxmBinary = 32

	// IMWriteWebpQuality is the quality from 1 to 100 for WEBP (the higher is
	// the better). By default (without any parameter) and for quality above
	// 100 the lossless compression is used.
	IMWriteWebpQuality = 64

	// IMWritePamTupletype sets the TUPLETYPE field to the corresponding string
	// value that is defined for the format.
	IMWritePamTupletype = 128

	// IMWritePngStrategyDefault is the value to use for normal data.
	IMWritePngStrategyDefault = 0

	// IMWritePngStrategyFiltered is the value to use for data produced by a
	// filter (or predictor). Filtered data consists mostly of small values
	// with a somewhat random distribution. In this case, the compression
	// algorithm is tuned to compress them better.
	IMWritePngStrategyFiltered = 1

	// IMWritePngStrategyHuffmanOnly forces Huffman encoding only (no string match).
	IMWritePngStrategyHuffmanOnly = 2

	// IMWritePngStrategyRle is the value to use to limit match distances to
	// one (run-length encoding).
	IMWritePngStrategyRle = 3

	// IMWritePngStrategyFixed is the value to prevent the use of dynamic
	// Huffman codes, allowing for a simpler decoder for special applications.
	IMWritePngStrategyFixed = 4
)
View Source
const GoCVVersion = "0.30.0"

GoCVVersion of this package, for display purposes.

Variables

View Source
var (
	ErrInvalidImage     = errors.New("unrecognized image format")
	ErrDecodingFailed   = errors.New("failed to decode image")
	ErrBufTooSmall      = errors.New("buffer too small to hold image")
	ErrFrameBufNoPixels = errors.New("Framebuffer contains no pixels")
	ErrSkipNotSupported = errors.New("skip operation not supported by this decoder")
)
View Source
var ErrEmptyByteSlice = errors.New("empty byte array")
View Source
var (
	ErrGifEncoderNeedsDecoder = errors.New("GIF encoder needs decoder used to create image")
)

Functions

func AbsDiff added in v0.3.0

func AbsDiff(src1, src2 Mat, dst *Mat)

AbsDiff calculates the per-element absolute difference between two arrays or between an array and a scalar.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#ga6fef31bc8c4071cbc114a758a2b79c14

func Accumulate added in v0.30.1

func Accumulate(src Mat, dst *Mat)

func AccumulateProduct added in v0.30.1

func AccumulateProduct(src1 Mat, src2 Mat, dst *Mat)

Adds the per-element product of two input images to the accumulator image.

For further details, please see: https://docs.opencv.org/master/d7/df3/group__imgproc__motion.html#ga82518a940ecfda49460f66117ac82520

func AccumulateProductWithMask added in v0.30.1

func AccumulateProductWithMask(src1 Mat, src2 Mat, dst *Mat, mask Mat)

Adds the per-element product of two input images to the accumulator image with mask.

For further details, please see: https://docs.opencv.org/master/d7/df3/group__imgproc__motion.html#ga82518a940ecfda49460f66117ac82520

func AccumulateSquare added in v0.30.1

func AccumulateSquare(src Mat, dst *Mat)

Adds the square of a source image to the accumulator image.

For further details, please see: https://docs.opencv.org/master/d7/df3/group__imgproc__motion.html#gacb75e7ffb573227088cef9ceaf80be8c

func AccumulateSquareWithMask added in v0.30.1

func AccumulateSquareWithMask(src Mat, dst *Mat, mask Mat)

Adds the square of a source image to the accumulator image with mask.

For further details, please see: https://docs.opencv.org/master/d7/df3/group__imgproc__motion.html#gacb75e7ffb573227088cef9ceaf80be8c

func AccumulateWithMask added in v0.30.1

func AccumulateWithMask(src Mat, dst *Mat, mask Mat)

Adds an image to the accumulator image with mask.

For further details, please see: https://docs.opencv.org/master/d7/df3/group__imgproc__motion.html#ga1a567a79901513811ff3b9976923b199

func AccumulatedWeighted added in v0.30.1

func AccumulatedWeighted(src Mat, dst *Mat, alpha float64)

Updates a running average.

For further details, please see: https://docs.opencv.org/master/d7/df3/group__imgproc__motion.html#ga4f9552b541187f61f6818e8d2d826bc7

func AccumulatedWeightedWithMask added in v0.30.1

func AccumulatedWeightedWithMask(src Mat, dst *Mat, alpha float64, mask Mat)

Updates a running average with mask.

For further details, please see: https://docs.opencv.org/master/d7/df3/group__imgproc__motion.html#ga4f9552b541187f61f6818e8d2d826bc7

func AdaptiveThreshold added in v0.16.0

func AdaptiveThreshold(src Mat, dst *Mat, maxValue float32, adaptiveTyp AdaptiveThresholdType, typ ThresholdType, blockSize int, c float32)

AdaptiveThreshold applies a fixed-level threshold to each array element.

For further details, please see: https://docs.opencv.org/master/d7/d1b/group__imgproc__misc.html#ga72b913f352e4a1b1b397736707afcde3

func Add added in v0.3.0

func Add(src1, src2 Mat, dst *Mat)

Add calculates the per-element sum of two arrays or an array and a scalar.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#ga10ac1bfb180e2cfda1701d06c24fdbd6

func AddWeighted added in v0.3.0

func AddWeighted(src1 Mat, alpha float64, src2 Mat, beta float64, gamma float64, dst *Mat)

AddWeighted calculates the weighted sum of two arrays.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#gafafb2513349db3bcff51f54ee5592a19

func ApplyColorMap added in v0.8.0

func ApplyColorMap(src Mat, dst *Mat, colormapType ColormapTypes)

ApplyColorMap applies a GNU Octave/MATLAB equivalent colormap on a given image.

For further details, please see: https://docs.opencv.org/master/d3/d50/group__imgproc__colormap.html#gadf478a5e5ff49d8aa24e726ea6f65d15

func ApplyCustomColorMap added in v0.8.0

func ApplyCustomColorMap(src Mat, dst *Mat, customColormap Mat)

ApplyCustomColorMap applies a custom defined colormap on a given image.

For further details, please see: https://docs.opencv.org/master/d3/d50/group__imgproc__colormap.html#gacb22288ddccc55f9bd9e6d492b409cae

func ArcLength added in v0.9.0

func ArcLength(curve PointVector, isClosed bool) float64

ArcLength calculates a contour perimeter or a curve length.

For further details, please see:

https://docs.opencv.org/master/d3/dc0/group__imgproc__shape.html#ga8d26483c636be6b35c3ec6335798a47c

func ArrowedLine added in v0.3.0

func ArrowedLine(img *Mat, pt1 image.Point, pt2 image.Point, c color.RGBA, thickness int)

ArrowedLine draws a arrow segment pointing from the first point to the second one.

For further details, please see: https://docs.opencv.org/master/d6/d6e/group__imgproc__draw.html#ga0a165a3ca093fd488ac709fdf10c05b2

func BatchDistance added in v0.16.0

func BatchDistance(src1 Mat, src2 Mat, dist Mat, dtype MatType, nidx Mat, normType NormType, K int, mask Mat, update int, crosscheck bool)

BatchDistance is a naive nearest neighbor finder.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#ga4ba778a1c57f83233b1d851c83f5a622

func BilateralFilter added in v0.3.0

func BilateralFilter(src Mat, dst *Mat, diameter int, sigmaColor float64, sigmaSpace float64)

BilateralFilter applies a bilateral filter to an image.

Bilateral filtering is described here: http://www.dai.ed.ac.uk/CVonline/LOCAL_COPIES/MANDUCHI1/Bilateral_Filtering.html

BilateralFilter can reduce unwanted noise very well while keeping edges fairly sharp. However, it is very slow compared to most filters.

For further details, please see: https://docs.opencv.org/master/d4/d86/group__imgproc__filter.html#ga9d7064d478c95d60003cf839430737ed

func BitwiseAnd added in v0.3.0

func BitwiseAnd(src1 Mat, src2 Mat, dst *Mat)

BitwiseAnd computes bitwise conjunction of the two arrays (dst = src1 & src2). Calculates the per-element bit-wise conjunction of two arrays or an array and a scalar.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#ga60b4d04b251ba5eb1392c34425497e14

func BitwiseAndWithMask added in v0.30.1

func BitwiseAndWithMask(src1 Mat, src2 Mat, dst *Mat, mask Mat)

BitwiseAndWithMask computes bitwise conjunction of the two arrays (dst = src1 & src2). Calculates the per-element bit-wise conjunction of two arrays or an array and a scalar. It has an additional parameter for a mask.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#ga60b4d04b251ba5eb1392c34425497e14

func BitwiseNot added in v0.3.0

func BitwiseNot(src1 Mat, dst *Mat)

BitwiseNot inverts every bit of an array.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#ga0002cf8b418479f4cb49a75442baee2f

func BitwiseNotWithMask added in v0.30.1

func BitwiseNotWithMask(src1 Mat, dst *Mat, mask Mat)

BitwiseNotWithMask inverts every bit of an array. It has an additional parameter for a mask.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#ga0002cf8b418479f4cb49a75442baee2f

func BitwiseOr added in v0.3.0

func BitwiseOr(src1 Mat, src2 Mat, dst *Mat)

BitwiseOr calculates the per-element bit-wise disjunction of two arrays or an array and a scalar.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#gab85523db362a4e26ff0c703793a719b4

func BitwiseOrWithMask added in v0.30.1

func BitwiseOrWithMask(src1 Mat, src2 Mat, dst *Mat, mask Mat)

BitwiseOrWithMask calculates the per-element bit-wise disjunction of two arrays or an array and a scalar. It has an additional parameter for a mask.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#gab85523db362a4e26ff0c703793a719b4

func BitwiseXor added in v0.3.0

func BitwiseXor(src1 Mat, src2 Mat, dst *Mat)

BitwiseXor calculates the per-element bit-wise "exclusive or" operation on two arrays or an array and a scalar.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#ga84b2d8188ce506593dcc3f8cd00e8e2c

func BitwiseXorWithMask added in v0.30.1

func BitwiseXorWithMask(src1 Mat, src2 Mat, dst *Mat, mask Mat)

BitwiseXorWithMask calculates the per-element bit-wise "exclusive or" operation on two arrays or an array and a scalar. It has an additional parameter for a mask.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#ga84b2d8188ce506593dcc3f8cd00e8e2c

func Blur

func Blur(src Mat, dst *Mat, ksize image.Point)

Blur blurs an image Mat using a normalized box filter.

For further details, please see: https://docs.opencv.org/master/d4/d86/group__imgproc__filter.html#ga8c45db9afe636703801b0b2e440fce37

func BorderInterpolate added in v0.16.0

func BorderInterpolate(p int, len int, borderType CovarFlags) int

BorderInterpolate computes the source location of an extrapolated pixel.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#ga247f571aa6244827d3d798f13892da58

func BoundingRect added in v0.4.1

func BoundingRect(contour PointVector) image.Rectangle

BoundingRect calculates the up-right bounding rectangle of a point set.

For further details, please see: https://docs.opencv.org/3.3.0/d3/dc0/group__imgproc__shape.html#gacb413ddce8e48ff3ca61ed7cf626a366

func BoxFilter added in v0.16.0

func BoxFilter(src Mat, dst *Mat, depth int, ksize image.Point)

BoxFilter blurs an image using the box filter.

For further details, please see: https://docs.opencv.org/master/d4/d86/group__imgproc__filter.html#gad533230ebf2d42509547d514f7d3fbc3

func BoxPoints added in v0.30.1

func BoxPoints(rect RotatedRect, pts *Mat)

BoxPoints finds the four vertices of a rotated rect. Useful to draw the rotated rectangle.

For further Details, please see: https://docs.opencv.org/3.3.0/d3/dc0/group__imgproc__shape.html#gaf78d467e024b4d7936cf9397185d2f5c

func CalcBackProject added in v0.30.1

func CalcBackProject(src []Mat, channels []int, hist Mat, backProject *Mat, ranges []float64, uniform bool)

CalcBackProject calculates the back projection of a histogram.

For futher details, please see: https://docs.opencv.org/3.4/d6/dc7/group__imgproc__hist.html#ga3a0af640716b456c3d14af8aee12e3ca

func CalcCovarMatrix added in v0.16.0

func CalcCovarMatrix(samples Mat, covar *Mat, mean *Mat, flags CovarFlags, ctype MatType)

CalcCovarMatrix calculates the covariance matrix of a set of vectors.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#ga017122d912af19d7d0d2cccc2d63819f

func CalcHist added in v0.16.0

func CalcHist(src []Mat, channels []int, mask Mat, hist *Mat, size []int, ranges []float64, acc bool)

CalcHist Calculates a histogram of a set of images

For futher details, please see: https://docs.opencv.org/master/d6/dc7/group__imgproc__hist.html#ga6ca1876785483836f72a77ced8ea759a

func Canny

func Canny(src Mat, edges *Mat, t1 float32, t2 float32)

Canny finds edges in an image using the Canny algorithm. The function finds edges in the input image image and marks them in the output map edges using the Canny algorithm. The smallest value between threshold1 and threshold2 is used for edge linking. The largest value is used to find initial segments of strong edges. See http://en.wikipedia.org/wiki/Canny_edge_detector

For further details, please see: http://docs.opencv.org/master/dd/d1a/group__imgproc__feature.html#ga04723e007ed888ddf11d9ba04e2232de

func CartToPolar added in v0.16.0

func CartToPolar(x Mat, y Mat, magnitude *Mat, angle *Mat, angleInDegrees bool)

CartToPolar calculates the magnitude and angle of 2D vectors.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#gac5f92f48ec32cacf5275969c33ee837d

func CheckRange added in v0.16.0

func CheckRange(src Mat) bool

CheckRange checks every element of an input array for invalid values.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#ga2bd19d89cae59361416736f87e3c7a64

func Circle added in v0.3.0

func Circle(img *Mat, center image.Point, radius int, c color.RGBA, thickness int)

Circle draws a circle.

For further details, please see: https://docs.opencv.org/master/d6/d6e/group__imgproc__draw.html#gaf10604b069374903dbd0f0488cb43670

func CircleWithParams added in v0.30.1

func CircleWithParams(img *Mat, center image.Point, radius int, c color.RGBA, thickness int, lineType LineType, shift int)

CircleWithParams draws a circle.

For further details, please see: https://docs.opencv.org/master/d6/d6e/group__imgproc__draw.html#gaf10604b069374903dbd0f0488cb43670

func ClipLine added in v0.30.1

func ClipLine(imgSize image.Point, pt1 image.Point, pt2 image.Point) bool

ClipLine clips the line against the image rectangle. For further details, please see: https://docs.opencv.org/master/d6/d6e/group__imgproc__draw.html#gaf483cb46ad6b049bc35ec67052ef1c2c

func Compare added in v0.16.0

func Compare(src1 Mat, src2 Mat, dst *Mat, ct CompareType)

Compare performs the per-element comparison of two arrays or an array and scalar value.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#ga303cfb72acf8cbb36d884650c09a3a97

func CompareHist added in v0.30.1

func CompareHist(hist1 Mat, hist2 Mat, method HistCompMethod) float32

CompareHist Compares two histograms.

For further details, please see: https://docs.opencv.org/master/d6/dc7/group__imgproc__hist.html#gaf4190090efa5c47cb367cf97a9a519bd

func CompleteSymm added in v0.16.0

func CompleteSymm(m Mat, lowerToUpper bool)

CompleteSymm copies the lower or the upper half of a square matrix to its another half.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#gaa9d88dcd0e54b6d1af38d41f2a3e3d25

func ConnectedComponents added in v0.30.1

func ConnectedComponents(src Mat, labels *Mat) int

ConnectedComponents computes the connected components labeled image of boolean image.

For further details, please see: https://docs.opencv.org/master/d3/dc0/group__imgproc__shape.html#gaedef8c7340499ca391d459122e51bef5

func ConnectedComponentsWithParams added in v0.30.1

func ConnectedComponentsWithParams(src Mat, labels *Mat, conn int, ltype MatType,
	ccltype ConnectedComponentsAlgorithmType) int

ConnectedComponents computes the connected components labeled image of boolean image.

For further details, please see: https://docs.opencv.org/master/d3/dc0/group__imgproc__shape.html#gaedef8c7340499ca391d459122e51bef5

func ConnectedComponentsWithStats added in v0.30.1

func ConnectedComponentsWithStats(src Mat, labels *Mat, stats *Mat, centroids *Mat) int

ConnectedComponentsWithStats computes the connected components labeled image of boolean image and also produces a statistics output for each label.

For further details, please see: https://docs.opencv.org/master/d3/dc0/group__imgproc__shape.html#ga107a78bf7cd25dec05fb4dfc5c9e765f

func ConnectedComponentsWithStatsWithParams added in v0.30.1

func ConnectedComponentsWithStatsWithParams(src Mat, labels *Mat, stats *Mat, centroids *Mat,
	conn int, ltype MatType, ccltype ConnectedComponentsAlgorithmType) int

ConnectedComponentsWithStats computes the connected components labeled image of boolean image and also produces a statistics output for each label.

For further details, please see: https://docs.opencv.org/master/d3/dc0/group__imgproc__shape.html#ga107a78bf7cd25dec05fb4dfc5c9e765f

func ContourArea added in v0.4.1

func ContourArea(contour PointVector) float64

ContourArea calculates a contour area.

For further details, please see: https://docs.opencv.org/3.3.0/d3/dc0/group__imgproc__shape.html#ga2c759ed9f497d4a618048a2f56dc97f1

func ConvertScaleAbs added in v0.16.0

func ConvertScaleAbs(src Mat, dst *Mat, alpha float64, beta float64)

ConvertScaleAbs scales, calculates absolute values, and converts the result to 8-bit.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#ga3460e9c9f37b563ab9dd550c4d8c4e7d

func ConvexHull added in v0.16.0

func ConvexHull(points PointVector, hull *Mat, clockwise bool, returnPoints bool)

ConvexHull finds the convex hull of a point set.

For further details, please see: https://docs.opencv.org/master/d3/dc0/group__imgproc__shape.html#ga014b28e56cb8854c0de4a211cb2be656

func ConvexityDefects added in v0.16.0

func ConvexityDefects(contour PointVector, hull Mat, result *Mat)

ConvexityDefects finds the convexity defects of a contour.

For further details, please see: https://docs.opencv.org/master/d3/dc0/group__imgproc__shape.html#gada4437098113fd8683c932e0567f47ba

func CopyMakeBorder added in v0.16.0

func CopyMakeBorder(src Mat, dst *Mat, top int, bottom int, left int, right int, bt BorderType, value color.RGBA)

CopyMakeBorder forms a border around an image (applies padding).

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#ga2ac1049c2c3dd25c2b41bffe17658a36

func CornerSubPix added in v0.5.0

func CornerSubPix(img Mat, corners *Mat, winSize image.Point, zeroZone image.Point, criteria TermCriteria)

CornerSubPix Refines the corner locations. The function iterates to find the sub-pixel accurate location of corners or radial saddle points.

For further details, please see: https://docs.opencv.org/master/dd/d1a/group__imgproc__feature.html#ga354e0d7c86d0d9da75de9b9701a9a87e

func CountNonZero added in v0.16.0

func CountNonZero(src Mat) int

CountNonZero counts non-zero array elements.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#gaa4b89393263bb4d604e0fe5986723914

func CvtColor

func CvtColor(src Mat, dst *Mat, code ColorConversionCode)

CvtColor converts an image from one color space to another. It converts the src Mat image to the dst Mat using the code param containing the desired ColorConversionCode color space.

For further details, please see: http://docs.opencv.org/master/d7/d1b/group__imgproc__misc.html#ga4e0972be5de079fed4e3a10e24ef5ef0

func DCT added in v0.16.0

func DCT(src Mat, dst *Mat, flags DftFlags)

DCT performs a forward or inverse discrete Cosine transform of 1D or 2D array.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#ga85aad4d668c01fbd64825f589e3696d4

func DFT added in v0.3.0

func DFT(src Mat, dst *Mat, flags DftFlags)

DFT performs a forward or inverse Discrete Fourier Transform (DFT) of a 1D or 2D floating-point array.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#gadd6cf9baf2b8b704a11b5f04aaf4f39d

func Determinant added in v0.16.0

func Determinant(src Mat) float64

Determinant returns the determinant of a square floating-point matrix.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#gaf802bd9ca3e07b8b6170645ef0611d0c

func Dilate added in v0.3.0

func Dilate(src Mat, dst *Mat, kernel Mat)

Dilate dilates an image by using a specific structuring element.

For further details, please see: https://docs.opencv.org/master/d4/d86/group__imgproc__filter.html#ga4ff0f3318642c4f469d0e11f242f3b6c

func DilateWithParams added in v0.30.1

func DilateWithParams(src Mat, dst *Mat, kernel Mat, anchor image.Point, iterations, borderType BorderType, borderValue color.RGBA)

DilateWithParams dilates an image by using a specific structuring element.

For further details, please see: https://docs.opencv.org/master/d4/d86/group__imgproc__filter.html#ga4ff0f3318642c4f469d0e11f242f3b6c

func DistanceTransform added in v0.30.1

func DistanceTransform(src Mat, dst *Mat, labels *Mat, distType DistanceTypes, maskSize DistanceTransformMasks, labelType DistanceTransformLabelTypes)

DistanceTransform Calculates the distance to the closest zero pixel for each pixel of the source image.

For further details, please see: https://docs.opencv.org/master/d7/d1b/group__imgproc__misc.html#ga8a0b7fdfcb7a13dde018988ba3a43042

func Divide added in v0.16.0

func Divide(src1 Mat, src2 Mat, dst *Mat)

Divide performs the per-element division on two arrays or an array and a scalar.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#ga6db555d30115642fedae0cda05604874

func DrawContours added in v0.16.0

func DrawContours(img *Mat, contours PointsVector, contourIdx int, c color.RGBA, thickness int)

DrawContours draws contours outlines or filled contours.

For further details, please see: https://docs.opencv.org/master/d6/d6e/group__imgproc__draw.html#ga746c0625f1781f1ffc9056259103edbc

func DrawContoursWithParams added in v0.30.1

func DrawContoursWithParams(img *Mat, contours PointsVector, contourIdx int, c color.RGBA, thickness int, lineType LineType, hierarchy Mat, maxLevel int, offset image.Point)

DrawContoursWithParams draws contours outlines or filled contours.

For further details, please see: https://docs.opencv.org/master/d6/d6e/group__imgproc__draw.html#ga746c0625f1781f1ffc9056259103edbc

func Eigen added in v0.16.0

func Eigen(src Mat, eigenvalues *Mat, eigenvectors *Mat) bool

Eigen calculates eigenvalues and eigenvectors of a symmetric matrix.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#ga9fa0d58657f60eaa6c71f6fbb40456e3

func EigenNonSymmetric added in v0.16.0

func EigenNonSymmetric(src Mat, eigenvalues *Mat, eigenvectors *Mat)

EigenNonSymmetric calculates eigenvalues and eigenvectors of a non-symmetric matrix (real eigenvalues only).

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#gaf51987e03cac8d171fbd2b327cf966f6

func Ellipse added in v0.16.0

func Ellipse(img *Mat, center, axes image.Point, angle, startAngle, endAngle float64, c color.RGBA, thickness int)

Ellipse draws a simple or thick elliptic arc or fills an ellipse sector.

For further details, please see: https://docs.opencv.org/master/d6/d6e/group__imgproc__draw.html#ga28b2267d35786f5f890ca167236cbc69

func EllipseWithParams added in v0.30.1

func EllipseWithParams(img *Mat, center, axes image.Point, angle, startAngle, endAngle float64, c color.RGBA, thickness int, lineType LineType, shift int)

Ellipse draws a simple or thick elliptic arc or fills an ellipse sector.

For further details, please see: https://docs.opencv.org/master/d6/d6e/group__imgproc__draw.html#ga28b2267d35786f5f890ca167236cbc69

func EqualizeHist added in v0.16.0

func EqualizeHist(src Mat, dst *Mat)

EqualizeHist normalizes the brightness and increases the contrast of the image.

For further details, please see: https://docs.opencv.org/master/d6/dc7/group__imgproc__hist.html#ga7e54091f0c937d49bf84152a16f76d6e

func Erode added in v0.3.0

func Erode(src Mat, dst *Mat, kernel Mat)

Erode erodes an image by using a specific structuring element.

For further details, please see: https://docs.opencv.org/master/d4/d86/group__imgproc__filter.html#gaeb1e0c1033e3f6b891a25d0511362aeb

func ErodeWithParams added in v0.30.1

func ErodeWithParams(src Mat, dst *Mat, kernel Mat, anchor image.Point, iterations, borderType int)

ErodeWithParams erodes an image by using a specific structuring element.

For further details, please see: https://docs.opencv.org/master/d4/d86/group__imgproc__filter.html#gaeb1e0c1033e3f6b891a25d0511362aeb

func Exp added in v0.16.0

func Exp(src Mat, dst *Mat)

Exp calculates the exponent of every array element.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#ga3e10108e2162c338f1b848af619f39e5

func ExtractChannel added in v0.16.0

func ExtractChannel(src Mat, dst *Mat, coi int)

ExtractChannel extracts a single channel from src (coi is 0-based index).

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#gacc6158574aa1f0281878c955bcf35642

func FillPoly added in v0.16.0

func FillPoly(img *Mat, pts PointsVector, c color.RGBA)

FillPoly fills the area bounded by one or more polygons.

For more information, see: https://docs.opencv.org/master/d6/d6e/group__imgproc__draw.html#gaf30888828337aa4c6b56782b5dfbd4b7

func FillPolyWithParams added in v0.30.1

func FillPolyWithParams(img *Mat, pts PointsVector, c color.RGBA, lineType LineType, shift int, offset image.Point)

FillPolyWithParams fills the area bounded by one or more polygons.

For more information, see: https://docs.opencv.org/master/d6/d6e/group__imgproc__draw.html#gaf30888828337aa4c6b56782b5dfbd4b7

func Filter2D added in v0.17.0

func Filter2D(src Mat, dst *Mat, ddepth MatType, kernel Mat, anchor image.Point, delta float64, borderType BorderType)

Filter2D applies an arbitrary linear filter to an image.

For further details, please see: https://docs.opencv.org/master/d4/d86/group__imgproc__filter.html#ga27c049795ce870216ddfb366086b5a04

func FindNonZero added in v0.16.0

func FindNonZero(src Mat, idx *Mat)

FindNonZero returns the list of locations of non-zero pixels.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#gaed7df59a3539b4cc0fe5c9c8d7586190

func FitLine added in v0.17.0

func FitLine(pts PointVector, line *Mat, distType DistanceTypes, param, reps, aeps float64)

FitLine fits a line to a 2D or 3D point set.

For further details, please see: https://docs.opencv.org/master/d3/dc0/group__imgproc__shape.html#gaf849da1fdafa67ee84b1e9a23b93f91f

func Flip added in v0.16.0

func Flip(src Mat, dst *Mat, flipCode int)

Flip flips a 2D array around horizontal(0), vertical(1), or both axes(-1).

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#gaca7be533e3dac7feb70fc60635adf441

func GaussianBlur

func GaussianBlur(src Mat, dst *Mat, ksize image.Point, sigmaX float64,
	sigmaY float64, borderType BorderType)

GaussianBlur blurs an image Mat using a Gaussian filter. The function convolves the src Mat image into the dst Mat using the specified Gaussian kernel params.

For further details, please see: http://docs.opencv.org/master/d4/d86/group__imgproc__filter.html#gaabe8c836e97159a9193fb0b11ac52cf1

func Gemm added in v0.16.0

func Gemm(src1, src2 Mat, alpha float64, src3 Mat, beta float64, dst *Mat, flags int)

Gemm performs generalized matrix multiplication.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#gacb6e64071dffe36434e1e7ee79e7cb35

func GetOptimalDFTSize added in v0.3.0

func GetOptimalDFTSize(vecsize int) int

GetOptimalDFTSize returns the optimal Discrete Fourier Transform (DFT) size for a given vector size.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#ga6577a2e59968936ae02eb2edde5de299

func GetRectSubPix added in v0.30.1

func GetRectSubPix(src Mat, patchSize image.Point, center image.Point, dst *Mat)

GetRectSubPix retrieves a pixel rectangle from an image with sub-pixel accuracy.

For further details, please see: https://docs.opencv.org/master/da/d54/group__imgproc__transform.html#ga77576d06075c1a4b6ba1a608850cd614

func GetTextSize

func GetTextSize(text string, fontFace HersheyFont, fontScale float64, thickness int) image.Point

GetTextSize calculates the width and height of a text string. It returns an image.Point with the size required to draw text using a specific font face, scale, and thickness.

For further details, please see: http://docs.opencv.org/master/d6/d6e/group__imgproc__draw.html#ga3d2abfcb995fd2db908c8288199dba82

func GetTextSizeWithBaseline added in v0.30.1

func GetTextSizeWithBaseline(text string, fontFace HersheyFont, fontScale float64, thickness int) (image.Point, int)

GetTextSizeWithBaseline calculates the width and height of a text string including the basline of the text. It returns an image.Point with the size required to draw text using a specific font face, scale, and thickness as well as its baseline.

For further details, please see: http://docs.opencv.org/master/d6/d6e/group__imgproc__draw.html#ga3d2abfcb995fd2db908c8288199dba82

func GetTickCount added in v0.16.0

func GetTickCount() float64

GetTickCount returns the number of ticks.

For further details, please see: https://docs.opencv.org/master/db/de0/group__core__utils.html#gae73f58000611a1af25dd36d496bf4487

func GetTickFrequency added in v0.16.0

func GetTickFrequency() float64

GetTickFrequency returns the number of ticks per second.

For further details, please see: https://docs.opencv.org/master/db/de0/group__core__utils.html#ga705441a9ef01f47acdc55d87fbe5090c

func GoodFeaturesToTrack added in v0.5.0

func GoodFeaturesToTrack(img Mat, corners *Mat, maxCorners int, quality float64, minDist float64)

GoodFeaturesToTrack determines strong corners on an image. The function finds the most prominent corners in the image or in the specified image region.

For further details, please see: https://docs.opencv.org/master/dd/d1a/group__imgproc__feature.html#ga1d6bb77486c8f92d79c8793ad995d541

func GrabCut added in v0.30.1

func GrabCut(img Mat, mask *Mat, r image.Rectangle, bgdModel *Mat, fgdModel *Mat, iterCount int, mode GrabCutMode)

Grabcut runs the GrabCut algorithm. The function implements the GrabCut image segmentation algorithm. For further details, please see: https://docs.opencv.org/master/d7/d1b/group__imgproc__misc.html#ga909c1dda50efcbeaa3ce126be862b37f

func Hconcat added in v0.16.0

func Hconcat(src1, src2 Mat, dst *Mat)

Hconcat applies horizontal concatenation to given matrices.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#gaab5ceee39e0580f879df645a872c6bf7

func HoughCircles added in v0.3.0

func HoughCircles(src Mat, circles *Mat, method HoughMode, dp, minDist float64)

HoughCircles finds circles in a grayscale image using the Hough transform. The only "method" currently supported is HoughGradient. If you want to pass more parameters, please see `HoughCirclesWithParams`.

For further details, please see: https://docs.opencv.org/master/dd/d1a/group__imgproc__feature.html#ga47849c3be0d0406ad3ca45db65a25d2d

func HoughCirclesWithParams added in v0.16.0

func HoughCirclesWithParams(src Mat, circles *Mat, method HoughMode, dp, minDist, param1, param2 float64, minRadius, maxRadius int)

HoughCirclesWithParams finds circles in a grayscale image using the Hough transform. The only "method" currently supported is HoughGradient.

For further details, please see: https://docs.opencv.org/master/dd/d1a/group__imgproc__feature.html#ga47849c3be0d0406ad3ca45db65a25d2d

func HoughLines

func HoughLines(src Mat, lines *Mat, rho float32, theta float32, threshold int)

HoughLines implements the standard or standard multi-scale Hough transform algorithm for line detection. For a good explanation of Hough transform, see: http://homepages.inf.ed.ac.uk/rbf/HIPR2/hough.htm

For further details, please see: http://docs.opencv.org/master/dd/d1a/group__imgproc__feature.html#ga46b4e588934f6c8dfd509cc6e0e4545a

func HoughLinesP

func HoughLinesP(src Mat, lines *Mat, rho float32, theta float32, threshold int)

HoughLinesP implements the probabilistic Hough transform algorithm for line detection. For a good explanation of Hough transform, see: http://homepages.inf.ed.ac.uk/rbf/HIPR2/hough.htm

For further details, please see: http://docs.opencv.org/master/dd/d1a/group__imgproc__feature.html#ga8618180a5948286384e3b7ca02f6feeb

func HoughLinesPWithParams added in v0.16.0

func HoughLinesPWithParams(src Mat, lines *Mat, rho float32, theta float32, threshold int, minLineLength float32, maxLineGap float32)

func HoughLinesPointSet added in v0.30.1

func HoughLinesPointSet(points Mat, lines *Mat, linesMax int, threshold int,
	minRho float32, maxRho float32, rhoStep float32,
	minTheta float32, maxTheta float32, thetaStep float32)

HoughLinesPointSet implements the Hough transform algorithm for line detection on a set of points. For a good explanation of Hough transform, see: http://homepages.inf.ed.ac.uk/rbf/HIPR2/hough.htm

For further details, please see: https://docs.opencv.org/master/dd/d1a/group__imgproc__feature.html#ga2858ef61b4e47d1919facac2152a160e

func IDCT added in v0.16.0

func IDCT(src Mat, dst *Mat, flags int)

IDCT calculates the inverse Discrete Cosine Transform of a 1D or 2D array.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#ga77b168d84e564c50228b69730a227ef2

func IDFT added in v0.16.0

func IDFT(src Mat, dst *Mat, flags, nonzeroRows int)

IDFT calculates the inverse Discrete Fourier Transform of a 1D or 2D array.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#gaa708aa2d2e57a508f968eb0f69aa5ff1

func IMWrite

func IMWrite(name string, img Mat) bool

IMWrite writes a Mat to an image file.

For further details, please see: http://docs.opencv.org/master/d4/da8/group__imgcodecs.html#gabbc7ef1aa2edfaa87772f1202d67e0ce

func IMWriteWithParams added in v0.4.1

func IMWriteWithParams(name string, img Mat, params []int) bool

IMWriteWithParams writes a Mat to an image file. With that func you can pass compression parameters.

For further details, please see: http://docs.opencv.org/master/d4/da8/group__imgcodecs.html#gabbc7ef1aa2edfaa87772f1202d67e0ce

func InRange added in v0.3.0

func InRange(src, lb, ub Mat, dst *Mat)

InRange checks if array elements lie between the elements of two Mat arrays.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#ga48af0ab51e36436c5d04340e036ce981

func InRangeWithScalar added in v0.16.0

func InRangeWithScalar(src Mat, lb, ub Scalar, dst *Mat)

InRangeWithScalar checks if array elements lie between the elements of two Scalars

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#ga48af0ab51e36436c5d04340e036ce981

func InsertChannel added in v0.16.0

func InsertChannel(src Mat, dst *Mat, coi int)

InsertChannel inserts a single channel to dst (coi is 0-based index) (it replaces channel i with another in dst).

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#ga1d4bd886d35b00ec0b764cb4ce6eb515

func Integral added in v0.30.1

func Integral(src Mat, sum *Mat, sqsum *Mat, tilted *Mat)

Integral calculates one or more integral images for the source image. For further details, please see: https://docs.opencv.org/master/d7/d1b/group__imgproc__misc.html#ga97b87bec26908237e8ba0f6e96d23e28

func Invert added in v0.16.0

func Invert(src Mat, dst *Mat, flags SolveDecompositionFlags) float64

Invert finds the inverse or pseudo-inverse of a matrix.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#gad278044679d4ecf20f7622cc151aaaa2

func KMeans added in v0.30.1

func KMeans(data Mat, k int, bestLabels *Mat, criteria TermCriteria, attempts int, flags KMeansFlags, centers *Mat) float64

KMeans finds centers of clusters and groups input samples around the clusters.

For further details, please see: https://docs.opencv.org/master/d5/d38/group__core__cluster.html#ga9a34dc06c6ec9460e90860f15bcd2f88

func KMeansPoints added in v0.30.1

func KMeansPoints(points PointVector, k int, bestLabels *Mat, criteria TermCriteria, attempts int, flags KMeansFlags, centers *Mat) float64

KMeansPoints finds centers of clusters and groups input samples around the clusters.

For further details, please see: https://docs.opencv.org/master/d5/d38/group__core__cluster.html#ga9a34dc06c6ec9460e90860f15bcd2f88

func LUT added in v0.6.0

func LUT(src, wbLUT Mat, dst *Mat)

LUT performs a look-up table transform of an array.

The function LUT fills the output array with values from the look-up table. Indices of the entries are taken from the input array.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#gab55b8d062b7f5587720ede032d34156f

func Laplacian added in v0.4.1

func Laplacian(src Mat, dst *Mat, dDepth MatType, size int, scale float64,
	delta float64, borderType BorderType)

Laplacian calculates the Laplacian of an image.

For further details, please see: https://docs.opencv.org/master/d4/d86/group__imgproc__filter.html#gad78703e4c8fe703d479c1860d76429e6

func Line added in v0.3.0

func Line(img *Mat, pt1 image.Point, pt2 image.Point, c color.RGBA, thickness int)

Line draws a line segment connecting two points.

For further details, please see: https://docs.opencv.org/master/d6/d6e/group__imgproc__draw.html#ga7078a9fae8c7e7d13d24dac2520ae4a2

func LinearPolar added in v0.30.1

func LinearPolar(src Mat, dst *Mat, center image.Point, maxRadius float64, flags InterpolationFlags)

LinearPolar remaps an image to polar coordinates space.

For further details, please see: https://docs.opencv.org/master/da/d54/group__imgproc__transform.html#gaa38a6884ac8b6e0b9bed47939b5362f3

func Log added in v0.16.0

func Log(src Mat, dst *Mat)

Log calculates the natural logarithm of every array element.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#ga937ecdce4679a77168730830a955bea7

func LogPolar added in v0.17.0

func LogPolar(src Mat, dst *Mat, center image.Point, m float64, flags InterpolationFlags)

LogPolar remaps an image to semilog-polar coordinates space.

For further details, please see: https://docs.opencv.org/master/da/d54/group__imgproc__transform.html#gaec3a0b126a85b5ca2c667b16e0ae022d

func Magnitude added in v0.16.0

func Magnitude(x, y Mat, magnitude *Mat)

Magnitude calculates the magnitude of 2D vectors.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#ga6d3b097586bca4409873d64a90fe64c3

func MatchTemplate added in v0.9.0

func MatchTemplate(image Mat, templ Mat, result *Mat, method TemplateMatchMode, mask Mat)

MatchTemplate compares a template against overlapped image regions.

For further details, please see: https://docs.opencv.org/master/df/dfb/group__imgproc__object.html#ga586ebfb0a7fb604b35a23d85391329be

func Max added in v0.16.0

func Max(src1, src2 Mat, dst *Mat)

Max calculates per-element maximum of two arrays or an array and a scalar.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#gacc40fa15eac0fb83f8ca70b7cc0b588d

func MeanStdDev added in v0.16.0

func MeanStdDev(src Mat, dst *Mat, dstStdDev *Mat)

MeanStdDev calculates a mean and standard deviation of array elements.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#ga846c858f4004d59493d7c6a4354b301d

func MedianBlur added in v0.3.0

func MedianBlur(src Mat, dst *Mat, ksize int)

MedianBlur blurs an image using the median filter.

For further details, please see: https://docs.opencv.org/master/d4/d86/group__imgproc__filter.html#ga564869aa33e58769b4469101aac458f9

func Merge added in v0.3.0

func Merge(mv []Mat, dst *Mat)

Merge creates one multi-channel array out of several single-channel ones.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#ga7d7b4d6c6ee504b30a20b1680029c7b4

func Min added in v0.16.0

func Min(src1, src2 Mat, dst *Mat)

Min calculates per-element minimum of two arrays or an array and a scalar.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#ga9af368f182ee76d0463d0d8d5330b764

func MinEnclosingCircle added in v0.30.1

func MinEnclosingCircle(pts PointVector) (x, y, radius float32)

MinEnclosingCircle finds a circle of the minimum area enclosing the input 2D point set.

For further details, please see: https://docs.opencv.org/3.4/d3/dc0/group__imgproc__shape.html#ga8ce13c24081bbc7151e9326f412190f1

func MinMaxIdx added in v0.16.0

func MinMaxIdx(input Mat) (minVal, maxVal float32, minIdx, maxIdx int)

MinMaxIdx finds the global minimum and maximum in an array.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#ga7622c466c628a75d9ed008b42250a73f

func MinMaxLoc added in v0.8.0

func MinMaxLoc(input Mat) (minVal, maxVal float32, minLoc, maxLoc image.Point)

MinMaxLoc finds the global minimum and maximum in an array.

For further details, please see: https://docs.opencv.org/trunk/d2/de8/group__core__array.html#gab473bf2eb6d14ff97e89b355dac20707

func MixChannels added in v0.30.1

func MixChannels(src []Mat, dst []Mat, fromTo []int)

Copies specified channels from input arrays to the specified channels of output arrays.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#ga51d768c270a1cdd3497255017c4504be

func Moments added in v0.4.1

func Moments(src Mat, binaryImage bool) map[string]float64

Moments calculates all of the moments up to the third order of a polygon or rasterized shape.

For further details, please see: https://docs.opencv.org/master/d3/dc0/group__imgproc__shape.html#ga556a180f43cab22649c23ada36a8a139

func MorphologyEx added in v0.3.0

func MorphologyEx(src Mat, dst *Mat, op MorphType, kernel Mat)

MorphologyEx performs advanced morphological transformations.

For further details, please see: https://docs.opencv.org/master/d4/d86/group__imgproc__filter.html#ga67493776e3ad1a3df63883829375201f

func MorphologyExWithParams added in v0.30.1

func MorphologyExWithParams(src Mat, dst *Mat, op MorphType, kernel Mat, iterations int, borderType BorderType)

MorphologyExWithParams performs advanced morphological transformations.

For further details, please see: https://docs.opencv.org/master/d4/d86/group__imgproc__filter.html#ga67493776e3ad1a3df63883829375201f

func MulSpectrums added in v0.17.0

func MulSpectrums(a Mat, b Mat, dst *Mat, flags DftFlags)

Mulspectrums performs the per-element multiplication of two Fourier spectrums.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#ga3ab38646463c59bf0ce962a9d51db64f

func Multiply added in v0.16.0

func Multiply(src1 Mat, src2 Mat, dst *Mat)

Multiply calculates the per-element scaled product of two arrays. Both input arrays must be of the same size and the same type.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#ga979d898a58d7f61c53003e162e7ad89f

func MultiplyWithParams added in v0.30.1

func MultiplyWithParams(src1 Mat, src2 Mat, dst *Mat, scale float64, dtype MatType)

MultiplyWithParams calculates the per-element scaled product of two arrays. Both input arrays must be of the same size and the same type.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#ga979d898a58d7f61c53003e162e7ad89f

func Norm added in v0.8.0

func Norm(src1 Mat, normType NormType) float64

Norm calculates the absolute norm of an array.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#ga7c331fb8dd951707e184ef4e3f21dd33

func NormWithMats added in v0.30.1

func NormWithMats(src1 Mat, src2 Mat, normType NormType) float64

Norm calculates the absolute difference/relative norm of two arrays.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#ga7c331fb8dd951707e184ef4e3f21dd33

func Normalize added in v0.3.0

func Normalize(src Mat, dst *Mat, alpha float64, beta float64, typ NormType)

Normalize normalizes the norm or value range of an array.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#ga87eef7ee3970f86906d69a92cbf064bd

func OpenCVVersion

func OpenCVVersion() string

OpenCVVersion returns the current OpenCV lib version

func PerspectiveTransform added in v0.16.0

func PerspectiveTransform(src Mat, dst *Mat, tm Mat)

PerspectiveTransform performs the perspective matrix transformation of vectors.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#gad327659ac03e5fd6894b90025e6900a7

func Phase added in v0.17.0

func Phase(x, y Mat, angle *Mat, angleInDegrees bool)

Phase calculates the rotation angle of 2D vectors.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#ga9db9ca9b4d81c3bde5677b8f64dc0137

func PointPolygonTest added in v0.30.1

func PointPolygonTest(pts PointVector, pt image.Point, measureDist bool) float64

PointPolygonTest performs a point-in-contour test.

For further details, please see: https://docs.opencv.org/master/d3/dc0/group__imgproc__shape.html#ga1a539e8db2135af2566103705d7a5722

func PolarToCart added in v0.17.0

func PolarToCart(magnitude Mat, degree Mat, x *Mat, y *Mat, angleInDegrees bool)

PolatToCart calculates x and y coordinates of 2D vectors from their magnitude and angle.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#ga581ff9d44201de2dd1b40a50db93d665

func Polylines added in v0.30.1

func Polylines(img *Mat, pts PointsVector, isClosed bool, c color.RGBA, thickness int)

Polylines draws several polygonal curves.

For more information, see: https://docs.opencv.org/master/d6/d6e/group__imgproc__draw.html#ga1ea127ffbbb7e0bfc4fd6fd2eb64263c

func Pow added in v0.16.0

func Pow(src Mat, power float64, dst *Mat)

Pow raises every array element to a power.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#gaf0d056b5bd1dc92500d6f6cf6bac41ef

func PutText

func PutText(img *Mat, text string, org image.Point, fontFace HersheyFont, fontScale float64, c color.RGBA, thickness int)

PutText draws a text string. It renders the specified text string into the img Mat at the location passed in the "org" param, using the desired font face, font scale, color, and line thinkness.

For further details, please see: http://docs.opencv.org/master/d6/d6e/group__imgproc__draw.html#ga5126f47f883d730f633d74f07456c576

func PutTextWithParams added in v0.30.1

func PutTextWithParams(img *Mat, text string, org image.Point, fontFace HersheyFont, fontScale float64, c color.RGBA, thickness int, lineType LineType, bottomLeftOrigin bool)

PutTextWithParams draws a text string. It renders the specified text string into the img Mat at the location passed in the "org" param, using the desired font face, font scale, color, and line thinkness.

For further details, please see: http://docs.opencv.org/master/d6/d6e/group__imgproc__draw.html#ga5126f47f883d730f633d74f07456c576

func PyrDown added in v0.16.0

func PyrDown(src Mat, dst *Mat, ksize image.Point, borderType BorderType)

PyrDown blurs an image and downsamples it.

For further details, please see: https://docs.opencv.org/master/d4/d86/group__imgproc__filter.html#gaf9bba239dfca11654cb7f50f889fc2ff

func PyrUp added in v0.16.0

func PyrUp(src Mat, dst *Mat, ksize image.Point, borderType BorderType)

PyrUp upsamples an image and then blurs it.

For further details, please see: https://docs.opencv.org/master/d4/d86/group__imgproc__filter.html#gada75b59bdaaca411ed6fee10085eb784

func RandN added in v0.30.1

func RandN(mat *Mat, mean, stddev Scalar)

RandN Fills the array with normally distributed random numbers.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#gaeff1f61e972d133a04ce3a5f81cf6808

func RandShuffle added in v0.30.1

func RandShuffle(mat *Mat)

RandShuffle Shuffles the array elements randomly.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#ga6a789c8a5cb56c6dd62506179808f763

func RandShuffleWithParams added in v0.30.1

func RandShuffleWithParams(mat *Mat, iterFactor float64, rng RNG)

RandShuffleWithParams Shuffles the array elements randomly.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#ga6a789c8a5cb56c6dd62506179808f763

func RandU added in v0.30.1

func RandU(mat *Mat, low, high Scalar)

RandU Generates a single uniformly-distributed random number or an array of random numbers.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#ga1ba1026dca0807b27057ba6a49d258c0

func Rectangle

func Rectangle(img *Mat, r image.Rectangle, c color.RGBA, thickness int)

Rectangle draws a simple, thick, or filled up-right rectangle. It renders a rectangle with the desired characteristics to the target Mat image.

For further details, please see: http://docs.opencv.org/master/d6/d6e/group__imgproc__draw.html#ga346ac30b5c74e9b5137576c9ee9e0e8c

func RectangleWithParams added in v0.30.1

func RectangleWithParams(img *Mat, r image.Rectangle, c color.RGBA, thickness int, lineType LineType, shift int)

RectangleWithParams draws a simple, thick, or filled up-right rectangle. It renders a rectangle with the desired characteristics to the target Mat image.

For further details, please see: http://docs.opencv.org/master/d6/d6e/group__imgproc__draw.html#ga346ac30b5c74e9b5137576c9ee9e0e8c

func Reduce added in v0.17.0

func Reduce(src Mat, dst *Mat, dim int, rType ReduceTypes, dType MatType)

Reduce reduces a matrix to a vector.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#ga4b78072a303f29d9031d56e5638da78e

func Remap added in v0.17.0

func Remap(src Mat, dst, map1, map2 *Mat, interpolation InterpolationFlags, borderMode BorderType, borderValue color.RGBA)

Remap applies a generic geometrical transformation to an image.

For further details, please see: https://docs.opencv.org/master/da/d54/group__imgproc__transform.html#gab75ef31ce5cdfb5c44b6da5f3b908ea4

func Repeat added in v0.17.0

func Repeat(src Mat, nY int, nX int, dst *Mat)

Repeat fills the output array with repeated copies of the input array.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#ga496c3860f3ac44c40b48811333cfda2d

func Resize added in v0.3.0

func Resize(src Mat, dst *Mat, sz image.Point, fx, fy float64, interp InterpolationFlags)

Resize resizes an image. It resizes the image src down to or up to the specified size, storing the result in dst. Note that src and dst may be the same image. If you wish to scale by factor, an empty sz may be passed and non-zero fx and fy. Likewise, if you wish to scale to an explicit size, a non-empty sz may be passed with zero for both fx and fy.

For further details, please see: https://docs.opencv.org/master/da/d54/group__imgproc__transform.html#ga47a974309e9102f5f08231edc7e7529d

func Rotate added in v0.16.0

func Rotate(src Mat, dst *Mat, code RotateFlag)

Rotate rotates a 2D array in multiples of 90 degrees

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#ga4ad01c0978b0ce64baa246811deeac24

func SVDCompute added in v0.30.1

func SVDCompute(src Mat, w, u, vt *Mat)

SVDCompute decomposes matrix and stores the results to user-provided matrices

https://docs.opencv.org/4.1.2/df/df7/classcv_1_1SVD.html#a76f0b2044df458160292045a3d3714c6

func ScaleAdd added in v0.18.0

func ScaleAdd(src1 Mat, alpha float64, src2 Mat, dst *Mat)

Calculates the sum of a scaled array and another array.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#ga9e0845db4135f55dcf20227402f00d98

func Scharr added in v0.4.1

func Scharr(src Mat, dst *Mat, dDepth MatType, dx int, dy int, scale float64,
	delta float64, borderType BorderType)

Scharr calculates the first x- or y- image derivative using Scharr operator.

For further details, please see: https://docs.opencv.org/master/d4/d86/group__imgproc__filter.html#gaa13106761eedf14798f37aa2d60404c9

func SepFilter2D added in v0.17.0

func SepFilter2D(src Mat, dst *Mat, ddepth MatType, kernelX, kernelY Mat, anchor image.Point, delta float64, borderType BorderType)

SepFilter2D applies a separable linear filter to the image.

For further details, please see: https://docs.opencv.org/master/d4/d86/group__imgproc__filter.html#ga910e29ff7d7b105057d1625a4bf6318d

func SetGIFMaxFrameDimension added in v0.30.1

func SetGIFMaxFrameDimension(dim uint64)

SetGIFMaxFrameDimension sets the largest GIF width/height that can be decoded

func SetIdentity added in v0.30.1

func SetIdentity(src Mat, scalar float64)

SetIdentity initializes a scaled identity matrix. For further details, please see:

https://docs.opencv.org/master/d2/de8/group__core__array.html#ga388d7575224a4a277ceb98ccaa327c99

func SetRNGSeed added in v0.30.1

func SetRNGSeed(seed int)

TheRNG Sets state of default random number generator.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#ga757e657c037410d9e19e819569e7de0f

func Sobel added in v0.17.0

func Sobel(src Mat, dst *Mat, ddepth MatType, dx, dy, ksize int, scale, delta float64, borderType BorderType)

Sobel calculates the first, second, third, or mixed image derivatives using an extended Sobel operator

For further details, please see: https://docs.opencv.org/master/d4/d86/group__imgproc__filter.html#gacea54f142e81b6758cb6f375ce782c8d

func Solve added in v0.17.0

func Solve(src1 Mat, src2 Mat, dst *Mat, flags SolveDecompositionFlags) bool

Solve solves one or more linear systems or least-squares problems.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#ga12b43690dbd31fed96f213eefead2373

func SolveCubic added in v0.17.0

func SolveCubic(coeffs Mat, roots *Mat) int

SolveCubic finds the real roots of a cubic equation.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#ga1c3b0b925b085b6e96931ee309e6a1da

func SolvePoly added in v0.17.0

func SolvePoly(coeffs Mat, roots *Mat, maxIters int) float64

SolvePoly finds the real or complex roots of a polynomial equation.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#gac2f5e953016fabcdf793d762f4ec5dce

func Sort added in v0.17.0

func Sort(src Mat, dst *Mat, flags SortFlags)

Sort sorts each row or each column of a matrix.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#ga45dd56da289494ce874be2324856898f

func SortIdx added in v0.17.0

func SortIdx(src Mat, dst *Mat, flags SortFlags)

SortIdx sorts each row or each column of a matrix. Instead of reordering the elements themselves, it stores the indices of sorted elements in the output array

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#gadf35157cbf97f3cb85a545380e383506

func SpatialGradient added in v0.17.0

func SpatialGradient(src Mat, dx, dy *Mat, ksize MatType, borderType BorderType)

SpatialGradient calculates the first order image derivative in both x and y using a Sobel operator.

For further details, please see: https://docs.opencv.org/master/d4/d86/group__imgproc__filter.html#ga405d03b20c782b65a4daf54d233239a2

func SqBoxFilter added in v0.16.0

func SqBoxFilter(src Mat, dst *Mat, depth int, ksize image.Point)

SqBoxFilter calculates the normalized sum of squares of the pixel values overlapping the filter.

For further details, please see: https://docs.opencv.org/master/d4/d86/group__imgproc__filter.html#ga045028184a9ef65d7d2579e5c4bff6c0

func Subtract added in v0.16.0

func Subtract(src1 Mat, src2 Mat, dst *Mat)

Subtract calculates the per-element subtraction of two arrays or an array and a scalar.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#gaa0f00d98b4b5edeaeb7b8333b2de353b

func Threshold added in v0.4.1

func Threshold(src Mat, dst *Mat, thresh float32, maxvalue float32, typ ThresholdType) (threshold float32)

Threshold applies a fixed-level threshold to each array element.

For further details, please see: https://docs.opencv.org/3.3.0/d7/d1b/group__imgproc__misc.html#gae8a4a146d1ca78c626a53577199e9c57

func Transform added in v0.16.0

func Transform(src Mat, dst *Mat, tm Mat)

Transform performs the matrix transformation of every array element.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#ga393164aa54bb9169ce0a8cc44e08ff22

func Transpose added in v0.16.0

func Transpose(src Mat, dst *Mat)

Transpose transposes a matrix.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#ga46630ed6c0ea6254a35f447289bd7404

func Vconcat added in v0.16.0

func Vconcat(src1, src2 Mat, dst *Mat)

Vconcat applies vertical concatenation to given matrices.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#gaab5ceee39e0580f879df645a872c6bf7

func Version

func Version() string

Version returns the current golang package version

func WarpAffine added in v0.8.0

func WarpAffine(src Mat, dst *Mat, m Mat, sz image.Point)

WarpAffine applies an affine transformation to an image. For more parameters please check WarpAffineWithParams

For further details, please see: https://docs.opencv.org/master/da/d54/group__imgproc__transform.html#ga0203d9ee5fcd28d40dbc4a1ea4451983

func WarpAffineWithParams added in v0.8.0

func WarpAffineWithParams(src Mat, dst *Mat, m Mat, sz image.Point, flags InterpolationFlags, borderType BorderType, borderValue color.RGBA)

WarpAffineWithParams applies an affine transformation to an image.

For further details, please see: https://docs.opencv.org/master/da/d54/group__imgproc__transform.html#ga0203d9ee5fcd28d40dbc4a1ea4451983

func WarpPerspective added in v0.16.0

func WarpPerspective(src Mat, dst *Mat, m Mat, sz image.Point)

WarpPerspective applies a perspective transformation to an image.

For further details, please see: https://docs.opencv.org/master/da/d54/group__imgproc__transform.html#gaf73673a7e8e18ec6963e3774e6a94b87

func Watershed added in v0.30.1

func Watershed(image Mat, markers *Mat)

Watershed performs a marker-based image segmentation using the watershed algorithm.

For further details, please see: https://docs.opencv.org/master/d7/d1b/group__imgproc__misc.html#ga3267243e4d3f95165d55a618c65ac6e1

Types

type AdaptiveThresholdType added in v0.16.0

type AdaptiveThresholdType int

AdaptiveThresholdType type of adaptive threshold operation.

const (
	// AdaptiveThresholdMean threshold type
	AdaptiveThresholdMean AdaptiveThresholdType = 0

	// AdaptiveThresholdGaussian threshold type
	AdaptiveThresholdGaussian AdaptiveThresholdType = 1
)

func (AdaptiveThresholdType) String added in v0.30.1

func (c AdaptiveThresholdType) String() string

type BorderType added in v0.4.1

type BorderType int

BorderType type of border.

const (
	// BorderConstant border type
	BorderConstant BorderType = 0

	// BorderReplicate border type
	BorderReplicate BorderType = 1

	// BorderReflect border type
	BorderReflect BorderType = 2

	// BorderWrap border type
	BorderWrap BorderType = 3

	// BorderReflect101 border type
	BorderReflect101 BorderType = 4

	// BorderTransparent border type
	BorderTransparent BorderType = 5

	// BorderDefault border type
	BorderDefault = BorderReflect101

	// BorderIsolated border type
	BorderIsolated BorderType = 16
)

func (BorderType) String added in v0.30.1

func (c BorderType) String() string

type CLAHE added in v0.30.1

type CLAHE struct {
	// contains filtered or unexported fields
}

CLAHE is a wrapper around the cv::CLAHE algorithm.

func NewCLAHE added in v0.30.1

func NewCLAHE() CLAHE

NewCLAHE returns a new CLAHE algorithm

For further details, please see: https://docs.opencv.org/master/d6/db6/classcv_1_1CLAHE.html

func NewCLAHEWithParams added in v0.30.1

func NewCLAHEWithParams(clipLimit float64, tileGridSize image.Point) CLAHE

NewCLAHEWithParams returns a new CLAHE algorithm

For further details, please see: https://docs.opencv.org/master/d6/db6/classcv_1_1CLAHE.html

func (*CLAHE) Apply added in v0.30.1

func (c *CLAHE) Apply(src Mat, dst *Mat)

Apply CLAHE.

For further details, please see: https://docs.opencv.org/master/d6/db6/classcv_1_1CLAHE.html#a4e92e0e427de21be8d1fae8dcd862c5e

func (*CLAHE) Close added in v0.30.1

func (c *CLAHE) Close() error

Close CLAHE.

type ColorConversionCode

type ColorConversionCode int

ColorConversionCode is a color conversion code used on Mat.

For further details, please see: http://docs.opencv.org/master/d7/d1b/group__imgproc__misc.html#ga4e0972be5de079fed4e3a10e24ef5ef0

const (
	// ColorBGRToBGRA adds alpha channel to BGR image.
	ColorBGRToBGRA ColorConversionCode = 0

	// ColorBGRAToBGR removes alpha channel from BGR image.
	ColorBGRAToBGR ColorConversionCode = 1

	// ColorBGRToRGBA converts from BGR to RGB with alpha channel.
	ColorBGRToRGBA ColorConversionCode = 2

	// ColorRGBAToBGR converts from RGB with alpha to BGR color space.
	ColorRGBAToBGR ColorConversionCode = 3

	// ColorBGRToRGB converts from BGR to RGB without alpha channel.
	ColorBGRToRGB ColorConversionCode = 4

	// ColorBGRAToRGBA converts from BGR with alpha channel
	// to RGB with alpha channel.
	ColorBGRAToRGBA ColorConversionCode = 5

	// ColorBGRToGray converts from BGR to grayscale.
	ColorBGRToGray ColorConversionCode = 6

	// ColorRGBToGray converts from RGB to grayscale.
	ColorRGBToGray ColorConversionCode = 7

	// ColorGrayToBGR converts from grayscale to BGR.
	ColorGrayToBGR ColorConversionCode = 8

	// ColorGrayToBGRA converts from grayscale to BGR with alpha channel.
	ColorGrayToBGRA ColorConversionCode = 9

	// ColorBGRAToGray converts from BGR with alpha channel to grayscale.
	ColorBGRAToGray ColorConversionCode = 10

	// ColorRGBAToGray converts from RGB with alpha channel to grayscale.
	ColorRGBAToGray ColorConversionCode = 11

	// ColorBGRToBGR565 converts from BGR to BGR565 (16-bit images).
	ColorBGRToBGR565 ColorConversionCode = 12

	// ColorRGBToBGR565 converts from RGB to BGR565 (16-bit images).
	ColorRGBToBGR565 ColorConversionCode = 13

	// ColorBGR565ToBGR converts from BGR565 (16-bit images) to BGR.
	ColorBGR565ToBGR ColorConversionCode = 14

	// ColorBGR565ToRGB converts from BGR565 (16-bit images) to RGB.
	ColorBGR565ToRGB ColorConversionCode = 15

	// ColorBGRAToBGR565 converts from BGRA (with alpha channel)
	// to BGR565 (16-bit images).
	ColorBGRAToBGR565 ColorConversionCode = 16

	// ColorRGBAToBGR565 converts from RGBA (with alpha channel)
	// to BGR565 (16-bit images).
	ColorRGBAToBGR565 ColorConversionCode = 17

	// ColorBGR565ToBGRA converts from BGR565 (16-bit images)
	// to BGRA (with alpha channel).
	ColorBGR565ToBGRA ColorConversionCode = 18

	// ColorBGR565ToRGBA converts from BGR565 (16-bit images)
	// to RGBA (with alpha channel).
	ColorBGR565ToRGBA ColorConversionCode = 19

	// ColorGrayToBGR565 converts from grayscale
	// to BGR565 (16-bit images).
	ColorGrayToBGR565 ColorConversionCode = 20

	// ColorBGR565ToGray converts from BGR565 (16-bit images)
	// to grayscale.
	ColorBGR565ToGray ColorConversionCode = 21

	// ColorBGRToBGR555 converts from BGR to BGR555 (16-bit images).
	ColorBGRToBGR555 ColorConversionCode = 22

	// ColorRGBToBGR555 converts from RGB to BGR555 (16-bit images).
	ColorRGBToBGR555 ColorConversionCode = 23

	// ColorBGR555ToBGR converts from BGR555 (16-bit images) to BGR.
	ColorBGR555ToBGR ColorConversionCode = 24

	// ColorBGR555ToRGB converts from BGR555 (16-bit images) to RGB.
	ColorBGR555ToRGB ColorConversionCode = 25

	// ColorBGRAToBGR555 converts from BGRA (with alpha channel)
	// to BGR555 (16-bit images).
	ColorBGRAToBGR555 ColorConversionCode = 26

	// ColorRGBAToBGR555 converts from RGBA (with alpha channel)
	// to BGR555 (16-bit images).
	ColorRGBAToBGR555 ColorConversionCode = 27

	// ColorBGR555ToBGRA converts from BGR555 (16-bit images)
	// to BGRA (with alpha channel).
	ColorBGR555ToBGRA ColorConversionCode = 28

	// ColorBGR555ToRGBA converts from BGR555 (16-bit images)
	// to RGBA (with alpha channel).
	ColorBGR555ToRGBA ColorConversionCode = 29

	// ColorGrayToBGR555 converts from grayscale to BGR555 (16-bit images).
	ColorGrayToBGR555 ColorConversionCode = 30

	// ColorBGR555ToGRAY converts from BGR555 (16-bit images) to grayscale.
	ColorBGR555ToGRAY ColorConversionCode = 31

	// ColorBGRToXYZ converts from BGR to CIE XYZ.
	ColorBGRToXYZ ColorConversionCode = 32

	// ColorRGBToXYZ converts from RGB to CIE XYZ.
	ColorRGBToXYZ ColorConversionCode = 33

	// ColorXYZToBGR converts from CIE XYZ to BGR.
	ColorXYZToBGR ColorConversionCode = 34

	// ColorXYZToRGB converts from CIE XYZ to RGB.
	ColorXYZToRGB ColorConversionCode = 35

	// ColorBGRToYCrCb converts from BGR to luma-chroma (aka YCC).
	ColorBGRToYCrCb ColorConversionCode = 36

	// ColorRGBToYCrCb converts from RGB to luma-chroma (aka YCC).
	ColorRGBToYCrCb ColorConversionCode = 37

	// ColorYCrCbToBGR converts from luma-chroma (aka YCC) to BGR.
	ColorYCrCbToBGR ColorConversionCode = 38

	// ColorYCrCbToRGB converts from luma-chroma (aka YCC) to RGB.
	ColorYCrCbToRGB ColorConversionCode = 39

	// ColorBGRToHSV converts from BGR to HSV (hue saturation value).
	ColorBGRToHSV ColorConversionCode = 40

	// ColorRGBToHSV converts from RGB to HSV (hue saturation value).
	ColorRGBToHSV ColorConversionCode = 41

	// ColorBGRToLab converts from BGR to CIE Lab.
	ColorBGRToLab ColorConversionCode = 44

	// ColorRGBToLab converts from RGB to CIE Lab.
	ColorRGBToLab ColorConversionCode = 45

	// ColorBGRToLuv converts from BGR to CIE Luv.
	ColorBGRToLuv ColorConversionCode = 50

	// ColorRGBToLuv converts from RGB to CIE Luv.
	ColorRGBToLuv ColorConversionCode = 51

	// ColorBGRToHLS converts from BGR to HLS (hue lightness saturation).
	ColorBGRToHLS ColorConversionCode = 52

	// ColorRGBToHLS converts from RGB to HLS (hue lightness saturation).
	ColorRGBToHLS ColorConversionCode = 53

	// ColorHSVToBGR converts from HSV (hue saturation value) to BGR.
	ColorHSVToBGR ColorConversionCode = 54

	// ColorHSVToRGB converts from HSV (hue saturation value) to RGB.
	ColorHSVToRGB ColorConversionCode = 55

	// ColorLabToBGR converts from CIE Lab to BGR.
	ColorLabToBGR ColorConversionCode = 56

	// ColorLabToRGB converts from CIE Lab to RGB.
	ColorLabToRGB ColorConversionCode = 57

	// ColorLuvToBGR converts from CIE Luv to BGR.
	ColorLuvToBGR ColorConversionCode = 58

	// ColorLuvToRGB converts from CIE Luv to RGB.
	ColorLuvToRGB ColorConversionCode = 59

	// ColorHLSToBGR converts from HLS (hue lightness saturation) to BGR.
	ColorHLSToBGR ColorConversionCode = 60

	// ColorHLSToRGB converts from HLS (hue lightness saturation) to RGB.
	ColorHLSToRGB ColorConversionCode = 61

	// ColorBGRToHSVFull converts from BGR to HSV (hue saturation value) full.
	ColorBGRToHSVFull ColorConversionCode = 66

	// ColorRGBToHSVFull converts from RGB to HSV (hue saturation value) full.
	ColorRGBToHSVFull ColorConversionCode = 67

	// ColorBGRToHLSFull converts from BGR to HLS (hue lightness saturation) full.
	ColorBGRToHLSFull ColorConversionCode = 68

	// ColorRGBToHLSFull converts from RGB to HLS (hue lightness saturation) full.
	ColorRGBToHLSFull ColorConversionCode = 69

	// ColorHSVToBGRFull converts from HSV (hue saturation value) to BGR full.
	ColorHSVToBGRFull ColorConversionCode = 70

	// ColorHSVToRGBFull converts from HSV (hue saturation value) to RGB full.
	ColorHSVToRGBFull ColorConversionCode = 71

	// ColorHLSToBGRFull converts from HLS (hue lightness saturation) to BGR full.
	ColorHLSToBGRFull ColorConversionCode = 72

	// ColorHLSToRGBFull converts from HLS (hue lightness saturation) to RGB full.
	ColorHLSToRGBFull ColorConversionCode = 73

	// ColorLBGRToLab converts from LBGR to CIE Lab.
	ColorLBGRToLab ColorConversionCode = 74

	// ColorLRGBToLab converts from LRGB to CIE Lab.
	ColorLRGBToLab ColorConversionCode = 75

	// ColorLBGRToLuv converts from LBGR to CIE Luv.
	ColorLBGRToLuv ColorConversionCode = 76

	// ColorLRGBToLuv converts from LRGB to CIE Luv.
	ColorLRGBToLuv ColorConversionCode = 77

	// ColorLabToLBGR converts from CIE Lab to LBGR.
	ColorLabToLBGR ColorConversionCode = 78

	// ColorLabToLRGB converts from CIE Lab to LRGB.
	ColorLabToLRGB ColorConversionCode = 79

	// ColorLuvToLBGR converts from CIE Luv to LBGR.
	ColorLuvToLBGR ColorConversionCode = 80

	// ColorLuvToLRGB converts from CIE Luv to LRGB.
	ColorLuvToLRGB ColorConversionCode = 81

	// ColorBGRToYUV converts from BGR to YUV.
	ColorBGRToYUV ColorConversionCode = 82

	// ColorRGBToYUV converts from RGB to YUV.
	ColorRGBToYUV ColorConversionCode = 83

	// ColorYUVToBGR converts from YUV to BGR.
	ColorYUVToBGR ColorConversionCode = 84

	// ColorYUVToRGB converts from YUV to RGB.
	ColorYUVToRGB ColorConversionCode = 85

	// ColorYUVToRGBNV12 converts from YUV 4:2:0 to RGB NV12.
	ColorYUVToRGBNV12 ColorConversionCode = 90

	// ColorYUVToBGRNV12 converts from YUV 4:2:0 to BGR NV12.
	ColorYUVToBGRNV12 ColorConversionCode = 91

	// ColorYUVToRGBNV21 converts from YUV 4:2:0 to RGB NV21.
	ColorYUVToRGBNV21 ColorConversionCode = 92

	// ColorYUVToBGRNV21 converts from YUV 4:2:0 to BGR NV21.
	ColorYUVToBGRNV21 ColorConversionCode = 93

	// ColorYUVToRGBANV12 converts from YUV 4:2:0 to RGBA NV12.
	ColorYUVToRGBANV12 ColorConversionCode = 94

	// ColorYUVToBGRANV12 converts from YUV 4:2:0 to BGRA NV12.
	ColorYUVToBGRANV12 ColorConversionCode = 95

	// ColorYUVToRGBANV21 converts from YUV 4:2:0 to RGBA NV21.
	ColorYUVToRGBANV21 ColorConversionCode = 96

	// ColorYUVToBGRANV21 converts from YUV 4:2:0 to BGRA NV21.
	ColorYUVToBGRANV21 ColorConversionCode = 97

	ColorYUVToRGBYV12 ColorConversionCode = 98
	ColorYUVToBGRYV12 ColorConversionCode = 99
	ColorYUVToRGBIYUV ColorConversionCode = 100
	ColorYUVToBGRIYUV ColorConversionCode = 101

	ColorYUVToRGBAYV12 ColorConversionCode = 102
	ColorYUVToBGRAYV12 ColorConversionCode = 103
	ColorYUVToRGBAIYUV ColorConversionCode = 104
	ColorYUVToBGRAIYUV ColorConversionCode = 105

	ColorYUVToGRAY420 ColorConversionCode = 106

	// YUV 4:2:2 family to RGB
	ColorYUVToRGBUYVY ColorConversionCode = 107
	ColorYUVToBGRUYVY ColorConversionCode = 108

	ColorYUVToRGBAUYVY ColorConversionCode = 111
	ColorYUVToBGRAUYVY ColorConversionCode = 112

	ColorYUVToRGBYUY2 ColorConversionCode = 115
	ColorYUVToBGRYUY2 ColorConversionCode = 116
	ColorYUVToRGBYVYU ColorConversionCode = 117
	ColorYUVToBGRYVYU ColorConversionCode = 118

	ColorYUVToRGBAYUY2 ColorConversionCode = 119
	ColorYUVToBGRAYUY2 ColorConversionCode = 120
	ColorYUVToRGBAYVYU ColorConversionCode = 121
	ColorYUVToBGRAYVYU ColorConversionCode = 122

	ColorYUVToGRAYUYVY ColorConversionCode = 123
	ColorYUVToGRAYYUY2 ColorConversionCode = 124

	// alpha premultiplication
	ColorRGBATomRGBA ColorConversionCode = 125
	ColormRGBAToRGBA ColorConversionCode = 126

	// RGB to YUV 4:2:0 family
	ColorRGBToYUVI420 ColorConversionCode = 127
	ColorBGRToYUVI420 ColorConversionCode = 128

	ColorRGBAToYUVI420 ColorConversionCode = 129
	ColorBGRAToYUVI420 ColorConversionCode = 130
	ColorRGBToYUVYV12  ColorConversionCode = 131
	ColorBGRToYUVYV12  ColorConversionCode = 132
	ColorRGBAToYUVYV12 ColorConversionCode = 133
	ColorBGRAToYUVYV12 ColorConversionCode = 134

	// Demosaicing
	ColorBayerBGToBGR ColorConversionCode = 46
	ColorBayerGBToBGR ColorConversionCode = 47
	ColorBayerRGToBGR ColorConversionCode = 48
	ColorBayerGRToBGR ColorConversionCode = 49

	ColorBayerBGToGRAY ColorConversionCode = 86
	ColorBayerGBToGRAY ColorConversionCode = 87
	ColorBayerRGToGRAY ColorConversionCode = 88
	ColorBayerGRToGRAY ColorConversionCode = 89

	// Demosaicing using Variable Number of Gradients
	ColorBayerBGToBGRVNG ColorConversionCode = 62
	ColorBayerGBToBGRVNG ColorConversionCode = 63
	ColorBayerRGToBGRVNG ColorConversionCode = 64
	ColorBayerGRToBGRVNG ColorConversionCode = 65

	// Edge-Aware Demosaicing
	ColorBayerBGToBGREA ColorConversionCode = 135
	ColorBayerGBToBGREA ColorConversionCode = 136
	ColorBayerRGToBGREA ColorConversionCode = 137
	ColorBayerGRToBGREA ColorConversionCode = 138

	// Demosaicing with alpha channel
	ColorBayerBGToBGRA ColorConversionCode = 139
	ColorBayerGBToBGRA ColorConversionCode = 140
	ColorBayerRGToBGRA ColorConversionCode = 141
	ColorBayerGRToBGRA ColorConversionCode = 142

	ColorCOLORCVTMAX ColorConversionCode = 143
)

func (ColorConversionCode) String added in v0.30.1

func (c ColorConversionCode) String() string

type ColormapTypes added in v0.8.0

type ColormapTypes int

ColormapTypes are the 12 GNU Octave/MATLAB equivalent colormaps.

For further details, please see: https://docs.opencv.org/master/d3/d50/group__imgproc__colormap.html

const (
	ColormapAutumn  ColormapTypes = 0
	ColormapBone    ColormapTypes = 1
	ColormapJet     ColormapTypes = 2
	ColormapWinter  ColormapTypes = 3
	ColormapRainbow ColormapTypes = 4
	ColormapOcean   ColormapTypes = 5
	ColormapSummer  ColormapTypes = 6
	ColormapSpring  ColormapTypes = 7
	ColormapCool    ColormapTypes = 8
	ColormapHsv     ColormapTypes = 9
	ColormapPink    ColormapTypes = 10
	ColormapHot     ColormapTypes = 11
	ColormapParula  ColormapTypes = 12
)

List of the available color maps

For further details, please see: https://docs.opencv.org/master/d3/d50/group__imgproc__colormap.html#ga9a805d8262bcbe273f16be9ea2055a65

func (ColormapTypes) String added in v0.30.1

func (c ColormapTypes) String() string

type CompareType added in v0.16.0

type CompareType int

CompareType is used for Compare operations to indicate which kind of comparison to use.

const (
	// CompareEQ src1 is equal to src2.
	CompareEQ CompareType = 0

	// CompareGT src1 is greater than src2.
	CompareGT CompareType = 1

	// CompareGE src1 is greater than or equal to src2.
	CompareGE CompareType = 2

	// CompareLT src1 is less than src2.
	CompareLT CompareType = 3

	// CompareLE src1 is less than or equal to src2.
	CompareLE CompareType = 4

	// CompareNE src1 is unequal to src2.
	CompareNE CompareType = 5
)

func (CompareType) String added in v0.30.1

func (c CompareType) String() string

type ConnectedComponentsAlgorithmType added in v0.30.1

type ConnectedComponentsAlgorithmType int

ConnectedComponentsAlgorithmType specifies the type for ConnectedComponents

const (
	// SAUF algorithm for 8-way connectivity, SAUF algorithm for 4-way connectivity.
	CCL_WU ConnectedComponentsAlgorithmType = 0

	// BBDT algorithm for 8-way connectivity, SAUF algorithm for 4-way connectivity.
	CCL_DEFAULT ConnectedComponentsAlgorithmType = 1

	// BBDT algorithm for 8-way connectivity, SAUF algorithm for 4-way connectivity
	CCL_GRANA ConnectedComponentsAlgorithmType = 2
)

func (ConnectedComponentsAlgorithmType) String added in v0.30.1

type ConnectedComponentsTypes added in v0.30.1

type ConnectedComponentsTypes int

ConnectedComponentsTypes are the connected components algorithm output formats

const (
	//The leftmost (x) coordinate which is the inclusive start of the bounding box in the horizontal direction.
	CC_STAT_LEFT ConnectedComponentsTypes = 0

	//The topmost (y) coordinate which is the inclusive start of the bounding box in the vertical direction.
	CC_STAT_TOP ConnectedComponentsTypes = 1

	// The horizontal size of the bounding box.
	CC_STAT_WIDTH ConnectedComponentsTypes = 2

	// The vertical size of the bounding box.
	CC_STAT_HEIGHT ConnectedComponentsTypes = 3

	// The total area (in pixels) of the connected component.
	CC_STAT_AREA ConnectedComponentsTypes = 4

	CC_STAT_MAX ConnectedComponentsTypes = 5
)

func (ConnectedComponentsTypes) String added in v0.30.1

func (c ConnectedComponentsTypes) String() string

type ContourApproximationMode added in v0.4.1

type ContourApproximationMode int

ContourApproximationMode is the mode of the contour approximation algorithm.

const (
	// ChainApproxNone stores absolutely all the contour points. That is,
	// any 2 subsequent points (x1,y1) and (x2,y2) of the contour will be
	// either horizontal, vertical or diagonal neighbors, that is,
	// max(abs(x1-x2),abs(y2-y1))==1.
	ChainApproxNone ContourApproximationMode = 1

	// ChainApproxSimple compresses horizontal, vertical, and diagonal segments
	// and leaves only their end points.
	// For example, an up-right rectangular contour is encoded with 4 points.
	ChainApproxSimple ContourApproximationMode = 2

	// ChainApproxTC89L1 applies one of the flavors of the Teh-Chin chain
	// approximation algorithms.
	ChainApproxTC89L1 ContourApproximationMode = 3

	// ChainApproxTC89KCOS applies one of the flavors of the Teh-Chin chain
	// approximation algorithms.
	ChainApproxTC89KCOS ContourApproximationMode = 4
)

func (ContourApproximationMode) String added in v0.30.1

func (c ContourApproximationMode) String() string

type CovarFlags added in v0.16.0

type CovarFlags int

CovarFlags are the covariation flags used by functions such as BorderInterpolate.

For further details, please see: https://docs.opencv.org/master/d0/de1/group__core.html#ga719ebd4a73f30f4fab258ab7616d0f0f

const (
	// CovarScrambled indicates to scramble the results.
	CovarScrambled CovarFlags = 0

	// CovarNormal indicates to use normal covariation.
	CovarNormal CovarFlags = 1

	// CovarUseAvg indicates to use average covariation.
	CovarUseAvg CovarFlags = 2

	// CovarScale indicates to use scaled covariation.
	CovarScale CovarFlags = 4

	// CovarRows indicates to use covariation on rows.
	CovarRows CovarFlags = 8

	// CovarCols indicates to use covariation on columns.
	CovarCols CovarFlags = 16
)

func (CovarFlags) String added in v0.30.1

func (c CovarFlags) String() string

type DMatch added in v0.16.0

type DMatch struct {
	QueryIdx int
	TrainIdx int
	ImgIdx   int
	Distance float64
}

DMatch is data structure for matching keypoint descriptors.

For further details, please see: https://docs.opencv.org/master/d4/de0/classcv_1_1DMatch.html#a546ddb9a87898f06e510e015a6de596e

type DftFlags added in v0.16.0

type DftFlags int

DftFlags represents a DFT or DCT flag.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#gaf4dde112b483b38175621befedda1f1c

const (
	// DftForward performs forward 1D or 2D dft or dct.
	DftForward DftFlags = 0

	// DftInverse performs an inverse 1D or 2D transform.
	DftInverse DftFlags = 1

	// DftScale scales the result: divide it by the number of array elements. Normally, it is combined with DFT_INVERSE.
	DftScale DftFlags = 2

	// DftRows performs a forward or inverse transform of every individual row of the input matrix.
	DftRows DftFlags = 4

	// DftComplexOutput performs a forward transformation of 1D or 2D real array; the result, though being a complex array, has complex-conjugate symmetry
	DftComplexOutput DftFlags = 16

	// DftRealOutput performs an inverse transformation of a 1D or 2D complex array; the result is normally a complex array of the same size,
	// however, if the input array has conjugate-complex symmetry (for example, it is a result of forward transformation with DFT_COMPLEX_OUTPUT flag),
	// the output is a real array.
	DftRealOutput DftFlags = 32

	// DftComplexInput specifies that input is complex input. If this flag is set, the input must have 2 channels.
	DftComplexInput DftFlags = 64

	// DctInverse performs an inverse 1D or 2D dct transform.
	DctInverse = DftInverse

	// DctRows performs a forward or inverse dct transform of every individual row of the input matrix.
	DctRows = DftRows
)

func (DftFlags) String added in v0.30.1

func (c DftFlags) String() string

type DistanceTransformLabelTypes added in v0.30.1

type DistanceTransformLabelTypes int

DistanceTransformLabelTypes are the types of the DistanceTransform algorithm flag

const (
	// DistanceLabelCComp assigns the same label to each connected component of zeros in the source image
	// (as well as all the non-zero pixels closest to the connected component).
	DistanceLabelCComp DistanceTransformLabelTypes = 0

	// DistanceLabelPixel assigns its own label to each zero pixel (and all the non-zero pixels closest to it).
	DistanceLabelPixel
)

func (DistanceTransformLabelTypes) String added in v0.30.1

type DistanceTransformMasks added in v0.30.1

type DistanceTransformMasks int

DistanceTransformMasks are the marsk sizes for distance transform

const (
	// DistanceMask3 is a mask of size 3
	DistanceMask3 DistanceTransformMasks = 0

	// DistanceMask5 is a mask of size 3
	DistanceMask5

	// DistanceMaskPrecise is not currently supported
	DistanceMaskPrecise
)

func (DistanceTransformMasks) String added in v0.30.1

func (c DistanceTransformMasks) String() string

type DistanceTypes added in v0.17.0

type DistanceTypes int

DistanceTypes types for Distance Transform and M-estimatorss

For further details, please see: https://docs.opencv.org/master/d7/d1b/group__imgproc__misc.html#gaa2bfbebbc5c320526897996aafa1d8eb

const (
	DistUser   DistanceTypes = 0
	DistL1     DistanceTypes = 1
	DistL2     DistanceTypes = 2
	DistC      DistanceTypes = 3
	DistL12    DistanceTypes = 4
	DistFair   DistanceTypes = 5
	DistWelsch DistanceTypes = 6
	DistHuber  DistanceTypes = 7
)

func (DistanceTypes) String added in v0.30.1

func (c DistanceTypes) String() string

type FileExt added in v0.8.0

type FileExt string

FileExt represents a file extension.

const (
	// PNGFileExt is the file extension for PNG.
	PNGFileExt FileExt = ".png"
	// JPEGFileExt is the file extension for JPEG.
	JPEGFileExt FileExt = ".jpg"
	// GIFFileExt is the file extension for GIF.
	GIFFileExt FileExt = ".gif"
	// WWEBPFileExt is the file extension for WEBP.
	WWEBPFileExt FileExt = ".webp"
)

type Framebuffer added in v0.30.1

type Framebuffer struct {
	// contains filtered or unexported fields
}

Framebuffer contains an array of raw, decoded pixel data.

func NewFramebuffer added in v0.30.2

func NewFramebuffer(width, height int) *Framebuffer

NewFramebuffer creates the backing store for a pixel frame buffer.

func (*Framebuffer) Clear added in v0.30.2

func (f *Framebuffer) Clear()

Clear resets all of the pixel data in Framebuffer.

func (*Framebuffer) Close added in v0.30.2

func (f *Framebuffer) Close()

Close releases the resources associated with Framebuffer.

func (*Framebuffer) Duration added in v0.30.2

func (f *Framebuffer) Duration() time.Duration

Duration returns the length of time this frame plays out in an animated image

func (*Framebuffer) Fit added in v0.30.2

func (f *Framebuffer) Fit(width, height int, dst *Framebuffer) error

func (*Framebuffer) Height added in v0.30.1

func (f *Framebuffer) Height() int

Height returns the height of the contained pixel data in number of pixels. This may differ from the capacity of the framebuffer.

func (*Framebuffer) ResizeTo added in v0.30.2

func (f *Framebuffer) ResizeTo(width, height int, dst *Framebuffer) error

ResizeTo performs a resizing transform on the Framebuffer and puts the result in the provided destination Framebuffer. This function does not preserve aspect ratio if the given dimensions differ in ratio from the source. Returns an error if the destination is not large enough to hold the given dimensions.

func (*Framebuffer) Width added in v0.30.1

func (f *Framebuffer) Width() int

Width returns the width of the contained pixel data in number of pixels. This may differ from the capacity of the framebuffer.

type GifDecoder added in v0.30.2

type GifDecoder interface {
	// Header returns basic image metadata from the image.
	// This is done lazily, reading only the first part of the image and not
	// a full decode.
	Header() (*ImageHeader, error)

	// Close releases any resources associated with the Decoder
	Close()

	// Description returns a string description of the image type, such as
	// "PNG"
	Description() string

	// Duration returns the duration of the content. This property is 0 for
	// static images and animated GIFs.
	Duration() time.Duration

	// DecodeTo fully decodes the image pixel data into f. Generally users should
	// prefer instead using the ImageOps object to decode images.
	DecodeTo(f *Framebuffer) error

	// SkipFrame skips a frame if the decoder supports multiple frames
	// and returns io.EOF if the last frame has been reached
	SkipFrame() error
}

func NewGifDecoder added in v0.30.2

func NewGifDecoder(buf []byte) (GifDecoder, error)

NewGifDecoder returns a Decoder which can be used to decode image data provided in buf. If the first few bytes of buf do not point to a valid magic string, an error will be returned.

type GifEncoder added in v0.30.2

type GifEncoder interface {
	// Encode encodes the pixel data in f into the dst provided to NewGifEncoder. Encode quality
	// options can be passed into opt, such as map[int]int{lilliput.JpegQuality: 80}
	Encode(f *Framebuffer, opt map[int]int) ([]byte, error)

	// Close releases any resources associated with the Encoder
	Close()
}

An Encoder compresses raw pixel data into a well-known image type.

func NewGifEncoder added in v0.30.2

func NewGifEncoder(ext string, decodedBy GifDecoder, dst []byte) (GifEncoder, error)

NewGifEncoder returns an Encode which can be used to encode Framebuffer into compressed image data. ext should be a string like ".jpeg" or ".png". decodedBy is optional and can be the Decoder used to make the Framebuffer. dst is where an encoded image will be written.

type GifOps added in v0.30.2

type GifOps struct {
	// contains filtered or unexported fields
}

GifOps is a reusable object that can resize and encode images.

func NewGifOps added in v0.30.2

func NewGifOps(maxSize int) *GifOps

NewGifOps creates a new GifOps object that will operate on images up to maxSize on each axis.

func (*GifOps) Clear added in v0.30.2

func (o *GifOps) Clear()

Clear resets all pixel data in GifOps. This need not be called between calls to Transform. You may choose to call this to remove image data from memory.

func (*GifOps) Close added in v0.30.2

func (o *GifOps) Close()

Close releases resources associated with GifOps

func (*GifOps) Transform added in v0.30.2

func (o *GifOps) Transform(d GifDecoder, opt *GifOptions, dst []byte) ([]byte, error)

Transform performs the requested transform operations on the GifDecoder specified by d. The result is written into the output buffer dst. A new slice pointing to dst is returned with its length set to the length of the resulting image. Errors may occur if the decoded image is too large for GifOps or if Encoding fails.

It is important that .Decode() not have been called already on d.

type GifOpsSizeMethod added in v0.30.2

type GifOpsSizeMethod int
const (
	GifOpsNoResize GifOpsSizeMethod = iota
	GifOpsFit
	GifOpsResize
)

type GifOptions added in v0.30.2

type GifOptions struct {
	// FileType should be a string starting with '.', e.g.
	// ".jpeg"
	FileType string

	// Width controls the width of the output image
	Width int

	// Height controls the height of the output image
	Height int

	// ResizeMethod controls how the image will be transformed to
	// its output size. Notably, GifOpsFit will do a cropping
	// resize, while GifOpsResize will stretch the image.
	ResizeMethod GifOpsSizeMethod

	// EncodeOptions controls the encode quality options
	EncodeOptions map[int]int

	// MaxEncodeFrames controls the maximum number of frames that will be resized
	MaxEncodeFrames int

	// MaxEncodeDuration controls the maximum duration of animated image that will be resized
	MaxEncodeDuration time.Duration
}

GifOptions controls how GifOps resizes and encodes the pixel data decoded from a GifDecoder

type GrabCutMode added in v0.30.1

type GrabCutMode int

GrabCutMode is the flag for GrabCut algorithm.

const (
	// GCInitWithRect makes the function initialize the state and the mask using the provided rectangle.
	// After that it runs the itercount iterations of the algorithm.
	GCInitWithRect GrabCutMode = 0
	// GCInitWithMask makes the function initialize the state using the provided mask.
	// GCInitWithMask and GCInitWithRect can be combined.
	// Then all the pixels outside of the ROI are automatically initialized with GC_BGD.
	GCInitWithMask GrabCutMode = 1
	// GCEval means that the algorithm should just resume.
	GCEval GrabCutMode = 2
	// GCEvalFreezeModel means that the algorithm should just run a single iteration of the GrabCut algorithm
	// with the fixed model
	GCEvalFreezeModel GrabCutMode = 3
)

func (GrabCutMode) String added in v0.30.1

func (c GrabCutMode) String() string

type HersheyFont

type HersheyFont int

HersheyFont are the font libraries included in OpenCV. Only a subset of the available Hershey fonts are supported by OpenCV.

For more information, see: http://sources.isc.org/utils/misc/hershey-font.txt

const (
	// FontHersheySimplex is normal size sans-serif font.
	FontHersheySimplex HersheyFont = 0
	// FontHersheyPlain issmall size sans-serif font.
	FontHersheyPlain HersheyFont = 1
	// FontHersheyDuplex normal size sans-serif font
	// (more complex than FontHersheySIMPLEX).
	FontHersheyDuplex HersheyFont = 2
	// FontHersheyComplex i a normal size serif font.
	FontHersheyComplex HersheyFont = 3
	// FontHersheyTriplex is a normal size serif font
	// (more complex than FontHersheyCOMPLEX).
	FontHersheyTriplex HersheyFont = 4
	// FontHersheyComplexSmall is a smaller version of FontHersheyCOMPLEX.
	FontHersheyComplexSmall HersheyFont = 5
	// FontHersheyScriptSimplex is a hand-writing style font.
	FontHersheyScriptSimplex HersheyFont = 6
	// FontHersheyScriptComplex is a more complex variant of FontHersheyScriptSimplex.
	FontHersheyScriptComplex HersheyFont = 7
	// FontItalic is the flag for italic font.
	FontItalic HersheyFont = 16
)

func (HersheyFont) String added in v0.30.1

func (c HersheyFont) String() string

type HistCompMethod added in v0.30.1

type HistCompMethod int

HistCompMethod is the method for Histogram comparison For more information, see https://docs.opencv.org/master/d6/dc7/group__imgproc__hist.html#ga994f53817d621e2e4228fc646342d386

const (
	// HistCmpCorrel calculates the Correlation
	HistCmpCorrel HistCompMethod = 0

	// HistCmpChiSqr calculates the Chi-Square
	HistCmpChiSqr HistCompMethod = 1

	// HistCmpIntersect calculates the Intersection
	HistCmpIntersect HistCompMethod = 2

	// HistCmpBhattacharya applies the HistCmpBhattacharya by calculating the Bhattacharya distance.
	HistCmpBhattacharya HistCompMethod = 3

	// HistCmpHellinger applies the HistCmpBhattacharya comparison. It is a synonym to HistCmpBhattacharya.
	HistCmpHellinger = HistCmpBhattacharya

	// HistCmpChiSqrAlt applies the Alternative Chi-Square (regularly used for texture comparsion).
	HistCmpChiSqrAlt HistCompMethod = 4

	// HistCmpKlDiv applies the Kullback-Liebler divergence comparison.
	HistCmpKlDiv HistCompMethod = 5
)

func (HistCompMethod) String added in v0.30.1

func (c HistCompMethod) String() string

type HoughMode added in v0.16.0

type HoughMode int

HoughMode is the type for Hough transform variants.

const (
	// HoughStandard is the classical or standard Hough transform.
	HoughStandard HoughMode = 0
	// HoughProbabilistic is the probabilistic Hough transform (more efficient
	// in case if the picture contains a few long linear segments).
	HoughProbabilistic HoughMode = 1
	// HoughMultiScale is the multi-scale variant of the classical Hough
	// transform.
	HoughMultiScale HoughMode = 2
	// HoughGradient is basically 21HT, described in: HK Yuen, John Princen,
	// John Illingworth, and Josef Kittler. Comparative study of hough
	// transform methods for circle finding. Image and Vision Computing,
	// 8(1):71–77, 1990.
	HoughGradient HoughMode = 3
)

func (HoughMode) String added in v0.30.1

func (c HoughMode) String() string

type IMReadFlag

type IMReadFlag int

IMReadFlag is one of the valid flags to use for the IMRead function.

const (
	// IMReadUnchanged return the loaded image as is (with alpha channel,
	// otherwise it gets cropped).
	IMReadUnchanged IMReadFlag = -1

	// IMReadGrayScale always convert image to the single channel
	// grayscale image.
	IMReadGrayScale IMReadFlag = 0

	// IMReadColor always converts image to the 3 channel BGR color image.
	IMReadColor IMReadFlag = 1

	// IMReadAnyDepth returns 16-bit/32-bit image when the input has the corresponding
	// depth, otherwise convert it to 8-bit.
	IMReadAnyDepth IMReadFlag = 2

	// IMReadAnyColor the image is read in any possible color format.
	IMReadAnyColor IMReadFlag = 4

	// IMReadLoadGDAL uses the gdal driver for loading the image.
	IMReadLoadGDAL IMReadFlag = 8

	// IMReadReducedGrayscale2 always converts image to the single channel grayscale image
	// and the image size reduced 1/2.
	IMReadReducedGrayscale2 IMReadFlag = 16

	// IMReadReducedColor2 always converts image to the 3 channel BGR color image and the
	// image size reduced 1/2.
	IMReadReducedColor2 IMReadFlag = 17

	// IMReadReducedGrayscale4 always converts image to the single channel grayscale image and
	// the image size reduced 1/4.
	IMReadReducedGrayscale4 IMReadFlag = 32

	// IMReadReducedColor4 always converts image to the 3 channel BGR color image and
	// the image size reduced 1/4.
	IMReadReducedColor4 IMReadFlag = 33

	// IMReadReducedGrayscale8 always convert image to the single channel grayscale image and
	// the image size reduced 1/8.
	IMReadReducedGrayscale8 IMReadFlag = 64

	// IMReadReducedColor8 always convert image to the 3 channel BGR color image and the
	// image size reduced 1/8.
	IMReadReducedColor8 IMReadFlag = 65

	// IMReadIgnoreOrientation do not rotate the image according to EXIF's orientation flag.
	IMReadIgnoreOrientation IMReadFlag = 128
)

type ImageHeader added in v0.30.1

type ImageHeader struct {
	// contains filtered or unexported fields
}

func (*ImageHeader) Height added in v0.30.1

func (h *ImageHeader) Height() int

Height returns the height of the image in number of pixels.

func (*ImageHeader) PixelType added in v0.30.1

func (h *ImageHeader) PixelType() PixelType

PixelType returns a PixelType describing the image's pixels.

func (*ImageHeader) Width added in v0.30.1

func (h *ImageHeader) Width() int

type ImageOrientation added in v0.30.1

type ImageOrientation int

type InterpolationFlags added in v0.3.0

type InterpolationFlags int

InterpolationFlags are bit flags that control the interpolation algorithm that is used.

const (
	// InterpolationNearestNeighbor is nearest neighbor. (fast but low quality)
	InterpolationNearestNeighbor InterpolationFlags = 0

	// InterpolationLinear is bilinear interpolation.
	InterpolationLinear InterpolationFlags = 1

	// InterpolationCubic is bicube interpolation.
	InterpolationCubic InterpolationFlags = 2

	// InterpolationArea uses pixel area relation. It is preferred for image
	// decimation as it gives moire-free results.
	InterpolationArea InterpolationFlags = 3

	// InterpolationLanczos4 is Lanczos interpolation over 8x8 neighborhood.
	InterpolationLanczos4 InterpolationFlags = 4

	// InterpolationDefault is an alias for InterpolationLinear.
	InterpolationDefault = InterpolationLinear

	// InterpolationMax indicates use maximum interpolation.
	InterpolationMax InterpolationFlags = 7
)

func (InterpolationFlags) String added in v0.30.1

func (c InterpolationFlags) String() string

type KMeansFlags added in v0.30.1

type KMeansFlags int

KMeansFlags for kmeans center selection

For further details, please see: https://docs.opencv.org/master/d0/de1/group__core.html#ga276000efe55ee2756e0c471c7b270949

const (
	// KMeansRandomCenters selects random initial centers in each attempt.
	KMeansRandomCenters KMeansFlags = 0
	// KMeansPPCenters uses kmeans++ center initialization by Arthur and Vassilvitskii [Arthur2007].
	KMeansPPCenters KMeansFlags = 1
	// KMeansUseInitialLabels uses the user-supplied lables during the first (and possibly the only) attempt
	// instead of computing them from the initial centers. For the second and further attempts, use the random or semi-random     // centers. Use one of KMEANS_*_CENTERS flag to specify the exact method.
	KMeansUseInitialLabels KMeansFlags = 2
)

func (KMeansFlags) String added in v0.30.1

func (c KMeansFlags) String() string

type KeyPoint added in v0.6.0

type KeyPoint struct {
	X, Y                  float64
	Size, Angle, Response float64
	Octave, ClassID       int
}

KeyPoint is data structure for salient point detectors.

For further details, please see: https://docs.opencv.org/master/d2/d29/classcv_1_1KeyPoint.html

type LineType added in v0.30.1

type LineType int

LineType are the line libraries included in OpenCV.

For more information, see: https://vovkos.github.io/doxyrest-showcase/opencv/sphinx_rtd_theme/enum_cv_LineTypes.html

const (
	// Filled line
	Filled LineType = -1
	// Line4 4-connected line
	Line4 LineType = 4
	// Line8 8-connected line
	Line8 LineType = 8
	// LineAA antialiased line
	LineAA LineType = 16
)

func (LineType) String added in v0.30.1

func (c LineType) String() string

type Mat

type Mat struct {
	// contains filtered or unexported fields
}

Mat represents an n-dimensional dense numerical single-channel or multi-channel array. It can be used to store real or complex-valued vectors and matrices, grayscale or color images, voxel volumes, vector fields, point clouds, tensors, and histograms.

For further details, please see: http://docs.opencv.org/master/d3/d63/classcv_1_1Mat.html

func Eye added in v0.30.1

func Eye(rows int, cols int, mt MatType) Mat

Returns an identity matrix of the specified size and type.

The method returns a Matlab-style identity matrix initializer, similarly to Mat::zeros. Similarly to Mat::ones. For further details, please see: https://docs.opencv.org/master/d3/d63/classcv_1_1Mat.html#a2cf9b9acde7a9852542bbc20ef851ed2

func GetGaussianKernel added in v0.30.1

func GetGaussianKernel(ksize int, sigma float64) Mat

GetGaussianKernel returns Gaussian filter coefficients.

For further details, please see: https://docs.opencv.org/master/d4/d86/group__imgproc__filter.html#gac05a120c1ae92a6060dd0db190a61afa

func GetGaussianKernelWithParams added in v0.30.1

func GetGaussianKernelWithParams(ksize int, sigma float64, ktype MatType) Mat

GetGaussianKernelWithParams returns Gaussian filter coefficients.

For further details, please see: https://docs.opencv.org/master/d4/d86/group__imgproc__filter.html#gac05a120c1ae92a6060dd0db190a61afa

func GetPerspectiveTransform added in v0.16.0

func GetPerspectiveTransform(src, dst PointVector) Mat

GetPerspectiveTransform returns 3x3 perspective transformation for the corresponding 4 point pairs as image.Point.

For further details, please see: https://docs.opencv.org/master/da/d54/group__imgproc__transform.html#ga8c1ae0e3589a9d77fffc962c49b22043

func GetPerspectiveTransform2f added in v0.30.1

func GetPerspectiveTransform2f(src, dst Point2fVector) Mat

GetPerspectiveTransform2f returns 3x3 perspective transformation for the corresponding 4 point pairs as gocv.Point2f.

For further details, please see: https://docs.opencv.org/master/da/d54/group__imgproc__transform.html#ga8c1ae0e3589a9d77fffc962c49b22043

func GetRotationMatrix2D added in v0.8.0

func GetRotationMatrix2D(center image.Point, angle, scale float64) Mat

GetRotationMatrix2D calculates an affine matrix of 2D rotation.

For further details, please see: https://docs.opencv.org/master/da/d54/group__imgproc__transform.html#gafbbc470ce83812914a70abfb604f4326

func GetStructuringElement added in v0.3.0

func GetStructuringElement(shape MorphShape, ksize image.Point) Mat

GetStructuringElement returns a structuring element of the specified size and shape for morphological operations.

For further details, please see: https://docs.opencv.org/master/d4/d86/group__imgproc__filter.html#gac342a1bb6eabf6f55c803b09268e36dc

func IMDecode added in v0.7.0

func IMDecode(buf []byte, flags IMReadFlag) (Mat, error)

IMDecode reads an image from a buffer in memory. The function IMDecode reads an image from the specified buffer in memory. If the buffer is too short or contains invalid data, the function returns an empty matrix.

For further details, please see: https://docs.opencv.org/master/d4/da8/group__imgcodecs.html#ga26a67788faa58ade337f8d28ba0eb19e

func IMRead

func IMRead(name string, flags IMReadFlag) Mat

IMRead reads an image from a file into a Mat. The flags param is one of the IMReadFlag flags. If the image cannot be read (because of missing file, improper permissions, unsupported or invalid format), the function returns an empty Mat.

For further details, please see: http://docs.opencv.org/master/d4/da8/group__imgcodecs.html#ga288b8b3da0892bd651fce07b3bbd3a56

func ImageGrayToMatGray added in v0.16.0

func ImageGrayToMatGray(img *image.Gray) (Mat, error)

ImageGrayToMatGray converts image.Gray to gocv.Mat, which represents grayscale image 8bit. Type of Mat is gocv.MatTypeCV8UC1.

func ImageToMatRGB added in v0.16.0

func ImageToMatRGB(img image.Image) (Mat, error)

ImageToMatRGB converts image.Image to gocv.Mat, which represents RGB image having 8bit for each component. Type of Mat is gocv.MatTypeCV8UC3.

func ImageToMatRGBA added in v0.16.0

func ImageToMatRGBA(img image.Image) (Mat, error)

ImageToMatRGBA converts image.Image to gocv.Mat, which represents RGBA image having 8bit for each component. Type of Mat is gocv.MatTypeCV8UC4.

func NewMat

func NewMat() Mat

NewMat returns a new empty Mat.

func NewMatFromBytes added in v0.9.0

func NewMatFromBytes(rows int, cols int, mt MatType, data []byte) (Mat, error)

NewMatFromBytes returns a new Mat with a specific size and type, initialized from a []byte.

func NewMatFromScalar added in v0.3.0

func NewMatFromScalar(s Scalar, mt MatType) Mat

NewMatFromScalar returns a new Mat for a specific Scalar value

func NewMatWithSize

func NewMatWithSize(rows int, cols int, mt MatType) Mat

NewMatWithSize returns a new Mat with a specific size and type.

func NewMatWithSizeFromScalar added in v0.16.0

func NewMatWithSizeFromScalar(s Scalar, rows int, cols int, mt MatType) Mat

NewMatWithSizeFromScalar returns a new Mat for a specific Scala value with a specific size and type This simplifies creation of specific color filters or creating Mats of specific colors and sizes

func NewMatWithSizes added in v0.30.1

func NewMatWithSizes(sizes []int, mt MatType) Mat

NewMatWithSizes returns a new multidimensional Mat with a specific size and type.

func NewMatWithSizesFromBytes added in v0.30.1

func NewMatWithSizesFromBytes(sizes []int, mt MatType, data []byte) (Mat, error)

NewMatWithSizesWithScalar returns a new multidimensional Mat with a specific size, type and preexisting data.

func NewMatWithSizesWithScalar added in v0.30.1

func NewMatWithSizesWithScalar(sizes []int, mt MatType, s Scalar) Mat

NewMatWithSizesWithScalar returns a new multidimensional Mat with a specific size, type and scalar value.

func Ones added in v0.30.1

func Ones(rows int, cols int, mt MatType) Mat

Returns an array of all 1's of the specified size and type.

The method returns a Matlab-style 1's array initializer For further details, please see: https://docs.opencv.org/master/d3/d63/classcv_1_1Mat.html#a69ae0402d116fc9c71908d8508dc2f09

func Split added in v0.16.0

func Split(src Mat) (mv []Mat)

Split creates an array of single channel images from a multi-channel image Created images should be closed manualy to avoid memory leaks.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#ga0547c7fed86152d7e9d0096029c8518a

func Zeros added in v0.30.1

func Zeros(rows int, cols int, mt MatType) Mat

Returns a zero array of the specified size and type.

The method returns a Matlab-style zero array initializer. For further details, please see: https://docs.opencv.org/master/d3/d63/classcv_1_1Mat.html#a0b57b6a326c8876d944d188a46e0f556

func (*Mat) AddFloat added in v0.16.0

func (m *Mat) AddFloat(val float32)

AddFloat adds a float value to each element in the Mat. Performs a mat += val operation.

func (*Mat) AddUChar added in v0.16.0

func (m *Mat) AddUChar(val uint8)

AddUChar adds a uchar value to each element in the Mat. Performs a mat += val operation.

func (*Mat) Channels added in v0.9.0

func (m *Mat) Channels() int

Channels returns the number of channels for this Mat.

func (*Mat) Clone

func (m *Mat) Clone() Mat

Clone returns a cloned full copy of the Mat.

func (*Mat) Close

func (m *Mat) Close() error

Close the Mat object.

func (*Mat) ColRange added in v0.30.1

func (m *Mat) ColRange(start, end int) Mat

ColRange creates a matrix header for the specified column span.

For further details, please see: https://docs.opencv.org/master/d3/d63/classcv_1_1Mat.html#aadc8f9210fe4dec50513746c246fa8d9

func (*Mat) Cols

func (m *Mat) Cols() int

Cols returns the number of columns for this Mat.

func (*Mat) ConvertFp16 added in v0.9.0

func (m *Mat) ConvertFp16() Mat

ConvertFp16 converts a Mat to half-precision floating point.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#ga9c25d9ef44a2a48ecc3774b30cb80082

func (*Mat) ConvertTo added in v0.9.0

func (m *Mat) ConvertTo(dst *Mat, mt MatType)

ConvertTo converts Mat into destination Mat.

For further details, please see: https://docs.opencv.org/master/d3/d63/classcv_1_1Mat.html#adf88c60c5b4980e05bb556080916978b

func (*Mat) ConvertToWithParams added in v0.30.1

func (m *Mat) ConvertToWithParams(dst *Mat, mt MatType, alpha, beta float32)

func (*Mat) CopyTo added in v0.3.0

func (m *Mat) CopyTo(dst *Mat)

CopyTo copies Mat into destination Mat.

For further details, please see: https://docs.opencv.org/master/d3/d63/classcv_1_1Mat.html#a33fd5d125b4c302b0c9aa86980791a77

func (*Mat) CopyToWithMask added in v0.16.0

func (m *Mat) CopyToWithMask(dst *Mat, mask Mat)

CopyToWithMask copies Mat into destination Mat after applying the mask Mat.

For further details, please see: https://docs.opencv.org/master/d3/d63/classcv_1_1Mat.html#a626fe5f96d02525e2604d2ad46dd574f

func (*Mat) DataPtrFloat32 added in v0.16.0

func (m *Mat) DataPtrFloat32() ([]float32, error)

DataPtrFloat32 returns a slice that references the OpenCV allocated data.

The data is no longer valid once the Mat has been closed. Any data that needs to be accessed after the Mat is closed must be copied into Go memory.

func (*Mat) DataPtrFloat64 added in v0.16.0

func (m *Mat) DataPtrFloat64() ([]float64, error)

DataPtrFloat64 returns a slice that references the OpenCV allocated data.

The data is no longer valid once the Mat has been closed. Any data that needs to be accessed after the Mat is closed must be copied into Go memory.

func (*Mat) DataPtrInt16 added in v0.16.0

func (m *Mat) DataPtrInt16() ([]int16, error)

DataPtrInt16 returns a slice that references the OpenCV allocated data.

The data is no longer valid once the Mat has been closed. Any data that needs to be accessed after the Mat is closed must be copied into Go memory.

func (*Mat) DataPtrInt8 added in v0.16.0

func (m *Mat) DataPtrInt8() ([]int8, error)

DataPtrInt8 returns a slice that references the OpenCV allocated data.

The data is no longer valid once the Mat has been closed. Any data that needs to be accessed after the Mat is closed must be copied into Go memory.

func (*Mat) DataPtrUint16 added in v0.16.0

func (m *Mat) DataPtrUint16() ([]uint16, error)

DataPtrUint16 returns a slice that references the OpenCV allocated data.

The data is no longer valid once the Mat has been closed. Any data that needs to be accessed after the Mat is closed must be copied into Go memory.

func (*Mat) DataPtrUint8 added in v0.16.0

func (m *Mat) DataPtrUint8() ([]uint8, error)

DataPtrUint8 returns a slice that references the OpenCV allocated data.

The data is no longer valid once the Mat has been closed. Any data that needs to be accessed after the Mat is closed must be copied into Go memory.

func (*Mat) DivideFloat added in v0.16.0

func (m *Mat) DivideFloat(val float32)

DivideFloat divides each element in the Mat by a float value. Performs a mat /= val operation.

func (*Mat) DivideUChar added in v0.16.0

func (m *Mat) DivideUChar(val uint8)

DivideUChar divides each element in the Mat by a uint value. Performs a mat /= val operation.

func (*Mat) Empty

func (m *Mat) Empty() bool

Empty determines if the Mat is empty or not.

func (*Mat) FromPtr added in v0.16.0

func (m *Mat) FromPtr(rows int, cols int, mt MatType, prow int, pcol int) (Mat, error)

FromPtr returns a new Mat with a specific size and type, initialized from a Mat Ptr.

func (*Mat) GetDoubleAt

func (m *Mat) GetDoubleAt(row int, col int) float64

GetDoubleAt returns a value from a specific row/col in this Mat expecting it to be of type double aka CV_64F.

func (*Mat) GetDoubleAt3 added in v0.16.0

func (m *Mat) GetDoubleAt3(x, y, z int) float64

GetDoubleAt3 returns a value from a specific x, y, z coordinate location in this Mat expecting it to be of type double aka CV_64F.

func (*Mat) GetFloatAt

func (m *Mat) GetFloatAt(row int, col int) float32

GetFloatAt returns a value from a specific row/col in this Mat expecting it to be of type float aka CV_32F.

func (*Mat) GetFloatAt3 added in v0.16.0

func (m *Mat) GetFloatAt3(x, y, z int) float32

GetFloatAt3 returns a value from a specific x, y, z coordinate location in this Mat expecting it to be of type float aka CV_32F.

func (*Mat) GetIntAt

func (m *Mat) GetIntAt(row int, col int) int32

GetIntAt returns a value from a specific row/col in this Mat expecting it to be of type int aka CV_32S.

func (*Mat) GetIntAt3 added in v0.16.0

func (m *Mat) GetIntAt3(x, y, z int) int32

GetIntAt3 returns a value from a specific x, y, z coordinate location in this Mat expecting it to be of type int aka CV_32S.

func (*Mat) GetSCharAt

func (m *Mat) GetSCharAt(row int, col int) int8

GetSCharAt returns a value from a specific row/col in this Mat expecting it to be of type schar aka CV_8S.

func (*Mat) GetSCharAt3 added in v0.16.0

func (m *Mat) GetSCharAt3(x, y, z int) int8

GetSCharAt3 returns a value from a specific x, y, z coordinate location in this Mat expecting it to be of type schar aka CV_8S.

func (*Mat) GetShortAt

func (m *Mat) GetShortAt(row int, col int) int16

GetShortAt returns a value from a specific row/col in this Mat expecting it to be of type short aka CV_16S.

func (*Mat) GetShortAt3 added in v0.16.0

func (m *Mat) GetShortAt3(x, y, z int) int16

GetShortAt3 returns a value from a specific x, y, z coordinate location in this Mat expecting it to be of type short aka CV_16S.

func (*Mat) GetUCharAt

func (m *Mat) GetUCharAt(row int, col int) uint8

GetUCharAt returns a value from a specific row/col in this Mat expecting it to be of type uchar aka CV_8U.

func (*Mat) GetUCharAt3 added in v0.16.0

func (m *Mat) GetUCharAt3(x, y, z int) uint8

GetUCharAt3 returns a value from a specific x, y, z coordinate location in this Mat expecting it to be of type uchar aka CV_8U.

func (*Mat) GetVecbAt added in v0.30.1

func (m *Mat) GetVecbAt(row int, col int) Vecb

GetVecbAt returns a vector of bytes. Its size corresponds to the number of channels of the Mat.

func (*Mat) GetVecdAt added in v0.30.1

func (m *Mat) GetVecdAt(row int, col int) Vecd

GetVecdAt returns a vector of float64s. Its size corresponds to the number of channels of the Mat.

func (*Mat) GetVecfAt added in v0.16.0

func (m *Mat) GetVecfAt(row int, col int) Vecf

GetVecfAt returns a vector of floats. Its size corresponds to the number of channels of the Mat.

func (*Mat) GetVeciAt added in v0.16.0

func (m *Mat) GetVeciAt(row int, col int) Veci

GetVeciAt returns a vector of integers. Its size corresponds to the number of channels of the Mat.

func (*Mat) IsContinuous added in v0.30.1

func (m *Mat) IsContinuous() bool

IsContinuous determines if the Mat is continuous.

For further details, please see: https://docs.opencv.org/master/d3/d63/classcv_1_1Mat.html#aa90cea495029c7d1ee0a41361ccecdf3

func (*Mat) Mean added in v0.4.1

func (m *Mat) Mean() Scalar

Mean calculates the mean value M of array elements, independently for each channel, and return it as Scalar For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#ga191389f8a0e58180bb13a727782cd461

func (*Mat) MeanWithMask added in v0.30.1

func (m *Mat) MeanWithMask(mask Mat) Scalar

MeanWithMask calculates the mean value M of array elements,independently for each channel, and returns it as Scalar vector while applying the mask. https://docs.opencv.org/master/d2/de8/group__core__array.html#ga191389f8a0e58180bb13a727782cd461

func (*Mat) MultiplyFloat added in v0.16.0

func (m *Mat) MultiplyFloat(val float32)

MultiplyFloat multiplies each element in the Mat by a float value. Performs a mat *= val operation.

func (*Mat) MultiplyMatrix added in v0.30.1

func (m *Mat) MultiplyMatrix(x Mat) Mat

MultiplyMatrix multiplies matrix (m*x)

func (*Mat) MultiplyUChar added in v0.16.0

func (m *Mat) MultiplyUChar(val uint8)

MultiplyUChar multiplies each element in the Mat by a uint value. Performs a mat *= val operation.

func (*Mat) PatchNaNs added in v0.16.0

func (m *Mat) PatchNaNs()

PatchNaNs converts NaN's to zeros.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#ga62286befb7cde3568ff8c7d14d5079da

func (*Mat) Ptr

func (m *Mat) Ptr() C.Mat

Ptr returns the Mat's underlying object pointer.

func (*Mat) Region

func (m *Mat) Region(rio image.Rectangle) Mat

Region returns a new Mat that points to a region of this Mat. Changes made to the region Mat will affect the original Mat, since they are pointers to the underlying OpenCV Mat object.

func (*Mat) Reshape added in v0.8.0

func (m *Mat) Reshape(cn int, rows int) Mat

Reshape changes the shape and/or the number of channels of a 2D matrix without copying the data.

For further details, please see: https://docs.opencv.org/master/d3/d63/classcv_1_1Mat.html#a4eb96e3251417fa88b78e2abd6cfd7d8

func (*Mat) RowRange added in v0.30.1

func (m *Mat) RowRange(start, end int) Mat

RowRange creates a matrix header for the specified row span.

For further details, please see: https://docs.opencv.org/master/d3/d63/classcv_1_1Mat.html#aa6542193430356ad631a9beabc624107

func (*Mat) Rows

func (m *Mat) Rows() int

Rows returns the number of rows for this Mat.

func (*Mat) SetDoubleAt added in v0.8.0

func (m *Mat) SetDoubleAt(row int, col int, val float64)

SetDoubleAt sets a value at a specific row/col in this Mat expecting it to be of type double aka CV_64F.

func (*Mat) SetDoubleAt3 added in v0.16.0

func (m *Mat) SetDoubleAt3(x, y, z int, val float64)

SetDoubleAt3 sets a value at a specific x, y, z coordinate location in this Mat expecting it to be of type double aka CV_64F.

func (*Mat) SetFloatAt added in v0.8.0

func (m *Mat) SetFloatAt(row int, col int, val float32)

SetFloatAt sets a value at a specific row/col in this Mat expecting it to be of type float aka CV_32F.

func (*Mat) SetFloatAt3 added in v0.16.0

func (m *Mat) SetFloatAt3(x, y, z int, val float32)

SetFloatAt3 sets a value at a specific x, y, z coordinate location in this Mat expecting it to be of type float aka CV_32F.

func (*Mat) SetIntAt added in v0.8.0

func (m *Mat) SetIntAt(row int, col int, val int32)

SetIntAt sets a value at a specific row/col in this Mat expecting it to be of type int aka CV_32S.

func (*Mat) SetIntAt3 added in v0.16.0

func (m *Mat) SetIntAt3(x, y, z int, val int32)

SetIntAt3 sets a value at a specific x, y, z coordinate location in this Mat expecting it to be of type int aka CV_32S.

func (*Mat) SetSCharAt added in v0.8.0

func (m *Mat) SetSCharAt(row int, col int, val int8)

SetSCharAt sets a value at a specific row/col in this Mat expecting it to be of type schar aka CV_8S.

func (*Mat) SetSCharAt3 added in v0.16.0

func (m *Mat) SetSCharAt3(x, y, z int, val int8)

SetSCharAt3 sets a value at a specific x, y, z coordinate location in this Mat expecting it to be of type schar aka CV_8S.

func (*Mat) SetShortAt added in v0.8.0

func (m *Mat) SetShortAt(row int, col int, val int16)

SetShortAt sets a value at a specific row/col in this Mat expecting it to be of type short aka CV_16S.

func (*Mat) SetShortAt3 added in v0.16.0

func (m *Mat) SetShortAt3(x, y, z int, val int16)

SetShortAt3 sets a value at a specific x, y, z coordinate location in this Mat expecting it to be of type short aka CV_16S.

func (*Mat) SetTo added in v0.16.0

func (m *Mat) SetTo(s Scalar)

SetTo sets all or some of the array elements to the specified scalar value.

func (*Mat) SetUCharAt added in v0.8.0

func (m *Mat) SetUCharAt(row int, col int, val uint8)

SetUCharAt sets a value at a specific row/col in this Mat expecting it to be of type uchar aka CV_8U.

func (*Mat) SetUCharAt3 added in v0.16.0

func (m *Mat) SetUCharAt3(x, y, z int, val uint8)

SetUCharAt3 sets a value at a specific x, y, z coordinate location in this Mat expecting it to be of type uchar aka CV_8U.

func (*Mat) Size added in v0.16.0

func (m *Mat) Size() (dims []int)

Size returns an array with one element for each dimension containing the size of that dimension for the Mat.

For further details, please see: https://docs.opencv.org/master/d3/d63/classcv_1_1Mat.html#aa4d317d43fb0cba9c2503f3c61b866c8

func (*Mat) Sqrt added in v0.16.0

func (m *Mat) Sqrt() Mat

Sqrt calculates a square root of array elements.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#ga186222c3919657890f88df5a1f64a7d7

func (*Mat) Step added in v0.16.0

func (m *Mat) Step() int

Step returns the number of bytes each matrix row occupies.

func (*Mat) SubtractFloat added in v0.16.0

func (m *Mat) SubtractFloat(val float32)

SubtractFloat subtracts a float value from each element in the Mat. Performs a mat -= val operation.

func (*Mat) SubtractUChar added in v0.16.0

func (m *Mat) SubtractUChar(val uint8)

SubtractUChar subtracts a uchar value from each element in the Mat. Performs a mat -= val operation.

func (*Mat) Sum added in v0.16.0

func (m *Mat) Sum() Scalar

Sum calculates the per-channel pixel sum of an image.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#ga716e10a2dd9e228e4d3c95818f106722

func (*Mat) T added in v0.30.1

func (m *Mat) T() Mat

T transpose matrix https://docs.opencv.org/4.1.2/d3/d63/classcv_1_1Mat.html#aaa428c60ccb6d8ea5de18f63dfac8e11

func (*Mat) ToBytes added in v0.8.0

func (m *Mat) ToBytes() []byte

ToBytes copies the underlying Mat data to a byte array.

For further details, please see: https://docs.opencv.org/3.3.1/d3/d63/classcv_1_1Mat.html#a4d33bed1c850265370d2af0ff02e1564

func (*Mat) ToImage added in v0.16.0

func (m *Mat) ToImage() (image.Image, error)

ToImage converts a Mat to a image.Image.

func (*Mat) ToImageYUV added in v0.30.1

func (m *Mat) ToImageYUV() (*image.YCbCr, error)

ToImageYUV converts a Mat to a image.YCbCr using image.YCbCrSubsampleRatio420 as default subsampling param.

func (*Mat) ToImageYUVWithParams added in v0.30.1

func (m *Mat) ToImageYUVWithParams(ratio image.YCbCrSubsampleRatio) (*image.YCbCr, error)

ToImageYUV converts a Mat to a image.YCbCr using provided YUV subsample ratio param.

func (*Mat) Total added in v0.16.0

func (m *Mat) Total() int

Total returns the total number of array elements.

For further details, please see: https://docs.opencv.org/master/d3/d63/classcv_1_1Mat.html#aa4d317d43fb0cba9c2503f3c61b866c8

func (*Mat) Type added in v0.9.0

func (m *Mat) Type() MatType

Type returns the type for this Mat.

type MatType

type MatType int

MatType is the type for the various different kinds of Mat you can create.

func (MatType) String added in v0.30.1

func (c MatType) String() string

type MorphShape added in v0.3.0

type MorphShape int

MorphShape is the shape of the structuring element used for Morphing operations.

const (
	// MorphRect is the rectangular morph shape.
	MorphRect MorphShape = 0

	// MorphCross is the cross morph shape.
	MorphCross MorphShape = 1

	// MorphEllipse is the ellipse morph shape.
	MorphEllipse MorphShape = 2
)

func (MorphShape) String added in v0.30.1

func (c MorphShape) String() string

type MorphType added in v0.3.0

type MorphType int

MorphType type of morphological operation.

const (
	// MorphErode operation
	MorphErode MorphType = 0

	// MorphDilate operation
	MorphDilate MorphType = 1

	// MorphOpen operation
	MorphOpen MorphType = 2

	// MorphClose operation
	MorphClose MorphType = 3

	// MorphGradient operation
	MorphGradient MorphType = 4

	// MorphTophat operation
	MorphTophat MorphType = 5

	// MorphBlackhat operation
	MorphBlackhat MorphType = 6

	// MorphHitmiss operation
	MorphHitmiss MorphType = 7
)

func (MorphType) String added in v0.30.1

func (c MorphType) String() string

type NativeByteBuffer added in v0.30.1

type NativeByteBuffer struct {
	// contains filtered or unexported fields
}

func IMEncode

func IMEncode(fileExt FileExt, img Mat) (buf *NativeByteBuffer, err error)

IMEncode encodes an image Mat into a memory buffer. This function compresses the image and stores it in the returned memory buffer, using the image format passed in in the form of a file extension string.

For further details, please see: http://docs.opencv.org/master/d4/da8/group__imgcodecs.html#ga461f9ac09887e47797a54567df3b8b63

func IMEncodeWithParams added in v0.17.0

func IMEncodeWithParams(fileExt FileExt, img Mat, params []int) (buf *NativeByteBuffer, err error)

IMEncodeWithParams encodes an image Mat into a memory buffer. This function compresses the image and stores it in the returned memory buffer, using the image format passed in in the form of a file extension string.

Usage example:

buffer, err := gocv.IMEncodeWithParams(gocv.JPEGFileExt, img, []int{gocv.IMWriteJpegQuality, quality})

For further details, please see: http://docs.opencv.org/master/d4/da8/group__imgcodecs.html#ga461f9ac09887e47797a54567df3b8b63

Example
img := IMRead(path.Join(os.Getenv("GOPATH"), "src/gocv.io/x/gocv/images/face-detect.jpg"), IMReadColor)
if img.Empty() {
	log.Fatal("Invalid Mat")
}

imgHandler := func(w http.ResponseWriter, req *http.Request) {
	quality := 75
	if q, err := strconv.Atoi(req.URL.Query().Get("q")); err == nil {
		quality = q
	}
	buffer, err := IMEncodeWithParams(JPEGFileExt, img, []int{IMWriteJpegQuality, quality})
	if err != nil {
		w.WriteHeader(http.StatusInternalServerError)
		io.WriteString(w, err.Error())
		return
	}
	defer buffer.Close()
	w.Header().Set("Content-Type", "image/jpeg")
	w.WriteHeader(http.StatusOK)
	w.Write(buffer.GetBytes())
}

http.HandleFunc("/img", imgHandler)
fmt.Println("Open in browser http://127.0.0.1:8080/img?q=10 where q is a JPEG quality parameter")
log.Fatal(http.ListenAndServe("127.0.0.1:8080", nil))
Output:

func (*NativeByteBuffer) Close added in v0.30.1

func (buffer *NativeByteBuffer) Close()

Close the buffer releasing all its resources

func (*NativeByteBuffer) GetBytes added in v0.30.1

func (buffer *NativeByteBuffer) GetBytes() []byte

GetBytes returns slice of bytes backed by native buffer

func (*NativeByteBuffer) Len added in v0.30.1

func (buffer *NativeByteBuffer) Len() int

Len - returns length in bytes of underlying buffer

type NormType added in v0.3.0

type NormType int

NormType for normalization operations.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#gad12cefbcb5291cf958a85b4b67b6149f

const (
	// NormInf indicates use infinite normalization.
	NormInf NormType = 1

	// NormL1 indicates use L1 normalization.
	NormL1 NormType = 2

	// NormL2 indicates use L2 normalization.
	NormL2 NormType = 4

	// NormL2Sqr indicates use L2 squared normalization.
	NormL2Sqr NormType = 5

	// NormHamming indicates use Hamming normalization.
	NormHamming NormType = 6

	// NormHamming2 indicates use Hamming 2-bit normalization.
	NormHamming2 NormType = 7

	// NormTypeMask indicates use type mask for normalization.
	NormTypeMask NormType = 7

	// NormRelative indicates use relative normalization.
	NormRelative NormType = 8

	// NormMinMax indicates use min/max normalization.
	NormMinMax NormType = 32
)

func (NormType) String added in v0.30.1

func (c NormType) String() string

type PixelType added in v0.30.1

type PixelType int

func (PixelType) Depth added in v0.30.1

func (p PixelType) Depth() int

type Point2f added in v0.30.1

type Point2f struct {
	X float32
	Y float32
}

func NewPoint2f added in v0.30.1

func NewPoint2f(x, y float32) Point2f

func PhaseCorrelate added in v0.30.1

func PhaseCorrelate(src1, src2, window Mat) (phaseShift Point2f, response float64)

Apply phaseCorrelate.

For further details, please see: https://docs.opencv.org/master/d7/df3/group__imgproc__motion.html#ga552420a2ace9ef3fb053cd630fdb4952

type Point2fVector added in v0.30.1

type Point2fVector struct {
	// contains filtered or unexported fields
}

Point2fVector is a wrapper around a std::vector< cv::Point2f >* This is needed anytime that you need to pass or receive a collection of points.

func NewPoint2fVector added in v0.30.1

func NewPoint2fVector() Point2fVector

NewPoint2fVector returns a new empty Point2fVector.

func NewPoint2fVectorFromMat added in v0.30.1

func NewPoint2fVectorFromMat(mat Mat) Point2fVector

NewPoint2fVectorFromMat returns a new Point2fVector that has been wrapped around a Mat of type CV_32FC2 with a single columm.

func NewPoint2fVectorFromPoints added in v0.30.1

func NewPoint2fVectorFromPoints(pts []Point2f) Point2fVector

NewPoint2fVectorFromPoints returns a new Point2fVector that has been initialized to a slice of image.Point.

func (Point2fVector) At added in v0.30.1

func (pfv Point2fVector) At(idx int) Point2f

At returns the image.Point

func (Point2fVector) Close added in v0.30.1

func (pfv Point2fVector) Close()

Close closes and frees memory for this Point2fVector.

func (Point2fVector) IsNil added in v0.30.1

func (pfv Point2fVector) IsNil() bool

IsNil checks the CGo pointer in the Point2fVector.

func (Point2fVector) Size added in v0.30.1

func (pfv Point2fVector) Size() int

Size returns how many Point are in the PointVector.

func (Point2fVector) ToPoints added in v0.30.1

func (pfv Point2fVector) ToPoints() []Point2f

ToPoints returns a slice of image.Point for the data in this PointVector.

type Point3f added in v0.30.1

type Point3f struct {
	X float32
	Y float32
	Z float32
}

func NewPoint3f added in v0.30.1

func NewPoint3f(x, y, z float32) Point3f

type Point3fVector added in v0.30.1

type Point3fVector struct {
	// contains filtered or unexported fields
}

Point3fVector is a wrapper around a std::vector< cv::Point3f >*

func NewPoint3fVector added in v0.30.1

func NewPoint3fVector() Point3fVector

NewPoint3fVector returns a new empty Point3fVector.

func NewPoint3fVectorFromMat added in v0.30.1

func NewPoint3fVectorFromMat(mat Mat) Point3fVector

NewPoint3fVectorFromMat returns a new Point3fVector that has been wrapped around a Mat of type CV_32FC3 with a single columm.

func NewPoint3fVectorFromPoints added in v0.30.1

func NewPoint3fVectorFromPoints(pts []Point3f) Point3fVector

NewPoint3fVectorFromPoints returns a new Point3fVector that has been initialized to a slice of image.Point.

func (Point3fVector) Append added in v0.30.1

func (pfv Point3fVector) Append(point Point3f)

func (Point3fVector) At added in v0.30.1

func (pfv Point3fVector) At(idx int) Point3f

At returns the Point3f

func (Point3fVector) Close added in v0.30.1

func (pfv Point3fVector) Close()

Close closes and frees memory for this Point3fVector.

func (Point3fVector) IsNil added in v0.30.1

func (pfv Point3fVector) IsNil() bool

IsNil checks the CGo pointer in the Point3fVector.

func (Point3fVector) Size added in v0.30.1

func (pfv Point3fVector) Size() int

Size returns how many Point are in the Point3fVector.

func (Point3fVector) ToPoints added in v0.30.1

func (pfv Point3fVector) ToPoints() []Point3f

ToPoints returns a slice of Point3f for the data in this Point3fVector.

type PointVector added in v0.30.1

type PointVector struct {
	// contains filtered or unexported fields
}

PointVector is a wrapper around a std::vector< cv::Point >* This is needed anytime that you need to pass or receive a collection of points.

func ApproxPolyDP added in v0.9.0

func ApproxPolyDP(curve PointVector, epsilon float64, closed bool) PointVector

ApproxPolyDP approximates a polygonal curve(s) with the specified precision.

For further details, please see:

https://docs.opencv.org/master/d3/dc0/group__imgproc__shape.html#ga0012a5fdaea70b8a9970165d98722b4c

func NewPointVector added in v0.30.1

func NewPointVector() PointVector

NewPointVector returns a new empty PointVector.

func NewPointVectorFromMat added in v0.30.1

func NewPointVectorFromMat(mat Mat) PointVector

NewPointVectorFromMat returns a new PointVector that has been wrapped around a Mat of type CV_32SC2 with a single columm.

func NewPointVectorFromPoints added in v0.30.1

func NewPointVectorFromPoints(pts []image.Point) PointVector

NewPointVectorFromPoints returns a new PointVector that has been initialized to a slice of image.Point.

func (PointVector) Append added in v0.30.1

func (pv PointVector) Append(point image.Point)

Append appends an image.Point at end of the PointVector.

func (PointVector) At added in v0.30.1

func (pv PointVector) At(idx int) image.Point

At returns the image.Point

func (PointVector) Close added in v0.30.1

func (pv PointVector) Close()

Close closes and frees memory for this PointVector.

func (PointVector) IsNil added in v0.30.1

func (pv PointVector) IsNil() bool

IsNil checks the CGo pointer in the PointVector.

func (PointVector) Size added in v0.30.1

func (pv PointVector) Size() int

Size returns how many Point are in the PointVector.

func (PointVector) ToPoints added in v0.30.1

func (pv PointVector) ToPoints() []image.Point

ToPoints returns a slice of image.Point for the data in this PointVector.

type Points2fVector added in v0.30.1

type Points2fVector struct {
	// contains filtered or unexported fields
}

Points2fVector is a wrapper around a std::vector< std::vector< cv::Point2f > >*

func NewPoints2fVector added in v0.30.1

func NewPoints2fVector() Points2fVector

NewPoints2fVector returns a new empty Points2fVector.

func NewPoints2fVectorFromPoints added in v0.30.1

func NewPoints2fVectorFromPoints(pts [][]Point2f) Points2fVector

NewPoints2fVectorFromPoints returns a new Points2fVector that has been initialized to a slice of slices of Point2f.

func (Points2fVector) Append added in v0.30.1

func (pvs Points2fVector) Append(pv Point2fVector)

Append appends a Point2fVector at end of the Points2fVector.

func (Points2fVector) At added in v0.30.1

func (pvs Points2fVector) At(idx int) Point2fVector

At returns the Point2fVector at that index of the Points2fVector.

func (Points2fVector) Close added in v0.30.1

func (pvs Points2fVector) Close()

Close closes and frees memory for this Points2fVector.

func (Points2fVector) IsNil added in v0.30.1

func (pvs Points2fVector) IsNil() bool

IsNil checks the CGo pointer in the Points2fVector.

func (Points2fVector) P added in v0.30.1

func (Points2fVector) Size added in v0.30.1

func (pvs Points2fVector) Size() int

Size returns how many vectors of Points are in the Points2fVector.

func (Points2fVector) ToPoints added in v0.30.1

func (pvs Points2fVector) ToPoints() [][]Point2f

ToPoints returns a slice of slices of Point2f for the data in this Points2fVector.

type Points3fVector added in v0.30.1

type Points3fVector struct {
	// contains filtered or unexported fields
}

Points3fVector is a wrapper around a std::vector< std::vector< cv::Point3f > >*

func NewPoints3fVector added in v0.30.1

func NewPoints3fVector() Points3fVector

NewPoints3fVector returns a new empty Points3fVector.

func NewPoints3fVectorFromPoints added in v0.30.1

func NewPoints3fVectorFromPoints(pts [][]Point3f) Points3fVector

NewPoints3fVectorFromPoints returns a new Points3fVector that has been initialized to a slice of slices of Point3f.

func (Points3fVector) Append added in v0.30.1

func (pvs Points3fVector) Append(pv Point3fVector)

Append appends a Point3fVector at end of the Points3fVector.

func (Points3fVector) At added in v0.30.1

func (pvs Points3fVector) At(idx int) Point3fVector

At returns the Point3fVector at that index of the Points3fVector.

func (Points3fVector) Close added in v0.30.1

func (pvs Points3fVector) Close()

Close closes and frees memory for this Points3fVector.

func (Points3fVector) IsNil added in v0.30.1

func (pvs Points3fVector) IsNil() bool

IsNil checks the CGo pointer in the Points3fVector.

func (Points3fVector) Size added in v0.30.1

func (pvs Points3fVector) Size() int

Size returns how many vectors of Points are in the Points3fVector.

func (Points3fVector) ToPoints added in v0.30.1

func (pvs Points3fVector) ToPoints() [][]Point3f

ToPoints returns a slice of slices of Point3f for the data in this Points3fVector.

type PointsVector added in v0.30.1

type PointsVector struct {
	// contains filtered or unexported fields
}

PointsVector is a wrapper around a std::vector< std::vector< cv::Point > >*

func FindContours added in v0.4.1

func FindContours(src Mat, mode RetrievalMode, method ContourApproximationMode) PointsVector

FindContours finds contours in a binary image.

For further details, please see: https://docs.opencv.org/master/d3/dc0/group__imgproc__shape.html#ga95f5b48d01abc7c2e0732db24689837b

func FindContoursWithParams added in v0.30.1

func FindContoursWithParams(src Mat, hierarchy *Mat, mode RetrievalMode, method ContourApproximationMode) PointsVector

FindContoursWithParams finds contours in a binary image.

For further details, please see: https://docs.opencv.org/master/d3/dc0/group__imgproc__shape.html#ga17ed9f5d79ae97bd4c7cf18403e1689a

func NewPointsVector added in v0.30.1

func NewPointsVector() PointsVector

NewPointsVector returns a new empty PointsVector.

func NewPointsVectorFromPoints added in v0.30.1

func NewPointsVectorFromPoints(pts [][]image.Point) PointsVector

NewPointsVectorFromPoints returns a new PointsVector that has been initialized to a slice of slices of image.Point.

func (PointsVector) Append added in v0.30.1

func (pvs PointsVector) Append(pv PointVector)

Append appends a PointVector at end of the PointsVector.

func (PointsVector) At added in v0.30.1

func (pvs PointsVector) At(idx int) PointVector

At returns the PointVector at that index of the PointsVector.

func (PointsVector) Close added in v0.30.1

func (pvs PointsVector) Close()

Close closes and frees memory for this PointsVector.

func (PointsVector) IsNil added in v0.30.1

func (pvs PointsVector) IsNil() bool

IsNil checks the CGo pointer in the PointsVector.

func (PointsVector) P added in v0.30.1

func (pvs PointsVector) P() C.PointsVector

func (PointsVector) Size added in v0.30.1

func (pvs PointsVector) Size() int

Size returns how many vectors of Points are in the PointsVector.

func (PointsVector) ToPoints added in v0.30.1

func (pvs PointsVector) ToPoints() [][]image.Point

ToPoints returns a slice of slices of image.Point for the data in this PointsVector.

type RNG added in v0.30.1

type RNG struct {
	// contains filtered or unexported fields
}

RNG Random Number Generator. It encapsulates the state (currently, a 64-bit integer) and has methods to return scalar random values and to fill arrays with random values

For further details, please see: https://docs.opencv.org/master/d1/dd6/classcv_1_1RNG.html

func TheRNG added in v0.30.1

func TheRNG() RNG

TheRNG Returns the default random number generator.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#ga75843061d150ad6564b5447e38e57722

func (*RNG) Fill added in v0.30.1

func (r *RNG) Fill(mat *Mat, distType RNGDistType, a, b float64, saturateRange bool)

Fill Fills arrays with random numbers.

For further details, please see: https://docs.opencv.org/master/d1/dd6/classcv_1_1RNG.html#ad26f2b09d9868cf108e84c9814aa682d

func (*RNG) Gaussian added in v0.30.1

func (r *RNG) Gaussian(sigma float64) float64

Gaussian Returns the next random number sampled from the Gaussian distribution.

For further details, please see: https://docs.opencv.org/master/d1/dd6/classcv_1_1RNG.html#a8df8ce4dc7d15916cee743e5a884639d

func (*RNG) Next added in v0.30.1

func (r *RNG) Next() uint

Next The method updates the state using the MWC algorithm and returns the next 32-bit random number.

For further details, please see: https://docs.opencv.org/master/d1/dd6/classcv_1_1RNG.html#a8df8ce4dc7d15916cee743e5a884639d

type RNGDistType added in v0.30.1

type RNGDistType int
const (
	// Uniform distribution
	RNGDistUniform RNGDistType = 0
	// Normal distribution
	RNGDistNormal RNGDistType = 1
)

type ReduceTypes added in v0.17.0

type ReduceTypes int
const (
	// The output is the sum of all rows/columns of the matrix.
	ReduceSum ReduceTypes = 0

	// The output is the mean vector of all rows/columns of the matrix.
	ReduceAvg ReduceTypes = 1

	// The output is the maximum (column/row-wise) of all rows/columns of the matrix.
	ReduceMax ReduceTypes = 2

	// The output is the minimum (column/row-wise) of all rows/columns of the matrix.
	ReduceMin ReduceTypes = 3
)

func (ReduceTypes) String added in v0.30.1

func (c ReduceTypes) String() string

type RetrievalMode added in v0.4.1

type RetrievalMode int

RetrievalMode is the mode of the contour retrieval algorithm.

const (
	// RetrievalExternal retrieves only the extreme outer contours.
	// It sets `hierarchy[i][2]=hierarchy[i][3]=-1` for all the contours.
	RetrievalExternal RetrievalMode = 0

	// RetrievalList retrieves all of the contours without establishing
	// any hierarchical relationships.
	RetrievalList RetrievalMode = 1

	// RetrievalCComp retrieves all of the contours and organizes them into
	// a two-level hierarchy. At the top level, there are external boundaries
	// of the components. At the second level, there are boundaries of the holes.
	// If there is another contour inside a hole of a connected component, it
	// is still put at the top level.
	RetrievalCComp RetrievalMode = 2

	// RetrievalTree retrieves all of the contours and reconstructs a full
	// hierarchy of nested contours.
	RetrievalTree RetrievalMode = 3

	// RetrievalFloodfill lacks a description in the original header.
	RetrievalFloodfill RetrievalMode = 4
)

func (RetrievalMode) String added in v0.30.1

func (c RetrievalMode) String() string

type RotateFlag added in v0.16.0

type RotateFlag int

RotateFlag for image rotation

For further details please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#ga6f45d55c0b1cc9d97f5353a7c8a7aac2

const (
	// Rotate90Clockwise allows to rotate image 90 degrees clockwise
	Rotate90Clockwise RotateFlag = 0
	// Rotate180Clockwise allows to rotate image 180 degrees clockwise
	Rotate180Clockwise RotateFlag = 1
	// Rotate90CounterClockwise allows to rotate 270 degrees clockwise
	Rotate90CounterClockwise RotateFlag = 2
)

func (RotateFlag) String added in v0.30.1

func (c RotateFlag) String() string

type RotatedRect added in v0.16.0

type RotatedRect struct {
	Points       []image.Point
	BoundingRect image.Rectangle
	Center       image.Point
	Width        int
	Height       int
	Angle        float64
}

func FitEllipse added in v0.30.1

func FitEllipse(pts PointVector) RotatedRect

FitEllipse Fits an ellipse around a set of 2D points.

For further details, please see: https://docs.opencv.org/master/d3/dc0/group__imgproc__shape.html#gaf259efaad93098103d6c27b9e4900ffa

func MinAreaRect added in v0.16.0

func MinAreaRect(points PointVector) RotatedRect

MinAreaRect finds a rotated rectangle of the minimum area enclosing the input 2D point set.

For further details, please see: https://docs.opencv.org/master/d3/dc0/group__imgproc__shape.html#ga3d476a3417130ae5154aea421ca7ead9

type Scalar

type Scalar struct {
	Val1 float64
	Val2 float64
	Val3 float64
	Val4 float64
}

Scalar is a 4-element vector widely used in OpenCV to pass pixel values.

For further details, please see: http://docs.opencv.org/master/d1/da0/classcv_1_1Scalar__.html

func MorphologyDefaultBorderValue added in v0.30.1

func MorphologyDefaultBorderValue() Scalar

MorphologyDefaultBorder returns "magic" border value for erosion and dilation. It is automatically transformed to Scalar::all(-DBL_MAX) for dilation.

For further details, please see: https://docs.opencv.org/master/d4/d86/group__imgproc__filter.html#ga94756fad83d9d24d29c9bf478558c40a

func NewScalar

func NewScalar(v1 float64, v2 float64, v3 float64, v4 float64) Scalar

NewScalar returns a new Scalar. These are usually colors typically being in BGR order.

func Trace added in v0.17.0

func Trace(src Mat) Scalar

Trace returns the trace of a matrix.

For further details, please see: https://docs.opencv.org/master/d2/de8/group__core__array.html#ga3419ac19c7dcd2be4bd552a23e147dd8

type SolveDecompositionFlags added in v0.17.0

type SolveDecompositionFlags int
const (
	// Gaussian elimination with the optimal pivot element chosen.
	SolveDecompositionLu SolveDecompositionFlags = 0

	// Singular value decomposition (SVD) method. The system can be over-defined and/or the matrix src1 can be singular.
	SolveDecompositionSvd SolveDecompositionFlags = 1

	// Eigenvalue decomposition. The matrix src1 must be symmetrical.
	SolveDecompositionEing SolveDecompositionFlags = 2

	// Cholesky LL^T factorization. The matrix src1 must be symmetrical and positively defined.
	SolveDecompositionCholesky SolveDecompositionFlags = 3

	// QR factorization. The system can be over-defined and/or the matrix src1 can be singular.
	SolveDecompositionQr SolveDecompositionFlags = 4

	// While all the previous flags are mutually exclusive, this flag can be used together with any of the previous.
	// It means that the normal equations 𝚜𝚛𝚌𝟷^T⋅𝚜𝚛𝚌𝟷⋅𝚍𝚜𝚝=𝚜𝚛𝚌𝟷^T𝚜𝚛𝚌𝟸 are solved instead of the original system
	// 𝚜𝚛𝚌𝟷⋅𝚍𝚜𝚝=𝚜𝚛𝚌𝟸.
	SolveDecompositionNormal SolveDecompositionFlags = 5
)

func (SolveDecompositionFlags) String added in v0.30.1

func (c SolveDecompositionFlags) String() string

type SortFlags added in v0.17.0

type SortFlags int
const (
	// Each matrix row is sorted independently
	SortEveryRow SortFlags = 0

	// Each matrix column is sorted independently; this flag and the previous one are mutually exclusive.
	SortEveryColumn SortFlags = 1

	// Each matrix row is sorted in the ascending order.
	SortAscending SortFlags = 0

	// Each matrix row is sorted in the descending order; this flag and the previous one are also mutually exclusive.
	SortDescending SortFlags = 16
)

func (SortFlags) String added in v0.30.1

func (c SortFlags) String() string

type TemplateMatchMode added in v0.9.0

type TemplateMatchMode int

TemplateMatchMode is the type of the template matching operation.

const (
	// TmSqdiff maps to TM_SQDIFF
	TmSqdiff TemplateMatchMode = 0
	// TmSqdiffNormed maps to TM_SQDIFF_NORMED
	TmSqdiffNormed TemplateMatchMode = 1
	// TmCcorr maps to TM_CCORR
	TmCcorr TemplateMatchMode = 2
	// TmCcorrNormed maps to TM_CCORR_NORMED
	TmCcorrNormed TemplateMatchMode = 3
	// TmCcoeff maps to TM_CCOEFF
	TmCcoeff TemplateMatchMode = 4
	// TmCcoeffNormed maps to TM_CCOEFF_NORMED
	TmCcoeffNormed TemplateMatchMode = 5
)

func (TemplateMatchMode) String added in v0.30.1

func (c TemplateMatchMode) String() string

type TermCriteria added in v0.5.0

type TermCriteria struct {
	// contains filtered or unexported fields
}

TermCriteria is the criteria for iterative algorithms.

For further details, please see: https://docs.opencv.org/master/d9/d5d/classcv_1_1TermCriteria.html

func NewTermCriteria added in v0.5.0

func NewTermCriteria(typ TermCriteriaType, maxCount int, epsilon float64) TermCriteria

NewTermCriteria returns a new TermCriteria.

type TermCriteriaType added in v0.5.0

type TermCriteriaType int

TermCriteriaType for TermCriteria.

For further details, please see: https://docs.opencv.org/master/d9/d5d/classcv_1_1TermCriteria.html#a56fecdc291ccaba8aad27d67ccf72c57

const (
	// Count is the maximum number of iterations or elements to compute.
	Count TermCriteriaType = 1

	// MaxIter is the maximum number of iterations or elements to compute.
	MaxIter TermCriteriaType = 1

	// EPS is the desired accuracy or change in parameters at which the
	// iterative algorithm stops.
	EPS TermCriteriaType = 2
)

func (TermCriteriaType) String added in v0.30.1

func (c TermCriteriaType) String() string

type ThresholdType added in v0.4.1

type ThresholdType int

ThresholdType type of threshold operation.

const (
	// ThresholdBinary threshold type
	ThresholdBinary ThresholdType = 0

	// ThresholdBinaryInv threshold type
	ThresholdBinaryInv ThresholdType = 1

	// ThresholdTrunc threshold type
	ThresholdTrunc ThresholdType = 2

	// ThresholdToZero threshold type
	ThresholdToZero ThresholdType = 3

	// ThresholdToZeroInv threshold type
	ThresholdToZeroInv ThresholdType = 4

	// ThresholdMask threshold type
	ThresholdMask ThresholdType = 7

	// ThresholdOtsu threshold type
	ThresholdOtsu ThresholdType = 8

	// ThresholdTriangle threshold type
	ThresholdTriangle ThresholdType = 16
)

func (ThresholdType) String added in v0.30.1

func (c ThresholdType) String() string

type Vecb added in v0.30.1

type Vecb []uint8

Vecb is a generic vector of bytes.

type Vecd added in v0.30.1

type Vecd []float64

Vecd is a generic vector of float64/doubles.

type Vecf added in v0.16.0

type Vecf []float32

Vecf is a generic vector of floats.

type Veci added in v0.16.0

type Veci []int32

Veci is a generic vector of integers.

Directories

Path Synopsis
cmd
Package contrib is the GoCV wrapper around OpenCV Contrib.
Package contrib is the GoCV wrapper around OpenCV Contrib.
Package cuda is the GoCV wrapper around OpenCV cuda.
Package cuda is the GoCV wrapper around OpenCV cuda.
Package openvino is the GoCV wrapper around the Intel OpenVINO toolkit.
Package openvino is the GoCV wrapper around the Intel OpenVINO toolkit.
ie
Package ie is the GoCV wrapper around the Intel OpenVINO toolkit's Inference Engine.
Package ie is the GoCV wrapper around the Intel OpenVINO toolkit's Inference Engine.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL