qgsrasterblock.h

Go to the documentation of this file.

/***************************************************************************
    qgsrasterblock.h - Class representing a block of raster data
     --------------------------------------
    Date                 : Oct 9, 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 QGSRASTERBLOCK_H
#define QGSRASTERBLOCK_H
 
#include <limits>
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgserror.h"
#include "qgslogger.h"
#include "qgsrasterrange.h"
 
#include <QImage>
#include <QString>
 
using namespace Qt::StringLiterals;
 
class QgsRectangle;

class CORE_EXPORT QgsRasterBlock
{
  public:
    QgsRasterBlock();

    QgsRasterBlock( Qgis::DataType dataType, int width, int height );
 
    virtual ~QgsRasterBlock();

    bool reset( Qgis::DataType dataType, int width, int height );
 
    // TODO: consider if use isValid() at all, isEmpty() should be sufficient
    // and works also if block is valid but empty - difference between valid and empty?
 
    // clang-format off
    bool isValid() const SIP_HOLDGIL { return mValid; }
    // clang-format on

    void setValid( bool valid ) SIP_HOLDGIL { mValid = valid; }

    bool isEmpty() const;

    static int typeSize( Qgis::DataType dataType ) SIP_HOLDGIL
    {
      // Modified and extended copy from GDAL
      switch ( dataType )
      {
        case Qgis::DataType::Byte:
        case Qgis::DataType::Int8:
          return 1;
 
        case Qgis::DataType::UInt16:
        case Qgis::DataType::Int16:
          return 2;
 
        case Qgis::DataType::UInt32:
        case Qgis::DataType::Int32:
        case Qgis::DataType::Float32:
        case Qgis::DataType::CInt16:
          return 4;
 
        case Qgis::DataType::Float64:
        case Qgis::DataType::CInt32:
        case Qgis::DataType::CFloat32:
          return 8;
 
        case Qgis::DataType::CFloat64:
          return 16;
 
        case Qgis::DataType::ARGB32:
        case Qgis::DataType::ARGB32_Premultiplied:
          return 4;
 
        case Qgis::DataType::UnknownDataType:
          break;
      }
      return 0;
    }

    int dataTypeSize() const SIP_HOLDGIL
    {
      return typeSize( mDataType );
    }

    static bool typeIsNumeric( Qgis::DataType type );

    static bool typeIsComplex( Qgis::DataType type );

    static bool typeIsColor( Qgis::DataType type );

    Qgis::DataType dataType() const  SIP_HOLDGIL { return mDataType; }

    static Qgis::DataType typeWithNoDataValue( Qgis::DataType dataType, double *noDataValue );

    bool hasNoDataValue() const SIP_HOLDGIL { return mHasNoDataValue; }

    bool hasNoData() const SIP_HOLDGIL
    {
      return mHasNoDataValue || mNoDataBitmap;
    }

    void setNoDataValue( double noDataValue ) SIP_HOLDGIL;

    void resetNoDataValue() SIP_HOLDGIL;

    double noDataValue() const SIP_HOLDGIL { return mNoDataValue; }

    static QByteArray valueBytes( Qgis::DataType dataType, double value );

    double value( int row, int column ) const SIP_HOLDGIL
    {
      return value( static_cast< qgssize >( row ) * mWidth + column );
    }

    double valueAndNoData( int row, int column, bool &isNoData ) const SIP_SKIP
    {
      return valueAndNoData( static_cast< qgssize >( row ) * mWidth + column, isNoData );
    }

    inline double value( qgssize index ) const SIP_HOLDGIL;

    inline double valueAndNoData( qgssize index, bool &isNoData ) const SIP_SKIP;

    const quint8 *byteData() const SIP_SKIP
    {
      if ( mDataType != Qgis::DataType::Byte )
        return nullptr;
      return static_cast< const quint8 * >( mData );
    }

    QRgb color( int row, int column ) const SIP_HOLDGIL
    {
      if ( !mImage ) return NO_DATA_COLOR;
 
      return mImage->pixel( column, row );
    }

    QRgb color( qgssize index ) const SIP_HOLDGIL
    {
      const int row = static_cast< int >( std::floor( static_cast< double >( index ) / mWidth ) );
      const int column = index % mWidth;
      return color( row, column );
    }

    bool isNoData( int row, int column ) const SIP_HOLDGIL
    {
      return isNoData( static_cast< qgssize >( row ) * mWidth + column );
    }

    bool isNoData( qgssize row, qgssize column ) const SIP_HOLDGIL
    {
      return isNoData( row * static_cast< qgssize >( mWidth ) + column );
    }

    bool isNoData( qgssize index ) const SIP_HOLDGIL
    {
      if ( !mHasNoDataValue && !mNoDataBitmap )
        return false;
      if ( index >= static_cast< qgssize >( mWidth )*mHeight )
      {
        QgsDebugError( u"Index %1 out of range (%2 x %3)"_s.arg( index ).arg( mWidth ).arg( mHeight ) );
        return true; // we consider no data if outside
      }
      if ( mHasNoDataValue )
      {
        const double value = readValue( mData, mDataType, index );
        return isNoDataValue( value );
      }
      // use no data bitmap
      if ( !mNoDataBitmap )
      {
        // no data are not defined
        return false;
      }
      // TODO: optimize
      const int row = static_cast< int >( index ) / mWidth;
      const int column = index % mWidth;
      const qgssize byte = static_cast< qgssize >( row ) * mNoDataBitmapWidth + column / 8;
      const int bit = column % 8;
      const int mask = 0x80 >> bit;
      //int x = mNoDataBitmap[byte] & mask;
      //QgsDebugMsg ( QString("byte = %1 bit = %2 mask = %3 nodata = %4 is nodata = %5").arg(byte).arg(bit).arg(mask, 0, 2 ).arg( x, 0, 2 ).arg( (bool)(x) ) );
      return mNoDataBitmap[byte] & mask;
    }

    bool setValue( int row, int column, double value ) SIP_HOLDGIL
    {
      return setValue( static_cast< qgssize >( row ) * mWidth + column, value );
    }

    bool setValue( qgssize index, double value ) SIP_HOLDGIL
    {
      if ( !mData )
      {
        QgsDebugError( u"Data block not allocated"_s );
        return false;
      }
      if ( index >= static_cast< qgssize >( mWidth ) *mHeight )
      {
        QgsDebugError( u"Index %1 out of range (%2 x %3)"_s.arg( index ).arg( mWidth ).arg( mHeight ) );
        return false;
      }
      writeValue( mData, mDataType, index, value );
      return true;
    }

    bool setColor( int row, int column, QRgb color ) SIP_HOLDGIL
    {
      return setColor( static_cast< qgssize >( row ) * mWidth + column, color );
    }

    bool setColor( qgssize index, QRgb color ) SIP_HOLDGIL
    {
      if ( !mImage )
      {
        QgsDebugError( u"Image not allocated"_s );
        return false;
      }
 
      if ( index >= static_cast< qgssize >( mImage->width() ) * mImage->height() )
      {
        QgsDebugError( u"index %1 out of range"_s.arg( index ) );
        return false;
      }
 
      // setPixel() is slow, see Qt doc -> use direct access
      QRgb *bits = reinterpret_cast< QRgb * >( mImage->bits() );
      bits[index] = color;
      return true;
    }

    QRgb *colorData() SIP_SKIP
    {
      if ( !mImage )
        return nullptr;
      return reinterpret_cast< QRgb * >( mImage->bits() );
    }

    bool setIsNoData( int row, int column ) SIP_HOLDGIL
    {
      return setIsNoData( static_cast< qgssize >( row ) * mWidth + column );
    }

    bool setIsNoData( qgssize index ) SIP_HOLDGIL
    {
      if ( mHasNoDataValue )
      {
        return setValue( index, mNoDataValue );
      }
      else
      {
        if ( !mNoDataBitmap )
        {
          if ( !createNoDataBitmap() )
          {
            return false;
          }
        }
        // TODO: optimize
        const int row = static_cast< int >( index ) / mWidth;
        const int column = index % mWidth;
        const qgssize byte = static_cast< qgssize >( row ) * mNoDataBitmapWidth + column / 8;
        const int bit = column % 8;
        const int nodata = 0x80 >> bit;
        //QgsDebugMsg ( QString("set byte = %1 bit = %2 no data by %3").arg(byte).arg(bit).arg(nodata, 0,2 ) );
        mNoDataBitmap[byte] = mNoDataBitmap[byte] | nodata;
        return true;
      }
    }

    bool setIsNoData();

    bool setIsNoDataExcept( QRect exceptRect );

    void setIsData( int row, int column ) SIP_HOLDGIL
    {
      setIsData( static_cast< qgssize >( row )*mWidth + column );
    }

    void setIsData( qgssize index ) SIP_HOLDGIL
    {
      if ( mHasNoDataValue )
      {
        //no data value set, so mNoDataBitmap is not being used
        return;
      }
 
      if ( !mNoDataBitmap )
      {
        return;
      }
 
      // TODO: optimize
      const int row = static_cast< int >( index ) / mWidth;
      const int column = index % mWidth;
      const qgssize byte = static_cast< qgssize >( row ) * mNoDataBitmapWidth + column / 8;
      const int bit = column % 8;
      const int nodata = 0x80 >> bit;
      mNoDataBitmap[byte] = mNoDataBitmap[byte] & ~nodata;
    }
 
#ifndef SIP_RUN
    bool fill( double value );
#else
// clang-format off

    void fill( double value );
    % MethodCode
    if ( !QgsRasterBlock::typeIsNumeric( sipCpp->dataType() ) )
    {
      PyErr_SetString( PyExc_ValueError, u"Cannot fill a block with %1 data type"_s.arg( qgsEnumValueToKey( sipCpp->dataType() ) ).toUtf8().constData() );
      sipIsErr = 1;
    }
    else if ( QgsRasterBlock::typeIsComplex( sipCpp->dataType() ) )
    {
      PyErr_SetString( PyExc_ValueError, u"Cannot fill a block with %1 complex data type"_s.arg( qgsEnumValueToKey( sipCpp->dataType() ) ).toUtf8().constData() );
      sipIsErr = 1;
    }
    else if ( sipCpp->isEmpty() )
    {
      PyErr_SetString( PyExc_ValueError, u"Cannot fill an empty block"_s.toUtf8().constData() );
      sipIsErr = 1;
    }
    else
    {
      sipCpp->fill( a0 );
    }
    % End
// clang-format on
#endif

    QByteArray data() const;

    void setData( const QByteArray &data, int offset = 0 );

    char *bits( int row, int column ) SIP_SKIP;

    char *bits( qgssize index ) SIP_SKIP;

    char *bits() SIP_SKIP;

    const char *constBits( qgssize index ) const SIP_SKIP;

    const char *constBits() const SIP_SKIP;

    static QString printValue( double value, bool localized = false );

    static QString printValue( float value, bool localized = false ) SIP_SKIP;

    bool convert( Qgis::DataType destDataType );

    QImage image() const;

    bool setImage( const QImage *image );

    inline static double readValue( void *data, Qgis::DataType type, qgssize index ) SIP_SKIP;

    inline static void writeValue( void *data, Qgis::DataType type, qgssize index, double value ) SIP_SKIP;
 
    void applyNoDataValues( const QgsRasterRangeList &rangeList );

    void applyScaleOffset( double scale, double offset );

    QgsError error() const { return mError; }

    void setError( const QgsError &error ) { mError = error;}
 
    QString toString() const;

    static QRect subRect( const QgsRectangle &extent, int width, int height, const QgsRectangle &subExtent );

    int width() const SIP_HOLDGIL { return mWidth; }

    int height() const SIP_HOLDGIL { return mHeight; }

    bool minimum( double &minimum SIP_OUT, int &row SIP_OUT, int &column SIP_OUT ) const;

    bool maximum( double &maximum SIP_OUT, int &row SIP_OUT, int &column SIP_OUT ) const;

    bool minimumMaximum( double &minimum SIP_OUT, int &minimumRow SIP_OUT, int &minimumColumn SIP_OUT, double &maximum SIP_OUT, int &maximumRow SIP_OUT, int &maximumColumn SIP_OUT ) const;
 
  private:
    static QImage::Format imageFormat( Qgis::DataType dataType );
    static Qgis::DataType dataType( QImage::Format format );

    static bool isNoDataValue( double value, double noDataValue )
    {
      // TODO: optimize no data value test by memcmp()
      // More precise would be std::isnan(value) && std::isnan(noDataValue(bandNo)), but probably
      // not important and slower
      return std::isnan( value ) ||
             qgsDoubleNear( value, noDataValue );
    }

    inline bool isNoDataValue( double value ) const;

    bool createNoDataBitmap();

    static void *convert( void *srcData, Qgis::DataType srcDataType, Qgis::DataType destDataType, qgssize size );
 
    // Valid
    bool mValid = true;
 
    // Data type
    Qgis::DataType mDataType = Qgis::DataType::UnknownDataType;
 
    // Data type size in bytes, to make bits() fast
    int mTypeSize = 0;
 
    // Width
    int mWidth = 0;
 
    // Height
    int mHeight = 0;
 
    // Has no data value
    bool mHasNoDataValue = false;
 
    // No data value
    double mNoDataValue;
 
    static const QRgb NO_DATA_COLOR;
 
    // Data block for numerical data types, not used with image data types
    // QByteArray does not seem to be intended for large data blocks, does it?
    void *mData = nullptr;
 
    // Image for image data types, not used with numerical data types
    QImage *mImage = nullptr;
 
    // Bitmap of no data. One bit for each pixel. Bit is 1 if a pixels is no data.
    // Each row is represented by whole number of bytes (last bits may be unused)
    // to make processing rows easy.
    char *mNoDataBitmap = nullptr;
 
    // number of bytes in mNoDataBitmap row
    int mNoDataBitmapWidth = 0;
 
    // total size in bytes of mNoDataBitmap
    qgssize mNoDataBitmapSize = 0;
 
    // Error
    QgsError mError;
};
 
inline double QgsRasterBlock::readValue( void *data, Qgis::DataType type, qgssize index ) SIP_SKIP
{
  if ( !data )
  {
    return std::numeric_limits<double>::quiet_NaN();
  }
 
  switch ( type )
  {
    case Qgis::DataType::Byte:
      return static_cast< double >( ( static_cast< quint8 * >( data ) )[index] );
    case Qgis::DataType::Int8:
      return static_cast< double >( ( static_cast< qint8 * >( data ) )[index] );
    case Qgis::DataType::UInt16:
      return static_cast< double >( ( static_cast< quint16 * >( data ) )[index] );
    case Qgis::DataType::Int16:
      return static_cast< double >( ( static_cast< qint16 * >( data ) )[index] );
    case Qgis::DataType::UInt32:
      return static_cast< double >( ( static_cast< quint32 * >( data ) )[index] );
    case Qgis::DataType::Int32:
      return static_cast< double >( ( static_cast< qint32 * >( data ) )[index] );
    case Qgis::DataType::Float32:
      return static_cast< double >( ( static_cast< float * >( data ) )[index] );
    case Qgis::DataType::Float64:
      return static_cast< double >( ( static_cast< double * >( data ) )[index] );
    case Qgis::DataType::CInt16:
    case Qgis::DataType::CInt32:
    case Qgis::DataType::CFloat32:
    case Qgis::DataType::CFloat64:
    case Qgis::DataType::ARGB32:
    case Qgis::DataType::ARGB32_Premultiplied:
    case Qgis::DataType::UnknownDataType:
      QgsDebugError( u"Data type %1 is not supported"_s.arg( qgsEnumValueToKey< Qgis::DataType >( type ) ) );
      break;
  }
 
  return std::numeric_limits<double>::quiet_NaN();
}
 
inline void QgsRasterBlock::writeValue( void *data, Qgis::DataType type, qgssize index, double value ) SIP_SKIP
{
  if ( !data ) return;
 
  switch ( type )
  {
    case Qgis::DataType::Byte:
      ( static_cast< quint8 * >( data ) )[index] = static_cast< quint8 >( value );
      break;
    case Qgis::DataType::Int8:
      ( static_cast< qint8 * >( data ) )[index] = static_cast< qint8 >( value );
      break;
    case Qgis::DataType::UInt16:
      ( static_cast< quint16 * >( data ) )[index] = static_cast< quint16 >( value );
      break;
    case Qgis::DataType::Int16:
      ( static_cast< qint16 * >( data ) )[index] = static_cast< qint16 >( value );
      break;
    case Qgis::DataType::UInt32:
      ( static_cast< quint32 * >( data ) )[index] = static_cast< quint32 >( value );
      break;
    case Qgis::DataType::Int32:
      ( static_cast< qint32 * >( data ) )[index] = static_cast< qint32 >( value );
      break;
    case Qgis::DataType::Float32:
      ( static_cast< float * >( data ) )[index] = static_cast< float >( value );
      break;
    case Qgis::DataType::Float64:
      ( static_cast< double * >( data ) )[index] = value;
      break;
    case Qgis::DataType::CInt16:
    case Qgis::DataType::CInt32:
    case Qgis::DataType::CFloat32:
    case Qgis::DataType::CFloat64:
    case Qgis::DataType::ARGB32:
    case Qgis::DataType::ARGB32_Premultiplied:
    case Qgis::DataType::UnknownDataType:
      QgsDebugError( u"Data type %1 is not supported"_s.arg( qgsEnumValueToKey< Qgis::DataType >( type ) ) );
      break;
  }
}
 
inline double QgsRasterBlock::value( qgssize index ) const SIP_SKIP
{
  if ( !mData )
  {
    QgsDebugError( u"Data block not allocated"_s );
    return std::numeric_limits<double>::quiet_NaN();
  }
  return readValue( mData, mDataType, index );
}
 
inline double QgsRasterBlock::valueAndNoData( qgssize index, bool &isNoData ) const SIP_SKIP
{
  if ( !mData )
  {
    QgsDebugError( u"Data block not allocated"_s );
    isNoData = true;
    return std::numeric_limits<double>::quiet_NaN();
  }
  if ( index >= static_cast< qgssize >( mWidth )*mHeight )
  {
    QgsDebugError( u"Index %1 out of range (%2 x %3)"_s.arg( index ).arg( mWidth ).arg( mHeight ) );
    isNoData = true; // we consider no data if outside
    return std::numeric_limits<double>::quiet_NaN();
  }
 
  const double val = readValue( mData, mDataType, index );
 
  if ( !mHasNoDataValue && !mNoDataBitmap )
  {
    isNoData = false;
    return val;
  }
 
  if ( mHasNoDataValue )
  {
    isNoData = isNoDataValue( val );
    return val;
  }
  // use no data bitmap
  if ( !mNoDataBitmap )
  {
    // no data are not defined
    isNoData = false;
    return val;
  }
 
  // no data is a bitmap
  isNoData = QgsRasterBlock::isNoData( index );
  return val;
}
 
inline bool QgsRasterBlock::isNoDataValue( double value ) const SIP_SKIP
{
  return std::isnan( value ) || qgsDoubleNear( value, mNoDataValue );
}
 
#endif