Class for Wiener Filter . More...

#include <WienerOp.h>

Inheritance diagram for icl::filter::WienerOp:

Public Member Functions
	WienerOp (const utils::Size &maskSize, icl32f noise=0)
	Constructor that creates a wiener filter object, with specified mask size. More...

ICLFilter_API void	apply (const core::ImgBase poSrc, core::ImgBase *ppoDst)
	Filters an image using the Wiener algorithm. More...

icl32f	getNoise () const
	returns the current noise factor More...

void	setNoise (icl32f noise)
	sets up a new noise factor More...

virtual void	apply (const core::ImgBase operand1, core::ImgBase *dst)=0
	Import unaryOps apply function without destination image. More...

virtual const core::ImgBase *	apply (const core::ImgBase *src)
	Import unaryOps apply function without destination image. More...

Public Member Functions inherited from icl::filter::NeighborhoodOp
virtual	~NeighborhoodOp ()
	Destructor. More...

bool	computeROI (const core::ImgBase *poSrc, utils::Point &oROIoffset, utils::Size &oROIsize)
	compute neccessary ROI offset and size More...

virtual void	applyMT (const core::ImgBase operand1, core::ImgBase *dst, unsigned int nThreads)
	NEW apply function for multithreaded filtering (reimplemented here for special roi handling!) More...

const utils::Size &	getMaskSize () const

const utils::Point &	getAnchor () const

const utils::Point &	getROIOffset () const

virtual void	apply (const core::ImgBase operand1, core::ImgBase *dst)=0
	Import unaryOps apply function without destination image. More...

virtual const core::ImgBase *	apply (const core::ImgBase *src)
	Import unaryOps apply function without destination image. More...

Public Member Functions inherited from icl::filter::UnaryOp
	UnaryOp ()
	Explicit empty constructor. More...

	UnaryOp (const UnaryOp &other)
	Explicit copy constructor. More...

UnaryOp &	operator= (const UnaryOp &other)
	Explicit declaration of the assignment operator. More...

virtual	~UnaryOp ()
	Destructor. More...

virtual const core::ImgBase *	apply (const core::ImgBase *src)
	applys the filter usign an internal buffer as output image More...

