Class JoeScan::Pinchot::ExclusionMask

ClassList > JoeScan > Pinchot > ExclusionMask

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

Inherits the following classes: ICloneable

Public Properties

Type	Name
property uint	Height The height of the exclusion mask.
property uint	Width The width of the exclusion mask.
property bool	this[int pixel] Gets or sets the pixel .

Public Functions

Type	Name
object	Clone () Returns a clone of this object. Changes to the original object will not reflect in the cloned object.
byte[]	GetMask () Gets the exclusion mask as a byte array.
void	SetPixels (int startPixel, int endPixel) Marks all pixels between startPixel and__endPixel to be excluded.

Public Properties Documentation

property Height

uint Height;

---

property Width

uint Width;

---

property this[int pixel]

Gets or sets the pixel .

bool this[int pixel];

Parameters:

• pixel The pixel to get or set.

Returns:

true if the pixel is excluded else false.

---

Public Functions Documentation

function Clone

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

inline object JoeScan::Pinchot::ExclusionMask::Clone () 

Returns:

A clone of this object.

---

function GetMask

Gets the exclusion mask as a byte array.

inline byte[] JoeScan::Pinchot::ExclusionMask::GetMask () 

Returns:

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.

---

function SetPixels

Marks all pixels between startPixel and__endPixel to be excluded.

inline void JoeScan::Pinchot::ExclusionMask::SetPixels (
    int startPixel,
    int endPixel
) 

Parameters:

• startPixel The starting exclusion pixel.
• endPixel The ending exclusion pixel.

Exception:

• ArgumentException

---

---