qgsrasterlayer.h

Go to the documentation of this file.

/***************************************************************************
                        qgsrasterlayer.h  -  description
                              -------------------
 begin                : Fri Jun 28 2002
 copyright            : (C) 2004 by T.Sutton, Gary E.Sherman, Steve Halasz
 email                : [email protected]
***************************************************************************/
/*
 * Peter J. Ersts - contributed to the refactoring and maintenance of this class
 * B. Morley - added functions to convert this class to a data provider interface
 * Frank Warmerdam - contributed bug fixes and migrated class to use all GDAL_C_API calls
 */
/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
#ifndef QGSRASTERLAYER_H
#define QGSRASTERLAYER_H
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsabstractprofilesource.h"
#include "qgscontrastenhancement.h"
#include "qgsmaplayer.h"
#include "qgsrasterdataprovider.h"
#include "qgsrasterviewport.h"
 
#include <QColor>
#include <QDateTime>
#include <QList>
#include <QMap>
#include <QPair>
#include <QString>
#include <QVector>
 
using namespace Qt::StringLiterals;
 
class QgsMapToPixel;
class QgsRasterRenderer;
class QgsRectangle;
class QgsRasterLayerTemporalProperties;
class QgsRasterPipe;
class QgsRasterResampleFilter;
class QgsBrightnessContrastFilter;
class QgsHueSaturationFilter;
class QgsRasterLayerElevationProperties;
class QgsSettingsEntryBool;
class QgsSettingsEntryDouble;
class QgsRasterMinMaxOrigin;
class QgsAbstractRasterLayerLabeling;
 
class QImage;
class QPixmap;
class QSlider;
 
typedef QList< QPair< QString, QColor > > QgsLegendColorList;

class CORE_EXPORT QgsRasterLayer : public QgsMapLayer, public QgsAbstractProfileSource
{
    Q_OBJECT
 
  public:
    static const QgsSettingsEntryBool *settingsRasterDefaultEarlyResampling SIP_SKIP;
    static const QgsSettingsEntryDouble *settingsRasterDefaultOversampling SIP_SKIP;

    static const double SAMPLE_SIZE;

    static const QgsContrastEnhancement::ContrastEnhancementAlgorithm SINGLE_BAND_ENHANCEMENT_ALGORITHM;

    static const QgsContrastEnhancement::ContrastEnhancementAlgorithm MULTIPLE_BAND_SINGLE_BYTE_ENHANCEMENT_ALGORITHM;

    static const QgsContrastEnhancement::ContrastEnhancementAlgorithm MULTIPLE_BAND_MULTI_BYTE_ENHANCEMENT_ALGORITHM;

    static const Qgis::RasterRangeLimit SINGLE_BAND_MIN_MAX_LIMITS;

    static const Qgis::RasterRangeLimit MULTIPLE_BAND_SINGLE_BYTE_MIN_MAX_LIMITS;

    static const Qgis::RasterRangeLimit MULTIPLE_BAND_MULTI_BYTE_MIN_MAX_LIMITS;

    QgsRasterLayer();

    struct LayerOptions
    {
        explicit LayerOptions( bool loadDefaultStyle = true, const QgsCoordinateTransformContext &transformContext = QgsCoordinateTransformContext() )
          : loadDefaultStyle( loadDefaultStyle )
          , transformContext( transformContext )
        {}

        bool loadDefaultStyle = true;

        QgsCoordinateTransformContext transformContext = QgsCoordinateTransformContext();

        bool skipCrsValidation = false;
    };

    explicit QgsRasterLayer( const QString &uri, const QString &baseName = QString(), const QString &providerType = "gdal", const QgsRasterLayer::LayerOptions &options = QgsRasterLayer::LayerOptions() );
 
    ~QgsRasterLayer() override;
 
#ifdef SIP_RUN
    // clang-format off
    SIP_PYOBJECT __repr__();
    % MethodCode
    QString str = u"<QgsRasterLayer: '%1' (%2)>"_s.arg( sipCpp->name(), sipCpp->dataProvider() ? sipCpp->dataProvider()->name() : u"Invalid"_s );
    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
    % End
// clang-format on
#endif

      QgsRasterLayer *clone() const override SIP_FACTORY;
 
