Window average that preserves the magnitude. More...

#include <FlowAverageWindowOp.h>

Inheritance diagram for FlowAverageWindow:

[legend]

Collaboration diagram for FlowAverageWindow:

[legend]

Public Types
typedef FlowAverageWindow	unweighted

Public Types inherited from Window< C, R >
typedef C	conf_t

Public Member Functions
	FlowAverageWindow (int width=5, int height=0)

	FlowAverageWindow (const WindowConfig &conf)

Public Member Functions inherited from SlidingWindow< WindowConfig, MultiChannelWindowCore >
	SlidingWindow (int width=0, int height=0, bool horzMultiple=true, bool vertMultiple=true)

	SlidingWindow (const WindowConfig &conf, bool horzMultiple=true, bool vertMultiple=true)

void	setSlidingMode (bool horzMultiple, bool vertMultiple)

void	run ()
	Sets coord handler, calls initialise, sets pos(0,0), fills, writes and slides. More...

void	runHorz ()
	Sets coord handler, calls initialise, sets pos(0,0), fills, writes and slides. More...

void	runVert ()
	Sets coord handler, calls initialise, sets pos(0,0), fills, writes and slides. More...

virtual void	debug ()

const std::string &	getModeStr ()

Public Member Functions inherited from Window< C, R >
	Window (size_t width=1, size_t height=0)
	Constructor with geometry setting option.

	Window (const C &conf)
	Constructor adapting given configuration.

	Window (const Window &window)

virtual	~Window ()
	Destructor.

virtual void	setSize (size_t width, size_t height)
	Sets the window size.

size_t	getArea ()
	Returns the nominal area in pixels.

size_t	getSamplingArea ()
	Returns the area which has eventually been scaled (in a non-linear coordinate system)

virtual void	toStream (std::ostream &ostr) const

Public Member Functions inherited from WindowCore
virtual void	setSrcFrames (const ImageTray< const Channel > &srcTray)

virtual void	setDstFrames (ImageTray< Channel > &dstTray)

virtual void	setSrcFrameWeight (const ImageFrame &srcW)

virtual void	setDstFrameWeight (ImageFrame &dstW)

Public Member Functions inherited from WindowCoreBase
virtual void	setSrcFrame (const ImageFrame &src)

virtual void	setDstFrame (ImageFrame &dst)

Protected Member Functions
void	initialize ()
	Sets class-specific initial values. Does not change general window state (e.g. location). Should not accumulate any statistics. More...

void	clear ()
	Clears statistics.

void	setImageLimits () const
	Sets internal limits corresponding to image geometries. Typically using coordHandler. More...

virtual void	removePixel (Point2D< int > &p)
	Removes a pixel from window statistics. Unvalidated location. More...

virtual void	addPixel (Point2D< int > &p)
	Adds a pixel to window statistics. Unvalidated location. More...

virtual void	write ()
	Write the result in the target image. More...

Protected Member Functions inherited from SlidingWindow< WindowConfig, MultiChannelWindowCore >
virtual bool	reset ()
	Returns false, if traversal should be ended.

void	slideHorz ()
	High-level functionality of a sliding window. FINAL.

void	slideVert ()
	High-level functionality of a sliding window. FINAL.

bool	moveDown ()
	Moves one pixel down. Stops at the edge, and returns false. More...

bool	moveUp ()
	Moves one pixel up. Stops at the edge, and returns false. More...

bool	moveRight ()
	Moves one pixel right. Stops at the edge, and returns false. More...

bool	moveLeft ()
	Moves one pixel left. Stops at the edge, and returns false. More...

virtual void	fillBoth ()
	Clears and computes the statistics for the current location. More...

void	fillHorz ()
	Clears and computes the statistics for the current location. FINAL. More...

void	fillVert ()
	Clears and computes the statistics for the current location. FINAL. More...

void	updateHorzMultiple ()
	In moving horizontally, updates the window centered at current location. Calls removePixel() and addPixel().

void	updateHorzSingle ()

void	updateVertMultiple ()
	In moving vertically, updates the window centered at current location. Calls removePixel() and addPixel().

void	updateVertSingle ()
	For 1 x n sized windows.

Protected Member Functions inherited from Window< C, R >
virtual bool	isHorizontal () const
	Tells if the window should be moved (traversed of slided) row-by-row (horizontally) or column-by-column (vertically). More...

virtual void	update ()
	At each location, this is called to calculate and store something in members.

