SqueezeBrains SDK 1.18
Samples

Samples interface. More...

Collaboration diagram for Samples:

Data Structures

class  sb_cs::SbSampleWeightsImage
 Sample weight image Class that wraps the sb_t_sample_weights_image structure. More...
 
class  sb_cs::SbSample
 Sample class that wraps the sb_t_sample structure. More...
 

Enumerations

enum class  sb_cs::SbTruth : int {
  sb_cs::SbTruth::SB_TRUTH_UNDEFINED = SB_TRUTH_UNDEFINED , sb_cs::SbTruth::SB_TRUTH_TRUE_POSITIVE = SB_TRUTH_TRUE_POSITIVE , sb_cs::SbTruth::SB_TRUTH_TRUE_NEGATIVE = SB_TRUTH_TRUE_NEGATIVE , sb_cs::SbTruth::SB_TRUTH_FALSE_POSITIVE = SB_TRUTH_FALSE_POSITIVE ,
  sb_cs::SbTruth::SB_TRUTH_FALSE_NEGATIVE = SB_TRUTH_FALSE_NEGATIVE , sb_cs::SbTruth::SB_TRUTH_OPTIONAL_POSITIVE = SB_TRUTH_OPTIONAL_POSITIVE , sb_cs::SbTruth::SB_TRUTH_OPTIONAL_NEGATIVE = SB_TRUTH_OPTIONAL_NEGATIVE , sb_cs::SbTruth::SB_TRUTH_OUT_OF_ROI = SB_TRUTH_OUT_OF_ROI ,
  sb_cs::SbTruth::SB_TRUTH_MODEL_DISABLED = SB_TRUTH_MODEL_DISABLED
}
 Sample truth values that wraps the sb_t_truth enum More...
 
enum class  sb_cs::SbSampleClassifyMode { sb_cs::SbSampleClassifyMode::SB_SAMPLE_REQUIRED = SB_SAMPLE_REQUIRED , sb_cs::SbSampleClassifyMode::SB_SAMPLE_OPTIONAL = SB_SAMPLE_OPTIONAL }
 Sample classify mode that wraps the sb_t_sample_classify_mode enum More...
 
enum class  sb_cs::SbObjType : int { sb_cs::SbObjType::SB_OBJ_TEST = SB_OBJ_TEST , sb_cs::SbObjType::SB_OBJ_LEARNING = SB_OBJ_LEARNING }
 Sample object type that wrpas the sb_t_obj_type enum More...
 

Detailed Description

Samples interface.

Enumeration Type Documentation

◆ SbObjType

enum class sb_cs::SbObjType : int
strong

Sample object type that wrpas the sb_t_obj_type enum

Enumerator
SB_OBJ_TEST 

Object is not used for learning.

SB_OBJ_LEARNING 

Object is used for learning.

Definition at line 102 of file cs_sample.h.

◆ SbSampleClassifyMode

enum class sb_cs::SbSampleClassifyMode
strong

Sample classify mode that wraps the sb_t_sample_classify_mode enum

Enumerator
SB_SAMPLE_REQUIRED 

The sample must be found, otherwise it will be classified as False Negative.

SB_SAMPLE_OPTIONAL 

The positive sample is optional in the sense that if it is found it is classified as Optional Positive, otherwise as Optional Negative. Another way to define an optional sample is a "border line" or a "boundary" sample, in the sense, it is not clear if it is a positive or negative instance, if it is a good or bad sample.

Definition at line 83 of file cs_sample.h.

◆ SbTruth

enum class sb_cs::SbTruth : int
strong

Sample truth values that wraps the sb_t_truth enum

Enumerator
SB_TRUTH_UNDEFINED 

Truth not defined.

SB_TRUTH_TRUE_POSITIVE 

Truth True Positive.

It is an occurrences with positive weight.

SB_TRUTH_TRUE_NEGATIVE 

Truth True Negative.

In case of "Retina" detection it is used:

  • an occurrence with negative weight. It can happen when the parameter sb_t_par_model::num_occurrences has a value other than 0.
  • to classify an image that meets the following conditions:
    • there are no occurrences
    • all required samples have disabled models
    • the optional samples are ignored In case of "Surface" it is the sample of the background.
SB_TRUTH_FALSE_POSITIVE 

Truth False Positive.

A object occurrence was found in a wrong place, or it was identified with the wrong model.

SB_TRUTH_FALSE_NEGATIVE 

Truth False Negative.

A object occurrence wasn't found.

SB_TRUTH_OPTIONAL_POSITIVE 

Truth Optional Positive.

A optional sample with positive weight.

SB_TRUTH_OPTIONAL_NEGATIVE 

Truth Optional Negative.

A optional sample with negative weight.

SB_TRUTH_OUT_OF_ROI 

Truth Out Of ROI.

The sample is out of the ROI and then it is not found, but it cannot become a False Negative.
In this case the object will not be considered in the statistic.

SB_TRUTH_MODEL_DISABLED 

A sample of a disabled model.

Definition at line 19 of file cs_sample.h.