Health/Assets/OpenCVForUnity/org/opencv_contrib/ximgproc/SuperpixelSLIC.cs

278 lines
10 KiB
C#

using OpenCVForUnity.CoreModule;
using OpenCVForUnity.UtilsModule;
using System;
using System.Collections.Generic;
using System.Runtime.InteropServices;
namespace OpenCVForUnity.XimgprocModule
{
// C++: class SuperpixelSLIC
/**
* Class implementing the SLIC (Simple Linear Iterative Clustering) superpixels
* algorithm described in CITE: Achanta2012.
*
* SLIC (Simple Linear Iterative Clustering) clusters pixels using pixel channels and image plane space
* to efficiently generate compact, nearly uniform superpixels. The simplicity of approach makes it
* extremely easy to use a lone parameter specifies the number of superpixels and the efficiency of
* the algorithm makes it very practical.
* Several optimizations are available for SLIC class:
* SLICO stands for "Zero parameter SLIC" and it is an optimization of baseline SLIC described in CITE: Achanta2012.
* MSLIC stands for "Manifold SLIC" and it is an optimization of baseline SLIC described in CITE: Liu_2017_IEEE.
*/
public class SuperpixelSLIC : Algorithm
{
protected override void Dispose(bool disposing)
{
try
{
if (disposing)
{
}
if (IsEnabledDispose)
{
if (nativeObj != IntPtr.Zero)
ximgproc_SuperpixelSLIC_delete(nativeObj);
nativeObj = IntPtr.Zero;
}
}
finally
{
base.Dispose(disposing);
}
}
protected internal SuperpixelSLIC(IntPtr addr) : base(addr) { }
// internal usage only
public static new SuperpixelSLIC __fromPtr__(IntPtr addr) { return new SuperpixelSLIC(addr); }
//
// C++: int cv::ximgproc::SuperpixelSLIC::getNumberOfSuperpixels()
//
/**
* Calculates the actual amount of superpixels on a given segmentation computed
* and stored in SuperpixelSLIC object.
* return automatically generated
*/
public int getNumberOfSuperpixels()
{
ThrowIfDisposed();
return ximgproc_SuperpixelSLIC_getNumberOfSuperpixels_10(nativeObj);
}
//
// C++: void cv::ximgproc::SuperpixelSLIC::iterate(int num_iterations = 10)
//
/**
* Calculates the superpixel segmentation on a given image with the initialized
* parameters in the SuperpixelSLIC object.
*
* This function can be called again without the need of initializing the algorithm with
* createSuperpixelSLIC(). This save the computational cost of allocating memory for all the
* structures of the algorithm.
*
* param num_iterations Number of iterations. Higher number improves the result.
*
* The function computes the superpixels segmentation of an image with the parameters initialized
* with the function createSuperpixelSLIC(). The algorithms starts from a grid of superpixels and
* then refines the boundaries by proposing updates of edges boundaries.
*/
public void iterate(int num_iterations)
{
ThrowIfDisposed();
ximgproc_SuperpixelSLIC_iterate_10(nativeObj, num_iterations);
}
/**
* Calculates the superpixel segmentation on a given image with the initialized
* parameters in the SuperpixelSLIC object.
*
* This function can be called again without the need of initializing the algorithm with
* createSuperpixelSLIC(). This save the computational cost of allocating memory for all the
* structures of the algorithm.
*
*
* The function computes the superpixels segmentation of an image with the parameters initialized
* with the function createSuperpixelSLIC(). The algorithms starts from a grid of superpixels and
* then refines the boundaries by proposing updates of edges boundaries.
*/
public void iterate()
{
ThrowIfDisposed();
ximgproc_SuperpixelSLIC_iterate_11(nativeObj);
}
//
// C++: void cv::ximgproc::SuperpixelSLIC::getLabels(Mat& labels_out)
//
/**
* Returns the segmentation labeling of the image.
*
* Each label represents a superpixel, and each pixel is assigned to one superpixel label.
*
* param labels_out Return: A CV_32SC1 integer array containing the labels of the superpixel
* segmentation. The labels are in the range [0, getNumberOfSuperpixels()].
*
* The function returns an image with the labels of the superpixel segmentation. The labels are in
* the range [0, getNumberOfSuperpixels()].
*/
public void getLabels(Mat labels_out)
{
ThrowIfDisposed();
if (labels_out != null) labels_out.ThrowIfDisposed();
ximgproc_SuperpixelSLIC_getLabels_10(nativeObj, labels_out.nativeObj);
}
//
// C++: void cv::ximgproc::SuperpixelSLIC::getLabelContourMask(Mat& image, bool thick_line = true)
//
/**
* Returns the mask of the superpixel segmentation stored in SuperpixelSLIC object.
*
* param image Return: CV_8U1 image mask where -1 indicates that the pixel is a superpixel border,
* and 0 otherwise.
*
* param thick_line If false, the border is only one pixel wide, otherwise all pixels at the border
* are masked.
*
* The function return the boundaries of the superpixel segmentation.
*/
public void getLabelContourMask(Mat image, bool thick_line)
{
ThrowIfDisposed();
if (image != null) image.ThrowIfDisposed();
ximgproc_SuperpixelSLIC_getLabelContourMask_10(nativeObj, image.nativeObj, thick_line);
}
/**
* Returns the mask of the superpixel segmentation stored in SuperpixelSLIC object.
*
* param image Return: CV_8U1 image mask where -1 indicates that the pixel is a superpixel border,
* and 0 otherwise.
*
* are masked.
*
* The function return the boundaries of the superpixel segmentation.
*/
public void getLabelContourMask(Mat image)
{
ThrowIfDisposed();
if (image != null) image.ThrowIfDisposed();
ximgproc_SuperpixelSLIC_getLabelContourMask_11(nativeObj, image.nativeObj);
}
//
// C++: void cv::ximgproc::SuperpixelSLIC::enforceLabelConnectivity(int min_element_size = 25)
//
/**
* Enforce label connectivity.
*
* param min_element_size The minimum element size in percents that should be absorbed into a bigger
* superpixel. Given resulted average superpixel size valid value should be in 0-100 range, 25 means
* that less then a quarter sized superpixel should be absorbed, this is default.
*
* The function merge component that is too small, assigning the previously found adjacent label
* to this component. Calling this function may change the final number of superpixels.
*/
public void enforceLabelConnectivity(int min_element_size)
{
ThrowIfDisposed();
ximgproc_SuperpixelSLIC_enforceLabelConnectivity_10(nativeObj, min_element_size);
}
/**
* Enforce label connectivity.
*
* superpixel. Given resulted average superpixel size valid value should be in 0-100 range, 25 means
* that less then a quarter sized superpixel should be absorbed, this is default.
*
* The function merge component that is too small, assigning the previously found adjacent label
* to this component. Calling this function may change the final number of superpixels.
*/
public void enforceLabelConnectivity()
{
ThrowIfDisposed();
ximgproc_SuperpixelSLIC_enforceLabelConnectivity_11(nativeObj);
}
#if (UNITY_IOS || UNITY_WEBGL) && !UNITY_EDITOR
const string LIBNAME = "__Internal";
#else
const string LIBNAME = "opencvforunity";
#endif
// C++: int cv::ximgproc::SuperpixelSLIC::getNumberOfSuperpixels()
[DllImport(LIBNAME)]
private static extern int ximgproc_SuperpixelSLIC_getNumberOfSuperpixels_10(IntPtr nativeObj);
// C++: void cv::ximgproc::SuperpixelSLIC::iterate(int num_iterations = 10)
[DllImport(LIBNAME)]
private static extern void ximgproc_SuperpixelSLIC_iterate_10(IntPtr nativeObj, int num_iterations);
[DllImport(LIBNAME)]
private static extern void ximgproc_SuperpixelSLIC_iterate_11(IntPtr nativeObj);
// C++: void cv::ximgproc::SuperpixelSLIC::getLabels(Mat& labels_out)
[DllImport(LIBNAME)]
private static extern void ximgproc_SuperpixelSLIC_getLabels_10(IntPtr nativeObj, IntPtr labels_out_nativeObj);
// C++: void cv::ximgproc::SuperpixelSLIC::getLabelContourMask(Mat& image, bool thick_line = true)
[DllImport(LIBNAME)]
private static extern void ximgproc_SuperpixelSLIC_getLabelContourMask_10(IntPtr nativeObj, IntPtr image_nativeObj, [MarshalAs(UnmanagedType.U1)] bool thick_line);
[DllImport(LIBNAME)]
private static extern void ximgproc_SuperpixelSLIC_getLabelContourMask_11(IntPtr nativeObj, IntPtr image_nativeObj);
// C++: void cv::ximgproc::SuperpixelSLIC::enforceLabelConnectivity(int min_element_size = 25)
[DllImport(LIBNAME)]
private static extern void ximgproc_SuperpixelSLIC_enforceLabelConnectivity_10(IntPtr nativeObj, int min_element_size);
[DllImport(LIBNAME)]
private static extern void ximgproc_SuperpixelSLIC_enforceLabelConnectivity_11(IntPtr nativeObj);
// native support for java finalize()
[DllImport(LIBNAME)]
private static extern void ximgproc_SuperpixelSLIC_delete(IntPtr nativeObj);
}
}