Sliding window averaging operator with optional weighting support. More...

#include <FastAverageOp.h>

Inheritance diagram for FastAverageOp:

[legend]

Collaboration diagram for FastAverageOp:

[legend]

Public Member Functions
	FastAverageOp (int width=1, int height=0)

	FastAverageOp (const FastAverageOp &op)

void	getDstConf (const ImageConf &src, ImageConf &dst) const
	Forces equal dst image. (Future versions may support different encoding.)

virtual void	traverseChannels (const ImageTray< const Channel > &src, ImageTray< Channel > &dst) const
	Delegates the invocation separately for each channel. More...

virtual void	traverseChannel (const Channel &src, Channel &dst) const
	Main operation, for plain (unweighted) image data. More...

virtual void	traverseChannel (const Channel &src, const Channel &srcWeight, Channel &dst, Channel &dstWeight) const
	Main operation, for weighted image data. More...

Public Member Functions inherited from WindowOp< Window< WindowConfig > >
	WindowOp (const std::string &name=__FUNCTION__, const std::string &description="")

	WindowOp (const std::string &name, const std::string &description, unsigned int width, unsigned int height)

	WindowOp (typename W::conf_t &c, const std::string &name=__FUNCTION__, const std::string &description="")

	WindowOp (const WindowOp< Window< WindowConfig > > &op)

void	setSize (unsigned int width)

void	setSize (unsigned int width, unsigned int height)

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

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. More...

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

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. More...

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

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

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

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

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

Public Member Functions inherited from BeanLike
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 ReferenceMap &	getParameters () const

ReferenceMap &	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". More...

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. More...

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

	BeanLike (const BeanLike &b)

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

Protected Member Functions
virtual bool	processOverlappingWithTemp (const ImageTray< const Channel > &src, ImageTray< Image > &dst) const

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

	ImageOp (const ImageOp &op)

virtual bool	processOverlappingWithTemp (const ImageFrame &src, Image &dst) const

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. More...

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. More...

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 &dst) const
	Set applicable internal parameters before calling traverse().

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 WindowOp< Window< WindowConfig > >
typedef Window< WindowConfig >	window_t

Public Attributes inherited from WindowOp< Window< WindowConfig > >
W::conf_t	conf

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

ReferenceMap	parameters

Detailed Description

Sliding window averaging operator with optional weighting support.

Implemented as two consequent SlidingStripeOp's: horizontal filtering followed by a vertical one.

drainage shapes.png --iAverage 25 -o average.png

drainage shapes.png --iAverage 5:55 -o average-vert.png

If the source image contains several channels, each channel is treated separately.

drainage image.png --iAverage 25 -o average-rgb.png

This operator applies weighted averaging, if a weight image (alpha channel) is provided.

drainage image-rgba.png --iAverage 25 -o average-weighted-rgba.png

drainage spots-rgba.png --iAverage 50 -o spots-avg-rgba.png

drainage spots-rgba-16b.png --iAverage 50 -o spots-avg-rgba-16b.png

drainage graphic-rgba.png          --iAverage 5 -o graphicAvg-rgba.png
drainage graphic-rgba-16b.png -T C --iAverage 5 -o graphicAvg-8b-rgba.png
drainage graphic-rgba-16b.png -T S --iAverage 5 -o graphicAvg-16b-rgba.png

See also: BlenderOp; DistanceTranformFillOp

Member Function Documentation

◆ traverseChannel() [1/2]

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

virtual

Main operation, for plain (unweighted) image data.

Special case

Reimplemented from ImageOp.

◆ traverseChannel() [2/2]

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

virtual

Main operation, for weighted image data.

Calls SlidingStripeOp<T,T2>::process() separately for each image channel. This is natural for many operations, such as averaging.

Special case

Reimplemented from ImageOp.

◆ traverseChannels()

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

inlinevirtual

Delegates the invocation separately for each channel.

If alpha channels are present, delegates to void process(const ImageFrame &src,const ImageFrame &srcWeight, Image &dst,Image &dstWeight) const

Reimplemented from ImageOp.

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

src/drain/imageops/FastAverageOp.h
src/drain/imageops/FastAverageOp.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ traverseChannel() [1/2]

◆ traverseChannel() [2/2]

◆ traverseChannels()