Deep learning project. More...

#include <eVision/EasyDeepLearning/EDeepLearningProject.h>

Collaboration diagram for eVision::EasyDeepLearning::EDeepLearningProject:

Public Member Functions
	EDeepLearningProject (const std::string &projectFile)
	Creates or opens a project.
	EDeepLearningProject (const std::string &projectDir, const std::string &projectName, eVision::EasyDeepLearning::EDeepLearningToolType type)
	Creates or opens a project.
	EDeepLearningProject ()
	Creates or opens a project.
	EDeepLearningProject (const eVision::EasyDeepLearning::EDeepLearningProject &other)
	Creates or opens a project.
virtual	~EDeepLearningProject () throw ()
eVision::EasyDeepLearning::EDeepLearningProject &	operator= (const eVision::EasyDeepLearning::EDeepLearningProject &other)
	Assignment operator.
void	CopyTo (eVision::EasyDeepLearning::EDeepLearningProject &other) const
	Copy the project.
void	SetProjectDirectory (const std::string &projectDirectory)
	Project directory.
std::string	GetProjectDirectory () const
	Project directory.
std::string	GetProjectFile () const
	Path to the project file.
std::string	GetImageDirectory () const
	Image directory.
bool	GetImportImageIntoProjectDirectory () const
	Whether to import the images into the EDeepLearningProject::GetImageDirectory. (Default value: true).
void	SetImportImageIntoProjectDirectory (bool importImages)
	Whether to import the images into the EDeepLearningProject::GetImageDirectory. (Default value: true).
eVision::EasyDeepLearning::EDeepLearningToolType	GetType () const
	Type of the tools in the projects.
void	SetType (eVision::EasyDeepLearning::EDeepLearningToolType type)
	Type of the tools in the projects.
void	SetName (const std::string &projectName)
	Name of the project.
std::string	GetName () const
	Name of the project.
int64_t	GetCreationDate () const
	Creation date of the project represented as the number of seconds since the UNIX epoch.
std::string	GetISOCreationDate () const
	Creation date of the project as an ISO 8601 date (YYYY-MM-DD HH:MM:SS).
void	SaveProject ()
	Saves an opened project.
void	Save (const std::string &projectFile)
	Saves a project and set the project directory to the parent directory of projectFile.
void	Save (eVision::ESerializer *serializer)
	Saves a project and set the project directory to the parent directory of projectFile.
void	Load (const std::string &projectFile)
	Loads a project.
void	Load (eVision::ESerializer *serializer)
	Loads a project.
void	CloseSerializer ()
	Closes the internal serializer and unlocks the project files and directory.
bool	HasFileStructureUpdates () const
	Whether the project can be updated to a new folder and file structure.
std::string	GetFileStructureUpdateDescription () const
	Description of the file structure update.
void	UpdateProjectFileStructure ()
	Updates the project file structure.
std::string	GetGoodLabel () const
	Good label for EasySegment Unsupervised.
void	SetGoodLabel (const std::string &newGoodLabel)
	Good label for EasySegment Unsupervised.
void	UnsetGoodLabel ()
	Remove the good label for EasySegment Unsupervised.
int	GetNumTools () const
	Number of tools.
std::unique_ptr< eVision::EasyDeepLearning::EDeepLearningTool >	GetToolCopy (int toolId, bool includeTrainingModel) const
	Loads and returns the i-th tool of the project.
std::unique_ptr< eVision::EasyDeepLearning::EDeepLearningTool >	GetToolCopy (int toolId) const
	Loads and returns the i-th tool of the project.
std::string	GetToolName (int toolId) const
	Tool name.
void	SetToolName (int toolId, const std::string &name)
	Tool name.
int64_t	GetToolCreationDate (int toolId) const
	Creation date of the tool represented as the number of seconds since the UNIX epoch.
std::string	GetToolISOCreationDate (int toolId) const
	Creation date of the tool represented as an ISO 8601 date (YYYY-MM-DD HH:MM:SS).
