Open3D (C++ API)  0.13.0+ec16c02
Public Member Functions | Data Fields
open3d::t::geometry::RGBDImage Class Reference

RGBDImage A pair of color and depth images. More...

#include <RGBDImage.h>

Inheritance diagram for open3d::t::geometry::RGBDImage:
open3d::t::geometry::Geometry

Public Member Functions

 RGBDImage ()
 Default Comnstructor. More...
 
 RGBDImage (const Image &color, const Image &depth, bool aligned=true)
 Parameterized Constructor. More...
 
 ~RGBDImage () override
 
RGBDImageClear () override
 Clear stored data. More...
 
bool IsEmpty () const override
 Is any data stored? More...
 
bool AreAligned () const
 Are the depth and color images aligned (same viewpoint and resolution)? More...
 
core::Tensor GetMinBound () const
 Compute min 2D coordinates for the data (always {0,0}). More...
 
core::Tensor GetMaxBound () const
 Compute max 2D coordinates for the data. More...
 
RGBDImage To (const core::Device &device, bool copy=false) const
 
RGBDImage Clone () const
 Returns copy of the RGBD image on the same device. More...
 
open3d::geometry::RGBDImage ToLegacy () const
 Convert to the legacy RGBDImage format. More...
 
std::string ToString () const
 Text description. More...
 
- Public Member Functions inherited from open3d::t::geometry::Geometry
virtual ~Geometry ()
 
GeometryType GetGeometryType () const
 Returns one of registered geometry types. More...
 
int Dimension () const
 Returns whether the geometry is 2D or 3D. More...
 
std::string GetName () const
 
void SetName (const std::string &name)
 

Data Fields

Image color_
 The color image. More...
 
Image depth_
 The depth image. More...
 
bool aligned_ = true
 Are the depth and color images aligned (same viewpoint and resolution)? More...
 

Additional Inherited Members

- Public Types inherited from open3d::t::geometry::Geometry
enum  GeometryType {
  GeometryType::Unspecified = 0, GeometryType::PointCloud = 1, GeometryType::VoxelGrid = 2, GeometryType::Octree = 3,
  GeometryType::LineSet = 4, GeometryType::MeshBase = 5, GeometryType::TriangleMesh = 6, GeometryType::HalfEdgeTriangleMesh = 7,
  GeometryType::Image = 8, GeometryType::RGBDImage = 9, GeometryType::TetraMesh = 10, GeometryType::OrientedBoundingBox = 11,
  GeometryType::AxisAlignedBoundingBox = 12
}
 Specifies possible geometry types. More...
 
- Protected Member Functions inherited from open3d::t::geometry::Geometry
 Geometry (GeometryType type, int dimension)
 Parameterized Constructor. More...
 

Detailed Description

RGBDImage A pair of color and depth images.

For most procesing, the image pair should be aligned (same viewpoint and resolution).

Constructor & Destructor Documentation

◆ RGBDImage() [1/2]

open3d::t::geometry::RGBDImage::RGBDImage ( )
inline

Default Comnstructor.

◆ RGBDImage() [2/2]

open3d::t::geometry::RGBDImage::RGBDImage ( const Image color,
const Image depth,
bool  aligned = true 
)
inline

Parameterized Constructor.

Parameters
colorThe color image.
depthThe depth image.
alignedAre the two images aligned (same viewpoint and resolution)?

◆ ~RGBDImage()

open3d::t::geometry::RGBDImage::~RGBDImage ( )
inlineoverride

Member Function Documentation

◆ AreAligned()

bool open3d::t::geometry::RGBDImage::AreAligned ( ) const
inline

Are the depth and color images aligned (same viewpoint and resolution)?

◆ Clear()

RGBDImage & open3d::t::geometry::RGBDImage::Clear ( )
overridevirtual

Clear stored data.

Implements open3d::t::geometry::Geometry.

◆ Clone()

RGBDImage open3d::t::geometry::RGBDImage::Clone ( ) const
inline

Returns copy of the RGBD image on the same device.

◆ GetMaxBound()

core::Tensor open3d::t::geometry::RGBDImage::GetMaxBound ( ) const
inline

Compute max 2D coordinates for the data.

◆ GetMinBound()

core::Tensor open3d::t::geometry::RGBDImage::GetMinBound ( ) const
inline

Compute min 2D coordinates for the data (always {0,0}).

◆ IsEmpty()

bool open3d::t::geometry::RGBDImage::IsEmpty ( ) const
overridevirtual

Is any data stored?

Implements open3d::t::geometry::Geometry.

◆ To()

RGBDImage open3d::t::geometry::RGBDImage::To ( const core::Device device,
bool  copy = false 
) const
inline

Transfer the RGBD image to a specified device.

Parameters
deviceThe targeted device to convert to.
copyIf true, a new image is always created; if false, the copy is avoided when the original image is already on the target device.

◆ ToLegacy()

open3d::geometry::RGBDImage open3d::t::geometry::RGBDImage::ToLegacy ( ) const
inline

Convert to the legacy RGBDImage format.

◆ ToString()

std::string open3d::t::geometry::RGBDImage::ToString ( ) const

Text description.

Field Documentation

◆ aligned_

bool open3d::t::geometry::RGBDImage::aligned_ = true

Are the depth and color images aligned (same viewpoint and resolution)?

◆ color_

Image open3d::t::geometry::RGBDImage::color_

The color image.

◆ depth_

Image open3d::t::geometry::RGBDImage::depth_

The depth image.


The documentation for this class was generated from the following files: