Class ExclusionMask

An exclusion mask determines which pixels on the sensor image should be ignored.

Inheritance

object

ExclusionMask

Implements

ICloneable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: JoeScan.Pinchot

Assembly: JoeScan.Pinchot.dll

Syntax

public class ExclusionMask : ICloneable

Properties

Height

The height of the exclusion mask.

Declaration

public uint Height { get; }

Property Value

Type	Description
uint

this[int]

Gets or sets the pixel.

Declaration

public bool this[int pixel] { get; set; }

Parameters

Type	Name	Description
int	pixel	The pixel to get or set.

Property Value

Type	Description
bool	true if the pixel is excluded else false.

Width

The width of the exclusion mask.

Declaration

public uint Width { get; }

Property Value

Type	Description
uint

Methods

Clone()

Returns a clone of this object. Changes to the original object will not reflect in the cloned object.

Declaration

public object Clone()

Returns

Type	Description
object	A clone of this object.

GetMask()

Gets the exclusion mask as a byte array.

Declaration

public byte[] GetMask()

Returns

Type	Description
byte[]	The mask as an array of bytes. Each byte cooresponds to eight pixels in the image where a bit value of 1 means the pixel is excluded.

SetPixels(int, int)

Marks all pixels between startPixel and endPixel to be excluded.

Declaration

public void SetPixels(int startPixel, int endPixel)

Parameters

Type	Name	Description
int	startPixel	The starting exclusion pixel.
int	endPixel	The ending exclusion pixel.

Exceptions

Type	Condition
ArgumentException

Implements

ICloneable