QGIS API Documentation 3.99.0-Master (e9821da5c6b)
Loading...
Searching...
No Matches
qgssinglebandgrayrendererwidget.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgssinglebandgrayrendererwidget.h
3 ---------------------------------
4 begin : March 2012
5 copyright : (C) 2012 by Marco Hugentobler
6 email : marco at sourcepole dot ch
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
19
21#include "qgsdoublevalidator.h"
23#include "qgsrasterlayer.h"
26
27#include <QString>
28
29#include "moc_qgssinglebandgrayrendererwidget.cpp"
30
31using namespace Qt::StringLiterals;
32
34 : QgsRasterRendererWidget( layer, extent )
35{
36 setupUi( this );
37 connect( mMinLineEdit, &QLineEdit::textChanged, this, &QgsSingleBandGrayRendererWidget::mMinLineEdit_textChanged );
38 connect( mMaxLineEdit, &QLineEdit::textChanged, this, &QgsSingleBandGrayRendererWidget::mMaxLineEdit_textChanged );
39
40 connect( mLegendSettingsButton, &QPushButton::clicked, this, &QgsSingleBandGrayRendererWidget::showLegendSettings );
41
42 mGradientComboBox->insertItem( 0, tr( "Black to White" ), QgsSingleBandGrayRenderer::BlackToWhite );
43 mGradientComboBox->insertItem( 1, tr( "White to Black" ), QgsSingleBandGrayRenderer::WhiteToBlack );
44
45 mMinLineEdit->setValidator( new QgsDoubleValidator( mMinLineEdit ) );
46 mMaxLineEdit->setValidator( new QgsDoubleValidator( mMaxLineEdit ) );
47
48 if ( mRasterLayer )
49 {
50 QgsRasterDataProvider *provider = mRasterLayer->dataProvider();
51 if ( !provider )
52 {
53 return;
54 }
55
56 mMinMaxWidget = new QgsRasterMinMaxWidget( layer, this );
57 mMinMaxWidget->setExtent( extent );
58 mMinMaxWidget->setMapCanvas( mCanvas );
59
60 QHBoxLayout *layout = new QHBoxLayout();
61 layout->setContentsMargins( 0, 0, 0, 0 );
62 mMinMaxContainerWidget->setLayout( layout );
63 layout->addWidget( mMinMaxWidget );
64
66
68
69 mGrayBandComboBox->setLayer( mRasterLayer );
70
71 //contrast enhancement algorithms
72 mContrastEnhancementComboBox->addItem( tr( "No Enhancement" ), QgsContrastEnhancement::NoEnhancement );
73 mContrastEnhancementComboBox->addItem( tr( "Stretch to MinMax" ), QgsContrastEnhancement::StretchToMinimumMaximum );
74 mContrastEnhancementComboBox->addItem( tr( "Stretch and Clip to MinMax" ), QgsContrastEnhancement::StretchAndClipToMinimumMaximum );
75 mContrastEnhancementComboBox->addItem( tr( "Clip to MinMax" ), QgsContrastEnhancement::ClipToMinimumMaximum );
76
77 setFromRenderer( layer->renderer() );
78
79 connect( mGrayBandComboBox, &QgsRasterBandComboBox::bandChanged, this, &QgsSingleBandGrayRendererWidget::bandChanged );
80 connect( mGradientComboBox, static_cast<void ( QComboBox::* )( int )>( &QComboBox::currentIndexChanged ), this, &QgsRasterRendererWidget::widgetChanged );
81 connect( mContrastEnhancementComboBox, static_cast<void ( QComboBox::* )( int )>( &QComboBox::currentIndexChanged ), this, &QgsRasterRendererWidget::widgetChanged );
82 }
83}
84
86{
87 if ( !mRasterLayer )
88 {
89 return nullptr;
90 }
91 QgsRasterDataProvider *provider = mRasterLayer->dataProvider();
92 if ( !provider )
93 {
94 return nullptr;
95 }
96 const int band = mGrayBandComboBox->currentBand();
97
99 provider->dataType( band )
100 ) );
101 e->setMinimumValue( QgsDoubleValidator::toDouble( mMinLineEdit->text() ) );
102 e->setMaximumValue( QgsDoubleValidator::toDouble( mMaxLineEdit->text() ) );
103 e->setContrastEnhancementAlgorithm( ( QgsContrastEnhancement::ContrastEnhancementAlgorithm )( mContrastEnhancementComboBox->currentData().toInt() ) );
104
106 renderer->setContrastEnhancement( e );
107
108 renderer->setGradient( ( QgsSingleBandGrayRenderer::Gradient ) mGradientComboBox->currentData().toInt() );
109 renderer->setMinMaxOrigin( mMinMaxWidget->minMaxOrigin() );
110
111 renderer->setLegendSettings( new QgsColorRampLegendNodeSettings( mLegendSettings ) );
112
113 return renderer;
114}
115
117{
118 mMinMaxWidget->doComputations();
119}
120
122{
124 mMinMaxWidget->setMapCanvas( canvas );
125}
126
127void QgsSingleBandGrayRendererWidget::mMinLineEdit_textChanged( const QString & )
128{
129 minMaxModified();
130}
131
132void QgsSingleBandGrayRendererWidget::mMaxLineEdit_textChanged( const QString & )
133{
134 minMaxModified();
135}
136
137void QgsSingleBandGrayRendererWidget::minMaxModified()
138{
139 if ( !mDisableMinMaxWidgetRefresh )
140 {
141 if ( ( QgsContrastEnhancement::ContrastEnhancementAlgorithm )( mContrastEnhancementComboBox->currentData().toInt() ) == QgsContrastEnhancement::NoEnhancement )
142 {
143 mContrastEnhancementComboBox->setCurrentIndex(
144 mContrastEnhancementComboBox->findData( ( int ) QgsContrastEnhancement::StretchToMinimumMaximum )
145 );
146 }
147 mMinMaxWidget->userHasSetManualMinMaxValues();
148 emit widgetChanged();
149 }
150}
151
152
153void QgsSingleBandGrayRendererWidget::loadMinMax( int bandNo, double min, double max )
154{
155 Q_UNUSED( bandNo )
156
157 QgsDebugMsgLevel( u"theBandNo = %1 min = %2 max = %3"_s.arg( bandNo ).arg( min ).arg( max ), 2 );
158
159 mDisableMinMaxWidgetRefresh = true;
160 if ( std::isnan( min ) )
161 {
162 mMinLineEdit->clear();
163 }
164 else
165 {
166 mMinLineEdit->setText( QLocale().toString( min ) );
167 }
168
169 if ( std::isnan( max ) )
170 {
171 mMaxLineEdit->clear();
172 }
173 else
174 {
175 mMaxLineEdit->setText( QLocale().toString( max ) );
176 }
177 mDisableMinMaxWidgetRefresh = false;
178}
179
180void QgsSingleBandGrayRendererWidget::bandChanged()
181{
182 QList<int> myBands;
183 myBands.append( mGrayBandComboBox->currentBand() );
184 mMinMaxWidget->setBands( myBands );
185 emit widgetChanged();
186}
187
189{
190 const QgsSingleBandGrayRenderer *gr = dynamic_cast<const QgsSingleBandGrayRenderer *>( r );
191 if ( gr )
192 {
193 //band
194 mGrayBandComboBox->setBand( gr->inputBand() );
195 mMinMaxWidget->setBands( QList<int>() << gr->inputBand() );
196 mGradientComboBox->setCurrentIndex( mGradientComboBox->findData( gr->gradient() ) );
197
199 if ( ce )
200 {
201 //minmax
202 mDisableMinMaxWidgetRefresh = true;
203 mMinLineEdit->setText( QLocale().toString( ce->minimumValue() ) );
204 mMaxLineEdit->setText( QLocale().toString( ce->maximumValue() ) );
205 mDisableMinMaxWidgetRefresh = false;
206 //contrast enhancement algorithm
207 mContrastEnhancementComboBox->setCurrentIndex(
208 mContrastEnhancementComboBox->findData( ( int ) ( ce->contrastEnhancementAlgorithm() ) )
209 );
210 }
211
212 mMinMaxWidget->setFromMinMaxOrigin( gr->minMaxOrigin() );
213
214 if ( gr->legendSettings() )
215 mLegendSettings = *gr->legendSettings();
216 }
217}
218
219void QgsSingleBandGrayRendererWidget::setMin( const QString &value, int )
220{
221 mDisableMinMaxWidgetRefresh = true;
222 mMinLineEdit->setText( value );
223 mDisableMinMaxWidgetRefresh = false;
224}
225
226void QgsSingleBandGrayRendererWidget::setMax( const QString &value, int )
227{
228 mDisableMinMaxWidgetRefresh = true;
229 mMaxLineEdit->setText( value );
230 mDisableMinMaxWidgetRefresh = false;
231}
232
233void QgsSingleBandGrayRendererWidget::showLegendSettings()
234{
235 QgsPanelWidget *panel = QgsPanelWidget::findParentPanel( qobject_cast<QWidget *>( parent() ) );
236 if ( panel && panel->dockMode() )
237 {
239 legendPanel->setUseContinuousRampCheckBoxVisibility( false );
240 legendPanel->setPanelTitle( tr( "Legend Settings" ) );
241 legendPanel->setSettings( mLegendSettings );
242 connect( legendPanel, &QgsColorRampLegendNodeWidget::widgetChanged, this, [this, legendPanel] {
243 mLegendSettings = legendPanel->settings();
244 emit widgetChanged();
245 } );
246 panel->openPanel( legendPanel );
247 }
248 else
249 {
250 QgsColorRampLegendNodeDialog dialog( mLegendSettings, this );
251 dialog.setUseContinuousRampCheckBoxVisibility( false );
252 dialog.setWindowTitle( tr( "Legend Settings" ) );
253 if ( dialog.exec() )
254 {
255 mLegendSettings = dialog.settings();
256 emit widgetChanged();
257 }
258 }
259}
260
265
267{
268 mDisableMinMaxWidgetRefresh = true;
269 mContrastEnhancementComboBox->setCurrentIndex( mContrastEnhancementComboBox->findData( static_cast<int>( algorithm ) ) );
270 mDisableMinMaxWidgetRefresh = false;
271}
DataType
Raster data types.
Definition qgis.h:379
Settings for a color ramp legend node.
A widget for properties relating to a QgsColorRampLegendNode (QgsColorRampLegendNodeSettings).
QgsColorRampLegendNodeSettings settings() const
Returns the legend node settings as defined by the widget.
void setSettings(const QgsColorRampLegendNodeSettings &settings)
Sets the settings to show in the widget.
void setUseContinuousRampCheckBoxVisibility(bool visible)
Sets visibility for the "Use Continuous Legend" checkbox to visible.
Handles contrast enhancement and clipping.
ContrastEnhancementAlgorithm
This enumerator describes the types of contrast enhancement algorithms that can be used.
@ StretchToMinimumMaximum
Linear histogram.
@ NoEnhancement
Default color scaling algorithm, no scaling is applied.
void setMinimumValue(double value, bool generateTable=true)
Sets the minimum value for the contrast enhancement range.
void setContrastEnhancementAlgorithm(ContrastEnhancementAlgorithm algorithm, bool generateTable=true)
Sets the contrast enhancement algorithm.
double minimumValue() const
Returns the minimum value for the contrast enhancement range.
ContrastEnhancementAlgorithm contrastEnhancementAlgorithm() const
void setMaximumValue(double value, bool generateTable=true)
Sets the maximum value for the contrast enhancement range.
double maximumValue() const
Returns the maximum value for the contrast enhancement range.
A custom validator which allows entry of doubles in a locale-tolerant way.
static double toDouble(const QString &input, bool *ok)
Converts input string to double value.
Map canvas is a class for displaying all GIS data types on a canvas.
Base class for any widget that can be shown as an inline panel.
void openPanel(QgsPanelWidget *panel)
Open a panel or dialog depending on dock mode setting If dock mode is true this method will emit the ...
bool dockMode() const
Returns the dock mode state.
void widgetChanged()
Emitted when the widget state changes.
static QgsPanelWidget * findParentPanel(QWidget *widget)
Traces through the parents of a widget to find if it is contained within a QgsPanelWidget widget.
void setPanelTitle(const QString &panelTitle)
Set the title of the panel when shown in the interface.
void bandChanged(int band)
Emitted when the currently selected band changes.
Base class for raster data providers.
Qgis::DataType dataType(int bandNo) const override=0
Returns data type for the band specified by number.
Represents a raster layer.
QgsRasterRenderer * renderer() const
Returns the raster's renderer.
A widget for configuring how the minimum and maximum value of a raster layer is determined.
void load(int bandNo, double min, double max)
signal emitted when new min/max values are computed from statistics.
void setBands(const QList< int > &bands)
void widgetChanged()
Emitted when something on the widget has changed.
virtual void setMapCanvas(QgsMapCanvas *canvas)
Sets the map canvas associated with the widget.
QgsMapCanvas * mCanvas
Associated map canvas.
QgsRasterRendererWidget(QgsRasterLayer *layer, const QgsRectangle &extent)
Constructor for QgsRasterRendererWidget.
void widgetChanged()
Emitted when something on the widget has changed.
Raster renderer pipe that applies colors to a raster.
const QgsRasterMinMaxOrigin & minMaxOrigin() const
Returns const reference to origin of min/max values.
A rectangle specified with double values.
void setFromRenderer(const QgsRasterRenderer *r)
Sets the widget state from the specified renderer.
QgsRasterRenderer * renderer() override
Creates a new renderer, using the properties defined in the widget.
void doComputations() override
Load programmatically with current values.
QgsSingleBandGrayRendererWidget(QgsRasterLayer *layer, const QgsRectangle &extent=QgsRectangle())
Constructor for QgsSingleBandGrayRendererWidget.
void setMapCanvas(QgsMapCanvas *canvas) override
Sets the map canvas associated with the widget.
QgsContrastEnhancement::ContrastEnhancementAlgorithm contrastEnhancementAlgorithm() const override
Returns the contrast enhancement algorithm to be used by the raster renderer.
void loadMinMax(int bandNo, double min, double max)
called when new min/max values are loaded
void setMax(const QString &value, int index=0) override
void setMin(const QString &value, int index=0) override
void setContrastEnhancementAlgorithm(QgsContrastEnhancement::ContrastEnhancementAlgorithm algorithm) override
Sets the contrast enhancement algorithm to be used by the raster renderer.
Raster renderer pipe for single band gray.
const QgsContrastEnhancement * contrastEnhancement() const
const QgsColorRampLegendNodeSettings * legendSettings() const
Returns the color ramp shader legend settings.
int inputBand() const override
Returns the input band for the renderer, or -1 if no input band is available.
As part of the API refactoring and improvements which landed in the Processing API was substantially reworked from the x version This was done in order to allow much of the underlying Processing framework to be ported into allowing algorithms to be written in pure substantial changes are required in order to port existing x Processing algorithms for QGIS x The most significant changes are outlined not GeoAlgorithm For algorithms which operate on features one by consider subclassing the QgsProcessingFeatureBasedAlgorithm class This class allows much of the boilerplate code for looping over features from a vector layer to be bypassed and instead requires implementation of a processFeature method Ensure that your algorithm(or algorithm 's parent class) implements the new pure virtual createInstance(self) call
#define QgsDebugMsgLevel(str, level)
Definition qgslogger.h:63