    QgsAbstractProfileSource *profileSource() override { return this; }
    QString profileSourceId() const override { return id(); }
    QString profileSourceName() const override { return name(); }
 
    QgsAbstractProfileGenerator *createProfileGenerator( const QgsProfileRequest &request ) override SIP_FACTORY;

    static bool isValidRasterFileName( const QString &fileNameQString, QString &retError );
    // TODO QGIS 5.0 - rename fileNameQString to fileName
 
    static bool isValidRasterFileName( const QString &fileNameQString );

    static QDateTime lastModified( const QString &name );

    Q_DECL_DEPRECATED void setDataProvider( const QString &provider ) SIP_DEPRECATED;

    void setDataProvider( const QString &provider, const QgsDataProvider::ProviderOptions &options, Qgis::DataProviderReadFlags flags = Qgis::DataProviderReadFlags() );

    Qgis::RasterLayerType rasterType() const { return mRasterType; }

    void setRenderer( QgsRasterRenderer *renderer SIP_TRANSFER );

    QgsRasterRenderer *renderer() const;

    QgsRasterResampleFilter *resampleFilter() const;

    QgsBrightnessContrastFilter *brightnessFilter() const;

    QgsHueSaturationFilter *hueSaturationFilter() const;

    void setResamplingStage( Qgis::RasterResamplingStage stage );

    Qgis::RasterResamplingStage resamplingStage() const;

    QgsRasterPipe *pipe() { return mPipe.get(); }

    int width() const;

    int height() const;

    int bandCount() const;

    QString bandName( int bandNoInt ) const;

    QgsRasterAttributeTable *attributeTable( int bandNumber ) const;

    int attributeTableCount() const;

    bool canCreateRasterAttributeTable();

    QgsRasterDataProvider *dataProvider() override;

    const QgsRasterDataProvider *dataProvider() const SIP_PYNAME( constDataProvider ) override;
 
    void reload() override;
    QgsMapLayerRenderer *createMapRenderer( QgsRenderContext &rendererContext ) override SIP_FACTORY;

    void draw( QPainter *theQPainter, QgsRasterViewPort *myRasterViewPort, const QgsMapToPixel *qgsMapToPixel = nullptr );

    Q_DECL_DEPRECATED QgsLegendColorList legendSymbologyItems() const SIP_DEPRECATED;
 
    bool isSpatial() const override { return true; }
 
    QString htmlMetadata() const override;
    Qgis::MapLayerProperties properties() const override;

    QPixmap paletteAsPixmap( int bandNumber = 1 );

    double rasterUnitsPerPixelX() const;

    double rasterUnitsPerPixelY() const;
 
    void setOpacity( double opacity ) final;
    double opacity() const final;

    void setContrastEnhancement(
      QgsContrastEnhancement::ContrastEnhancementAlgorithm algorithm,
      Qgis::RasterRangeLimit limits = Qgis::RasterRangeLimit::MinimumMaximum,
      const QgsRectangle &extent = QgsRectangle(),
      int sampleSize = QgsRasterLayer::SAMPLE_SIZE,
      bool generateLookupTableFlag = true
    );

    void refreshContrastEnhancement( const QgsRectangle &extent ) SIP_SKIP;

    virtual QString subsetString() const;

    virtual bool setSubsetString( const QString &subset );

    bool defaultContrastEnhancementSettings( QgsContrastEnhancement::ContrastEnhancementAlgorithm &myAlgorithm, Qgis::RasterRangeLimit &myLimits ) const SIP_SKIP;

    void setDefaultContrastEnhancement();
 
    QStringList subLayers() const override;

    QImage previewAsImage( QSize size, const QColor &bgColor = Qt::white, QImage::Format format = QImage::Format_ARGB32_Premultiplied );
 
    void setLayerOrder( const QStringList &layers ) override;
    void setSubLayerVisibility( const QString &name, bool vis ) override;
    QDateTime timestamp() const override;
 
    using QgsMapLayer::accept;
    bool accept( QgsStyleEntityVisitorInterface *visitor ) const override;

    bool labelsEnabled() const;

    void setLabelsEnabled( bool enabled );

    const QgsAbstractRasterLayerLabeling *labeling() const SIP_SKIP;

