19#include "moc_qgsrasterlayerelevationproperties.cpp"
34 setDefaultProfileLineSymbol( color );
35 setDefaultProfileFillSymbol( color );
47 QDomElement element = document.createElement( QStringLiteral(
"elevation" ) );
48 element.setAttribute( QStringLiteral(
"enabled" ), mEnabled ? QStringLiteral(
"1" ) : QStringLiteral(
"0" ) );
50 element.setAttribute( QStringLiteral(
"symbology" ),
qgsEnumValueToKey( mSymbology ) );
51 if ( !std::isnan( mElevationLimit ) )
52 element.setAttribute( QStringLiteral(
"elevationLimit" ),
qgsDoubleToString( mElevationLimit ) );
61 element.setAttribute( QStringLiteral(
"includeLower" ), mFixedRange.
includeLower() ?
"1" :
"0" );
62 element.setAttribute( QStringLiteral(
"includeUpper" ), mFixedRange.
includeUpper() ?
"1" :
"0" );
67 QDomElement ranges = document.createElement( QStringLiteral(
"ranges" ) );
68 for (
auto it = mRangePerBand.constBegin(); it != mRangePerBand.constEnd(); ++it )
70 QDomElement range = document.createElement( QStringLiteral(
"range" ) );
71 range.setAttribute( QStringLiteral(
"band" ), it.key() );
72 range.setAttribute( QStringLiteral(
"lower" ),
qgsDoubleToString( it.value().lower() ) );
73 range.setAttribute( QStringLiteral(
"upper" ),
qgsDoubleToString( it.value().upper() ) );
74 range.setAttribute( QStringLiteral(
"includeLower" ), it.value().includeLower() ?
"1" :
"0" );
75 range.setAttribute( QStringLiteral(
"includeUpper" ), it.value().includeUpper() ?
"1" :
"0" );
76 ranges.appendChild( range );
78 element.appendChild( ranges );
86 element.setAttribute( QStringLiteral(
"band" ), mBandNumber );
90 QDomElement profileLineSymbolElement = document.createElement( QStringLiteral(
"profileLineSymbol" ) );
92 element.appendChild( profileLineSymbolElement );
94 QDomElement profileFillSymbolElement = document.createElement( QStringLiteral(
"profileFillSymbol" ) );
96 element.appendChild( profileFillSymbolElement );
98 parentElement.appendChild( element );
104 const QDomElement elevationElement = element.firstChildElement( QStringLiteral(
"elevation" ) ).toElement();
105 mEnabled = elevationElement.attribute( QStringLiteral(
"enabled" ), QStringLiteral(
"0" ) ).toInt();
108 if ( elevationElement.hasAttribute( QStringLiteral(
"elevationLimit" ) ) )
109 mElevationLimit = elevationElement.attribute( QStringLiteral(
"elevationLimit" ) ).toDouble();
111 mElevationLimit = std::numeric_limits< double >::quiet_NaN();
119 const double lower = elevationElement.attribute( QStringLiteral(
"lower" ) ).toDouble();
120 const double upper = elevationElement.attribute( QStringLiteral(
"upper" ) ).toDouble();
121 const bool includeLower = elevationElement.attribute( QStringLiteral(
"includeLower" ) ).toInt();
122 const bool includeUpper = elevationElement.attribute( QStringLiteral(
"includeUpper" ) ).toInt();
123 mFixedRange =
QgsDoubleRange( lower, upper, includeLower, includeUpper );
129 mRangePerBand.clear();
131 const QDomNodeList ranges = elevationElement.firstChildElement( QStringLiteral(
"ranges" ) ).childNodes();
132 for (
int i = 0; i < ranges.size(); ++i )
134 const QDomElement rangeElement = ranges.at( i ).toElement();
135 const int band = rangeElement.attribute( QStringLiteral(
"band" ) ).toInt();
136 const double lower = rangeElement.attribute( QStringLiteral(
"lower" ) ).toDouble();
137 const double upper = rangeElement.attribute( QStringLiteral(
"upper" ) ).toDouble();
138 const bool includeLower = rangeElement.attribute( QStringLiteral(
"includeLower" ) ).toInt();
139 const bool includeUpper = rangeElement.attribute( QStringLiteral(
"includeUpper" ) ).toInt();
140 mRangePerBand.insert( band,
QgsDoubleRange( lower, upper, includeLower, includeUpper ) );
149 mBandNumber = elevationElement.attribute( QStringLiteral(
"band" ), QStringLiteral(
"1" ) ).toInt();
155 const QDomElement profileLineSymbolElement = elevationElement.firstChildElement( QStringLiteral(
"profileLineSymbol" ) ).firstChildElement( QStringLiteral(
"symbol" ) );
156 mProfileLineSymbol.reset( QgsSymbolLayerUtils::loadSymbol< QgsLineSymbol >( profileLineSymbolElement, context ) );
157 if ( !mProfileLineSymbol )
158 setDefaultProfileLineSymbol( defaultColor );
160 const QDomElement profileFillSymbolElement = elevationElement.firstChildElement( QStringLiteral(
"profileFillSymbol" ) ).firstChildElement( QStringLiteral(
"symbol" ) );
161 mProfileFillSymbol.reset( QgsSymbolLayerUtils::loadSymbol< QgsFillSymbol >( profileFillSymbolElement, context ) );
162 if ( !mProfileFillSymbol )
163 setDefaultProfileFillSymbol( defaultColor );
170 std::unique_ptr< QgsRasterLayerElevationProperties > res = std::make_unique< QgsRasterLayerElevationProperties >(
nullptr );
171 res->setEnabled( mEnabled );
172 res->setMode( mMode );
173 res->setProfileLineSymbol( mProfileLineSymbol->clone() );
174 res->setProfileFillSymbol( mProfileFillSymbol->clone() );
175 res->setProfileSymbology( mSymbology );
176 res->setElevationLimit( mElevationLimit );
177 res->setBandNumber( mBandNumber );
178 res->setFixedRange( mFixedRange );
179 res->setFixedRangePerBand( mRangePerBand );
180 res->copyCommonProperties(
this );
181 return res.release();
186 QStringList properties;
190 properties << tr(
"Elevation range: %1 to %2" ).arg( mFixedRange.
lower() ).arg( mFixedRange.
upper() );
195 for (
auto it = mRangePerBand.constBegin(); it != mRangePerBand.constEnd(); ++it )
197 properties << tr(
"Elevation for band %1: %2 to %3" ).arg( it.key() ).arg( it.value().lower() ).arg( it.value().upper() );
206 properties << tr(
"Elevation band: %1" ).arg( mBandNumber );
207 properties << tr(
"Scale: %1" ).arg(
mZScale );
208 properties << tr(
"Offset: %1" ).arg(
mZOffset );
212 return QStringLiteral(
"<li>%1</li>" ).arg( properties.join( QLatin1String(
"</li><li>" ) ) );
220 return mFixedRange.
overlaps( range );
224 for (
auto it = mRangePerBand.constBegin(); it != mRangePerBand.constEnd(); ++it )
226 if ( it.value().overlaps( range ) )
234 if (
QgsRasterLayer *rl = qobject_cast< QgsRasterLayer * >( layer ) )
246 lowerProperty.
prepare( context );
247 upperProperty.
prepare( context );
248 for (
int band = 1; band <= rl->bandCount(); ++band )
250 bandScope->
setVariable( QStringLiteral(
"band" ), band );
251 bandScope->
setVariable( QStringLiteral(
"band_name" ), rl->dataProvider()->displayBandName( band ) );
252 bandScope->
setVariable( QStringLiteral(
"band_description" ), rl->dataProvider()->bandDescription( band ) );
255 const double lower = lowerProperty.
valueAsDouble( context, 0, &ok );
258 const double upper = upperProperty.
valueAsDouble( context, 0, &ok );
285 double lower = std::numeric_limits< double >::max();
286 double upper = std::numeric_limits< double >::min();
287 bool includeLower =
true;
288 bool includeUpper =
true;
289 for (
auto it = mRangePerBand.constBegin(); it != mRangePerBand.constEnd(); ++it )
291 if ( it.value().lower() < lower )
293 lower = it.value().lower();
294 includeLower = it.value().includeLower();
296 else if ( !includeLower && it.value().lower() == lower && it.value().includeLower() )
300 if ( it.value().upper() > upper )
302 upper = it.value().upper();
303 includeUpper = it.value().includeUpper();
305 else if ( !includeUpper && it.value().upper() == upper && it.value().includeUpper() )
310 return QgsDoubleRange( lower, upper, includeLower, includeUpper );
315 if (
QgsRasterLayer *rl = qobject_cast< QgsRasterLayer * >( layer ) )
327 lowerProperty.
prepare( context );
328 upperProperty.
prepare( context );
329 double minLower = std::numeric_limits<double>::max();
330 double maxUpper = std::numeric_limits<double>::lowest();
331 for (
int band = 1; band <= rl->bandCount(); ++band )
333 bandScope->
setVariable( QStringLiteral(
"band" ), band );
334 bandScope->
setVariable( QStringLiteral(
"band_name" ), rl->dataProvider()->displayBandName( band ) );
335 bandScope->
setVariable( QStringLiteral(
"band_description" ), rl->dataProvider()->bandDescription( band ) );
338 const double lower = lowerProperty.
valueAsDouble( context, 0, &ok );
341 const double upper = upperProperty.
valueAsDouble( context, 0, &ok );
345 minLower = std::min( minLower, lower );
346 maxUpper = std::max( maxUpper, upper );
348 return ( minLower == std::numeric_limits<double>::max() && maxUpper == std::numeric_limits<double>::lowest() ) ?
QgsDoubleRange() :
QgsDoubleRange( minLower, maxUpper );
367 return { mFixedRange.
lower(), mFixedRange.
upper() };
369 return { mFixedRange.
lower() };
377 for (
auto it = mRangePerBand.constBegin(); it != mRangePerBand.constEnd(); ++it )
379 if ( it.value().isInfinite() )
382 if ( !res.contains( it.value().lower( ) ) )
383 res.append( it.value().lower() );
384 if ( !res.contains( it.value().upper( ) ) )
385 res.append( it.value().upper() );
387 std::sort( res.begin(), res.end() );
394 if (
QgsRasterLayer *rl = qobject_cast< QgsRasterLayer * >( layer ) )
406 lowerProperty.
prepare( context );
407 upperProperty.
prepare( context );
408 for (
int band = 1; band <= rl->bandCount(); ++band )
410 bandScope->
setVariable( QStringLiteral(
"band" ), band );
411 bandScope->
setVariable( QStringLiteral(
"band_name" ), rl->dataProvider()->displayBandName( band ) );
412 bandScope->
setVariable( QStringLiteral(
"band_description" ), rl->dataProvider()->bandDescription( band ) );
415 const double lower = lowerProperty.
valueAsDouble( context, 0, &ok );
416 if ( ok && !res.contains( lower ) )
418 const double upper = upperProperty.
valueAsDouble( context, 0, &ok );
419 if ( ok && !res.contains( upper ) )
457 if ( enabled == mEnabled )
481 if ( mBandNumber == band )
491 if ( !mEnabled || std::isnan( pixelValue ) )
501 auto it = mRangePerBand.constFind( band );
502 if ( it != mRangePerBand.constEnd() )
509 if ( layer && band > 0 && band <= layer->bandCount() )
521 lowerProperty.
prepare( context );
522 upperProperty.
prepare( context );
525 const double lower = lowerProperty.
valueAsDouble( context, 0, &ok );
528 const double upper = upperProperty.
valueAsDouble( context, 0, &ok );
540 if ( band != mBandNumber )
561 int currentMatchingBand = -1;
563 for (
auto it = mRangePerBand.constBegin(); it != mRangePerBand.constEnd(); ++it )
565 if ( it.value().overlaps( range ) )
568 || ( it.value().includeUpper() && it.value().upper() >= currentMatchingRange.
upper() )
569 || ( !currentMatchingRange.
includeUpper() && it.value().upper() >= currentMatchingRange.
upper() ) )
571 currentMatchingBand = it.key();
572 currentMatchingRange = it.value();
576 return currentMatchingBand;
590 lowerProperty.
prepare( context );
591 upperProperty.
prepare( context );
593 int currentMatchingBand = -1;
596 for (
int band = 1; band <= layer->
bandCount(); ++band )
598 bandScope->
setVariable( QStringLiteral(
"band" ), band );
603 const double lower = lowerProperty.
valueAsDouble( context, 0, &ok );
606 const double upper = upperProperty.
valueAsDouble( context, 0, &ok );
617 currentMatchingBand = band;
618 currentMatchingRange = bandRange;
622 return currentMatchingBand;
632 return mProfileLineSymbol.get();
637 mProfileLineSymbol.reset( symbol );
644 return mProfileFillSymbol.get();
649 mProfileFillSymbol.reset( symbol );
656 if ( mSymbology == symbology )
659 mSymbology = symbology;
666 return mElevationLimit;
674 mElevationLimit = limit;
692 switch ( dataProvider->dataType( 1 ) )
718 static const QStringList sPartialCandidates{ QStringLiteral(
"dem" ),
719 QStringLiteral(
"dtm" ),
720 QStringLiteral(
"dsm" ),
721 QStringLiteral(
"height" ),
722 QStringLiteral(
"elev" ),
723 QStringLiteral(
"srtm" ),
725 QStringLiteral(
"mne" ),
726 QStringLiteral(
"mnt" ),
727 QStringLiteral(
"mns" ),
728 QStringLiteral(
"rge" ),
729 QStringLiteral(
"alti" ),
731 QStringLiteral(
"dhm" ),
732 QStringLiteral(
"dgm" ),
733 QStringLiteral(
"dom" ),
734 QStringLiteral(
"Höhe" ),
735 QStringLiteral(
"Hoehe" ) };
736 const QString layerName = layer->
name();
737 for (
const QString &candidate : sPartialCandidates )
739 if ( layerName.contains( candidate, Qt::CaseInsensitive ) )
744 static const QStringList sWordCandidates{ QStringLiteral(
"aster" ) };
745 for (
const QString &candidate : sWordCandidates )
747 const thread_local QRegularExpression re( QStringLiteral(
"\\b%1\\b" ).arg( candidate ) );
748 if ( re.match( layerName, Qt::CaseInsensitive ).hasMatch() )
755void QgsRasterLayerElevationProperties::setDefaultProfileLineSymbol(
const QColor &color )
757 std::unique_ptr< QgsSimpleLineSymbolLayer > profileLineLayer = std::make_unique< QgsSimpleLineSymbolLayer >( color, 0.6 );
758 mProfileLineSymbol = std::make_unique< QgsLineSymbol>(
QgsSymbolLayerList( { profileLineLayer.release() } ) );
761void QgsRasterLayerElevationProperties::setDefaultProfileFillSymbol(
const QColor &color )
763 std::unique_ptr< QgsSimpleFillSymbolLayer > profileFillLayer = std::make_unique< QgsSimpleFillSymbolLayer >( color );
764 profileFillLayer->setStrokeStyle( Qt::NoPen );
765 mProfileFillSymbol = std::make_unique< QgsFillSymbol>(
QgsSymbolLayerList( { profileFillLayer.release() } ) );
770 return mRangePerBand;
775 if ( ranges == mRangePerBand )
778 mRangePerBand = ranges;
789 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.
Base class for storage of map layer elevation properties.
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 ...
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.
QgsProperty property(int key) const final
Returns a matching property from the collection, if one exists.
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 lower() const
Returns the lower bound of the range.
bool includeLower() const
Returns true if the lower bound is inclusive, or false if the lower bound is exclusive.
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.
Raster layer specific subclass of QgsMapLayerElevationProperties.
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.
The class is used as a container of context for various read/write operations on other objects.
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.