ImagePlaneCollection Class Reference

Collection of plane informations. More...

Inherits InfoCollection< Image, ImagePlane >, and IEnumerable< ImagePlane >.

Public Member Functions
MappedImage	Map ()
	Creates a mapped image of this image, containing all of the original image planes. The mapped image will share its memory with the input planes. More...
MappedImage	Map (params int[] indices)
	Creates a mapped image of this image, containing only a subset of the original image planes. The mapped image will share its memory with the input planes. More...
MappedImage	Map (IEnumerable< int > indices)
	Creates a mapped image of this image, containing only a subset of the original image planes. The mapped image will share its memory with the input planes. More...
Public Member Functions inherited from InfoCollection< Image, ImagePlane >
TInfo[]	ToArray ()
	Converts this collection into an array. More...

Protected Member Functions
override ImagePlane	GetInfo (int index)
	Retrieval function for plane information. More...
override int	GetCount ()
	Retrieval function for plane count information. More...
Protected Member Functions inherited from InfoCollection< Image, ImagePlane >
	InfoCollection (TParent parent)
	Constructor. More...
abstract int	GetCount ()
	Function with which the collection queries the number of elements More...
abstract TInfo	GetInfo (int index)
	Function with which the collection retrieves the information object with the given index. More...

Properties
ImagePlane	this[int index] [get]
	Indexed access to the individual plane information. More...
bool	DataTypesIdentical [get]
	True if all image infos in this collection have the same data type, false otherwise. More...
Properties inherited from InfoCollection< Image, ImagePlane >
int	Count [get]
	Number of elements in the collection. More...

Additional Inherited Members
Protected Attributes inherited from InfoCollection< Image, ImagePlane >
readonly TParent	Parent
	Parent image reference helps keeping track of the lifetime and provides the information basis for index access

Detailed Description

Collection of plane informations.

Member Function Documentation

GetCount()

override int GetCount ( )

protectedvirtual

Retrieval function for plane count information.

Returns

Number of infos in the parent image.

Exceptions

ObjectDisposedException

If the parent image has already been disposed of

Implements InfoCollection< Image, ImagePlane >.

GetInfo()

override ImagePlane GetInfo ( int  index )

protectedvirtual

Retrieval function for plane information.

Parameters

index

Index of the block to be retrieved

Returns

Info object

Exceptions

ArgumentOutOfRangeException	If the index is invalid
ObjectDisposedException	If the parent image has already been disposed of

Implements InfoCollection< Image, ImagePlane >.

Map() [1/3]

MappedImage Map

(

)

Creates a mapped image of this image, containing all of the original image planes. The mapped image will share its memory with the input planes.

Returns

Mapped image.

Map() [2/3]

MappedImage Map

(

IEnumerable< int >

indices

)

Creates a mapped image of this image, containing only a subset of the original image planes. The mapped image will share its memory with the input planes.

Parameters

indices

Indices of the planes to map into the new image.

Returns

Mapped image.

Exceptions

ArgumentNullException	If the indices enumeration is null.
ArgumentOutOfRangeException	If one of the indices is outside the range [0...num planes[

Map() [3/3]

MappedImage Map

(

params int[]

indices

)

Creates a mapped image of this image, containing only a subset of the original image planes. The mapped image will share its memory with the input planes.

Parameters

indices

Indices of the planes to map into the new image.

Returns

Mapped image.

Exceptions

ArgumentNullException	If the indices enumeration is null.
ArgumentOutOfRangeException	If one of the indices is outside the range [0...num planes[

Property Documentation

DataTypesIdentical

bool DataTypesIdentical

get

True if all image infos in this collection have the same data type, false otherwise.

Exceptions

ObjectDisposedException

If the parent image has already been disposed of

this[int index]

ImagePlane this[int index]

get

Indexed access to the individual plane information.

Parameters

index

Index of the plane to be accessed

Returns

Plane information object

Exceptions

ArgumentOutOfRangeException	If the index is invalid
ObjectDisposedException	If the parent image has already been disposed of