Click or drag to resize
Accord.NET (logo) MoveTowards Class
Move towards filter.
Inheritance Hierarchy
SystemObject
  Accord.Imaging.FiltersBaseInPlaceFilter
    Accord.Imaging.FiltersBaseInPlaceFilter2
      Accord.Imaging.FiltersMoveTowards

Namespace:  Accord.Imaging.Filters
Assembly:  Accord.Imaging (in Accord.Imaging.dll) Version: 3.4.0
Syntax
public class MoveTowards : BaseInPlaceFilter2
Request Example View Source

The MoveTowards type exposes the following members.

Constructors
  NameDescription
Public methodMoveTowards
Initializes a new instance of the MoveTowards class
Public methodMoveTowards(Bitmap)
Initializes a new instance of the MoveTowards class.
Public methodMoveTowards(UnmanagedImage)
Initializes a new instance of the MoveTowards class.
Public methodMoveTowards(Bitmap, Int32)
Initializes a new instance of the MoveTowards class.
Public methodMoveTowards(UnmanagedImage, Int32)
Initializes a new instance of the MoveTowards class.
Top
Properties
  NameDescription
Public propertyFormatTranslations
Format translations dictionary.
(Overrides BaseInPlaceFilterFormatTranslations.)
Public propertyOverlayImage
Overlay image.
(Inherited from BaseInPlaceFilter2.)
Public propertyStepSize
Step size, [0, 65535].
Public propertyUnmanagedOverlayImage
Unmanaged overlay image.
(Inherited from BaseInPlaceFilter2.)
Top
Methods
  NameDescription
Public methodApply(Bitmap)
Apply filter to an image.
(Inherited from BaseInPlaceFilter.)
Public methodApply(BitmapData)
Apply filter to an image.
(Inherited from BaseInPlaceFilter.)
Public methodApply(UnmanagedImage)
Apply filter to an image in unmanaged memory.
(Inherited from BaseInPlaceFilter.)
Public methodApply(UnmanagedImage, UnmanagedImage)
Apply filter to an image in unmanaged memory.
(Inherited from BaseInPlaceFilter.)
Public methodApplyInPlace(Bitmap)
Apply filter to an image.
(Inherited from BaseInPlaceFilter.)
Public methodApplyInPlace(BitmapData)
Apply filter to an image.
(Inherited from BaseInPlaceFilter.)
Public methodApplyInPlace(UnmanagedImage)
Apply filter to an unmanaged image.
(Inherited from BaseInPlaceFilter.)
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(UnmanagedImage)
Process the filter on the specified image.
(Inherited from BaseInPlaceFilter2.)
Protected methodProcessFilter(UnmanagedImage, UnmanagedImage)
Process the filter on the specified image.
(Overrides BaseInPlaceFilter2ProcessFilter(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 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.)
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 Matrix.)
Top
Remarks

The result of this filter is an image, which is based on source image, but updated in the way to decrease diffirence with overlay image - source image is moved towards overlay image. The update equation is defined in the next way: res = src + Min( Abs( ovr - src ), step ) * Sign( ovr - src ).

The bigger is step size value the more resulting image will look like overlay image. For example, in the case if step size is equal to 255 (or 65535 for images with 16 bits per channel), the resulting image will be equal to overlay image regardless of source image's pixel values. In the case if step size is set to 1, the resulting image will very little differ from the source image. But, in the case if the filter is applied repeatedly to the resulting image again and again, it will become equal to overlay image in maximum 255 (65535 for images with 16 bits per channel) iterations.

The filter accepts 8 and 16 bpp grayscale images and 24, 32, 48 and 64 bpp color images for processing.

Sample usage:

// create filter
MoveTowards filter = new MoveTowards( overlayImage, 20 );
// apply the filter
Bitmap resultImage = filter.Apply( sourceImage );

Source image:

Overlay image:

Result image:

See Also