cloudViewer::data::Dataset Class Reference

Base CloudViewer dataset class. More...

#include <Dataset.h>

Inheritance diagram for cloudViewer::data::Dataset:

Collaboration diagram for cloudViewer::data::Dataset:

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_
	CloudViewer data root. More...
std::string	prefix_
	Dataset prefix. More...

Detailed Description

Base CloudViewer dataset class.

The Dataset classes in CloudViewer 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 CloudViewer's data root directory.

• A dataset class locates the data root directory in the following order: (a) User-specified by data_root when instantiating a dataset object. (b) CLOUDVIEWER_DATA_ROOT environment variable. (c) $HOME/cloudViewer_data. By default, (c) will be used, and it is also the recommended way.
• When a dataset object is instantiated, the corresponding data will be downloaded in ${data_root}/download/prefix/ and extracted or copied to ${data_root}/extract/prefix/. If the extracted data directory exists, the files will be used without validation. If it does not exists, and the valid downloaded file exists, the data will be extracted from the downloaded file. If downloaded file does not exists, or validates against the provided MD5, it will be re-downloaded.
• After the data is downloaded and extracted, the dataset object will NOT load the data for you. Instead, you will get the paths to the data files and use CloudViewer's I/O functions to load the data. This design exposes where the data is stored and how the data is loaded, allowing users to modify the code and load their own data in a similar way. Please check the documentation of the specific dataset to know more about the specific functionalities provided for it.

Definition at line 61 of file Dataset.h.

Constructor & Destructor Documentation

Dataset()

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

Parameterized Constructor.

Parameters

prefix	Prefix of the dataset. The data is downloaded in ${data_root}/download/${prefix}/ and extracted in ${data_root}/extract/${prefix}/.
data_root	Path 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) CLOUDVIEWER_DATA_ROOT environment variable. (c) $HOME/cloudViewer_data. By default, (c) will be used, and it is also the recommended way.

Definition at line 53 of file Dataset.cpp.

References data_root_, cloudViewer::data::LocateDataRoot(), LogError, and prefix_.

~Dataset()

virtual cloudViewer::data::Dataset::~Dataset ( )

inlinevirtual

Definition at line 77 of file Dataset.h.

Member Function Documentation

CheckPathsExist()

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

protected

Check if the paths exists after extraction.

Definition at line 65 of file Dataset.cpp.

References cloudViewer::utility::filesystem::FileExists(), LogError, LogWarning, and cloudViewer::t::geometry::path.

Referenced by cloudViewer::data::RedwoodIndoorLivingRoom1::RedwoodIndoorLivingRoom1(), cloudViewer::data::RedwoodIndoorLivingRoom2::RedwoodIndoorLivingRoom2(), cloudViewer::data::RedwoodIndoorOffice1::RedwoodIndoorOffice1(), and cloudViewer::data::RedwoodIndoorOffice2::RedwoodIndoorOffice2().

GetDataRoot()

const std::string cloudViewer::data::Dataset::GetDataRoot ( ) const

inline

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

Definition at line 81 of file Dataset.h.

References data_root_.

Referenced by GetDownloadDir(), GetExtractDir(), and cloudViewer::data::pybind_data_classes().

GetDownloadDir()

const std::string cloudViewer::data::Dataset::GetDownloadDir ( ) const

inline

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

Definition at line 88 of file Dataset.h.

References GetDataRoot(), and GetPrefix().

Referenced by cloudViewer::data::DownloadDataset::DownloadDataset(), cloudViewer::data::DownloadDataset::HasDownloaded(), and cloudViewer::data::pybind_data_classes().

GetExtractDir()

const std::string cloudViewer::data::Dataset::GetExtractDir ( ) const

inline

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

Definition at line 94 of file Dataset.h.

References GetDataRoot(), and GetPrefix().

