SqueezeBrains SDK 1.13
sb_cs::SbPar Class Reference

Parameters Class that wraps the sb_t_par structure.
You must call the Dispose() method to free all the resources of the returned instance. More...

#include <cs_par.h>

Inheritance diagram for sb_cs::SbPar:
Collaboration diagram for sb_cs::SbPar:

Public Member Functions

SbError AddModel (String^ model_name)
 Adds the model to the parameter structure. More...
 
SbError RemoveModel (String^ model_name)
 Removes the model from the parameter structure. More...
 
SbError AddLevel (String^ model_name, float scale)
 Adds the level to the parameter structure. More...
 
SbError RemoveLevel (String^ model_name, float scale)
 Removes the l-th level from the structure of the project parameters. More...
 
SbError SetCollaboration (String^ model_name1, String^ model_name2, bool value)
 Sets collaboration between two models. More...
 
int GetCollaboration (String^ model_name1, String^ model_name2)
 Gets collaboration between two models. More...
 
String Format ()
 Formats the parameters string. 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 String FormatProjectType (SbProjectType value)
 Formats the project type More...
 
static String FormatImageCircularityType (SbImageCircularityType value)
 Formats the image circularity type More...
 
static String FormatFloatingPointPrecisionType (SbFloatingPointPrecisionType value)
 Formats the floating point precision More...
 
static String FormatNetworkType (SbNetworkType value)
 Formats the Deep Learning Network type More...
 
static String FormatLossFnType (SbLossFnType value)
 Formats the Deep Learning Loss function type More...
 
static String FormatSvlParOptimizationMode (SbSvlParOptimizationMode value)
 Formats the Shallow Learning SVL optimization mode More...
 
static String FormatPerturbationMode (SbPerturbationMode value)
 Formats the Deep Learning SVL image perturbation mode More...
 
static String FormatPerturbationType (SbPerturbationType value)
 Formats the Deep Learning SVL image perturbation type More...
 
- Static Public Member Functions inherited from sb_cs::SbCommon
static String FormatError (SbError error)
 Returns the error message. More...
 

Data Fields

SbProjectType project_type
 Project type More...
 
array< SbParModel^> models
 Array of the models parameters More...
 
array< unsigned char, 2 > collaborations
 Matrix of the models collaborations More...
 
int num_threads
 Num threads to be used for the detection More...
 
SbBlobPar blob_par
 Blob analysis parameters. Used only for Surface projects More...
 
SbDevicesPar devices
 Devices used for inference. More...
 
SbInterpolationMode resize_mode
 Interpolation mode used to resize the images. More...
 
SbFloatingPointPrecisionType floating_point_precision
 Floating point precision used to run operations during detection. More...
 
SbRgba color_opt
 Optional all models color. Used for painting More...
 
int surface_blob_analysis
 Enable the surface blob analysis More...
 
SbParSl sl
 Shallow Learning modules parameters More...
 
SbSvlPar svl
 SVL parameters More...
 

Detailed Description

Parameters Class that wraps the sb_t_par structure.
You must call the Dispose() method to free all the resources of the returned instance.

Definition at line 656 of file cs_par.h.

Member Function Documentation

◆ AddLevel()

SbError sb_cs::SbPar::AddLevel ( String^  model_name,
float  scale 
)

Adds the level to the parameter structure.

Parameters
model_nameModel for which the level shoud be added. If NULL the level is added to all the models
scaleScale of the level to be added.
Returns
If successful, returns SbError.SB_ERR_NONE. Otherwise, it returns an error code SbError.
See also
sb_par_add_level

◆ AddModel()

SbError sb_cs::SbPar::AddModel ( String^  model_name)

Adds the model to the parameter structure.

Parameters
model_nameModel name
Returns
If successful, returns SbError.SB_ERR_NONE. Otherwise, it returns an error code SbError.
See also
sb_par_add_model

◆ Format()

String sb_cs::SbPar::Format ( )

Formats the parameters string.

Returns
An instance to the String class or null in case of memory error.
See also
sb_par_format

◆ FormatFloatingPointPrecisionType()

static String sb_cs::SbPar::FormatFloatingPointPrecisionType ( SbFloatingPointPrecisionType  value)
static

Formats the floating point precision

Parameters
valueFloating point precision type type
Returns
An instance to the String class or null in case of memory error.
See also
sb_floating_point_precision_type_format

◆ FormatImageCircularityType()

static String sb_cs::SbPar::FormatImageCircularityType ( SbImageCircularityType  value)
static

Formats the image circularity type

Parameters
valueImage circularity type
Returns
An instance to the String class or null in case of memory error.
See also
sb_image_circularity_type_format

◆ FormatLossFnType()

static String sb_cs::SbPar::FormatLossFnType ( SbLossFnType  value)
static

Formats the Deep Learning Loss function type

Parameters
valueLoss function type
Returns
An instance to the String class or null in case of memory error.
See also
sb_loss_fn_type_format

◆ FormatNetworkType()

static String sb_cs::SbPar::FormatNetworkType ( SbNetworkType  value)
static

Formats the Deep Learning Network type