void	operator() (const core::ImgBase src, core::ImgBase *dst)
	function operator (alternative for apply(src,dst) More...

const core::ImgBase *	operator() (const core::ImgBase *src)
	function operator for the implicit destination apply(src) call More...

const core::ImgBase &	operator() (const core::ImgBase &src)
	reference based function operator More...

void	setClipToROI (bool bClipToROI)
	sets if the image should be clip to ROI or not More...

void	setCheckOnly (bool bCheckOnly)
	sets if the destination image should be adapted to the source, or if it is only checked if it can be adapted. More...

bool	getClipToROI () const
	returns the ClipToROI status More...

bool	getCheckOnly () const
	returns the CheckOnly status More...

virtual void	setPropertyValue (const std::string &propertyName, const utils::Any &value)
	sets value of a property (always call call_callbacks(propertyName) or Configurable::setPropertyValue) More...

Public Member Functions inherited from icl::utils::Configurable
virtual	~Configurable ()
	virtual destructor More...

	Configurable (const Configurable &other)
	Copy constructor. More...

Configurable &	operator= (const Configurable &other)
	Assignment operator. More...

void	setConfigurableID (const std::string &ID)
	sets the ID of this configurable More...

const std::string &	getConfigurableID () const
	returns the configurables static ID More...

bool	isOrderedFlagSet () const
	returns whether the ordered flag is set More...

void	deactivateProperty (const std::string &pattern)
	adds an additional deativation pattern More...

void	deleteDeactivationPattern (const std::string &pattern)
	removed a formerly added deactivation pattern More...

std::vector< std::string >	getPropertyListWithoutDeactivated () const
	this returns a filtered list of properties (using all filters added by deactivateProperty) More...

virtual void	adaptProperty (const std::string &name, const std::string &newType, const std::string &newInfo, const std::string &newToolTip)
	this function can be used to adapt a specific property afterwards More...

void	registerCallback (const Callback &cb)
	add a callback for changed properties More...

void	removedCallback (const Callback &cb)
	removes a callback that was registered before More...

void	syncChangesTo (Configurable *others, int num=1)
	this can be used to let this instance also apply property changes to others More...

virtual std::vector< std::string >	getPropertyList () const
	returns a list of All properties, that can be set using setProperty More...

virtual bool	supportsProperty (const std::string &propertyName) const
	base implementation for property check (seaches in the property list) More...

virtual void	saveProperties (const std::string &filename, const std::vector< std::string > &propertiesToSkip=EMPTY_VEC) const
	writes all available properties into a file More...

virtual void	loadProperties (const std::string &filename, const std::vector< std::string > &propertiesToSkip=EMPTY_VEC)
	reads a camera config file from disc More...

virtual std::string	getPropertyType (const std::string &propertyName) const
	get type of property More...

virtual std::string	getPropertyInfo (const std::string &propertyName) const
	get information of a properties valid values More...

virtual Any	getPropertyValue (const std::string &propertyName) const
	returns the current value of a property or a parameter More...

virtual std::string	getPropertyToolTip (const std::string &propertyName) const
	returns the tooltip description for a given property More...

virtual int	getPropertyVolatileness (const std::string &propertyName) const
	Returns whether this property may be changed internally. More...

Private Attributes
std::vector< icl8u >	m_vecBuffer
	internal buffer for applying the wiener operation More...

icl32f	m_fNoise
	internal storage for the current noise factor More...

Additional Inherited Members
Public Types inherited from icl::utils::Configurable
typedef Function< void, const Property & >	Callback
	Function type for changed properties. More...

Static Public Member Functions inherited from icl::filter::UnaryOp
static UnaryOp *	fromString (const std::string &definition)
	Creates a UnaryOp instance from given string definition. More...

static std::string	getFromStringSyntax (const std::string &opSpecifier)
	gives a string syntax description for given opSpecifier More...

static std::vector< std::string >	listFromStringOps ()
	returns a list of all supported OP_SPEC values for the fromString function More...

static void	applyFromString (const std::string &definition, const core::ImgBase src, core::ImgBase *dst)
	creates, applies and releases a UnaryOp defined by given definition string More...

Static Public Member Functions inherited from icl::utils::Configurable
static std::string	create_default_ID (const std::string &prefix)
	this function can be used in subclasses to create a default ID More...

static Configurable *	get (const std::string &id)
	returns configurable by given ID More...

static void	register_configurable_type (const std::string &classname, Function< Configurable * > creator)
	registers a configurable type More...

static std::vector< std::string >	get_registered_configurables ()
	returns a list of all registered configurable classnames More...

static Configurable *	create_configurable (const std::string &classname)
	creates a configurable by given name More...

Static Public Attributes inherited from icl::utils::Configurable
static const std::vector< std::string >	EMPTY_VEC
	used as shortcut – just an empty vector of std::strings More...

Protected Member Functions inherited from icl::filter::NeighborhoodOp
	NeighborhoodOp ()

	NeighborhoodOp (const utils::Size &size)

void	setMask (const utils::Size &size)

void	setMask (const utils::Size &size, const utils::Point &anchor)

void	setROIOffset (const utils::Point &offs)

virtual bool	prepare (core::ImgBase *ppoDst, const core::ImgBase poSrc)
	prepare filter operation: ensure compatible image format and size More...

virtual bool	prepare (core::ImgBase *ppoDst, const core::ImgBase poSrc, core::depth eDepht)
	prepare filter operation: as above, but with depth parameter More...

virtual utils::Size	adaptSize (const utils::Size &size)
	this function can be reimplemented e.g to enshure an odd mask width and height More...

Protected Member Functions inherited from icl::filter::UnaryOp
bool	prepare (core::ImgBase **ppoDst, core::depth eDepth, const utils::Size &imgSize, core::format eFormat, int nChannels, const utils::Rect &roi, utils::Time timestamp=utils::Time::null)

Protected Member Functions inherited from icl::utils::Configurable
void	addProperty (const std::string &name, const std::string &type, const std::string &info, const Any &value=Any(), const int volatileness=0, const std::string &tooltip=std::string())
	This can be used by derived classes to store supported properties in the internal list. More...

void	addChildConfigurable (Configurable *configurable, const std::string &childPrefix="")
	This adds another configurable as child. More...

void	removeChildConfigurable (Configurable *configurable)
	removes the given child configurable More...

Property &	prop (const std::string &propertyName)
	this CAN be used e.g. to store a property value in internal property-list More...

const Property &	prop (const std::string &propertyName) const
	this CAN be used e.g. to store a property value in internal property-list More...

	Configurable (const std::string &ID="", bool ordered=true)
	create this configurable with given ID More...

void	call_callbacks (const std::string &propertyName, const Configurable *caller) const
	calls all registered callbacks More...

Protected Attributes inherited from icl::filter::NeighborhoodOp
utils::Size	m_oMaskSize
	TODO: later private with getter and setter functions. More...

utils::Point	m_oAnchor
	anchor of filter mask More...

utils::Point	m_oROIOffset
	to-be-used ROI offset for source image More...

Protected Attributes inherited from icl::filter::UnaryOp
utils::MultiThreader *	m_poMT

Protected Attributes inherited from icl::utils::Configurable
std::vector< Callback >	callbacks
	internally managed list of callbacks More...

Detailed Description

Class for Wiener Filter .

Wiener filters are commonly used in image processing applications to remove additive noise from degraded images, to restore a blurred image.

The following operation is performed on each pixel:

$R(x,y,c) = \mu_m(x,y,c) + \frac{\sigma_m^2(x,y,c)-\nu^2}{\sigma^2} * (S(x,y,c) - \mu_m(x,y,c))$

where:

is the result image at position (x,y) and channel c
$\mu_m(x,y,c)$ is the mean of the image in region m (mask) centered at (x,y), channel c
$\sigma^2_m(x,y,c)$ is the variance of the image in region m (mask) centered at (x,y), channel c
$\sigma^2$ is the image variance
is the source image at position (x,y) and channel c

Constructor & Destructor Documentation

◆ WienerOp()

icl::filter::WienerOp::WienerOp	(	const utils::Size &	maskSize,
		icl32f	noise = `0`
	)

inline

Constructor that creates a wiener filter object, with specified mask size.

Parameters

maskSize	of odd width and height Even width or height is increased to next higher odd value.
noise	nois factor

Member Function Documentation

◆ apply() [1/3]

ICLFilter_API void icl::filter::WienerOp::apply	(	const core::ImgBase *	poSrc,
		core::ImgBase **	ppoDst
	)

virtual

Filters an image using the Wiener algorithm.

Parameters

poSrc	Source image
ppoDst	Destination image

Implements icl::filter::UnaryOp.

◆ apply() [2/3]

virtual const core::ImgBase* icl::filter::UnaryOp::apply

Import unaryOps apply function without destination image.

◆ apply() [3/3]

virtual void icl::filter::UnaryOp::apply

Import unaryOps apply function without destination image.

◆ getNoise()

icl32f icl::filter::WienerOp::getNoise ( ) const

inline

returns the current noise factor

Returns: current noise factor

◆ setNoise()

void icl::filter::WienerOp::setNoise ( icl32f noise )

inline

sets up a new noise factor

@ param noise new noise factor

Member Data Documentation

◆ m_fNoise

icl32f icl::filter::WienerOp::m_fNoise

private

internal storage for the current noise factor

◆ m_vecBuffer

std::vector<icl8u> icl::filter::WienerOp::m_vecBuffer

private

internal buffer for applying the wiener operation

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

/Users/alneuman/vm/icl/ICLFilter/src/ICLFilter/WienerOp.h

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ WienerOp()

Member Function Documentation

◆ apply() [1/3]

◆ apply() [2/3]

◆ apply() [3/3]

◆ getNoise()

◆ setNoise()

Member Data Documentation

◆ m_fNoise

◆ m_vecBuffer