bool	IsToolNameValid (const std::string &toolName) const
	Checks that the tool name is valid (not used by any other tool).
void	AddTool (const std::string &name)
	Adds a new tool with the given name.
void	RemoveTool (int toolId)
	Removes the given tool from the project. This will also remove all files and directories associated with the tool (tool directory, result and metrics files).
void	ImportTool (const std::string &name, const std::string &path)
	Imports an existing tool. Note that the imported tool will be copied into the project directory. The original file will no be used by the project.
void	ImportTool (const std::string &name, const eVision::EasyDeepLearning::EDeepLearningTool &tool)
	Imports an existing tool. Note that the imported tool will be copied into the project directory. The original file will no be used by the project.
void	SetToolSplit (int toolId, int splitId)
	Dataset split associated with a tool.
int	GetToolSplit (int toolId) const
	Dataset split associated with a tool.
void	SetToolDataAugmentation (int toolId, int dataAugmentationId)
	Data augmentation associated with a tool.
int	GetToolDataAugmentation (int toolId) const
	Data augmentation associated with a tool.
int	GetNumBenchmarks (int toolId) const
	Number of benchmarks for the given tool.
const eVision::EasyDeepLearning::EDeepLearningBenchmark &	GetBenchmark (int toolId, int benchId) const
	Gets a benchmark for a given tool.
eVision::EasyDeepLearning::EDeepLearningBenchmark &	GetBenchmark (int toolId, int benchId)
	Gets a benchmark for a given tool.
void	AddBenchmark (int toolId, const eVision::EasyDeepLearning::EDeepLearningBenchmark &benchmark)
	Adds a benchmark for the given tool.
void	RemoveBenchmark (int toolId, int benchmarkId)
	Removes a benchmark.
void	SetBenchmark (int toolId, int benchmarkId, const eVision::EasyDeepLearning::EDeepLearningBenchmark &benchmark)
	Replaces a benchmark.
int	GetNumSplits () const
	Number of dataset splits in the project.
void	AddSplit (const std::string &name, const eVision::EasyDeepLearning::EDatasetSplit &split)
	Adds a split.
void	RemoveSplit (int splitId)
	Removes a split.
const eVision::EasyDeepLearning::EDatasetSplit &	GetSplit (int splitId) const
	Gets the dataset split object for the given index.
std::string	GetSplitName (int splitId) const
	Name of the split.
void	SetSplitName (int splitId, const std::string &newName)
	Name of the split.
int64_t	GetSplitCreationDate (int splitId) const
	Creation date of the split represented as the number of seconds since the UNIX epoch.
std::string	GetSplitCreationISODate (int splitId) const
	Creation date of the split formatted as an ISO 8601 date (YYYY-MM-DD HH:MM:SS).
const eVision::EasyDeepLearning::EDataset &	GetDataset () const
	Gets the dataset contained in the project.
int	GetNumDataAugmentations () const
	Number of data augmentation.
const eVision::EasyDeepLearning::EDataAugmentation &	GetDataAugmentation (int dataAugmentationId) const
	Gets the data augmentation object for the given index.
std::string	GetDataAugmentationName (int dataAugmentationId) const
	Name of the data augmentation.
void	SetDataAugmentationName (int dataAugmentationId, const std::string &name)
	Name of the data augmentation.
int64_t	GetDataAugmentationCreationDate (int dataAugmentationId) const
	Creation date of the data augmentation represented as the number of seconds since the UNIX epoch.
std::string	GetDataAugmentationCreationISODate (int dataAugmentationId) const
	Creation date of the data augmentation formatted as an ISO 8601 date (YYYY-MM-DD HH:MM:SS).
void	AddDataAugmentation (const std::string &name)
	Adds an empty or specified data augmentation to the project.
void	AddDataAugmentation (const std::string &name, const eVision::EasyDeepLearning::EDataAugmentation &dataAugmentation)
	Adds an empty or specified data augmentation to the project.
