Basic implementation of the multi-planar image interface.
More...
#include <MultiImage.h>
Basic implementation of the multi-planar image interface.
Definition at line 41 of file MultiImage.h.
Allocated a previously initialised multi image.
- Note
- The multi image must not already be allocated when calling this function.
void create_subimage |
( |
MultiImage * |
image, |
|
|
const Coordinates & |
coords, |
|
|
unsigned int |
width, |
|
|
unsigned int |
height |
|
) |
| |
Create a subimage from an existing MultiImage.
- Parameters
-
[in] | image | Image to use backing memory from |
[in] | coords | Starting coordinates of the new image. Should be within the parent image sizes |
[in] | width | The width of the subimage |
[in] | height | The height of the subimage |
Interface to be implemented by the child class to return the multi-planar image's metadata.
- Returns
- A pointer to the image's metadata.
Implements IMultiImage.
void init |
( |
unsigned int |
width, |
|
|
unsigned int |
height, |
|
|
Format |
format |
|
) |
| |
Allocate the multi-planar image.
- Parameters
-
[in] | width | Width of the whole image |
[in] | height | Height of the whole image |
[in] | format | Format of the whole image |
void init_auto_padding |
( |
unsigned int |
width, |
|
|
unsigned int |
height, |
|
|
Format |
format |
|
) |
| |
Allocate the multi-planar image.
- Note
- Uses conservative padding strategy which fits all kernels.
- Parameters
-
[in] | width | Width of the whole image |
[in] | height | Height of the whole image |
[in] | format | Format of the whole image |
Image* plane |
( |
unsigned int |
index | ) |
|
|
overridevirtual |
Return a pointer to the requested plane of the image.
- Parameters
-
[in] | index | The index of the wanted planed. |
- Returns
- A pointer pointed to the plane
Implements IMultiImage.
const Image* plane |
( |
unsigned int |
index | ) |
const |
|
overridevirtual |
Return a constant pointer to the requested plane of the image.
- Parameters
-
[in] | index | The index of the wanted planed. |
- Returns
- A constant pointer pointed to the plane
Implements IMultiImage.
The documentation for this class was generated from the following file: