Click or drag to resize
Accord.NET (logo) MaskedFilter Class
Apply filter according to the specified mask.
Inheritance Hierarchy
SystemObject
  Accord.Imaging.FiltersBaseInPlacePartialFilter
    Accord.Imaging.FiltersMaskedFilter

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

The MaskedFilter type exposes the following members.

Constructors
  NameDescription
Public methodMaskedFilter(IFilter, UnmanagedImage)
Initializes a new instance of the MaskedFilter class.
Public methodMaskedFilter(IFilter, Byte)
Initializes a new instance of the MaskedFilter class.
Public methodMaskedFilter(IFilter, Bitmap)
Initializes a new instance of the MaskedFilter class.
Top
Properties
  NameDescription
Public propertyBaseFilter
Base filter to apply to the source image.
Public propertyFormatTranslations
Format translations dictionary.
(Overrides BaseInPlacePartialFilterFormatTranslations.)
Public propertyMask
Mask to apply.
Public propertyMaskImage
Mask image to apply.
Public propertyUnmanagedMaskImage
Unmanaged mask image to apply.
Top
Methods
  NameDescription
Public methodApply(Bitmap)
Apply filter to an image.
(Inherited from BaseInPlacePartialFilter.)
Public methodApply(BitmapData)
Apply filter to an image.
(Inherited from BaseInPlacePartialFilter.)
Public methodApply(UnmanagedImage)
Apply filter to an image in unmanaged memory.
(Inherited from BaseInPlacePartialFilter.)
Public methodApply(UnmanagedImage, UnmanagedImage)
Apply filter to an image in unmanaged memory.
(Inherited from BaseInPlacePartialFilter.)
Public methodApplyInPlace(Bitmap)
Apply filter to an image.
(Inherited from BaseInPlacePartialFilter.)
Public methodApplyInPlace(BitmapData)
Apply filter to an image.
(Inherited from BaseInPlacePartialFilter.)
Public methodApplyInPlace(UnmanagedImage)
Apply filter to an unmanaged image.
(Inherited from BaseInPlacePartialFilter.)
Public methodApplyInPlace(Bitmap, Rectangle)
Apply filter to an image or its part.
(Inherited from BaseInPlacePartialFilter.)
Public methodApplyInPlace(BitmapData, Rectangle)
Apply filter to an image or its part.
(Inherited from BaseInPlacePartialFilter.)
Public methodApplyInPlace(UnmanagedImage, Rectangle)
Apply filter to an unmanaged image or its part.
(Inherited from BaseInPlacePartialFilter.)
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 BaseInPlacePartialFilterProcessFilter(UnmanagedImage, Rectangle).)
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 image processing routine applies the specified BaseFilter to a source image according to the specified mask - if a pixel/value in the specified mask image/array is set to 0, then the original pixel's value is kept; otherwise the pixel is filtered using the specified base filter.

Mask can be specified as .NET's managed Bitmap, as UnmanagedImage or as byte array. In the case if mask is specified as image, it must be 8 bpp grayscale image. In all case mask size must be the same as size of the image to process.

Note Note
Pixel formats accepted by this filter are specified by the BaseFilter.

Sample usage:

// create the filter
MaskedFilter maskedFilter = new MaskedFilter( new Sepia( ), maskImage );
// apply the filter
maskedFilter.ApplyInPlace( image );

Initial image:

Mask image:

Result image:

See Also