Collection of plane informations.
More...
Inherits InfoCollection< TParent, TInfo >.
|
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.
|
|
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.
|
|
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.
|
|
TInfo[] | ToArray () |
| Converts this collection into an array.
|
|
|
override ImagePlane | GetInfo (int index) |
| Retrieval function for plane information.
|
|
override int | GetCount () |
| Retrieval function for plane count information.
|
|
| InfoCollection (TParent parent) |
| Constructor.
|
|
int | GetCount () |
| Function with which the collection queries the number of elements.
|
|
TInfo | GetInfo (int index) |
| Function with which the collection retrieves the information object with the given index.
|
|
|
ImagePlane | this[int index] [get] |
| Indexed access to the individual plane information.
|
|
bool | DataTypesIdentical [get] |
| True if all image infos in this collection have the same data type, false otherwise.
|
|
int | Count [get] |
| Number of elements in the collection.
|
|
|
readonly TParent | Parent |
| Parent image reference helps keeping track of the lifetime and provides the information basis for index access.
|
|
Collection of plane informations.
◆ GetCount()
override int GetCount |
( |
| ) |
|
|
protected |
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 |
◆ GetInfo()
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 |
◆ Map() [1/3]
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]
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]
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[ |
◆ DataTypesIdentical
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]
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 |