    QgsAbstractRasterLayerLabeling *labeling();

    void setLabeling( QgsAbstractRasterLayerLabeling *labeling SIP_TRANSFER );

    Q_DECL_DEPRECATED bool writeSld( QDomNode &node, QDomDocument &doc, QString &errorMessage, const QVariantMap &props = QVariantMap() ) const SIP_DEPRECATED;

    bool writeSld( QDomNode &node, QDomDocument &doc, QgsSldExportContext &context ) const;

    bool ignoreExtents() const;
 
    QgsMapLayerTemporalProperties *temporalProperties() override;
    QgsMapLayerElevationProperties *elevationProperties() override;

    void computeMinMax( int band, const QgsRasterMinMaxOrigin &mmo, Qgis::RasterRangeLimit limits, const QgsRectangle &extent, int sampleSize, double &min, double &max ) SIP_SKIP;
 
  public slots:
    void showStatusMessage( const QString &message );

    void setTransformContext( const QgsCoordinateTransformContext &transformContext ) override;
 
  signals:

    void subsetStringChanged();
 
  protected:
    bool readSymbology( const QDomNode &node, QString &errorMessage, QgsReadWriteContext &context, QgsMapLayer::StyleCategories categories = QgsMapLayer::AllStyleCategories ) override;
    bool readStyle( const QDomNode &node, QString &errorMessage, QgsReadWriteContext &context, QgsMapLayer::StyleCategories categories = QgsMapLayer::AllStyleCategories ) override;
    bool readXml( const QDomNode &layer_node, QgsReadWriteContext &context ) override;
    bool writeSymbology( QDomNode &, QDomDocument &doc, QString &errorMessage, const QgsReadWriteContext &context, QgsMapLayer::StyleCategories categories = QgsMapLayer::AllStyleCategories ) const override;
    bool writeStyle( QDomNode &node, QDomDocument &doc, QString &errorMessage, const QgsReadWriteContext &context, QgsMapLayer::StyleCategories categories = QgsMapLayer::AllStyleCategories ) const override;
    bool writeXml( QDomNode &layer_node, QDomDocument &doc, const QgsReadWriteContext &context ) const override;
    QString encodedSource( const QString &source, const QgsReadWriteContext &context ) const override;
    QString decodedSource( const QString &source, const QString &provider, const QgsReadWriteContext &context ) const override;
 
  private:
    void init();

    void closeDataProvider();

    bool update();

    void setRendererForDrawingStyle( Qgis::RasterDrawingStyle drawingStyle );
 
    void setContrastEnhancement(
      QgsContrastEnhancement::ContrastEnhancementAlgorithm algorithm, Qgis::RasterRangeLimit limits, const QgsRectangle &extent, int sampleSize, bool generateLookupTableFlag, QgsRasterRenderer *rasterRenderer
    );

    void setDataSourcePrivate( const QString &dataSource, const QString &baseName, const QString &provider, const QgsDataProvider::ProviderOptions &options, Qgis::DataProviderReadFlags flags ) override;

    void writeRasterAttributeTableExternalPaths( QDomNode &layerNode, QDomDocument &doc, const QgsReadWriteContext &context ) const;

    void readRasterAttributeTableExternalPaths( const QDomNode &layerNode, QgsReadWriteContext &context ) const;

    const QString QSTRING_NOT_SET;
    const QString TRSTRING_NOT_SET;

    QgsRasterDataProvider *mDataProvider = nullptr;

    QgsRasterLayerTemporalProperties *mTemporalProperties = nullptr;
 
    QgsRasterLayerElevationProperties *mElevationProperties = nullptr;

    bool mLabelsEnabled = false;

    std::unique_ptr< QgsAbstractRasterLayerLabeling > mLabeling;

    QDateTime mLastModified;
 
    QgsRasterViewPort mLastViewPort;
 
    Qgis::RasterLayerType mRasterType = Qgis::RasterLayerType::GrayOrUndefined;
 
    std::unique_ptr< QgsRasterPipe > mPipe;
 
    QDomDocument mOriginalStyleDocument;
    QDomElement mOriginalStyleElement;
};
 
// clazy:excludeall=qstring-allocations
 
#endif