QGIS API Documentation 3.34.0-Prizren (ffbdd678812)
Loading...
Searching...
No Matches
qgsalignraster.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsalignraster.h
3 --------------------------------------
4 Date : June 2015
5 Copyright : (C) 2015 by Martin Dobias
6 Email : wonder dot sk at gmail dot com
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
16#ifndef QGSALIGNRASTER_H
17#define QGSALIGNRASTER_H
18
19#include <QList>
20#include <QPointF>
21#include <QSizeF>
22#include <QString>
23#include <gdal_version.h>
24#include "qgis_analysis.h"
25#include "qgis_sip.h"
26#include "qgsogrutils.h"
27#include "qgsalignrasterdata.h"
28
29class QgsRectangle;
30
31typedef void *GDALDatasetH SIP_SKIP;
32
33
45class ANALYSIS_EXPORT QgsAlignRaster
46{
47#ifdef SIP_RUN
48#include <gdal_version.h>
49#endif
50
51 public:
53
55 struct ANALYSIS_EXPORT RasterInfo
56 {
57 public:
59 RasterInfo( const QString &layerpath );
60
61 RasterInfo( const RasterInfo &rh ) = delete;
62 RasterInfo &operator=( const RasterInfo &rh ) = delete;
63
65 bool isValid() const { return nullptr != mDataset; }
66
68 QString crs() const { return mCrsWkt; }
70 QSize rasterSize() const { return QSize( mXSize, mYSize ); }
72 int bandCount() const { return mBandCnt; }
74 QSizeF cellSize() const;
76 QPointF gridOffset() const;
78 QgsRectangle extent() const;
80 QPointF origin() const;
81
83 void dump() const;
84
86 double identify( double mx, double my );
87
88 protected:
92 QString mCrsWkt;
94 double mGeoTransform[6];
96 int mXSize = 0;
98 int mYSize = 0;
100 int mBandCnt = 0;
101
102 private:
103#ifdef SIP_RUN
105#endif
106
107 friend class QgsAlignRaster;
108 };
109
112 typedef QList<QgsAlignRasterData::RasterItem> List;
113
116 {
117
123 virtual bool progress( double complete ) = 0;
124
125 virtual ~ProgressHandler() = default;
126 };
127
129 void setProgressHandler( ProgressHandler *progressHandler ) { mProgressHandler = progressHandler; }
131 ProgressHandler *progressHandler() const { return mProgressHandler; }
132
134 void setRasters( const List &list ) { mRasters = list; }
136 List rasters() const { return mRasters; }
137
138 void setGridOffset( QPointF offset ) { mGridOffsetX = offset.x(); mGridOffsetY = offset.y(); }
139 QPointF gridOffset() const { return QPointF( mGridOffsetX, mGridOffsetY ); }
140
142 void setCellSize( double x, double y ) { setCellSize( QSizeF( x, y ) ); }
144 void setCellSize( QSizeF size ) { mCellSizeX = size.width(); mCellSizeY = size.height(); }
146 QSizeF cellSize() const { return QSizeF( mCellSizeX, mCellSizeY ); }
147
149 void setDestinationCrs( const QString &crsWkt ) { mCrsWkt = crsWkt; }
151 QString destinationCrs() const { return mCrsWkt; }
152
157 void setClipExtent( double xmin, double ymin, double xmax, double ymax );
158
163 void setClipExtent( const QgsRectangle &extent );
164
169 QgsRectangle clipExtent() const;
170
182 bool setParametersFromRaster( const RasterInfo &rasterInfo, const QString &customCRSWkt = QString(), QSizeF customCellSize = QSizeF(), QPointF customGridOffset = QPointF( -1, -1 ) );
183
188 bool setParametersFromRaster( const QString &filename, const QString &customCRSWkt = QString(), QSizeF customCellSize = QSizeF(), QPointF customGridOffset = QPointF( -1, -1 ) );
189
194 bool checkInputParameters();
195
200 QSize alignedRasterSize() const;
201
206 QgsRectangle alignedRasterExtent() const;
207
212 bool run();
213
218 QString errorMessage() const { return mErrorMessage; }
219
221 void dump() const;
222
224 int suggestedReferenceLayer() const;
225
226 protected:
227
229 bool createAndWarp( const Item &raster );
230
232 static bool suggestedWarpOutput( const RasterInfo &info, const QString &destWkt, QSizeF *cellSize = nullptr, QPointF *gridOffset = nullptr, QgsRectangle *rect = nullptr );
233
234 protected:
235
236 // set by the client
237
239 ProgressHandler *mProgressHandler = nullptr;
240
243
246
248 QString mCrsWkt;
250 double mCellSizeX, mCellSizeY;
252 double mGridOffsetX, mGridOffsetY;
253
258 double mClipExtent[4];
259
260 // derived data from other members
261
263 double mGeoTransform[6];
266
269};
270
271#endif // QGSALIGNRASTER_H
GdalResampleAlgorithm
Flags which control how tiled scene 2D renderers behave.
Definition qgis.h:4014
QgsAlignRaster takes one or more raster layers and warps (resamples) them so they have the same:
ProgressHandler * progressHandler() const
Gets associated progress handler. May be nullptr (default)
int mYSize
Computed raster grid height.
QSizeF cellSize() const
Gets output cell size.
QPointF gridOffset() const
double mGridOffsetX
Destination grid offset - expected to be in interval <0,cellsize)
void setCellSize(QSizeF size)
Sets output cell size.
List mRasters
List of rasters to be aligned (with their output files and other options)
void setDestinationCrs(const QString &crsWkt)
Sets the output CRS in WKT format.
void setGridOffset(QPointF offset)
List rasters() const
Gets list of rasters that will be aligned.
QString mCrsWkt
Destination CRS - stored in well-known text (WKT) format.
int mXSize
Computed raster grid width.
QString destinationCrs() const
Gets the output CRS in WKT format.
double mCellSizeX
Destination cell size.
void setProgressHandler(ProgressHandler *progressHandler)
Assign a progress handler instance. Does not take ownership. nullptr can be passed.
QList< QgsAlignRasterData::RasterItem > List
QString errorMessage() const
Returns the error from a previous run() call.
QgsAlignRasterData::RasterItem Item
void setRasters(const List &list)
Sets list of rasters that will be aligned.
void setCellSize(double x, double y)
Sets output cell size.
QString mErrorMessage
Last error message from run()
Qgis::GdalResampleAlgorithm ResampleAlg
A rectangle specified with double values.
std::unique_ptr< std::remove_pointer< GDALDatasetH >::type, GDALDatasetCloser > dataset_unique_ptr
Scoped GDAL dataset.
#define SIP_SKIP
Definition qgis_sip.h:126
void * GDALDatasetH
Definition of one raster layer for alignment.
Helper struct to be sub-classed for progress reporting.
virtual ~ProgressHandler()=default
virtual bool progress(double complete)=0
Method to be overridden for progress reporting.
Utility class for gathering information about rasters.
QString crs() const
Returns the CRS in WKT format.
gdal::dataset_unique_ptr mDataset
handle to open GDAL dataset
int bandCount() const
Returns the number of raster bands in the file.
QSize rasterSize() const
Returns the size of the raster grid in pixels.
RasterInfo(const RasterInfo &rh)=delete
RasterInfo & operator=(const RasterInfo &rh)=delete
bool isValid() const
Check whether the given path is a valid raster.
QString mCrsWkt
CRS stored in WKT format.