ConvertPointCloud.cpp

Go to the documentation of this file.

// ----------------------------------------------------------------------------
// -                        CloudViewer: www.cloudViewer.org                  -
// ----------------------------------------------------------------------------
// Copyright (c) 2018-2024 www.cloudViewer.org
// SPDX-License-Identifier: MIT
// ----------------------------------------------------------------------------
 
#include <limits>
 
#include "CloudViewer.h"
 
void PrintHelp() {
    using namespace cloudViewer;
    PrintCloudViewerVersion();
    // clang-format off
    utility::LogInfo("Usage:");
    utility::LogInfo("    > ConvertPointCloud source_file target_file [options]");
    utility::LogInfo("    > ConvertPointCloud source_directory target_directory [options]");
    utility::LogInfo("      Read point cloud from source file and convert it to target file.");
    utility::LogInfo("");
    utility::LogInfo("Options (listed in the order of execution priority):");
    utility::LogInfo("    --help, -h                : Print help information.");
    utility::LogInfo("    --verbose n               : Set verbose level (0-4).");
    utility::LogInfo("    --clip_x_min x0           : Clip points with x coordinate < x0.");
    utility::LogInfo("    --clip_x_max x1           : Clip points with x coordinate > x1.");
    utility::LogInfo("    --clip_y_min y0           : Clip points with y coordinate < y0.");
    utility::LogInfo("    --clip_y_max y1           : Clip points with y coordinate > y1.");
    utility::LogInfo("    --clip_z_min z0           : Clip points with z coordinate < z0.");
    utility::LogInfo("    --clip_z_max z1           : Clip points with z coordinate > z1.");
    utility::LogInfo("    --filter_mahalanobis d    : Filter out points with Mahalanobis distance > d.");
    utility::LogInfo("    --uniform_sample_every K  : Downsample the point cloud uniformly. Keep only");
    utility::LogInfo("                              : one point for every K points.");
    utility::LogInfo("    --voxel_sample voxel_size : Downsample the point cloud with a voxel.");
    utility::LogInfo("    --estimate_normals radius : Estimate normals using a search neighborhood of");
    utility::LogInfo("                                radius. The normals are oriented w.r.t. the");
    utility::LogInfo("                                original normals of the pointcloud if they");
    utility::LogInfo("                                exist. Otherwise, they are oriented towards -Z");
    utility::LogInfo("                                direction.");
    utility::LogInfo("    --estimate_normals_knn k  : Estimate normals using a search with k nearest");
    utility::LogInfo("                                neighbors. The normals are oriented w.r.t. the");
    utility::LogInfo("                                original normals of the pointcloud if they");
    utility::LogInfo("                                exist. Otherwise, they are oriented towards -Z");
    utility::LogInfo("                                direction.");
    utility::LogInfo("    --orient_normals [x,y,z]  : Orient the normals w.r.t the direction [x,y,z].");
    utility::LogInfo("    --camera_location [x,y,z] : Orient the normals w.r.t camera location [x,y,z].");
    // clang-format on
}
 
