Collection of functions to manage the image information file associated to an image. More...

Collaboration diagram for Image information file:

Data Structures
struct	sb_t_image_info_detail
	Image information details structure. More...

struct	sb_t_image_info_details
	Array of the image information details structure. More...

Macros
#define	SB_IMAGE_INFO_EXT "rtn"
	Extension of the image information file associated to an image. More...

Enumerations
enum	sb_t_image_info_type { SB_IMAGE_INFO_TYPE_NONE = 0 , SB_IMAGE_INFO_TYPE_TEST , SB_IMAGE_INFO_TYPE_SVL , SB_IMAGE_INFO_TYPE_SVL_USED }
	Defines the type of the image. More...

Functions
sb_t_err	sb_image_info_get_version (const char const image_file, sb_t_version version, char *const version_str, int size_version_str)
	Gets the version of the image information file. More...

sb_t_err	sb_image_info_get_details (const char const image_file, sb_t_image_info_details *details)
	Load the file and get the array of the image info details. More...

sb_t_err	sb_image_info_destroy_details (sb_t_image_info_details **const details)
	Destroys the array of the images info details. More...

sb_t_err	sb_image_info_change_project (const char const image_file, const sb_t_project_info const project_info_old, SB_HANDLE module_handle_new)
	Change the project to the data associated to the image. More...

sb_t_err	sb_image_info_remove_project (const char const image_file, const char const project_uuid)
	Remove the project with the specified UUID from the data associated to the image. More...

sb_t_err	sb_image_info_load (SB_HANDLE image_info, const char const image_file, SB_HANDLE module_handle)
	Creates a SqueezeBrains image info handle. More...

sb_t_err	sb_image_info_destroy (SB_HANDLE *image_info)
	Destroys the SqueezeBrains image info handle. More...

sb_t_err	sb_image_info_save (SB_HANDLE image_info)
	Saves the SqueezeBrains image info handle into the image file. More...

sb_t_err	sb_image_info_clone (SB_HANDLE src, SB_HANDLE *pdst, SB_HANDLE module_handle)
	Clones the SqueezeBrains image info. More...

sb_t_err	sb_image_info_copy_labeling (SB_HANDLE dst, const char const image_file, const sb_t_project_info src_prj, int roi, int ground_truth, int *copied)
	Copies the labeling information from the src project into the destination image info. More...

sb_t_err	sb_image_info_add_sample (SB_HANDLE image_info, const sb_t_sample *const sample)
	Adds a sample into the SqueezeBrains image info handle. More...

sb_t_err	sb_image_info_set_samples (SB_HANDLE image_info, const sb_t_samples *const samples)
	Saves the samples in the corresponding SqueezeBrains image info handle. More...

sb_t_err	sb_image_info_get_samples (SB_HANDLE image_info, sb_t_samples **const samples)
	Get the samples of an image from the corresponding SqueezeBrains image info handle. More...

sb_t_err	sb_image_info_check_samples (const sb_t_samples *const samples, SB_HANDLE project, SB_HANDLE image_info, sb_t_size image_size)
	Check the correctness of the samples metadata. More...

sb_t_err	sb_image_info_reset (SB_HANDLE image_info)
	Erases all the data from the SqueezeBrains image info handle. More...

sb_t_err	sb_image_info_set_type (SB_HANDLE image_info, sb_t_image_info_type type)
	Sets the type of the SqueezeBrains image info. More...

sb_t_err	sb_image_info_get_type (SB_HANDLE image_info, const char const model_name, sb_t_image_info_type const type)
	Retrieves the SqueezeBrains image info handle type. More...

sb_t_err	sb_image_info_get_tiles_svl (SB_HANDLE handle, sb_t_tiles_info **const ptiles)
	Retrieves the svl tiles information. More...

sb_t_err	sb_image_info_get_project_info (SB_HANDLE handle, sb_t_project_info *const project_info)
	Retrieves the project information. More...

sb_t_err	sb_image_info_set_notes (SB_HANDLE image_info, const char *const str)
	Set a note into SqueezeBrains image info handle. More...

