Class for using simple function objects (like std::functor) for sequential pixel iteration. More...

#include <FunctorOp.h>

Inheritance diagram for UnaryFunctorOp< F, NORM, SIGN >:

[legend]

Collaboration diagram for UnaryFunctorOp< F, NORM, SIGN >:

[legend]

Public Member Functions
	UnaryFunctorOp (bool adaptParams=true, bool adoptLimit=true)

	UnaryFunctorOp (const UnaryFunctorOp< F > &op)

void	traverseChannels (const ImageTray< const Channel > &src, ImageTray< Channel > &dst) const

void	traverseChannel (const Channel &src, Channel &dst) const
	Process the image.

Public Member Functions inherited from FunctorOp< F >
	FunctorOp (const FunctorOp &op)

void	adaptParameters (bool adaptLimit=false)

Public Member Functions inherited from FunctorWrapper< F >
	FunctorWrapper (const FunctorWrapper< F > &wrapper)

Public Member Functions inherited from ImageOp
virtual void	process (const ImageFrame &src, Image &dst) const
	Main interface. Typically splits processing to each channel.

virtual void	process (Image &dst) const override final
	Run this modifier for an image.

virtual void	process (const ImageFrame &src, const ImageFrame &srcWeight, Image &dst, Image &dstWeight) const

virtual void	process (const ImageTray< const Channel > &src, ImageTray< Image > &dst, bool checkOverlap=true) const
	Run the operator on a series of images. Geometry and type may be changed. UNDER CONSTR.

virtual void	traverseChannel (const Channel &src, const Channel &srcAlpha, Channel &dst, Channel &dstAlpha) const
	Apply to single channel with alpha.

virtual void	makeCompatible (const ImageConf &src, Image &dst) const
	Depending on the operator, modifies the geometry and type of dst.

virtual void	makeCompatible2 (const ImageFrame &src1, const ImageFrame &src2, Image &dst) const
	Modifies the geometry and type of dst to fit the computation result.

virtual void	help (std::ostream &ostr=std::cout) const
	Prints name, description and parameters using BeanLike::toOStr(). Virtual, so derived classes may extend output.

Public Member Functions inherited from ImageMod
virtual int	srcAlpha () const
	Tell if alpha channel(s) is required in input.

virtual void	traverseChannels (ImageTray< Channel > &dst) const
	Run this modifier for a set of channels.

virtual void	traverseChannel (Channel &dst) const
	Run this modifier for an image frame.

virtual void	traverseChannel (Channel &dst, Channel &dstAlpha) const
	Run this modifier for an image frame.

virtual void	traverseChannels (ImageFrame &dst) const
	Converts dst to ImageTray<Channel> and calls traverseFrame(ImageTray<Channel> &) .

Public Member Functions inherited from BeanLike
	BeanLike (const BeanLike &b)

	BeanLike (const std::string &name, const std::string &description="")

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

template<class F >
F	getParameter (const std::string &p) const
	Gets a single parameter.

const map_t &	getParameters () const

map_t &	getParameters ()

template<class F >
void	setParametersFromEntries (const F &args)

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)

virtual std::ostream &	toStream (std::ostream &ostr, bool compact=true) const

Protected Member Functions
void	getDstConf (const ImageConf &src, ImageConf &dst) const
	Given source image, determine respective dest image configuration.

virtual void	initializeParameters (const ImageFrame &src, const ImageFrame &dst) const
	Set applicable internal parameters before calling traverse().

Protected Member Functions inherited from FunctorOp< F >
virtual bool	processOverlappingWithTemp (const ImageFrame &srcFrame, Image &dstImage) const

bool	processOverlappingWithTemp (const ImageTray< const Channel > &src, ImageTray< Image > &dst) const

	FunctorOp (bool adaptParams=false, bool adoptLimit=false)

Protected Member Functions inherited from ImageOp
	ImageOp (const std::string &name=__FUNCTION__, const std::string &description="")

	ImageOp (const ImageOp &op)

bool	traverseOverlappingWithTemp (const Channel &src, Channel &dst) const

bool	traverseOverlappingWithTemp (const Channel &src, const Channel &srcWeight, Channel &dst, Channel &dstWeight) const

void	traverseChannelsEqually (const ImageTray< const Channel > &src, ImageTray< Channel > &dst) const
	Calls processWithTemp() if the frames overlap.

void	traverseChannelsRepeated (const ImageTray< const Channel > &src, ImageTray< Channel > &dst) const
	Recycle channels until all dst channels completed.

