eVision Python API
Loading...
Searching...
No Matches
eVision.EMovingAverage Class Reference

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

Public Member Functions

None __init__ (self)
 Constructs an eVision.EMovingAverage object.
None __init__ (self, int period, int width, int height, bool internalAllocationScheme)
 Constructs an eVision.EMovingAverage object.
None __init__ (self, int period, int width, int height)
 Constructs an eVision.EMovingAverage object.
None SetSize (self, int numberOfImages, int imageWidth, int imageHeight, bool internalAllocationScheme)
 Initializes a moving average context with appropriate parameters.
None SetSize (self, int numberOfImages, int imageWidth, int imageHeight)
 Initializes a moving average context with appropriate parameters.
None Reset (self)
 Restarts the average process as if no image had ever been handed to the eVision.EMovingAverage object.
None Average (self, eVision.EROIBW8|None destinationImage)
 Performs averaging of the source image with the preceding ones, and computes the de-noised image.
None Average (self, eVision.EROIBW8|None sourceImage, eVision.EROIBW8|None destinationImage)
 Performs averaging of the source image with the preceding ones, and computes the de-noised image.
int NumberOfImages (self)
 Gets the number of images on which to integrate.
int ImageWidth (self)
 Gets the image width;.
int ImageHeight (self)
 Gets the image height.
bool InternalAllocationScheme (self)
 Gets the buffer allocation scheme.
eVision.EImageBW8|None SrcImage (self)
 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.

Remarks:

License(s): EasyImage

Constructor & Destructor Documentation

◆ __init__() [1/3]

None eVision.EMovingAverage.__init__ ( self)

Constructs an eVision.EMovingAverage object.

Remarks:

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 eVision.EMovingAverage.SetSize member after construction, or the initializing constructor instead. The sizing constructor constructs and initializes a moving average context.

◆ __init__() [2/3]

None eVision.EMovingAverage.__init__ ( self,
int period,
int width,
int height,
bool internalAllocationScheme )

Constructs an eVision.EMovingAverage object.

Remarks:

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 eVision.EMovingAverage.SetSize member after construction, or the initializing constructor instead. The sizing constructor constructs and initializes a moving average context.

Parameters
periodNumber of images on which to integrate. A power of 2 is recommended.
widthImage width (all images used for averaging must be of the same size).
heightImage height (all images used for averaging must be of the same size).
internalAllocationSchemeBuffer allocation scheme. When true, the moving average context provides the image to be acquired into (see member eVision.EMovingAverage.SrcImage).

◆ __init__() [3/3]

None eVision.EMovingAverage.__init__ ( self,
int period,
int width,
int height )

Constructs an eVision.EMovingAverage object.

Remarks:

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 eVision.EMovingAverage.SetSize member after construction, or the initializing constructor instead. The sizing constructor constructs and initializes a moving average context.

Parameters
periodNumber of images on which to integrate. A power of 2 is recommended.
widthImage width (all images used for averaging must be of the same size).
heightImage height (all images used for averaging must be of the same size).

Member Function Documentation

◆ Average() [1/2]

None eVision.EMovingAverage.Average ( self,
eVision.EROIBW8 | None destinationImage )

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

Remarks:

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

Parameters
destinationImagePointer to the destination image.

◆ Average() [2/2]

None eVision.EMovingAverage.Average ( self,
eVision.EROIBW8 | None sourceImage,
eVision.EROIBW8 | None destinationImage )

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

Remarks:

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

Parameters
sourceImagePointer to the source image.
destinationImagePointer to the destination image.

◆ ImageHeight()

int eVision.EMovingAverage.ImageHeight ( self)

Gets the image height.

◆ ImageWidth()

int eVision.EMovingAverage.ImageWidth ( self)

Gets the image width;.

◆ InternalAllocationScheme()

bool eVision.EMovingAverage.InternalAllocationScheme ( self)

Gets the buffer allocation scheme.

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

◆ NumberOfImages()

int eVision.EMovingAverage.NumberOfImages ( self)

Gets the number of images on which to integrate.

◆ Reset()

None eVision.EMovingAverage.Reset ( self)

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

Remarks:

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

◆ SetSize() [1/2]

None eVision.EMovingAverage.SetSize ( self,
int numberOfImages,
int imageWidth,
int imageHeight )

Initializes a moving average context with appropriate parameters.

Parameters
numberOfImagesNumber of images on which to integrate. A power of 2 is recommended.
imageWidthImage width.
imageHeightImage height.

◆ SetSize() [2/2]

None eVision.EMovingAverage.SetSize ( self,
int numberOfImages,
int imageWidth,
int imageHeight,
bool internalAllocationScheme )

Initializes a moving average context with appropriate parameters.

Parameters
numberOfImagesNumber of images on which to integrate. A power of 2 is recommended.
imageWidthImage width.
imageHeightImage height.
internalAllocationSchemeBuffer allocation scheme. When true, the moving average context provides the image to be acquired into (see member eVision.EMovingAverage.SrcImage).

◆ SrcImage()

eVision.EImageBW8 | None eVision.EMovingAverage.SrcImage ( self)

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

Remarks:

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