Prefer using copc index file for processing if it exist (#61771)

* prefer using copc index file for processing if it exist

* ensure that copc layer is valid

* read using copc data provider

* add test case to verify that copc file is used in alg

* fix error in doc

* review suggestions

* add more complex test

* simplify test

* wait for index to be created and verify that it exists

* reflow for copc input check

* avoid marking lyr as unused

Author: JanCaha

src/analysis/processing/pdal/qgspdalalgorithmbase.cpp

@@ -22,6 +22,7 @@
 #include "qgspointcloudlayer.h"
 #include "qgspointcloudexpression.h"
 #include "qgsrasterlayerelevationproperties.h"
+#include "qgscopcprovider.h"
 
 #include <QRegularExpression>
 
@@ -281,4 +282,46 @@ QVariantMap QgsPdalAlgorithmBase::processAlgorithm( const QVariantMap &parameter
   return outputs;
 }
 
+QgsPointCloudLayer *QgsPdalAlgorithmBase::parameterAsPointCloudLayer( const QVariantMap &parameters, const QString &name, QgsProcessingContext &context, QgsProcessing::LayerOptionsFlags flags ) const
+{
+  QgsPointCloudLayer *layer = QgsProcessingParameters::parameterAsPointCloudLayer( parameterDefinition( name ), parameters, context, flags );
+
+  // if layer or its data provider are empty return nullptr
+  if ( !layer || !layer->dataProvider() )
+    return nullptr;
+
+  // if COPC provider, return as it is
+  if ( layer->dataProvider()->name() == QStringLiteral( "copc" ) )
+  {
+    return layer;
+  }
+
+  // if source is remote file, use it as it is
+  const QUrl url = QUrl( layer->source() );
+  if ( url.isValid() && ( url.scheme() == "http" || url.scheme() == "https" ) )
+  {
+    return layer;
+  }
+
+  // for local files try to find COPC index file
+  const QString copcFileName = QgsPdalAlgorithmBase::copcIndexFile( layer->source() );
+
+  if ( QFileInfo::exists( copcFileName ) )
+  {
+    QgsPointCloudLayer *copcLayer = new QgsPointCloudLayer( copcFileName, layer->name(), "copc" );
+    if ( copcLayer && copcLayer->isValid() )
+      return copcLayer;
+  }
+
+  return layer;
+}
+
+QString QgsPdalAlgorithmBase::copcIndexFile( const QString &filename )
+{
+  const QFileInfo fi( filename );
+  const QDir directory = fi.absoluteDir();
+  const QString outputFile = QStringLiteral( "%1/%2.copc.laz" ).arg( directory.absolutePath() ).arg( fi.completeBaseName() );
+  return outputFile;
+}
+
 ///@endcond

src/analysis/processing/pdal/qgspdalalgorithmbase.h

@@ -86,6 +86,22 @@ class QgsPdalAlgorithmBase : public QgsProcessingAlgorithm
 
     QVariantMap processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
 
+    /**
+     * Returns name of index copc file for given \a filename of point cloud.
+     *
+     * \param filename name of the original dataset
+     *
+     * \since 3.44
+     */
+    static QString copcIndexFile( const QString &filename );
+
+    /**
+     * Override that prefers copc.laz index file as datasource for faster processing (if the index file exists) otherwise uses original layer.
+     *
+     * \since 3.44
+     */
+    QgsPointCloudLayer *parameterAsPointCloudLayer( const QVariantMap &parameters, const QString &name, QgsProcessingContext &context, QgsProcessing::LayerOptionsFlags flags ) const;
+
   private:
     QMap<QString, QVariant> mOutputValues;
     bool mEnableElevationProperties = false;

tests/src/analysis/testqgsprocessingpdalalgs.cpp

@@ -22,7 +22,9 @@
 #include "qgsprocessingcontext.h"
 #include "qgspdalalgorithms.h"
 #include "qgspdalalgorithmbase.h"
+#include "qgspointcloudlayer.h"
 
+#include <QThread>
 
 class TestQgsProcessingPdalAlgs : public QgsTest
 {
@@ -56,6 +58,8 @@ class TestQgsProcessingPdalAlgs : public QgsTest
     void thinByRadius();
     void tile();
 
+    void useIndexCopcFile();
+
   private:
     void updateFileListArg( QStringList &args, const QString &fileName );
 
@@ -854,5 +858,41 @@ void TestQgsProcessingPdalAlgs::filter()
   QCOMPARE( args, QStringList() << QStringLiteral( "translate" ) << QStringLiteral( "--input=%1" ).arg( mPointCloudLayerPath ) << QStringLiteral( "--output=%1" ).arg( outputPointCloud ) << QStringLiteral( "--filter=Classification == 7 || Classification == 8" ) << QStringLiteral( "--bounds=([1, 3], [2, 4])" ) << QStringLiteral( "--threads=2" ) );
 }
 
+void TestQgsProcessingPdalAlgs::useIndexCopcFile()
+{
+  const QString pointCloudFileName = QString( TEST_DATA_DIR ) + "/point_clouds/las/cloud.las";
+  const QFileInfo pointCloudFileInfo( pointCloudFileName );
+  const QString pointCloudLayerPath = pointCloudFileInfo.filePath();
+  const QString copcIndexFileName = pointCloudFileInfo.absolutePath() + "/" + pointCloudFileInfo.completeBaseName() + ".copc.laz";
+
+  QgsPdalAlgorithmBase *alg = const_cast<QgsPdalAlgorithmBase *>( static_cast<const QgsPdalAlgorithmBase *>( QgsApplication::processingRegistry()->algorithmById( QStringLiteral( "pdal:exportvector" ) ) ) );
+
+  auto context = std::make_unique<QgsProcessingContext>();
+  context->setMaximumThreads( 0 );
+
+  QgsProcessingFeedback feedback;
+
+  // generate index for use in algorithm
+  QgsPointCloudLayer *lyr = new QgsPointCloudLayer( pointCloudLayerPath, "layer", "pdal" );
+  Q_UNUSED( lyr );
+
+  //wait for index to be generated
+  while ( !QFileInfo::exists( copcIndexFileName ) )
+  {
+    QThread::sleep( 1 );
+  }
+  QVERIFY( QFileInfo::exists( copcIndexFileName ) );
+
+  const QString outputFile = QDir::tempPath() + "/points.gpkg";
+
+  QVariantMap parameters;
+  parameters.insert( QStringLiteral( "INPUT" ), pointCloudLayerPath );
+  parameters.insert( QStringLiteral( "OUTPUT" ), outputFile );
+
+  QStringList args = alg->createArgumentLists( parameters, *context, &feedback );
+  QCOMPARE( args, QStringList() << QStringLiteral( "to_vector" ) << QStringLiteral( "--input=%1" ).arg( copcIndexFileName ) << QStringLiteral( "--output=%1" ).arg( outputFile ) );
+  QVERIFY( args.at( 1 ).endsWith( "copc.laz" ) );
+}
+
 QGSTEST_MAIN( TestQgsProcessingPdalAlgs )
 #include "testqgsprocessingpdalalgs.moc"