C# Class Accord.Imaging.Filters.BaseFilter2

Base class for filters, which operate with two images of the same size and format and produce new image as a result.

The abstract class is the base class for all filters, which can be applied to an image producing new image as a result of image processing.

The base class is aimed for such type of filters, which require additional image to process the source image. The additional image is set by OverlayImage or UnmanagedOverlayImage property and must have the same size and pixel format as source image. See documentation of particular inherited class for information about overlay image purpose.

Inheritance: BaseFilter
Show file Open project: accord-net/framework

Protected Methods

Method Description
BaseFilter2 ( ) : System

Initializes a new instance of the BaseFilter2 class.

BaseFilter2 ( Bitmap overlayImage ) : System

Initializes a new instance of the BaseFilter2 class.

BaseFilter2 ( UnmanagedImage unmanagedOverlayImage ) : System

Initializes a new instance of the BaseFilter2 class.

ProcessFilter ( UnmanagedImage sourceData, UnmanagedImage destinationData ) : void

Process the filter on the specified image.

ProcessFilter ( UnmanagedImage sourceData, UnmanagedImage overlay, UnmanagedImage destinationData ) : void

Process the filter on the specified image.

Overlay image size and pixel format is checked by this base class, before passing execution to inherited class.

Method Details

BaseFilter2() protected method

Initializes a new instance of the BaseFilter2 class.
protected BaseFilter2 ( ) : System
return System

BaseFilter2() protected method

Initializes a new instance of the BaseFilter2 class.
protected BaseFilter2 ( Bitmap overlayImage ) : System
overlayImage System.Drawing.Bitmap Overlay image.
return System

BaseFilter2() protected method

Initializes a new instance of the BaseFilter2 class.
protected BaseFilter2 ( UnmanagedImage unmanagedOverlayImage ) : System
unmanagedOverlayImage UnmanagedImage Unmanaged overlay image.
return System

ProcessFilter() protected method

Process the filter on the specified image.
protected ProcessFilter ( UnmanagedImage sourceData, UnmanagedImage destinationData ) : void
sourceData UnmanagedImage Source image data.
destinationData UnmanagedImage Destination image data.
return void

ProcessFilter() protected abstract method

Process the filter on the specified image.

Overlay image size and pixel format is checked by this base class, before passing execution to inherited class.

protected abstract ProcessFilter ( UnmanagedImage sourceData, UnmanagedImage overlay, UnmanagedImage destinationData ) : void
sourceData UnmanagedImage Source image data.
overlay UnmanagedImage Overlay image data.
destinationData UnmanagedImage Destination image data
return void