void convert(int argc,
             char **argv,
             const std::string &file_in,
             const std::string &file_out) {
    using namespace cloudViewer;
    using namespace cloudViewer::utility::filesystem;
    auto pointcloud_ptr =
            cloudViewer::io::CreatePointCloudFromFile(file_in.c_str());
    if (!pointcloud_ptr) {
        utility::LogError("Failed to create point cloud from {}.", file_in);
    }
    size_t point_num_in = pointcloud_ptr->size();
    bool processed = false;
 
    // clip
    if (utility::ProgramOptionExistsAny(
                argc, argv,
                {"--clip_x_min", "--clip_x_max", "--clip_y_min", "--clip_y_max",
                 "--clip_z_min", "--clip_z_max"})) {
        Eigen::Vector3d min_bound, max_bound;
        min_bound(0) = utility::GetProgramOptionAsDouble(
                argc, argv, "--clip_x_min",
                std::numeric_limits<double>::lowest());
        min_bound(1) = utility::GetProgramOptionAsDouble(
                argc, argv, "--clip_y_min",
                std::numeric_limits<double>::lowest());
        min_bound(2) = utility::GetProgramOptionAsDouble(
                argc, argv, "--clip_z_min",
                std::numeric_limits<double>::lowest());
        max_bound(0) = utility::GetProgramOptionAsDouble(
                argc, argv, "--clip_x_max", std::numeric_limits<double>::max());
        max_bound(1) = utility::GetProgramOptionAsDouble(
                argc, argv, "--clip_y_max", std::numeric_limits<double>::max());
        max_bound(2) = utility::GetProgramOptionAsDouble(
                argc, argv, "--clip_z_max", std::numeric_limits<double>::max());
        pointcloud_ptr = pointcloud_ptr->Crop(ccBBox(min_bound, max_bound));
        processed = true;
    }
 
    // filter_mahalanobis
    double mahalanobis_threshold = utility::GetProgramOptionAsDouble(
            argc, argv, "--filter_mahalanobis", 0.0);
    if (mahalanobis_threshold > 0.0) {
        auto mahalanobis = pointcloud_ptr->ComputeMahalanobisDistance();
        std::vector<size_t> indices;
        for (size_t i = 0; i < pointcloud_ptr->size(); i++) {
            if (mahalanobis[i] < mahalanobis_threshold) {
                indices.push_back(i);
            }
        }
        auto pcd = pointcloud_ptr->SelectByIndex(indices);
        utility::LogDebug(
                "Based on Mahalanobis distance, {:d} points were filtered.",
                (int)(pointcloud_ptr->size() - pcd->size()));
        pointcloud_ptr = pcd;
    }
 
    // uniform_downsample
    int every_k = utility::GetProgramOptionAsInt(argc, argv,
                                                 "--uniform_sample_every", 0);
    if (every_k > 1) {
        utility::LogDebug("Downsample point cloud uniformly every {:d} points.",
                          every_k);
        pointcloud_ptr = pointcloud_ptr->UniformDownSample(every_k);
        processed = true;
    }
 
    // voxel_downsample
    double voxel_size = utility::GetProgramOptionAsDouble(
            argc, argv, "--voxel_sample", 0.0);
    if (voxel_size > 0.0) {
        utility::LogDebug("Downsample point cloud with voxel size {:.4f}.",
                          voxel_size);
        pointcloud_ptr = pointcloud_ptr->VoxelDownSample(voxel_size);
        processed = true;
    }
 
    // estimate_normals
    double radius = utility::GetProgramOptionAsDouble(
            argc, argv, "--estimate_normals", 0.0);
    if (radius > 0.0) {
        utility::LogDebug("Estimate normals with search radius {:.4f}.",
                          radius);
        pointcloud_ptr->EstimateNormals(
                geometry::KDTreeSearchParamRadius(radius));
        processed = true;
    }
 
    int k = utility::GetProgramOptionAsInt(argc, argv, "--estimate_normals_knn",
                                           0);
    if (k > 0) {
        utility::LogDebug("Estimate normals with search knn {:d}.", k);
        pointcloud_ptr->EstimateNormals(geometry::KDTreeSearchParamKNN(k));
        processed = true;
    }
 
    // orient_normals
    Eigen::VectorXd direction = utility::GetProgramOptionAsEigenVectorXd(
            argc, argv, "--orient_normals");
    if (direction.size() == 3 && pointcloud_ptr->hasNormals()) {
        utility::LogDebug("Orient normals to [%.2f, %.2f, %.2f].", direction(0),
                          direction(1), direction(2));
        Eigen::Vector3d dir(direction);
        pointcloud_ptr->OrientNormalsToAlignWithDirection(dir);
        processed = true;
    }
    Eigen::VectorXd camera_loc = utility::GetProgramOptionAsEigenVectorXd(
            argc, argv, "--camera_location");
    if (camera_loc.size() == 3 && pointcloud_ptr->hasNormals()) {
        utility::LogDebug("Orient normals towards [%.2f, %.2f, %.2f].",
                          camera_loc(0), camera_loc(1), camera_loc(2));
        Eigen::Vector3d loc(camera_loc);
        pointcloud_ptr->OrientNormalsTowardsCameraLocation(loc);
        processed = true;
    }
 
    size_t point_num_out = pointcloud_ptr->size();
    if (processed) {
        utility::LogInfo(
                "Processed point cloud from {:d} points to {:d} points.",
                (int)point_num_in, (int)point_num_out);
    }
    io::WritePointCloud(file_out.c_str(), *pointcloud_ptr, {false, true});
}
 
int main(int argc, char **argv) {
    using namespace cloudViewer;
    using namespace cloudViewer::utility::filesystem;
 
    if (argc < 3 || utility::ProgramOptionExists(argc, argv, "--help") ||
        utility::ProgramOptionExists(argc, argv, "-h")) {
        PrintHelp();
        return 0;
    }
 
    int verbose = utility::GetProgramOptionAsInt(argc, argv, "--verbose", 2);
    utility::SetVerbosityLevel((utility::VerbosityLevel)verbose);
 
    if (FileExists(argv[1])) {
        convert(argc, argv, argv[1], argv[2]);
    } else if (DirectoryExists(argv[1])) {
        MakeDirectoryHierarchy(argv[2]);
        std::vector<std::string> filenames;
        ListFilesInDirectory(argv[1], filenames);
        for (const auto &fn : filenames) {
            convert(argc, argv, fn,
                    GetRegularizedDirectoryName(argv[2]) +
                            GetFileNameWithoutDirectory(fn));
        }
    } else {
        utility::LogWarning("File or directory does not exist.");
        return 1;
    }
 
    return 0;
}