|
HSLFiltering Class |
Color filtering in HSL color space.
Inheritance HierarchyNamespace: Accord.Imaging.Filters
Assembly: Accord.Imaging (in Accord.Imaging.dll) Version: 3.8.0
SyntaxThe HSLFiltering type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | HSLFiltering |
Initializes a new instance of the HSLFiltering class.
|
| HSLFiltering(IntRange, Range, Range) |
Initializes a new instance of the HSLFiltering class.
|
Properties| Name | Description | |
|---|---|---|
 | FillColor |
Fill color used to fill filtered pixels.
|
| FillOutsideRange |
Determines, if pixels should be filled inside or outside specified
color range.
|
| FormatTranslations |
Format translations dictionary.
(Overrides BaseInPlacePartialFilterFormatTranslations.) |
| Hue |
Range of hue component, [0, 359].
|
| Luminance |
Range of luminance component, [0, 1].
|
| Saturation |
Range of saturation component, [0, 1].
|
| UpdateHue |
Determines, if hue value of filtered pixels should be updated.
|
| UpdateLuminance |
Determines, if luminance value of filtered pixels should be updated.
|
| UpdateSaturation |
Determines, if saturation value of filtered pixels should be updated.
|
Methods| Name | Description | |
|---|---|---|
| Apply(Bitmap) |
Apply filter to an image.
(Inherited from BaseInPlacePartialFilter.) |
| Apply(BitmapData) |
Apply filter to an image.
(Inherited from BaseInPlacePartialFilter.) |
| Apply(UnmanagedImage) |
Apply filter to an image in unmanaged memory.
(Inherited from BaseInPlacePartialFilter.) |
| Apply(UnmanagedImage, UnmanagedImage) |
Apply filter to an image in unmanaged memory.
(Inherited from BaseInPlacePartialFilter.) |
| ApplyInPlace(Bitmap) |
Apply filter to an image.
(Inherited from BaseInPlacePartialFilter.) |
| ApplyInPlace(BitmapData) |
Apply filter to an image.
(Inherited from BaseInPlacePartialFilter.) |
| ApplyInPlace(UnmanagedImage) |
Apply filter to an unmanaged image.
(Inherited from BaseInPlacePartialFilter.) |
| ApplyInPlace(Bitmap, Rectangle) |
Apply filter to an image or its part.
(Inherited from BaseInPlacePartialFilter.) |
| ApplyInPlace(BitmapData, Rectangle) |
Apply filter to an image or its part.
(Inherited from BaseInPlacePartialFilter.) |
| ApplyInPlace(UnmanagedImage, Rectangle) |
Apply filter to an unmanaged image or its part.
(Inherited from BaseInPlacePartialFilter.) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ProcessFilter |
Process the filter on the specified image.
(Overrides BaseInPlacePartialFilterProcessFilter(UnmanagedImage, Rectangle).) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Extension Methods| Name | Description | |
|---|---|---|
 | HasMethod |
Checks whether an object implements a method with the given name.
(Defined by ExtensionMethods.) |
| IsEqual |
Compares two objects for equality, performing an elementwise
comparison if the elements are vectors or matrices.
(Defined by Matrix.) |
| To(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.) |
| ToT | 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.) |
RemarksThe filter operates in HSL color space and filters pixels, which color is inside/outside of the specified HSL range - it keeps pixels with colors inside/outside of the specified range and fills the rest with specified color.
The filter accepts 24 and 32 bpp color images for processing.
Sample usage:
// create filter HSLFiltering filter = new HSLFiltering( ); // set color ranges to keep filter.Hue = new IntRange( 335, 0 ); filter.Saturation = new Range( 0.6f, 1 ); filter.Luminance = new Range( 0.1f, 1 ); // apply the filter filter.ApplyInPlace( image );
Initial image:
Result image:
Sample usage with saturation update only:
// create filter HSLFiltering filter = new HSLFiltering( ); // configure the filter filter.Hue = new IntRange( 340, 20 ); filter.UpdateLuminance = false; filter.UpdateHue = false; // apply the filter filter.ApplyInPlace( image );
Result image:
See Also