Click or drag to resize
Accord.NET (logo)

Subtract Class

Subtract filter - subtract pixel values of two images.
Inheritance Hierarchy
SystemObject
  Accord.Imaging.FiltersBaseInPlaceFilter
    Accord.Imaging.FiltersBaseInPlaceFilter2
      Accord.Imaging.FiltersSubtract

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

The Subtract type exposes the following members.

Constructors
  NameDescription
Public methodSubtract
Initializes a new instance of the Subtract class.
Public methodSubtract(Bitmap)
Initializes a new instance of the Subtract class.
Public methodSubtract(UnmanagedImage)
Initializes a new instance of the Subtract class.
Top
Properties
  NameDescription
Public propertyFormatTranslations
Format translations dictionary.
(Overrides BaseInPlaceFilterFormatTranslations.)
Public propertyOverlayImage
Overlay image.
(Inherited from BaseInPlaceFilter2.)
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.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
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 MethodToT
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 subtract filter takes two images (source and overlay images) of the same size and pixel format and produces an image, where each pixel equals to the difference value of corresponding pixels from provided images (if difference is less than minimum allowed value, 0, then it is truncated to that minimum value).

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

Sample usage:

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

Source image:

Overlay image:

Result image:

See Also