DataType Struct Reference

Data type description for a Image plane. More...

Public Member Functions
override bool	Equals (object obj)
	Comparison function.
override int	GetHashCode ()
	Hash code.
override string	ToString ()
	Gets a string representation of this data type.

Static Public Member Functions
static DataType	FromUnmanagedDescriptor (Int32 dataTypeDescriptor)
	Construct a data type descriptor from one of the native library's unmanaged descriptor values.
static bool	operator== (DataType lhs, DataType rhs)
	Comparison operator for DataType objects.
static bool	operator!= (DataType lhs, DataType rhs)
	Comparison operator for DataType objects.

Properties
int	BitsPerPixel [get]
	Number of actually valid bits per pixel.
int	BytesPerPixel [get]
	Number of bytes that each pixel occupies.
bool	IsFloat [get]
	Gets whether the plane's pixels have floating point values.
bool	IsSignedInteger [get]
	Gets whether the plane's pixels have signed integer values.
bool	IsUnsignedInteger [get]
	Gets whether the plane's pixels have unsigned integer values.
bool	HasOverlayBit [get]
	Gets whether bit 0 of the plane's pixels is being used as an overlay indicator bit.
bool	IsComplexPacked [get]
	Indicates whether or not the plane contains a complex packed image format that makes use of the hermitian symmetries in images resulting from Fourier transformation of a real-valued image.
double	MinVal [get]
	Minimum pixel value that fits this data type.
double	MaxVal [get]
	Maximum pixel value that fits this data type.
PixelDataType	NumericType [get]
	Returns the basic numeric type of the pixels.
Type	ClrType [get]
	Returns a type object that indicates the appropriate CLR type (where applicable) in which to store pixels of the given data type or null if no appropriate CLR type exists.
double	UndefinedVal [get]
	Pixel value for those pixels whose value cannot be defined properly e.g. where in scanning situations pixels outside the image are accessed.
Int32	NativeDescriptor [get]
	Native data type value.

Detailed Description

Data type description for a Image plane.

Member Function Documentation

Equals()

override bool Equals

(

object

obj

)

Comparison function.

Parameters

obj	Object to compare to

Returns

true if obj == this, false otherwise

FromUnmanagedDescriptor()

static DataType FromUnmanagedDescriptor ( Int32 dataTypeDescriptor )

static

Construct a data type descriptor from one of the native library's unmanaged descriptor values.

Parameters

dataTypeDescriptor

Unmanaged descriptor value.

Returns

Data type descriptor object.

GetHashCode()

override int GetHashCode

(

)

Hash code.

Returns

Hash code

operator!=()

static bool operator!= ( DataType lhs, DataType rhs )

static

Comparison operator for DataType objects.

Parameters

lhs	Left hand side object
rhs	Right hand side object

Returns

false if the left hand side object and the right hand side object are identical, true otherwise

operator==()

static bool operator== ( DataType lhs, DataType rhs )

static

Comparison operator for DataType objects.

Parameters

lhs	Left hand side object
rhs	Right hand side object

Returns

true if the left hand side object and the right hand side object are identical, false otherwise

ToString()

override string ToString

(

)

Gets a string representation of this data type.

The following prefixes are available:

f

Floating point image.

s

Signed integer image.

cp

Complex packed image. If no prefix is displayed it is an unsigned integer image. The postfix '(o)' means that the image uses an overlay bit.

Returns

Short string representation of the data type.

Property Documentation

HasOverlayBit

bool HasOverlayBit

get

Gets whether bit 0 of the plane's pixels is being used as an overlay indicator bit.

true/false

IsComplexPacked

bool IsComplexPacked

get

Indicates whether or not the plane contains a complex packed image format that makes use of the hermitian symmetries in images resulting from Fourier transformation of a real-valued image.

Image infos of this type are usually not usable directly.

true/false

IsFloat

bool IsFloat

get

Gets whether the plane's pixels have floating point values.

true/false

IsSignedInteger

bool IsSignedInteger

get

Gets whether the plane's pixels have signed integer values.

true/false