qgsrasteranalysisutils.h

Go to the documentation of this file.

/***************************************************************************
  qgsrasteranalysisutils.h
  ---------------------
  Date                 : June 2018
  Copyright            : (C) 2018 by Nyall Dawson
  Email                : nyall dot dawson 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 QGSRASTERANALYSISUTILS_H
#define QGSRASTERANALYSISUTILS_H
 
#include <functional>
#include <memory>
#include <vector>
 
#include "qgis.h"
#include "qgis_analysis.h"
#include "qgspointxy.h"
 
#define SIP_NO_FILE

 
class QgsRasterInterface;
class QgsGeometry;
class QgsRectangle;
class QgsProcessingParameterDefinition;
class QgsRasterProjector;
class QgsRasterDataProvider;
class QgsFeedback;
class QgsRasterBlock;
 
namespace QgsRasterAnalysisUtils
{

  void cellInfoForBBox(
    const QgsRectangle &rasterBBox, const QgsRectangle &featureBBox, double cellSizeX, double cellSizeY, int &nCellsX, int &nCellsY, int rasterWidth, int rasterHeight, QgsRectangle &rasterBlockExtent
  );

  void statisticsFromMiddlePointTest(
    QgsRasterInterface *rasterInterface,
    int rasterBand,
    const QgsGeometry &poly,
    int nCellsX,
    int nCellsY,
    double cellSizeX,
    double cellSizeY,
    const QgsRectangle &rasterBBox,
    const std::function<void( double, const QgsPointXY & )> &addValue,
    bool skipNodata = true
  );

  void statisticsFromPreciseIntersection(
    QgsRasterInterface *rasterInterface,
    int rasterBand,
    const QgsGeometry &poly,
    int nCellsX,
    int nCellsY,
    double cellSizeX,
    double cellSizeY,
    const QgsRectangle &rasterBBox,
    const std::function<void( double, double, const QgsPointXY & )> &addValue,
    bool skipNodata = true
  );

  bool validPixel( double value );

  void mapToPixel( const double x, const double y, const QgsRectangle bounds, const double unitsPerPixelX, const double unitsPerPixelY, int &px, int &py );

  void pixelToMap( const int px, const int py, const QgsRectangle bounds, const double unitsPerPixelX, const double unitsPerPixelY, double &x, double &y );

  std::unique_ptr<QgsProcessingParameterDefinition> createRasterTypeParameter( const QString &name, const QString &description, Qgis::DataType defaultType = Qgis::DataType::Float32 );

  Qgis::DataType rasterTypeChoiceToDataType( int choice );
 
  struct RasterLogicInput
  {
      std::unique_ptr<QgsRasterInterface> sourceDataProvider;
      std::unique_ptr<QgsRasterProjector> projector;
      QgsRasterInterface *interface = nullptr;
      bool hasNoDataValue = false;
      std::vector<int> bands { 1 };
  };
 
  ANALYSIS_EXPORT void applyRasterLogicOperator(
    const std::vector<QgsRasterAnalysisUtils::RasterLogicInput> &inputs,
    std::unique_ptr<QgsRasterDataProvider> destinationRaster,
    double outputNoDataValue,
    const bool treatNoDataAsFalse,
    int width,
    int height,
    const QgsRectangle &extent,
    QgsFeedback *feedback,
    std::function<void( const std::vector<std::unique_ptr<QgsRasterBlock>> &, bool &, bool &, int, int, bool )> &applyLogicFunc,
    qgssize &noDataCount,
    qgssize &trueCount,
    qgssize &falseCount
  );

  std::vector<double> getCellValuesFromBlockStack( const std::vector<std::unique_ptr<QgsRasterBlock>> &inputBlocks, int &row, int &col, bool &noDataInStack );

  enum CellValueStatisticMethods
  {
    Sum,
    Count,
    Mean,
    Median,
    StandardDeviation,
    Variance,
    Minimum,
    Maximum,
    Minority,
    Majority,
    Range,
    Variety
  };

  double meanFromCellValues( std::vector<double> &cellValues, int stackSize );

  double medianFromCellValues( std::vector<double> &cellValues, int stackSize );

  double stddevFromCellValues( std::vector<double> &cellValues, int stackSize );

  double varianceFromCellValues( std::vector<double> &cellValues, int stackSize );

  double maximumFromCellValues( std::vector<double> &cellValues );

  double minimumFromCellValues( std::vector<double> &cellValues );

  double majorityFromCellValues( std::vector<double> &cellValues, const double noDataValue, int stackSize );

  double minorityFromCellValues( std::vector<double> &cellValues, const double noDataValue, int stackSize );

  double rangeFromCellValues( std::vector<double> &cellValues );

  double varietyFromCellValues( std::vector<double> &cellValues );
 
  enum CellValuePercentileMethods
  {
    NearestRankPercentile,
    InterpolatedPercentileInc,
    InterpolatedPercentileExc
  };

  double nearestRankPercentile( std::vector<double> &cellValues, int stackSize, double percentile );

  double interpolatedPercentileInc( std::vector<double> &cellValues, int stackSize, double percentile );

  double interpolatedPercentileExc( std::vector<double> &cellValues, int stackSize, double percentile, double noDataValue );
 
  enum CellValuePercentRankMethods
  {
    InterpolatedPercentRankInc,
    InterpolatedPercentRankExc
  };

  double interpolatedPercentRankInc( std::vector<double> &cellValues, int stackSize, double value, double noDataValue );

  double interpolatedPercentRankExc( std::vector<double> &cellValues, int stackSize, double value, double noDataValue );
 
} // namespace QgsRasterAnalysisUtils
 

 
#endif // QGSRASTERANALYSISUTILS_H