Public Member Functions | Public Attributes | Static Public Attributes | List of all members
ecvl::Dataset Class Reference

DeepHealth Dataset. More...

#include <dataset_parser.h>

Inheritance diagram for ecvl::Dataset:
ecvl::DLDataset

Public Member Functions

 Dataset ()
 
 Dataset (const filesystem::path &filename, bool verify=false)
 
void Dump (const filesystem::path &file_path)
 Dump the Dataset into a YAML file following the DeepHealth Dataset Format. More...
 

Public Attributes

std::string name_ = "DeepHealth dataset"
 Name of the Dataset. More...
 
std::string description_ = "This is the DeepHealth example dataset!"
 Description of the Dataset. More...
 
std::vector< std::string > classes_
 Vector with all the classes available in the Dataset. More...
 
std::vector< std::string > features_
 Vector with all the features available in the Dataset. More...
 
std::vector< Samplesamples_
 Vector containing all the Dataset samples. See Sample. More...
 
Split split_
 Splits of the Dataset. See Split. More...
 

Static Public Attributes

static const std::regex url_regex_
 

Detailed Description

DeepHealth Dataset.

This class implements the DeepHealth Dataset Format (https://github.com/deephealthproject/ecvl/wiki/DeepHealth-Toolkit-Dataset-Format).

Definition at line 86 of file dataset_parser.h.

Constructor & Destructor Documentation

◆ Dataset() [1/2]

ecvl::Dataset::Dataset ( )
inline

Definition at line 96 of file dataset_parser.h.

◆ Dataset() [2/2]

ecvl::Dataset::Dataset ( const filesystem::path &  filename,
bool  verify = false 
)
Parameters
[in]filenamePath to the Dataset file.
[in]verifyWhether to log the non-existence of a dataset sample location or not.

Member Function Documentation

◆ Dump()

void ecvl::Dataset::Dump ( const filesystem::path &  file_path)

Dump the Dataset into a YAML file following the DeepHealth Dataset Format.

The YAML file is saved into the dataset root directory. Samples paths are relative to the dataset root directory.

Parameters
[in]file_pathWhere to save the YAML file.

Member Data Documentation

◆ classes_

std::vector<std::string> ecvl::Dataset::classes_

Vector with all the classes available in the Dataset.

Examples
example_ecvl_eddl.cpp.

Definition at line 91 of file dataset_parser.h.

◆ description_

std::string ecvl::Dataset::description_ = "This is the DeepHealth example dataset!"

Description of the Dataset.

Definition at line 90 of file dataset_parser.h.

◆ features_

std::vector<std::string> ecvl::Dataset::features_

Vector with all the features available in the Dataset.

Definition at line 92 of file dataset_parser.h.

◆ name_

std::string ecvl::Dataset::name_ = "DeepHealth dataset"

Name of the Dataset.

Definition at line 89 of file dataset_parser.h.

◆ samples_

std::vector<Sample> ecvl::Dataset::samples_

Vector containing all the Dataset samples. See Sample.

Definition at line 93 of file dataset_parser.h.

◆ split_

Split ecvl::Dataset::split_

Splits of the Dataset. See Split.

Definition at line 94 of file dataset_parser.h.

◆ url_regex_

const std::regex ecvl::Dataset::url_regex_
static

Definition at line 114 of file dataset_parser.h.


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