A bilateral filter. More...

#include <jevoisbase/Components/Filters/BilateralFilter.H>

Inheritance diagram for BilateralFilter:

[legend]

Collaboration diagram for BilateralFilter:

[legend]

Public Member Functions
virtual	~BilateralFilter ()
	Virtual destructor for safe inheritance.

virtual std::string	process (cv::Mat const &src, cv::Mat &dst) override
	Processing function: filters the image src and puts the results into dst.

Public Member Functions inherited from Filter
virtual	~Filter ()
	Virtual destructor for safe inheritance.

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

bool	initialized () const

std::string const &	className () const

std::string const &	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, bool doit)

void	freezeAllParams (bool doit)

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, bool throw_if_not_found=true)

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

bool	initialized () const

std::string const &	className () const

std::string const &	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, bool doit)

void	freezeAllParams (bool doit)

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, bool throw_if_not_found=true)

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 Symbols
(Note that these are not member symbols.)
	JEVOIS_DECLARE_PARAMETER (d, int, "Diameter of each pixel neighborhood that is used during filtering. " "If it is non-positive, it is computed from sigmaSpace", 0, ParamCateg)
	Parameter.

	JEVOIS_DECLARE_PARAMETER (sigmaColor, double, "Filter sigma in the color space. A larger value of the parameter " "means that farther colors within the pixel neighborhood (see sigmaSpace) will be mixed " "together, resulting in larger areas of semi-equal color. ", 2.0, ParamCateg)
	Parameter.

	JEVOIS_DECLARE_PARAMETER (sigmaSpace, double, "Filter sigma in the coordinate space. A larger value of the parameter " "means that farther pixels will influence each other as long as their colors are close " "enough (see sigmaColor). When d>0, it specifies the neighborhood size regardless of " "sigmaSpace. Otherwise, d is proportional to sigmaSpace.", 2.0, ParamCateg)
	Parameter.

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

A bilateral filter.

See http://docs.opencv.org/3.2.0/d4/d86/group__imgproc__filter.html for details.

Definition at line 48 of file BilateralFilter.H.

Constructor & Destructor Documentation

◆ ~BilateralFilter()

BilateralFilter::~BilateralFilter ( )

virtual

Virtual destructor for safe inheritance.

Definition at line 23 of file BilateralFilter.C.

Member Function Documentation

◆ process()

std::string BilateralFilter::process	(	cv::Mat const &	src,
		cv::Mat &	dst
	)

overridevirtual

Processing function: filters the image src and puts the results into dst.

Implements Filter.

Definition at line 27 of file BilateralFilter.C.

Friends And Related Symbol Documentation

◆ JEVOIS_DECLARE_PARAMETER() [1/3]

JEVOIS_DECLARE_PARAMETER	(	d	,
		int	,
		"Diameter of each pixel neighborhood that is used during filtering. " "If it is non-	positive,
		it is computed from sigmaSpace"	,
		0	,
		ParamCateg
	)

◆ JEVOIS_DECLARE_PARAMETER() [2/3]

JEVOIS_DECLARE_PARAMETER	(	sigmaColor	,
		double	,
		"Filter sigma in the color space. A larger value of the parameter " "means that farther colors within the pixel neighborhood (see sigmaSpace) will be mixed " "	together,
		resulting in larger areas of semi-equal color. "	,
		2.	0,
		ParamCateg
	)

◆ JEVOIS_DECLARE_PARAMETER() [3/3]

JEVOIS_DECLARE_PARAMETER	(	sigmaSpace	,
		double	,
		"Filter sigma in the coordinate space. A larger value of the parameter " "means that farther pixels will influence each other as long as their colors are close " "enough (see sigmaColor). When	d,
		0	,
		it specifies the neighborhood size regardless of " "sigmaSpace.	Otherwise,
		d is proportional to sigmaSpace."	,
		2.	0,
		ParamCateg
	)

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

include/jevoisbase/Components/Filters/BilateralFilter.H
src/Components/Filters/BilateralFilter.C

Public Member Functions

Related Symbols

Additional Inherited Members