OpenCvSharp

https://shimat.github.io/opencvsharp/
Admin
OpenCvSharp is a cross-platform .NET wrapper for OpenCV, providing a rich set of APIs for computer...
Tokens:414,275
Snippets:5,338
Trust Score:9.7
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install OpenCvSharp via NuGet

Source: https://shimat.github.io/opencvsharp/articles/intro.html

Commands to install the core library and platform-specific native bindings.

```bash
# Core library
dotnet add package OpenCvSharp4

# Native bindings (choose one based on your platform)
dotnet add package OpenCvSharp4.runtime.win                            # Windows
# dotnet add package OpenCvSharp4.runtime.win.slim                       # Windows slim
dotnet add package OpenCvSharp4.official.runtime.linux-x64               # Linux x64
# dotnet add package OpenCvSharp4.official.runtime.linux-x64.slim        # Linux x64 slim
dotnet add package OpenCvSharp4.runtime.osx.x64                        # macOS x64 (Intel)
dotnet add package OpenCvSharp4.runtime.osx.arm64                        # macOS arm64 (Apple Silicon)
```

--------------------------------

### Get Rectangular Array Examples

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.Mat.html

Examples demonstrating how to copy matrix data into rectangular arrays of various types.

```csharp
using var m1 = new Mat(1, 1, MatType.CV_8UC1); m1.GetRectangularArray(out byte[,] array);
```

```csharp
using var m2 = new Mat(1, 1, MatType.CV_32SC1); m2.GetRectangularArray(out int[,] array);
```

```csharp
using var m3 = new Mat(1, 1, MatType.CV_8UC(6)); m3.GetRectangularArray(out Vec6b[,] array);
```

```csharp
using var m4 = new Mat(1, 1, MatType.CV_64FC4); m4.GetRectangularArray(out Vec4d[,] array);
```

--------------------------------

### SimpleWB.Create()

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.XPhoto.SimpleWB.html

Creates an instance of the SimpleWB white balance algorithm.

```APIDOC
## SimpleWB.Create()

### Description
Creates a new instance of the SimpleWB class.

### Returns
- **SimpleWB** - A new instance of the SimpleWB class.
```

--------------------------------

### Initialize Method

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.Detail.Timelapser.html

Prepares the timelapser by defining the corners and sizes of the source images in the destination plane.

```csharp
public void Initialize(IReadOnlyList<Point> corners, IReadOnlyList<Size> sizes)
```

--------------------------------

### StartPointInOctave

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.LineDescriptor.KeyLine.html

Gets the start point of the line in the octave it was extracted from.

```APIDOC
## Property: StartPointInOctave

### Description
Returns the start point of the line in the octave it was extracted from.

### Type
Point2f
```

--------------------------------

### StartPoint

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.LineDescriptor.KeyLine.html

Gets the start point of the line in the original image.

```APIDOC
## Property: StartPoint

### Description
Returns the start point of the line in the original image.

### Type
Point2f
```

--------------------------------

### Open(string, VideoCaptureAPIs, FourCC, double, Size, bool)

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.VideoWriter.html

Initializes the video writer with color or grayscale configuration.

```APIDOC
## Open(string, VideoCaptureAPIs, FourCC, double, Size, bool)

### Description
Creates a video writer structure with an option to specify color or grayscale mode.

### Parameters
- **fileName** (string) - Name of the output video file.
- **apiPreference** (VideoCaptureAPIs) - Specifies API backends to use.
- **fourcc** (FourCC) - 4-character code of the codec.
- **fps** (double) - Frame rate of the video stream.
- **frameSize** (Size) - Size of video frames.
- **isColor** (bool) - If true, expects color frames; otherwise, grayscale (Windows only).

### Returns
- **bool** - Returns true if successful.
```

--------------------------------

### Open(string, FourCC, double, Size, bool)

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.VideoWriter.html

Initializes the video writer with specified parameters.

```APIDOC
## public bool Open(string fileName, FourCC fourcc, double fps, Size frameSize, bool isColor = true)

### Description
Creates the video writer structure for saving video files.

### Parameters
- **fileName** (string) - Required - Name of the output video file.
- **fourcc** (FourCC) - Required - 4-character code of the codec.
- **fps** (double) - Required - Frame rate of the video stream.
- **frameSize** (Size) - Required - Size of video frames.
- **isColor** (bool) - Optional - Whether to encode color frames.

### Returns
- **bool** - True if successfully initialized.
```

--------------------------------

### Guid Property

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.VideoCapture.html

Controls camera GUID.

```csharp
public double Guid { get; set; }
```

--------------------------------

### Range Start Field

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.Range.html

The start index of the range.

```csharp
public readonly int Start__
```

--------------------------------

### Create LearningBasedWB Instance

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.Cv2.XPhoto.html

Initializes a new instance of the LearningBasedWB white balance algorithm, optionally using a custom model file.

```csharp
public static LearningBasedWB CreateLearningBasedWB(string? model)__
```

--------------------------------

### EMStartStep Enum

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.EMStartStep.html

The EMStartStep enumeration specifies the starting point for the EM algorithm. It includes options for automatic initialization, starting with the E-step, or starting with the M-step.

```APIDOC
## Enum EMStartStep

### Description
The initial step the algorithm starts from.

### Fields
- **Auto** (0): No values are required from the user, k-means algorithm is used to estimate initial mixtures parameters.
- **E** (1): The algorithm starts with E-step. Initial values of mean vectors must be passed.
- **M** (2): The algorithm starts with M-step. The initial probabilities must be provided.
```

--------------------------------

### Create SimpleWB Instance

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.Cv2.XPhoto.html

Initializes a new instance of the SimpleWB white balance algorithm.

```csharp
public static SimpleWB CreateSimpleWB()__
```

--------------------------------

### Size

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.Internal.Vectors.VectorOfVectorKeyLine.html

Gets the size of the vector.

```APIDOC
## Property: Size

### Description
Gets the number of elements in the vector.

### Type
`int`
```

--------------------------------

### Constructor: Create from Files

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.Dnn.TextDetectionModelDB.html

Initializes a new instance of the model using model weights and an optional configuration file.

```csharp
public TextDetectionModelDB(string model, string? config = null)
```

--------------------------------

### Name Property

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.Window.html

Gets the name of the window.

```APIDOC
## Property: Name

### Description
Gets window name.

### Type
`string`
```

--------------------------------

