30void QgsJoinByLocationSummaryAlgorithm::initAlgorithm(
const QVariantMap & )
33 QObject::tr(
"Join to features in" ), QList< int > () << QgsProcessing::QgsProcessing::TypeVectorAnyGeometry ) );
35 std::unique_ptr< QgsProcessingParameterEnum > predicateParam = std::make_unique< QgsProcessingParameterEnum >( QStringLiteral(
"PREDICATE" ), QObject::tr(
"Where the features" ),
36 QgsJoinByLocationAlgorithm::translatedPredicates(),
true, 0 );
37 QVariantMap predicateMetadata;
38 QVariantMap widgetMetadata;
39 widgetMetadata.insert( QStringLiteral(
"useCheckBoxes" ),
true );
40 widgetMetadata.insert( QStringLiteral(
"columns" ), 2 );
41 predicateMetadata.insert( QStringLiteral(
"widget_wrapper" ), widgetMetadata );
42 predicateParam->setMetadata( predicateMetadata );
43 addParameter( predicateParam.release() );
46 QObject::tr(
"By comparing to" ), QList< int > () << QgsProcessing::QgsProcessing::TypeVectorAnyGeometry ) );
49 QObject::tr(
"Fields to summarise (leave empty to use all fields)" ),
52 mAllSummaries << QObject::tr(
"count" )
53 << QObject::tr(
"unique" )
54 << QObject::tr(
"min" )
55 << QObject::tr(
"max" )
56 << QObject::tr(
"range" )
57 << QObject::tr(
"sum" )
58 << QObject::tr(
"mean" )
59 << QObject::tr(
"median" )
60 << QObject::tr(
"stddev" )
61 << QObject::tr(
"minority" )
62 << QObject::tr(
"majority" )
63 << QObject::tr(
"q1" )
64 << QObject::tr(
"q3" )
65 << QObject::tr(
"iqr" )
66 << QObject::tr(
"empty" )
67 << QObject::tr(
"filled" )
68 << QObject::tr(
"min_length" )
69 << QObject::tr(
"max_length" )
70 << QObject::tr(
"mean_length" );
72 std::unique_ptr< QgsProcessingParameterEnum > summaryParam = std::make_unique< QgsProcessingParameterEnum >( QStringLiteral(
"SUMMARIES" ), QObject::tr(
"Summaries to calculate (leave empty to use all available)" ), mAllSummaries,
true, QVariant(),
true );
73 addParameter( summaryParam.release() );
76 QObject::tr(
"Discard records which could not be joined" ),
81QString QgsJoinByLocationSummaryAlgorithm::name()
const
83 return QStringLiteral(
"joinbylocationsummary" );
86QString QgsJoinByLocationSummaryAlgorithm::displayName()
const
88 return QObject::tr(
"Join attributes by location (summary)" );
91QStringList QgsJoinByLocationSummaryAlgorithm::tags()
const
93 return QObject::tr(
"summary,aggregate,join,intersects,intersecting,touching,within,contains,overlaps,relation,spatial,"
94 "stats,statistics,sum,maximum,minimum,mean,average,standard,deviation,"
95 "count,distinct,unique,variance,median,quartile,range,majority,minority,histogram,distinct" ).split(
',' );
98QString QgsJoinByLocationSummaryAlgorithm::group()
const
100 return QObject::tr(
"Vector general" );
103QString QgsJoinByLocationSummaryAlgorithm::groupId()
const
105 return QStringLiteral(
"vectorgeneral" );
108QString QgsJoinByLocationSummaryAlgorithm::shortHelpString()
const
110 return QObject::tr(
"This algorithm takes an input vector layer and creates a new vector layer that is an extended version of the input one, with additional attributes in its attribute table.\n\n"
111 "The additional attributes and their values are taken from a second vector layer. A spatial criteria is applied to select the values from the second layer that are added to each feature from the first layer in the resulting one.\n\n"
112 "The algorithm calculates a statistical summary for the values from matching features in the second layer( e.g. maximum value, mean value, etc )." );
115QString QgsJoinByLocationSummaryAlgorithm::shortDescription()
const
117 return QObject::tr(
"Calculate summaries of attributes from one vector layer to another by location." );
120QIcon QgsJoinByLocationSummaryAlgorithm::icon()
const
125QString QgsJoinByLocationSummaryAlgorithm::svgIconPath()
const
130QgsJoinByLocationSummaryAlgorithm *QgsJoinByLocationSummaryAlgorithm::createInstance()
const
132 return new QgsJoinByLocationSummaryAlgorithm();
137 std::unique_ptr< QgsProcessingFeatureSource > baseSource( parameterAsSource( parameters, QStringLiteral(
"INPUT" ), context ) );
141 std::unique_ptr< QgsProcessingFeatureSource > joinSource( parameterAsSource( parameters, QStringLiteral(
"JOIN" ), context ) );
146 feedback->
reportError( QObject::tr(
"No spatial index exists for join layer, performance will be severely degraded" ) );
148 QStringList joinedFieldNames = parameterAsStrings( parameters, QStringLiteral(
"JOIN_FIELDS" ), context );
150 bool discardNonMatching = parameterAsBoolean( parameters, QStringLiteral(
"DISCARD_NONMATCHING" ), context );
152 QList< int > summaries = parameterAsEnums( parameters, QStringLiteral(
"SUMMARIES" ), context );
153 if ( summaries.empty() )
155 for (
int i = 0; i < mAllSummaries.size(); ++i )
159 QgsFields sourceFields = baseSource->fields();
161 QList< int > joinFieldIndices;
162 if ( joinedFieldNames.empty() )
165 for (
const QgsField &sourceField : joinSource->fields() )
167 joinedFieldNames.
append( sourceField.name() );
172 auto addFieldKeepType = [&fieldsToJoin](
const QgsField & original,
const QString & statistic )
176 fieldsToJoin.
append( field );
180 auto addFieldWithType = [&fieldsToJoin](
const QgsField & original,
const QString & statistic, QVariant::Type type )
185 if ( type == QVariant::Double )
190 fieldsToJoin.
append( field );
199 QList< FieldType > fieldTypes;
201 struct FieldStatistic
203 FieldStatistic(
int enumIndex,
const QString &name, QVariant::Type type )
204 : enumIndex( enumIndex )
213 static const QVector< FieldStatistic > sNumericStats
215 FieldStatistic( 0, QStringLiteral(
"count" ), QVariant::LongLong ),
216 FieldStatistic( 1, QStringLiteral(
"unique" ), QVariant::LongLong ),
217 FieldStatistic( 2, QStringLiteral(
"min" ), QVariant::Double ),
218 FieldStatistic( 3, QStringLiteral(
"max" ), QVariant::Double ),
219 FieldStatistic( 4, QStringLiteral(
"range" ), QVariant::Double ),
220 FieldStatistic( 5, QStringLiteral(
"sum" ), QVariant::Double ),
221 FieldStatistic( 6, QStringLiteral(
"mean" ), QVariant::Double ),
222 FieldStatistic( 7, QStringLiteral(
"median" ), QVariant::Double ),
223 FieldStatistic( 8, QStringLiteral(
"stddev" ), QVariant::Double ),
224 FieldStatistic( 9, QStringLiteral(
"minority" ), QVariant::Double ),
225 FieldStatistic( 10, QStringLiteral(
"majority" ), QVariant::Double ),
226 FieldStatistic( 11, QStringLiteral(
"q1" ), QVariant::Double ),
227 FieldStatistic( 12, QStringLiteral(
"q3" ), QVariant::Double ),
228 FieldStatistic( 13, QStringLiteral(
"iqr" ), QVariant::Double ),
230 static const QVector< FieldStatistic > sDateTimeStats
232 FieldStatistic( 0, QStringLiteral(
"count" ), QVariant::LongLong ),
233 FieldStatistic( 1, QStringLiteral(
"unique" ), QVariant::LongLong ),
234 FieldStatistic( 14, QStringLiteral(
"empty" ), QVariant::LongLong ),
235 FieldStatistic( 15, QStringLiteral(
"filled" ), QVariant::LongLong ),
236 FieldStatistic( 2, QStringLiteral(
"min" ), QVariant::Invalid ),
237 FieldStatistic( 3, QStringLiteral(
"max" ), QVariant::Invalid ),
239 static const QVector< FieldStatistic > sStringStats
241 FieldStatistic( 0, QStringLiteral(
"count" ), QVariant::LongLong ),
242 FieldStatistic( 1, QStringLiteral(
"unique" ), QVariant::LongLong ),
243 FieldStatistic( 14, QStringLiteral(
"empty" ), QVariant::LongLong ),
244 FieldStatistic( 15, QStringLiteral(
"filled" ), QVariant::LongLong ),
245 FieldStatistic( 2, QStringLiteral(
"min" ), QVariant::Invalid ),
246 FieldStatistic( 3, QStringLiteral(
"max" ), QVariant::Invalid ),
247 FieldStatistic( 16, QStringLiteral(
"min_length" ), QVariant::Int ),
248 FieldStatistic( 17, QStringLiteral(
"max_length" ), QVariant::Int ),
249 FieldStatistic( 18, QStringLiteral(
"mean_length" ), QVariant::Double ),
252 for (
const QString &field : std::as_const( joinedFieldNames ) )
254 const int fieldIndex = joinSource->fields().lookupField( field );
255 if ( fieldIndex >= 0 )
257 joinFieldIndices.append( fieldIndex );
259 const QgsField joinField = joinSource->fields().at( fieldIndex );
260 QVector< FieldStatistic > statisticList;
263 fieldTypes.append( FieldType::Numeric );
264 statisticList = sNumericStats;
266 else if ( joinField.
type() == QVariant::Date
267 || joinField.
type() == QVariant::Time
268 || joinField.
type() == QVariant::DateTime )
270 fieldTypes.append( FieldType::DateTime );
271 statisticList = sDateTimeStats;
275 fieldTypes.append( FieldType::String );
276 statisticList = sStringStats;
279 for (
const FieldStatistic &statistic : std::as_const( statisticList ) )
281 if ( summaries.contains( statistic.enumIndex ) )
283 if ( statistic.type != QVariant::Invalid )
284 addFieldWithType( joinField, statistic.name, statistic.type );
286 addFieldKeepType( joinField, statistic.name );
295 std::unique_ptr< QgsFeatureSink > sink( parameterAsSink( parameters, QStringLiteral(
"OUTPUT" ), context, destId, outputFields,
296 baseSource->wkbType(), baseSource->sourceCrs() ) );
302 QList<int> predicates = parameterAsEnums( parameters, QStringLiteral(
"PREDICATE" ), context );
303 QgsJoinByLocationAlgorithm::sortPredicates( predicates );
307 const double step = baseSource->featureCount() > 0 ? 100.0 / baseSource->featureCount() : 1;
316 if ( !discardNonMatching )
327 std::unique_ptr< QgsGeometryEngine > engine;
328 QVector< QVector< QVariant > > values;
345 engine->prepareGeometry();
348 if ( QgsJoinByLocationAlgorithm::featureFilter( testJoinFeature, engine.get(),
true, predicates ) )
351 joinAttributes.reserve( joinFieldIndices.size() );
352 for (
int joinIndex : std::as_const( joinFieldIndices ) )
354 joinAttributes.append( testJoinFeature.
attribute( joinIndex ) );
356 values.append( joinAttributes );
366 if ( values.empty() )
368 if ( discardNonMatching )
385 outputAttributes.reserve( outputFields.
size() );
386 for (
int fieldIndex = 0; fieldIndex < joinFieldIndices.size(); ++fieldIndex )
388 const FieldType &fieldType = fieldTypes.at( fieldIndex );
391 case FieldType::Numeric:
394 for (
const QVector< QVariant > &value : std::as_const( values ) )
399 for (
const FieldStatistic &statistic : sNumericStats )
401 if ( summaries.contains( statistic.enumIndex ) )
404 switch ( statistic.enumIndex )
449 if ( val.isValid() && std::isnan( val.toDouble() ) )
451 outputAttributes.append( val );
457 case FieldType::DateTime:
460 QVariantList inputValues;
461 inputValues.reserve( values.size() );
462 for (
const QVector< QVariant > &value : std::as_const( values ) )
464 inputValues << value.at( fieldIndex );
467 for (
const FieldStatistic &statistic : sDateTimeStats )
469 if ( summaries.contains( statistic.enumIndex ) )
472 switch ( statistic.enumIndex )
493 outputAttributes.append( val );
499 case FieldType::String:
502 QVariantList inputValues;
503 inputValues.reserve( values.size() );
504 for (
const QVector< QVariant > &value : std::as_const( values ) )
506 if ( value.at( fieldIndex ).isNull() )
509 stat.
addString( value.at( fieldIndex ).toString() );
512 for (
const FieldStatistic &statistic : sStringStats )
514 if ( summaries.contains( statistic.enumIndex ) )
517 switch ( statistic.enumIndex )
547 outputAttributes.append( val );
563 results.insert( QStringLiteral(
"OUTPUT" ), destId );
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.
Calculator for summary statistics and aggregates for a list of datetimes.
void calculate(const QVariantList &values)
Calculates summary statistics for a list of variants.
QDateTime min() const
Returns the minimum (earliest) non-null datetime value.
int count() const
Returns the calculated count of values.
int countMissing() const
Returns the number of missing (null) datetime values.
int countDistinct() const
Returns the number of distinct datetime values.
QDateTime max() const
Returns the maximum (latest) non-null datetime value.
Wrapper for iterator of features from vector data provider or vector layer.
bool nextFeature(QgsFeature &f)
This class 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 & setFilterRect(const QgsRectangle &rectangle)
Sets the rectangle from which features will be taken.
@ FastInsert
Use faster inserts, at the cost of updating the passed features to reflect changes made at the provid...
@ SpatialIndexNotPresent
No spatial index exists for the source.
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
void resizeAttributes(int fieldCount)
Resizes the attributes attached to this feature to the given number of fields.
void setAttributes(const QgsAttributes &attrs)
Sets the feature's attributes.
bool hasGeometry() const
Returns true if the feature has an associated geometry.
QVariant attribute(const QString &name) const
Lookup attribute value by attribute name.
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.
void setPrecision(int precision)
Set the field precision.
void setName(const QString &name)
Set the field name.
void setLength(int len)
Set the field length.
void setType(QVariant::Type type)
Set variant type.
Container of fields for a vector layer.
bool append(const QgsField &field, FieldOrigin origin=OriginProvider, int originIndex=-1)
Appends a field. The field must have unique name, otherwise it is rejected (returns false)
int size() const
Returns number of items.
const QgsAbstractGeometry * constGet() const
Returns a non-modifiable (const) reference to the underlying abstract geometry primitive.
static QgsGeometryEngine * createGeometryEngine(const QgsAbstractGeometry *geometry)
Creates and returns a new geometry engine representing the specified geometry.
QgsRectangle boundingBox() const
Returns the bounding box of the geometry.
Contains information about the context in which a processing algorithm is executed.
QgsCoordinateTransformContext transformContext() const
Returns the coordinate transform context.
Custom exception class for processing related exceptions.
Base class for providing feedback from a processing algorithm.
virtual void reportError(const QString &error, bool fatalError=false)
Reports that the algorithm encountered an error while executing.
A boolean parameter for processing algorithms.
A feature sink output for processing algorithms.
An input feature source (such as vector layers) parameter for processing algorithms.
A vector layer or feature source field parameter for processing algorithms.
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).
Calculator for summary statistics for a list of doubles.
void addVariant(const QVariant &value)
Adds a single value to the statistics calculation.
double firstQuartile() const
Returns the first quartile of the values.
double sum() const
Returns calculated sum of values.
double mean() const
Returns calculated mean of values.
double majority() const
Returns majority of values.
double interQuartileRange() const
Returns the inter quartile range of the values.
double median() const
Returns calculated median of values.
double minority() const
Returns minority of values.
double min() const
Returns calculated minimum from values.
double stDev() const
Returns population standard deviation.
double thirdQuartile() const
Returns the third quartile of the values.
int count() const
Returns calculated count of values.
double range() const
Returns calculated range (difference between maximum and minimum values).
double max() const
Returns calculated maximum from values.
void finalize()
Must be called after adding all values with addValues() and before retrieving any calculated statisti...
int variety() const
Returns variety of values.
Calculator for summary statistics and aggregates for a list of strings.
QString max() const
Returns the maximum (non-null) string value.
QString min() const
Returns the minimum (non-null) string value.
int countMissing() const
Returns the number of missing (null) string values.
int count() const
Returns the calculated count of values.
int countDistinct() const
Returns the number of distinct string values.
void finalize()
Must be called after adding all strings with addString() and before retrieving any calculated string ...
void addString(const QString &string)
Adds a single string to the statistics calculation.
int minLength() const
Returns the minimum length of strings.
int maxLength() const
Returns the maximum length of strings.
double meanLength() const
Returns the mean length of strings.