CVB.Net 14.0
TrainingSet.InstanceInfo Class Reference

InstanceInformation that has been added to a training set. More...

Inherits TrainingSet.TrainingSetObject.

Public Member Functions

override bool Equals (object obj)
 Comparison for the wrapper object for our unmanaged instance data should not be left to CLR. More...
 
unsafe override int GetHashCode ()
 Build a sensible hash value from the native handle. More...
 
double GetCorrelation ()
 Retrieve the correlation between this instance image and the model image. More...
 

Static Public Member Functions

static bool operator== (InstanceInfo lhs, InstanceInfo rhs)
 Comparison operator for instance information objects. More...
 
static bool operator!= (InstanceInfo lhs, InstanceInfo rhs)
 Comparison operator for instance information objects. More...
 

Protected Member Functions

override int GetIndex ()
 Index of this MTS instance inside the training set More...
 
override Image CreateImageRepresentation ()
 Creates the image used for representing this object. More...
 
abstract int GetIndex ()
 Method through which the inherited classes retrieve the index this object has in its "master" collection underneath the TrainingSet. More...
 
abstract Image CreateImageRepresentation ()
 Creates the image used for representing this object. More...
 

Properties

ImageInfo SourceImage [get]
 The image from which this instance has been trained. More...
 
Point2Dd Location [get]
 Position in the SourceImage from which this instance has been extracted. More...
 
ModelInfo Model [get]
 The Training Set Model into which this instance has been trained. More...
 
- Properties inherited from TrainingSet.TrainingSetObject
int Index [get]
 Index of this object in the parent's collection. More...
 
Image Image [get]
 Image representation of this object. More...
 

Additional Inherited Members

- Protected Attributes inherited from TrainingSet.TrainingSetObject
readonly IntPtr collectionParent_
 Native handle to the parent of the collection (which is not necessarily the training set!)
 

Detailed Description

InstanceInformation that has been added to a training set.

Member Function Documentation

◆ CreateImageRepresentation()

override Image CreateImageRepresentation ( )
protectedvirtual

Creates the image used for representing this object.

Returns
Image representing this object.

Implements TrainingSet.TrainingSetObject.

◆ Equals()

override bool Equals ( object  obj)

Comparison for the wrapper object for our unmanaged instance data should not be left to CLR.

Parameters
objObject to compare to.
Returns
true if this object and the object referred to by obj are to be considered equal (which in this case means that SourceImageand Location are identical), false otherwise.

◆ GetCorrelation()

double GetCorrelation ( )

Retrieve the correlation between this instance image and the model image.

Returns
Correlation result.

◆ GetHashCode()

unsafe override int GetHashCode ( )

Build a sensible hash value from the native handle.

Returns
The hash code for this object.

◆ GetIndex()

override int GetIndex ( )
protectedvirtual

Index of this MTS instance inside the training set

Returns
index

Implements TrainingSet.TrainingSetObject.

◆ operator!=()

static bool operator!= ( InstanceInfo  lhs,
InstanceInfo  rhs 
)
static

Comparison operator for instance information objects.

Parameters
lhsobject to compare
rhsobject to compare
Returns
false if the two objects refer to the same instance

◆ operator==()

static bool operator== ( InstanceInfo  lhs,
InstanceInfo  rhs 
)
static

Comparison operator for instance information objects.

Parameters
lhsobject to compare
rhsobject to compare
Returns
true if the two objects refer to the same instance

Property Documentation

◆ Location

Point2Dd Location
get

Position in the SourceImage from which this instance has been extracted.

Exceptions
ObjectDisposedExceptionIf the training set has already been disposed

◆ Model

ModelInfo Model
get

The Training Set Model into which this instance has been trained.

Exceptions
ObjectDisposedExceptionIf the training set has already been disposed

◆ SourceImage

ImageInfo SourceImage
get

The image from which this instance has been trained.

Exceptions
ObjectDisposedExceptionIf the training set has already been disposed