### Open(string, VideoCaptureAPIs, FourCC, double, Size, VideoWriterPara)

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.VideoWriter.html

Initializes the video writer with specific hardware acceleration parameters.

```APIDOC
## Open(string, VideoCaptureAPIs, FourCC, double, Size, VideoWriterPara)

### Description
Creates a video writer structure with hardware acceleration parameters.

### Parameters
- **fileName** (string) - Name of the output video file.
- **apiPreference** (VideoCaptureAPIs) - Specifies API backends to use.
- **fourcc** (FourCC) - 4-character code of the codec.
- **fps** (double) - Frame rate of the video stream.
- **frameSize** (Size) - Size of video frames.
- **prms** (VideoWriterPara) - Parameters for hardware acceleration.

### Returns
- **bool** - Returns true if successful.
```

--------------------------------

### Init Method

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.Tracker.html

Initializes the tracker with an initial frame and target bounding box.

```csharp
public void Init(Mat image, Rect boundingBox)
```

--------------------------------

### GetSize2()

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.Internal.Vectors.VectorOfVectorDMatch.html

Gets the sizes of the inner vectors.

```APIDOC
## Method: GetSize2()

### Description
Returns the sizes of the inner vectors (vector[i].size()).

### Signature
`public IReadOnlyList<long> GetSize2()`

### Returns
- **IReadOnlyList<long>** - A list containing the sizes of each inner vector.
```

--------------------------------

### GetSize1()

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.Internal.Vectors.VectorOfVectorDMatch.html

Gets the size of the outer vector.

```APIDOC
## Method: GetSize1()

### Description
Returns the size of the outer vector.

### Signature
`public int GetSize1()`

### Returns
- **int** - The size of the outer vector.
```

--------------------------------

### SetOnDiskBuild Method

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.ANNIndex.html

Prepares to build the index in a file instead of RAM.

```csharp
public bool SetOnDiskBuild(string filename)
```

--------------------------------

### Size

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.Internal.Vectors.VectorOfVectorDMatch.html

Gets the size of the outer vector.

```APIDOC
## Property: Size

### Description
Returns the size of the outer vector (vector.size()).

### Signature
`public int Size { get; }`
```

--------------------------------

### Init Method

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.Saliency.MotionSaliencyBinWangApr2014.html

Initializes all data structures for the algorithm. Call after SetImagesize(int, int).

```csharp
public bool Init()
```

--------------------------------

### FacemarkKazemi.SetFaceDetector

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.Face.FacemarkKazemi.html

Installs a managed face detector for the model.

```APIDOC
## public void SetFaceDetector(FacemarkFaceDetector detector)

### Description
Configures the model to use a specific managed face detector.

### Parameters
- **detector** (FacemarkFaceDetector) - Required - The face detector instance to install.
```

--------------------------------

### SimpleWB Methods

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.XPhoto.SimpleWB.html

Methods for applying white balance and creating an instance of the class.

```csharp
public override void BalanceWhite(InputArray src, OutputArray dst)
```

```csharp
public static SimpleWB Create()
```

--------------------------------

### PtrObj Property

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.XImgProc.Segmentation.SelectiveSearchSegmentationStrategy.html

Gets the pointer to the underlying object.

```csharp
public nint PtrObj { get; }
```

--------------------------------

### LearningBasedWB.Create(string?)

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.XPhoto.LearningBasedWB.html

Creates an instance of the LearningBasedWB class. Optionally accepts a path to a model file.

```APIDOC
## LearningBasedWB.Create(string? model)

### Description
Creates an instance of LearningBasedWB. If a model path is provided, it loads the model from the specified .yml file; otherwise, it uses the default model.

### Parameters
- **model** (string?) - Optional - Path to a .yml file with the model.

### Returns
- **LearningBasedWB** - An instance of the LearningBasedWB class.
```

--------------------------------

### Create Method

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.XPhoto.LearningBasedWB.html

Creates an instance of LearningBasedWB, optionally loading a model from a .yml file.

```csharp
public static LearningBasedWB Create(string? model)
```

--------------------------------

### WeightY Property

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.XFeatures2D.PCTSignatures.html

Sets or gets the weight for the y-axis.

```csharp
public float WeightY { get; set; }__
```

--------------------------------

### VideoCapture Initialization Methods

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.VideoCapture.html

Static methods to initialize video capture from cameras or files.

```csharp
public static VideoCapture FromCamera(int index, VideoCaptureAPIs apiPreference = VideoCaptureAPIs.ANY)__
```

```csharp
public static VideoCapture FromFile(string fileName, VideoCaptureAPIs apiPreference = VideoCaptureAPIs.ANY)__
```

--------------------------------

### WeightX Property

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.XFeatures2D.PCTSignatures.html

Sets or gets the weight for the x-axis.

```csharp
public float WeightX { get; set; }__
```

--------------------------------

### FrameWidth Property

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.VideoCapture.html

Gets or sets the frame width.

```csharp
public int FrameWidth { get; set; }
```

--------------------------------

### Create Method

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.XPhoto.GrayworldWB.html

Instantiates a new object of the GrayworldWB class.

```csharp
public static GrayworldWB Create()
```

--------------------------------

### Create GrayworldWB Instance

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.Cv2.XPhoto.html

Initializes a new instance of the GrayworldWB white balance algorithm.

```csharp
public static GrayworldWB CreateGrayworldWB()__
```

--------------------------------

### FrameHeight Property

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.VideoCapture.html

Gets or sets the frame height.

```csharp
public int FrameHeight { get; set; }
```

--------------------------------

### Fps Property

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.VideoCapture.html

Gets or sets the frame rate.

```csharp
public double Fps { get; set; }
```

--------------------------------

### FacemarkAAM.Config()

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.Face.FacemarkAAM.Config.html

Constructor to create a configuration instance with default values provided by OpenCV.

```APIDOC
## Constructor: FacemarkAAM.Config()

### Description
Creates a new configuration instance using OpenCV's default settings.

### Signature
`public Config()`
```

--------------------------------

### BuildMap Method

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.Segmentation.IntelligentScissorsMB.html

Prepares a map of optimal paths for a given source point; must be called after ApplyImage or ApplyImageFeatures.

```csharp
public void BuildMap(Point sourcePt)
```

--------------------------------

### ResponseThreshold Property

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.XFeatures2D.StarDetector.html

Gets or sets the response threshold.

```csharp
public int ResponseThreshold { get; set; }
```

