QgsRasterIterator Class Reference

Iterator for sequentially processing raster cells. More...

#include <qgsrasteriterator.h>

Public Member Functions
	QgsRasterIterator (QgsRasterInterface *input)
const QgsRasterInterface *	input () const
int	maximumTileHeight () const
int	maximumTileWidth () const
bool	readNextRasterPart (int bandNumber, int &nCols, int &nRows, QgsRasterBlock **block, int &topLeftCol, int &topLeftRow)
	Fetches next part of raster data, caller takes ownership of the block and caller should delete the block. More...
void	setMaximumTileHeight (int h)
void	setMaximumTileWidth (int w)
void	startRasterRead (int bandNumber, int nCols, int nRows, const QgsRectangle &extent, QgsRasterBlockFeedback *feedback=nullptr)
	Start reading of raster band. More...
void	stopRasterRead (int bandNumber)

Static Public Attributes
static const int	DEFAULT_MAXIMUM_TILE_HEIGHT = 2000
static const int	DEFAULT_MAXIMUM_TILE_WIDTH = 2000

Detailed Description

Iterator for sequentially processing raster cells.

Definition at line 33 of file qgsrasteriterator.h.

Constructor & Destructor Documentation

QgsRasterIterator()

QgsRasterIterator::QgsRasterIterator

(

QgsRasterInterface *

input

)

Definition at line 21 of file qgsrasteriterator.cpp.

Member Function Documentation

input()

const QgsRasterInterface* QgsRasterIterator::input ( ) const

inline

Definition at line 66 of file qgsrasteriterator.h.

maximumTileHeight()

int QgsRasterIterator::maximumTileHeight ( ) const

inline

Definition at line 72 of file qgsrasteriterator.h.

maximumTileWidth()

int QgsRasterIterator::maximumTileWidth ( ) const

inline

Definition at line 69 of file qgsrasteriterator.h.

readNextRasterPart()

bool QgsRasterIterator::readNextRasterPart	(	int	bandNumber,
		int &	nCols,
		int &	nRows,
		QgsRasterBlock **	block,
		int &	topLeftCol,
		int &	topLeftRow
	)

Fetches next part of raster data, caller takes ownership of the block and caller should delete the block.

Parameters

bandNumber	band to read
nCols	number of columns on output device
nRows	number of rows on output device
block	address of block pointer
topLeftCol	top left column
topLeftRow	top left row

Returns

false if the last part was already returned

Definition at line 61 of file qgsrasteriterator.cpp.

setMaximumTileHeight()

void QgsRasterIterator::setMaximumTileHeight ( int  h )

inline

Definition at line 71 of file qgsrasteriterator.h.

setMaximumTileWidth()

void QgsRasterIterator::setMaximumTileWidth ( int  w )

inline

Definition at line 68 of file qgsrasteriterator.h.

startRasterRead()

void QgsRasterIterator::startRasterRead	(	int	bandNumber,
		int	nCols,
		int	nRows,
		const QgsRectangle &	extent,
		QgsRasterBlockFeedback *	feedback = nullptr
	)

Start reading of raster band.

Raster data can then be retrieved by calling readNextRasterPart until it returns false.

Parameters

bandNumber	number of raster band to read
nCols	number of columns
nRows	number of rows
extent	area to read
feedback	optional raster feedback object for cancelation/preview. Added in QGIS 3.0.

Definition at line 38 of file qgsrasteriterator.cpp.

stopRasterRead()

void QgsRasterIterator::stopRasterRead

(

int

bandNumber

)

Definition at line 126 of file qgsrasteriterator.cpp.

Member Data Documentation

DEFAULT_MAXIMUM_TILE_HEIGHT

const int QgsRasterIterator::DEFAULT_MAXIMUM_TILE_HEIGHT = 2000

static

Definition at line 75 of file qgsrasteriterator.h.

DEFAULT_MAXIMUM_TILE_WIDTH

const int QgsRasterIterator::DEFAULT_MAXIMUM_TILE_WIDTH = 2000

static

Definition at line 74 of file qgsrasteriterator.h.

---

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

• /tmp/buildd/qgis-3.0.2+14stretch/src/core/raster/qgsrasteriterator.h
• /tmp/buildd/qgis-3.0.2+14stretch/src/core/raster/qgsrasteriterator.cpp