Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :                          qgsalgorithmrandomextract.cpp
       3                 :            :                          ---------------------
       4                 :            :     begin                : December 2019
       5                 :            :     copyright            : (C) 2019 by Alexander Bruy
       6                 :            :     email                : alexander dot bruy at gmail dot com
       7                 :            :  ***************************************************************************/
       8                 :            : 
       9                 :            : /***************************************************************************
      10                 :            :  *                                                                         *
      11                 :            :  *   This program is free software; you can redistribute it and/or modify  *
      12                 :            :  *   it under the terms of the GNU General Public License as published by  *
      13                 :            :  *   the Free Software Foundation; either version 2 of the License, or     *
      14                 :            :  *   (at your option) any later version.                                   *
      15                 :            :  *                                                                         *
      16                 :            :  ***************************************************************************/
      17                 :            : 
      18                 :            : #include "qgsalgorithmrandomextract.h"
      19                 :            : #include <random>
      20                 :            : #include <functional>
      21                 :            : 
      22                 :            : ///@cond PRIVATE
      23                 :            : 
      24                 :          0 : QString QgsRandomExtractAlgorithm::name() const
      25                 :            : {
      26                 :          0 :   return QStringLiteral( "randomextract" );
      27                 :            : }
      28                 :            : 
      29                 :          0 : QString QgsRandomExtractAlgorithm::displayName() const
      30                 :            : {
      31                 :          0 :   return QObject::tr( "Random extract" );
      32                 :            : }
      33                 :            : 
      34                 :          0 : QStringList QgsRandomExtractAlgorithm::tags() const
      35                 :            : {
      36                 :          0 :   return QObject::tr( "extract,filter,random,number,percentage" ).split( ',' );
      37                 :          0 : }
      38                 :            : 
      39                 :          0 : QString QgsRandomExtractAlgorithm::group() const
      40                 :            : {
      41                 :          0 :   return QObject::tr( "Vector selection" );
      42                 :            : }
      43                 :            : 
      44                 :          0 : QString QgsRandomExtractAlgorithm::groupId() const
      45                 :            : {
      46                 :          0 :   return QStringLiteral( "vectorselection" );
      47                 :            : }
      48                 :            : 
      49                 :          0 : QString QgsRandomExtractAlgorithm::shortHelpString() const
      50                 :            : {
      51                 :          0 :   return QObject::tr( "This algorithm takes a vector layer and generates a new one that contains only a subset "
      52                 :            :                       "of the features in the input layer.\n\n"
      53                 :            :                       "The subset is defined randomly, using a percentage or count value to define the total number "
      54                 :            :                       "of features in the subset." );
      55                 :            : }
      56                 :            : 
      57                 :          0 : QgsRandomExtractAlgorithm *QgsRandomExtractAlgorithm::createInstance() const
      58                 :            : {
      59                 :          0 :   return new QgsRandomExtractAlgorithm();
      60                 :            : }
      61                 :            : 
      62                 :          0 : void QgsRandomExtractAlgorithm::initAlgorithm( const QVariantMap & )
      63                 :            : {
      64                 :          0 :   addParameter( new QgsProcessingParameterFeatureSource( QStringLiteral( "INPUT" ), QObject::tr( "Input layer" ),
      65                 :          0 :                 QList< int >() << QgsProcessing::TypeVector ) );
      66                 :          0 :   addParameter( new QgsProcessingParameterEnum( QStringLiteral( "METHOD" ), QObject::tr( "Method" ), QStringList() << QObject::tr( "Number of features" ) << QObject::tr( "Percentage of features" ), false, 0 ) );
      67                 :          0 :   addParameter( new QgsProcessingParameterNumber( QStringLiteral( "NUMBER" ), QObject::tr( "Number/percentage of features" ),
      68                 :          0 :                 QgsProcessingParameterNumber::Integer, 10, false, 0 ) );
      69                 :            : 
      70                 :          0 :   addParameter( new QgsProcessingParameterFeatureSink( QStringLiteral( "OUTPUT" ), QObject::tr( "Extracted (random)" ) ) );
      71                 :          0 : }
      72                 :            : 
      73                 :          0 : QVariantMap QgsRandomExtractAlgorithm::processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback )
      74                 :            : {
      75                 :          0 :   std::unique_ptr< QgsProcessingFeatureSource > source( parameterAsSource( parameters, QStringLiteral( "INPUT" ), context ) );
      76                 :          0 :   if ( !source )
      77                 :          0 :     throw QgsProcessingException( invalidSourceError( parameters, QStringLiteral( "INPUT" ) ) );
      78                 :            : 
      79                 :          0 :   QString dest;
      80                 :          0 :   std::unique_ptr< QgsFeatureSink > sink( parameterAsSink( parameters, QStringLiteral( "OUTPUT" ), context, dest, source->fields(),
      81                 :          0 :                                           source->wkbType(), source->sourceCrs(), QgsFeatureSink::RegeneratePrimaryKey ) );
      82                 :          0 :   if ( !sink )
      83                 :          0 :     throw QgsProcessingException( invalidSinkError( parameters, QStringLiteral( "OUTPUT" ) ) );
      84                 :            : 
      85                 :          0 :   int method = parameterAsEnum( parameters, QStringLiteral( "METHOD" ), context );
      86                 :          0 :   int number = parameterAsInt( parameters, QStringLiteral( "NUMBER" ), context );
      87                 :            : 
      88                 :          0 :   long count = source->featureCount();
      89                 :            : 
      90                 :          0 :   if ( method == 0 )
      91                 :            :   {
      92                 :            :     // number of features
      93                 :          0 :     if ( number > count )
      94                 :          0 :       throw QgsProcessingException( QObject::tr( "Selected number is greater than feature count. Choose a lower value and try again." ) );
      95                 :          0 :   }
      96                 :            :   else
      97                 :            :   {
      98                 :            :     // percentage of features
      99                 :          0 :     if ( number > 100 )
     100                 :          0 :       throw QgsProcessingException( QObject::tr( "Percentage can't be greater than 100. Choose a lower value and try again." ) );
     101                 :            : 
     102                 :          0 :     number = static_cast< int >( std::ceil( number * count / 100 ) );
     103                 :            :   }
     104                 :            : 
     105                 :            :   // initialize random engine
     106                 :          0 :   std::random_device randomDevice;
     107                 :          0 :   std::mt19937 mersenneTwister( randomDevice() );
     108                 :          0 :   std::uniform_int_distribution<int> fidsDistribution( 0, count );
     109                 :            : 
     110                 :          0 :   QVector< QgsFeatureId > fids( number );
     111                 :          0 :   std::generate( fids.begin(), fids.end(), bind( fidsDistribution, mersenneTwister ) );
     112                 :            : 
     113                 :          0 :   QHash< QgsFeatureId, int > idsCount;
     114                 :          0 :   for ( QgsFeatureId id : fids )
     115                 :            :   {
     116                 :          0 :     if ( feedback->isCanceled() )
     117                 :            :     {
     118                 :          0 :       break;
     119                 :            :     }
     120                 :            : 
     121                 :          0 :     idsCount[ id ] += 1;
     122                 :            :   }
     123                 :            : 
     124                 :          0 :   QgsFeatureIds ids = qgis::listToSet( idsCount.keys() );
     125                 :          0 :   QgsFeatureIterator fit = source->getFeatures( QgsFeatureRequest().setFilterFids( ids ), QgsProcessingFeatureSource::FlagSkipGeometryValidityChecks );
     126                 :            : 
     127                 :          0 :   QgsFeature f;
     128                 :          0 :   while ( fit.nextFeature( f ) )
     129                 :            :   {
     130                 :          0 :     if ( feedback->isCanceled() )
     131                 :            :     {
     132                 :          0 :       break;
     133                 :            :     }
     134                 :            : 
     135                 :          0 :     const int count = idsCount.value( f.id() );
     136                 :          0 :     for ( int i = 0; i < count; ++i )
     137                 :            :     {
     138                 :          0 :       sink->addFeature( f, QgsFeatureSink::FastInsert );
     139                 :          0 :     }
     140                 :            :   }
     141                 :            : 
     142                 :          0 :   QVariantMap outputs;
     143                 :          0 :   outputs.insert( QStringLiteral( "OUTPUT" ), dest );
     144                 :          0 :   return outputs;
     145                 :          0 : }
     146                 :            : 
     147                 :            : ///@endcond