Class HistogramEqualizationProcessor

Defines a processor that normalizes the histogram of an image.

Inheritance

Object

HistogramEqualizationProcessor

AdaptiveHistogramEqualizationProcessor

AdaptiveHistogramEqualizationSlidingWindowProcessor

GlobalHistogramEqualizationProcessor

Implements

IImageProcessor

Inherited Members

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Object.ToString()

Namespace: SixLabors.ImageSharp.Processing.Processors.Normalization

Assembly: SixLabors.ImageSharp.dll

Syntax

public abstract class HistogramEqualizationProcessor : IImageProcessor

Constructors

| Improve this Doc View Source

HistogramEqualizationProcessor(Int32, Boolean, Int32)

Initializes a new instance of the HistogramEqualizationProcessor class.

Declaration

protected HistogramEqualizationProcessor(int luminanceLevels, bool clipHistogram, int clipLimit)

Parameters

Type	Name	Description
Int32	luminanceLevels	The number of different luminance levels. Typical values are 256 for 8-bit grayscale images or 65536 for 16-bit grayscale images.
Boolean	clipHistogram	Indicates, if histogram bins should be clipped.
Int32	clipLimit	The histogram clip limit. Histogram bins which exceed this limit, will be capped at this value.

Properties

| Improve this Doc View Source

ClipHistogram

Gets a value indicating whether to clip the histogram bins at a specific value.

Declaration

public bool ClipHistogram { get; }

Property Value

Type	Description
Boolean

| Improve this Doc View Source

ClipLimit

Gets the histogram clip limit. Histogram bins which exceed this limit, will be capped at this value.

Declaration

public int ClipLimit { get; }

Property Value

Type	Description
Int32

| Improve this Doc View Source

LuminanceLevels

Gets the number of luminance levels.

Declaration

public int LuminanceLevels { get; }

Property Value

Type	Description
Int32

Methods

| Improve this Doc View Source

CreatePixelSpecificProcessor<TPixel>(Configuration, Image<TPixel>, Rectangle)

Creates a pixel specific IImageProcessor<TPixel> that is capable of executing the processing algorithm on an Image<TPixel>.

Declaration

public abstract IImageProcessor<TPixel> CreatePixelSpecificProcessor<TPixel>(Configuration configuration, Image<TPixel> source, Rectangle sourceRectangle)
    where TPixel : struct, IPixel<TPixel>

Parameters

Type	Name	Description
Configuration	configuration	The configuration which allows altering default behaviour or extending the library.
Image<TPixel>	source	The source image. Cannot be null.
Rectangle	sourceRectangle	The Rectangle structure that specifies the portion of the image object to draw.

Returns

Type	Description
IImageProcessor<TPixel>	The IImageProcessor<TPixel>

Type Parameters

Name	Description
TPixel	The pixel type.

| Improve this Doc View Source

FromOptions(HistogramEqualizationOptions)

Creates the HistogramEqualizationProcessor that implements the algorithm defined by the given HistogramEqualizationOptions.

Declaration

public static HistogramEqualizationProcessor FromOptions(HistogramEqualizationOptions options)

Parameters

Type	Name	Description
HistogramEqualizationOptions	options	The HistogramEqualizationOptions.

Returns

Type	Description
HistogramEqualizationProcessor	The HistogramEqualizationProcessor.

Implements

IImageProcessor