virtual void	setLoopLimits (int width, int height)
	Sets the actual traversal range inside the window. Sometimes applied dynamically by reset().

void	setLoopLimits ()
	Sets the actual traversal range inside the window. Sometimes applied dynamically by reset().

bool	debugDiag (int bit=4)

Protected Attributes
double	sumMagnitude

std::vector< double >	sum

double	sumW

unsigned int	count

drain::typeLimiter< double >::value_t	limiter

Protected Attributes inherited from SlidingWindow< WindowConfig, MultiChannelWindowCore >
Point2D< int >	locationLead

Point2D< int >	locationTrail

void(SlidingWindow< WindowConfig, MultiChannelWindowCore >::*	fill )()
	Pointer to fill operation preformed at initial location (0,0) More...

void(SlidingWindow< WindowConfig, MultiChannelWindowCore >::*	updateHorz )()
	Pointer to update function invoked at each horizontal move. More...

void(SlidingWindow< WindowConfig, MultiChannelWindowCore >::*	updateVert )()
	Pointer to update function invoked at each vertical move. More...

Point2D< int >	locationTmp

Protected Attributes inherited from Window< C, R >
Point2D< int >	location
	Current location of this window.

int	samplingArea = 0
	Number of pixels in the window (frame width*height?).

bool	resetAtEdges = false
	To avoid accumulated numerical errors esp. with floats, reset the statistics at row/cols ends. See reset() .

bool	SCALE = true
	If set, scaling is applied, potentially slowering the computation.

Range< int >	iRange
	Studies source and destination images and decides whether scaling (SCALE=true) should be set.

Range< int >	jRange

CoordinateHandler2D	coordinateHandler

Additional Inherited Members
Public Attributes inherited from Window< C, R >
conf_t	conf

UniCloner< UnaryFunctor >	unicloner

drain::UnaryFunctor &	myFunctor

Public Attributes inherited from WindowCore
ImageView	src

ImageView	dst

Detailed Description

Window average that preserves the magnitude.

Member Function Documentation

◆ addPixel()

void addPixel ( Point2D< int > & p )

protectedvirtual

Adds a pixel to window statistics. Unvalidated location.

Updates class-specific window statistics by adding a pixel value - typically at the leading edge of the window.

Parameters

p	- location at which contribution should be removed

The argument p is not validated in advance but it should be checked within the implementation using coordinateHandler.validate(p), for example.

Implements SlidingWindow< WindowConfig, MultiChannelWindowCore >.

Reimplemented in FlowAverageWindowWeighted.

◆ initialize()

void initialize ( )

inlineprotectedvirtual

Sets class-specific initial values. Does not change general window state (e.g. location). Should not accumulate any statistics.

See also: fill(); clear()

Implements SlidingWindow< WindowConfig, MultiChannelWindowCore >.

◆ removePixel()

void removePixel ( Point2D< int > & p )

protectedvirtual

Removes a pixel from window statistics. Unvalidated location.

     Updates class-specific window statistics by removing a pixel value  - typically at the trailing edge of the window.

     \param p - location at which contribution should be removed
    const int h = (conf.height>0.0) ? conf.height : conf.width;

GaussianStripeVert window2(h, 0.5*conf.radius*static_cast{double}(h)); GaussianStripe2<false> window2(h, 0.5*conf.radius*static_cast{double}(h));

 The argument p is \em not validated in advance but
 it should be checked within the implementation using coordinateHandler.validate(p), for example.

Implements SlidingWindow< WindowConfig, MultiChannelWindowCore >.

Reimplemented in FlowAverageWindowWeighted.

◆ setImageLimits()

void setImageLimits ( ) const

inlineprotectedvirtual

Sets internal limits corresponding to image geometries. Typically using coordHandler.

Studies source image(s) and sets srcWidth, srcHeight and coordHandler. Consider already implemented methods like WindowCore::adjustCoordHandler()

Implements Window< C, R >.

◆ write()

void write ( )

protectedvirtual

Write the result in the target image.

Sliding windows enjoys a confidence of the application, as it has the

Compute magnitude of the current sum vector.

Invert and rescale with current averaged magnitude (sumMagnitude/sumW)

Implements SlidingWindow< WindowConfig, MultiChannelWindowCore >.

Reimplemented in FlowAverageWindowWeighted.

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

src/drain/imageops/FlowAverageWindowOp.h
src/drain/imageops/FlowAverageWindowOp.cpp

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addPixel()

◆ initialize()

◆ removePixel()

◆ setImageLimits()

◆ write()