Histogram Class Reference

A single histogram result. More...

Public Member Functions
int	IndexOf (long count)
	Gets the index of the first found count .
void	Insert (int index, long count)
	Not supported as the histogram is read-only.
void	RemoveAt (int index)
	Not supported as the histogram is read-only.
void	Add (long count)
	Not supported as the histogram is read-only.
void	Clear ()
	Not supported as the histogram is read-only.
bool	Contains (long count)
	Gets whether the count is inside this histogram.
void	CopyTo (long[] array, int arrayIndex)
	Copies the elements of this histogram to the given array starting at arrayIndex .
bool	Remove (long count)
	Not supported as the histogram is read-only.
IEnumerator< long >	GetEnumerator ()
	Gets the enumerator enumerating this histogram.

Properties
long	NumPixels [get]
	Total number of pixels taken into account.
long	Median [get]
	The median (gray value at which roughly 50% of the pixels are darker and 50% of the pixels are brighter than this gray value).
double	Mean [get]
	Mean value of all pixels.
double	Mode [get]
	Gets the mode (the most common gray value) of the histogram.
double	Min [get]
	Get the minimum gray value of the histogram.
double	Max [get]
	Get the maximum gray value of the histogram.
double	Variance [get]
	Get the variance of the histogram.
double	StandardDeviation [get]
	Get the standard deviation of the histogram.
int	Count [get]
	Gets the number of elements in this histogram.
long	this[int i] [get]
	The indexer for accessing the histogram data itself.
bool	IsReadOnly [get]
	The histogram data is read-only.

Detailed Description

A single histogram result.

Member Function Documentation

Add()

void Add

(

long

count

)

Not supported as the histogram is read-only.

Parameters

count

Ignored.

Exceptions

InvalidOperationException

Always thrown as this is a read-only collection.

Clear()

void Clear

(

)

Not supported as the histogram is read-only.

Exceptions

InvalidOperationException

Always thrown as this is a read-only collection.

Contains()

bool Contains

(

long

count

)

Gets whether the count is inside this histogram.

Parameters

count

Numeric count of gray value to test.

Returns

true if the count is present; false if not.

CopyTo()

void CopyTo	(	long[]	array,
		int	arrayIndex )

Copies the elements of this histogram to the given array starting at arrayIndex .

Parameters

array	Destination array.
arrayIndex	Zero based index in array at which copying begins.

GetEnumerator()

IEnumerator< long > GetEnumerator

(

)

Gets the enumerator enumerating this histogram.

Returns

The enumerator.

IndexOf()

int IndexOf

(

long

count

)

Gets the index of the first found count .

Parameters

count

Count of gray value to find.

Returns

Index of count ; negative if not found.

Insert()

void Insert	(	int	index,
		long	count )

Not supported as the histogram is read-only.

Parameters

index	Ignored.
count	Ignored.

Exceptions

InvalidOperationException

Always thrown as this is a read-only collection.

Remove()

bool Remove

(

long

count

)

Not supported as the histogram is read-only.

Parameters

count

Ignored.

Returns

Nothing.

Exceptions

InvalidOperationException

Always thrown as this is a read-only collection.

RemoveAt()

void RemoveAt

(

int

index

)

Not supported as the histogram is read-only.

Parameters

index

Ignored.

Exceptions

InvalidOperationException

Always thrown as this is a read-only collection.

Property Documentation

Count

int Count

get

Gets the number of elements in this histogram.

The number of elements corresponds to the number of possible gray values.