CVBpy 14.0
ImageRegressionLabelInfo Class Reference

Regression label information. More...

Inherits object.

Public Member Functions

None add (self, cvb.Image src_image, cvb.Point2D extraction_location, int mode)
 Add a new sample to an existing class. More...
 
None relabel (self, List[float] label)
 Modify the label of a sample set, but not to one that already exists in the sample list. More...
 

Properties

 index = property
 int: Get the index of this label. More...
 
 label = property
 List[float]: Get label under which this class is stored. More...
 
 samples = property
 cvb.sample_database.ImageCollection: Get samples under this label.
 

Detailed Description

Regression label information.

Member Function Documentation

◆ add()

None add (   self,
cvb.Image  src_image,
cvb.Point2D  extraction_location,
int  mode 
)

Add a new sample to an existing class.

Parameters

src_image : cvb.Image Image from which to extract the sample for the class.

extraction_location : cvb.Point2D Location at which to extract the sample for the class. Note that what the extraction location actually refers dependent on the value of the mode parameter.

mode : int Interpretation hint for the extraction_location parameter (see cvb.SampleDatabase.SampleExtractionMode).

◆ relabel()

None relabel (   self,
List[float]  label 
)

Modify the label of a sample set, but not to one that already exists in the sample list.

Parameters

label : List[float] The new label.

Property Documentation

◆ index

index = property
static

int: Get the index of this label.

Note that this index may change when samples are removed from the image list - therefore you should check this index often. Generally it is more recommendable to work label based, not index based.

◆ label

label = property
static

List[float]: Get label under which this class is stored.

You may change this label, but not to one that already exists in the SampleList. To Merge labels in the SampleList use the merge method(s) of the sample list.