Click or drag to resize
Accord.NET (logo)

HSLFiltering Class

Color filtering in HSL color space.
Inheritance Hierarchy
SystemObject
  Accord.Imaging.FiltersBaseInPlacePartialFilter
    Accord.Imaging.FiltersHSLFiltering

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

The HSLFiltering type exposes the following members.

Constructors
  NameDescription
Public methodHSLFiltering
Initializes a new instance of the HSLFiltering class.
Public methodHSLFiltering(IntRange, Range, Range)
Initializes a new instance of the HSLFiltering class.
Top
Properties
  NameDescription
Public propertyFillColor
Fill color used to fill filtered pixels.
Public propertyFillOutsideRange
Determines, if pixels should be filled inside or outside specified color range.
Public propertyFormatTranslations
Format translations dictionary.
(Overrides BaseInPlacePartialFilterFormatTranslations.)
Public propertyHue
Range of hue component, [0, 359].
Public propertyLuminance
Range of luminance component, [0, 1].
Public propertySaturation
Range of saturation component, [0, 1].
Public propertyUpdateHue
Determines, if hue value of filtered pixels should be updated.
Public propertyUpdateLuminance
Determines, if luminance value of filtered pixels should be updated.
Public propertyUpdateSaturation
Determines, if saturation value of filtered pixels should be updated.
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 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 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