Open3D (C++ API)  0.13.0+ec16c02
Public Member Functions | Static Public Member Functions
open3d::t::io::RGBDVideoReader Class Referenceabstract

#include <RGBDVideoReader.h>

Inheritance diagram for open3d::t::io::RGBDVideoReader:
open3d::t::io::RSBagReader

Public Member Functions

 RGBDVideoReader ()
 
virtual ~RGBDVideoReader ()
 
virtual bool IsOpened () const =0
 Check If the RGBD video file is opened. More...
 
virtual bool IsEOF () const =0
 Check if the RGBD video file is all read. More...
 
virtual bool Open (const std::string &filename)=0
 
virtual void Close ()=0
 Close the opened RGBD video playback. More...
 
virtual RGBDVideoMetadataGetMetadata ()=0
 Get reference to the metadata of the RGBD video playback. More...
 
virtual const RGBDVideoMetadataGetMetadata () const =0
 Get metadata of the RGBD video playback. More...
 
virtual bool SeekTimestamp (uint64_t timestamp)=0
 Seek to the timestamp (in us). More...
 
virtual uint64_t GetTimestamp () const =0
 Get current timestamp (in us). More...
 
virtual t::geometry::RGBDImage NextFrame ()=0
 Get next frame from the RGBD video playback and returns the RGBD object. More...
 
virtual void SaveFrames (const std::string &frame_path, uint64_t start_time_us=0, uint64_t end_time_us=UINT64_MAX)
 
virtual std::string GetFilename () const =0
 Return filename being read. More...
 
virtual std::string ToString () const
 Text description. More...
 

Static Public Member Functions

static std::unique_ptr< RGBDVideoReaderCreate (const std::string &filename)
 Factory function to create object based on RGBD video file type. More...
 

Constructor & Destructor Documentation

◆ RGBDVideoReader()

open3d::t::io::RGBDVideoReader::RGBDVideoReader ( )
inline

◆ ~RGBDVideoReader()

virtual open3d::t::io::RGBDVideoReader::~RGBDVideoReader ( )
inlinevirtual

Member Function Documentation

◆ Close()

virtual void open3d::t::io::RGBDVideoReader::Close ( )
pure virtual

Close the opened RGBD video playback.

Implemented in open3d::t::io::RSBagReader.

◆ Create()

std::unique_ptr< RGBDVideoReader > open3d::t::io::RGBDVideoReader::Create ( const std::string &  filename)
static

Factory function to create object based on RGBD video file type.

◆ GetFilename()

virtual std::string open3d::t::io::RGBDVideoReader::GetFilename ( ) const
pure virtual

Return filename being read.

Implemented in open3d::t::io::RSBagReader.

◆ GetMetadata() [1/2]

virtual RGBDVideoMetadata& open3d::t::io::RGBDVideoReader::GetMetadata ( )
pure virtual

Get reference to the metadata of the RGBD video playback.

Implemented in open3d::t::io::RSBagReader.

◆ GetMetadata() [2/2]

virtual const RGBDVideoMetadata& open3d::t::io::RGBDVideoReader::GetMetadata ( ) const
pure virtual

Get metadata of the RGBD video playback.

Implemented in open3d::t::io::RSBagReader.

◆ GetTimestamp()

virtual uint64_t open3d::t::io::RGBDVideoReader::GetTimestamp ( ) const
pure virtual

Get current timestamp (in us).

Implemented in open3d::t::io::RSBagReader.

◆ IsEOF()

virtual bool open3d::t::io::RGBDVideoReader::IsEOF ( ) const
pure virtual

Check if the RGBD video file is all read.

Implemented in open3d::t::io::RSBagReader.

◆ IsOpened()

virtual bool open3d::t::io::RGBDVideoReader::IsOpened ( ) const
pure virtual

Check If the RGBD video file is opened.

Implemented in open3d::t::io::RSBagReader.

◆ NextFrame()

virtual t::geometry::RGBDImage open3d::t::io::RGBDVideoReader::NextFrame ( )
pure virtual

Get next frame from the RGBD video playback and returns the RGBD object.

Implemented in open3d::t::io::RSBagReader.

◆ Open()

virtual bool open3d::t::io::RGBDVideoReader::Open ( const std::string &  filename)
pure virtual

Open an RGBD video playback.

Parameters
filenamePath to the RGBD video file.

Implemented in open3d::t::io::RSBagReader.

◆ SaveFrames()

void open3d::t::io::RGBDVideoReader::SaveFrames ( const std::string &  frame_path,
uint64_t  start_time_us = 0,
uint64_t  end_time_us = UINT64_MAX 
)
virtual

Save synchronized and aligned individual frames to subfolders.

Parameters
frame_pathFrames will be stored in stream subfolders 'color' and 'depth' here. The intrinsic camera calibration for the color stream will be saved in 'intrinsic.json'.
start_time_us(default 0) Start saving frames from this time (us)
end_time_us(default video length) Save frames till this time (us)

◆ SeekTimestamp()

virtual bool open3d::t::io::RGBDVideoReader::SeekTimestamp ( uint64_t  timestamp)
pure virtual

Seek to the timestamp (in us).

Implemented in open3d::t::io::RSBagReader.

◆ ToString()

std::string open3d::t::io::RGBDVideoReader::ToString ( ) const
virtual

Text description.


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