Base class for windows applied by WindowOp's. More...

#include <Window.h>

Inheritance diagram for Window< C, R >:

[legend]

Collaboration diagram for Window< C, R >:

[legend]

Public Types
typedef C	conf_t

Public Member Functions
	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	run ()
	Main loop: traverses the source image and writes result to dst image.

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)

Public Attributes
conf_t	conf

LocalCloner< UnaryFunctor >	unicloner

drain::UnaryFunctor &	myFunctor

Public Attributes inherited from WindowCore
ImageView	src

ImageView	dst

Protected Member Functions
virtual bool	isHorizontal () const
	Tells if the window should be moved (traversed of slided) row-by-row (horizontally) or column-by-column (vertically).

virtual void	initialize ()

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

virtual void	write ()=0
	At each location, the result of computation to dst image(s).

virtual bool	reset ()
	Function determining whether array should be cleared at the edge(s). Needed for 1) cleaning numerical residues and 2) updating window parameters.

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

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

Detailed Description

template<class C = WindowConfig, class R = WindowCore>
class drain::image::Window< C, R >

Base class for windows applied by WindowOp's.

Template Parameters

C	- configuration (width, height and str metadata)
R	- source and target images, and their setters.

Member Function Documentation

◆ initialize()

template<class C = WindowConfig, class R = WindowCore>

virtual void initialize ( )

inlineprotectedvirtual

This function \i must

set image limits (limits of the total scanning area)
set (initial) loop limits (limits of the window scanning area. Typically window origin is in the center.
set starting location (typically 0,0)

◆ isHorizontal()

template<class C = WindowConfig, class R = WindowCore>

virtual bool isHorizontal ( ) const

inlineprotectedvirtual

Tells if the window should be moved (traversed of slided) row-by-row (horizontally) or column-by-column (vertically).

One may think of a boat. Boats typically move more easily forward or backward (ie. "horizontally") than sideways ("vertically").

◆ reset()

template<class C = WindowConfig, class R = WindowCore>

virtual bool reset ( )

inlineprotectedvirtual

Function determining whether array should be cleared at the edge(s). Needed for 1) cleaning numerical residues and 2) updating window parameters.

Consider: rename to edgeCheck ?

Returns: - false, if scanning should be ended (if window dimensions have been changed?)

◆ run()

template<class P , class R >

void run ( )

virtual

Main loop: traverses the source image and writes result to dst image.

The basic implementation is a two-level loop (for j, for i ...).

Contract: any implementation should call initialize().

Reimplemented in SlidingWindow< C, R >, SlidingWindow< C, RadarWindowCore >, SlidingWindow< DopplerInversionConfig, RadarWindowCore >, SlidingWindow< F, RadarWindowCore >, SlidingWindow< HistogramWindowConfig, WeightedWindowCore >, SlidingWindow< HistogramWindowConfig, WindowCore >, SlidingWindow< OpticalFlowConfig, OpticalFlowCore1 >, SlidingWindow< OpticalFlowConfig, OpticalFlowCore2 >, SlidingWindow< RadarWindowConfig, EtopWindowCore >, SlidingWindow< RadarWindowConfig, RadarWindowCore >, SlidingWindow< WindowConfig, MultiChannelWindowCore >, and SlidingWindow< WindowConfig, WindowCore >.

◆ setImageLimits()

template<class C = WindowConfig, class R = WindowCore>

virtual void setImageLimits ( ) const

protectedpure virtual

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()

Implemented in GaussianStripe< DIR, R >, GaussianStripe< DIR, WeightedWindowCore >, GaussianStripe< true, WeightedWindowCore >, SlidingOpticalFlow< R >, SlidingOpticalFlow< OpticalFlowCore1 >, SlidingOpticalFlow2< R >, SlidingOpticalFlow2< OpticalFlowCore2 >, FlowAverageWindow, SlidingWindowHistogram< R >, SlidingWindowHistogram< WeightedWindowCore >, SlidingWindowHistogram< WindowCore >, SlidingRadarWindowBase< C, R >, SlidingRadarWindowBase< C, RadarWindowCore >, SlidingRadarWindowBase< DopplerInversionConfig, RadarWindowCore >, SlidingRadarWindowBase< F, RadarWindowCore >, SlidingRadarWindowBase< RadarWindowConfig, RadarWindowCore >, and Etop2Window.

◆ setSize()

template<class C = WindowConfig, class R = WindowCore>

virtual void setSize	(	size_t	width,
		size_t	height
	)

inlinevirtual

Sets the window size.

Reimplemented in GaussianStripe< DIR, R >, GaussianStripe< DIR, WeightedWindowCore >, GaussianStripe< true, WeightedWindowCore >, and SlidingStripe< C, R, DIR >.

◆ toStream()

template<class C , class R >

void toStream ( std::ostream & ostr ) const

virtual

Write debugging info to stream

◆ update()

template<class C = WindowConfig, class R = WindowCore>

virtual void update ( )

inlineprotectedvirtual

At each location, this is called to calculate and store something in members.

◆ write()

template<class C = WindowConfig, class R = WindowCore>

virtual void write ( )

protectedpure virtual

At each location, the result of computation to dst image(s).

Contract: this function is called after update().

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

src/drain/image/Window.h

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ initialize()

◆ isHorizontal()

◆ reset()

◆ run()

◆ setImageLimits()

◆ setSize()

◆ toStream()

◆ update()

◆ write()