Click or drag to resize
Accord.NET (logo)

SaturationCorrection Class

Saturation adjusting in HSL color space.
Inheritance Hierarchy
SystemObject
  Accord.Imaging.FiltersBaseInPlacePartialFilter
    Accord.Imaging.FiltersSaturationCorrection

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

The SaturationCorrection type exposes the following members.

Constructors
  NameDescription
Public methodSaturationCorrection
Initializes a new instance of the SaturationCorrection class.
Public methodSaturationCorrection(Single)
Initializes a new instance of the SaturationCorrection class.
Top
Properties
  NameDescription
Public propertyAdjustValue
Saturation adjust value, [-1, 1].
Public propertyFormatTranslations
Format translations dictionary.
(Overrides BaseInPlacePartialFilterFormatTranslations.)
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 adjusts pixels' saturation value, increasing it or decreasing by specified percentage. The filters is based on HSLLinear filter, passing work to it after recalculating saturation adjust value to input/output ranges of the HSLLinear filter.

The filter accepts 24 and 32 bpp color images for processing.

Sample usage:

// create filter
SaturationCorrection filter = new SaturationCorrection( -0.5f );
// apply the filter
filter.ApplyInPlace( image );

Initial image:

Result image:

See Also