TSDFVoxelGrid.h

Go to the documentation of this file.

// ----------------------------------------------------------------------------
// -                        Open3D: www.open3d.org                            -
// ----------------------------------------------------------------------------
// The MIT License (MIT)
//
// Copyright (c) 2018-2021 www.open3d.org
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
// IN THE SOFTWARE.
// ----------------------------------------------------------------------------

#pragma once

#include <string>
#include <unordered_map>
#include <unordered_set>

#include "open3d/core/Tensor.h"
#include "open3d/core/hashmap/HashMap.h"
#include "open3d/t/geometry/Geometry.h"
#include "open3d/t/geometry/Image.h"
#include "open3d/t/geometry/PointCloud.h"
#include "open3d/t/geometry/TensorMap.h"
#include "open3d/t/geometry/TriangleMesh.h"

namespace open3d {
namespace t {

namespace io {
class TSDFVoxelGridMetadata;
}

namespace geometry {

class TSDFVoxelGrid {
public:
    TSDFVoxelGrid(std::unordered_map<std::string, core::Dtype> attr_dtype_map =
                          {{"tsdf", core::Float32},
                           {"weight", core::UInt16},
                           {"color", core::UInt16}},
                  float voxel_size = 3.0 / 512.0, /* in meter */
                  float sdf_trunc = 0.04,         /* in meter */
                  int64_t block_resolution = 16,  /* block Tensor resolution */
                  int64_t block_count = 1000,
                  const core::Device &device = core::Device("CPU:0"),
                  const core::HashBackendType &backend =
                          core::HashBackendType::Default);

    ~TSDFVoxelGrid(){};

    void Integrate(const Image &depth,
                   const core::Tensor &intrinsics,
                   const core::Tensor &extrinsics,
                   float depth_scale = 1000.0f,
                   float depth_max = 3.0f);

    void Integrate(const Image &depth,
                   const Image &color,
                   const core::Tensor &intrinsics,
                   const core::Tensor &extrinsics,
                   float depth_scale = 1000.0f,
                   float depth_max = 3.0f);

    enum SurfaceMaskCode {
        None = 0,
        VertexMap = (1 << 0),
        DepthMap = (1 << 1),
        ColorMap = (1 << 2),
        NormalMap = (1 << 3),
        RangeMap = (1 << 4)
    };
    std::unordered_map<SurfaceMaskCode, core::Tensor> RayCast(
            const core::Tensor &intrinsics,
            const core::Tensor &extrinsics,
            int width,
            int height,
            float depth_scale = 1000.0f,
            float depth_min = 0.1f,
            float depth_max = 3.0f,
            float weight_threshold = 3.0f,
            int ray_cast_mask = SurfaceMaskCode::DepthMap |
                                SurfaceMaskCode::ColorMap);

    PointCloud ExtractSurfacePoints(
            int estimate_number = -1,
            float weight_threshold = 3.0f,
            int surface_mask = SurfaceMaskCode::VertexMap |
                               SurfaceMaskCode::ColorMap);

    TriangleMesh ExtractSurfaceMesh(
            int estimate_vertices = -1,
            float weight_threshold = 3.0f,
            int surface_mask = SurfaceMaskCode::VertexMap |
                               SurfaceMaskCode::NormalMap |
                               SurfaceMaskCode::ColorMap);

    TSDFVoxelGrid To(const core::Device &device, bool copy = false) const;

    TSDFVoxelGrid Clone() const { return To(GetDevice(), true); }

    float GetVoxelSize() const { return voxel_size_; }

    float GetSDFTrunc() const { return sdf_trunc_; }

    int64_t GetBlockResolution() const { return block_resolution_; }

    int64_t GetBlockCount() const { return block_count_; }

    std::unordered_map<std::string, core::Dtype> GetAttrDtypeMap() const {
        return attr_dtype_map_;
    }

    core::Device GetDevice() const { return device_; }

    std::shared_ptr<core::HashMap> GetBlockHashMap() { return block_hashmap_; }

    std::shared_ptr<core::HashMap> GetBlockHashMap() const {
        return block_hashmap_;
    }

private:
    float voxel_size_;

    float sdf_trunc_;

    int64_t block_resolution_;

    int64_t block_count_;

    std::unordered_map<std::string, core::Dtype> attr_dtype_map_;

    core::Device device_ = core::Device("CPU:0");

    std::pair<core::Tensor, core::Tensor> BufferRadiusNeighbors(
            const core::Tensor &active_buf_indices);

    // Global hashmap
    std::shared_ptr<core::HashMap> block_hashmap_;

    // Local hashmap for the `unique` operation of input points
    std::shared_ptr<core::HashMap> point_hashmap_;

    core::Tensor active_block_coords_;
};
}  // namespace geometry
}  // namespace t
}  // namespace open3d