SuperPixel Class Reference

Superpixel image segmentation from OpenCV. More...

#include <jevoisbase/Components/ImageProc/SuperPixel.H>

Inheritance diagram for SuperPixel:

Collaboration diagram for SuperPixel:

Public Member Functions
virtual	~SuperPixel ()
	Virtual destructor for safe inheritance. More...
void	process (cv::Mat const &inimg, cv::Mat &outimg)
	Process an RGB image and get some greyscale results. More...
Public Member Functions inherited from jevois::Component
	Component (std::string const &instance)
virtual	~Component ()
std::shared_ptr< Comp >	addSubComponent (std::string const &instance, Args &&...args)
void	removeSubComponent (std::shared_ptr< Comp > &component)
void	removeSubComponent (std::string const &instance, bool warnIfNotFound=true)
std::shared_ptr< Comp >	getSubComponent (std::string const &instance) const
bool	isTopLevel () const
Engine *	engine () const
bool	initialized () const
const std::string &	className () const
const std::string &	instanceName () const
std::vector< std::string >	setParamVal (std::string const &paramdescriptor, T const &val)
void	setParamValUnique (std::string const &paramdescriptor, T const &val)
std::vector< std::pair< std::string, T > >	getParamVal (std::string const &paramdescriptor) const
T	getParamValUnique (std::string const &paramdescriptor) const
std::vector< std::string >	setParamString (std::string const &paramdescriptor, std::string const &val)
void	setParamStringUnique (std::string const &paramdescriptor, std::string const &val)
std::vector< std::pair< std::string, std::string > >	getParamString (std::string const &paramdescriptor) const
std::string	getParamStringUnique (std::string const &paramdescriptor) const
void	freezeParam (std::string const &paramdescriptor)
void	unFreezeParam (std::string const &paramdescriptor)
void	freezeAllParams ()
void	unFreezeAllParams ()
std::string	descriptor () const
void	setParamsFromFile (std::string const &filename)
std::istream &	setParamsFromStream (std::istream &is, std::string const &absfile)
virtual void	paramInfo (std::shared_ptr< UserInterface > s, std::map< std::string, std::string > &categs, bool skipFrozen, std::string const &cname="", std::string const &pfx="")
void	foreachParam (std::function< void(std::string const &compname, ParameterBase *p)> func, std::string const &cname="")
std::shared_ptr< DynamicParameter< T > >	addDynamicParameter (std::string const &name, std::string const &description, T const &defaultValue, ParameterCategory const &category)
std::shared_ptr< DynamicParameter< T > >	addDynamicParameter (std::string const &name, std::string const &description, T const &defaultValue, ValidValuesSpec< T > const &validValuesSpec, ParameterCategory const &category)
void	setDynamicParameterCallback (std::string const &name, std::function< void(T const &)> cb, bool callnow=true)
void	removeDynamicParameter (std::string const &name)
void	setPath (std::string const &path)
std::filesystem::path	absolutePath (std::filesystem::path const &path="")
std::shared_ptr< Comp >	addSubComponent (std::string const &instance, Args &&...args)
void	removeSubComponent (std::shared_ptr< Comp > &component)
void	removeSubComponent (std::string const &instance, bool warnIfNotFound=true)
std::shared_ptr< Comp >	getSubComponent (std::string const &instance) const
bool	isTopLevel () const
Engine *	engine () const
bool	initialized () const
const std::string &	className () const
const std::string &	instanceName () const
std::vector< std::string >	setParamVal (std::string const &paramdescriptor, T const &val)
void	setParamValUnique (std::string const &paramdescriptor, T const &val)
std::vector< std::pair< std::string, T > >	getParamVal (std::string const &paramdescriptor) const
T	getParamValUnique (std::string const &paramdescriptor) const
std::vector< std::string >	setParamString (std::string const &paramdescriptor, std::string const &val)
void	setParamStringUnique (std::string const &paramdescriptor, std::string const &val)
std::vector< std::pair< std::string, std::string > >	getParamString (std::string const &paramdescriptor) const
std::string	getParamStringUnique (std::string const &paramdescriptor) const
void	freezeParam (std::string const &paramdescriptor)
void	unFreezeParam (std::string const &paramdescriptor)
void	freezeAllParams ()
void	unFreezeAllParams ()
std::string	descriptor () const
void	setParamsFromFile (std::string const &filename)
std::istream &	setParamsFromStream (std::istream &is, std::string const &absfile)
virtual void	paramInfo (std::shared_ptr< UserInterface > s, std::map< std::string, std::string > &categs, bool skipFrozen, std::string const &cname="", std::string const &pfx="")
void	foreachParam (std::function< void(std::string const &compname, ParameterBase *p)> func, std::string const &cname="")
std::shared_ptr< DynamicParameter< T > >	addDynamicParameter (std::string const &name, std::string const &description, T const &defaultValue, ParameterCategory const &category)
std::shared_ptr< DynamicParameter< T > >	addDynamicParameter (std::string const &name, std::string const &description, T const &defaultValue, ValidValuesSpec< T > const &validValuesSpec, ParameterCategory const &category)
void	setDynamicParameterCallback (std::string const &name, std::function< void(T const &)> cb, bool callnow=true)
void	removeDynamicParameter (std::string const &name)
void	setPath (std::string const &path)
std::filesystem::path	absolutePath (std::filesystem::path const &path="")
Public Member Functions inherited from jevois::ParameterRegistry
virtual	~ParameterRegistry ()

