Click or drag to resize
Accord.NET (logo)

WaterWave Class
Simple water wave effect filter.
Inheritance Hierarchy
SystemObject
  Accord.Imaging.FiltersBaseFilter
    Accord.Imaging.FiltersWaterWave

Namespace:  Accord.Imaging.Filters
Assembly:  Accord.Imaging (in Accord.Imaging.dll) Version: 3.8.0
Syntax
Copy
public class WaterWave : BaseFilter
Request Example View Source

The WaterWave type exposes the following members.

Constructors
  NameDescription
Public methodWaterWave
Initializes a new instance of the WaterWave class.
Top
Properties
  NameDescription
Public propertyFormatTranslations
Format translations dictionary.
(Overrides BaseFilterFormatTranslations.)
Public propertyHorizontalWavesAmplitude
Amplitude of horizontal waves measured in pixels, [0, 10000].
Public propertyHorizontalWavesCount
Number of horizontal waves, [1, 10000].
Public propertyVerticalWavesAmplitude
Amplitude of vertical waves measured in pixels, [0, 10000].
Public propertyVerticalWavesCount
Number of vertical waves, [1, 10000].
Top
Methods
  NameDescription
Public methodApply(Bitmap)
Apply filter to an image.
(Inherited from BaseFilter.)
Public methodApply(BitmapData)
Apply filter to an image.
(Inherited from BaseFilter.)
Public methodApply(UnmanagedImage)
Apply filter to an image in unmanaged memory.
(Inherited from BaseFilter.)
Public methodApply(UnmanagedImage, UnmanagedImage)
Apply filter to an image in unmanaged memory.
(Inherited from BaseFilter.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodProcessFilter
Process the filter on the specified image.
(Overrides BaseFilterProcessFilter(UnmanagedImage, UnmanagedImage).)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Extension Methods
  NameDescription
Public Extension MethodHasMethod
Checks whether an object implements a method with the given name.
(Defined by ExtensionMethods.)
Public Extension MethodIsEqual
Compares two objects for equality, performing an elementwise comparison if the elements are vectors or matrices.
(Defined by Matrix.)
Public Extension MethodTo(Type)Overloaded.
Converts an object into another type, irrespective of whether the conversion can be done at compile time or not. This can be used to convert generic types to numeric types during runtime.
(Defined by ExtensionMethods.)
Public Extension MethodToTOverloaded.
Converts an object into another type, irrespective of whether the conversion can be done at compile time or not. This can be used to convert generic types to numeric types during runtime.
(Defined by ExtensionMethods.)
Top
Remarks

The image processing filter implements simple water wave effect. Using properties of the class, it is possible to set number of vertical/horizontal waves, as well as their amplitude.

Bilinear interpolation is used to create smooth effect.

The filter accepts 8 bpp grayscale images and 24/32 color images for processing.

Sample usage:

Copy
// create filter
WaterWave filter = new WaterWave( );
filter.HorizontalWavesCount     = 10;
filter.HorizontalWavesAmplitude = 5;
filter.VerticalWavesCount       = 3;
filter.VerticalWavesAmplitude   = 15;
// apply the filter
Bitmap newImage = filter.Apply( image );

Initial image:

Result image:

See Also