FuzzyTwinPeaks< T > Class Template Reference

A function taking shape of two peaks, with a zero in the middle . More...

#include <Fuzzy.h>

Inheritance diagram for FuzzyTwinPeaks< T >:

Collaboration diagram for FuzzyTwinPeaks< T >:

Public Member Functions
	FuzzyTwinPeaks (double location=0.0, double width=1.0, double scale=1.0, double bias=0.0)
	FuzzyTwinPeaks (const FuzzyTwinPeaks &f)
void	set (double location=0.0, double width=1.0, double scale=1.0, double bias=0.0)
virtual void	updateBean () const override
	Called after setParameters()
virtual double	operator() (double x) const
Public Member Functions inherited from Fuzzifier< T >
	Fuzzifier (const std::string &name, const std::string &description="", double scale=1.0, double bias=0.0)
bool	isInversed ()
	Updates internal variables. Should be called after modifying public members.
Public Member Functions inherited from UnaryFunctor
	UnaryFunctor (const std::string &name, const std::string &description="", double scale=1.0, double bias=0.0)
Public Member Functions inherited from Functor
void	setScale (double scale, double bias=0.0)
Public Member Functions inherited from BeanLike
	BeanLike (const BeanLike &b)
	Copy constructor. Re-links parameters to the member variables of this (new) instance.
	BeanLike (const std::string &name, const std::string &description="")
	Constructor.
virtual const std::string &	getName () const
	Return the name of an instance.
virtual const std::string &	getDescription () const
	Return a brief description.
bool	hasParameters () const
	Tells if any parameters have been linked (registered) for this bean.
template<class F >
F	getParameter (const std::string &p) const
	Gets a single parameter.
const map_t &	getParameters () const
	Returns the parameter map (const access).
map_t &	getParameters ()
	Returns the parameter map.
template<class F >
void	setParametersFromEntries (const F &args)
	Sets several parameters at once from a sequence of key-value pairs.
void	setParameters (std::initializer_list< Variable::init_pair_t > args)
	Grants access to (if above hidden)
virtual void	setParameters (const std::string &p, char assignmentSymbol='=', char separatorSymbol=0)
	Sets comma-separated parameters in a predetermined order "a,b,c" or by specifing them "b=2".
template<class T >
void	setParameters (const std::map< std::string, T > &args)
	Set parameters.
template<class T >
void	setParameters (const SmartMap< T > &args)
	Set parameters.
void	setParameter (const std::string &p, const Castable &value)
	Sets a single parameter.
template<class T >
void	setParameter (const std::string &p, const VariableT< T > &value)
template<class F >
void	setParameter (const std::string &p, const F &value)
	Sets a single parameter.
template<class F >
void	setParameter (const std::string &p, std::initializer_list< F > value)
	Sets a single parameter.
BeanLike &	operator= (const BeanLike &b)
	Assigns the parameter values of another bean (by key) to this one's own parameters.
virtual std::ostream &	toStream (std::ostream &ostr, bool compact=true) const
	Prints the name, description and current parameter values.

Public Attributes
double	location = 0.0
double	width = 1.0

Protected Member Functions
virtual void	updateScale () const
Protected Member Functions inherited from Functor
	Functor (const std::string &name, const std::string &description="", double scale=1.0, double bias=0.0)
	Functor (const Functor &fct)
Protected Member Functions inherited from BeanLike
virtual void	storeLastArguments (const std::string &p)
	Called after setParameters()

Protected Attributes
double	steepness = 1.0
Protected Attributes inherited from Fuzzifier< T >
bool	INVERSE
Protected Attributes inherited from Functor
double	scale
	Relative scale, typically 1. Optional.
double	bias
	"Relative" bias, typically 0. Optional.
double	scaleFinal
	Scaling factor after encodings of src and dst images are known.
double	biasFinal
	Scaling factor after encodings of src and dst images are known.
Protected Attributes inherited from BeanLike
const std::string	name
	Name of this bean, typically also the name of the (derived) class.
const std::string	description
	Brief, human-readable description of this bean.
map_t	parameters
	Parameters (name -> linked variable), typically linked to member variables of the derived class.

Additional Inherited Members
Public Types inherited from BeanLike
typedef ReferenceMap	map_t
	Reference map type used to store this bean's parameters (name -> linked variable).

Detailed Description

template<class T>
class drain::FuzzyTwinPeaks< T >

A function taking shape of two peaks, with a zero in the middle .

Template Parameters

T	- input storage type
T2	- output storage type

Fuzzy 'twin peaks'.

Constructor & Destructor Documentation

FuzzyTwinPeaks()

template<class T >

FuzzyTwinPeaks ( double  location = 0.0, double  width = 1.0, double  scale = 1.0, double  bias = 0.0  )

inline

TODO: use range instead

Member Function Documentation

operator()()

template<class T >

virtual double operator() ( double  x ) const

inlinevirtual

Implements UnaryFunctor.

updateBean()

template<class T >

virtual void updateBean ( ) const

inlineoverridevirtual

Called after setParameters()

Reimplemented from Functor.

updateScale()

template<class T >

virtual void updateScale ( ) const

inlineprotectedvirtual

Reimplemented from Fuzzifier< T >.

---

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

• src/drain/util/Fuzzy.h