Skip to content

Commit f1a0f3e

Browse files
Improve Documentation - Fix code links and improve tutorial layout (#6321)
* Correct code tagging in interactive_visualization tutorial. * Highlight the methods that are being introduced at the start. * Non-Blocking VIZ - Add add_geometry step which is not optional. * Non-Blocking VIZ - Split main code to simpler function and fix code blocks in docs. * Fix Typos * Update docs with new argument values. * Fix grammar and dedent for overly indented code * Integrate_Custom - Optimize imports, add early return, use f-strings and remove unnecessary parentheses. * Fix default value and remove BooleanOptionalAction, its only available >= python 3.9 * Disable use of cuda for tensor based reconstruction * Customized Integration - Fix code lines * Ray Casting - Fix code lines * Dense Slam - Fix code lines and slight grammar. * Fix some f-strings and extra parantheses * Make Fragments - Fix code lines * Code for batch processing was removed long back in #521 in 2018 * Register Fragments - Fix code docs * Register fragments - Fix code lines * Integrate Scene - Fix code lines * Change layout of tutorials - only done at top level. * Add new lines before bullet/numbered list, else list rendering fails. * Bugfix - Fix code lines for Integration and add filename as done in v0.14.0 * Remove python version 3.6 as supported versions by open3d. * Fix line number using lineno-match directive. * Fix some typos detected automatically. * Replace prepend with lineno-match * Correct filename documented in the files * Fix lineno-start. * Fix PR comments * Revert "Code for batch processing was removed long back in #521 in 2018" This reverts commit d65fb67. * Correct batch processing section documentation and native multiprocessing. * Use native multiprocessing for register fragments and refinement of registration --------- Co-authored-by: Sameer Sheorey <[email protected]>
1 parent b2f5cef commit f1a0f3e

40 files changed

+359
-310
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ For more, please visit the [Open3D documentation](http://www.open3d.org/docs).
4545
## Python quick start
4646

4747
Pre-built pip packages support Ubuntu 18.04+, macOS 10.15+ and Windows 10+
48-
(64-bit) with Python 3.6-3.10.
48+
(64-bit) with Python 3.7-3.10.
4949

5050
```bash
5151
# Install

cpp/open3d/core/AdvancedIndexing.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -206,7 +206,7 @@ void AdvancedIndexPreprocessor::RunPreprocess() {
206206
// If the indexed_shape_ contains a dimension of size 0 but the
207207
// replacement shape does not, the index is out of bounds. This is because
208208
// there is no valid number to index an empty tensor.
209-
// Normally, out of bounds is detected in the advanded indexing kernel. We
209+
// Normally, out of bounds is detected in the advanced indexing kernel. We
210210
// detected here for more helpful error message.
211211
auto contains_zero = [](const SizeVector& vals) -> bool {
212212
return std::any_of(vals.begin(), vals.end(),

cpp/open3d/core/AdvancedIndexing.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ class AdvancedIndexPreprocessor {
4949
const Tensor& tensor, const std::vector<Tensor>& index_tensors);
5050

5151
/// Expand all tensors to the broadcasted shape, 0-dim tensors are ignored.
52-
/// Thorws exception if the common broadcasted shape does not exist.
52+
/// Throws exception if the common broadcasted shape does not exist.
5353
static std::pair<std::vector<Tensor>, SizeVector>
5454
ExpandToCommonShapeExceptZeroDim(const std::vector<Tensor>& index_tensors);
5555

@@ -127,7 +127,7 @@ class AdvancedIndexer {
127127
if (indexed_shape.size() != indexed_strides.size()) {
128128
utility::LogError(
129129
"Internal error: indexed_shape's ndim {} does not equal to "
130-
"indexd_strides' ndim {}",
130+
"indexed_strides' ndim {}",
131131
indexed_shape.size(), indexed_strides.size());
132132
}
133133
num_indices_ = indexed_shape.size();

cpp/open3d/geometry/BoundingVolume.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ class AxisAlignedBoundingBox;
2121
/// \brief A bounding box oriented along an arbitrary frame of reference.
2222
///
2323
/// The oriented bounding box is defined by its center position, rotation
24-
/// maxtrix and extent.
24+
/// matrix and extent.
2525
class OrientedBoundingBox : public Geometry3D {
2626
public:
2727
/// \brief Default constructor.

cpp/open3d/geometry/VoxelGrid.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -245,7 +245,7 @@ class VoxelGrid : public Geometry3D {
245245
public:
246246
/// Size of the voxel.
247247
double voxel_size_ = 0.0;
248-
/// Coorindate of the origin point.
248+
/// Coordinate of the origin point.
249249
Eigen::Vector3d origin_ = Eigen::Vector3d::Zero();
250250
/// Voxels contained in voxel grid
251251
std::unordered_map<Eigen::Vector3i,

cpp/open3d/ml/impl/continuous_conv/ContinuousConvBackpropFilter.cuh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ namespace impl {
4545
/// \param texture_alignment The texture alignment in bytes. This is used
4646
/// for allocating segments within the temporary memory.
4747
///
48-
/// \param filter_backrop Output array for the computed filter gradient
48+
/// \param filter_backprop Output array for the computed filter gradient
4949
/// with shape [depth,height,width, inp channels, out channels]
5050
///
5151
/// \param filter_dims The sizes of the filter dimensions. The size of

cpp/open3d/ml/tensorflow/misc/BuildSpatialHashTableOps.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ The following example shows how **build_spatial_hash_table** and
7878
7979
radius = 1.0
8080
81-
# build the spatial hash table for fixex_radius_search
81+
# build the spatial hash table for fixed_radius_search
8282
table = ml3d.ops.build_spatial_hash_table(points,
8383
radius,
8484
points_row_splits=torch.LongTensor([0,5]),

cpp/open3d/t/geometry/BoundingVolume.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -318,7 +318,7 @@ OrientedBoundingBox::OrientedBoundingBox(const core::Tensor &center,
318318
utility::LogError(
319319
"Invalid oriented bounding box. Please make sure the values of "
320320
"extent are all positive and the rotation matrix is "
321-
"othogonal.");
321+
"orthogonal.");
322322
}
323323
}
324324

cpp/open3d/t/geometry/BoundingVolume.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ class AxisAlignedBoundingBox : public Geometry, public DrawableGeometry {
146146
const utility::optional<core::Tensor> &center = utility::nullopt);
147147

148148
/// \brief Add operation for axis-aligned bounding box.
149-
/// The device of ohter box must be the same as the device of the current
149+
/// The device of other box must be the same as the device of the current
150150
/// box.
151151
AxisAlignedBoundingBox &operator+=(const AxisAlignedBoundingBox &other);
152152

@@ -223,7 +223,7 @@ class AxisAlignedBoundingBox : public Geometry, public DrawableGeometry {
223223
/// \brief A bounding box oriented along an arbitrary frame of reference.
224224
///
225225
/// - (center, rotation, extent): The oriented bounding box is defined by its
226-
/// center position, rotation maxtrix and extent.
226+
/// center position, rotation matrix and extent.
227227
/// - Usage
228228
/// - OrientedBoundingBox::GetCenter()
229229
/// - OrientedBoundingBox::SetCenter(const core::Tensor &center)

cpp/open3d/visualization/gui/Window.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -707,7 +707,7 @@ Widget::DrawResult DrawChild(DrawContext& dc,
707707
const char* name,
708708
std::shared_ptr<Widget> child,
709709
Mode mode) {
710-
// Note: ImGUI's concept of a "window" is really a moveable child of the
710+
// Note: ImGUI's concept of a "window" is really a movable child of the
711711
// OS window. We want a child to act like a child of the OS window,
712712
// like native UI toolkits, Qt, etc. So the top-level widgets of
713713
// a window are drawn using ImGui windows whose frame is specified

0 commit comments

Comments
 (0)