sb_t_err	sb_image_info_get_notes (SB_HANDLE image_info, char **const str)
	Gets the note from the SqueezeBrains image info handle. More...

sb_t_err	sb_image_info_get_name (SB_HANDLE image_info, char *const str, int str_size)
	Retrieves the name of the image. More...

sb_t_err	sb_image_info_set_results (SB_HANDLE image_info, const sb_t_res *const res)
	Set the results of the detection in the image info handle. More...

sb_t_err	sb_image_info_get_results (SB_HANDLE image_info, sb_t_res **const res, int compressed)
	Get the results of the detection from the image info handle. More...

sb_t_err	sb_image_info_set_project_name (SB_HANDLE image_info, const char *const project_name)
	Set the project name in the image info handle. More...

sb_t_err	sb_image_info_apply_par_changes (SB_HANDLE image_info, const sb_t_par_changes_info *info)
	Apply the par changes to the SqueezeBrains image info handle. More...

sb_t_err	sb_image_info_set_roi (SB_HANDLE image_info, const sb_t_roi *const roi)
	Sets the ROI in a SqueezeBrains image info handle. More...

sb_t_err	sb_image_info_get_roi (SB_HANDLE image_info, sb_t_roi **const roi, int width, int height, int compressed)
	Gets the ROI from a SqueezeBrains image info handle. More...

sb_t_err	sb_image_info_set_roi_defects (SB_HANDLE image_info, const sb_t_roi *const defects)
	Sets the surface defects ROI on a SqueezeBrains image info handle. More...

sb_t_err	sb_image_info_get_roi_defects (SB_HANDLE image_info, sb_t_roi **const defects, int width, int height, int compressed)
	Gets the surface defects ROI from a SqueezeBrains image info handle. More...

sb_t_err	sb_image_info_get_custom_par_root (SB_HANDLE handle, SB_HANDLE *node_root)
	Returns the xml root node of your own custom parameters. More...

Detailed Description

Collection of functions to manage the image information file associated to an image.

See also: Management of information relative to an image

Macro Definition Documentation

◆ SB_IMAGE_INFO_EXT

#define SB_IMAGE_INFO_EXT "rtn"

Extension of the image information file associated to an image.

See also: Management of information relative to an image.

Definition at line 13364 of file sb.h.

Enumeration Type Documentation

◆ sb_t_image_info_type

enum sb_t_image_info_type

Defines the type of the image.

It determines how image is used by that project.
If it is not used its value is SB_IMAGE_INFO_TYPE_NONE . The values are 32 bits both for 32 and 64 bits library version.

See also: sb_image_info_get_type

Enumerator
SB_IMAGE_INFO_TYPE_NONE	Image is not used.
SB_IMAGE_INFO_TYPE_TEST	Image is used for test.
SB_IMAGE_INFO_TYPE_SVL	Image is used for SVL and not used for training.
SB_IMAGE_INFO_TYPE_SVL_USED	Read-only value. Image is used for SVL and for training.

Definition at line 13373 of file sb.h.

Function Documentation

◆ sb_image_info_add_sample()

sb_t_err sb_image_info_add_sample	(	SB_HANDLE	image_info,
		const sb_t_sample *const	sample
	)

Adds a sample into the SqueezeBrains image info handle.

Parameters

[in]	image_info	SqueezeBrains image info handle.
[in]	sample	Pointer to the structure of the sample.

Returns: If successful, returns SB_ERR_NONE. Otherwise, it returns an error code sb_t_err.
The function returns the SB_ERR_PROJECT_TYPE error with Surface && Deep Surface projects.

See also: Management of information relative to an image

◆ sb_image_info_apply_par_changes()

sb_t_err sb_image_info_apply_par_changes	(	SB_HANDLE	image_info,
		const sb_t_par_changes_info *	info
	)

Apply the par changes to the SqueezeBrains image info handle.

The function updates the samples and the defects ROI of the image info according to the info passed.

Parameters

[in]	image_info	SqueezeBrains image info handle.
[in]	info	Information about the parameters changes

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

See also: Management of information relative to an image; Solution and projects management

◆ sb_image_info_change_project()

