ContextBasedFeature.h

Go to the documentation of this file.

// ----------------------------------------------------------------------------
// -                        CloudViewer: www.cloudViewer.org                  -
// ----------------------------------------------------------------------------
// Copyright (c) 2018-2024 www.cloudViewer.org
// SPDX-License-Identifier: MIT
// ----------------------------------------------------------------------------
 
#pragma once
 
// ##########################################################################
// #                                                                        #
// #                     ACLOUDVIEWER PLUGIN: q3DMASC                       #
// #                                                                        #
// #  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; version 2 or later of the License.      #
// #                                                                        #
// #  This program is distributed in the hope that it will be useful,       #
// #  but WITHOUT ANY WARRANTY; without even the implied warranty of        #
// #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the          #
// #  GNU General Public License for more details.                          #
// #                                                                        #
// #                 COPYRIGHT: Dimitri Lague / CNRS / UEB                  #
// #                                                                        #
// ##########################################################################
 
// Local
#include "FeaturesInterface.h"
 
namespace masc {
struct ContextBasedFeature : public Feature {
public:  // ContextBasedFeatureType
    typedef QSharedPointer<ContextBasedFeature> Shared;
 
    enum ContextBasedFeatureType { Invalid = 0, DZ, DH };
 
    static QString ToString(ContextBasedFeatureType type) {
        switch (type) {
            case Invalid:
                return "Invalid";
            case DZ:
                return "DZ";
            case DH:
                return "DH";
            default:
                assert(false);
                break;
        }
        return "Invalid";
    }
 
    static inline ContextBasedFeatureType FromString(const QString& token) {
        return FromUpperString(token.toUpper());
    }
    static ContextBasedFeatureType FromUpperString(const QString& token) {
        if (token.startsWith("DZ"))
            return DZ;
        else if (token.startsWith("DH"))
            return DH;
 
        return Invalid;
    }
 
public:  // methods
    ContextBasedFeature(
            ContextBasedFeatureType p_type,
            int p_kNN = 1,
            double p_scale = std::numeric_limits<double>::quiet_NaN(),
            int p_ctxClassLabel = 0)
        : type(p_type),
          kNN(p_kNN),
          ctxClassLabel(p_ctxClassLabel),
          sf(nullptr) {
        scale = p_scale;
    }
 
    // inherited from Feature
    virtual Type getType() const override { return Type::ContextBasedFeature; }
    virtual Feature::Shared clone() const override {
        return Feature::Shared(new ContextBasedFeature(*this));
    }
    virtual bool prepare(
            const CorePoints& corePoints,
            QString& error,
            cloudViewer::GenericProgressCallback* progressCb = nullptr,
            SFCollector* generatedScalarFields = nullptr) override;
    virtual bool finish(const CorePoints& corePoints, QString& error) override;
    virtual bool checkValidity(QString corePointRole,
                               QString& error) const override;
    virtual QString toString() const override;
 
    bool computeValue(
            cloudViewer::DgmOctree::NeighboursSet& pointsInNeighbourhood,
            const CCVector3& queryPoint,
            ScalarType& outputValue) const;
 
public:  // members
 
    ContextBasedFeatureType type;
 
    // Number of neighbors
    int kNN;
    int ctxClassLabel;
    cloudViewer::ScalarField* sf;
};
}  // namespace masc