Open3D (C++ API)
Public Types | Public Member Functions | Data Fields | Protected Member Functions
open3d::geometry::Image Class Reference

#include <Image.h>

Inheritance diagram for open3d::geometry::Image:
open3d::geometry::Geometry2D open3d::geometry::Geometry

Public Types

enum  ColorToIntensityConversionType { ColorToIntensityConversionType::Equal, ColorToIntensityConversionType::Weighted }
 
enum  FilterType {
  FilterType::Gaussian3, FilterType::Gaussian5, FilterType::Gaussian7, FilterType::Sobel3Dx,
  FilterType::Sobel3Dy
}
 
- Public Types inherited from open3d::geometry::Geometry
enum  GeometryType {
  GeometryType::Unspecified = 0, GeometryType::PointCloud = 1, GeometryType::VoxelGrid = 2, GeometryType::Octree = 3,
  GeometryType::LineSet = 4, GeometryType::TriangleMesh = 5, GeometryType::HalfEdgeTriangleMesh = 6, GeometryType::Image = 7
}
 

Public Member Functions

 Image ()
 
 ~Image () override
 
void Clear () override
 
bool IsEmpty () const override
 
Eigen::Vector2d GetMinBound () const override
 
Eigen::Vector2d GetMaxBound () const override
 
bool TestImageBoundary (double u, double v, double inner_margin=0.0) const
 
virtual bool HasData () const
 
void PrepareImage (int width, int height, int num_of_channels, int bytes_per_channel)
 
int BytesPerLine () const
 
std::pair< bool, double > FloatValueAt (double u, double v) const
 
- Public Member Functions inherited from open3d::geometry::Geometry2D
 ~Geometry2D () override
 
- Public Member Functions inherited from open3d::geometry::Geometry
virtual ~Geometry ()
 
GeometryType GetGeometryType () const
 
int Dimension () const
 

Data Fields

int width_ = 0
 
int height_ = 0
 
int num_of_channels_ = 0
 
int bytes_per_channel_ = 0
 
std::vector< uint8_t > data_
 

Protected Member Functions

void AllocateDataBuffer ()
 
- Protected Member Functions inherited from open3d::geometry::Geometry2D
 Geometry2D (GeometryType type)
 
- Protected Member Functions inherited from open3d::geometry::Geometry
 Geometry (GeometryType type, int dimension)
 

Member Enumeration Documentation

◆ ColorToIntensityConversionType

Enumerator
Equal 
Weighted 

◆ FilterType

Enumerator
Gaussian3 
Gaussian5 
Gaussian7 
Sobel3Dx 
Sobel3Dy 

Constructor & Destructor Documentation

◆ Image()

open3d::geometry::Image::Image ( )
inline

◆ ~Image()

open3d::geometry::Image::~Image ( )
inlineoverride

Member Function Documentation

◆ AllocateDataBuffer()

void open3d::geometry::Image::AllocateDataBuffer ( )
inlineprotected

◆ BytesPerLine()

int open3d::geometry::Image::BytesPerLine ( ) const
inline

◆ Clear()

void open3d::geometry::Image::Clear ( )
overridevirtual

◆ FloatValueAt()

std::pair< bool, double > open3d::geometry::Image::FloatValueAt ( double  u,
double  v 
) const

Function to access the bilinear interpolated float value of a (single-channel) float image

◆ GetMaxBound()

Eigen::Vector2d open3d::geometry::Image::GetMaxBound ( ) const
overridevirtual

◆ GetMinBound()

Eigen::Vector2d open3d::geometry::Image::GetMinBound ( ) const
overridevirtual

◆ HasData()

virtual bool open3d::geometry::Image::HasData ( ) const
inlinevirtual

◆ IsEmpty()

bool open3d::geometry::Image::IsEmpty ( ) const
overridevirtual

◆ PrepareImage()

void open3d::geometry::Image::PrepareImage ( int  width,
int  height,
int  num_of_channels,
int  bytes_per_channel 
)
inline

◆ TestImageBoundary()

bool open3d::geometry::Image::TestImageBoundary ( double  u,
double  v,
double  inner_margin = 0.0 
) const

Field Documentation

◆ bytes_per_channel_

int open3d::geometry::Image::bytes_per_channel_ = 0

◆ data_

std::vector<uint8_t> open3d::geometry::Image::data_

◆ height_

int open3d::geometry::Image::height_ = 0

◆ num_of_channels_

int open3d::geometry::Image::num_of_channels_ = 0

◆ width_

int open3d::geometry::Image::width_ = 0

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