sb_t_err sb_image_info_change_project	(	const char *const	image_file,
		const sb_t_project_info *const	project_info_old,
		SB_HANDLE	module_handle_new
	)

Change the project to the data associated to the image.

The function has two different behaviors:

if the type of project does not change all information is retained: analysis ROI, defect ROI and samples
if the type of project changes:
- the analysis ROI is always maintained with the exception of the case in which the new project is of the Deep Cortex type
- the defect roi is maintained only from Surface to Deep Surface and vice versa
- samples from Retina and Deep Cortex to Deep Retina are retained
  Parameters
  
  [in] image_file Name of the image file.
  
  [in] project_info_old Identification of the project to be changed.
  
  [in] module_handle_new Handle of new project.
  
  Returns
  If successful, returns SB_ERR_NONE. Otherwise, it returns an error code sb_t_err.
  
  See also
  Management of information relative to an image

◆ sb_image_info_check_samples()

sb_t_err sb_image_info_check_samples	(	const sb_t_samples *const	samples,
		SB_HANDLE	project,
		SB_HANDLE	image_info,
		sb_t_size	image_size
	)

Check the correctness of the samples metadata.

In the case that project is circular (sb_t_svl_par::sb_t_image_circularity_type equal to SB_IMAGE_CIRCULARITY_TYPE_HORIZONTAL ) the function manages the following cases:

a sample that is partially outside-left has negative coordinates and a sample that is partially outside-right has coordinates higher than image width.
a sample that is partially outside-left/outside-right has horizontal coordinates of the left vertices higher than right ones.

With a circular Retina project, the samples loaded by the sb_image_info_load function and returned by the sb_image_info_get_samples function which are outside-left have left vertices whith negative horizontal coordinates and those are outside-right have right vertices higher than image width.
The function checks the coordinates of vertices within 1 pixel.

Attention: The function must be called before sb_image_info_set_samples or sb_image_info_add_sample to verify the correctness of the metadata of the samples.

Parameters

[in]	samples	Puntatore ai campioni
[in]	project	SqueezeBrains project handle.
[in]	image_info	SqueezeBrains image info handle.
[in]	image_size	Image resolution

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

◆ sb_image_info_clone()

sb_t_err sb_image_info_clone	(	SB_HANDLE	src,
		SB_HANDLE *	pdst,
		SB_HANDLE	module_handle
	)

Clones the SqueezeBrains image info.

Parameters

[in]	src	The source image info handle.
[out]	pdst	The pointer to the new image info handle.
[in]	module_handle	The pointer to the project handle

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

See also: sb_project_load; sb_image_info_destroy; sb_image_info_load

◆ sb_image_info_copy_labeling()

sb_t_err sb_image_info_copy_labeling	(	SB_HANDLE	dst,
		const char *const	image_file,
		const sb_t_project_info *	src_prj,
		int	roi,
		int	ground_truth,
		int *	copied
	)

Copies the labeling information from the src project into the destination image info.

The information that may be copied is different according to the project type:

Retina: the ROI and samples associated to the object instances.
Deep Cortex: the sample associated to the image (if exists).
Surface/Deep Surface: the ROI and defects.

If the rtn source file doesn't exist the function returns without error.
The source and destination image must have the same resolution.

Parameters

[in]	dst	The destination image info handle.
[in]	image_file	Name of the image file of the source project.
[in]	src_prj	The source project information.
[in]	roi	Set to 1 if you need to copy ROI analysis.
[in]	ground_truth	Set to 1 if you need to copy ground truth (i.e. samples or ROI defects).
[out]	copied	This flag is set to 1 if the labeling info has been copied to the destination.

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

See also: sb_project_load; sb_image_info_destroy; sb_image_info_load

◆ sb_image_info_destroy()

sb_t_err sb_image_info_destroy ( SB_HANDLE * image_info )

Destroys the SqueezeBrains image info handle.

Parameters

[in,out] image_info SqueezeBrains image info handle. It is set to NULL.

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

See also: Management of information relative to an image; sb_image_info_load

◆ sb_image_info_destroy_details()

sb_t_err sb_image_info_destroy_details ( sb_t_image_info_details **const details )

Destroys the array of the images info details.

Parameters

[in,out] details Array of the images info details

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

See also: Management of information relative to an image; sb_image_info_get_details

◆ sb_image_info_get_custom_par_root()

sb_t_err sb_image_info_get_custom_par_root	(	SB_HANDLE	handle,
		SB_HANDLE *	node_root
	)

Returns the xml root node of your own custom parameters.

Attention: The handle returned by the function must not the destroyed.

Parameters

[in]	handle	SqueezeBrains image info handle.
[out]	node_root	The variable is filled with the xml root node of your own custom parameters. The handle returned by the function must not the destroyed.

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

See also: Management of information relative to an image; Manage custom parameters; sb_xml_node_get; sb_xml_node_get_child; sb_xml_node_next; sb_xml_node_add; sb_xml_node_set; sb_xml_node_get_name; sb_xml_node_set_attribute; sb_xml_node_get_attribute; sb_xml_node_set_itself; sb_xml_node_count; sb_xml_node_get_string; sb_xml_node_get_string_malloc; sb_xml_node_remove; sb_xml_node_remove_itself

◆ sb_image_info_get_details()

sb_t_err sb_image_info_get_details	(	const char *const	image_file,
		sb_t_image_info_details **	details
	)

Load the file and get the array of the image info details.

Parameters

[in]	image_file	Name of the image file.
[out]	details	Pointer to the array of the image info details.

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

See also: Management of information relative to an image; sb_image_info_destroy_details

◆ sb_image_info_get_name()

sb_t_err sb_image_info_get_name	(	SB_HANDLE	image_info,
		char *const	str,
		int	str_size
	)

Retrieves the name of the image.

Parameters

[in]	image_info	SqueezeBrains image info handle.
[out]	str	Pointer to the string.
[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.

See also: Management of information relative to an image

◆ sb_image_info_get_notes()

sb_t_err sb_image_info_get_notes	(	SB_HANDLE	image_info,
		char **const	str
	)

Gets the note from the SqueezeBrains image info handle.

Parameters

[in]	image_info	SqueezeBrains image info handle.
[out]	str	Pointer to the string. On successful return, this parameter will be filled with the pointer to the note. The pointer should be freed with sb_free .

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

See also: Management of information relative to an image; sb_image_info_set_notes

◆ sb_image_info_get_project_info()

sb_t_err sb_image_info_get_project_info	(	SB_HANDLE	handle,
		sb_t_project_info *const	project_info
	)

Retrieves the project information.

Parameters

[in]	handle	SqueezeBrains image info handle.
[out]	project_info	Pointer to the project information structure

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

◆ sb_image_info_get_results()

sb_t_err sb_image_info_get_results	(	SB_HANDLE	image_info,
		sb_t_res **const	res,
		int	compressed
	)

Get the results of the detection from the image info handle.

Parameters

[in]	image_info	SqueezeBrains image info handle.
[in]	res	Pointer to the result structure. The structure is allocated by the function and MUST be destroyed with sb_res_destroy.
[in]	compressed	If TRUE the results are compressed, otherwise they are decompressed

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

See also: Management of information relative to an image; sb_res_destroy; sb_image_info_set_results

◆ sb_image_info_get_roi()

sb_t_err sb_image_info_get_roi	(	SB_HANDLE	image_info,
		sb_t_roi **const	roi,
		int	width,
		int	height,
		int	compressed
	)

Gets the ROI from a SqueezeBrains image info handle.

In case the roi was not found in the image file:

if parameters width and height are greater that 0, a rectangular ROI with size (width, height) is created.
if parameters width and height are equal to 0, the roi is not created and the roi parameter remains NULL.
if parameters width and height are less than 0, a rectangular ROI with image size is created.
If the image does not exist, the function returns the error SB_ERR_FILE_NOT_EXIST.

The roi is completely filled with the value 255 if it is created by the function because it does not exist in the image.

Note: The function sets the parameter roi to NULL and does not return error with Deep Cortex projects.

Parameters

[in]	image_info	SqueezeBrains image info handle.
[out]	roi	Pointer to the pointer of the ROI. On successful return, this parameter will be updated with the pointer of the handle, or it could be NULL if the roi was not found in the image and the width and height parameters are equal to 0.
[in]	width	If the ROI isn't found in the image file, width of the created ROI
[in]	height	If the ROI isn't found in the image file, height of the created ROI
[in]	compressed	Set to 1 if you want to maintain the ROI in compressed format

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

See also: ROI management; Management of information relative to an image; sb_roi_destroy; sb_image_info_set_roi

◆ sb_image_info_get_roi_defects()

sb_t_err sb_image_info_get_roi_defects	(	SB_HANDLE	image_info,
		sb_t_roi **const	defects,
		int	width,
		int	height,
		int	compressed
	)

Gets the surface defects ROI from a SqueezeBrains image info handle.

In case the roi was not found in the image file:

if parameters width and height are greater that 0, a rectangular ROI with size (width, height) is created.
if parameters width and height are equal to 0, the roi is not created and the roi parameter remains NULL.
if parameters width and height are less that 0, a rectangular ROI with image size is created.
If the image does not exist, the function returns the error SB_ERR_FILE_NOT_EXIST.

The roi is completely filled with the value 0 if it does not exist in the image and was created by the function.

Note: The function sets defects parameter to NULL and does not return error with Retina and Deep Cortex projects.

Parameters

[out]	defects	Pointer to the pointer of the ROI defects. On successful return, this parameter will be updated with the pointer of the handle, or it could be NULL if the roi was not found in the image and the width and height parameters are equal to 0.
[in]	image_info	SqueezeBrains image info handle.
[in]	width	If the ROI isn't found in the image file, width of the created ROI
[in]	height	If the ROI isn't found in the image file, height of the created ROI
[in]	compressed	Set to 1 if you want to maintain the ROI in compressed format

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

See also: ROI management; Management of information relative to an image; sb_roi_destroy; sb_image_info_set_roi_defects

◆ sb_image_info_get_samples()

sb_t_err sb_image_info_get_samples	(	SB_HANDLE	image_info,
		sb_t_samples **const	samples
	)

Get the samples of an image from the corresponding SqueezeBrains image info handle.

Parameters

[in]	image_info	SqueezeBrains image info handle.
[out]	samples	Pointer to samples. On successful return, this parameter will be updated with the pointer of the structure sb_t_samples. The structure should freed using the function sb_samples_destroy .

Note: The function sets the parameter samples to NULL and does not return error with Surface and Deep Surface projects.

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

See also: Management of information relative to an image; sb_image_info_set_samples; sb_image_info_load; sb_samples_destroy

◆ sb_image_info_get_tiles_svl()

sb_t_err sb_image_info_get_tiles_svl	(	SB_HANDLE	handle,
		sb_t_tiles_info **const	ptiles
	)

Retrieves the svl tiles information.

If tiling is applied during training, you can know exactly how tiling grid is applied over the image and know which tiles have been used or not in the procedure.

Parameters

[in]	handle	SqueezeBrains image info handle.
[out]	ptiles	On successful return, this parameter will be filled with the pointer to the svl tiles information structure. The structure must be destroyed with the function sb_tiles_info_destroy .

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

See also: Management of information relative to an image; sb_tiles_info_destroy; sb_tiles_info_no_overlap

◆ sb_image_info_get_type()

sb_t_err sb_image_info_get_type	(	SB_HANDLE	image_info,
		const char *const	model_name,
		sb_t_image_info_type *const	type
	)

Retrieves the SqueezeBrains image info handle type.

If an image is in the SVL collection, you can know if the image is used or not for learning.

Warning: If you set the image type to SB_IMAGE_INFO_TYPE_SVL the function sb_image_info_get_type can return both SB_IMAGE_INFO_TYPE_SVL and SB_IMAGE_INFO_TYPE_SVL_USED.

Parameters

[in]	image_info	SqueezeBrains image info handle.
[in]	model_name	Name of the model to be considered. If NULL all models will be considered.
[out]	type	On successful return, this parameter will be filled with the image type.

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

See also: Management of information relative to an image; sb_image_info_set_type

◆ sb_image_info_get_version()

sb_t_err sb_image_info_get_version	(	const char *const	image_file,
		sb_t_version *	version,
		char *const	version_str,
		int	size_version_str
	)

Gets the version of the image information file.

Parameters

[in]	image_file	Name of the image file.
[out]	version	Pointer of the structure.
[out]	version_str	Pointer of the string. This parameter can be left to NULL if not necessary.
[in]	size_version_str	Size of the version_str string.

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

◆ sb_image_info_load()

sb_t_err sb_image_info_load	(	SB_HANDLE *	image_info,
		const char *const	image_file,
		SB_HANDLE	module_handle
	)

Creates a SqueezeBrains image info handle.

The function open the file with extension SB_IMAGE_INFO_EXT relative to the image.

image_file	Description
not exists	The function prepares an "image info handle" with uuid and type of the module_handle
exists	The function loads the information about the specified module_handle. If the project is not found, the function prepares an handle with uuid and type of the specified module_handle

Warning

The function does not return error if you pass the file with the SB_IMAGE_INFO_EXT extension instead of the image file name, but:

with the Deep Cortex projects, the vertex parameter of the samples cannot be valued and will be left at 0.
if the roi are not already present, the sb_image_info_get_roi and sb_image_info_set_roi_defects functions will return the SB_ERR_WRONG_PARAMETER error if they are called with parameter width and height less than 0.

Parameters

[out]	image_info	Pointer to the handle of SqueezeBrains image info. On successful return, this parameter will be updated with the pointer of the handle.
[in]	image_file	Name of the image file or of the SB_IMAGE_INFO_EXT file. The file may not exist.
[in]	module_handle	handle of the project, it cannot be NULL.

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

See also: Management of information relative to an image; sb_image_info_destroy; sb_image_info_save

◆ sb_image_info_remove_project()

sb_t_err sb_image_info_remove_project	(	const char *const	image_file,
		const char *const	project_uuid
	)

Remove the project with the specified UUID from the data associated to the image.

Parameters

[in]	image_file	Name of the image file.
[in]	project_uuid	UUID of the project to be removed.

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

See also: Management of information relative to an image; sb_image_info_get_details; sb_image_info_change_project

◆ sb_image_info_reset()

sb_t_err sb_image_info_reset ( SB_HANDLE image_info )

Erases all the data from the SqueezeBrains image info handle.

The function sets the type of the image to SB_IMAGE_INFO_TYPE_NONE .

Parameters

[in] image_info SqueezeBrains image info handle.

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

See also: Management of information relative to an image

◆ sb_image_info_save()

sb_t_err sb_image_info_save ( SB_HANDLE image_info )

Saves the SqueezeBrains image info handle into the image file.

Parameters

[in] image_info SqueezeBrains image info handle.

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

See also: Management of information relative to an image; sb_image_info_load

◆ sb_image_info_set_notes()

sb_t_err sb_image_info_set_notes	(	SB_HANDLE	image_info,
		const char *const	str
	)

Set a note into SqueezeBrains image info handle.

Parameters

[in]	image_info	SqueezeBrains image info handle.
[in]	str	String to be written. 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: Management of information relative to an image; sb_image_info_get_notes

◆ sb_image_info_set_project_name()

sb_t_err sb_image_info_set_project_name	(	SB_HANDLE	image_info,
		const char *const	project_name
	)

Set the project name in the image info handle.

Parameters

[in]	image_info	SqueezeBrains image info handle.
[in]	project_name	New project name to be set

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

See also: Management of information relative to an image; sb_project_set_name

◆ sb_image_info_set_results()

sb_t_err sb_image_info_set_results	(	SB_HANDLE	image_info,
		const sb_t_res *const	res
	)

Set the results of the detection in the image info handle.

Parameters

[in]	image_info	SqueezeBrains image info handle.
[in]	res	pointer to the result structure. If NULL the results of the image are deleted.

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

See also: Management of information relative to an image; sb_image_info_get_results

◆ sb_image_info_set_roi()

sb_t_err sb_image_info_set_roi	(	SB_HANDLE	image_info,
		const sb_t_roi *const	roi
	)

Sets the ROI in a SqueezeBrains image info handle.

The array of the roi is encoded with rle.

Parameters

[in]	image_info	SqueezeBrains image info handle.
[in]	roi	Pointer to the ROI.

Returns: If successful, returns SB_ERR_NONE. Otherwise, it returns an error code sb_t_err.
The function returns the SB_ERR_PROJECT_TYPE error with Deep Cortex projects.

See also: Management of information relative to an image; sb_image_info_get_roi

◆ sb_image_info_set_roi_defects()

sb_t_err sb_image_info_set_roi_defects	(	SB_HANDLE	image_info,
		const sb_t_roi *const	defects
	)

Sets the surface defects ROI on a SqueezeBrains image info handle.

The array of the roi is encoded with rle. The function returns the error SB_ERR_PROJECT_TYPE with Retina and Deep Cortex projects.

Parameters

[in]	defects	Pointer to the ROI.
[in]	image_info	SqueezeBrains image info handle.

Returns: If successful, returns SB_ERR_NONE. Otherwise, it returns an error code sb_t_err.
The function returns the SB_ERR_PROJECT_TYPE error with Retina && Deep Cortex projects.

See also: ROI management; Management of information relative to an image; sb_image_info_get_roi_defects

◆ sb_image_info_set_samples()

sb_t_err sb_image_info_set_samples	(	SB_HANDLE	image_info,
		const sb_t_samples *const	samples
	)

Saves the samples in the corresponding SqueezeBrains image info handle.

Parameters

[in]	image_info	SqueezeBrains image info handle.
[in]	samples	Pointer to the structure of the samples.

Returns: If successful, returns SB_ERR_NONE. Otherwise, it returns an error code sb_t_err.
The function returns the SB_ERR_PROJECT_TYPE error with Surface && Deep Surface projects.

See also: Management of information relative to an image; sb_image_info_get_samples; sb_image_info_check_samples

◆ sb_image_info_set_type()

sb_t_err sb_image_info_set_type	(	SB_HANDLE	image_info,
		sb_t_image_info_type	type
	)

Sets the type of the SqueezeBrains image info.

The function clears all the information set by SVL except the case where the image is already SB_IMAGE_INFO_TYPE_SVL or SB_IMAGE_INFO_TYPE_SVL_USED and type is SB_IMAGE_INFO_TYPE_SVL.
The function returns the error SB_ERR_WRONG_PARAMETER if type is equal to SB_IMAGE_INFO_TYPE_SVL_USED because only the sb_svl_run function can set this value.

Parameters

[in]	image_info	SqueezeBrains image info handle.
[in]	type	Type of the image

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

See also: Management of information relative to an image; SVL - training; sb_image_info_get_type

Data Structures

Macros

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ SB_IMAGE_INFO_EXT

Enumeration Type Documentation

◆ sb_t_image_info_type

Function Documentation

◆ sb_image_info_add_sample()

◆ sb_image_info_apply_par_changes()

◆ sb_image_info_change_project()

◆ sb_image_info_check_samples()

◆ sb_image_info_clone()

◆ sb_image_info_copy_labeling()

◆ sb_image_info_destroy()

◆ sb_image_info_destroy_details()

◆ sb_image_info_get_custom_par_root()

◆ sb_image_info_get_details()

◆ sb_image_info_get_name()

◆ sb_image_info_get_notes()

◆ sb_image_info_get_project_info()

◆ sb_image_info_get_results()

◆ sb_image_info_get_roi()

◆ sb_image_info_get_roi_defects()

◆ sb_image_info_get_samples()

◆ sb_image_info_get_tiles_svl()

◆ sb_image_info_get_type()

◆ sb_image_info_get_version()

◆ sb_image_info_load()

◆ sb_image_info_remove_project()

◆ sb_image_info_reset()

◆ sb_image_info_save()

◆ sb_image_info_set_notes()

◆ sb_image_info_set_project_name()

◆ sb_image_info_set_results()

◆ sb_image_info_set_roi()

◆ sb_image_info_set_roi_defects()

◆ sb_image_info_set_samples()

◆ sb_image_info_set_type()