Referenced by cloudViewer::data::ArmadilloMesh::ArmadilloMesh(), cloudViewer::data::AvocadoModel::AvocadoModel(), cloudViewer::data::BedroomRGBDImages::BedroomRGBDImages(), cloudViewer::data::BunnyMesh::BunnyMesh(), cloudViewer::data::CrateModel::CrateModel(), cloudViewer::data::DamagedHelmetModel::DamagedHelmetModel(), cloudViewer::data::DemoColoredICPPointClouds::DemoColoredICPPointClouds(), cloudViewer::data::DemoCropPointCloud::DemoCropPointCloud(), cloudViewer::data::DemoCustomVisualization::DemoCustomVisualization(), cloudViewer::data::DemoDopplerICPSequence::DemoDopplerICPSequence(), cloudViewer::data::DemoFeatureMatchingPointClouds::DemoFeatureMatchingPointClouds(), cloudViewer::data::DemoICPPointClouds::DemoICPPointClouds(), cloudViewer::data::DemoPoseGraphOptimization::DemoPoseGraphOptimization(), cloudViewer::data::DownloadDataset::DownloadDataset(), cloudViewer::data::EaglePointCloud::EaglePointCloud(), cloudViewer::data::FlightHelmetModel::FlightHelmetModel(), cloudViewer::data::JackJackL515Bag::JackJackL515Bag(), cloudViewer::data::JuneauImage::JuneauImage(), cloudViewer::data::KnotMesh::KnotMesh(), cloudViewer::data::LivingRoomPointClouds::LivingRoomPointClouds(), cloudViewer::data::LoungeRGBDImages::LoungeRGBDImages(), cloudViewer::data::MetalTexture::MetalTexture(), cloudViewer::data::MonkeyModel::MonkeyModel(), cloudViewer::data::OfficePointClouds::OfficePointClouds(), cloudViewer::data::PaintedPlasterTexture::PaintedPlasterTexture(), cloudViewer::data::PCDPointCloud::PCDPointCloud(), cloudViewer::data::PLYPointCloud::PLYPointCloud(), cloudViewer::data::PTSPointCloud::PTSPointCloud(), cloudViewer::data::pybind_data_classes(), cloudViewer::data::RedwoodIndoorLivingRoom1::RedwoodIndoorLivingRoom1(), cloudViewer::data::RedwoodIndoorLivingRoom2::RedwoodIndoorLivingRoom2(), cloudViewer::data::RedwoodIndoorOffice1::RedwoodIndoorOffice1(), cloudViewer::data::RedwoodIndoorOffice2::RedwoodIndoorOffice2(), cloudViewer::data::SampleFountainRGBDImages::SampleFountainRGBDImages(), cloudViewer::data::SampleL515Bag::SampleL515Bag(), cloudViewer::data::SampleNYURGBDImage::SampleNYURGBDImage(), cloudViewer::data::SampleRedwoodRGBDImages::SampleRedwoodRGBDImages(), cloudViewer::data::SampleSUNRGBDImage::SampleSUNRGBDImage(), cloudViewer::data::SampleTUMRGBDImage::SampleTUMRGBDImage(), cloudViewer::data::SwordModel::SwordModel(), cloudViewer::data::TerrazzoTexture::TerrazzoTexture(), cloudViewer::data::TilesTexture::TilesTexture(), cloudViewer::data::WoodFloorTexture::WoodFloorTexture(), and cloudViewer::data::WoodTexture::WoodTexture().

GetPrefix()

const std::string cloudViewer::data::Dataset::GetPrefix ( ) const

inline

Get prefix for the dataset.

Definition at line 84 of file Dataset.h.

References prefix_.

Referenced by GetDownloadDir(), GetExtractDir(), and cloudViewer::data::pybind_data_classes().

Member Data Documentation

data_root_

std::string cloudViewer::data::Dataset::data_root_

protected

CloudViewer data root.

Definition at line 100 of file Dataset.h.

Referenced by Dataset(), and GetDataRoot().

prefix_

std::string cloudViewer::data::Dataset::prefix_

protected

Dataset prefix.

Definition at line 103 of file Dataset.h.

Referenced by Dataset(), and GetPrefix().

---

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

• /root/ACloudViewer/libs/cloudViewer/data/Dataset.h
• /root/ACloudViewer/libs/cloudViewer/data/Dataset.cpp