--------------------------------

### Install OpenCvSharp via NuGet

Source: https://shimat.github.io/opencvsharp/index.html

Use the .NET CLI to add the core OpenCvSharp package and the Windows-specific runtime dependency.

```bash
dotnet add package OpenCvSharp4
dotnet add package OpenCvSharp4.runtime.win  # For Windows
```

--------------------------------

### Get(VideoWriterProperties)

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.VideoWriter.html

Retrieves a specific property of the VideoWriter.

```APIDOC
## public double Get(VideoWriterProperties propId)

### Description
Returns the value of the specified VideoWriter property.

### Parameters
- **propId** (VideoWriterProperties) - Required - Property identifier.

### Returns
- **double** - The value of the property, or 0 if not supported.
```

--------------------------------

### GetNumRejected()

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.Text.ERFilter.html

Gets the number of rejected extremal regions.

```APIDOC
## GetNumRejected()

### Description
Gets the number of rejected extremal regions.

### Returns
- **int** - The count of rejected regions.
```

--------------------------------

### Begin()

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.FileNode.html

Returns an iterator pointing to the first node element.

```APIDOC
## FileNode.Begin()

### Description
Returns an iterator pointing to the first node element.

### Returns
- **FileNodeIterator** - Iterator for the first element.
```

--------------------------------

### Tonemap.Gamma

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.Tonemap.html

Gets or sets the gamma correction value.

```APIDOC
## Tonemap.Gamma

### Description
Gets or sets a positive value for gamma correction. Gamma value of 1.0 implies no correction, gamma equal to 2.2f is suitable for most displays. Generally gamma > 1 brightens the image and gamma < 1 darkens it.

### Property Value
- **float**
```

--------------------------------

### BRISK.Create(int, int, IEnumerable<float>, IEnumerable<int>, float, float, IEnumerable<int>?)

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.XFeatures2D.BRISK.html

Creates a BRISK instance with custom detection threshold, octaves, and sampling pattern.

```APIDOC
## static BRISK Create(int thresh, int octaves, IEnumerable<float> radiusList, IEnumerable<int> numberList, float dMax = 5.85, float dMin = 8.2, IEnumerable<int>? indexChange = null)

### Description
The BRISK constructor for a custom pattern, detection threshold and octaves.

### Parameters
- **thresh** (int) - Required - AGAST detection threshold score.
- **octaves** (int) - Required - Detection octaves. Use 0 to do single scale.
- **radiusList** (IEnumerable<float>) - Required - Defines the radii (in pixels) where the samples around a keypoint are taken (for keypoint scale 1).
- **numberList** (IEnumerable<int>) - Required - Defines the number of sampling points on the sampling circle. Must be the same size as radiusList.
- **dMax** (float) - Optional - Threshold for the short pairings used for descriptor formation (in pixels for keypoint scale 1).
- **dMin** (float) - Optional - Threshold for the long pairings used for orientation determination (in pixels for keypoint scale 1).
- **indexChange** (IEnumerable<int>) - Optional - Index remapping of the bits.

### Returns
- **BRISK** - A new instance of the BRISK class.
```

--------------------------------

### ImageWidth Property

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.Saliency.MotionSaliencyBinWangApr2014.html

Gets or sets the image width.

```csharp
public int ImageWidth { get; set; }
```

--------------------------------

### Process an image with OpenCvSharp

Source: https://shimat.github.io/opencvsharp/articles/intro.html

Basic example demonstrating loading an image, converting it to grayscale, applying a Gaussian blur, and saving the result.

```csharp
using OpenCvSharp;

// Load an image
using var src = Cv2.ImRead("sample.jpg");

// Convert to grayscale
using var gray = new Mat();
Cv2.CvtColor(src, gray, ColorConversionCodes.BGR2GRAY);

// Apply Gaussian blur
using var blurred = new Mat();
Cv2.GaussianBlur(gray, blurred, new Size(5, 5), 0);

// Save the result
Cv2.ImWrite("output.jpg", blurred);
```

--------------------------------

### ImageHeight Property

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.Saliency.MotionSaliencyBinWangApr2014.html

Gets or sets the image height.

```csharp
public int ImageHeight { get; set; }
```

--------------------------------

### GrayworldWB.Create()

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.XPhoto.GrayworldWB.html

Creates a new instance of the GrayworldWB class.

```APIDOC
## GrayworldWB.Create()

### Description
Creates an instance of the GrayworldWB white balancer.

### Returns
- **GrayworldWB** - A new instance of the GrayworldWB class.
```

--------------------------------

### Constructor

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.XImgProc.Segmentation.SelectiveSearchSegmentationStrategy.html

Creates an instance via the factory pattern.

```csharp
protected SelectiveSearchSegmentationStrategy(nint smartPtr, nint rawPtr, Action<nint> release)
```

--------------------------------

### VolumeParams Property

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.Rgbd.LargeKinfuParams.html

Gets or sets the volume parameters.

```csharp
public LargeKinfuVolumeParams VolumeParams { get; set; }__
```

--------------------------------

### StartWriteStruct(string, Types, string?)

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.FileStorage.html

Starts writing a nested structure.

```APIDOC
## void StartWriteStruct(string name, FileNode.Types flags, string? typeName = null)

### Description
Starts writing a nested structure (sequence or mapping).

### Parameters
- **name** (string) - Name of the structure.
- **flags** (FileNode.Types) - Structure type (Map/Seq).
- **typeName** (string) - Optional object class name.
```

--------------------------------

### Get Variable Count

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.ML.TrainData.html

Returns the number of variables.

```csharp
public int GetNVars()
```

--------------------------------

### Create BackgroundSubtractorLSBP Instance

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.BackgroundSubtractorLSBP.html

Static method to instantiate the BackgroundSubtractorLSBP algorithm with configurable parameters for motion compensation, sampling, and thresholding.

```csharp
public static BackgroundSubtractorLSBP Create(LSBPCameraMotionCompensation mc = LSBPCameraMotionCompensation.None, int nSamples = 20, int lsbpRadius = 16, float tLower = 2, float tUpper = 32, float tInc = 1, float tDec = 0.05, float rScale = 10, float rIncdec = 0.005, float noiseRemovalThresholdFacBG = 0.0004, float noiseRemovalThresholdFacFG = 0.0008, int lsbpThreshold = 8, int minCount = 2)
```

--------------------------------

### Get Eigenvectors

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.LDA.html

