qgsspatialindex.cpp

Go to the documentation of this file.

/***************************************************************************
    qgsspatialindex.cpp  - wrapper class for spatial index library
    ----------------------
    begin                : December 2006
    copyright            : (C) 2006 by Martin Dobias
    email                : wonder.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.                                   *
 *                                                                         *
 ***************************************************************************/

#include "qgsspatialindex.h"

#include "qgsgeometry.h"
#include "qgsfeature.h"
#include "qgsfeatureiterator.h"
#include "qgsrectangle.h"
#include "qgslogger.h"
#include "qgsfeaturesource.h"
#include "qgsfeedback.h"

#include <spatialindex/SpatialIndex.h>
#include <QMutex>
#include <QMutexLocker>

using namespace SpatialIndex;



class QgisVisitor : public SpatialIndex::IVisitor
{
  public:
    explicit QgisVisitor( QList<QgsFeatureId> &list )
      : mList( list ) {}

    void visitNode( const INode &n ) override
    { Q_UNUSED( n ); }

    void visitData( const IData &d ) override
    {
      mList.append( d.getIdentifier() );
    }

    void visitData( std::vector<const IData *> &v ) override
    { Q_UNUSED( v ); }

  private:
    QList<QgsFeatureId> &mList;
};

class QgsSpatialIndexCopyVisitor : public SpatialIndex::IVisitor
{
  public:
    explicit QgsSpatialIndexCopyVisitor( SpatialIndex::ISpatialIndex *newIndex )
      : mNewIndex( newIndex ) {}

    void visitNode( const INode &n ) override
    { Q_UNUSED( n ); }

    void visitData( const IData &d ) override
    {
      SpatialIndex::IShape *shape = nullptr;
      d.getShape( &shape );
      mNewIndex->insertData( 0, nullptr, *shape, d.getIdentifier() );
      delete shape;
    }

    void visitData( std::vector<const IData *> &v ) override
    { Q_UNUSED( v ); }

  private:
    SpatialIndex::ISpatialIndex *mNewIndex = nullptr;
};

class QgsNearestNeighborComparator : public INearestNeighborComparator
{
  public:

    QgsNearestNeighborComparator( const QHash< QgsFeatureId, QgsGeometry > *geometries, const QgsPointXY &point, double maxDistance )
      : mGeometries( geometries )
      , mPoint( QgsGeometry::fromPointXY( point ) )
      , mMaxDistance( maxDistance )
    {
    }

    const QHash< QgsFeatureId, QgsGeometry > *mGeometries = nullptr;
    QgsGeometry mPoint;
    double mMaxDistance = 0;
    QSet< QgsFeatureId > mFeaturesOutsideMaxDistance;

    double getMinimumDistance( const IShape &query, const IShape &entry ) override
    {
      return query.getMinimumDistance( entry );
    }

    double getMinimumDistance( const IShape &query, const IData &data ) override
    {
      // start with the default implementation, which gives distance to bounding box only
      IShape *pS;
      data.getShape( &pS );
      double dist = query.getMinimumDistance( *pS );
      delete pS;

      // if doing exact distance search, AND either no max distance specified OR the
      // distance to the bounding box is less than the max distance, calculate the exact
      // distance now.
      // (note: if bounding box is already greater than the distance away then max distance, there's no
      // point doing this more expensive calculation, since we can't possibly use this feature anyway!)
      if ( mGeometries && ( mMaxDistance <= 0.0 || dist <= mMaxDistance ) )
      {
        QgsGeometry other = mGeometries->value( data.getIdentifier() );
        dist = other.distance( mPoint );
      }

      if ( mMaxDistance > 0 && dist > mMaxDistance )
      {
        // feature is outside of maximum distance threshold. Flag it,
        // but "trick" libspatialindex into considering it as just outside
        // our max distance region. This means if there's no other closer features (i.e.,
        // within our actual maximum search distance), the libspatialindex
        // nearest neighbor test will use this feature and not needlessly continue hunting
        // through the remaining more distant features in the index.
        // TODO: add proper API to libspatialindex to allow a maximum search distance in
        // nearest neighbor tests
        mFeaturesOutsideMaxDistance.insert( data.getIdentifier() );
        return mMaxDistance + 0.00000001;
      }
      return dist;
    }
};

class QgsFeatureIteratorDataStream : public IDataStream
{
  public:
    explicit QgsFeatureIteratorDataStream( const QgsFeatureIterator &fi, QgsFeedback *feedback = nullptr, QgsSpatialIndex::Flags flags = nullptr )
      : mFi( fi )
      , mFeedback( feedback )
      , mFlags( flags )
    {
      readNextEntry();
    }

    ~QgsFeatureIteratorDataStream() override
    {
      delete mNextData;
    }

    IData *getNext() override
    {
      if ( mFeedback && mFeedback->isCanceled() )
        return nullptr;

      RTree::Data *ret = mNextData;
      mNextData = nullptr;
      readNextEntry();
      return ret;
    }

    bool hasNext() override { return nullptr != mNextData; }

