QGIS API Documentation 3.41.0-Master (181b2f43d8e)
Loading...
Searching...
No Matches
qgsrasteriterator.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsrasteriterator.h
3 ---------------------
4 begin : July 2012
5 copyright : (C) 2012 by Marco Hugentobler
6 email : marco dot hugentobler at sourcepole dot ch
7 ***************************************************************************
8 * *
9 * This program is free software; you can redistribute it and/or modify *
10 * it under the terms of the GNU General Public License as published by *
11 * the Free Software Foundation; either version 2 of the License, or *
12 * (at your option) any later version. *
13 * *
14 ***************************************************************************/
15#ifndef QGSRASTERITERATOR_H
16#define QGSRASTERITERATOR_H
17
18#include "qgis_core.h"
19#include "qgsrectangle.h"
20#include "qgis_sip.h"
21#include <QMap>
22
23class QgsMapToPixel;
24class QgsRasterBlock;
29
34class CORE_EXPORT QgsRasterIterator
35{
36 public:
37
43 QgsRasterIterator( QgsRasterInterface *input, int tileOverlapPixels = 0 );
44
62 static QgsRectangle subRegion( const QgsRectangle &rasterExtent, int rasterWidth, int rasterHeight, const QgsRectangle &subRegion, int &subRegionWidth SIP_OUT, int &subRegionHeight SIP_OUT, int &subRegionLeft SIP_OUT, int &subRegionTop SIP_OUT );
63
72 void startRasterRead( int bandNumber, qgssize nCols, qgssize nRows, const QgsRectangle &extent, QgsRasterBlockFeedback *feedback = nullptr );
73
93 bool next( int bandNumber, int &columns SIP_OUT, int &rows SIP_OUT, int &topLeftColumn SIP_OUT, int &topLeftRow SIP_OUT, QgsRectangle &blockExtent SIP_OUT );
94
106 bool readNextRasterPart( int bandNumber,
107 int &nCols, int &nRows,
109 int &topLeftCol, int &topLeftRow );
110
128 bool readNextRasterPart( int bandNumber,
129 int &nCols, int &nRows,
130 std::unique_ptr< QgsRasterBlock > &block,
131 int &topLeftCol, int &topLeftRow,
132 QgsRectangle *blockExtent = nullptr,
133 int *tileColumns = nullptr, int *tileRows = nullptr, int *tileTopLeftColumn = nullptr, int *tileTopLeftRow = nullptr ) SIP_SKIP;
134
138 void stopRasterRead( int bandNumber );
139
143 const QgsRasterInterface *input() const { return mInput; }
144
150 void setMaximumTileWidth( int w ) { mMaximumTileWidth = w; }
151
157 int maximumTileWidth() const { return mMaximumTileWidth; }
158
164 void setMaximumTileHeight( int h ) { mMaximumTileHeight = h; }
165
171 int maximumTileHeight() const { return mMaximumTileHeight; }
172
180 int blockCountWidth() const { return mNumberBlocksWidth; }
181
189 int blockCountHeight() const { return mNumberBlocksWidth; }
190
198 qgssize blockCount() const { return static_cast< qgssize >( mNumberBlocksHeight ) * mNumberBlocksWidth; }
199
205 double progress( int bandNumber ) const;
206
208 static const int DEFAULT_MAXIMUM_TILE_WIDTH = 2000;
209
211 static const int DEFAULT_MAXIMUM_TILE_HEIGHT = 2000;
212
213 private:
214 //Stores information about reading of a raster band. Columns and rows are in unsampled coordinates
215 struct RasterPartInfo
216 {
217 qgssize currentCol;
218 qgssize currentRow;
219 qgssize nCols;
220 qgssize nRows;
221 };
222
223 QgsRasterInterface *mInput = nullptr;
224 QMap<int, RasterPartInfo> mRasterPartInfos;
225 QgsRectangle mExtent;
226 QgsRasterBlockFeedback *mFeedback = nullptr;
227
228 int mTileOverlapPixels = 0;
229 int mMaximumTileWidth;
230 int mMaximumTileHeight;
231
232 int mNumberBlocksWidth = 0;
233 int mNumberBlocksHeight = 0;
234
236 void removePartInfo( int bandNumber );
237 bool readNextRasterPartInternal( int bandNumber, int &nCols, int &nRows, std::unique_ptr<QgsRasterBlock> *block, int &topLeftCol, int &topLeftRow, QgsRectangle *blockExtent, int &tileColumns, int &tileRows, int &tileTopLeftColumn, int &tileTopLeftRow );
238};
239
240#endif // QGSRASTERITERATOR_H
Perform transforms between map coordinates and device coordinates.
Feedback object tailored for raster block reading.
Raster data container.
Base class for processing filters like renderers, reprojector, resampler etc.
Iterator for sequentially processing raster cells.
qgssize blockCount() const
Returns the total number of blocks required to iterate over the input raster.
int maximumTileWidth() const
Returns the maximum tile width returned during iteration.
const QgsRasterInterface * input() const
Returns the input raster interface which is being iterated over.
void setMaximumTileWidth(int w)
Sets the maximum tile width returned during iteration.
int blockCountWidth() const
Returns the total number of blocks which cover the width of the input raster.
int blockCountHeight() const
Returns the total number of blocks which cover the height of the input raster.
int maximumTileHeight() const
Returns the minimum tile width returned during iteration.
void setMaximumTileHeight(int h)
Sets the minimum tile height returned during iteration.
Implements approximate projection support for optimised raster transformation.
A rectangle specified with double values.
unsigned long long qgssize
Qgssize is used instead of size_t, because size_t is stdlib type, unknown by SIP, and it would be har...
Definition qgis.h:6572
#define SIP_SKIP
Definition qgis_sip.h:126
#define SIP_OUT
Definition qgis_sip.h:58
#define SIP_TRANSFERBACK
Definition qgis_sip.h:48
This class provides details of the viewable area that a raster will be rendered into.