BinningFactor Class Reference

Inheritance diagram for BinningFactor:

Public Member Functions
	BinningFactor ()
	Initializes a new instance of the BinningFactor class with default binning factors.
	BinningFactor (uint x, uint y)
	Initializes a new instance of the BinningFactor class with the specified binning factors for x and y directions.
override bool	Equals (object? obj)
	Determines whether the specified object is equal to the current PointT<T>.
override int	GetHashCode ()
	Returns a hash code for the current point.
override string	ToString ()
	Converts the PointT<T> to a string representation.

Properties
T	X [get]
	Gets the X coordinate of the point.
T	Y [get]
	Gets the Y coordinate of the point.

Detailed Description

The binning factor for the x and y directions must consist of positive integer values.

A binning value of 2 indicates that the values of the two lines are combined into one line.

Since

IDSImaging.Peak.ICV 1.3

Constructor & Destructor Documentation

BinningFactor() [1/2]

BinningFactor ( )

inline

Initializes a new instance of the BinningFactor class with default binning factors.

The default binning factor for both x and y directions is 1.

Since

IDSImaging.Peak.ICV 1.3

BinningFactor() [2/2]

BinningFactor ( uint x, uint y )

inline

Initializes a new instance of the BinningFactor class with the specified binning factors for x and y directions.

Parameters

x	The binning factor for the x direction
y	The binning factor for the y direction

Exceptions

IcvOutOfRangeException

One or more of the given values are invalid. Binning Factor values have to be bigger than zero.

Since

IDSImaging.Peak.ICV 1.3

Member Function Documentation

Equals()

override bool Equals ( object? obj )

inlineinherited

Determines whether the specified object is equal to the current PointT<T>.

Parameters

obj	The object to compare with the current point.

Returns

true if the objects are equal; otherwise, false.

GetHashCode()

override int GetHashCode ( )

inlineinherited

Returns a hash code for the current point.

ToString()

override string ToString ( )

inlineinherited

Converts the PointT<T> to a string representation.

Returns

A string representing of the point.

Property Documentation

X

T X	getinherited

Gets the X coordinate of the point.

Y

T Y	getinherited

Gets the Y coordinate of the point.