add build virtual point cloud algorithm

alexbruy · wonder-sk · commit 3a8a7cba9644 · 2023-03-22T16:04:01.000+01:00
diff --git a/src/analysis/CMakeLists.txt b/src/analysis/CMakeLists.txt
@@ -424,6 +424,7 @@ if (WITH_PDAL)
     processing/pdal/qgspdalalgorithmbase.cpp
 
     processing/pdal/qgsalgorithmpdalboundary.cpp
+    processing/pdal/qgsalgorithmpdalbuildvpc.cpp
     processing/pdal/qgsalgorithmpdalconvertformat.cpp
     processing/pdal/qgsalgorithmpdaldensity.cpp
     processing/pdal/qgsalgorithmpdalexportraster.cpp
diff --git a/src/analysis/processing/pdal/qgsalgorithmpdalbuildvpc.cpp b/src/analysis/processing/pdal/qgsalgorithmpdalbuildvpc.cpp
@@ -0,0 +1,95 @@
+/***************************************************************************
+                         qgsalgorithmpdalbuildvpc.cpp
+                         ---------------------
+    begin                : February 2023
+    copyright            : (C) 2023 by Alexander Bruy
+    email                : alexander dot bruy 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 "qgsalgorithmpdalbuildvpc.h"
+
+#include "qgsrunprocess.h"
+#include "qgspointcloudlayer.h"
+
+///@cond PRIVATE
+
+QString QgsPdalBuildVpcAlgorithm::name() const
+{
+  return QStringLiteral( "virtualpointcloud" );
+}
+
+QString QgsPdalBuildVpcAlgorithm::displayName() const
+{
+  return QObject::tr( "Build virtual point cloud (VPC)" );
+}
+
+QString QgsPdalBuildVpcAlgorithm::group() const
+{
+  return QObject::tr( "Point cloud data management" );
+}
+
+QString QgsPdalBuildVpcAlgorithm::groupId() const
+{
+  return QStringLiteral( "pointclouddatamanagement" );
+}
+
+QStringList QgsPdalBuildVpcAlgorithm::tags() const
+{
+  return QObject::tr( "collect,merge,combine,point cloud,virtual,vpc" ).split( ',' );
+}
+
+QString QgsPdalBuildVpcAlgorithm::shortHelpString() const
+{
+  return QObject::tr( "This algorithm creates a virtual point cloud from input data." );
+}
+
+QgsPdalBuildVpcAlgorithm *QgsPdalBuildVpcAlgorithm::createInstance() const
+{
+  return new QgsPdalBuildVpcAlgorithm();
+}
+
+void QgsPdalBuildVpcAlgorithm::initAlgorithm( const QVariantMap & )
+{
+  addParameter( new QgsProcessingParameterMultipleLayers( QStringLiteral( "LAYERS" ), QObject::tr( "Input layers" ), QgsProcessing::TypePointCloud ) );
+  addParameter( new QgsProcessingParameterFileDestination( QStringLiteral( "OUTPUT" ), QObject::tr( "Virtual point cloud file" ), QObject::tr( "VPC files (*.vpc *.VPC)" ) ) );
+}
+
+QStringList QgsPdalBuildVpcAlgorithm::createArgumentLists( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback )
+{
+  Q_UNUSED( feedback );
+
+  const QList< QgsMapLayer * > layers = parameterAsLayerList( parameters, QStringLiteral( "LAYERS" ), context );
+  if ( layers.empty() )
+  {
+    feedback->reportError( QObject::tr( "No layers selected" ), true );
+  }
+
+  const QString outputFile = parameterAsFileOutput( parameters, QStringLiteral( "OUTPUT" ), context );
+  setOutputValue( QStringLiteral( "OUTPUT" ), outputFile );
+
+  QStringList args;
+  args.reserve( layers.count() + 2 );
+
+  args << QStringLiteral( "build_vpc" )
+       << QStringLiteral( "--output=%1" ).arg( outputFile );
+
+  addThreadsParameter( args );
+
+  for ( const QgsMapLayer *layer : std::as_const( layers ) )
+  {
+    args << layer->source();
+  }
+
+  return args;
+}
+
+///@endcond
diff --git a/src/analysis/processing/pdal/qgsalgorithmpdalbuildvpc.h b/src/analysis/processing/pdal/qgsalgorithmpdalbuildvpc.h
@@ -0,0 +1,54 @@
+/***************************************************************************
+                         qgsalgorithmpdalbuildvpc.h
+                         ---------------------
+    begin                : February 2023
+    copyright            : (C) 2023 by Alexander Bruy
+    email                : alexander dot bruy 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 QGSALGORITHMPDALBUILDVPC_H
+#define QGSALGORITHMPDALBUILDVPC_H
+
+#define SIP_NO_FILE
+
+#include "qgis_sip.h"
+#include "qgspdalalgorithmbase.h"
+
+///@cond PRIVATE
+
+/**
+ * Native build virtual point cloud (VPC) algorithm.
+ */
+class QgsPdalBuildVpcAlgorithm : public QgsPdalAlgorithmBase
+{
+
+  public:
+
+    QgsPdalBuildVpcAlgorithm() = default;
+    void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
+    QString name() const override;
+    QString displayName() const override;
+    QString group() const override;
+    QString groupId() const override;
+    QStringList tags() const override;
+    QString shortHelpString() const override;
+    QgsPdalBuildVpcAlgorithm *createInstance() const override SIP_FACTORY;
+
+    QStringList createArgumentLists( const QVariantMap &parameters,
+                                     QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
+
+    friend class TestQgsProcessingPdalAlgs;
+};
+
+///@endcond PRIVATE
+
+#endif // QGSALGORITHMPDALBUILDVPC_H
diff --git a/src/analysis/processing/pdal/qgspdalalgorithms.cpp b/src/analysis/processing/pdal/qgspdalalgorithms.cpp
@@ -20,6 +20,7 @@
 #include "qgsapplication.h"
 
 #include "qgsalgorithmpdalboundary.h"
+#include "qgsalgorithmpdalbuildvpc.h"
 #include "qgsalgorithmpdalconvertformat.h"
 #include "qgsalgorithmpdaldensity.h"
 #include "qgsalgorithmpdalexportraster.h"
@@ -88,6 +89,7 @@ void QgsPdalAlgorithms::loadAlgorithms()
   const QgsScopedRuntimeProfile profile( QObject::tr( "QGIS PDAL provider" ) );
 
   addAlgorithm( new QgsPdalBoundaryAlgorithm() );
+  addAlgorithm( new QgsPdalBuildVpcAlgorithm() );
   addAlgorithm( new QgsPdalConvertFormatAlgorithm() );
   addAlgorithm( new QgsPdalDensityAlgorithm() );
   addAlgorithm( new QgsPdalExportRasterAlgorithm() );
diff --git a/tests/src/analysis/testqgsprocessingpdalalgs.cpp b/tests/src/analysis/testqgsprocessingpdalalgs.cpp
@@ -35,6 +35,7 @@ class TestQgsProcessingPdalAlgs: public QObject
     void cleanup() {} // will be called after every testfunction.
 
     void boundary();
+    void buildVpc();
     void convertFormat();
     void density();
     void exportRaster();
@@ -697,5 +698,49 @@ void TestQgsProcessingPdalAlgs::merge()
           );
 }
 
+void TestQgsProcessingPdalAlgs::buildVpc()
+{
+  QgsPdalAlgorithmBase *alg = const_cast<QgsPdalAlgorithmBase *>( static_cast< const QgsPdalAlgorithmBase * >( QgsApplication::processingRegistry()->algorithmById( QStringLiteral( "pdal:virtualpointcloud" ) ) ) );
+
+  std::unique_ptr< QgsProcessingContext > context = std::make_unique< QgsProcessingContext >();
+  context->setProject( QgsProject::instance() );
+
+  QgsProcessingFeedback feedback;
+
+  const QString pointCloud1 = QString( TEST_DATA_DIR ) + "/point_clouds/copc/rgb.copc.laz";
+  const QString pointCloud2 = QString( TEST_DATA_DIR ) + "/point_clouds/copc/rgb16.copc.laz";
+  const QString outputFile = QDir::tempPath() + "/test.vpc";
+
+  // single layer
+  QVariantMap parameters;
+  parameters.insert( QStringLiteral( "LAYERS" ), QStringList() << pointCloud1 );
+  parameters.insert( QStringLiteral( "OUTPUT" ), outputFile );
+
+  QStringList args = alg->createArgumentLists( parameters, *context, &feedback );
+  QCOMPARE( args, QStringList() << QStringLiteral( "build_vpc" )
+            << QStringLiteral( "--output=%1" ).arg( outputFile )
+            << pointCloud1
+          );
+
+  // multiple layers
+  parameters.insert( QStringLiteral( "LAYERS" ), QStringList() << pointCloud1 << pointCloud2 );
+  args = alg->createArgumentLists( parameters, *context, &feedback );
+  QCOMPARE( args, QStringList() << QStringLiteral( "build_vpc" )
+            << QStringLiteral( "--output=%1" ).arg( outputFile )
+            << pointCloud1
+            << pointCloud2
+          );
+
+  // set max threads to 2, a --threads argument should be added
+  QgsSettings().setValue( QStringLiteral( "/Processing/Configuration/MAX_THREADS" ), 2 );
+  args = alg->createArgumentLists( parameters, *context, &feedback );
+  QCOMPARE( args, QStringList() << QStringLiteral( "build_vpc" )
+            << QStringLiteral( "--output=%1" ).arg( outputFile )
+            << QStringLiteral( "--threads=2" )
+            << pointCloud1
+            << pointCloud2
+          );
+}
+
 QGSTEST_MAIN( TestQgsProcessingPdalAlgs )
 #include "testqgsprocessingpdalalgs.moc"