Retrieves the eigenvectors of the LDA model.

```csharp
public Mat Eigenvectors()__
```

--------------------------------

### GetBackends Method

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.Cv2.VideoIORegistry.html

Retrieves a list of all available video I/O backends.

```csharp
public static VideoCaptureAPIs[] GetBackends()__
```

--------------------------------

### Get Methods

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.Flann.IndexParams.html

Methods to retrieve configuration values from the index parameters.

```APIDOC
## Methods: GetDouble, GetInt, GetString

### Description
Retrieves a configuration value associated with the specified key. If the key is not found, the provided default value is returned.

### Signatures
- `public double GetDouble(string key, double defaultVal = -1)`
- `public int GetInt(string key, int defaultVal = -1)`
- `public string GetString(string key, string? defaultVal = null)`
```

--------------------------------

### Get Eigenvalues

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.LDA.html

Retrieves the eigenvalues of the LDA model.

```csharp
public Mat Eigenvalues()__
```

--------------------------------

### FacemarkAAM.Config Constructors

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.Face.FacemarkAAM.Config.html

Constructors for initializing the configuration with default or specific parameters.

```csharp
public Config()__
```

```csharp
public Config(Mat? rotation, Point2f translation, float scale, int modelScaleIndex)__
```

--------------------------------

### ElemPtr

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.Internal.Vectors.VectorOfDTreesNode.html

Gets the pointer to the first element of the vector.

```APIDOC
## Property: ElemPtr

### Description
Returns the pointer to the first element of the underlying std::vector (&vector[0]).

### Type
`nint`
```

--------------------------------

### BriefDescriptorExtractor.Create(int, bool)

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.XFeatures2D.BriefDescriptorExtractor.html

Creates an instance of the BriefDescriptorExtractor.

```APIDOC
## BriefDescriptorExtractor.Create(int bytes, bool useOrientation)

### Description
Creates a new instance of the BriefDescriptorExtractor. The bytes parameter defines the length of the descriptor in bytes (16, 32, or 64).

### Parameters
- **bytes** (int) - Optional - Length of the descriptor in bytes. Default is 32.
- **useOrientation** (bool) - Optional - Whether to sample patterns using keypoints orientation. Default is false.

### Returns
- **BriefDescriptorExtractor** - An instance of the extractor.
```

--------------------------------

### Window Constructor (Named)

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.Window.html

Initializes a new window with a specific name, optional initial image, and window flags.

```csharp
public Window(string name, Mat? image = null, WindowFlags flags = WindowFlags.AutoSize)
```

--------------------------------

### Length

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.Internal.Util.ReadOnlyArray2D-1.html

Gets the total number of elements in the array.

```APIDOC
## Property: Length

### Description
Gets the total number of elements in all dimensions of the array.

### Returns
- **int** - The total count of elements.
```

--------------------------------

### Construct TextDetectionModelEAST from Files

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.Dnn.TextDetectionModelEAST.html

Initialize the model using paths to the model weights and configuration files.

```csharp
public TextDetectionModelEAST(string model, string? config = null)
```

--------------------------------

### AffineTransformer.FullAffine

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.AffineTransformer.html

Gets or sets the transformation mode for the AffineTransformer.

```APIDOC
## Property: FullAffine

### Description
Gets or sets whether the full (6 DOF) affine transformation is used (true) or partial affine (4 DOF, false).

### Type
`bool`
```

--------------------------------

### Create Method

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.XFeatures2D.BriefDescriptorExtractor.html

Creates an instance of BriefDescriptorExtractor with specified descriptor length and orientation usage.

```csharp
public static BriefDescriptorExtractor Create(int bytes = 32, bool useOrientation = false)
```

--------------------------------

### GuidedFilter.Filter

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.XImgProc.GuidedFilter.html

Applies the Guided Filter to the provided source image.

```APIDOC
## virtual void Filter(InputArray src, OutputArray dst, int dDepth = -1)

### Description
Apply Guided Filter to the filtering image.

### Parameters
- **src** (InputArray) - Filtering image with any number of channels.
- **dst** (OutputArray) - Output image.
- **dDepth** (int) - Optional depth of the output image. Defaults to -1 (equivalent to src.depth()).
```

--------------------------------

### Init()

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.Saliency.MotionSaliencyBinWangApr2014.html

Initializes the internal data structures of the algorithm.

```APIDOC
## public bool Init()

### Description
Initializes all data structures for the algorithm. Call after SetImagesize(int, int).

### Returns
- **bool** - true if initialization succeeded.
```

--------------------------------

### Get(int, int)

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.XImgProc.Segmentation.SelectiveSearchSegmentationStrategyMultiple.html

Returns the score between two regions.

```APIDOC
## public virtual float Get(int r1, int r2)

### Description
Return the score between two regions (between 0 and 1).

### Parameters
- **r1** (int) - The first region.
- **r2** (int) - The second region.

### Returns
- **float** - The score between the regions.
```

--------------------------------

### Create Method

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.TonemapMantiuk.html

Creates an instance of the TonemapMantiuk class with specified gamma, scale, and saturation parameters.

```csharp
public static TonemapMantiuk Create(float gamma = 1, float scale = 0.7, float saturation = 1)
```

--------------------------------

### WeightEntropy Property

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.XFeatures2D.PCTSignatures.html

Sets or gets the weight for the entropy axis.

```csharp
public float WeightEntropy { get; set; }__
```

--------------------------------

### Prepare Methods

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.Detail.Blender.html

Prepares the blender for the blending process using either a region of interest or a list of image corners and sizes.

```csharp
public void Prepare(Rect dstRoi)
```

```csharp
public void Prepare(IReadOnlyList<Point> corners, IReadOnlyList<Size> sizes)
```

--------------------------------

### WeightContrast Property

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.XFeatures2D.PCTSignatures.html

Sets or gets the weight for the contrast axis.

```csharp
public float WeightContrast { get; set; }__
```

--------------------------------

### Create Method

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.TonemapReinhard.html

Creates a TonemapReinhard object with specified gamma, intensity, light adaptation, and color adaptation parameters.

```csharp
public static TonemapReinhard Create(float gamma = 1, float intensity = 0, float lightAdapt = 1, float colorAdapt = 0)
```

--------------------------------

### VideoCapture XI_DataFormat Property

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.VideoCapture.html

Gets the output data format.

```csharp
public double XI_DataFormat { get; }
```

--------------------------------

### VideoCapture Trigger Property

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.VideoCapture.html

Gets or sets the trigger value.

```csharp
public double Trigger { get; set; }
```

--------------------------------

### Open(string, VideoCaptureAPIs, FourCC, double, Size, int[])

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.VideoWriter.html

Initializes the video writer with custom encoder parameters.

```APIDOC
## Open(string, VideoCaptureAPIs, FourCC, double, Size, int[])

### Description
Creates a video writer structure using an array of encoder parameters.

### Parameters
- **fileName** (string) - Name of the output video file.
- **apiPreference** (VideoCaptureAPIs) - Specifies API backends to use.
- **fourcc** (FourCC) - 4-character code of the codec.
- **fps** (double) - Frame rate of the video stream.
- **frameSize** (Size) - Size of video frames.
- **prms** (int[]) - Extra encoder parameters encoded as pairs (paramId, paramValue).

### Returns
- **bool** - Returns true if successful.
```

--------------------------------

### EmptyClone Method

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.Mat.html

Makes a Mat that has the same size, depth, and channels as the current image.

```csharp
public Mat EmptyClone()__
```

--------------------------------

### VideoCapture Tilt Property

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.VideoCapture.html

Gets or sets the tilt value.

```csharp
public double Tilt { get; set; }
```

--------------------------------

### Initialize VideoWriter with encoder parameters

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.VideoWriter.html

Creates a video writer structure using an integer array to specify extra encoder parameters as key-value pairs.

```csharp
public VideoWriter(string fileName, VideoCaptureAPIs apiPreference, FourCC fourcc, double fps, Size frameSize, int[] prms)__
```

--------------------------------

### VideoCapture Temperature Property

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.VideoCapture.html

Gets or sets the temperature property.

```csharp
public double Temperature { get; set; }
```

--------------------------------

### VideoCapture Sharpness Property

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.VideoCapture.html

Gets or sets the sharpness value.

```csharp
public double Sharpness { get; set; }
```

--------------------------------

### CreateLearningBasedWB

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.Cv2.XPhoto.html

Creates an instance of LearningBasedWB.

```APIDOC
## CreateLearningBasedWB

### Description
Creates an instance of LearningBasedWB using a specified model file.

### Signature
public static LearningBasedWB CreateLearningBasedWB(string? model)
```

--------------------------------

### VideoCapture Settings Property

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.VideoCapture.html

Gets or sets the settings property.

```csharp
public double Settings { get; set; }
```

--------------------------------

### Create()

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.XImgProc.Segmentation.SelectiveSearchSegmentationStrategyMultiple.html

Creates a new instance of the multiple strategy.

```APIDOC
## public static SelectiveSearchSegmentationStrategyMultiple Create()

### Description
Create a new multiple strategy.

### Returns
- **SelectiveSearchSegmentationStrategyMultiple** - The created strategy instance.
```

--------------------------------

### Access StartPoint property

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.LineDescriptor.KeyLine.html

Retrieves the start point of the line in the original image.

```csharp
public Point2f StartPoint { get; }
```

--------------------------------

### VideoCapture Roll Property

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.VideoCapture.html

Gets or sets the roll value.

```csharp
public double Roll { get; set; }
```

--------------------------------

### GridBoard(Size, float, float, Dictionary, IEnumerable<int>?)

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.Aruco.GridBoard.html

Constructor for the GridBoard class. Initializes a new instance of a planar board with a specified grid size, marker dimensions, and dictionary.

```APIDOC
## Constructor: GridBoard(Size size, float markerLength, float markerSeparation, Dictionary dictionary, IEnumerable<int>? ids)

### Description
Initializes a new GridBoard object with the specified grid dimensions and marker parameters.

### Parameters
- **size** (Size) - Number of markers in x and y directions.
- **markerLength** (float) - Marker side length (normally in meters).
- **markerSeparation** (float) - Separation between two markers (same unit as markerLength).
- **dictionary** (Dictionary) - Dictionary of markers indicating the type of markers.
- **ids** (IEnumerable<int>) - Optional set of marker ids in dictionary to use on board. If null, sequential ids starting at 0 are used.
```

--------------------------------

### Create Method

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.ML.Boost.html

Creates an empty Boost model instance.

```csharp
public static Boost Create()
```

--------------------------------

### VideoCapture Pan Property

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.VideoCapture.html

Gets or sets the pan value.

```csharp
public double Pan { get; set; }
```

--------------------------------

### TrackerBoosting.Create()

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.Tracking.Legacy.TrackerBoosting.html

Creates a new instance of the TrackerBoosting class using default parameters.

```APIDOC
## TrackerBoosting.Create()

### Description
Creates a new instance of the TrackerBoosting class.

### Signature
`public static TrackerBoosting Create()`

### Returns
- **TrackerBoosting** - A new instance of the tracker.
```

--------------------------------

### Hue Property

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.VideoCapture.html

Gets or sets the image hue for cameras.

```csharp
public double Hue { get; set; }
```

--------------------------------

### Create QRCodeEncoder Instance

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.QRCodeEncoder.html

Methods to instantiate the QRCodeEncoder with default or custom parameters.

```csharp
public static QRCodeEncoder Create()
```

```csharp
public static QRCodeEncoder Create(QRCodeEncoderParams parameters)
```

--------------------------------

### FrameCount Property

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.VideoCapture.html

Gets the number of frames in a video file.

```csharp
public int FrameCount { get; }
```

--------------------------------

### FourCC Property

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.VideoCapture.html

Gets or sets the 4-character codec code.

```csharp
public string FourCC { get; set; }
```

--------------------------------

### Default Method

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.XImgProc.EdgeDrawingParams.html

Returns a new instance initialized with the native library's default values.

```csharp
public static EdgeDrawingParams Default()__
```

--------------------------------

### VideoCapture()

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.VideoCapture.html

Initializes an empty capture instance. Use the Open method to start capturing.

```APIDOC
## VideoCapture()

### Description
Initializes an empty capture. To use this, you should call Open.
```

--------------------------------

### Contrast Property

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.VideoCapture.html

Gets or sets the image contrast for cameras.

```csharp
public double Contrast { get; set; }
```

--------------------------------

### Create OCRHMMDecoder Instance via File

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.Text.OCRHMMDecoder.html

Initializes an OCRHMMDecoder instance by loading a classifier model from a file.

```csharp
public static OCRHMMDecoder Create(string filename, string vocabulary, InputArray transitionProbabilitiesTable, InputArray emissionProbabilitiesTable, DecoderMode mode = DecoderMode.Viterbi, ClassifierType classifier = ClassifierType.Knn)
```

--------------------------------

### Brightness Property

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.VideoCapture.html

Gets or sets the image brightness for cameras.

```csharp
public double Brightness { get; set; }
```

--------------------------------

### FGSSigma Property

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.XImgProc.EdgeAwareInterpolator.html

Gets or sets the sigma parameter for the fastGlobalSmootherFilter.

```csharp
public float FGSSigma { get; set; }
```

--------------------------------

### BRISK.Create(IEnumerable<float>, IEnumerable<int>, float, float, IEnumerable<int>?)

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.XFeatures2D.BRISK.html

Creates a BRISK instance using a custom sampling pattern.

```APIDOC
## static BRISK Create(IEnumerable<float> radiusList, IEnumerable<int> numberList, float dMax = 5.85, float dMin = 8.2, IEnumerable<int>? indexChange = null)

### Description
The BRISK constructor for a custom pattern.

### Parameters
- **radiusList** (IEnumerable<float>) - Required - Defines the radii (in pixels) where the samples around a keypoint are taken (for keypoint scale 1).
- **numberList** (IEnumerable<int>) - Required - Defines the number of sampling points on the sampling circle. Must be the same size as radiusList.
- **dMax** (float) - Optional - Threshold for the short pairings used for descriptor formation (in pixels for keypoint scale 1).
- **dMin** (float) - Optional - Threshold for the long pairings used for orientation determination (in pixels for keypoint scale 1).
- **indexChange** (IEnumerable<int>) - Optional - Index remapping of the bits.

### Returns
- **BRISK** - A new instance of the BRISK class.
```

--------------------------------

### FGSLambda Property

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.XImgProc.EdgeAwareInterpolator.html

Gets or sets the lambda parameter for the fastGlobalSmootherFilter.

```csharp
public float FGSLambda { get; set; }
```

--------------------------------

### Create Method

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.XFeatures2D.PCTSignaturesSQFD.html

Creates an instance of the PCTSignaturesSQFD algorithm with specified distance and similarity functions.

```csharp
public static PCTSignaturesSQFD Create(PCTSignaturesDistanceFunction distanceFunction = PCTSignaturesDistanceFunction.L2, PCTSignaturesSimilarityFunction similarityFunction = PCTSignaturesSimilarityFunction.Heuristic, float similarityParameter = 1)
```

--------------------------------

### FacemarkAAM.Config(Mat?, Point2f, float, int)

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.Face.FacemarkAAM.Config.html

Constructor to create a configuration instance with specific runtime fitting parameters.

```APIDOC
## Constructor: FacemarkAAM.Config(Mat? rotation, Point2f translation, float scale, int modelScaleIndex)

### Description
Creates a runtime fitting configuration with custom pose and scale parameters.

### Parameters
- **rotation** (Mat?) - Optional 2x2 CV_32F rotation matrix.
- **translation** (Point2f) - Translation applied during fitting.
- **scale** (float) - Scale applied during fitting.
- **modelScaleIndex** (int) - Index of the model scale to use.
```

--------------------------------

### TreeHeight Property

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.XImgProc.AdaptiveManifoldFilter.html

Gets or sets the height of the manifold tree.

```csharp
public int TreeHeight { get; set; }
```

--------------------------------

### SigmaS Property

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.XImgProc.AdaptiveManifoldFilter.html

Gets or sets the spatial standard deviation.

```csharp
public double SigmaS { get; set; }
```

--------------------------------

### Create(double, double, double, int, int, double, int, int, double, double, int, bool)

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.OptFlow.DualTVL1OpticalFlow.html

Creates an instance of the DualTVL1OpticalFlow algorithm with specified parameters.

```APIDOC
## Create(double tau, double lambda, double theta, int nscales, int warps, double epsilon, int innerIterations, int outerIterations, double scaleStep, double gamma, int medianFiltering, bool useInitialFlow)

### Description
Creates a new instance of the cv::optflow::DualTVL1OpticalFlow algorithm.

### Parameters
- **tau** (double) - Time step of the numerical scheme.
- **lambda** (double) - Weight parameter for the data term, attachment parameter.
- **theta** (double) - Weight parameter for (u - v)^2, tightness parameter.
- **nscales** (int) - Number of scales used to create the pyramid of images.
- **warps** (int) - Number of warpings per scale.
- **epsilon** (double) - Stopping criterion threshold used in the numerical scheme.
- **innerIterations** (int) - Inner iterations (between outlier filtering) used in the numerical scheme.
- **outerIterations** (int) - Outer iterations (number of inner loops) used in the numerical scheme.
- **scaleStep** (double) - Step between scales (<1).
- **gamma** (double) - Coefficient for additional illumination variation term.
- **medianFiltering** (int) - Median filter kernel size (1 = no filter) (3 or 5).
- **useInitialFlow** (bool) - Use initial flow.

### Returns
- **DualTVL1OpticalFlow** - An instance of the DualTVL1OpticalFlow class.
```

--------------------------------

### Create LightGlueMatcher from File

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.LightGlueMatcher.html

Creates a matcher instance from an ONNX model file path. On Windows, non-ASCII paths are handled by reading the file into memory.

```csharp
public static LightGlueMatcher Create(string modelPath, float scoreThreshold = 0, int backend = 0, int target = 0)
```

--------------------------------

### AdjustOutliers Property

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.XImgProc.AdaptiveManifoldFilter.html

Gets or sets the flag to adjust outliers.

```csharp
public bool AdjustOutliers { get; set; }
```

--------------------------------

### SwitchToSingleStrategy Method

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.XImgProc.Segmentation.SelectiveSearchSegmentation.html

Initializes the class with parameters for the 'Single strategy' algorithm.

```csharp
public virtual void SwitchToSingleStrategy(int k = 200, float sigma = 0.8)
```

--------------------------------

### SuppressNonmaxSize Property

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.XFeatures2D.StarDetector.html

Gets or sets the non-maximum suppression size.

```csharp
public int SuppressNonmaxSize { get; set; }
```

--------------------------------

### Initialize OdometrySettings

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.OdometrySettings.html

Constructor to create default odometry settings.

```csharp
public OdometrySettings()
```

--------------------------------

### MaxSize Property

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.XFeatures2D.StarDetector.html

