[ VIGRA Homepage |
Class Index |
Function Index |
File Index |
Main Page ]
|
BasicImageView Class Template Reference
|
 |
BasicImage using foreign memory.
More...
#include "vigra/basicimageview.hxx"
template<class PIXELTYPE>
class vigra::BasicImageView< PIXELTYPE >
BasicImage using foreign memory.
This class provides the same interface as vigra::BasicImage (with the exception of resize()
) but the image's memory is provided from the outside instead of allocated internally.
A BasicImageView
can also be created from a vigra::MultiArrayView with the appropriate shape -- see Wrap a \ref vigra::MultiArrayView in.
#include "vigra/basicimageview.hxx"
Namespace: vigra
Member Typedef Documentation
typedef PIXELTYPE const* const_iterator
|
|
|
the BasicImageView's 1D random access const iterator (note: lower case 'const_iterator' is a STL compatible 1D random access const iterator) |
typedef PIXELTYPE const* const_pointer
|
|
typedef PIXELTYPE const& const_reference
|
|
|
the BasicImageView's const reference type (i.e. the return type of image[diff] and image(dx,dy) when image is const) |
|
the BasicImageView's 2D random access const iterator ('const traverser') |
|
deprecated, use const_traverser instead |
typedef PIXELTYPE const* ConstScanOrderIterator
|
|
|
deprecated, use const_iterator instead |
typedef Diff2D difference_type
|
|
|
deprecated, use traverser instead |
typedef PIXELTYPE* iterator
|
|
|
the BasicImageView's 1D random access iterator (note: lower case 'iterator' is a STL compatible 1D random access iterator, don't confuse with capitalized Iterator) |
typedef PIXELTYPE PixelType
|
|
typedef PIXELTYPE* pointer
|
|
typedef PIXELTYPE& reference
|
|
|
the BasicImageView's reference type (i.e. the return type of image[diff] and image(dx,dy)) |
typedef PIXELTYPE* ScanOrderIterator
|
|
|
deprecated, use iterator instead |
typedef PIXELTYPE value_type
|
|
Constructor & Destructor Documentation
BasicImageView |
( |
|
) |
[inline] |
|
|
construct image of size 0x0 |
BasicImageView |
( |
const_pointer |
data, |
|
|
int |
w, |
|
|
int |
h, |
|
|
int |
stride = 0 |
|
) |
[inline] |
|
|
construct view of size w x h |
|
construct view of size size.x x size.y |
Member Function Documentation
|
return default const accessor |
|
init 1D random access const iterator pointing to first pixel. Note: Only works if stride equals width. |
|
init 1D random access iterator pointing to first pixel. Note: Only works if stride equals width. |
|
init 1D random access const iterator pointing past the end. Note: Only works if stride equals width. |
|
init 1D random access iterator pointing past the end. Note: Only works if stride equals width. |
int height |
( |
|
) |
const [inline] |
|
BasicImageView& init |
( |
value_type const & |
pixel |
) |
[inline] |
|
|
set Image with const value |
|
test whether a given coordinate is inside the image |
|
init 2D random access const iterator poining to pixel(width, height), i.e. one pixel right and below lower right corner of the image as is common in C/C++. |
|
init 2D random access iterator poining to pixel(width, height), i.e. one pixel right and below lower right corner of the image as is common in C/C++. |
|
read pixel at given location.
usage: value_type value = image(1,2) |
reference operator() |
( |
int |
dx, |
|
|
int |
dy |
|
) |
[inline] |
|
|
access pixel at given location.
usage: value_type value = image(1,2) |
|
read pixel at given location. Note that the 'x' index is the trailing index.
usage: value_type value = image[2][1] |
pointer operator[] |
( |
int |
dy |
) |
[inline] |
|
|
access pixel at given location. Note that the 'x' index is the trailing index.
usage: value_type value = image[2][1] |
|
read pixel at given location.
usage: value_type value = image[Diff2D(1,2)] |
|
access pixel at given location.
usage: value_type value = image[Diff2D(1,2)] |
int stride |
( |
|
) |
const [inline] |
|
|
stride of Image. Memory offset between the start of two successive rows. |
|
init 2D random access const iterator poining to upper left pixel |
|
init 2D random access iterator poining to upper left pixel |
int width |
( |
|
) |
const [inline] |
|
The documentation for this class was generated from the following file: