Open3D (C++ API)  0.18.0
Public Member Functions | Protected Member Functions | Protected Attributes
open3d::data::Dataset Class Reference

Base Open3D dataset class. More...

#include <Dataset.h>

Inheritance diagram for open3d::data::Dataset:
open3d::data::DownloadDataset open3d::data::ArmadilloMesh open3d::data::AvocadoModel open3d::data::BedroomRGBDImages open3d::data::BunnyMesh open3d::data::CrateModel open3d::data::DamagedHelmetModel open3d::data::DemoColoredICPPointClouds open3d::data::DemoCropPointCloud open3d::data::DemoCustomVisualization open3d::data::DemoDopplerICPSequence open3d::data::DemoFeatureMatchingPointClouds open3d::data::DemoICPPointClouds open3d::data::DemoPoseGraphOptimization open3d::data::EaglePointCloud open3d::data::FlightHelmetModel open3d::data::JackJackL515Bag open3d::data::JuneauImage open3d::data::KnotMesh open3d::data::LivingRoomPointClouds open3d::data::LoungeRGBDImages open3d::data::MetalTexture open3d::data::MonkeyModel open3d::data::OfficePointClouds open3d::data::PCDPointCloud open3d::data::PLYPointCloud open3d::data::PTSPointCloud open3d::data::PaintedPlasterTexture open3d::data::RedwoodIndoorLivingRoom1 open3d::data::RedwoodIndoorLivingRoom2 open3d::data::RedwoodIndoorOffice1 open3d::data::RedwoodIndoorOffice2 open3d::data::SampleFountainRGBDImages open3d::data::SampleL515Bag open3d::data::SampleNYURGBDImage open3d::data::SampleRedwoodRGBDImages open3d::data::SampleSUNRGBDImage open3d::data::SampleTUMRGBDImage open3d::data::SwordModel open3d::data::TerrazzoTexture open3d::data::TilesTexture open3d::data::WoodFloorTexture open3d::data::WoodTexture

Public Member Functions

 Dataset (const std::string &prefix, const std::string &data_root="")
 Parameterized Constructor. More...
 
virtual ~Dataset ()
 
const std::string GetDataRoot () const
 Get data root directory. The data root is set at construction time or automatically determined. More...
 
const std::string GetPrefix () const
 Get prefix for the dataset. More...
 
const std::string GetDownloadDir () const
 Get absolute path to download directory. i.e. ${data_root}/download/${prefix}. More...
 
const std::string GetExtractDir () const
 Get absolute path to extract directory. i.e. ${data_root}/extract/${prefix}. More...
 

Protected Member Functions

void CheckPathsExist (const std::vector< std::string > &paths) const
 Check if the paths exists after extraction. More...
 

Protected Attributes

std::string data_root_
 Open3D data root. More...
 
std::string prefix_
 Dataset prefix. More...
 

Detailed Description

Base Open3D dataset class.

The Dataset classes in Open3D are designed for convenient access to "built-in" example and test data. You'll need internet access to use the dataset classes. The downloaded data will be stored in the Open3D's data root directory.

Constructor & Destructor Documentation

◆ Dataset()

open3d::data::Dataset::Dataset ( const std::string &  prefix,
const std::string &  data_root = "" 
)

Parameterized Constructor.

Parameters
prefixPrefix of the dataset. The data is downloaded in ${data_root}/download/${prefix}/ and extracted in ${data_root}/extract/${prefix}/.
data_rootPath to ${data_root}, which contains all the downloaded and extracted files. The data root directory is located in the following order: (a) User-specified by data_root when instantiating a dataset object. (b) OPEN3D_DATA_ROOT environment variable. (c) $HOME/open3d_data. By default, (c) will be used, and it is also the recommended way.

◆ ~Dataset()

virtual open3d::data::Dataset::~Dataset ( )
inlinevirtual

Member Function Documentation

◆ CheckPathsExist()

void open3d::data::Dataset::CheckPathsExist ( const std::vector< std::string > &  paths) const
protected

Check if the paths exists after extraction.

◆ GetDataRoot()

const std::string open3d::data::Dataset::GetDataRoot ( ) const
inline

Get data root directory. The data root is set at construction time or automatically determined.

◆ GetDownloadDir()

const std::string open3d::data::Dataset::GetDownloadDir ( ) const
inline

Get absolute path to download directory. i.e. ${data_root}/download/${prefix}.

◆ GetExtractDir()

const std::string open3d::data::Dataset::GetExtractDir ( ) const
inline

Get absolute path to extract directory. i.e. ${data_root}/extract/${prefix}.

◆ GetPrefix()

const std::string open3d::data::Dataset::GetPrefix ( ) const
inline

Get prefix for the dataset.

Field Documentation

◆ data_root_

std::string open3d::data::Dataset::data_root_
protected

Open3D data root.

◆ prefix_

std::string open3d::data::Dataset::prefix_
protected

Dataset prefix.


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