PointCloud.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
 
#include <Logging.h>
 
#include <initializer_list>
#include <string>
#include <unordered_map>
#include <unordered_set>
 
#include "cloudViewer/core/Tensor.h"
#include "cloudViewer/core/TensorCheck.h"
#include "cloudViewer/core/hashmap/HashMap.h"
#include "cloudViewer/geometry/PointCloud.h"
#include "cloudViewer/t/geometry/BoundingVolume.h"
#include "cloudViewer/t/geometry/DrawableGeometry.h"
#include "cloudViewer/t/geometry/Geometry.h"
#include "cloudViewer/t/geometry/Image.h"
#include "cloudViewer/t/geometry/RGBDImage.h"
#include "cloudViewer/t/geometry/TensorMap.h"
#include "cloudViewer/t/geometry/TriangleMesh.h"
 
namespace cloudViewer {
namespace t {
namespace geometry {
 
class LineSet;
 
class PointCloud : public Geometry, public DrawableGeometry {
public:
    PointCloud(const core::Device &device = core::Device("CPU:0"));
 
    PointCloud(const core::Tensor &points);
 
    PointCloud(const std::unordered_map<std::string, core::Tensor>
                       &map_keys_to_tensors);
 
    virtual ~PointCloud() override {}
 
    std::string ToString() const;
 
    const TensorMap &GetPointAttr() const { return point_attr_; }
 
    TensorMap &GetPointAttr() { return point_attr_; }
 
    core::Tensor &GetPointAttr(const std::string &key) {
        return point_attr_.at(key);
    }
 
    core::Tensor &GetPointPositions() { return GetPointAttr("positions"); }
 
    core::Tensor &GetPointColors() { return GetPointAttr("colors"); }
 
    core::Tensor &GetPointNormals() { return GetPointAttr("normals"); }
 
    const core::Tensor &GetPointAttr(const std::string &key) const {
        return point_attr_.at(key);
    }
 
    const core::Tensor &GetPointPositions() const {
        return GetPointAttr("positions");
    }
 
    // ---------------------------------------------------------------------
    // Backward-compatibility helpers for pre-v0.19 API
    // ---------------------------------------------------------------------
    core::Tensor &GetPoints() { return GetPointPositions(); }
 
    const core::Tensor &GetPoints() const { return GetPointPositions(); }
 
    void SetPoints(const core::Tensor &value) { SetPointPositions(value); }
 
    bool HasPoints() const { return HasPointPositions(); }
 
    const core::Tensor &GetPointColors() const {
        return GetPointAttr("colors");
    }
 
    const core::Tensor &GetPointNormals() const {
        return GetPointAttr("normals");
    }
 
    void SetPointAttr(const std::string &key, const core::Tensor &value) {
        if (value.GetDevice() != device_) {
            utility::LogError("Attribute device {} != Pointcloud's device {}.",
                              value.GetDevice().ToString(), device_.ToString());
        }
        point_attr_[key] = value;
    }
 
    void SetPointPositions(const core::Tensor &value) {
        core::AssertTensorShape(value, {utility::nullopt, 3});
        SetPointAttr("positions", value);
    }
 
    void SetPointColors(const core::Tensor &value) {
        core::AssertTensorShape(value, {utility::nullopt, 3});
        SetPointAttr("colors", value);
    }
 
    void SetPointNormals(const core::Tensor &value) {
        core::AssertTensorShape(value, {utility::nullopt, 3});
        SetPointAttr("normals", value);
    }
 
    bool HasPointAttr(const std::string &key) const {
        return point_attr_.Contains(key) && GetPointAttr(key).GetLength() > 0 &&
               GetPointAttr(key).GetLength() == GetPointPositions().GetLength();
    }
 
    void RemovePointAttr(const std::string &key) { point_attr_.Erase(key); }
 
    bool HasPointPositions() const { return HasPointAttr("positions"); }
 
    bool HasPointColors() const { return HasPointAttr("colors"); }
 
    bool HasPointNormals() const { return HasPointAttr("normals"); }
 
public:
    PointCloud To(const core::Device &device, bool copy = false) const;
 
    PointCloud CPU() const { return To(core::Device("CPU:0"), false); }
 
    PointCloud Clone() const;
 
    PointCloud &Clear() override {
        point_attr_.clear();
        return *this;
    }
 
    bool IsEmpty() const override { return !HasPointPositions(); }
 
    core::Tensor GetMinBound() const;
 
    core::Tensor GetMaxBound() const;
 
    core::Tensor GetCenter() const;
 
    PointCloud Append(const PointCloud &other) const;
 
    PointCloud operator+(const PointCloud &other) const {
        return Append(other);
    }
 
    PointCloud &Transform(const core::Tensor &transformation);
 
    PointCloud &Translate(const core::Tensor &translation,
                          bool relative = true);
 
    PointCloud &Scale(double scale, const core::Tensor &center);
 
    PointCloud &Rotate(const core::Tensor &R, const core::Tensor &center);
 
    PointCloud &PaintUniformColor(const core::Tensor &color);
 
    PointCloud SelectByMask(const core::Tensor &boolean_mask,
                            bool invert = false) const;
 
    PointCloud SelectByIndex(const core::Tensor &indices,
                             bool invert = false,
                             bool remove_duplicates = false) const;
 
    PointCloud VoxelDownSample(double voxel_size,
                               const std::string &reduction = "mean") const;
 
