1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260
|
// ----------------------------------------------------------------------------
// - Open3D: www.open3d.org -
// ----------------------------------------------------------------------------
// Copyright (c) 2018-2024 www.open3d.org
// SPDX-License-Identifier: MIT
// ----------------------------------------------------------------------------
#include "open3d/geometry/VoxelGrid.h"
#include <sstream>
#include "open3d/camera/PinholeCameraParameters.h"
#include "open3d/geometry/Image.h"
#include "open3d/geometry/Octree.h"
#include "open3d/geometry/PointCloud.h"
#include "pybind/docstring.h"
#include "pybind/geometry/geometry.h"
#include "pybind/geometry/geometry_trampoline.h"
namespace open3d {
namespace geometry {
void pybind_voxelgrid_declarations(py::module &m) {
py::class_<Voxel, std::shared_ptr<Voxel>> voxel(
m, "Voxel", "Base Voxel class, containing grid id and color");
py::class_<VoxelGrid, PyGeometry3D<VoxelGrid>, std::shared_ptr<VoxelGrid>,
Geometry3D>
voxelgrid(m, "VoxelGrid",
"VoxelGrid is a collection of voxels which are aligned "
"in grid.");
}
void pybind_voxelgrid_definitions(py::module &m) {
auto voxel = static_cast<py::class_<Voxel, std::shared_ptr<Voxel>>>(
m.attr("Voxel"));
py::detail::bind_default_constructor<Voxel>(voxel);
py::detail::bind_copy_functions<Voxel>(voxel);
voxel.def("__repr__",
[](const Voxel &voxel) {
std::ostringstream repr;
repr << "Voxel with grid_index: (" << voxel.grid_index_(0)
<< ", " << voxel.grid_index_(1) << ", "
<< voxel.grid_index_(2) << "), color: ("
<< voxel.color_(0) << ", " << voxel.color_(1) << ", "
<< voxel.color_(2) << ")";
return repr.str();
})
.def(py::init([](const Eigen::Vector3i &grid_index) {
return new Voxel(grid_index);
}),
"grid_index"_a)
.def(py::init([](const Eigen::Vector3i &grid_index,
const Eigen::Vector3d &color) {
return new Voxel(grid_index, color);
}),
"grid_index"_a, "color"_a)
.def_readwrite("grid_index", &Voxel::grid_index_,
"Int numpy array of shape (3,): Grid coordinate "
"index of the voxel.")
.def_readwrite(
"color", &Voxel::color_,
"Float64 numpy array of shape (3,): Color of the voxel.");
auto voxelgrid =
static_cast<py::class_<VoxelGrid, PyGeometry3D<VoxelGrid>,
std::shared_ptr<VoxelGrid>, Geometry3D>>(
m.attr("VoxelGrid"));
py::enum_<VoxelGrid::VoxelPoolingMode> pooling_mode(
voxelgrid, "VoxelPoolingMode",
"Mode of determining color for each voxel.");
pooling_mode.value("AVG", VoxelGrid::VoxelPoolingMode::AVG)
.value("MIN", VoxelGrid::VoxelPoolingMode::MIN)
.value("MAX", VoxelGrid::VoxelPoolingMode::MAX)
.value("SUM", VoxelGrid::VoxelPoolingMode::SUM);
py::detail::bind_default_constructor<VoxelGrid>(voxelgrid);
py::detail::bind_copy_functions<VoxelGrid>(voxelgrid);
voxelgrid
.def("__repr__",
[](const VoxelGrid &voxelgrid) {
return std::string("VoxelGrid with ") +
std::to_string(voxelgrid.voxels_.size()) +
" voxels.";
})
.def(py::self + py::self)
.def(py::self += py::self)
.def("get_voxels", &VoxelGrid::GetVoxels,
"Returns List of ``Voxel``: Voxels contained in voxel grid. "
"Changes to the voxels returned from this method"
"are not reflected in the voxel grid.")
.def("has_colors", &VoxelGrid::HasColors,
"Returns ``True`` if the voxel grid contains voxel colors.")
.def("has_voxels", &VoxelGrid::HasVoxels,
"Returns ``True`` if the voxel grid contains voxels.")
.def("get_voxel", &VoxelGrid::GetVoxel, "point"_a,
"Returns voxel index given query point.")
.def("add_voxel", &VoxelGrid::AddVoxel, "voxel"_a,
"Add a new voxel into the VoxelGrid.")
.def("remove_voxel", &VoxelGrid::RemoveVoxel, "idx"_a,
"Remove a voxel given index.")
.def("check_if_included", &VoxelGrid::CheckIfIncluded, "queries"_a,
"Element-wise check if a query in the list is included in "
"the VoxelGrid. Queries are double precision and "
"are mapped to the closest voxel.")
.def("carve_depth_map", &VoxelGrid::CarveDepthMap, "depth_map"_a,
"camera_params"_a, "keep_voxels_outside_image"_a = false,
"Remove all voxels from the VoxelGrid where none of the "
"boundary points of the voxel projects to depth value that is "
"smaller, or equal than the projected depth of the boundary "
"point. If keep_voxels_outside_image is true then voxels are "
"only carved if all boundary points project to a valid image "
"location.")
.def("carve_silhouette", &VoxelGrid::CarveSilhouette,
"silhouette_mask"_a, "camera_params"_a,
"keep_voxels_outside_image"_a = false,
"Remove all voxels from the VoxelGrid where none of the "
"boundary points of the voxel projects to a valid mask pixel "
"(pixel value > 0). If keep_voxels_outside_image is true then "
"voxels are only carved if all boundary points project to a "
"valid image location.")
.def("to_octree", &VoxelGrid::ToOctree, "max_depth"_a,
"Convert to Octree.")
.def("create_from_octree", &VoxelGrid::CreateFromOctree, "octree"_a,
"Convert from Octree.")
.def("get_voxel_center_coordinate",
&VoxelGrid::GetVoxelCenterCoordinate, "idx"_a,
"Returns the center coordinate of a voxel given its grid "
"index.")
.def("get_voxel_bounding_points",
&VoxelGrid::GetVoxelBoundingPoints, "index"_a,
"Returns the 8 bounding points of a voxel given its grid "
"index.")
.def_static("create_dense", &VoxelGrid::CreateDense,
"Creates a voxel grid where every voxel is set (hence "
"dense). This is a useful starting point for voxel "
"carving",
"origin"_a, "color"_a, "voxel_size"_a, "width"_a,
"height"_a, "depth"_a)
.def_static("create_from_point_cloud",
&VoxelGrid::CreateFromPointCloud,
"Creates a VoxelGrid from a given PointCloud. The "
"color value of a given voxel is determined by the "
"VoxelPoolingMode, e.g. by default the average color "
"value of the points that fall into it (if the "
"PointCloud has colors). The bounds of the created "
"VoxelGrid are computed from the PointCloud.",
"input"_a, "voxel_size"_a,
"pooling_mode"_a = VoxelGrid::VoxelPoolingMode::AVG)
.def_static("create_from_point_cloud_within_bounds",
&VoxelGrid::CreateFromPointCloudWithinBounds,
"Creates a VoxelGrid from a given PointCloud. The "
"color value of a given voxel is determined by the "
"VoxelPoolingMode, e.g. by default the average color "
"value of the points that fall into it (if the "
"PointCloud has colors). The bounds of the created "
"VoxelGrid are defined by the given parameters.",
"input"_a, "voxel_size"_a, "min_bound"_a, "max_bound"_a,
"pooling_mode"_a = VoxelGrid::VoxelPoolingMode::AVG)
.def_static("create_from_triangle_mesh",
&VoxelGrid::CreateFromTriangleMesh,
"Creates a VoxelGrid from a given TriangleMesh. No "
"color information is converted. The bounds of the "
"created VoxelGrid are computed from the "
"TriangleMesh.",
"input"_a, "voxel_size"_a)
.def_static(
"create_from_triangle_mesh_within_bounds",
&VoxelGrid::CreateFromTriangleMeshWithinBounds,
"Creates a VoxelGrid from a given TriangleMesh. No color "
"information is converted. The bounds "
"of the created VoxelGrid are defined by the given "
"parameters",
"input"_a, "voxel_size"_a, "min_bound"_a, "max_bound"_a)
.def_readwrite("origin", &VoxelGrid::origin_,
"``float64`` vector of length 3: Coordinate of the "
"origin point.")
.def_readwrite("voxel_size", &VoxelGrid::voxel_size_,
"``float64`` Size of the voxel.");
docstring::ClassMethodDocInject(m, "VoxelGrid", "has_colors");
docstring::ClassMethodDocInject(m, "VoxelGrid", "has_voxels");
docstring::ClassMethodDocInject(m, "VoxelGrid", "get_voxel",
{{"point", "The query point."}});
docstring::ClassMethodDocInject(m, "VoxelGrid", "add_voxel",
{{"Voxel", "A new voxel."}});
docstring::ClassMethodDocInject(
m, "VoxelGrid", "remove_voxel",
{{"idx", "The grid index of the target voxel."}});
docstring::ClassMethodDocInject(
m, "VoxelGrid", "check_if_included",
{{"query", "a list of voxel indices to check."}});
docstring::ClassMethodDocInject(
m, "VoxelGrid", "carve_depth_map",
{{"depth_map", "Depth map (Image) used for VoxelGrid carving."},
{"camera_parameters",
"PinholeCameraParameters used to record the given depth_map."},
{"keep_voxels_outside_image",
"retain voxels that don't project"
" to pixels in the image"}});
docstring::ClassMethodDocInject(
m, "VoxelGrid", "carve_silhouette",
{{"silhouette_mask",
"Silhouette mask (Image) used for VoxelGrid carving."},
{"camera_parameters",
"PinholeCameraParameters used to record the given depth_map."},
{"keep_voxels_outside_image",
"retain voxels that don't project"
" to pixels in the image"}});
docstring::ClassMethodDocInject(
m, "VoxelGrid", "to_octree",
{{"max_depth", "int: Maximum depth of the octree."}});
docstring::ClassMethodDocInject(
m, "VoxelGrid", "create_from_octree",
{{"octree", "geometry.Octree: The source octree."}});
docstring::ClassMethodDocInject(
m, "VoxelGrid", "get_voxel_center_coordinate",
{{"idx", "The grid index of the query voxel."}});
docstring::ClassMethodDocInject(
m, "VoxelGrid", "get_voxel_bounding_points",
{{"index", "The grid index of the query voxel."}});
docstring::ClassMethodDocInject(
m, "VoxelGrid", "create_dense",
{{"origin", "Coordinate center of the VoxelGrid"},
{"color", "Voxel color for all voxels if the VoxelGrid."},
{"voxel_size", "Voxel size of of the VoxelGrid construction."},
{"width", "Spatial width extend of the VoxelGrid."},
{"height", "Spatial height extend of the VoxelGrid."},
{"depth", "Spatial depth extend of the VoxelGrid."}});
docstring::ClassMethodDocInject(
m, "VoxelGrid", "create_from_point_cloud",
{{"input", "The input PointCloud"},
{"voxel_size", "Voxel size of of the VoxelGrid construction."},
{"pooling_mode",
"VoxelPoolingMode for determining voxel color."}});
docstring::ClassMethodDocInject(
m, "VoxelGrid", "create_from_point_cloud_within_bounds",
{{"input", "The input PointCloud"},
{"voxel_size", "Voxel size of of the VoxelGrid construction."},
{"min_bound",
"Minimum boundary point for the VoxelGrid to create."},
{"max_bound",
"Maximum boundary point for the VoxelGrid to create."},
{"pooling_mode",
"VoxelPoolingMode that determines how to compute the voxel "
"color."}});
docstring::ClassMethodDocInject(
m, "VoxelGrid", "create_from_triangle_mesh",
{{"input", "The input TriangleMesh"},
{"voxel_size", "Voxel size of of the VoxelGrid construction."}});
docstring::ClassMethodDocInject(
m, "VoxelGrid", "create_from_triangle_mesh_within_bounds",
{{"input", "The input TriangleMesh"},
{"voxel_size", "Voxel size of of the VoxelGrid construction."},
{"min_bound",
"Minimum boundary point for the VoxelGrid to create."},
{"max_bound",
"Maximum boundary point for the VoxelGrid to create."}});
}
} // namespace geometry
} // namespace open3d
|