Struct EdgeDetectorCompassKernel

Represents an edge detection convolution kernel consisting of eight gradient operators.

Implements

IEquatable<EdgeDetectorCompassKernel>

Inherited Members

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: SixLabors.ImageSharp.Processing.Processors.Convolution

Assembly: SixLabors.ImageSharp.dll

Syntax

public readonly struct EdgeDetectorCompassKernel : IEquatable<EdgeDetectorCompassKernel>

Constructors

EdgeDetectorCompassKernel(DenseMatrix<float>, DenseMatrix<float>, DenseMatrix<float>, DenseMatrix<float>, DenseMatrix<float>, DenseMatrix<float>, DenseMatrix<float>, DenseMatrix<float>)

Initializes a new instance of the EdgeDetectorCompassKernel struct.

Declaration

public EdgeDetectorCompassKernel(DenseMatrix<float> north, DenseMatrix<float> northWest, DenseMatrix<float> west, DenseMatrix<float> southWest, DenseMatrix<float> south, DenseMatrix<float> southEast, DenseMatrix<float> east, DenseMatrix<float> northEast)

Parameters

Type	Name	Description
DenseMatrix<float>	north	The north gradient operator.
DenseMatrix<float>	northWest	The north-west gradient operator.
DenseMatrix<float>	west	The west gradient operator.
DenseMatrix<float>	southWest	The south-west gradient operator.
DenseMatrix<float>	south	The south gradient operator.
DenseMatrix<float>	southEast	The south-east gradient operator.
DenseMatrix<float>	east	The east gradient operator.
DenseMatrix<float>	northEast	The north-east gradient operator.

Fields

Kirsch

An edge detection kenel comprised of Kirsch gradient operators. http://en.wikipedia.org/wiki/Kirsch_operator.

Declaration

public static readonly EdgeDetectorCompassKernel Kirsch

Field Value

Type	Description
EdgeDetectorCompassKernel

Robinson

An edge detection kenel comprised of Robinson gradient operators. http://www.tutorialspoint.com/dip/Robinson_Compass_Mask.htm

Declaration

public static readonly EdgeDetectorCompassKernel Robinson

Field Value

Type	Description
EdgeDetectorCompassKernel

Properties

East

Gets the East gradient operator.

Declaration

public DenseMatrix<float> East { get; }

Property Value

Type	Description
DenseMatrix<float>

North

Gets the North gradient operator.

Declaration

public DenseMatrix<float> North { get; }

Property Value

Type	Description
DenseMatrix<float>

NorthEast

Gets the NorthEast gradient operator.

Declaration

public DenseMatrix<float> NorthEast { get; }

Property Value

Type	Description
DenseMatrix<float>

NorthWest

Gets the NorthWest gradient operator.

Declaration

public DenseMatrix<float> NorthWest { get; }

Property Value

Type	Description
DenseMatrix<float>

South

Gets the South gradient operator.

Declaration

public DenseMatrix<float> South { get; }

Property Value

Type	Description
DenseMatrix<float>

SouthEast

Gets the SouthEast gradient operator.

Declaration

public DenseMatrix<float> SouthEast { get; }

Property Value

Type	Description
DenseMatrix<float>

SouthWest

Gets the SouthWest gradient operator.

Declaration

public DenseMatrix<float> SouthWest { get; }

Property Value

Type	Description
DenseMatrix<float>

West

Gets the West gradient operator.

Declaration

public DenseMatrix<float> West { get; }

Property Value

Type	Description
DenseMatrix<float>

Methods

Equals(EdgeDetectorCompassKernel)

Indicates whether the current object is equal to another object of the same type.

Declaration

public bool Equals(EdgeDetectorCompassKernel other)

Parameters

Type	Name	Description
EdgeDetectorCompassKernel	other	An object to compare with this object.

Returns

Type	Description
bool	true if the current object is equal to the other parameter; otherwise, false.

Equals(object?)

Indicates whether this instance and a specified object are equal.

Declaration

public override bool Equals(object? obj)

Parameters

Type	Name	Description
object	obj	The object to compare with the current instance.

Returns

Type	Description
bool	true if obj and this instance are the same type and represent the same value; otherwise, false.

Overrides

ValueType.Equals(object)

GetHashCode()

Returns the hash code for this instance.

Declaration

public override int GetHashCode()

Returns

Type	Description
int	A 32-bit signed integer that is the hash code for this instance.

Overrides

ValueType.GetHashCode()

Operators

operator ==(EdgeDetectorCompassKernel, EdgeDetectorCompassKernel)

Checks whether two EdgeDetectorCompassKernel structures are equal.

Declaration

public static bool operator ==(EdgeDetectorCompassKernel left, EdgeDetectorCompassKernel right)

Parameters

Type	Name	Description
EdgeDetectorCompassKernel	left	The left hand EdgeDetectorCompassKernel operand.
EdgeDetectorCompassKernel	right	The right hand EdgeDetectorCompassKernel operand.

Returns

Type	Description
bool	True if the left parameter is equal to the right parameter; otherwise, false.

operator !=(EdgeDetectorCompassKernel, EdgeDetectorCompassKernel)

Checks whether two EdgeDetectorCompassKernel structures are equal.

Declaration

public static bool operator !=(EdgeDetectorCompassKernel left, EdgeDetectorCompassKernel right)

Parameters

Type	Name	Description
EdgeDetectorCompassKernel	left	The left hand EdgeDetectorCompassKernel operand.
EdgeDetectorCompassKernel	right	The right hand EdgeDetectorCompassKernel operand.

Returns

Type	Description
bool	True if the left parameter is not equal to the right parameter; otherwise, false.

Implements

IEquatable<T>