void	RemoveDataAugmentaton (int dataAugmentationId)
	Removes the given data augmentation. The data augmentation at index 0 can't be removed.
std::string	GetResultFilename (int imageId) const
	Result filename for the given image.
	EDeepLearningProject (CppWrapperInternal::InternalConstructor)

Static Public Member Functions
static eVision::EasyDeepLearning::EDataAugmentation	GetDefaultDataAugmentation (eVision::EasyDeepLearning::EDeepLearningToolType type)
	Returns the default data augmentation used in Deep Learning Studio depending on the given tool type.

Public Attributes
CppWrapperInternal::WrappedClass	wrappedClass_

Detailed Description

Deep learning project.

A deep learning project manages a directory (EDeepLearningProject::SetProjectDirectory) in which it stores:

A main project file (EDeepLearningProject::GetProjectFile) containing the dataset, the dataset splits, data augmentation objects, and meta data about the tools;
A image directory to store the images of the dataset (EDeepLearningProject::GetImageDirectory);
A directory for each tool named after the corresponding tool name (EDeepLearningProject::GetToolName).

Call to EDeepLearningProject::CloseSerializer is mandatory after usage to ensure the file handle used by this class is properly released.

License(s): EasyClassify or EasySegment or EasyLocate

Constructor & Destructor Documentation

◆ EDeepLearningProject() [1/5]

eVision::EasyDeepLearning::EDeepLearningProject::EDeepLearningProject ( const std::string & projectFile )

Creates or opens a project.

Parameters

projectFile Main project file top open

◆ EDeepLearningProject() [2/5]

eVision::EasyDeepLearning::EDeepLearningProject::EDeepLearningProject	(	const std::string &	projectDir,
		const std::string &	projectName,
		eVision::EasyDeepLearning::EDeepLearningToolType	type )

Creates or opens a project.

Parameters

projectDir	Directory for a new project
projectName	Name of the new project project
type	Type of the new project

◆ EDeepLearningProject() [3/5]

eVision::EasyDeepLearning::EDeepLearningProject::EDeepLearningProject ( )

Creates or opens a project.

◆ EDeepLearningProject() [4/5]

eVision::EasyDeepLearning::EDeepLearningProject::EDeepLearningProject ( const eVision::EasyDeepLearning::EDeepLearningProject & other )

Creates or opens a project.

Parameters

other Other project for the copy constructor

◆ ~EDeepLearningProject()

eVision::EasyDeepLearning::EDeepLearningProject::~EDeepLearningProject	(		)
throw	(	)

virtual

◆ EDeepLearningProject() [5/5]

eVision::EasyDeepLearning::EDeepLearningProject::EDeepLearningProject ( CppWrapperInternal::InternalConstructor )

Member Function Documentation

◆ AddBenchmark()

void eVision::EasyDeepLearning::EDeepLearningProject::AddBenchmark	(	int	toolId,
		const eVision::EasyDeepLearning::EDeepLearningBenchmark &	benchmark )

Adds a benchmark for the given tool.

Parameters

toolId	Index of the tool
benchmark	Benchmark to add to the project

◆ AddDataAugmentation() [1/2]

void eVision::EasyDeepLearning::EDeepLearningProject::AddDataAugmentation ( const std::string & name )

Adds an empty or specified data augmentation to the project.

Parameters

name	Name for the data augmentation

◆ AddDataAugmentation() [2/2]

void eVision::EasyDeepLearning::EDeepLearningProject::AddDataAugmentation	(	const std::string &	name,
		const eVision::EasyDeepLearning::EDataAugmentation &	dataAugmentation )

Adds an empty or specified data augmentation to the project.

Parameters

name	Name for the data augmentation
dataAugmentation	Instance of EDataAugmentation class

◆ AddSplit()

void eVision::EasyDeepLearning::EDeepLearningProject::AddSplit	(	const std::string &	name,
		const eVision::EasyDeepLearning::EDatasetSplit &	split )