Gets or sets the maximum size of the features.

```csharp
public int MaxSize { get; set; }
```

--------------------------------

### Image Property

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.Window.html

Gets or sets the image to be shown in the window.

```APIDOC
## Property: Image

### Description
Gets or sets an image to be shown.

### Type
`Mat?`
```

--------------------------------

### Open(string, VideoCaptureAPIs, VideoCapturePara)

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.VideoCapture.html

Opens a video source with specific API preference and hardware acceleration parameters.

```APIDOC
## Open(string fileName, VideoCaptureAPIs apiPreference, VideoCapturePara prms)

### Description
Opens a video file, capturing device, or IP video stream for video capturing with API Preference and hardware acceleration parameters.

### Parameters
- **fileName** (string) - Required - The name of the video file, image sequence, or URL of the video stream.
- **apiPreference** (VideoCaptureAPIs) - Required - The preferred Capture API backend to use.
- **prms** (VideoCapturePara) - Required - Parameters of VideoCapture for hardware acceleration.

### Returns
- **bool** - Returns true if the file has been successfully opened.
```

--------------------------------

### GetGenericIndexer<T>()

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.Mat.html

Gets a type-specific indexer for accessing matrix elements.

```APIDOC
## GetGenericIndexer<T>()

### Description
Gets a type-specific indexer for accessing matrix elements. Note: This method is marked as obsolete in favor of At<T> or AsRows<T>.

### Returns
- **Mat.Indexer<T>** - The indexer instance.
```

--------------------------------

### CreateOptFlow Factory Methods

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.Cv2.OptFlow.html

Factory methods to instantiate various dense and sparse optical flow algorithms with default parameters.

```csharp
public static DenseOpticalFlow CreateOptFlow_DeepFlow()__
```

```csharp
public static DenseOpticalFlow CreateOptFlow_DenseRLOF()__
```

```csharp
public static DualTVL1OpticalFlow CreateOptFlow_DualTVL1()__
```

```csharp
public static DenseOpticalFlow CreateOptFlow_Farneback()__
```

```csharp
public static DenseOpticalFlow CreateOptFlow_PCAFlow()__
```

```csharp
public static DenseOpticalFlow CreateOptFlow_SimpleFlow()__
```

```csharp
public static SparseOpticalFlow CreateOptFlow_SparseRLOF()__
```

```csharp
public static DenseOpticalFlow CreateOptFlow_SparseToDense()__
```

--------------------------------

### Window(string, Mat?, WindowFlags)

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.Window.html

Creates a window with a specified name, optional image, and window flags.

```APIDOC
## Constructor: Window(string name, Mat? image, WindowFlags flags)

### Description
Creates a window with a specified name, optional image, and window flags.

### Parameters
- **name** (string) - Name of the window which is used as window identifier and appears in the window caption.
- **image** (Mat) - Image to be shown.
- **flags** (WindowFlags) - Flags of the window. Currently the only supported flag is WindowMode.AutoSize.
```

--------------------------------

### RegularizationParameter

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.ThinPlateSplineShapeTransformer.html

Gets or sets the regularization parameter for the TPS transformation.

```APIDOC
## Property: RegularizationParameter

### Description
The regularization parameter used for the TPS transformation.

### Type
`double`

### Access
Read/Write
```

--------------------------------

### BuildMaps Method

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.PyRotationWarper.html

Builds the projection maps based on camera data.

```csharp
public Rect BuildMaps(Size srcSize, InputArray k, InputArray r, OutputArray xmap, OutputArray ymap)
```

--------------------------------

### Get Triangle List

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.Subdiv2D.html

Retrieves a list of all triangles in the subdivision.

```csharp
public Vec6f[] GetTriangleList()__
```

--------------------------------

### Get Edge List

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.Subdiv2D.html

Retrieves a list of all edges in the subdivision.

```csharp
public Vec4f[] GetEdgeList()__
```

--------------------------------

### FacemarkAAM.Params Constructor

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.Face.FacemarkAAM.Params.html

Initializes a new instance of the parameters with default OpenCV values.

```csharp
public Params()__
```

--------------------------------

### CreateOptFlow Methods

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.Cv2.OptFlow.html

Factory methods to create instances of various optical flow algorithms.

```APIDOC
## CreateOptFlow Methods

### Description
Methods to instantiate various optical flow algorithm implementations.

### Methods
- **CreateOptFlow_DeepFlow()**: Returns DenseOpticalFlow.
- **CreateOptFlow_DenseRLOF()**: Returns DenseOpticalFlow.
- **CreateOptFlow_DualTVL1()**: Returns DualTVL1OpticalFlow.
- **CreateOptFlow_Farneback()**: Returns DenseOpticalFlow.
- **CreateOptFlow_PCAFlow()**: Returns DenseOpticalFlow.
- **CreateOptFlow_SimpleFlow()**: Returns DenseOpticalFlow.
- **CreateOptFlow_SparseRLOF()**: Returns SparseOpticalFlow.
- **CreateOptFlow_SparseToDense()**: Returns DenseOpticalFlow.
```

--------------------------------

### LevelsNumber Property

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.SuperResFarnebackOpticalFlow.html

Gets or sets the number of pyramid levels.

```csharp
public int LevelsNumber { get; set; }
```

--------------------------------

### Create TrackerBoosting Instance

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.Tracking.Legacy.TrackerBoosting.html

Methods to instantiate a TrackerBoosting object, either with default settings or custom parameters.

```csharp
public static TrackerBoosting Create()
```

```csharp
public static TrackerBoosting Create(TrackerBoosting.Params parameters)
```

--------------------------------

### RotationInvariant Property

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.ShapeContextDistanceExtractor.html

Gets or sets the rotation invariance flag.

```csharp
public bool RotationInvariant { get; set; }
```

--------------------------------

### BRISK.Create(int, int, float)

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.XFeatures2D.BRISK.html

Creates a standard BRISK instance with specified threshold, octaves, and pattern scale.

```APIDOC
## static BRISK Create(int thresh = 30, int octaves = 3, float patternScale = 1)

### Description
The BRISK constructor.

### Parameters
- **thresh** (int) - Optional - AGAST detection threshold score.
- **octaves** (int) - Optional - Detection octaves. Use 0 to do single scale.
- **patternScale** (float) - Optional - Apply this scale to the pattern used for sampling the neighbourhood of a keypoint.

### Returns
- **BRISK** - A new instance of the BRISK class.
```

