Project Class
You must call the Dispose() method to free all the resources of the returned instance. More...

#include <cs_project.h>

Inheritance diagram for sb_cs::SbProject:

Collaboration diagram for sb_cs::SbProject:

Public Member Functions
SbError	Save (String^ solution_file, SbProjectMode mode)
	Saves the project to file More...

SbProject	Clone (SbProjectMode mode, bool regenerate_uuid)
	Clones the project More...

SbPar	GetPar ()
	Retrieves the project parameters structure. More...

SbError	SetPar (SbPar^ par)
	Sets the project parameters. More...

SbError	Detection (SbImage ^img, SbRoi ^roi)
	The function elaborates the image inside the ROI. For Surface projects the function computes also the blob analysis on the weight map if the parameter SbPar::surface_blob_analysis is set. More...

SbRes	GetRes (bool details)
	Retrieves the results of the last processed image More...

SbProjectInfo	GetInfo ()
	Gets the project information from the handle. More...

String	GetName ()
	Retrieves the project name More...

SbError	SetName (String^ name)
	Sets the project name More...

SbError	Invalidate (String ^model_name, float scale)
	Eliminates the training of the models. More...

SbError	SetSensitivity (String ^model_name, float scale, float sensitivity)
	Sets the classification threshold from the project handle. More...

float	GetSensitivity (String ^model_name, float scale)
	Gets the classification threshold from the project handle. More...

SbProjectTrainingStatus	CheckTrained (String ^model_name, float scale)
	Checks if the project is trained. See the SB Library documentation for further details. More...

String	GetNotes ()
	Retrieves the project notes More...

SbError	SetNotes (String ^ notes)
	Sets the project notes More...

SbVersion	GetSvlVersion ()
	Retrieves the SVL version More...

String	LicenseConfigurationCheck (SbLicenseConfigurationId id)
	Checks if the project can be used with a license configuration. More...

Public Member Functions inherited from sb_cs::SbCommon
SbError	Error ()
	Returns the error code of the last operation. If no error SbError.SB_ERR_NONE is returned. More...

String	ErrorMsg ()
	Returns the error message of the last operation. More...

Static Public Member Functions
static SbProject	Create (String^ name, SbProjectType type)
	Creates a new project of the specifed type. More...

static SbProject	Load (String^ solution_file, String^ project_uuid, SbProjectMode mode)
	Loads an existing project from file. More...

Static Public Member Functions inherited from sb_cs::SbCommon
static String	FormatError (SbError error)
	Returns the error message. More...

Detailed Description

Project Class
You must call the Dispose() method to free all the resources of the returned instance.

Definition at line 50 of file cs_project.h.

Member Function Documentation

◆ CheckTrained()

SbProjectTrainingStatus sb_cs::SbProject::CheckTrained	(	String ^	model_name,
		float	scale
	)

Checks if the project is trained. See the SB Library documentation for further details.

Parameters

model_name	Name of the model to be checked.
scale	Level scale to check (used only for Surface projects)

Returns: Project training status

See also: sb_project_check_trained

◆ Clone()

SbProject sb_cs::SbProject::Clone	(	SbProjectMode	mode,
		bool	regenerate_uuid
	)

Clones the project

Parameters

mode	Loading method of the module of a project
regenerate_uuid	If true it generates a new project uuid for the new project

Returns: An instance to the SbProject class or null in case of memory error.
The instance returned is valid only if the SbProject.Error() is equal to SbError::SB_ERR_NONE, otherwise an error occurred.
You must call the Dispose() method to free all the resources of the returned instance.

See also: sb_project_clean

◆ Create()

static SbProject sb_cs::SbProject::Create	(	String^	name,
		SbProjectType	type
	)

static

Creates a new project of the specifed type.

Parameters

name	Project Name
type	Project Type

Returns: An instance to the SbProject class or null in case of memory error.
The instance returned is valid only if the SbProject.Error() is equal to SbError::SB_ERR_NONE, otherwise an error occurred.
You must call the Dispose() method to free all the resources of the returned instance.

See also: sb_project_create

◆ Detection()

SbError sb_cs::SbProject::Detection	(	SbImage ^	img,
		SbRoi ^	roi
	)

The function elaborates the image inside the ROI. For Surface projects the function computes also the blob analysis on the weight map if the parameter SbPar::surface_blob_analysis is set.

Parameters

img	Image to be elaborated
roi	ROI

Returns: If successful, returns SbError.SB_ERR_NONE. Otherwise, it returns an error code SbError.

See also: sb_project_detection

◆ GetInfo()

SbProjectInfo sb_cs::SbProject::GetInfo ( )

Gets the project information from the handle.

Returns: An instance to the SbProjectInfo class or null in case of memory error.

See also: sb_project_get_info

◆ GetName()

String sb_cs::SbProject::GetName ( )

Retrieves the project name

Returns: An instance to the String class or null in case of memory error.

See also: sb_project_get_name

◆ GetNotes()

String sb_cs::SbProject::GetNotes ( )

Retrieves the project notes

Returns: An instance to the String class or null in case of memory error.

See also: sb_project_get_notes

◆ GetPar()

SbPar sb_cs::SbProject::GetPar ( )

Retrieves the project parameters structure.

Returns: An instance to the SbPar class or null in case of memory error.
The instance returned is valid only if the SbPar.Error() is equal to SbError::SB_ERR_NONE, otherwise an error occurred.
You must call the Dispose() method to free all the resources of the returned instance.

See also: sb_project_get_par

◆ GetRes()

SbRes sb_cs::SbProject::GetRes ( bool details )

Retrieves the results of the last processed image

Parameters

details If true the function also exports the details for each sample for Retina projects and the vote plane of the models for Surface and Deep Surface projects

Returns: An instance to the SbRes class or null in case of memory error.

See also: sb_project_get_res

◆ GetSensitivity()

float sb_cs::SbProject::GetSensitivity	(	String ^	model_name,
		float	scale
	)

Gets the classification threshold from the project handle.

Parameters

model_name	Model name
scale	Scale value. Not used for Retina projects.

Returns: The sensitivity value

See also: sb_project_get_sensitivity

◆ GetSvlVersion()

SbVersion sb_cs::SbProject::GetSvlVersion ( )

Retrieves the SVL version

Returns: An instance to the SbVersion class or null in case of memory error.

See also: sb_project_get_svl_version

◆ Invalidate()

SbError sb_cs::SbProject::Invalidate	(	String ^	model_name,
		float	scale
	)

Eliminates the training of the models.

Parameters

model_name	Name of the model to be invalidated. If NULL all models will be invalidated.
scale	Level / Scale to be invalidated. If 0 all levels will be invalidated. (used only for Surface projects)

Returns: If successful, returns SbError.SB_ERR_NONE. Otherwise, it returns an error code SbError.

See also: sb_project_invalidate

◆ LicenseConfigurationCheck()

String sb_cs::SbProject::LicenseConfigurationCheck ( SbLicenseConfigurationId id )

Checks if the project can be used with a license configuration.

Parameters

id	License configuration id

Returns: An instance to the String class or null in case of memory error.

◆ Load()

static SbProject sb_cs::SbProject::Load	(	String^	solution_file,
		String^	project_uuid,
		SbProjectMode	mode
	)

static

Loads an existing project from file.

Parameters

solution_file	Filename of the project to load
project_uuid	uuid of the project. To get the project uuid use the function SbSolutionInfo.GetInfo
mode	Loading mode of the project from a solution file

Returns: An instance to the SbProject class or null in case of memory error.
The instance returned is valid only if the SbProject.Error() is equal to SbError::SB_ERR_NONE, otherwise an error occurred.
You must call the Dispose() method to free all the resources of the returned instance.

See also: sb_project_load

◆ Save()

SbError sb_cs::SbProject::Save	(	String^	solution_file,
		SbProjectMode	mode
	)

Saves the project to file

Parameters

solution_file	Filename of the solution where to save the project
mode	Saving mode of the project into a solution file

Returns: If successful, returns SbError.SB_ERR_NONE. Otherwise, it returns an error code SbError.

See also: sb_project_save

◆ SetName()

SbError sb_cs::SbProject::SetName ( String^ name )

Sets the project name

Parameters

name

Returns: If successful, returns SbError.SB_ERR_NONE. Otherwise, it returns an error code SbError.

See also: sb_project_set_name

◆ SetNotes()

SbError sb_cs::SbProject::SetNotes ( String ^ notes )

Sets the project notes

Parameters

notes

Returns: If successful, returns SbError.SB_ERR_NONE. Otherwise, it returns an error code SbError.

See also: sb_project_set_notes

◆ SetPar()

SbError sb_cs::SbProject::SetPar ( SbPar^ par )

Sets the project parameters.

Parameters

par	Parameters

Returns: If successful, returns SbError.SB_ERR_NONE. Otherwise, it returns an error code SbError.

See also: sb_project_set_par

◆ SetSensitivity()

SbError sb_cs::SbProject::SetSensitivity	(	String ^	model_name,
		float	scale,
		float	sensitivity
	)

Sets the classification threshold from the project handle.

Parameters

model_name	Model name
scale	Scale value. Not used for Retina projects.
sensitivity

Returns: If successful, returns SbError.SB_ERR_NONE. Otherwise, it returns an error code SbError.

See also: sb_project_set_sensitivity

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

cs_project.h

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ CheckTrained()

◆ Clone()

◆ Create()

◆ Detection()

◆ GetInfo()

◆ GetName()

◆ GetNotes()

◆ GetPar()

◆ GetRes()

◆ GetSensitivity()

◆ GetSvlVersion()

◆ Invalidate()

◆ LicenseConfigurationCheck()

◆ Load()

◆ Save()

◆ SetName()

◆ SetNotes()

◆ SetPar()

◆ SetSensitivity()