Adds a split.

Parameters

name	Name of the split
split	Instance of EDatasetSplit class.

◆ AddTool()

void eVision::EasyDeepLearning::EDeepLearningProject::AddTool ( const std::string & name )

Adds a new tool with the given name.

Parameters

name	Name of the tool.

◆ CloseSerializer()

void eVision::EasyDeepLearning::EDeepLearningProject::CloseSerializer ( )

Closes the internal serializer and unlocks the project files and directory.

This method is always called implicitly during the destruction of the object. It is still recommended to call it explicitly in programming languages other than C++ to ensure the underlying ressources are correctly released.

This method never throws exceptions.

◆ CopyTo()

void eVision::EasyDeepLearning::EDeepLearningProject::CopyTo ( eVision::EasyDeepLearning::EDeepLearningProject & other ) const

Copy the project.

Parameters

other Other project

◆ GetBenchmark() [1/2]

eVision::EasyDeepLearning::EDeepLearningBenchmark & eVision::EasyDeepLearning::EDeepLearningProject::GetBenchmark	(	int	toolId,
		int	benchId )

Gets a benchmark for a given tool.

Parameters

toolId	Index of the tool
benchId	Index of the benchmark

◆ GetBenchmark() [2/2]

const eVision::EasyDeepLearning::EDeepLearningBenchmark & eVision::EasyDeepLearning::EDeepLearningProject::GetBenchmark	(	int	toolId,
		int	benchId ) const

Gets a benchmark for a given tool.

Parameters

toolId	Index of the tool
benchId	Index of the benchmark

◆ GetCreationDate()

int64_t eVision::EasyDeepLearning::EDeepLearningProject::GetCreationDate ( ) const

Creation date of the project represented as the number of seconds since the UNIX epoch.

◆ GetDataAugmentation()

const eVision::EasyDeepLearning::EDataAugmentation & eVision::EasyDeepLearning::EDeepLearningProject::GetDataAugmentation ( int dataAugmentationId ) const

Gets the data augmentation object for the given index.

Parameters

dataAugmentationId Index of the data augmentation

◆ GetDataAugmentationCreationDate()

int64_t eVision::EasyDeepLearning::EDeepLearningProject::GetDataAugmentationCreationDate ( int dataAugmentationId ) const

Creation date of the data augmentation represented as the number of seconds since the UNIX epoch.

Parameters

dataAugmentationId Index of the data augmentation

◆ GetDataAugmentationCreationISODate()

std::string eVision::EasyDeepLearning::EDeepLearningProject::GetDataAugmentationCreationISODate ( int dataAugmentationId ) const

Creation date of the data augmentation formatted as an ISO 8601 date (YYYY-MM-DD HH:MM:SS).

Parameters

dataAugmentationId Index of the data augmentation

◆ GetDataAugmentationName()

std::string eVision::EasyDeepLearning::EDeepLearningProject::GetDataAugmentationName ( int dataAugmentationId ) const

Name of the data augmentation.

Parameters

dataAugmentationId Index of the data augmentation

◆ GetDataset()

const eVision::EasyDeepLearning::EDataset & eVision::EasyDeepLearning::EDeepLearningProject::GetDataset ( ) const

Gets the dataset contained in the project.

◆ GetDefaultDataAugmentation()

eVision::EasyDeepLearning::EDataAugmentation eVision::EasyDeepLearning::EDeepLearningProject::GetDefaultDataAugmentation ( eVision::EasyDeepLearning::EDeepLearningToolType type )

static

Returns the default data augmentation used in Deep Learning Studio depending on the given tool type.

Parameters

type	Type of the project

◆ GetFileStructureUpdateDescription()

std::string eVision::EasyDeepLearning::EDeepLearningProject::GetFileStructureUpdateDescription ( ) const

Description of the file structure update.

◆ GetGoodLabel()

std::string eVision::EasyDeepLearning::EDeepLearningProject::GetGoodLabel ( ) const

Good label for EasySegment Unsupervised.

◆ GetImageDirectory()

std::string eVision::EasyDeepLearning::EDeepLearningProject::GetImageDirectory ( ) const

Image directory.

Calling this method will create the image directory if it doesn't exist.

◆ GetImportImageIntoProjectDirectory()

bool eVision::EasyDeepLearning::EDeepLearningProject::GetImportImageIntoProjectDirectory ( ) const

Whether to import the images into the EDeepLearningProject::GetImageDirectory. (Default value: true).

This is a hint for Deep Learning Studio and this property will not be enforced when adding images through the API.

Importing the images into the project directory allows relocating a project to another computer.

◆ GetISOCreationDate()

std::string eVision::EasyDeepLearning::EDeepLearningProject::GetISOCreationDate ( ) const

Creation date of the project as an ISO 8601 date (YYYY-MM-DD HH:MM:SS).

◆ GetName()

std::string eVision::EasyDeepLearning::EDeepLearningProject::GetName ( ) const

Name of the project.

◆ GetNumBenchmarks()

int eVision::EasyDeepLearning::EDeepLearningProject::GetNumBenchmarks ( int toolId ) const

Number of benchmarks for the given tool.

Parameters

toolId Index of the tool

◆ GetNumDataAugmentations()

int eVision::EasyDeepLearning::EDeepLearningProject::GetNumDataAugmentations ( ) const

Number of data augmentation.

A project always contains an empty data augmentation at index 0.

◆ GetNumSplits()

int eVision::EasyDeepLearning::EDeepLearningProject::GetNumSplits ( ) const

Number of dataset splits in the project.

◆ GetNumTools()

int eVision::EasyDeepLearning::EDeepLearningProject::GetNumTools ( ) const

Number of tools.

◆ GetProjectDirectory()

std::string eVision::EasyDeepLearning::EDeepLearningProject::GetProjectDirectory ( ) const

Project directory.

The project directory can only be set on an empty project. Setting the project directory will create the directory if it doesn't exist.

◆ GetProjectFile()

std::string eVision::EasyDeepLearning::EDeepLearningProject::GetProjectFile ( ) const

Path to the project file.

The path to the project file is only defined for a project that has non-empty EDeepLearningProject::SetName and EDeepLearningProject::SetProjectDirectory.

◆ GetResultFilename()

std::string eVision::EasyDeepLearning::EDeepLearningProject::GetResultFilename ( int imageId ) const

Result filename for the given image.

Parameters

imageId Index of the image in the dataset

◆ GetSplit()

const eVision::EasyDeepLearning::EDatasetSplit & eVision::EasyDeepLearning::EDeepLearningProject::GetSplit ( int splitId ) const

Gets the dataset split object for the given index.

Parameters

splitId Index of the split

◆ GetSplitCreationDate()

int64_t eVision::EasyDeepLearning::EDeepLearningProject::GetSplitCreationDate ( int splitId ) const

Creation date of the split represented as the number of seconds since the UNIX epoch.

Parameters

splitId Index of the split

◆ GetSplitCreationISODate()

std::string eVision::EasyDeepLearning::EDeepLearningProject::GetSplitCreationISODate ( int splitId ) const

Creation date of the split formatted as an ISO 8601 date (YYYY-MM-DD HH:MM:SS).

Parameters

splitId Index of the split

◆ GetSplitName()

std::string eVision::EasyDeepLearning::EDeepLearningProject::GetSplitName ( int splitId ) const

Name of the split.

Parameters

splitId Index of the split

◆ GetToolCopy() [1/2]

std::unique_ptr< eVision::EasyDeepLearning::EDeepLearningTool > eVision::EasyDeepLearning::EDeepLearningProject::GetToolCopy ( int toolId ) const

Loads and returns the i-th tool of the project.

The user is responsible for deleting the returned object.

Parameters

toolId Index of the tool

◆ GetToolCopy() [2/2]

std::unique_ptr< eVision::EasyDeepLearning::EDeepLearningTool > eVision::EasyDeepLearning::EDeepLearningProject::GetToolCopy	(	int	toolId,
		bool	includeTrainingModel ) const

Loads and returns the i-th tool of the project.

The user is responsible for deleting the returned object.

Parameters

toolId	Index of the tool
includeTrainingModel	Whether to include the training model

◆ GetToolCreationDate()

int64_t eVision::EasyDeepLearning::EDeepLearningProject::GetToolCreationDate ( int toolId ) const

Creation date of the tool represented as the number of seconds since the UNIX epoch.

Parameters

toolId Index of the tool

◆ GetToolDataAugmentation()

int eVision::EasyDeepLearning::EDeepLearningProject::GetToolDataAugmentation ( int toolId ) const

Data augmentation associated with a tool.

Parameters

toolId Index of the tool

◆ GetToolISOCreationDate()

std::string eVision::EasyDeepLearning::EDeepLearningProject::GetToolISOCreationDate ( int toolId ) const

Creation date of the tool represented as an ISO 8601 date (YYYY-MM-DD HH:MM:SS).

Parameters

toolId Index of the tool

◆ GetToolName()

std::string eVision::EasyDeepLearning::EDeepLearningProject::GetToolName ( int toolId ) const

Tool name.

Parameters

toolId Index of the tool

◆ GetToolSplit()

int eVision::EasyDeepLearning::EDeepLearningProject::GetToolSplit ( int toolId ) const

Dataset split associated with a tool.

Parameters

toolId Index of the tool

◆ GetType()

eVision::EasyDeepLearning::EDeepLearningToolType eVision::EasyDeepLearning::EDeepLearningProject::GetType ( ) const

Type of the tools in the projects.

◆ HasFileStructureUpdates()

bool eVision::EasyDeepLearning::EDeepLearningProject::HasFileStructureUpdates ( ) const

Whether the project can be updated to a new folder and file structure.

◆ ImportTool() [1/2]

void eVision::EasyDeepLearning::EDeepLearningProject::ImportTool	(	const std::string &	name,
		const eVision::EasyDeepLearning::EDeepLearningTool &	tool )

Imports an existing tool. Note that the imported tool will be copied into the project directory. The original file will no be used by the project.

The labels' name, weight, and color in the imported tool will be taken from the dataset.

Parameters

name	Name for the imported tool.
tool	Tool object to import. A copy of the tool will be made internally.

◆ ImportTool() [2/2]

void eVision::EasyDeepLearning::EDeepLearningProject::ImportTool	(	const std::string &	name,
		const std::string &	path )

Imports an existing tool. Note that the imported tool will be copied into the project directory. The original file will no be used by the project.

The labels' name, weight, and color in the imported tool will be taken from the dataset.

Parameters

name	Name for the imported tool.
path	Path towards the tool file.

◆ IsToolNameValid()

bool eVision::EasyDeepLearning::EDeepLearningProject::IsToolNameValid ( const std::string & toolName ) const

Checks that the tool name is valid (not used by any other tool).

Parameters

toolName Tool name

◆ Load() [1/2]

void eVision::EasyDeepLearning::EDeepLearningProject::Load ( const std::string & projectFile )

Loads a project.

Parameters

projectFile Project file to load.

◆ Load() [2/2]

void eVision::EasyDeepLearning::EDeepLearningProject::Load ( eVision::ESerializer * serializer )

Loads a project.

Parameters

serializer The serializer. This overload will throw as it's an invalid operation.

◆ operator=()

eVision::EasyDeepLearning::EDeepLearningProject & eVision::EasyDeepLearning::EDeepLearningProject::operator= ( const eVision::EasyDeepLearning::EDeepLearningProject & other )

Assignment operator.

Parameters

other Other project

◆ RemoveBenchmark()

void eVision::EasyDeepLearning::EDeepLearningProject::RemoveBenchmark	(	int	toolId,
		int	benchmarkId )

Removes a benchmark.

Parameters

toolId	Index of the tool
benchmarkId	Index of the benchmark to remove

◆ RemoveDataAugmentaton()

void eVision::EasyDeepLearning::EDeepLearningProject::RemoveDataAugmentaton ( int dataAugmentationId )

Removes the given data augmentation. The data augmentation at index 0 can't be removed.

Parameters

dataAugmentationId Index of the data augmentation to remove

◆ RemoveSplit()

void eVision::EasyDeepLearning::EDeepLearningProject::RemoveSplit ( int splitId )

Removes a split.

Parameters

splitId Index of the split

◆ RemoveTool()

void eVision::EasyDeepLearning::EDeepLearningProject::RemoveTool ( int toolId )

Removes the given tool from the project. This will also remove all files and directories associated with the tool (tool directory, result and metrics files).

Parameters

toolId Index of the tool to remove

◆ Save() [1/2]

void eVision::EasyDeepLearning::EDeepLearningProject::Save ( const std::string & projectFile )

Saves a project and set the project directory to the parent directory of projectFile.

Parameters

projectFile Project file to save.

◆ Save() [2/2]

void eVision::EasyDeepLearning::EDeepLearningProject::Save ( eVision::ESerializer * serializer )

Saves a project and set the project directory to the parent directory of projectFile.

Parameters

serializer The serializer. This overload will throw as it's an invalid operation.

◆ SaveProject()

void eVision::EasyDeepLearning::EDeepLearningProject::SaveProject ( )

Saves an opened project.

◆ SetBenchmark()

void eVision::EasyDeepLearning::EDeepLearningProject::SetBenchmark	(	int	toolId,
		int	benchmarkId,
		const eVision::EasyDeepLearning::EDeepLearningBenchmark &	benchmark )

Replaces a benchmark.

Parameters

toolId	Index of the tool
benchmarkId	Index of the benchmark to replace
benchmark	New benchmark

◆ SetDataAugmentationName()

void eVision::EasyDeepLearning::EDeepLearningProject::SetDataAugmentationName	(	int	dataAugmentationId,
		const std::string &	name )

Name of the data augmentation.

Parameters

dataAugmentationId	Index of the data augmentation
name	New name for the data augmentation

◆ SetGoodLabel()

void eVision::EasyDeepLearning::EDeepLearningProject::SetGoodLabel ( const std::string & newGoodLabel )

Good label for EasySegment Unsupervised.

Parameters

newGoodLabel Good label for EasySegment Unsupervised

◆ SetImportImageIntoProjectDirectory()

void eVision::EasyDeepLearning::EDeepLearningProject::SetImportImageIntoProjectDirectory ( bool importImages )

Whether to import the images into the EDeepLearningProject::GetImageDirectory. (Default value: true).

This is a hint for Deep Learning Studio and this property will not be enforced when adding images through the API.

Importing the images into the project directory allows relocating a project to another computer.

◆ SetName()

void eVision::EasyDeepLearning::EDeepLearningProject::SetName ( const std::string & projectName )

Name of the project.

Parameters

projectName Name of the project

◆ SetProjectDirectory()

void eVision::EasyDeepLearning::EDeepLearningProject::SetProjectDirectory ( const std::string & projectDirectory )

Project directory.

The project directory can only be set on an empty project. Setting the project directory will create the directory if it doesn't exist.

Parameters

projectDirectory Project directory

◆ SetSplitName()

void eVision::EasyDeepLearning::EDeepLearningProject::SetSplitName	(	int	splitId,
		const std::string &	newName )

Name of the split.

Parameters

splitId	Index of the split
newName	New name for the split

◆ SetToolDataAugmentation()

void eVision::EasyDeepLearning::EDeepLearningProject::SetToolDataAugmentation	(	int	toolId,
		int	dataAugmentationId )

Data augmentation associated with a tool.

Parameters

toolId	Index of the tool
dataAugmentationId	Index of the data augmentation

◆ SetToolName()

void eVision::EasyDeepLearning::EDeepLearningProject::SetToolName	(	int	toolId,
		const std::string &	name )

Tool name.

Changing the name of a tool will move the directory in which the tool is saved.

Parameters

toolId	Index of the tool
name	New name for the tool

◆ SetToolSplit()

void eVision::EasyDeepLearning::EDeepLearningProject::SetToolSplit	(	int	toolId,
		int	splitId )

Dataset split associated with a tool.

Parameters

toolId	Index of the tool
splitId	Index of the split

◆ SetType()

void eVision::EasyDeepLearning::EDeepLearningProject::SetType ( eVision::EasyDeepLearning::EDeepLearningToolType type )

Type of the tools in the projects.

◆ UnsetGoodLabel()

void eVision::EasyDeepLearning::EDeepLearningProject::UnsetGoodLabel ( )

Remove the good label for EasySegment Unsupervised.

◆ UpdateProjectFileStructure()

void eVision::EasyDeepLearning::EDeepLearningProject::UpdateProjectFileStructure ( )

Updates the project file structure.

Member Data Documentation

◆ wrappedClass_

CppWrapperInternal::WrappedClass eVision::EasyDeepLearning::EDeepLearningProject::wrappedClass_

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ EDeepLearningProject() [1/5]

◆ EDeepLearningProject() [2/5]

◆ EDeepLearningProject() [3/5]

◆ EDeepLearningProject() [4/5]

◆ ~EDeepLearningProject()

◆ EDeepLearningProject() [5/5]

Member Function Documentation

◆ AddBenchmark()

◆ AddDataAugmentation() [1/2]

◆ AddDataAugmentation() [2/2]

◆ AddSplit()

◆ AddTool()

◆ CloseSerializer()

◆ CopyTo()

◆ GetBenchmark() [1/2]

◆ GetBenchmark() [2/2]

◆ GetCreationDate()

◆ GetDataAugmentation()

◆ GetDataAugmentationCreationDate()

◆ GetDataAugmentationCreationISODate()

◆ GetDataAugmentationName()

◆ GetDataset()

◆ GetDefaultDataAugmentation()

◆ GetFileStructureUpdateDescription()

◆ GetGoodLabel()

◆ GetImageDirectory()

◆ GetImportImageIntoProjectDirectory()

◆ GetISOCreationDate()

◆ GetName()

◆ GetNumBenchmarks()

◆ GetNumDataAugmentations()

◆ GetNumSplits()

◆ GetNumTools()

◆ GetProjectDirectory()

◆ GetProjectFile()

◆ GetResultFilename()

◆ GetSplit()

◆ GetSplitCreationDate()

◆ GetSplitCreationISODate()

◆ GetSplitName()

◆ GetToolCopy() [1/2]

◆ GetToolCopy() [2/2]

◆ GetToolCreationDate()

◆ GetToolDataAugmentation()

◆ GetToolISOCreationDate()

◆ GetToolName()

◆ GetToolSplit()

◆ GetType()

◆ HasFileStructureUpdates()

◆ ImportTool() [1/2]

◆ ImportTool() [2/2]

◆ IsToolNameValid()

◆ Load() [1/2]

◆ Load() [2/2]

◆ operator=()

◆ RemoveBenchmark()

◆ RemoveDataAugmentaton()

◆ RemoveSplit()

◆ RemoveTool()

◆ Save() [1/2]

◆ Save() [2/2]

◆ SaveProject()

◆ SetBenchmark()

◆ SetDataAugmentationName()

◆ SetGoodLabel()

◆ SetImportImageIntoProjectDirectory()

◆ SetName()

◆ SetProjectDirectory()

◆ SetSplitName()

◆ SetToolDataAugmentation()

◆ SetToolName()

◆ SetToolSplit()

◆ SetType()

◆ UnsetGoodLabel()

◆ UpdateProjectFileStructure()