OpenCV  4.2.0-pre
Open Source Computer Vision
Public Member Functions | List of all members
cv::ximgproc::SuperpixelLSC Class Referenceabstract

Class implementing the LSC (Linear Spectral Clustering) superpixels algorithm described in [131]. More...

#include <opencv2/ximgproc/lsc.hpp>

Inheritance diagram for cv::ximgproc::SuperpixelLSC:
cv::Algorithm

Public Member Functions

virtual void enforceLabelConnectivity (int min_element_size=20)=0
 Enforce label connectivity. More...
 
virtual void getLabelContourMask (OutputArray image, bool thick_line=true) const =0
 Returns the mask of the superpixel segmentation stored in SuperpixelLSC object. More...
 
virtual void getLabels (OutputArray labels_out) const =0
 Returns the segmentation labeling of the image. More...
 
virtual int getNumberOfSuperpixels () const =0
 Calculates the actual amount of superpixels on a given segmentation computed and stored in SuperpixelLSC object. More...
 
virtual void iterate (int num_iterations=10)=0
 Calculates the superpixel segmentation on a given image with the initialized parameters in the SuperpixelLSC object. More...
 
- Public Member Functions inherited from cv::Algorithm
 Algorithm ()
 
virtual ~Algorithm ()
 
virtual void clear ()
 Clears the algorithm state. More...
 
virtual bool empty () const
 Returns true if the Algorithm is empty (e.g. in the very beginning or after unsuccessful read. More...
 
virtual String getDefaultName () const
 
virtual void read (const FileNode &fn)
 Reads algorithm parameters from a file storage. More...
 
virtual void save (const String &filename) const
 
virtual void write (FileStorage &fs) const
 Stores algorithm parameters in a file storage. More...
 
void write (const Ptr< FileStorage > &fs, const String &name=String()) const
 simplified API for language bindings This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from cv::Algorithm
template<typename _Tp >
static Ptr< _Tp > load (const String &filename, const String &objname=String())
 Loads algorithm from the file. More...
 
template<typename _Tp >
static Ptr< _Tp > loadFromString (const String &strModel, const String &objname=String())
 Loads algorithm from a String. More...
 
template<typename _Tp >
static Ptr< _Tp > read (const FileNode &fn)
 Reads algorithm from the file node. More...
 
- Protected Member Functions inherited from cv::Algorithm
void writeFormat (FileStorage &fs) const
 

Detailed Description

Class implementing the LSC (Linear Spectral Clustering) superpixels algorithm described in [131].

LSC (Linear Spectral Clustering) produces compact and uniform superpixels with low computational costs. Basically, a normalized cuts formulation of the superpixel segmentation is adopted based on a similarity metric that measures the color similarity and space proximity between image pixels. LSC is of linear computational complexity and high memory efficiency and is able to preserve global properties of images

Member Function Documentation

◆ enforceLabelConnectivity()

virtual void cv::ximgproc::SuperpixelLSC::enforceLabelConnectivity ( int  min_element_size = 20)
pure virtual
Python:
None=cv.ximgproc_SuperpixelLSC.enforceLabelConnectivity([, min_element_size])

Enforce label connectivity.

Parameters
min_element_sizeThe 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.

◆ getLabelContourMask()

virtual void cv::ximgproc::SuperpixelLSC::getLabelContourMask ( OutputArray  image,
bool  thick_line = true 
) const
pure virtual
Python:
image=cv.ximgproc_SuperpixelLSC.getLabelContourMask([, image[, thick_line]])

Returns the mask of the superpixel segmentation stored in SuperpixelLSC object.

Parameters
imageReturn: CV_8U1 image mask where -1 indicates that the pixel is a superpixel border, and 0 otherwise.
thick_lineIf 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.

◆ getLabels()

virtual void cv::ximgproc::SuperpixelLSC::getLabels ( OutputArray  labels_out) const
pure virtual
Python:
labels_out=cv.ximgproc_SuperpixelLSC.getLabels([, labels_out])

Returns the segmentation labeling of the image.

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

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

◆ getNumberOfSuperpixels()

virtual int cv::ximgproc::SuperpixelLSC::getNumberOfSuperpixels ( ) const
pure virtual
Python:
retval=cv.ximgproc_SuperpixelLSC.getNumberOfSuperpixels()

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

◆ iterate()

virtual void cv::ximgproc::SuperpixelLSC::iterate ( int  num_iterations = 10)
pure virtual
Python:
None=cv.ximgproc_SuperpixelLSC.iterate([, num_iterations])

Calculates the superpixel segmentation on a given image with the initialized parameters in the SuperpixelLSC object.

This function can be called again without the need of initializing the algorithm with createSuperpixelLSC(). This save the computational cost of allocating memory for all the structures of the algorithm.

Parameters
num_iterationsNumber of iterations. Higher number improves the result.

The function computes the superpixels segmentation of an image with the parameters initialized with the function createSuperpixelLSC(). The algorithms starts from a grid of superpixels and then refines the boundaries by proposing updates of edges boundaries.


The documentation for this class was generated from the following file: