eVision.EMovingAverage Class Reference

Temporal integration of a number of images to reduce noise. More...

Inheritance diagram for eVision.EMovingAverage:

Collaboration diagram for eVision.EMovingAverage:

Public Member Functions
	EMovingAverage ()
	Constructs an EMovingAverage object.
	EMovingAverage (uint period, int width, int height, bool internalAllocationScheme)
	Constructs an EMovingAverage object.
	EMovingAverage (uint period, int width, int height)
	Constructs an EMovingAverage object.
void	SetSize (uint numberOfImages, int imageWidth, int imageHeight, bool internalAllocationScheme)
	Initializes a moving average context with appropriate parameters.
void	SetSize (uint numberOfImages, int imageWidth, int imageHeight)
	Initializes a moving average context with appropriate parameters.
void	GetSize (ref uint numberOfImages, ref int imageWidth, ref int imageHeight, ref bool internalAllocationScheme)
	Queries a moving average context for the current parameter settings.
void	Reset ()
	Restarts the average process as if no image had ever been handed to the EMovingAverage object.
void	Average (eVision.EROIBW8 destinationImage)
	Performs averaging of the source image with the preceding ones, and computes the de-noised image.
void	Average (eVision.EROIBW8 sourceImage, eVision.EROIBW8 destinationImage)
	Performs averaging of the source image with the preceding ones, and computes the de-noised image.

Properties
uint	NumberOfImages [get]
	Gets the number of images on which to integrate.
int	ImageWidth [get]
	Gets the image width;.
int	ImageHeight [get]
	Gets the image height.
bool	InternalAllocationScheme [get]
	Gets the buffer allocation scheme. When true, the moving average context provides the image to be acquired into (see member EMovingAverage.SrcImage).
eVision.EImageBW8	SrcImage [get]
	Returns the image in which you must store the next image to be averaged.

Detailed Description

Temporal integration of a number of images to reduce noise.

License(s): EasyImage

Constructor & Destructor Documentation

EMovingAverage() [1/3]

eVision.EMovingAverage.EMovingAverage

(

)

Constructs an EMovingAverage object.

The default constructor constructs a void moving average context. A void moving average context has no internal buffers allocated and cannot be used for integration. Use the EMovingAverage.SetSize member after construction, or the initializing constructor instead. The sizing constructor constructs and initializes a moving average context.

EMovingAverage() [2/3]

eVision.EMovingAverage.EMovingAverage	(	uint	period,
		int	width,
		int	height,
		bool	internalAllocationScheme )

Constructs an EMovingAverage object.

Parameters

period	Number of images on which to integrate. A power of 2 is recommended.
width	Image width (all images used for averaging must be of the same size).
height	Image height (all images used for averaging must be of the same size).
internalAllocationScheme	Buffer allocation scheme. When true, the moving average context provides the image to be acquired into (see member EMovingAverage.SrcImage).

The default constructor constructs a void moving average context. A void moving average context has no internal buffers allocated and cannot be used for integration. Use the EMovingAverage.SetSize member after construction, or the initializing constructor instead. The sizing constructor constructs and initializes a moving average context.

EMovingAverage() [3/3]

eVision.EMovingAverage.EMovingAverage	(	uint	period,
		int	width,
		int	height )

Constructs an EMovingAverage object.

Parameters

period	Number of images on which to integrate. A power of 2 is recommended.
width	Image width (all images used for averaging must be of the same size).
height	Image height (all images used for averaging must be of the same size).

The default constructor constructs a void moving average context. A void moving average context has no internal buffers allocated and cannot be used for integration. Use the EMovingAverage.SetSize member after construction, or the initializing constructor instead. The sizing constructor constructs and initializes a moving average context.

Member Function Documentation

Average() [1/2]

void eVision.EMovingAverage.Average

(

eVision.EROIBW8

destinationImage

)

Performs averaging of the source image with the preceding ones, and computes the de-noised image.

Parameters

destinationImage

Pointer to the destination image.

The overload with only the destinationImage may be used only when the buffer allocation scheme has been set to internal (see EMovingAverage.SetSize or EMovingAverage.EMovingAverage)

Average() [2/2]

void eVision.EMovingAverage.Average	(	eVision.EROIBW8	sourceImage,
		eVision.EROIBW8	destinationImage )

Performs averaging of the source image with the preceding ones, and computes the de-noised image.

Parameters

sourceImage	Pointer to the source image.
destinationImage	Pointer to the destination image.

The overload with only the destinationImage may be used only when the buffer allocation scheme has been set to internal (see EMovingAverage.SetSize or EMovingAverage.EMovingAverage)

GetSize()

void eVision.EMovingAverage.GetSize	(	ref uint	numberOfImages,
		ref int	imageWidth,
		ref int	imageHeight,
		ref bool	internalAllocationScheme )

Queries a moving average context for the current parameter settings.

Parameters

numberOfImages	Number of images on which to integrate.
imageWidth	Image width (all images used for averaging must be of the same size).
imageHeight	Image height (all images used for averaging must be of the same size).
internalAllocationScheme	Buffer allocation scheme. When true, the moving average context provides the image to be acquired into (see member EMovingAverage.SrcImage).

Deprecated

Use EMovingAverage.NumberOfImages, EMovingAverage.ImageWidth, EMovingAverage.ImageHeight or EMovingAverage.InternalAllocationScheme instead.

Deprecated in version 24.6. Scheduled to be removed in version 27.6.

Reset()

void eVision.EMovingAverage.Reset

(

)

Restarts the average process as if no image had ever been handed to the EMovingAverage object.

The behavior is thus the same as after a EMovingAverage.SetSize operation.

SetSize() [1/2]

void eVision.EMovingAverage.SetSize	(	uint	numberOfImages,
		int	imageWidth,
		int	imageHeight )

Initializes a moving average context with appropriate parameters.

Parameters

numberOfImages	Number of images on which to integrate. A power of 2 is recommended.
imageWidth	Image width.
imageHeight	Image height.

SetSize() [2/2]

void eVision.EMovingAverage.SetSize	(	uint	numberOfImages,
		int	imageWidth,
		int	imageHeight,
		bool	internalAllocationScheme )

Initializes a moving average context with appropriate parameters.

Parameters

numberOfImages	Number of images on which to integrate. A power of 2 is recommended.
imageWidth	Image width.
imageHeight	Image height.
internalAllocationScheme	Buffer allocation scheme. When true, the moving average context provides the image to be acquired into (see member EMovingAverage.SrcImage).

Property Documentation

ImageHeight

int eVision.EMovingAverage.ImageHeight

get

Gets the image height.

ImageWidth

int eVision.EMovingAverage.ImageWidth

get

Gets the image width;.

InternalAllocationScheme

bool eVision.EMovingAverage.InternalAllocationScheme

get

Gets the buffer allocation scheme. When true, the moving average context provides the image to be acquired into (see member EMovingAverage.SrcImage).

NumberOfImages

uint eVision.EMovingAverage.NumberOfImages

get

Gets the number of images on which to integrate.

SrcImage

eVision.EImageBW8 eVision.EMovingAverage.SrcImage

get

Returns the image in which you must store the next image to be averaged.

This method may be used only when the buffer allocation scheme has been set to internal (see EMovingAverage.SetSize or EMovingAverage.EMovingAverage)