Parameters
valueNetwork type
Returns
An instance to the String class or null in case of memory error.
See also
sb_network_type_format

◆ FormatPerturbationMode()

static String sb_cs::SbPar::FormatPerturbationMode ( SbPerturbationMode  value)
static

Formats the Deep Learning SVL image perturbation mode

Parameters
valuePerturbation mode
Returns
An instance to the String class or null in case of memory error.
See also
sb_perturbation_mode_format

◆ FormatPerturbationType()

static String sb_cs::SbPar::FormatPerturbationType ( SbPerturbationType  value)
static

Formats the Deep Learning SVL image perturbation type

Parameters
valuePerturbation type
Returns
An instance to the String class or null in case of memory error.
See also
sb_perturbation_type_format

◆ FormatProjectType()

static String sb_cs::SbPar::FormatProjectType ( SbProjectType  value)
static

Formats the project type

Parameters
valueProject type
Returns
An instance to the String class or null in case of memory error.
See also
sb_project_type_format

◆ FormatSvlParOptimizationMode()

static String sb_cs::SbPar::FormatSvlParOptimizationMode ( SbSvlParOptimizationMode  value)
static

Formats the Shallow Learning SVL optimization mode

Parameters
valueOptimization type
Returns
An instance to the String class or null in case of memory error.
See also
sb_svl_par_optimization_mode_format

◆ GetCollaboration()

int sb_cs::SbPar::GetCollaboration ( String^  model_name1,
String^  model_name2 
)

Gets collaboration between two models.

Parameters
model_name1Name of the first model.
model_name2Name of the second model.
Returns
See also
sb_par_get_collaboration

◆ RemoveLevel()

SbError sb_cs::SbPar::RemoveLevel ( String^  model_name,
float  scale 
)

Removes the l-th level from the structure of the project parameters.

Parameters
model_nameModel for which the level shoud be removed. If NULL the level is removed from all the models
scaleScale of the level to be removed
Returns
If successful, returns SbError.SB_ERR_NONE. Otherwise, it returns an error code SbError.
See also
sb_par_remove_level

◆ RemoveModel()

SbError sb_cs::SbPar::RemoveModel ( String^  model_name)

Removes the model from the parameter structure.

Parameters
model_nameModel name
Returns
If successful, returns SbError.SB_ERR_NONE. Otherwise, it returns an error code SbError.
See also
sb_par_remove_model

◆ SetCollaboration()

SbError sb_cs::SbPar::SetCollaboration ( String^  model_name1,
String^  model_name2,
bool  value 
)

Sets collaboration between two models.

Parameters
model_name1Name of the first model.
model_name2Name of the second model.
valuetrue: models are collaborative, false: models are not collaborative.
Returns
If successful, returns SbError.SB_ERR_NONE. Otherwise, it returns an error code SbError.
See also
sb_par_set_collaboration

Field Documentation

◆ blob_par

SbBlobPar sb_cs::SbPar::blob_par

Blob analysis parameters. Used only for Surface projects

See also
sb_t_par.blob_par

Definition at line 687 of file cs_par.h.

◆ collaborations

array<unsigned char, 2> sb_cs::SbPar::collaborations

Matrix of the models collaborations

See also
sb_t_par.collaborations

Definition at line 675 of file cs_par.h.

◆ color_opt

SbRgba sb_cs::SbPar::color_opt

Optional all models color. Used for painting

See also
sb_t_par.color_opt

Definition at line 711 of file cs_par.h.

◆ devices

SbDevicesPar sb_cs::SbPar::devices

Devices used for inference.

See also
sb_t_par.devices

Definition at line 693 of file cs_par.h.

◆ floating_point_precision

SbFloatingPointPrecisionType sb_cs::SbPar::floating_point_precision

Floating point precision used to run operations during detection.

See also
sb_t_par.resize_mode

Definition at line 705 of file cs_par.h.

◆ models

array<SbParModel^> sb_cs::SbPar::models

Array of the models parameters

See also
sb_t_par.models

Definition at line 669 of file cs_par.h.

◆ num_threads

int sb_cs::SbPar::num_threads

Num threads to be used for the detection

See also
sb_t_par.num_threads

Definition at line 681 of file cs_par.h.

◆ project_type

SbProjectType sb_cs::SbPar::project_type

Project type

See also
sb_t_par.project_type

Definition at line 663 of file cs_par.h.

◆ resize_mode

SbInterpolationMode sb_cs::SbPar::resize_mode

Interpolation mode used to resize the images.

See also
sb_t_par.resize_mode

Definition at line 699 of file cs_par.h.

◆ sl

SbParSl sb_cs::SbPar::sl

Shallow Learning modules parameters

See also
sb_t_par.sl

Definition at line 723 of file cs_par.h.

◆ surface_blob_analysis

int sb_cs::SbPar::surface_blob_analysis

Enable the surface blob analysis

See also
sb_t_par.surface_blob_analysis

Definition at line 717 of file cs_par.h.

◆ svl

SbSvlPar sb_cs::SbPar::svl

SVL parameters

See also
sb_t_par.svl

Definition at line 729 of file cs_par.h.


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