void	traverseChannelsSeparately (const ImageTray< const Channel > &src, ImageTray< Channel > &dst) const
	Process each (src,dst) channel pair independently. Raise error if their counts differ.

void	traverseAsChannelTrays (const ImageFrame &src, ImageFrame &dst) const
	Redirect to processing as trays. This is the opposite of processChannels...() functions.

void	traverseAsChannelTrays (const ImageFrame &src, const ImageFrame &srcWeight, ImageFrame &dst, ImageFrame &dstWeight) const
	Redirect to processing as trays. This is the opposite of processChannels...() functions.

virtual void	initializeParameters (const ImageFrame &src, const ImageFrame &src2, const ImageFrame &dst) const
	Set applicable internal parameters before calling traverse().

Protected Member Functions inherited from ImageMod
	ImageMod (const std::string &name=__FUNCTION__, const std::string &description="")

	ImageMod (const ImageMod &op)

virtual void	processChannelsSeparately (ImageTray< Channel > &dst) const
	Run this modifier by calling traverseChannel(Channel &) for each image.

virtual void	initialize (Image &dst) const
	Modifies the geometry and the type of dst such that traverseChannel(Channel &) can be called.

virtual void	initializeAlpha (const Image &srcAlpha, Image &dstAlpha) const
	Modifies the geometry and the type of dst such that traverseChannel(Channel &) can be called.

Protected Member Functions inherited from BeanLike
virtual void	storeLastArguments (const std::string &p)
	Called after setParameters()

virtual void	updateBean () const
	Called after setParameters()

Additional Inherited Members
Public Types inherited from BeanLike
typedef ReferenceMap	map_t

Public Attributes inherited from FunctorOp< F >
bool	LIMIT

Public Attributes inherited from FunctorWrapper< F >
F	functor

Public Attributes inherited from ImageMod
bool	physicalScale

Static Protected Member Functions inherited from ImageOp
static void	adaptCoordinateHandler (const Channel &src, CoordinateHandler2D &handler)

Protected Attributes inherited from BeanLike
const std::string	name

const std::string	description

map_t	parameters

Detailed Description

template<class F, bool NORM = false, bool SIGN = false>
class drain::image::UnaryFunctorOp< F, NORM, SIGN >

Class for using simple function objects (like std::functor) for sequential pixel iteration.

! \template F - unary (single-parameter) functor \template NORM - normalize to 0...1 (unsigned) and -1...1 (signed) \template SIGN - select signed, else unsigned

Constructor & Destructor Documentation

◆ UnaryFunctorOp()

template<class F , bool NORM = false, bool SIGN = false>

UnaryFunctorOp	(	bool	adaptParams = `true`,
		bool	adoptLimit = `true`
	)

inline

Parameters

adaptParameters	- add all the parameters of the functors to this op's parameters
adaptLimit	- add LIMIT option to visible parameters

Member Function Documentation

◆ getDstConf()

template<class F , bool NORM = false, bool SIGN = false>

void getDstConf	(	const ImageConf &	src,
		ImageConf &	dst
	)		const

inlineprotectedvirtual

Given source image, determine respective dest image configuration.

This default implementations

changes type and scaling only if either is undefined in dst.
copies geometry and coordinate policy of src.

Reimplemented from ImageOp.

◆ initializeParameters()

template<class F , bool NORM = false, bool SIGN = false>

virtual void initializeParameters	(	const ImageFrame &	src,
		const ImageFrame &	dst
	)		const

inlineprotectedvirtual

Set applicable internal parameters before calling traverse().

Reimplemented from ImageOp.

◆ traverseChannel()

template<class T , bool NORM, bool SIGN>

void traverseChannel	(	const Channel &	src,
		Channel &	dst
	)		const

virtual

Process the image.

In future versions there may dedicated processing for integral and floatimg-point base types. (If some of images are double, then

Unlimited, unscaled, ie. "direct". This option may be sufficient if dst is double, for example.

Reimplemented from ImageOp.

◆ traverseChannels()

template<class F , bool NORM = false, bool SIGN = false>

void traverseChannels	(	const ImageTray< const Channel > &	src,
		ImageTray< Channel > &	dst
	)		const

inlinevirtual

Reimplemented from ImageOp.

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

src/drain/imageops/FunctorOp.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ UnaryFunctorOp()

Member Function Documentation

◆ getDstConf()

◆ initializeParameters()

◆ traverseChannel()

◆ traverseChannels()