    uint32_t size() override { Q_ASSERT( false && "not available" ); return 0; }

    void rewind() override { Q_ASSERT( false && "not available" ); }

    QHash< QgsFeatureId, QgsGeometry > geometries;

  protected:
    void readNextEntry()
    {
      QgsFeature f;
      SpatialIndex::Region r;
      QgsFeatureId id;
      while ( mFi.nextFeature( f ) )
      {
        if ( QgsSpatialIndex::featureInfo( f, r, id ) )
        {
          mNextData = new RTree::Data( 0, nullptr, r, id );
          if ( mFlags & QgsSpatialIndex::FlagStoreFeatureGeometries )
            geometries.insert( f.id(), f.geometry() );
          return;
        }
      }
    }

  private:
    QgsFeatureIterator mFi;
    RTree::Data *mNextData = nullptr;
    QgsFeedback *mFeedback = nullptr;
    QgsSpatialIndex::Flags mFlags = nullptr;

};


class QgsSpatialIndexData : public QSharedData
{
  public:
    QgsSpatialIndexData( QgsSpatialIndex::Flags flags )
      : mFlags( flags )
    {
      initTree();
    }

    QgsSpatialIndex::Flags mFlags = nullptr;

    QHash< QgsFeatureId, QgsGeometry > mGeometries;

    explicit QgsSpatialIndexData( const QgsFeatureIterator &fi, QgsFeedback *feedback = nullptr, QgsSpatialIndex::Flags flags = nullptr )
      : mFlags( flags )
    {
      QgsFeatureIteratorDataStream fids( fi, feedback, mFlags );
      initTree( &fids );
      if ( flags & QgsSpatialIndex::FlagStoreFeatureGeometries )
        mGeometries = fids.geometries;
    }

    QgsSpatialIndexData( const QgsSpatialIndexData &other )
      : QSharedData( other )
      , mFlags( other.mFlags )
      , mGeometries( other.mGeometries )
    {
      QMutexLocker locker( &other.mMutex );

      initTree();

      // copy R-tree data one by one (is there a faster way??)
      double low[]  = { std::numeric_limits<double>::lowest(), std::numeric_limits<double>::lowest() };
      double high[] = { std::numeric_limits<double>::max(), std::numeric_limits<double>::max() };
      SpatialIndex::Region query( low, high, 2 );
      QgsSpatialIndexCopyVisitor visitor( mRTree );
      other.mRTree->intersectsWithQuery( query, visitor );
    }

    ~QgsSpatialIndexData()
    {
      delete mRTree;
      delete mStorage;
    }

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

    void initTree( IDataStream *inputStream = nullptr )
    {
      // for now only memory manager
      mStorage = StorageManager::createNewMemoryStorageManager();

      // R-Tree parameters
      double fillFactor = 0.7;
      unsigned long indexCapacity = 10;
      unsigned long leafCapacity = 10;
      unsigned long dimension = 2;
      RTree::RTreeVariant variant = RTree::RV_RSTAR;

      // create R-tree
      SpatialIndex::id_type indexId;

      if ( inputStream && inputStream->hasNext() )
        mRTree = RTree::createAndBulkLoadNewRTree( RTree::BLM_STR, *inputStream, *mStorage, fillFactor, indexCapacity,
                 leafCapacity, dimension, variant, indexId );
      else
        mRTree = RTree::createNewRTree( *mStorage, fillFactor, indexCapacity,
                                        leafCapacity, dimension, variant, indexId );
    }

    SpatialIndex::IStorageManager *mStorage = nullptr;

    SpatialIndex::ISpatialIndex *mRTree = nullptr;

    mutable QMutex mMutex;

};


// -------------------------------------------------------------------------


QgsSpatialIndex::QgsSpatialIndex( QgsSpatialIndex::Flags flags )
{
  d = new QgsSpatialIndexData( flags );
}

QgsSpatialIndex::QgsSpatialIndex( const QgsFeatureIterator &fi, QgsFeedback *feedback, QgsSpatialIndex::Flags flags )
{
  d = new QgsSpatialIndexData( fi, feedback, flags );
}

QgsSpatialIndex::QgsSpatialIndex( const QgsFeatureSource &source, QgsFeedback *feedback, QgsSpatialIndex::Flags flags )
{
  d = new QgsSpatialIndexData( source.getFeatures( QgsFeatureRequest().setNoAttributes() ), feedback, flags );
}

QgsSpatialIndex::QgsSpatialIndex( const QgsSpatialIndex &other ) //NOLINT
  : d( other.d )
{
}

QgsSpatialIndex:: ~QgsSpatialIndex() //NOLINT
{
}

QgsSpatialIndex &QgsSpatialIndex::operator=( const QgsSpatialIndex &other )
{
  if ( this != &other )
    d = other.d;
  return *this;
}

SpatialIndex::Region QgsSpatialIndex::rectToRegion( const QgsRectangle &rect )
{
  double pt1[2] = { rect.xMinimum(), rect.yMinimum() },
                  pt2[2] = { rect.xMaximum(), rect.yMaximum() };
  return SpatialIndex::Region( pt1, pt2, 2 );
}

