30#include "moc_qgsrasterlayerelevationproperties.cpp"
36 setDefaultProfileLineSymbol( color );
37 setDefaultProfileFillSymbol( color );
49 QDomElement element = document.createElement( QStringLiteral(
"elevation" ) );
50 element.setAttribute( QStringLiteral(
"enabled" ), mEnabled ? QStringLiteral(
"1" ) : QStringLiteral(
"0" ) );
52 element.setAttribute( QStringLiteral(
"symbology" ),
qgsEnumValueToKey( mSymbology ) );
53 if ( !std::isnan( mElevationLimit ) )
54 element.setAttribute( QStringLiteral(
"elevationLimit" ),
qgsDoubleToString( mElevationLimit ) );
61 element.setAttribute( QStringLiteral(
"lower" ),
qgsDoubleToString( mFixedRange.lower() ) );
62 element.setAttribute( QStringLiteral(
"upper" ),
qgsDoubleToString( mFixedRange.upper() ) );
63 element.setAttribute( QStringLiteral(
"includeLower" ), mFixedRange.includeLower() ?
"1" :
"0" );
64 element.setAttribute( QStringLiteral(
"includeUpper" ), mFixedRange.includeUpper() ?
"1" :
"0" );
69 QDomElement ranges = document.createElement( QStringLiteral(
"ranges" ) );
70 for (
auto it = mRangePerBand.constBegin(); it != mRangePerBand.constEnd(); ++it )
72 QDomElement range = document.createElement( QStringLiteral(
"range" ) );
73 range.setAttribute( QStringLiteral(
"band" ), it.key() );
74 range.setAttribute( QStringLiteral(
"lower" ),
qgsDoubleToString( it.value().lower() ) );
75 range.setAttribute( QStringLiteral(
"upper" ),
qgsDoubleToString( it.value().upper() ) );
76 range.setAttribute( QStringLiteral(
"includeLower" ), it.value().includeLower() ?
"1" :
"0" );
77 range.setAttribute( QStringLiteral(
"includeUpper" ), it.value().includeUpper() ?
"1" :
"0" );
78 ranges.appendChild( range );
80 element.appendChild( ranges );
88 element.setAttribute( QStringLiteral(
"band" ), mBandNumber );
92 QDomElement profileLineSymbolElement = document.createElement( QStringLiteral(
"profileLineSymbol" ) );
94 element.appendChild( profileLineSymbolElement );
96 QDomElement profileFillSymbolElement = document.createElement( QStringLiteral(
"profileFillSymbol" ) );
98 element.appendChild( profileFillSymbolElement );
100 parentElement.appendChild( element );
106 const QDomElement elevationElement = element.firstChildElement( QStringLiteral(
"elevation" ) ).toElement();
107 mEnabled = elevationElement.attribute( QStringLiteral(
"enabled" ), QStringLiteral(
"0" ) ).toInt();
110 if ( elevationElement.hasAttribute( QStringLiteral(
"elevationLimit" ) ) )
111 mElevationLimit = elevationElement.attribute( QStringLiteral(
"elevationLimit" ) ).toDouble();
113 mElevationLimit = std::numeric_limits< double >::quiet_NaN();
121 const double lower = elevationElement.attribute( QStringLiteral(
"lower" ) ).toDouble();
122 const double upper = elevationElement.attribute( QStringLiteral(
"upper" ) ).toDouble();
123 const bool includeLower = elevationElement.attribute( QStringLiteral(
"includeLower" ) ).toInt();
124 const bool includeUpper = elevationElement.attribute( QStringLiteral(
"includeUpper" ) ).toInt();
125 mFixedRange =
QgsDoubleRange( lower, upper, includeLower, includeUpper );
131 mRangePerBand.clear();
133 const QDomNodeList ranges = elevationElement.firstChildElement( QStringLiteral(
"ranges" ) ).childNodes();
134 for (
int i = 0; i < ranges.size(); ++i )
136 const QDomElement rangeElement = ranges.at( i ).toElement();
137 const int band = rangeElement.attribute( QStringLiteral(
"band" ) ).toInt();
138 const double lower = rangeElement.attribute( QStringLiteral(
"lower" ) ).toDouble();
139 const double upper = rangeElement.attribute( QStringLiteral(
"upper" ) ).toDouble();
140 const bool includeLower = rangeElement.attribute( QStringLiteral(
"includeLower" ) ).toInt();
141 const bool includeUpper = rangeElement.attribute( QStringLiteral(
"includeUpper" ) ).toInt();
142 mRangePerBand.insert( band,
QgsDoubleRange( lower, upper, includeLower, includeUpper ) );
151 mBandNumber = elevationElement.attribute( QStringLiteral(
"band" ), QStringLiteral(
"1" ) ).toInt();
157 const QDomElement profileLineSymbolElement = elevationElement.firstChildElement( QStringLiteral(
"profileLineSymbol" ) ).firstChildElement( QStringLiteral(
"symbol" ) );
159 if ( !mProfileLineSymbol )
160 setDefaultProfileLineSymbol( defaultColor );
162 const QDomElement profileFillSymbolElement = elevationElement.firstChildElement( QStringLiteral(
"profileFillSymbol" ) ).firstChildElement( QStringLiteral(
"symbol" ) );
164 if ( !mProfileFillSymbol )
165 setDefaultProfileFillSymbol( defaultColor );
172 auto res = std::make_unique< QgsRasterLayerElevationProperties >(
nullptr );
173 res->setEnabled( mEnabled );
174 res->setMode( mMode );
175 res->setProfileLineSymbol( mProfileLineSymbol->clone() );
176 res->setProfileFillSymbol( mProfileFillSymbol->clone() );
177 res->setProfileSymbology( mSymbology );
178 res->setElevationLimit( mElevationLimit );
179 res->setBandNumber( mBandNumber );
180 res->setFixedRange( mFixedRange );
181 res->setFixedRangePerBand( mRangePerBand );
182 res->copyCommonProperties(
this );
183 return res.release();
188 QStringList properties;
192 properties << tr(
"Elevation range: %1 to %2" ).arg( mFixedRange.lower() ).arg( mFixedRange.upper() );
197 for (
auto it = mRangePerBand.constBegin(); it != mRangePerBand.constEnd(); ++it )
199 properties << tr(
"Elevation for band %1: %2 to %3" ).arg( it.key() ).arg( it.value().lower() ).arg( it.value().upper() );
208 properties << tr(
"Elevation band: %1" ).arg( mBandNumber );
209 properties << tr(
"Scale: %1" ).arg(
mZScale );
210 properties << tr(
"Offset: %1" ).arg(
mZOffset );
214 return QStringLiteral(
"<li>%1</li>" ).arg( properties.join( QLatin1String(
"</li><li>" ) ) );
222 return mFixedRange.overlaps( range );
226 for (
auto it = mRangePerBand.constBegin(); it != mRangePerBand.constEnd(); ++it )
228 if ( it.value().overlaps( range ) )
236 if (
QgsRasterLayer *rl = qobject_cast< QgsRasterLayer * >( layer ) )
248 lowerProperty.
prepare( context );
249 upperProperty.
prepare( context );
250 for (
int band = 1; band <= rl->bandCount(); ++band )
252 bandScope->
setVariable( QStringLiteral(
"band" ), band );
253 bandScope->
setVariable( QStringLiteral(
"band_name" ), rl->dataProvider()->displayBandName( band ) );
254 bandScope->
setVariable( QStringLiteral(
"band_description" ), rl->dataProvider()->bandDescription( band ) );
257 const double lower = lowerProperty.
valueAsDouble( context, 0, &ok );
260 const double upper = upperProperty.
valueAsDouble( context, 0, &ok );
287 double lower = std::numeric_limits< double >::max();
288 double upper = std::numeric_limits< double >::min();
289 bool includeLower =
true;
290 bool includeUpper =
true;
291 for (
auto it = mRangePerBand.constBegin(); it != mRangePerBand.constEnd(); ++it )
293 if ( it.value().lower() < lower )
295 lower = it.value().lower();
296 includeLower = it.value().includeLower();
298 else if ( !includeLower && it.value().lower() == lower && it.value().includeLower() )
302 if ( it.value().upper() > upper )
304 upper = it.value().upper();
305 includeUpper = it.value().includeUpper();
307 else if ( !includeUpper && it.value().upper() == upper && it.value().includeUpper() )
312 return QgsDoubleRange( lower, upper, includeLower, includeUpper );
317 if (
QgsRasterLayer *rl = qobject_cast< QgsRasterLayer * >( layer ) )
329 lowerProperty.
prepare( context );
330 upperProperty.
prepare( context );
331 double minLower = std::numeric_limits<double>::max();
332 double maxUpper = std::numeric_limits<double>::lowest();
333 for (
int band = 1; band <= rl->bandCount(); ++band )
335 bandScope->
setVariable( QStringLiteral(
"band" ), band );
336 bandScope->
setVariable( QStringLiteral(
"band_name" ), rl->dataProvider()->displayBandName( band ) );
337 bandScope->
setVariable( QStringLiteral(
"band_description" ), rl->dataProvider()->bandDescription( band ) );
340 const double lower = lowerProperty.
valueAsDouble( context, 0, &ok );
343 const double upper = upperProperty.
valueAsDouble( context, 0, &ok );
347 minLower = std::min( minLower, lower );
348 maxUpper = std::max( maxUpper, upper );
350 return ( minLower == std::numeric_limits<double>::max() && maxUpper == std::numeric_limits<double>::lowest() ) ?
QgsDoubleRange() :
QgsDoubleRange( minLower, maxUpper );
368 if ( !mFixedRange.isInfinite() && mFixedRange.lower() != mFixedRange.upper() )
369 return { mFixedRange.lower(), mFixedRange.upper() };
370 else if ( !mFixedRange.isInfinite() )
371 return { mFixedRange.lower() };
379 for (
auto it = mRangePerBand.constBegin(); it != mRangePerBand.constEnd(); ++it )
381 if ( it.value().isInfinite() )
384 if ( !res.contains( it.value().lower( ) ) )
385 res.append( it.value().lower() );
386 if ( !res.contains( it.value().upper( ) ) )
387 res.append( it.value().upper() );
389 std::sort( res.begin(), res.end() );
396 if (
QgsRasterLayer *rl = qobject_cast< QgsRasterLayer * >( layer ) )
408 lowerProperty.
prepare( context );
409 upperProperty.
prepare( context );
410 for (
int band = 1; band <= rl->bandCount(); ++band )
412 bandScope->
setVariable( QStringLiteral(
"band" ), band );
413 bandScope->
setVariable( QStringLiteral(
"band_name" ), rl->dataProvider()->displayBandName( band ) );
414 bandScope->
setVariable( QStringLiteral(
"band_description" ), rl->dataProvider()->bandDescription( band ) );
417 const double lower = lowerProperty.
valueAsDouble( context, 0, &ok );
418 if ( ok && !res.contains( lower ) )
420 const double upper = upperProperty.
valueAsDouble( context, 0, &ok );
421 if ( ok && !res.contains( upper ) )
459 if ( enabled == mEnabled )
483 if ( mBandNumber == band )
493 if ( !mEnabled || std::isnan( pixelValue ) )
503 auto it = mRangePerBand.constFind( band );
504 if ( it != mRangePerBand.constEnd() )
511 if ( layer && band > 0 && band <= layer->bandCount() )
523 lowerProperty.
prepare( context );
524 upperProperty.
prepare( context );
527 const double lower = lowerProperty.
valueAsDouble( context, 0, &ok );
530 const double upper = upperProperty.
valueAsDouble( context, 0, &ok );
542 if ( band != mBandNumber )
563 int currentMatchingBand = -1;
565 for (
auto it = mRangePerBand.constBegin(); it != mRangePerBand.constEnd(); ++it )
567 if ( it.value().overlaps( range ) )
570 || ( it.value().includeUpper() && it.value().upper() >= currentMatchingRange.
upper() )
571 || ( !currentMatchingRange.
includeUpper() && it.value().upper() >= currentMatchingRange.
upper() ) )
573 currentMatchingBand = it.key();
574 currentMatchingRange = it.value();
578 return currentMatchingBand;
592 lowerProperty.
prepare( context );
593 upperProperty.
prepare( context );
595 int currentMatchingBand = -1;
598 for (
int band = 1; band <= layer->
bandCount(); ++band )
600 bandScope->
setVariable( QStringLiteral(
"band" ), band );
605 const double lower = lowerProperty.
valueAsDouble( context, 0, &ok );
608 const double upper = upperProperty.
valueAsDouble( context, 0, &ok );
619 currentMatchingBand = band;
620 currentMatchingRange = bandRange;
624 return currentMatchingBand;
634 return mProfileLineSymbol.get();
639 mProfileLineSymbol.reset( symbol );
646 return mProfileFillSymbol.get();
651 mProfileFillSymbol.reset( symbol );
658 if ( mSymbology == symbology )
661 mSymbology = symbology;
668 return mElevationLimit;
676 mElevationLimit = limit;
694 switch ( dataProvider->dataType( 1 ) )
720 static const QStringList sPartialCandidates{ QStringLiteral(
"dem" ),
721 QStringLiteral(
"dtm" ),
722 QStringLiteral(
"dsm" ),
723 QStringLiteral(
"height" ),
724 QStringLiteral(
"elev" ),
725 QStringLiteral(
"srtm" ),
726 QStringLiteral(
"dted" ),
728 QStringLiteral(
"mne" ),
729 QStringLiteral(
"mnt" ),
730 QStringLiteral(
"mns" ),
731 QStringLiteral(
"rge" ),
732 QStringLiteral(
"alti" ),
734 QStringLiteral(
"dhm" ),
735 QStringLiteral(
"dgm" ),
736 QStringLiteral(
"dom" ),
737 QStringLiteral(
"Höhe" ),
738 QStringLiteral(
"Hoehe" ) };
739 const QString layerName = layer->
name();
740 for (
const QString &candidate : sPartialCandidates )
742 if ( layerName.contains( candidate, Qt::CaseInsensitive ) )
747 static const QStringList sWordCandidates{ QStringLiteral(
"aster" ) };
748 for (
const QString &candidate : sWordCandidates )
750 const thread_local QRegularExpression re( QStringLiteral(
"\\b%1\\b" ).arg( candidate ) );
751 if ( re.match( layerName, Qt::CaseInsensitive ).hasMatch() )
758void QgsRasterLayerElevationProperties::setDefaultProfileLineSymbol(
const QColor &color )
760 auto profileLineLayer = std::make_unique< QgsSimpleLineSymbolLayer >( color, 0.6 );
761 mProfileLineSymbol = std::make_unique< QgsLineSymbol>(
QgsSymbolLayerList( { profileLineLayer.release() } ) );
764void QgsRasterLayerElevationProperties::setDefaultProfileFillSymbol(
const QColor &color )
766 auto profileFillLayer = std::make_unique< QgsSimpleFillSymbolLayer >( color );
767 profileFillLayer->setStrokeStyle( Qt::NoPen );
768 mProfileFillSymbol = std::make_unique< QgsFillSymbol>(
QgsSymbolLayerList( { profileFillLayer.release() } ) );
773 return mRangePerBand;
778 if ( ranges == mRangePerBand )
781 mRangePerBand = ranges;
792 if ( range == mFixedRange )
RasterElevationMode
Raster layer elevation modes.
@ FixedRangePerBand
Layer has a fixed (manually specified) elevation range per band.
@ FixedElevationRange
Layer has a fixed elevation range.
@ RepresentsElevationSurface
Pixel values represent an elevation surface.
@ DynamicRangePerBand
Layer has a elevation range per band, calculated dynamically from an expression.
@ Float32
Thirty two bit floating point (float).
@ CFloat64
Complex Float64.
@ Int16
Sixteen bit signed integer (qint16).
@ ARGB32_Premultiplied
Color, alpha, red, green, blue, 4 bytes the same as QImage::Format_ARGB32_Premultiplied.
@ Int8
Eight bit signed integer (qint8) (added in QGIS 3.30).
@ UInt16
Sixteen bit unsigned integer (quint16).
@ Byte
Eight bit unsigned integer (quint8).
@ UnknownDataType
Unknown or unspecified type.
@ ARGB32
Color, alpha, red, green, blue, 4 bytes the same as QImage::Format_ARGB32.
@ Int32
Thirty two bit signed integer (qint32).
@ Float64
Sixty four bit floating point (double).
@ CFloat32
Complex Float32.
@ UInt32
Thirty two bit unsigned integer (quint32).
ProfileSurfaceSymbology
Surface symbology type for elevation profile plots.
@ Line
The elevation surface will be rendered using a line symbol.
static QgsColorSchemeRegistry * colorSchemeRegistry()
Returns the application's color scheme registry, used for managing color schemes.
QColor fetchRandomStyleColor() const
Returns a random color for use with a new symbol style (e.g.
QgsRange which stores a range of double values.
bool isInfinite() const
Returns true if the range consists of all possible values.
Single scope for storing variables and functions for use within a QgsExpressionContext.
void addVariable(const QgsExpressionContextScope::StaticVariable &variable)
Adds a variable into the context scope.
void setVariable(const QString &name, const QVariant &value, bool isStatic=false)
Convenience method for setting a variable in the context scope by name name and value.
static QList< QgsExpressionContextScope * > globalProjectLayerScopes(const QgsMapLayer *layer)
Creates a list of three scopes: global, layer's project and layer.
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
void appendScope(QgsExpressionContextScope *scope)
Appends a scope to the end of the context.
void appendScopes(const QList< QgsExpressionContextScope * > &scopes)
Appends a list of scopes to the end of the context.
A fill symbol type, for rendering Polygon and MultiPolygon geometries.
A line symbol type, for rendering LineString and MultiLineString geometries.
QgsPropertyCollection mDataDefinedProperties
Property collection for data defined elevation settings.
void writeCommonProperties(QDomElement &element, QDomDocument &doc, const QgsReadWriteContext &context)
Writes common class properties to a DOM element, to be used later with readXml().
void profileGenerationPropertyChanged()
Emitted when any of the elevation properties which relate solely to generation of elevation profiles ...
QgsMapLayerElevationProperties(QObject *parent)
Constructor for QgsMapLayerElevationProperties, with the specified parent object.
void readCommonProperties(const QDomElement &element, const QgsReadWriteContext &context)
Reads common class properties from a DOM element previously written by writeXml().
void changed()
Emitted when any of the elevation properties have changed.
void profileRenderingPropertyChanged()
Emitted when any of the elevation properties which relate solely to presentation of elevation results...
@ RasterPerBandUpperElevation
Upper elevation for each raster band.
@ RasterPerBandLowerElevation
Lower elevation for each raster band.
@ FlagDontInvalidateCachedRendersWhenRangeChanges
Any cached rendering will not be invalidated when z range context is modified.
Base class for all map layer types.
A store for object properties.
double valueAsDouble(const QgsExpressionContext &context, double defaultValue=0.0, bool *ok=nullptr) const
Calculates the current value of the property and interprets it as a double.
bool prepare(const QgsExpressionContext &context=QgsExpressionContext()) const
Prepares the property against a specified expression context.
bool includeUpper() const
Returns true if the upper bound is inclusive, or false if the upper bound is exclusive.
bool overlaps(const QgsRange< T > &other) const
Returns true if this range overlaps another range.
T upper() const
Returns the upper bound of the range.
Base class for raster data providers.
virtual QString bandDescription(int bandNumber)
Returns the description for band bandNumber, or an empty string if the band is not valid or has not d...
QString displayBandName(int bandNumber) const
Generates a friendly, descriptive name for the specified bandNumber.
QgsDoubleRange fixedRange() const
Returns the fixed elevation range for the raster.
void setProfileFillSymbol(QgsFillSymbol *symbol)
Sets the fill symbol used to render the raster profile in elevation profile plots.
void setFixedRange(const QgsDoubleRange &range)
Sets the fixed elevation range for the raster.
~QgsRasterLayerElevationProperties() override
QgsDoubleRange elevationRangeForPixelValue(QgsRasterLayer *layer, int band, double pixelValue) const
Returns the elevation range corresponding to a raw pixel value from the specified band.
QList< double > significantZValues(QgsMapLayer *layer) const override
Returns a list of significant elevation/z-values for the specified layer, using the settings defined ...
Qgis::RasterElevationMode mode() const
Returns the elevation mode.
QgsLineSymbol * profileLineSymbol() const
Returns the line symbol used to render the raster profile in elevation profile plots.
bool hasElevation() const override
Returns true if the layer has an elevation or z component.
QgsRasterLayerElevationProperties * clone() const override
Creates a clone of the properties.
QgsDoubleRange calculateZRange(QgsMapLayer *layer) const override
Attempts to calculate the overall elevation or z range for the specified layer, using the settings de...
QgsMapLayerElevationProperties::Flags flags() const override
Returns flags associated to the elevation properties.
void setBandNumber(int band)
Sets the band number from which the elevation should be taken.
int bandForElevationRange(QgsRasterLayer *layer, const QgsDoubleRange &range) const
Returns the band corresponding to the specified range.
QString htmlSummary() const override
Returns a HTML formatted summary of the properties.
void setElevationLimit(double limit)
Sets the elevation limit, which is used when profileSymbology() is Qgis::ProfileSurfaceSymbology::Fil...
void setFixedRangePerBand(const QMap< int, QgsDoubleRange > &ranges)
Sets the fixed elevation range for each band.
bool isVisibleInZRange(const QgsDoubleRange &range, QgsMapLayer *layer=nullptr) const override
Returns true if the layer should be visible and rendered for the specified z range.
void setProfileSymbology(Qgis::ProfileSurfaceSymbology symbology)
Sets the symbology option used to render the raster profile in elevation profile plots.
QMap< int, QgsDoubleRange > fixedRangePerBand() const
Returns the fixed elevation range for each band.
static bool layerLooksLikeDem(QgsRasterLayer *layer)
Returns true if a raster layer looks like a DEM.
QDomElement writeXml(QDomElement &element, QDomDocument &doc, const QgsReadWriteContext &context) override
Writes the properties to a DOM element, to be used later with readXml().
QgsFillSymbol * profileFillSymbol() const
Returns the fill symbol used to render the raster profile in elevation profile plots.
double elevationLimit() const
Returns the elevation limit, which is used when profileSymbology() is Qgis::ProfileSurfaceSymbology::...
void setProfileLineSymbol(QgsLineSymbol *symbol)
Sets the line symbol used to render the raster profile in elevation profile plots.
void setMode(Qgis::RasterElevationMode mode)
Sets the elevation mode.
void setEnabled(bool enabled)
Sets whether the elevation properties are enabled, i.e.
QgsRasterLayerElevationProperties(QObject *parent)
Constructor for QgsRasterLayerElevationProperties, with the specified parent object.
bool readXml(const QDomElement &element, const QgsReadWriteContext &context) override
Reads the elevation properties from a DOM element previously written by writeXml().
bool showByDefaultInElevationProfilePlots() const override
Returns true if the layer should be visible by default in newly created elevation profile plots.
Represents a raster layer.
QgsRasterAttributeTable * attributeTable(int bandNumber) const
Returns the (possibly NULL) raster attribute table for the given band bandNumber.
int bandCount() const
Returns the number of bands in this layer.
QgsRasterDataProvider * dataProvider() override
Returns the source data provider.
A container for the context for various read/write operations on objects.
static std::unique_ptr< QgsSymbol > loadSymbol(const QDomElement &element, const QgsReadWriteContext &context)
Attempts to load a symbol from a DOM element.
static QDomElement saveSymbol(const QString &symbolName, const QgsSymbol *symbol, QDomDocument &doc, const QgsReadWriteContext &context)
Writes a symbol definition to XML.
T qgsEnumKeyToValue(const QString &key, const T &defaultValue, bool tryValueAsKey=true, bool *returnOk=nullptr)
Returns the value corresponding to the given key of an enum.
QString qgsDoubleToString(double a, int precision=17)
Returns a string representation of a double.
QString qgsEnumValueToKey(const T &value, bool *returnOk=nullptr)
Returns the value for the given key of an enum.
#define BUILTIN_UNREACHABLE
bool qgsDoubleNear(double a, double b, double epsilon=4 *std::numeric_limits< double >::epsilon())
Compare two doubles (but allow some difference).
QList< QgsSymbolLayer * > QgsSymbolLayerList
Single variable definition for use within a QgsExpressionContextScope.