qgsalignraster.h

Go to the documentation of this file.

/***************************************************************************
  qgsalignraster.h
  --------------------------------------
  Date                 : June 2015
  Copyright            : (C) 2015 by Martin Dobias
  Email                : wonder dot sk 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 QGSALIGNRASTER_H
#define QGSALIGNRASTER_H

#include <QList>
#include <QPointF>
#include <QSizeF>
#include <QString>
#include <gdal_version.h>
#include "qgis_analysis.h"
#include "qgis.h"
#include "qgsogrutils.h"

class QgsRectangle;

typedef void *GDALDatasetH SIP_SKIP;


class ANALYSIS_EXPORT QgsAlignRaster
{
#ifdef SIP_RUN
#include <gdal_version.h>
#endif

  public:
    QgsAlignRaster();

    struct ANALYSIS_EXPORT RasterInfo
    {
      public:
        RasterInfo( const QString &layerpath );

        RasterInfo( const RasterInfo &rh ) = delete;
        RasterInfo &operator=( const RasterInfo &rh ) = delete;

        bool isValid() const { return nullptr != mDataset; }

        QString crs() const { return mCrsWkt; }
        QSize rasterSize() const { return QSize( mXSize, mYSize ); }
        int bandCount() const { return mBandCnt; }
        QSizeF cellSize() const;
        QPointF gridOffset() const;
        QgsRectangle extent() const;
        QPointF origin() const;

        void dump() const;

        double identify( double mx, double my );

      protected:
        gdal::dataset_unique_ptr mDataset;
        QString mCrsWkt;
        double mGeoTransform[6];
        int mXSize = 0;
        int mYSize = 0;
        int mBandCnt = 0;

      private:
#ifdef SIP_RUN
        RasterInfo( const QgsAlignRaster::RasterInfo &rh );
#endif

        friend class QgsAlignRaster;
    };


    enum ResampleAlg
    {
      RA_NearestNeighbour = 0, 
      RA_Bilinear = 1,       
      RA_Cubic = 2,          
      RA_CubicSpline = 3,    
      RA_Lanczos = 4,        
      RA_Average = 5,        
      RA_Mode = 6,            
      RA_Max = 8, 
      RA_Min = 9, 
      RA_Median = 10, 
      RA_Q1 = 11, 
      RA_Q3 = 12, 
    };

    struct Item
    {
      Item( const QString &input, const QString &output )
        : inputFilename( input )
        , outputFilename( output )
        , resampleMethod( RA_NearestNeighbour )
        , rescaleValues( false )
        , srcCellSizeInDestCRS( 0.0 )
      {}

      QString inputFilename;
      QString outputFilename;
      QgsAlignRaster::ResampleAlg resampleMethod;
      bool rescaleValues;

      // private part

      double srcCellSizeInDestCRS;
    };
    typedef QList<QgsAlignRaster::Item> List;

    struct ProgressHandler
    {

      virtual bool progress( double complete ) = 0;

      virtual ~ProgressHandler() = default;
    };

    void setProgressHandler( ProgressHandler *progressHandler ) { mProgressHandler = progressHandler; }
    ProgressHandler *progressHandler() const { return mProgressHandler; }

    void setRasters( const List &list ) { mRasters = list; }
    List rasters() const { return mRasters; }

    void setGridOffset( QPointF offset ) { mGridOffsetX = offset.x(); mGridOffsetY = offset.y(); }
    QPointF gridOffset() const { return QPointF( mGridOffsetX, mGridOffsetY ); }

    void setCellSize( double x, double y ) { setCellSize( QSizeF( x, y ) ); }
    void setCellSize( QSizeF size ) { mCellSizeX = size.width(); mCellSizeY = size.height(); }
    QSizeF cellSize() const { return QSizeF( mCellSizeX, mCellSizeY ); }

    void setDestinationCrs( const QString &crsWkt ) { mCrsWkt = crsWkt; }
    QString destinationCrs() const { return mCrsWkt; }

    void setClipExtent( double xmin, double ymin, double xmax, double ymax );

    void setClipExtent( const QgsRectangle &extent );

    QgsRectangle clipExtent() const;

    bool setParametersFromRaster( const RasterInfo &rasterInfo, const QString &customCRSWkt = QString(), QSizeF customCellSize = QSizeF(), QPointF customGridOffset = QPointF( -1, -1 ) );

    bool setParametersFromRaster( const QString &filename, const QString &customCRSWkt = QString(), QSizeF customCellSize = QSizeF(), QPointF customGridOffset = QPointF( -1, -1 ) );

    bool checkInputParameters();

    QSize alignedRasterSize() const;

    QgsRectangle alignedRasterExtent() const;

    bool run();

    QString errorMessage() const { return mErrorMessage; }

    void dump() const;

    int suggestedReferenceLayer() const;

  protected:

    bool createAndWarp( const Item &raster );

    static bool suggestedWarpOutput( const RasterInfo &info, const QString &destWkt, QSizeF *cellSize = nullptr, QPointF *gridOffset = nullptr, QgsRectangle *rect = nullptr );

  protected:

    // set by the client

    ProgressHandler *mProgressHandler = nullptr;

    QString mErrorMessage;

    List mRasters;

    QString mCrsWkt;
    double mCellSizeX, mCellSizeY;
    double mGridOffsetX, mGridOffsetY;

    double mClipExtent[4];

    // derived data from other members

    double mGeoTransform[6];
    int mXSize;

    int mYSize;

};


#endif // QGSALIGNRASTER_H