    PointCloud UniformDownSample(size_t every_k_points) const;
 
    PointCloud RandomDownSample(double sampling_ratio) const;
 
    PointCloud FarthestPointDownSample(const size_t num_samples,
                                       const size_t start_index = 0) const;
 
    std::tuple<PointCloud, core::Tensor> RemoveRadiusOutliers(
            size_t nb_points, double search_radius) const;
 
    std::tuple<PointCloud, core::Tensor> RemoveStatisticalOutliers(
            size_t nb_neighbors, double std_ratio) const;
 
    std::tuple<PointCloud, core::Tensor> RemoveDuplicatedPoints() const;
 
    std::tuple<PointCloud, core::Tensor> RemoveNonFinitePoints(
            bool remove_nan = true, bool remove_infinite = true) const;
 
    core::Device GetDevice() const override { return device_; }
 
    std::tuple<TriangleMesh, core::Tensor> HiddenPointRemoval(
            const core::Tensor &camera_location, double radius) const;
 
    core::Tensor ClusterDBSCAN(double eps,
                               size_t min_points,
                               bool print_progress = false) const;
 
    std::tuple<core::Tensor, core::Tensor> SegmentPlane(
            const double distance_threshold = 0.01,
            const int ransac_n = 3,
            const int num_iterations = 100,
            const double probability = 0.99999999) const;
 
    TriangleMesh ComputeConvexHull(bool joggle_inputs = false) const;
 
    std::tuple<PointCloud, core::Tensor> ComputeBoundaryPoints(
            double radius,
            int max_nn = 30,
            double angle_threshold = 90.0) const;
 
public:
    PointCloud &NormalizeNormals();
 
    void EstimateNormals(
            const utility::optional<int> max_nn = 30,
            const utility::optional<double> radius = utility::nullopt);
 
    void OrientNormalsToAlignWithDirection(
            const core::Tensor &orientation_reference =
                    core::Tensor::Init<float>({0, 0, 1},
                                              core::Device("CPU:0")));
 
    void OrientNormalsTowardsCameraLocation(
            const core::Tensor &camera_location = core::Tensor::Zeros(
                    {3}, core::Float32, core::Device("CPU:0")));
 
    void OrientNormalsConsistentTangentPlane(size_t k,
                                             const double lambda = 0.0,
                                             const double cos_alpha_tol = 1.0);
 
    void EstimateColorGradients(
            const utility::optional<int> max_nn = 30,
            const utility::optional<double> radius = utility::nullopt);
 
public:
    static PointCloud CreateFromDepthImage(
            const Image &depth,
            const core::Tensor &intrinsics,
            const core::Tensor &extrinsics =
                    core::Tensor::Eye(4, core::Float32, core::Device("CPU:0")),
            float depth_scale = 1000.0f,
            float depth_max = 3.0f,
            int stride = 1,
            bool with_normals = false);
 
    static PointCloud CreateFromRGBDImage(
            const RGBDImage &rgbd_image,
            const core::Tensor &intrinsics,
            const core::Tensor &extrinsics =
                    core::Tensor::Eye(4, core::Float32, core::Device("CPU:0")),
            float depth_scale = 1000.0f,
            float depth_max = 3.0f,
            int stride = 1,
            bool with_normals = false);
 
    static PointCloud FromLegacy(
            const cloudViewer::geometry::PointCloud &pcd_legacy,
            core::Dtype dtype = core::Float32,
            const core::Device &device = core::Device("CPU:0"));
 
    cloudViewer::geometry::PointCloud ToLegacy() const;
 
    geometry::Image ProjectToDepthImage(
            int width,
            int height,
            const core::Tensor &intrinsics,
            const core::Tensor &extrinsics =
                    core::Tensor::Eye(4, core::Float32, core::Device("CPU:0")),
            float depth_scale = 1000.0f,
            float depth_max = 3.0f);
 
    geometry::RGBDImage ProjectToRGBDImage(
            int width,
            int height,
            const core::Tensor &intrinsics,
            const core::Tensor &extrinsics =
                    core::Tensor::Eye(4, core::Float32, core::Device("CPU:0")),
            float depth_scale = 1000.0f,
            float depth_max = 3.0f);
 
    AxisAlignedBoundingBox GetAxisAlignedBoundingBox() const;
 
    OrientedBoundingBox GetOrientedBoundingBox() const;
 
    PointCloud Crop(const AxisAlignedBoundingBox &aabb,
                    bool invert = false) const;
 
    PointCloud Crop(const OrientedBoundingBox &obb, bool invert = false) const;
 
    LineSet ExtrudeRotation(double angle,
                            const core::Tensor &axis,
                            int resolution = 16,
                            double translation = 0.0,
                            bool capping = true) const;
 
    LineSet ExtrudeLinear(const core::Tensor &vector,
                          double scale = 1.0,
                          bool capping = true) const;
 
    int PCAPartition(int max_points);
 
 
 
    core::Tensor ComputeMetrics(
            const PointCloud &pcd2,
            std::vector<Metric> metrics = {Metric::ChamferDistance},
            MetricParameters params = MetricParameters()) const;
 
    bool IsGaussianSplat() const;
 
    int GaussianSplatGetSHOrder() const;
 
protected:
    core::Device device_ = core::Device("CPU:0");
    TensorMap point_attr_;
};
 
}  // namespace geometry
}  // namespace t
}  // namespace cloudViewer