Branch data Line data Source code
1 : : /***************************************************************************
2 : : qgsalgorithmdrape.cpp
3 : : ---------------------
4 : : begin : November 2017
5 : : copyright : (C) 2017 by Nyall Dawson
6 : : email : nyall dot dawson at gmail dot com
7 : : ***************************************************************************/
8 : :
9 : : /***************************************************************************
10 : : * *
11 : : * This program is free software; you can redistribute it and/or modify *
12 : : * it under the terms of the GNU General Public License as published by *
13 : : * the Free Software Foundation; either version 2 of the License, or *
14 : : * (at your option) any later version. *
15 : : * *
16 : : ***************************************************************************/
17 : :
18 : : #include "qgsalgorithmdrape.h"
19 : : #include "qgsvectorlayer.h"
20 : :
21 : : ///@cond PRIVATE
22 : :
23 : :
24 : 0 : QString QgsDrapeAlgorithmBase::group() const
25 : : {
26 : 0 : return QObject::tr( "Vector geometry" );
27 : : }
28 : :
29 : 0 : QString QgsDrapeAlgorithmBase::groupId() const
30 : : {
31 : 0 : return QStringLiteral( "vectorgeometry" );
32 : : }
33 : :
34 : 0 : QString QgsDrapeAlgorithmBase::outputName() const
35 : : {
36 : 0 : return QObject::tr( "Draped" );
37 : : }
38 : :
39 : 0 : void QgsDrapeAlgorithmBase::initParameters( const QVariantMap & )
40 : : {
41 : 0 : addParameter( new QgsProcessingParameterRasterLayer( QStringLiteral( "RASTER" ),
42 : 0 : QObject::tr( "Raster layer" ) ) );
43 : 0 : addParameter( new QgsProcessingParameterBand( QStringLiteral( "BAND" ),
44 : 0 : QObject::tr( "Band number" ), 1, QStringLiteral( "RASTER" ) ) );
45 : :
46 : : // nodata value
47 : 0 : std::unique_ptr< QgsProcessingParameterNumber > nodata = std::make_unique< QgsProcessingParameterNumber >( QStringLiteral( "NODATA" ),
48 : 0 : QObject::tr( "Value for nodata or non-intersecting vertices" ), QgsProcessingParameterNumber::Double,
49 : 0 : 0.0 );
50 : 0 : nodata->setIsDynamic( true );
51 : 0 : nodata->setDynamicPropertyDefinition( QgsPropertyDefinition( QStringLiteral( "NODATA" ), QObject::tr( "Value for nodata or non-intersecting vertices" ), QgsPropertyDefinition::Double ) );
52 : 0 : nodata->setDynamicLayerParameterName( QStringLiteral( "INPUT" ) );
53 : 0 : addParameter( nodata.release() );
54 : :
55 : 0 : auto scaleParam = std::make_unique< QgsProcessingParameterNumber >( QStringLiteral( "SCALE" ), QObject::tr( "Scale factor" ), QgsProcessingParameterNumber::Double, 1.0, false, 0.0 );
56 : 0 : scaleParam->setIsDynamic( true );
57 : 0 : scaleParam->setDynamicPropertyDefinition( QgsPropertyDefinition( QStringLiteral( "SCALE" ), QObject::tr( "Scale factor" ), QgsPropertyDefinition::Double ) );
58 : 0 : scaleParam->setDynamicLayerParameterName( QStringLiteral( "INPUT" ) );
59 : 0 : addParameter( scaleParam.release() );
60 : 0 : }
61 : :
62 : 0 : bool QgsDrapeAlgorithmBase::prepareAlgorithm( const QVariantMap ¶meters, QgsProcessingContext &context, QgsProcessingFeedback * )
63 : : {
64 : 0 : mNoData = parameterAsDouble( parameters, QStringLiteral( "NODATA" ), context );
65 : 0 : mDynamicNoData = QgsProcessingParameters::isDynamic( parameters, QStringLiteral( "NODATA" ) );
66 : 0 : if ( mDynamicNoData )
67 : 0 : mNoDataProperty = parameters.value( QStringLiteral( "NODATA" ) ).value< QgsProperty >();
68 : :
69 : 0 : mScale = parameterAsDouble( parameters, QStringLiteral( "SCALE" ), context );
70 : 0 : mDynamicScale = QgsProcessingParameters::isDynamic( parameters, QStringLiteral( "SCALE" ) );
71 : 0 : if ( mDynamicScale )
72 : 0 : mScaleProperty = parameters.value( QStringLiteral( "SCALE" ) ).value< QgsProperty >();
73 : :
74 : 0 : QgsRasterLayer *layer = parameterAsRasterLayer( parameters, QStringLiteral( "RASTER" ), context );
75 : :
76 : 0 : if ( !layer )
77 : 0 : throw QgsProcessingException( invalidRasterError( parameters, QStringLiteral( "RASTER" ) ) );
78 : :
79 : 0 : mBand = parameterAsInt( parameters, QStringLiteral( "BAND" ), context );
80 : 0 : if ( mBand < 1 || mBand > layer->bandCount() )
81 : 0 : throw QgsProcessingException( QObject::tr( "Invalid band number for BAND (%1): Valid values for input raster are 1 to %2" ).arg( mBand )
82 : 0 : .arg( layer->bandCount() ) );
83 : 0 : mRasterExtent = layer->extent();
84 : :
85 : 0 : std::unique_ptr< QgsRasterInterface > provider( layer->dataProvider()->clone() );
86 : 0 : QgsRasterDataProvider *dp = dynamic_cast< QgsRasterDataProvider * >( provider.get() );
87 : 0 : if ( !dp )
88 : 0 : throw QgsProcessingException( invalidRasterError( parameters, QStringLiteral( "RASTER" ) ) );
89 : :
90 : 0 : mRasterProvider.reset( dp );
91 : 0 : provider.release();
92 : :
93 : : return true;
94 : 0 : }
95 : :
96 : 0 : QgsFeatureList QgsDrapeAlgorithmBase::processFeature( const QgsFeature &feature, QgsProcessingContext &context, QgsProcessingFeedback *feedback )
97 : : {
98 : 0 : if ( !mCreatedTransform )
99 : : {
100 : 0 : mCreatedTransform = true;
101 : 0 : mTransform = QgsCoordinateTransform( sourceCrs(), mRasterProvider->crs(), context.transformContext() );
102 : :
103 : : // transform the raster extent back to the vector's crs, so that we can test
104 : : // whether individual vector geometries are actually covered by the raster
105 : : try
106 : : {
107 : 0 : mRasterExtent = mTransform.transform( mRasterExtent, QgsCoordinateTransform::ReverseTransform );
108 : 0 : }
109 : : catch ( QgsCsException & )
110 : : {
111 : 0 : mRasterExtent = QgsRectangle();
112 : 0 : }
113 : 0 : }
114 : :
115 : 0 : QgsFeature f = feature;
116 : 0 : if ( f.hasGeometry() )
117 : : {
118 : 0 : QgsGeometry geometry = f.geometry();
119 : :
120 : 0 : double nodata = mNoData;
121 : 0 : if ( mDynamicNoData )
122 : 0 : nodata = mNoDataProperty.valueAsDouble( context.expressionContext(), nodata );
123 : :
124 : 0 : double scale = mScale;
125 : 0 : if ( mDynamicScale )
126 : 0 : scale = mScaleProperty.valueAsDouble( context.expressionContext(), scale );
127 : :
128 : 0 : prepareGeometry( geometry, nodata );
129 : :
130 : : // only do the "draping" if the geometry intersects the raster - otherwise skip
131 : : // a pointless iteration over all vertices
132 : 0 : if ( !mRasterExtent.isNull() && geometry.boundingBoxIntersects( mRasterExtent ) )
133 : : {
134 : 0 : geometry.transformVertices( [ = ]( const QgsPoint & p )->QgsPoint
135 : : {
136 : 0 : QgsPointXY t;
137 : 0 : double val = nodata;
138 : : try
139 : : {
140 : 0 : t = mTransform.transform( p );
141 : 0 : bool ok = false;
142 : 0 : val = mRasterProvider->sample( t, mBand, &ok );
143 : 0 : if ( !ok )
144 : 0 : val = nodata;
145 : : else
146 : 0 : val *= scale;
147 : 0 : }
148 : : catch ( QgsCsException & )
149 : : {
150 : 0 : feedback->reportError( QObject::tr( "Transform error while reprojecting feature {}" ).arg( f.id() ) );
151 : 0 : }
152 : :
153 : 0 : return drapeVertex( p, val );
154 : 0 : } );
155 : 0 : }
156 : :
157 : 0 : f.setGeometry( geometry );
158 : 0 : }
159 : 0 : return QgsFeatureList() << f;
160 : 0 : }
161 : :
162 : :
163 : : //
164 : : // QgsDrapeToZAlgorithm
165 : : //
166 : :
167 : 0 : QString QgsDrapeToZAlgorithm::name() const
168 : : {
169 : 0 : return QStringLiteral( "setzfromraster" );
170 : : }
171 : :
172 : 0 : QString QgsDrapeToZAlgorithm::displayName() const
173 : : {
174 : 0 : return QObject::tr( "Drape (set Z value from raster)" );
175 : : }
176 : :
177 : 0 : QStringList QgsDrapeToZAlgorithm::tags() const
178 : : {
179 : 0 : return QObject::tr( "3d,vertex,vertices,elevation,height,sample,dem,update,feature" ).split( ',' );
180 : 0 : }
181 : :
182 : 0 : QString QgsDrapeToZAlgorithm::shortHelpString() const
183 : : {
184 : 0 : return QObject::tr( "This algorithm sets the z value of every vertex in the feature geometry to a value sampled from a band within a raster layer." )
185 : 0 : + QStringLiteral( "\n\n" )
186 : 0 : + QObject::tr( "The raster values can optionally be scaled by a preset amount." );
187 : 0 : }
188 : :
189 : 0 : QString QgsDrapeToZAlgorithm::shortDescription() const
190 : : {
191 : 0 : return QObject::tr( "Sets the z value for vertices to values sampled from a raster layer." );
192 : : }
193 : :
194 : 0 : QgsDrapeToZAlgorithm *QgsDrapeToZAlgorithm::createInstance() const
195 : : {
196 : 0 : return new QgsDrapeToZAlgorithm();
197 : 0 : }
198 : :
199 : 0 : bool QgsDrapeToZAlgorithm::supportInPlaceEdit( const QgsMapLayer *l ) const
200 : : {
201 : 0 : const QgsVectorLayer *layer = qobject_cast< const QgsVectorLayer * >( l );
202 : 0 : if ( !layer )
203 : 0 : return false;
204 : :
205 : 0 : if ( ! QgsDrapeAlgorithmBase::supportInPlaceEdit( layer ) )
206 : 0 : return false;
207 : 0 : return QgsWkbTypes::hasZ( layer->wkbType() );
208 : 0 : }
209 : :
210 : 0 : QgsWkbTypes::Type QgsDrapeToZAlgorithm::outputWkbType( QgsWkbTypes::Type inputWkbType ) const
211 : : {
212 : 0 : QgsWkbTypes::Type wkb = inputWkbType;
213 : 0 : return QgsWkbTypes::addZ( wkb );
214 : : }
215 : :
216 : 0 : void QgsDrapeToZAlgorithm::prepareGeometry( QgsGeometry &geometry, double defaultVal ) const
217 : : {
218 : 0 : geometry.get()->addZValue( defaultVal );
219 : 0 : }
220 : :
221 : 0 : QgsPoint QgsDrapeToZAlgorithm::drapeVertex( const QgsPoint &p, double rasterVal ) const
222 : : {
223 : 0 : return QgsPoint( p.wkbType(), p.x(), p.y(), rasterVal, p.m() );
224 : : }
225 : :
226 : : //
227 : : // QgsDrapeToMAlgorithm
228 : : //
229 : :
230 : 0 : QString QgsDrapeToMAlgorithm::name() const
231 : : {
232 : 0 : return QStringLiteral( "setmfromraster" );
233 : : }
234 : :
235 : 0 : QString QgsDrapeToMAlgorithm::displayName() const
236 : : {
237 : 0 : return QObject::tr( "Set M value from raster" );
238 : : }
239 : :
240 : 0 : QStringList QgsDrapeToMAlgorithm::tags() const
241 : : {
242 : 0 : return QObject::tr( "drape,vertex,vertices,sample,dem,update,feature,measure" ).split( ',' );
243 : 0 : }
244 : :
245 : 0 : QString QgsDrapeToMAlgorithm::shortHelpString() const
246 : : {
247 : 0 : return QObject::tr( "This algorithm sets the M value for every vertex in the feature geometry to a value sampled from a band within a raster layer." )
248 : 0 : + QStringLiteral( "\n\n" )
249 : 0 : + QObject::tr( "The raster values can optionally be scaled by a preset amount." );
250 : 0 : }
251 : :
252 : 0 : QString QgsDrapeToMAlgorithm::shortDescription() const
253 : : {
254 : 0 : return QObject::tr( "Sets the M value for vertices to values sampled from a raster layer." );
255 : : }
256 : :
257 : 0 : QgsDrapeToMAlgorithm *QgsDrapeToMAlgorithm::createInstance() const
258 : : {
259 : 0 : return new QgsDrapeToMAlgorithm();
260 : 0 : }
261 : :
262 : 0 : bool QgsDrapeToMAlgorithm::supportInPlaceEdit( const QgsMapLayer *l ) const
263 : : {
264 : 0 : const QgsVectorLayer *layer = qobject_cast< const QgsVectorLayer * >( l );
265 : 0 : if ( !layer )
266 : 0 : return false;
267 : :
268 : 0 : if ( ! QgsDrapeAlgorithmBase::supportInPlaceEdit( layer ) )
269 : 0 : return false;
270 : 0 : return QgsWkbTypes::hasM( layer->wkbType() );
271 : 0 : }
272 : :
273 : 0 : QgsWkbTypes::Type QgsDrapeToMAlgorithm::outputWkbType( QgsWkbTypes::Type inputWkbType ) const
274 : : {
275 : 0 : QgsWkbTypes::Type wkb = inputWkbType;
276 : 0 : return QgsWkbTypes::addM( wkb );
277 : : }
278 : :
279 : 0 : void QgsDrapeToMAlgorithm::prepareGeometry( QgsGeometry &geometry, double defaultVal ) const
280 : : {
281 : 0 : geometry.get()->addMValue( defaultVal );
282 : 0 : }
283 : :
284 : 0 : QgsPoint QgsDrapeToMAlgorithm::drapeVertex( const QgsPoint &p, double rasterVal ) const
285 : : {
286 : 0 : return QgsPoint( p.wkbType(), p.x(), p.y(), p.z(), rasterVal );
287 : : }
288 : :
289 : :
290 : : ///@endcond
291 : :
292 : :
|
