OpenImageIO
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | List of all members
ImageBuf::Iterator< BUFT, USERT > Class Template Reference

#include <imagebuf.h>

Inheritance diagram for ImageBuf::Iterator< BUFT, USERT >:
ImageBuf::IteratorBase

Public Member Functions

 Iterator (ImageBuf &ib, WrapMode wrap=WrapDefault)
 
 Iterator (ImageBuf &ib, int x, int y, int z=0, WrapMode wrap=WrapDefault)
 
 Iterator (ImageBuf &ib, const ROI &roi, WrapMode wrap=WrapDefault)
 Construct read-write iteration region from ImageBuf and ROI.
 
 Iterator (ImageBuf &ib, int xbegin, int xend, int ybegin, int yend, int zbegin=0, int zend=1, WrapMode wrap=WrapDefault)
 
 Iterator (Iterator &i)
 
const Iteratoroperator= (const Iterator &i)
 
DataArrayProxy< BUFT, USERT > & operator* ()
 
USERT operator[] (int i) const
 
DataProxy< BUFT, USERT > operator[] (int i)
 
void * rawptr () const
 
USERT deep_value (int c, int s) const
 Retrieve the deep data value of sample s of channel c.
 
- Public Member Functions inherited from ImageBuf::IteratorBase
 IteratorBase (const ImageBuf &ib, WrapMode wrap)
 
 IteratorBase (const ImageBuf &ib, const ROI &roi, WrapMode wrap)
 Construct valid iteration region from ImageBuf and ROI.
 
 IteratorBase (const ImageBuf &ib, int xbegin, int xend, int ybegin, int yend, int zbegin, int zend, WrapMode wrap)
 
 IteratorBase (const IteratorBase &i)
 
const IteratorBaseassign_base (const IteratorBase &i)
 
int x () const
 
int y () const
 
int z () const
 
bool valid () const
 Is the current location within the designated iteration range?
 
bool valid (int x_, int y_, int z_=0) const
 
bool exists (int x_, int y_, int z_=0) const
 
bool exists () const
 
bool done () const
 Are we finished iterating over the region?
 
int deep_samples ()
 Retrieve the number of deep data samples at this pixel.
 
WrapMode wrap () const
 Return the wrap mode.
 
void pos (int x_, int y_, int z_=0)
 
void operator++ ()
 
void operator++ (int)
 
ROI range () const
 Return the iteration range.
 

Additional Inherited Members

- Protected Member Functions inherited from ImageBuf::IteratorBase
void init_ib (WrapMode wrap)
 
void range_is_image ()
 
void pos_xincr ()
 
- Protected Attributes inherited from ImageBuf::IteratorBase
const ImageBufm_ib
 
bool m_valid
 
bool m_exists
 
bool m_deep
 
bool m_localpixels
 
int m_img_xbegin
 
int m_img_xend
 
int m_img_ybegin
 
int m_img_yend
 
int m_img_zbegin
 
int m_img_zend
 
int m_rng_xbegin
 
int m_rng_xend
 
int m_rng_ybegin
 
int m_rng_yend
 
int m_rng_zbegin
 
int m_rng_zend
 
int m_x
 
int m_y
 
int m_z
 
ImageCache::Tile * m_tile
 
int m_tilexbegin
 
int m_tileybegin
 
int m_tilezbegin
 
int m_tilexend
 
int m_nchannels
 
size_t m_pixel_bytes
 
char * m_proxydata
 
WrapMode m_wrap
 

Detailed Description

template<typename BUFT, typename USERT = float>
class ImageBuf::Iterator< BUFT, USERT >

Templated class for referring to an individual pixel in an ImageBuf, iterating over the pixels of an ImageBuf, or iterating over the pixels of a specified region of the ImageBuf [xbegin..xend) X [ybegin..yend). It is templated on BUFT, the type known to be in the internal representation of the ImageBuf, and USERT, the type that the user wants to retrieve or set the data (defaulting to float). the whole idea is to allow this:

ImageBuf img (...);
ImageBuf::Iterator<float> pixel (img, 0, 512, 0, 512);
for ( ; ! pixel.done(); ++pixel) {
for (int c = 0; c < img.nchannels(); ++c) {
float x = pixel[c];
pixel[c] = ...;
}
}

Constructor & Destructor Documentation

template<typename BUFT, typename USERT = float>
ImageBuf::Iterator< BUFT, USERT >::Iterator ( ImageBuf ib,
WrapMode  wrap = WrapDefault 
)
inline

Construct from just an ImageBuf – iterate over the whole region, starting with the upper left pixel of the region.

template<typename BUFT, typename USERT = float>
ImageBuf::Iterator< BUFT, USERT >::Iterator ( ImageBuf ib,
int  x,
int  y,
int  z = 0,
WrapMode  wrap = WrapDefault 
)
inline

Construct from an ImageBuf and a specific pixel index. The iteration range is the full image.

template<typename BUFT, typename USERT = float>
ImageBuf::Iterator< BUFT, USERT >::Iterator ( ImageBuf ib,
const ROI roi,
WrapMode  wrap = WrapDefault 
)
inline

Construct read-write iteration region from ImageBuf and ROI.

template<typename BUFT, typename USERT = float>
ImageBuf::Iterator< BUFT, USERT >::Iterator ( ImageBuf ib,
int  xbegin,
int  xend,
int  ybegin,
int  yend,
int  zbegin = 0,
int  zend = 1,
WrapMode  wrap = WrapDefault 
)
inline

Construct from an ImageBuf and designated region – iterate over region, starting with the upper left pixel.

template<typename BUFT, typename USERT = float>
ImageBuf::Iterator< BUFT, USERT >::Iterator ( Iterator< BUFT, USERT > &  i)
inline

Copy constructor.

Member Function Documentation

template<typename BUFT, typename USERT = float>
USERT ImageBuf::Iterator< BUFT, USERT >::deep_value ( int  c,
int  s 
) const
inline

Retrieve the deep data value of sample s of channel c.

template<typename BUFT, typename USERT = float>
DataArrayProxy<BUFT,USERT>& ImageBuf::Iterator< BUFT, USERT >::operator* ( )
inline

Dereferencing the iterator gives us a proxy for the pixel, which we can index for reading or assignment.

template<typename BUFT, typename USERT = float>
const Iterator& ImageBuf::Iterator< BUFT, USERT >::operator= ( const Iterator< BUFT, USERT > &  i)
inline

Assign one Iterator to another

template<typename BUFT, typename USERT = float>
USERT ImageBuf::Iterator< BUFT, USERT >::operator[] ( int  i) const
inline

Array indexing retrieves the value of the i-th channel of the current pixel.

template<typename BUFT, typename USERT = float>
DataProxy<BUFT,USERT> ImageBuf::Iterator< BUFT, USERT >::operator[] ( int  i)
inline

Array referencing retrieve a proxy (which may be "assigned to") of i-th channel of the current pixel, so that this works: me[i] = val;


The documentation for this class was generated from the following file: