SampleClassificationImageList Class Reference

Classifier type that operates on images. More...

#include <sample_classification_image_list.hpp>

Inherits SampleImageList.

Public Member Functions
	SampleClassificationImageList (const SampleListImageDataType &imageDataType)
	Create a sample image list suitable for classification tasks.
	SampleClassificationImageList (const String &fileName)
	Load a sample classification image from a file.
ImageClassificationInfoCollectionPtr	Classes ()
	Get the class collection.
std::unique_ptr< SampleClassificationImageList >	Transform (DataTransformImageToImage transformCallback) const
	Transform this sample image list into a new sample image list by transforming each sample inside it.
std::unique_ptr< SampleClassificationImageList >	Transform (LabelTransformStringToString transformCallback) const
	Transform this sample image list into a new sample image list by transforming each label inside it.
std::unique_ptr< SampleRegressionImageList >	Transform (LabelTransformStringToVector transformCallback) const
	Transform this sample image list into a new sample image list by transforming each label inside it.
std::unique_ptr< ImageClassificationLabelInfo >	GetClassFromSample (int sampleIndex)
	Retrieve the label information that goes with a given sample.
void	GetIndicesForSampleIndex (int sampleIndex, int &clsIdx, int &splIdx) const
	For a given sample index (running from 0 to NumSamples()-1) this method determines the indices of the class and the sample inside the class.
Public Member Functions inherited from SampleImageList
class Fringes	Fringes () const
	Get fringes (= size difference between the images and the feature window) of the sample images.
Size2D< int >	FeatureWindowSize () const
	Size of the feature window.
Point2D< int >	FeatureWindowLocation () const
	Location of the feature window (position of left top corner inside the image).
Point2D< int >	FeatureWindowOrigin () const
	Location of the feature window origin in pixel coordinates measured from the left top corner of the feature window.
Size2D< int >	ImageSize () const
	Size of the images (in pixels) that can be added to the image list.
int	ImageDimension () const
	Dimension (# of planes) of the images that can be added to the image list.
DataType	ImageDataType () const
	Data type of the images that can be added to the image list (all planes must have same data type).
void	SetFeatureWindow (Point2D< int > location, Size2D< int > size, Point2D< int > origin)
	Redefine the feature window of the sample image list.
bool	IsCompatible (const Image &img) const
	Check whether a CVB image is compatible with this image list, i.e. if it is generally possible to add samples from that image to the list.
std::shared_ptr< Image >	GetSampleImage (int sampleIndex) const
	Retrieve an image by its overall sample index (ranging from 0 to NumSamples()-1).
Public Member Functions inherited from SampleList
void *	Handle () const noexcept
	Classic API SIL handle.
String	FileName () const
	Name of the file from which this image list was loaded (empty string if this image list was neither loaded nor saved since its construction).
String	Comment () const
	Get the comment text.
void	SetComment (String comment)
	Set the comment text.
std::chrono::system_clock::time_point	CreationDate () const
	Date on which the sample list was created.
std::chrono::system_clock::time_point	ModificationDate () const
	Date on which the sample list was modified.
int	NumClasses () const
	Number of distinguishable classes in the sample list.
int	NumSamples () const
	Total number of samples in the sample list.
int	MinSampleCount () const
	Number samples in the smallest class of the sample list.
int	MaxSampleCount () const
	Number samples in the largest class of the sample list.
double	AverageSampleCount () const
	Average number samples in per class of the sample list.
void	Save (const String &fileName) const
	Save the sample list to a file.

Static Public Member Functions
static std::unique_ptr< SampleClassificationImageList >	FromHandle (ReleaseObjectGuard &&guard, const String &fileName=String())
	Creates classification image list from a classic API handle.
static std::unique_ptr< SampleClassificationImageList >	ImportMantoSil (const String &fileName)
	Load a Manto2 sample list from disc.

Detailed Description

Classifier type that operates on images.

cvb/sample_database/sample_classification_image_list.hpp

Constructor & Destructor Documentation

SampleClassificationImageList() [1/2]

SampleClassificationImageList ( const SampleListImageDataType & imageDataType )

inlineexplicit

Create a sample image list suitable for classification tasks.

Parameters

[in]

imageDataType

Data type of the images to be added to the sample image list.

Exceptions

Any	exception derived from std::exception including CvbException.

SampleClassificationImageList() [2/2]

SampleClassificationImageList ( const String & fileName )

inlineexplicit

Load a sample classification image from a file.

Parameters

[in]

fileName

Name of the file to be loaded.

Exceptions

Any	exception derived from std::exception including CvbException.

Member Function Documentation

Classes()

ImageClassificationInfoCollectionPtr Classes ( )

inline

Get the class collection.

Returns

The classes.

Exceptions

Any	exception derived from std::exception including CvbException.

FromHandle()

static std::unique_ptr< SampleClassificationImageList > FromHandle ( ReleaseObjectGuard && guard, const String & fileName = String() )

inlinestatic

Creates classification image list from a classic API handle.

Parameters

[in]	guard	Life time guard for C-API handle.
[in]	fileName	The file name of the classifier.

Returns

The classification image list created from the classic API handle.

Exceptions

Any	exception derived from std::exception including CvbException.

The image list takes ownership of the handle, so you must share it before using this function.

GetClassFromSample()

std::unique_ptr< ImageClassificationLabelInfo > GetClassFromSample ( int sampleIndex )

inline

Retrieve the label information that goes with a given sample.

Parameters

[in]

sampleIndex

Index of the sample for which to retrieve the class information.

Returns

The indexed class.

Exceptions

Any	exception derived from std::exception including CvbException.

GetIndicesForSampleIndex()

void GetIndicesForSampleIndex ( int sampleIndex, int & clsIdx, int & splIdx ) const

inline

For a given sample index (running from 0 to NumSamples()-1) this method determines the indices of the class and the sample inside the class.

Parameters

[in]	sampleIndex	Sample index to get the indices for.
[out]	clsIdx	Class index (output).
[out]	splIdx	Sample index inside the class's sample collection (output).

Exceptions

Any	exception derived from std::exception including CvbException.

ImportMantoSil()

static std::unique_ptr< SampleClassificationImageList > ImportMantoSil ( const String & fileName )

inlinestatic

Load a Manto2 sample list from disc.

Parameters

[in]

fileName

File to import.

Returns

The imported Manto image list.

Exceptions

Any	exception derived from std::exception including CvbException.

Transform() [1/3]

std::unique_ptr< SampleClassificationImageList > Transform ( DataTransformImageToImage transformCallback ) const

inline

Transform this sample image list into a new sample image list by transforming each sample inside it.

Parameters

[in]

transformCallback

Sample transformation callback.

Returns

New sample list.

Exceptions

Any	exception derived from std::exception including CvbException.

Transform() [2/3]

std::unique_ptr< SampleClassificationImageList > Transform ( LabelTransformStringToString transformCallback ) const

inline

Transform this sample image list into a new sample image list by transforming each label inside it.

Parameters

[in]

transformCallback

Label transformation callback.

Returns

New sample list.

Exceptions

Any	exception derived from std::exception including CvbException.

Transform() [3/3]

std::unique_ptr< SampleRegressionImageList > Transform

(

LabelTransformStringToVector

transformCallback

)

const

Transform this sample image list into a new sample image list by transforming each label inside it.

Parameters

[in]

transformCallback

Label transformation callback.

Returns

New sample list.

Exceptions

Any	exception derived from std::exception including CvbException.