--------------------------------

### OuterRadius Property

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.ShapeContextDistanceExtractor.html

Gets or sets the value of the outer radius.

```csharp
public float OuterRadius { get; set; }
```

--------------------------------

### InnerRadius Property

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.ShapeContextDistanceExtractor.html

Gets or sets the value of the inner radius.

```csharp
public float InnerRadius { get; set; }
```

--------------------------------

### Net()

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.Dnn.Net.html

Initializes a new instance of the Net class.

```APIDOC
## Net()

### Description
Default constructor for the Net class.

### Signature
`public Net()`
```

--------------------------------

### Load Method

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.ANNIndex.html

Loads an index from disk.

```csharp
public void Load(string filename, bool prefault = false)
```

--------------------------------

### operator |(Rect, Rect)

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.Rect.html

Gets the union of two rectangles.

```APIDOC
## operator |(Rect, Rect)

### Description
Gets a Rect structure that contains the union of two Rect structures.

### Signature
`public static Rect operator |(Rect a, Rect b)`

### Parameters
- **a** (Rect) - A rectangle to union.
- **b** (Rect) - A rectangle to union.

### Returns
- **Rect** - The union of the two rectangles.
```

--------------------------------

### Create Method

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.DISOpticalFlow.html

Creates a new instance of DISOpticalFlow with a specified preset.

```csharp
public static DISOpticalFlow Create(DISOpticalFlowPresetTypes preset = DISOpticalFlowPresetTypes.Fast)
```

--------------------------------

### VoxelSize Property

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.Rgbd.LargeKinfuVolumeParams.html

Sets or gets the length of voxels in meters.

```csharp
public float VoxelSize { get; set; }__
```

--------------------------------

### TsdfTruncDist Property

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.Rgbd.LargeKinfuVolumeParams.html

Sets or gets the TSDF truncation distance.

```csharp
public float TsdfTruncDist { get; set; }__
```

--------------------------------

### Create()

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.LineDescriptor.BinaryDescriptorMatcher.html

Creates a new instance of the BinaryDescriptorMatcher.

```APIDOC
## static BinaryDescriptorMatcher Create()

### Description
Creates a binary line descriptor matcher instance.

### Returns
- **BinaryDescriptorMatcher** - A new instance of the matcher.
```

--------------------------------

### Intr Property

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.Rgbd.LargeKinfuParams.html

Gets or sets the camera intrinsics (3x3).

```csharp
public Mat Intr { get; set; }__
```

--------------------------------

### IsOpened()

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.VideoCapture.html

Checks if the video capture device or file has been successfully initialized.

```APIDOC
## bool IsOpened()

### Description
Returns true if video capturing has been initialized already.

### Returns
- **bool** - True if initialized, false otherwise.
```

--------------------------------

### UpdateOpt Method

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.Tracking.Legacy.MultiTrackerTLD.html

Performs an optimized update for multi-object TLD tracking. Requires targets to have similar aspect ratios for optimal performance.

```csharp
public bool UpdateOpt(Mat image)
```

--------------------------------

### FrameSize Property

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.Rgbd.LargeKinfuParams.html

Gets or sets the frame size in pixels.

```csharp
public Size FrameSize { get; set; }__
```

--------------------------------

### Get Deformation Nodes

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.Rgbd.DynaFu.html

Retrieves the positions of the deformation-graph nodes.

```csharp
public virtual Point3f[] GetNodesPos()
```

--------------------------------

### Create KinFu Instance

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.Rgbd.KinFu.html

Initializes a new KinFu instance using the specified parameters.

```csharp
public static KinFu Create(KinFuParams parameters)
```

--------------------------------

### DetectorParameters

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.QRCodeDetectorAruco.html

Gets or sets the detector parameters specific to the QRCodeDetectorAruco.

```APIDOC
## Property: DetectorParameters

### Description
Accesses the specific detector parameters for the QRCodeDetectorAruco instance.

### Type
`QRCodeDetectorArucoParams`
```

--------------------------------

### WeChatQRCode Constructor

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.WeChatQRCode.html

Initializes the detector with optional paths to ONNX model files for detection and super-resolution.

```csharp
public WeChatQRCode(string detectorModelPath = "", string superResolutionModelPath = "")
```

--------------------------------

### Create BRISK with Default Pattern

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.XFeatures2D.BRISK.html

Factory method to create a BRISK instance using default parameters.

```csharp
public static BRISK Create(int thresh = 30, int octaves = 3, float patternScale = 1)
```

--------------------------------

### EndPointInOctave

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.LineDescriptor.KeyLine.html

Gets the end point of the line in the octave it was extracted from.

```APIDOC
## Property: EndPointInOctave

### Description
Returns the end point of the line in the octave it was extracted from.

### Type
Point2f
```

--------------------------------

### EndPoint

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.LineDescriptor.KeyLine.html

Gets the end point of the line in the original image.

```APIDOC
## Property: EndPoint

### Description
Returns the end point of the line in the original image.

### Type
Point2f
```

--------------------------------

### SURF Create Method

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.XFeatures2D.SURF.html

Static factory method to instantiate a SURF object with specific parameters.

```csharp
public static SURF Create(double hessianThreshold, int nOctaves = 4, int nOctaveLayers = 2, bool extended = true, bool upright = false)
```

--------------------------------

### GuidedFilter.Create

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.XImgProc.GuidedFilter.html

Factory method to create an instance of GuidedFilter and initialize it with a guide image, radius, and regularization term.

```APIDOC
## static GuidedFilter Create(InputArray guide, int radius, double eps)

### Description
Factory method, create instance of GuidedFilter and produce initialization routines.

### Parameters
- **guide** (InputArray) - Guided image (or array of images) with up to 3 channels.
- **radius** (int) - Radius of Guided Filter.
- **eps** (double) - Regularization term of Guided Filter.

### Returns
- **GuidedFilter** - An instance of the GuidedFilter class.
```

--------------------------------

### BoostType Property

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.ML.Boost.html

Gets or sets the type of the boosting algorithm.

```csharp
public Boost.Types BoostType { get; set; }
```

--------------------------------

### VectorOfImageFeatures Size Property

Source: https://shimat.github.io/opencvsharp/api/OpenCvSharp.Internal.Vectors.VectorOfImageFeatures.html

Gets the number of elements in the vector.

```csharp
public int Size { get; }
```
Tokens:
Raw