bool QgsSpatialIndex::featureInfo( const QgsFeature &f, SpatialIndex::Region &r, QgsFeatureId &id )
{
  QgsRectangle rect;
  if ( !featureInfo( f, rect, id ) )
    return false;

  r = rectToRegion( rect );
  return true;
}

bool QgsSpatialIndex::featureInfo( const QgsFeature &f, QgsRectangle &rect, QgsFeatureId &id )
{
  if ( !f.hasGeometry() )
    return false;

  id = f.id();
  rect = f.geometry().boundingBox();
  return true;
}

bool QgsSpatialIndex::addFeature( QgsFeature &feature, QgsFeatureSink::Flags )
{
  QgsRectangle rect;
  QgsFeatureId id;
  if ( !featureInfo( feature, rect, id ) )
    return false;

  if ( addFeature( id, rect ) )
  {
    if ( d->mFlags & QgsSpatialIndex::FlagStoreFeatureGeometries )
    {
      QMutexLocker locker( &d->mMutex );
      d->mGeometries.insert( feature.id(), feature.geometry() );
    }
    return true;
  }
  return false;
}

bool QgsSpatialIndex::addFeatures( QgsFeatureList &features, QgsFeatureSink::Flags flags )
{
  QgsFeatureList::iterator fIt = features.begin();
  bool result = true;
  for ( ; fIt != features.end(); ++fIt )
  {
    result = result && addFeature( *fIt, flags );
  }
  return result;
}

bool QgsSpatialIndex::insertFeature( const QgsFeature &f )
{
  QgsFeature feature( f );
  return addFeature( feature );
}

bool QgsSpatialIndex::insertFeature( QgsFeatureId id, const QgsRectangle &bounds )
{
  return addFeature( id, bounds );
}

bool QgsSpatialIndex::addFeature( QgsFeatureId id, const QgsRectangle &bounds )
{
  SpatialIndex::Region r( rectToRegion( bounds ) );

  QMutexLocker locker( &d->mMutex );

  // TODO: handle possible exceptions correctly
  try
  {
    d->mRTree->insertData( 0, nullptr, r, FID_TO_NUMBER( id ) );
    return true;
  }
  catch ( Tools::Exception &e )
  {
    Q_UNUSED( e );
    QgsDebugMsg( QStringLiteral( "Tools::Exception caught: " ).arg( e.what().c_str() ) );
  }
  catch ( const std::exception &e )
  {
    Q_UNUSED( e );
    QgsDebugMsg( QStringLiteral( "std::exception caught: " ).arg( e.what() ) );
  }
  catch ( ... )
  {
    QgsDebugMsg( QStringLiteral( "unknown spatial index exception caught" ) );
  }

  return false;
}

bool QgsSpatialIndex::deleteFeature( const QgsFeature &f )
{
  SpatialIndex::Region r;
  QgsFeatureId id;
  if ( !featureInfo( f, r, id ) )
    return false;

  QMutexLocker locker( &d->mMutex );
  // TODO: handle exceptions
  if ( d->mFlags & QgsSpatialIndex::FlagStoreFeatureGeometries )
    d->mGeometries.remove( f.id() );
  return d->mRTree->deleteData( r, FID_TO_NUMBER( id ) );
}

QList<QgsFeatureId> QgsSpatialIndex::intersects( const QgsRectangle &rect ) const
{
  QList<QgsFeatureId> list;
  QgisVisitor visitor( list );

  SpatialIndex::Region r = rectToRegion( rect );

  QMutexLocker locker( &d->mMutex );
  d->mRTree->intersectsWithQuery( r, visitor );

  return list;
}

QList<QgsFeatureId> QgsSpatialIndex::nearestNeighbor( const QgsPointXY &point, const int neighbors, const double maxDistance ) const
{
  QList<QgsFeatureId> list;
  QgisVisitor visitor( list );

  double pt[2] = { point.x(), point.y() };
  Point p( pt, 2 );

  QMutexLocker locker( &d->mMutex );
  QgsNearestNeighborComparator nnc( d->mFlags & QgsSpatialIndex::FlagStoreFeatureGeometries ? &d->mGeometries : nullptr,
                                    point, maxDistance );
  d->mRTree->nearestNeighborQuery( neighbors, p, visitor, nnc );

  if ( maxDistance > 0 )
  {
    // trim features outside of max distance
    list.erase( std::remove_if( list.begin(), list.end(),
                                [&nnc]( QgsFeatureId id )
    {
      return nnc.mFeaturesOutsideMaxDistance.contains( id );
    } ), list.end() );
  }

  return list;
}

QgsGeometry QgsSpatialIndex::geometry( QgsFeatureId id ) const
{
  QMutexLocker locker( &d->mMutex );
  return d->mGeometries.value( id );
}

QAtomicInt QgsSpatialIndex::refs() const
{
  return d->ref;
}