ScalarFieldTools.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
 
// Local
#include "CVToolbox.h"
#include "DgmOctree.h"
 
namespace cloudViewer {
 
class GenericCloud;
class GenericIndexedCloud;
class GenericIndexedCloudPersist;
class GenericProgressCallback;
 
struct KMeanClass {
    ScalarType mean;
    ScalarType minValue;
    ScalarType maxValue;
};
 
 
class CV_CORE_LIB_API ScalarFieldTools : public CVToolbox {
public:
 
    static ScalarType computeMeanScalarValue(GenericCloud* theCloud);
 
 
    static ScalarType computeMeanSquareScalarValue(GenericCloud* theCloud);
 
 
    static int computeScalarFieldGradient(
            GenericIndexedCloudPersist* theCloud,
            PointCoordinateType radius,
            bool euclideanDistances,
            bool sameInAndOutScalarField = false,
            GenericProgressCallback* progressCb = nullptr,
            DgmOctree* theOctree = nullptr);
 
 
    static bool applyScalarFieldGaussianFilter(
            PointCoordinateType sigma,
            GenericIndexedCloudPersist* theCloud,
            PointCoordinateType sigmaSF,
            GenericProgressCallback* progressCb = nullptr,
            DgmOctree* theOctree = nullptr);
 
 
    static void multiplyScalarFields(
            GenericIndexedCloud* firstCloud,
            GenericIndexedCloud* secondCloud,
            GenericProgressCallback* progressCb = nullptr);
 
 
    static void computeScalarFieldHistogram(const GenericCloud* theCloud,
                                            unsigned numberOfClasses,
                                            std::vector<int>& histo);
 
 
    static void computeScalarFieldExtremas(const GenericCloud* theCloud,
                                           ScalarType& minV,
                                           ScalarType& maxV);
 
 
    static unsigned countScalarFieldValidValues(const GenericCloud* theCloud);
 
 
    static bool computeKmeans(const GenericCloud* theCloud,
                              unsigned char K,
                              KMeanClass kmcc[],
                              GenericProgressCallback* progressCb = nullptr);
 
 
    static void SetScalarValueToNaN(const CCVector3& P,
                                    ScalarType& scalarValue);
 
 
    static void SetScalarValueToZero(const CCVector3& P,
                                     ScalarType& scalarValue);
 
    static void SetScalarValueInverted(const CCVector3& P,
                                       ScalarType& scalarValue);
 
protected:
 
    static bool computeMeanGradientOnPatch(
            const DgmOctree::octreeCell& cell,
            void** additionalParameters,
            NormalizedProgress* nProgress = nullptr);
 
 
    static bool computeCellGaussianFilter(
            const DgmOctree::octreeCell& cell,
            void** additionalParameters,
            NormalizedProgress* nProgress = nullptr);
};
 
}  // namespace cloudViewer