CVB++ 14.0
InstanceInfo Class Reference

Instance information that has been added to a training set. More...

#include <cvb/minos/training_set.hpp>

Public Member Functions

int Index () const
 Index of this object in the parent's collection. More...
 
std::unique_ptr< class ImageImage () const
 Image representation of this object. More...
 
ImageInfo SourceImage () const
 Retrieve the correlation between this instance image and the model image. More...
 
Point2D< double > Location () const
 Position in the SourceImage from which this instance has been extracted. More...
 
ModelInfo Model () const
 The Training Set Model into which this instance has been trained. More...
 
void * Handle () const noexcept
 Classic API MTSINSTANCE handle. More...
 

Detailed Description

Instance information that has been added to a training set.

Member Function Documentation

◆ Handle()

void * Handle ( ) const
inlinenoexcept

Classic API MTSINSTANCE handle.

Returns
Classic API handle.
Exceptions
Doesnot throw any exception.

It is normally not necessary to work with this handle.

◆ Image()

std::unique_ptr< class Image > Image ( ) const
inline

Image representation of this object.

Returns
Image representation.
Exceptions
Anyexception derived from std::exception including CvbException.

◆ Index()

int Index ( ) const
inline

Index of this object in the parent's collection.

Returns
Index in the collection.
Exceptions
Anyexception derived from std::exception including CvbException.

◆ Location()

Point2D< double > Location ( ) const
inline

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

Returns
Instance location.
Exceptions
Anyexception derived from std::exception including CvbException.

◆ Model()

ModelInfo Model ( ) const

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

Returns
Trained model information.
Exceptions
Anyexception derived from std::exception including CvbException.

◆ SourceImage()

ImageInfo SourceImage ( ) const

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

Returns
Correlation result.
Exceptions
Anyexception derived from std::exception including CvbException.

The image from which this instance has been trained.

Returns
Source image information.
Exceptions
Anyexception derived from std::exception including CvbException.