qgsrasterinterface.h

Go to the documentation of this file.

/***************************************************************************
    qgsrasterface.h - Internal raster processing modules interface
     --------------------------------------
    Date                 : Jun 21, 2012
    Copyright            : (C) 2012 by Radim Blazek
    email                : radim dot blazek at gmail dot com
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   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 QGSRASTERINTERFACE_H
#define QGSRASTERINTERFACE_H
 
#include <limits>
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsfeedback.h"
#include "qgsrasterbandstats.h"
#include "qgsrasterblock.h"
#include "qgsrasterhistogram.h"
#include "qgsrectangle.h"
#include "qgsrendercontext.h"
 
#include <QCoreApplication>
#include <QImage>
#include <QString>
 
using namespace Qt::StringLiterals;

class CORE_EXPORT QgsRasterBlockFeedback : public QgsFeedback
{
    Q_OBJECT
 
  public:
    QgsRasterBlockFeedback( QObject *parent = nullptr )
      : QgsFeedback( parent )
    {}

    virtual void onNewData() {}

    bool isPreviewOnly() const { return mPreviewOnly; }

    void setPreviewOnly( bool preview ) { mPreviewOnly = preview; }

    bool renderPartialOutput() const { return mRenderPartialOutput; }

    void setRenderPartialOutput( bool enable ) { mRenderPartialOutput = enable; }

    void appendError( const QString &error ) { mErrors.append( error ); }

    QStringList errors() const { return mErrors; }

    QgsRenderContext renderContext() const;

    void setRenderContext( const QgsRenderContext &renderContext );
 
  private:
    bool mPreviewOnly = false;

    bool mRenderPartialOutput = false;

    QStringList mErrors;
 
    QgsRenderContext mRenderContext;
};
 

class CORE_EXPORT QgsRasterInterface
{
    // QgsRasterInterface subclasses
    //SIP_TYPEHEADER_INCLUDE( "qgsbrightnesscontrastfilter.h" );
    //SIP_TYPEHEADER_INCLUDE( "qgshuesaturationfilter.h" );
    //SIP_TYPEHEADER_INCLUDE( "qgsrasterdataprovider.h" );
    //SIP_TYPEHEADER_INCLUDE( "qgsrasternuller.h" );
    //SIP_TYPEHEADER_INCLUDE( "qgsrasterprojector.h" );
    //SIP_TYPEHEADER_INCLUDE( "qgsrasterrenderer.h" );
    //SIP_TYPEHEADER_INCLUDE( "qgsrasterresamplefilter.h" );
    // QgsRasterRenderer subclasses
    //SIP_TYPEHEADER_INCLUDE( "qgshillshaderenderer.h" );
    //SIP_TYPEHEADER_INCLUDE( "qgsmultibandcolorrenderer.h" );
    //SIP_TYPEHEADER_INCLUDE( "qgspalettedrasterrenderer.h" );
    //SIP_TYPEHEADER_INCLUDE( "qgssinglebandcolordatarenderer.h" );
    //SIP_TYPEHEADER_INCLUDE( "qgssinglebandgrayrenderer.h" );
    //SIP_TYPEHEADER_INCLUDE( "qgssinglebandpseudocolorrenderer.h" );
    //SIP_TYPEHEADER_INCLUDE( "qgsrastersinglecolorrenderer.h" );
    //SIP_TYPEHEADER_INCLUDE( "qgsrastercontourrenderer.h" );
    //SIP_TYPEHEADER_INCLUDE( "qgsrastervectorfieldrenderer.h" );
 
 
#ifdef SIP_RUN
    SIP_CONVERT_TO_SUBCLASS_CODE
    if ( dynamic_cast<QgsBrightnessContrastFilter *>( sipCpp ) )
      sipType = sipType_QgsBrightnessContrastFilter;
    else if ( dynamic_cast<QgsHueSaturationFilter *>( sipCpp ) )
      sipType = sipType_QgsHueSaturationFilter;
    else if ( dynamic_cast<QgsRasterDataProvider *>( sipCpp ) )
    {
      sipType = sipType_QgsRasterDataProvider;
      // use static cast because QgsRasterDataProvider has multiple inheritance
      // and we would end up with bad pointer otherwise!
      *sipCppRet = static_cast<QgsRasterDataProvider *>( sipCpp );
    }
    else if ( dynamic_cast<QgsRasterNuller *>( sipCpp ) )
      sipType = sipType_QgsRasterNuller;
    else if ( dynamic_cast<QgsRasterProjector *>( sipCpp ) )
      sipType = sipType_QgsRasterProjector;
    else if ( dynamic_cast<QgsRasterRenderer *>( sipCpp ) )
    {
      if ( dynamic_cast<QgsHillshadeRenderer *>( sipCpp ) )
        sipType = sipType_QgsHillshadeRenderer;
      else if ( dynamic_cast<QgsMultiBandColorRenderer *>( sipCpp ) )
        sipType = sipType_QgsMultiBandColorRenderer;
      else if ( dynamic_cast<QgsPalettedRasterRenderer *>( sipCpp ) )
        sipType = sipType_QgsPalettedRasterRenderer;
      else if ( dynamic_cast<QgsSingleBandColorDataRenderer *>( sipCpp ) )
        sipType = sipType_QgsSingleBandColorDataRenderer;
      else if ( dynamic_cast<QgsSingleBandGrayRenderer *>( sipCpp ) )
        sipType = sipType_QgsSingleBandGrayRenderer;
      else if ( dynamic_cast<QgsSingleBandPseudoColorRenderer *>( sipCpp ) )
        sipType = sipType_QgsSingleBandPseudoColorRenderer;
      else if ( dynamic_cast<QgsRasterSingleColorRenderer *>( sipCpp ) )
        sipType = sipType_QgsRasterSingleColorRenderer;
      else if ( dynamic_cast<QgsRasterContourRenderer *>( sipCpp ) )
        sipType = sipType_QgsRasterContourRenderer;
      else if ( dynamic_cast<QgsRasterVectorFieldRenderer *>( sipCpp ) )
        sipType = sipType_QgsRasterVectorFieldRenderer;
      else
        sipType = sipType_QgsRasterRenderer;
    }
    else if ( dynamic_cast<QgsRasterResampleFilter *>( sipCpp ) )
      sipType = sipType_QgsRasterResampleFilter;
    else
      sipType = 0;
  SIP_END
#endif
 
  // clang-format off
  Q_DECLARE_TR_FUNCTIONS( QgsRasterInterface )
 
  public:
    // clang-format on
 
    QgsRasterInterface( QgsRasterInterface *input = nullptr );
 
    virtual ~QgsRasterInterface() = default;

    virtual QgsRasterInterface *clone() const = 0 SIP_FACTORY;
 
    // TODO QGIS 5.0 -- rename to interfaceCapabilities, to avoid confusion with QgsRasterDataProvider::providerCapabilities
    // (which inherits this class)

    virtual Qgis::RasterInterfaceCapabilities capabilities() const;

    Q_DECL_DEPRECATED QString capabilitiesString() const SIP_DEPRECATED;

    virtual Qgis::DataType dataType( int bandNo ) const = 0;

    virtual Qgis::DataType sourceDataType( int bandNo ) const { return mInput ? mInput->sourceDataType( bandNo ) : Qgis::DataType::UnknownDataType; }

    virtual QgsRectangle extent() const { return mInput ? mInput->extent() : QgsRectangle(); }

    int dataTypeSize( int bandNo ) const { return QgsRasterBlock::typeSize( dataType( bandNo ) ); }

    virtual int bandCount() const = 0;

    virtual int xBlockSize() const { return mInput ? mInput->xBlockSize() : 0; }
    virtual int yBlockSize() const { return mInput ? mInput->yBlockSize() : 0; }

    virtual int xSize() const { return mInput ? mInput->xSize() : 0; }
    virtual int ySize() const { return mInput ? mInput->ySize() : 0; }

    virtual QString generateBandName( int bandNumber ) const;

    virtual QString colorInterpretationName( int bandNumber ) const;

    QString displayBandName( int bandNumber ) const;

    virtual QgsRasterBlock *block( int bandNo, const QgsRectangle &extent, int width, int height, QgsRasterBlockFeedback *feedback = nullptr ) = 0 SIP_FACTORY;

    virtual bool setInput( QgsRasterInterface *input )
    {
      mInput = input;
      return true;
    }

    virtual QgsRasterInterface *input() const { return mInput; }

    virtual bool on() const { return mOn; }

    virtual void setOn( bool on ) { mOn = on; }

    virtual const QgsRasterInterface *sourceInput() const SIP_SKIP
    {
      QgsDebugMsgLevel( u"Entered"_s, 4 );
      return mInput ? mInput->sourceInput() : this;
    }

    virtual QgsRasterInterface *sourceInput()
    {
      QgsDebugMsgLevel( u"Entered"_s, 4 );
      return mInput ? mInput->sourceInput() : this;
    }
 
    // clang-format off
    Q_DECL_DEPRECATED QgsRasterBandStats bandStatistics( int bandNo, int stats, const QgsRectangle &extent = QgsRectangle(), int sampleSize = 0, QgsRasterBlockFeedback *feedback = nullptr ) SIP_DEPRECATED;
    // clang-format on

    virtual QgsRasterBandStats bandStatistics(
      int bandNo, Qgis::RasterBandStatistics stats = Qgis::RasterBandStatistic::All, const QgsRectangle &extent = QgsRectangle(), int sampleSize = 0, QgsRasterBlockFeedback *feedback = nullptr
    );

    Q_DECL_DEPRECATED bool hasStatistics( int bandNo, int stats, const QgsRectangle &extent = QgsRectangle(), int sampleSize = 0 ) SIP_DEPRECATED;

    virtual bool hasStatistics( int bandNo, Qgis::RasterBandStatistics stats = Qgis::RasterBandStatistic::All, const QgsRectangle &extent = QgsRectangle(), int sampleSize = 0 );
 
 
    // clang-format off
#ifndef SIP_RUN
    virtual QgsRasterHistogram histogram( int bandNo,
                                          int binCount = 0,
                                          double minimum = std::numeric_limits<double>::quiet_NaN(),
                                          double maximum = std::numeric_limits<double>::quiet_NaN(),
                                          const QgsRectangle &extent = QgsRectangle(),
                                          int sampleSize = 0,
                                          bool includeOutOfRange = false,
                                          QgsRasterBlockFeedback *feedback = nullptr );
#else
// clang-format off
    virtual QgsRasterHistogram histogram( int bandNo,
                                          int binCount = 0,
                                          SIP_PYOBJECT minimum = Py_None,
                                          SIP_PYOBJECT maximum = Py_None,
                                          const QgsRectangle &extent = QgsRectangle(),
                                          int sampleSize = 0,
                                          bool includeOutOfRange = false,
                                          QgsRasterBlockFeedback *feedback = nullptr )
    [QgsRasterHistogram( int bandNo,
                         int binCount = 0,
                         double minimum = 0.0,
                         double maximum = 0.0,
                         const QgsRectangle &extent = QgsRectangle(),
                         int sampleSize = 0,
                         bool includeOutOfRange = false,
                         QgsRasterBlockFeedback *feedback = nullptr )];
    % MethodCode
    double minimum;
    double maximum;
    if ( a2 == Py_None )
    {
      minimum = std::numeric_limits<double>::quiet_NaN();
    }
    else
    {
      minimum = PyFloat_AsDouble( a2 );
    }
 
    if ( a3 == Py_None )
    {
      maximum = std::numeric_limits<double>::quiet_NaN();
    }
    else
    {
      maximum = PyFloat_AsDouble( a3 );
    }
 
    QgsRasterHistogram *h = new QgsRasterHistogram( sipCpp->histogram( a0, a1, minimum, maximum, *a4, a5, a6, a7 ) );
    return sipConvertFromType( h, sipType_QgsRasterHistogram, Py_None );
    % End
// clang-format on
#endif
    // clang-format on
 
 
    // clang-format off
#ifndef SIP_RUN
    virtual bool hasHistogram( int bandNo,
                               int binCount,
                               double minimum = std::numeric_limits<double>::quiet_NaN(),
                               double maximum = std::numeric_limits<double>::quiet_NaN(),
                               const QgsRectangle &extent = QgsRectangle(),
                               int sampleSize = 0,
                               bool includeOutOfRange = false );
#else
// clang-format off
    virtual bool hasHistogram( int bandNo,
                               int binCount,
                               SIP_PYOBJECT minimum = Py_None,
                               SIP_PYOBJECT maximum = Py_None,
                               const QgsRectangle &extent = QgsRectangle(),
                               int sampleSize = 0,
                               bool includeOutOfRange = false )
    [bool( int bandNo,
           int binCount,
           double minimum = 0.0,
           double maximum = 0.0,
           const QgsRectangle &extent = QgsRectangle(),
           int sampleSize = 0,
           bool includeOutOfRange = false )];
    % MethodCode
    double minimum;
    double maximum;
    if ( a2 == Py_None )
    {
      minimum = std::numeric_limits<double>::quiet_NaN();
    }
    else
    {
      minimum = PyFloat_AsDouble( a2 );
    }
 
    if ( a3 == Py_None )
    {
      maximum = std::numeric_limits<double>::quiet_NaN();
    }
    else
    {
      maximum = PyFloat_AsDouble( a3 );
    }
 
    sipRes = sipCpp->hasHistogram( a0, a1, minimum, maximum, *a4, a5, a6 );
    % End
// clang-format on
#endif
    // clang-format on
 

    virtual void cumulativeCut( int bandNo, double lowerCount, double upperCount, double &lowerValue, double &upperValue, const QgsRectangle &extent = QgsRectangle(), int sampleSize = 0 );

    virtual void writeXml( QDomDocument &doc, QDomElement &parentElem ) const
    {
      Q_UNUSED( doc )
      Q_UNUSED( parentElem );
    }

    virtual void readXml( const QDomElement &filterElem ) { Q_UNUSED( filterElem ) }
 
  protected:
    // QgsRasterInterface used as input
    QgsRasterInterface *mInput = nullptr;

    QList<QgsRasterBandStats> mStatistics;

    QList<QgsRasterHistogram> mHistograms;
 
    // On/off state, if off, it does not do anything, replicates input
    bool mOn = true;
 
    // clang-format off
#ifndef SIP_RUN
    void initHistogram( QgsRasterHistogram &histogram,
                        int bandNo,
                        int binCount,
                        double minimum = std::numeric_limits<double>::quiet_NaN(),
                        double maximum = std::numeric_limits<double>::quiet_NaN(),
                        const QgsRectangle &boundingBox = QgsRectangle(),
                        int sampleSize = 0,
                        bool includeOutOfRange = false );
#else
// clang-format off
    void initHistogram( QgsRasterHistogram &histogram,
                        int bandNo,
                        int binCount,
                        SIP_PYOBJECT minimum = Py_None,
                        SIP_PYOBJECT maximum = Py_None,
                        const QgsRectangle &boundingBox = QgsRectangle(),
                        int sampleSize = 0,
                        bool includeOutOfRange = false )
    [void ( QgsRasterHistogram & histogram,
            int bandNo,
            int binCount,
            double minimum = 0.0,
            double maximum = 0.0,
            const QgsRectangle &boundingBox = QgsRectangle(),
            int sampleSize = 0,
            bool includeOutOfRange = false )];
    % MethodCode
    double minimum;
    double maximum;
    if ( a3 == Py_None )
    {
      minimum = std::numeric_limits<double>::quiet_NaN();
    }
    else
    {
      minimum = PyFloat_AsDouble( a3 );
    }
 
    if ( a4 == Py_None )
    {
      maximum = std::numeric_limits<double>::quiet_NaN();
    }
    else
    {
      maximum = PyFloat_AsDouble( a4 );
    }
 
#if defined(SIP_PROTECTED_IS_PUBLIC) || !defined(_MSC_VER)
    sipCpp->initHistogram( *a0, a1, a2, minimum, maximum, *a5, a6, a7 );
#else
    sipCpp->sipProtect_initHistogram( *a0, a1, a2, minimum, maximum, *a5, a6, a7 );
#endif
    % End
// clang-format on
#endif
    // clang-format on

    Q_DECL_DEPRECATED void initStatistics( QgsRasterBandStats &statistics, int bandNo, int stats, const QgsRectangle &boundingBox = QgsRectangle(), int binCount = 0 ) const SIP_DEPRECATED;

    void initStatistics(
      QgsRasterBandStats &statistics, int bandNo, Qgis::RasterBandStatistics stats = Qgis::RasterBandStatistic::All, const QgsRectangle &boundingBox = QgsRectangle(), int binCount = 0
    ) const;
 
  private:
#ifdef SIP_RUN
    QgsRasterInterface( const QgsRasterInterface & );
    QgsRasterInterface &operator=( const QgsRasterInterface & );
#endif
 
    Q_DISABLE_COPY( QgsRasterInterface ) // there is clone() for copying
};
 
#endif