org.bytedeco.opencv.opencv_ximgproc

Class SuperpixelSLIC

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.opencv.opencv_core.Algorithm

org.bytedeco.opencv.opencv_ximgproc.SuperpixelSLIC

All Implemented Interfaces:

AutoCloseable

@Namespace(value="cv::ximgproc")
 @Properties(inherit=opencv_ximgproc.class)
public class SuperpixelSLIC
extends Algorithm

\brief 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.

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
SuperpixelSLIC(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
void	enforceLabelConnectivity()
void	enforceLabelConnectivity(int min_element_size) \brief Enforce label connectivity.
void	getLabelContourMask(GpuMat image)
void	getLabelContourMask(GpuMat image, boolean thick_line)
void	getLabelContourMask(Mat image)
void	getLabelContourMask(Mat image, boolean thick_line) \brief Returns the mask of the superpixel segmentation stored in SuperpixelSLIC object.
void	getLabelContourMask(UMat image)
void	getLabelContourMask(UMat image, boolean thick_line)
void	getLabels(GpuMat labels_out)
void	getLabels(Mat labels_out) \brief Returns the segmentation labeling of the image.
void	getLabels(UMat labels_out)
int	getNumberOfSuperpixels() \brief Calculates the actual amount of superpixels on a given segmentation computed and stored in SuperpixelSLIC object.
void	iterate()
void	iterate(int num_iterations) \brief Calculates the superpixel segmentation on a given image with the initialized parameters in the SuperpixelSLIC object.

Methods inherited from class org.bytedeco.opencv.opencv_core.Algorithm

clear, empty, getDefaultName, position, read, save, save, write, write, write

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, hashCode, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetof, parseBytes, physicalBytes, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, toString, totalBytes, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SuperpixelSLIC

public SuperpixelSLIC(Pointer p)

Pointer cast constructor. Invokes Pointer.Pointer(Pointer).

Method Detail

getNumberOfSuperpixels

public int getNumberOfSuperpixels()

\brief Calculates the actual amount of superpixels on a given segmentation computed and stored in SuperpixelSLIC object.

iterate

public void iterate(int num_iterations)

\brief 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.

Parameters:

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.

iterate

public void iterate()

getLabels

public void getLabels(@ByVal
                      Mat labels_out)

\brief Returns the segmentation labeling of the image.

Each label represents a superpixel, and each pixel is assigned to one superpixel label.

Parameters:

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()].

getLabels

public void getLabels(@ByVal
                      UMat labels_out)

getLabels

public void getLabels(@ByVal
                      GpuMat labels_out)

getLabelContourMask

public void getLabelContourMask(@ByVal
                                Mat image,
                                @Cast(value="bool")
                                boolean thick_line)

\brief Returns the mask of the superpixel segmentation stored in SuperpixelSLIC object.

Parameters:

image - Return: CV_8U1 image mask where -1 indicates that the pixel is a superpixel border, and 0 otherwise.

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.

getLabelContourMask

public void getLabelContourMask(@ByVal
                                Mat image)

getLabelContourMask

public void getLabelContourMask(@ByVal
                                UMat image,
                                @Cast(value="bool")
                                boolean thick_line)

getLabelContourMask

public void getLabelContourMask(@ByVal
                                UMat image)

getLabelContourMask

public void getLabelContourMask(@ByVal
                                GpuMat image,
                                @Cast(value="bool")
                                boolean thick_line)

getLabelContourMask

public void getLabelContourMask(@ByVal
                                GpuMat image)

enforceLabelConnectivity

public void enforceLabelConnectivity(int min_element_size)

\brief Enforce label connectivity.

Parameters:

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.

enforceLabelConnectivity

public void enforceLabelConnectivity()