26QString QgsCalculateVectorOverlapsAlgorithm::name()
const
28 return QStringLiteral(
"calculatevectoroverlaps" );
31QString QgsCalculateVectorOverlapsAlgorithm::displayName()
const
33 return QObject::tr(
"Overlap analysis" );
36QStringList QgsCalculateVectorOverlapsAlgorithm::tags()
const
38 return QObject::tr(
"vector,overlay,area,percentage,intersection" ).split(
',' );
41QString QgsCalculateVectorOverlapsAlgorithm::group()
const
43 return QObject::tr(
"Vector analysis" );
46QString QgsCalculateVectorOverlapsAlgorithm::groupId()
const
48 return QStringLiteral(
"vectoranalysis" );
51void QgsCalculateVectorOverlapsAlgorithm::initAlgorithm(
const QVariantMap & )
59 addParameter( gridSize.release() );
62QIcon QgsCalculateVectorOverlapsAlgorithm::icon()
const
67QString QgsCalculateVectorOverlapsAlgorithm::svgIconPath()
const
72QString QgsCalculateVectorOverlapsAlgorithm::shortHelpString()
const
74 return QObject::tr(
"This algorithm calculates the area and percentage cover by which features from an input layer "
75 "are overlapped by features from a selection of overlay layers.\n\n"
76 "New attributes are added to the output layer reporting the total area of overlap and percentage of the input feature overlapped "
77 "by each of the selected overlay layers." );
80QString QgsCalculateVectorOverlapsAlgorithm::shortDescription()
const
82 return QObject::tr(
"Calculates the area and percentage cover by which features from an input layer "
83 "are overlapped by features from a selection of overlay layers." );
86QgsCalculateVectorOverlapsAlgorithm *QgsCalculateVectorOverlapsAlgorithm::createInstance()
const
88 return new QgsCalculateVectorOverlapsAlgorithm();
93 mSource.reset( parameterAsSource( parameters, QStringLiteral(
"INPUT" ), context ) );
97 mOutputFields = mSource->fields();
99 const QList<QgsMapLayer *> layers = parameterAsLayerList( parameters, QStringLiteral(
"LAYERS" ), context );
100 mOverlayerSources.reserve( layers.size() );
101 mLayerNames.reserve( layers.size() );
104 if (
QgsVectorLayer *vl = qobject_cast<QgsVectorLayer *>( layer ) )
106 mLayerNames << layer->name();
107 mOverlayerSources.emplace_back( std::make_unique<QgsVectorLayerFeatureSource>( vl ) );
109 newFields.
append(
QgsField( QStringLiteral(
"%1_area" ).arg( vl->name() ), QMetaType::Type::Double ) );
110 newFields.
append(
QgsField( QStringLiteral(
"%1_pc" ).arg( vl->name() ), QMetaType::Type::Double ) );
115 mOutputType = mSource->wkbType();
116 mCrs = mSource->sourceCrs();
117 mInputCount = mSource->featureCount();
118 mInputFeatures = mSource->getFeatures();
125 std::unique_ptr<QgsFeatureSink> sink( parameterAsSink( parameters, QStringLiteral(
"OUTPUT" ), context, destId, mOutputFields, mOutputType, mCrs ) );
131 QList<QgsSpatialIndex> spatialIndices;
132 spatialIndices.reserve( mLayerNames.size() );
133 auto nameIt = mLayerNames.constBegin();
134 for (
auto sourceIt = mOverlayerSources.begin(); sourceIt != mOverlayerSources.end(); ++sourceIt, ++nameIt )
136 feedback->
pushInfo( QObject::tr(
"Preparing %1" ).arg( *nameIt ) );
146 if ( parameters.value( QStringLiteral(
"GRID_SIZE" ) ).isValid() )
148 geometryParameters.
setGridSize( parameterAsDouble( parameters, QStringLiteral(
"GRID_SIZE" ), context ) );
152 const double step = mInputCount > 0 ? 100.0 / mInputCount : 0;
155 while ( mInputFeatures.nextFeature( feature ) )
165 double inputArea = 0;
177 bufferGeomEngine->prepareGeometry();
180 auto spatialIteratorIt = spatialIndices.begin();
181 for (
auto it = mOverlayerSources.begin(); it != mOverlayerSources.end(); ++it, ++spatialIteratorIt )
188 QVector<QgsGeometry> intersectingGeoms;
189 intersectingGeoms.reserve( matches.count() );
196 if ( bufferGeomEngine->intersects( overlayGeometry.
constGet() ) )
198 intersectingGeoms.append( overlayGeometry );
213 double overlayArea = 0;
216 overlayArea = da.
measureArea( overlayIntersection );
223 outAttributes.append( overlayArea );
224 outAttributes.append( 100 * overlayArea / inputArea );
230 for (
auto it = mOverlayerSources.begin(); it != mOverlayerSources.end(); ++it )
232 outAttributes.append( QVariant() );
233 outAttributes.append( QVariant() );
248 outputs.insert( QStringLiteral(
"OUTPUT" ), destId );
@ VectorPolygon
Vector polygon layers.
@ Advanced
Parameter is an advanced parameter which should be hidden from users by default.
@ Double
Double/float values.
static QIcon getThemeIcon(const QString &name, const QColor &fillColor=QColor(), const QColor &strokeColor=QColor())
Helper to get a theme icon.
static QString iconPath(const QString &iconFile)
Returns path to the desired icon file.
Custom exception class for Coordinate Reference System related exceptions.
A general purpose distance and area calculator, capable of performing ellipsoid based calculations.
double measureArea(const QgsGeometry &geometry) const
Measures the area of a geometry.
void setSourceCrs(const QgsCoordinateReferenceSystem &crs, const QgsCoordinateTransformContext &context)
Sets source spatial reference system crs.
bool setEllipsoid(const QString &ellipsoid)
Sets the ellipsoid by its acronym.
Wrapper for iterator of features from vector data provider or vector layer.
Wraps a request for features to a vector layer (or directly its vector data provider).
QgsFeatureRequest & setSubsetOfAttributes(const QgsAttributeList &attrs)
Set a subset of attributes that will be fetched.
QgsFeatureRequest & setDestinationCrs(const QgsCoordinateReferenceSystem &crs, const QgsCoordinateTransformContext &context)
Sets the destination crs for feature's geometries.
QgsFeatureRequest & setInvalidGeometryCheck(Qgis::InvalidGeometryCheck check)
Sets invalid geometry checking behavior.
QgsFeatureRequest & setInvalidGeometryCallback(const std::function< void(const QgsFeature &)> &callback)
Sets a callback function to use when encountering an invalid geometry and invalidGeometryCheck() is s...
@ FastInsert
Use faster inserts, at the cost of updating the passed features to reflect changes made at the provid...
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
void setAttributes(const QgsAttributes &attrs)
Sets the feature's attributes.
bool hasGeometry() const
Returns true if the feature has an associated geometry.
bool isCanceled() const
Tells whether the operation has been canceled already.
void setProgress(double progress)
Sets the current progress for the feedback object.
Encapsulate a field in an attribute table or data source.
Container of fields for a vector layer.
bool append(const QgsField &field, Qgis::FieldOrigin origin=Qgis::FieldOrigin::Provider, int originIndex=-1)
Appends a field.
Encapsulates parameters under which a geometry operation is performed.
void setGridSize(double size)
Sets the grid size which will be used to snap vertices of a geometry.
A geometry is the spatial representation of a feature.
const QgsAbstractGeometry * constGet() const
Returns a non-modifiable (const) reference to the underlying abstract geometry primitive.
double area() const
Returns the planar, 2-dimensional area of the geometry.
QgsGeometry intersection(const QgsGeometry &geometry, const QgsGeometryParameters ¶meters=QgsGeometryParameters()) const
Returns a geometry representing the points shared by this geometry and other.
static QgsGeometry unaryUnion(const QVector< QgsGeometry > &geometries, const QgsGeometryParameters ¶meters=QgsGeometryParameters())
Compute the unary union on a list of geometries.
QgsRectangle boundingBox() const
Returns the bounding box of the geometry.
static QgsGeometryEngine * createGeometryEngine(const QgsAbstractGeometry *geometry, double precision=0.0, Qgis::GeosCreationFlags flags=Qgis::GeosCreationFlag::SkipEmptyInteriorRings)
Creates and returns a new geometry engine representing the specified geometry using precision on a gr...
Base class for all map layer types.
Contains information about the context in which a processing algorithm is executed.
QgsCoordinateTransformContext transformContext() const
Returns the coordinate transform context.
std::function< void(const QgsFeature &) > invalidGeometryCallback(QgsFeatureSource *source=nullptr) const
Returns the callback function to use when encountering an invalid geometry and invalidGeometryCheck()...
QString ellipsoid() const
Returns the ellipsoid to use for distance and area calculations.
Qgis::InvalidGeometryCheck invalidGeometryCheck() const
Returns the behavior used for checking invalid geometries in input layers.
Custom exception class for processing related exceptions.
Base class for providing feedback from a processing algorithm.
virtual void pushInfo(const QString &info)
Pushes a general informational message from the algorithm.
A feature sink output for processing algorithms.
An input feature source (such as vector layers) parameter for processing algorithms.
A parameter for processing algorithms which accepts multiple map layers.
static QgsFields combineFields(const QgsFields &fieldsA, const QgsFields &fieldsB, const QString &fieldsBPrefix=QString())
Combines two field lists, avoiding duplicate field names (in a case-insensitive manner).
A spatial index for QgsFeature objects.
@ FlagStoreFeatureGeometries
Indicates that the spatial index should also store feature geometries. This requires more memory,...
QList< QgsFeatureId > intersects(const QgsRectangle &rectangle) const
Returns a list of features with a bounding box which intersects the specified rectangle.
QgsGeometry geometry(QgsFeatureId id) const
Returns the stored geometry for the indexed feature with matching id.
Represents a vector layer which manages a vector based dataset.
bool qgsDoubleNear(double a, double b, double epsilon=4 *std::numeric_limits< double >::epsilon())
Compare two doubles (but allow some difference)
qint64 QgsFeatureId
64 bit feature ids negative numbers are used for uncommitted/newly added features
QList< int > QgsAttributeList