Related Functions
(Note that these are not member functions.)
	JEVOIS_DEFINE_ENUM_CLASS (Algo,(SLIC)(SLICO)(SEEDS))
	Enum for parameter. More...
	JEVOIS_DECLARE_PARAMETER (algo, Algo, "Algorithm variant to use", Algo::SLICO, Algo_Values, ParamCateg)
	Parameter. More...
	JEVOIS_DECLARE_PARAMETER (regionsize, int, "SLIC Region size", 30, ParamCateg)
	Parameter. More...
	JEVOIS_DECLARE_PARAMETER (numpix, int, "Number of SEEDS superpixels", 200, ParamCateg)
	Parameter. More...
	JEVOIS_DECLARE_PARAMETER (iterations, int, "Number of iterations", 6, jevois::Range< int >(1, 100), ParamCateg)
	Parameter. More...
	JEVOIS_DEFINE_ENUM_CLASS (OutType,(Labels)(Contours))
	Enum for parameter. More...
	JEVOIS_DECLARE_PARAMETER (output, OutType, "Output labels or demo grayscale input image with superimposed contours", OutType::Contours, OutType_Values, ParamCateg)
	Parameter. More...

Additional Inherited Members
Protected Member Functions inherited from jevois::Component
virtual void	preInit ()
virtual void	postInit ()
virtual void	preUninit ()
virtual void	postUninit ()
virtual void	preInit ()
virtual void	postInit ()
virtual void	preUninit ()
virtual void	postUninit ()
Protected Member Functions inherited from jevois::ParameterRegistry
void	addParameter (ParameterBase *const param)
void	removeParameter (ParameterBase *const param)
void	callbackInitCall ()

Detailed Description

Superpixel image segmentation from OpenCV.

See tutorial at http://docs.opencv.org/3.2.0/df/d6c/group__ximgproc__superpixel.html and http://docs.opencv.org/3.0-beta/modules/ximgproc/doc/superpixels.html

Definition at line 56 of file SuperPixel.H.

Constructor & Destructor Documentation

~SuperPixel()

virtual SuperPixel::~SuperPixel ( )

inlinevirtual

Virtual destructor for safe inheritance.

Definition at line 65 of file SuperPixel.H.

Member Function Documentation

process()

void SuperPixel::process	(	cv::Mat const &	inimg,
		cv::Mat &	outimg
	)

Process an RGB image and get some greyscale results.

outimg should be allocated with same size as the input and CV_8UC1 pixels.

Definition at line 23 of file SuperPixel.C.

References LERROR, LFATAL, and demo::res.

Friends And Related Function Documentation

JEVOIS_DECLARE_PARAMETER() [1/5]

JEVOIS_DECLARE_PARAMETER ( algo  , Algo  , "Algorithm variant to use"  , Algo::SLICO  , Algo_Values  , ParamCateg    )

related

Parameter.

JEVOIS_DECLARE_PARAMETER() [2/5]

JEVOIS_DECLARE_PARAMETER ( iterations  , int  , "Number of iterations"  , 6  , jevois::Range< int >  1, 100, ParamCateg    )

related

Parameter.

JEVOIS_DECLARE_PARAMETER() [3/5]

JEVOIS_DECLARE_PARAMETER ( numpix  , int  , "Number of SEEDS superpixels"  , 200  , ParamCateg    )

related

Parameter.

JEVOIS_DECLARE_PARAMETER() [4/5]

JEVOIS_DECLARE_PARAMETER ( output  , OutType  , "Output labels or demo grayscale input image with superimposed contours"  , OutType::Contours  , OutType_Values  , ParamCateg    )

related

Parameter.

JEVOIS_DECLARE_PARAMETER() [5/5]

JEVOIS_DECLARE_PARAMETER ( regionsize  , int  , "SLIC Region size"  , 30  , ParamCateg    )

related

Parameter.

JEVOIS_DEFINE_ENUM_CLASS() [1/2]

JEVOIS_DEFINE_ENUM_CLASS ( Algo  , (SLIC)(SLICO)(SEEDS)    )

related

Enum for parameter.

JEVOIS_DEFINE_ENUM_CLASS() [2/2]

JEVOIS_DEFINE_ENUM_CLASS ( OutType  , (Labels)(Contours)    )

related

Enum for parameter.

---

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

• include/jevoisbase/Components/ImageProc/SuperPixel.H
• src/Components/ImageProc/SuperPixel.C