Parameters

Project Parameters. More...

Collaboration diagram for Parameters:

Data Structures
struct	sb_t_par_perturbation
	Describes the perturbation of a sample. More...
struct	sb_t_par_perturbations
	List of the perturbations of a sample. More...
struct	sb_t_par_level
	Level parameters. More...
struct	sb_t_par_levels
	Levels parameter array. More...
struct	sb_t_par_model
	Parameters of a model. More...
struct	sb_t_par_models
	Array of models parameters. More...
struct	sb_t_par_sl
	Shallow Learning modules parameters. More...
struct	sb_t_par
	Project parameters. More...

Functions
sb_t_err	sb_par_init (sb_t_par *const par, sb_t_project_type project_type)
	Initializes the fields of the structure. More...
sb_t_err	sb_par_add_model (sb_t_par *const par, const char *const model_name)
	Adds the model to the parameter structure. More...
sb_t_err	sb_par_remove_model (sb_t_par *const par, const char *const model_name)
	Removes the model from the structure of the project parameters. More...
sb_t_err	sb_par_add_level (sb_t_par *const par, const char *const model_name, float scale)
	Adds the level to the parameter structure. More...
sb_t_err	sb_par_remove_level (sb_t_par *const par, const char *const model_name, float scale)
	Removes the l-th level from the structure of the project parameters. More...
sb_t_err	sb_par_set_collaboration (sb_t_par *par, const char *const model_name_1, const char *const model_name_2, int value)
	Sets collaboration between two models. More...
sb_t_err	sb_par_get_collaboration (sb_t_par *par, const char *const model_name_1, const char *const model_name_2, int *const value)
	Retreives the collaboration between two models. More...
sb_t_err	sb_par_format (const sb_t_par *const par, char *const str, int str_size)
	Formats the parameters structure. More...
sb_t_err	sb_par_auto_tiling_get_img_range (sb_t_range *const range, int net_input_size, float scale, int tile)
	Calculates the scale range of the images to be processed compatible with the input size of the network, the scale factor and the number of tiles set. More...
const char *	sb_floating_point_precision_type_format (sb_t_floating_point_op_type type)
	Returns the string of the floating point precision type. More...
const char *	sb_interpolation_mode_format (sb_t_interpolation_mode mode)
	Returns the string of the interpolation mode. More...
const char *	sb_device_type_format (sb_t_device_type type)
	Returns the string of the device type. More...

Detailed Description

Project Parameters.

Function Documentation

sb_device_type_format()

const char * sb_device_type_format

(

sb_t_device_type

type

)

Returns the string of the device type.

Interprets the contents of the type and converts it to a C - string containing a human - readable version of the corresponding device type.
The string must not be freed.

Parameters

[in]

type

Device type.

Returns

A C - string containing the device type in a human - readable format.

sb_floating_point_precision_type_format()

const char * sb_floating_point_precision_type_format

(

sb_t_floating_point_op_type

type

)

Returns the string of the floating point precision type.

Interprets the contents of the type and converts it to a C - string containing a human - readable version of the corresponding type.
The string must not be freed.

Parameters

[in]

type

Floating point precision type.

Returns

A C - string containing the floating point precision type in a human - readable format.

sb_interpolation_mode_format()

const char * sb_interpolation_mode_format

(

sb_t_interpolation_mode

mode

)

Returns the string of the interpolation mode.

Interprets the contents of the mode and converts it to a C - string containing a human - readable version of the corresponding mode.
The string must not be freed.

Parameters

[in]

mode

Interpolation mode.

Returns

A C - string containing the interpolation mode in a human - readable format.

sb_par_add_level()

sb_t_err sb_par_add_level	(	sb_t_par *const	par,
		const char *const	model_name,
		float	scale
	)

Adds the level to the parameter structure.

Parameters

[in,out]	par	Pointer to the parameters structure.
[in]	model_name	Model for which the level shoud be added. If NULL the level is added to all the models
[in]	scale	Scale of the level to be added.

Returns

If successful, returns SB_ERR_NONE. Otherwise, it returns an error code sb_t_err.

See also

Levels

sb_par_remove_level

sb_par_add_model()

sb_t_err sb_par_add_model	(	sb_t_par *const	par,
		const char *const	model_name
	)

Adds the model to the parameter structure.

Parameters

[in,out]	par	Pointer to the parameters structure.
[in]	model_name	Name of the model to be added. The string must be compliant to UTF-8 format.

Returns

If successful, returns SB_ERR_NONE. Otherwise, it returns an error code sb_t_err.

See also

sb_par_remove_model

sb_par_auto_tiling_get_img_range()

sb_t_err sb_par_auto_tiling_get_img_range	(	sb_t_range *const	range,
		int	net_input_size,
		float	scale,
		int	tile
	)

Calculates the scale range of the images to be processed compatible with the input size of the network, the scale factor and the number of tiles set.

The function works in the hypothesis that the parameter sb_t_svl_dl_par::auto_tiling is enabled.
To get the correct value of the parameters net_input_size and scale use the function sb_project_get_par.
Example:

sb_t_par par;
sb_t_range width;
sb_t_range height;
// Get the parameters from the project.
sb_project_get_par(project, &par);
// Get the width image range for 3 tiles
sb_par_auto_tiling_get_img_range(&width, par.svl.dl.network.input_size.width, par.svl.dl.scale.width, 3);
// Get the height image range for 3 tiles
sb_par_auto_tiling_get_img_range(&height, par.svl.dl.network.input_size.height, par.svl.dl.scale.height, 3);

See Load a project from solution file to load a project.

Parameters

[out]	range	On successfull return the structure is filled with the image range size.
[in]	net_input_size	Input image size of the network (see sb_t_svl_dl_par_network::input_size).
[in]	scale	Image scale factor (see sb_t_svl_dl_par::scale).
[in]	tile	Number of tiles,

Returns

If successful, returns SB_ERR_NONE. Otherwise, it returns an error code sb_t_err.

See also

sb_project_get_par

sb_t_svl_dl_par::auto_tiling

sb_t_svl_dl_par::scale

sb_t_svl_dl_par_network::input_size

sb_par_format()

sb_t_err sb_par_format	(	const sb_t_par *const	par,
		char *const	str,
		int	str_size
	)

Formats the parameters structure.

Interprets the contents of par and converts it to a C-string containing a human-readable version of the corresponding structure.

Parameters

[in]	par	Pointer to the parameters structure.
[out]	str	Pointer to the string. On successful return, this parameter will be filled with a human-readable version of the parameters structure.
[in]	str_size	Number of bytes of the string str.

Returns

If successful, returns SB_ERR_NONE. Otherwise, it returns an error code sb_t_err.

sb_par_get_collaboration()

sb_t_err sb_par_get_collaboration	(	sb_t_par *	par,
		const char *const	model_name_1,
		const char *const	model_name_2,
		int *const	value
	)

Retreives the collaboration between two models.

Parameters

[in,out]	par	Pointer to the parameters structure.
[in]	model_name_1	Name of the first model.
[in]	model_name_2	Name of the second model.
[in]	value	Value of the collaboration between the two models.

Returns

If successful, returns SB_ERR_NONE. Otherwise, it returns an error code sb_t_err.

See also

sb_t_par::collaborations

sb_par_get_collaboration

sb_par_init()

sb_t_err sb_par_init	(	sb_t_par *const	par,
		sb_t_project_type	project_type
	)

Initializes the fields of the structure.

Parameters

[in,out]	par	Pointer to the parameters structure.
[in]	project_type	Project type.

Returns

If successful, returns SB_ERR_NONE. Otherwise, it returns an error code sb_t_err.

sb_par_remove_level()

sb_t_err sb_par_remove_level	(	sb_t_par *const	par,
		const char *const	model_name,
		float	scale
	)

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

Parameters

[in,out]	par	Pointer to the parameters structure.
[in]	model_name	Model for which the level shoud be removed. If NULL the level is removed from all the models
[in]	scale	Scale of the level to be removed.

Returns

If successful, returns SB_ERR_NONE. Otherwise, it returns an error code sb_t_err.

See also

Levels

sb_par_add_level

sb_par_remove_model()

sb_t_err sb_par_remove_model	(	sb_t_par *const	par,
		const char *const	model_name
	)

Removes the model from the structure of the project parameters.

Parameters

[in,out]	par	Pointer to the parameters structure.
[in]	model_name	Name of the model to be removed.

Returns

If successful, returns SB_ERR_NONE. Otherwise, it returns an error code sb_t_err.

See also

sb_par_add_model

sb_par_set_collaboration()

sb_t_err sb_par_set_collaboration	(	sb_t_par *	par,
		const char *const	model_name_1,
		const char *const	model_name_2,
		int	value
	)

Sets collaboration between two models.

Parameters

[in,out]	par	Pointer to the parameters structure.
[in]	model_name_1	Name of the first model.
[in]	model_name_2	Name of the second model.
[in]	value	Value = 1 models are collaborative, value=0 models are not collaborative.

Returns

If successful, returns SB_ERR_NONE. Otherwise, it returns an error code sb_t_err.

See also

sb_t_par::collaborations

sb_par_get_collaboration