SampleRegressionImageList Class Reference

Classifier type that operates on images. More...

#include <cvb/sample_database/sample_classification_image_list.hpp>

Inherits SampleImageList.

Public Member Functions
	SampleRegressionImageList (const SampleListImageDataType &imageDataType, int regressionDimension)
	Create a sample image list suitable for regression tasks. More...
	SampleRegressionImageList (const String &fileName)
	Load a sample regression image from a file. More...
int	RegressionDimension () const noexcept
	Get the dimension of the regression labels used in this sample image list. More...
ImageRegressionInfoCollectionPtr	Values ()
	Get the class collection. More...
std::unique_ptr< SampleRegressionImageList >	Transform (DataTransformImageToImage transformCallback) const
	Transform this sample image list into a new sample image list by transforming each sample inside it. More...
std::unique_ptr< SampleRegressionImageList >	Transform (LabelTransformVectorToVector transformCallback) const
	Transform this sample image list into a new sample image list by transforming each label inside it. More...
std::unique_ptr< SampleClassificationImageList >	Transform (LabelTransformVectorToString transformCallback) const
	Transform this sample image list into a new sample image list by transforming each label inside it. More...
std::unique_ptr< ImageRegressionLabelInfo >	GetValueForSample (int sampleIndex)
	Retrieve the label information that goes with a given sample. More...
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. More...
Size2D< int >	FeatureWindowSize () const
	Size of the feature window. More...
Point2D< int >	FeatureWindowLocation () const
	Location of the feature window (position of left top corner inside the image). More...
Point2D< int >	FeatureWindowOrigin () const
	Location of the feature window origin in pixel coordinates measured from the left top corner of the feature window. More...
Size2D< int >	ImageSize () const
	Size of the images (in pixels) that can be added to the image list. More...
int	ImageDimension () const
	Dimension (# of planes) of the images that can be added to the image list. More...
DataType	ImageDataType () const
	Data type of the images that can be added to the image list (all planes must have same data type). More...
void	SetFeatureWindow (Point2D< int > location, Size2D< int > size, Point2D< int > origin)
	Redefine the feature window of the sample image list. More...
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. More...
std::shared_ptr< Image >	GetSampleImage (int sampleIndex) const
	Retrieve an image by its overall sample index (ranging from 0 to NumSamples()-1). More...
Public Member Functions inherited from SampleList
void *	Handle () const noexcept
	Classic API SIL handle. More...
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). More...
String	Comment () const
	Get the comment text. More...
void	SetComment (String comment)
	Set the comment text. More...
std::chrono::system_clock::time_point	CreationDate () const
	Date on which the sample list was created. More...
std::chrono::system_clock::time_point	ModificationDate () const
	Date on which the sample list was modified. More...
int	NumClasses () const
	Number of distinguishable classes in the sample list. More...
int	NumSamples () const
	Total number of samples in the sample list. More...
int	MinSampleCount () const
	Number samples in the smallest class of the sample list. More...
int	MaxSampleCount () const
	Number samples in the largest class of the sample list. More...
double	AverageSampleCount () const
	Average number samples in per class of the sample list. More...
void	Save (const String &fileName) const
	Save the sample list to a file. More...

Static Public Member Functions
static std::unique_ptr< SampleRegressionImageList >	FromHandle (ReleaseObjectGuard &&guard, const String &fileName=String())
	Creates regression image list from a classic API handle. More...

Static Public Attributes
static constexpr int	RegressionDimensionMax = 16
	Maximum regression dimension to be used.

Detailed Description

Classifier type that operates on images.

Constructor & Destructor Documentation

SampleRegressionImageList() [1/2]

SampleRegressionImageList ( const SampleListImageDataType &  imageDataType, int  regressionDimension  )

inline

Create a sample image list suitable for regression tasks.

Parameters

[in]	imageDataType	Data type of the images to be added to the sample image list.
[in]	regressionDimension	Dimension of the regression vector. Must be greater than 0 and less than or equal RegressionDimensionMax.

Exceptions

Any	exception derived from std::exception including CvbException.

SampleRegressionImageList() [2/2]

SampleRegressionImageList ( const String &  fileName )

inlineexplicit

Load a sample regression 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

FromHandle()

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

inlinestatic

Creates regression image list from a classic API handle.

Parameters

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

Returns

The regression 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.

GetValueForSample()

std::unique_ptr< ImageRegressionLabelInfo > GetValueForSample ( int  sampleIndex )

inline

Retrieve the label information that goes with a given sample.

Parameters

[in]

sampleIndex

Index of the sample to retrieve the value for.

Returns

The regression label value for the sample referred to by sampleIndex

Exceptions

Any	exception derived from std::exception including CvbException.

RegressionDimension()

int RegressionDimension ( ) const

inlinenoexcept

Get the dimension of the regression labels used in this sample image list.

Returns

The regression dimension.

Exceptions

Does	not throw any exception.

Transform() [1/3]

std::unique_ptr< SampleRegressionImageList > 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

(

LabelTransformVectorToString

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.

Transform() [3/3]

std::unique_ptr< SampleClassificationImageList > Transform ( LabelTransformVectorToVector  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.

Values()

ImageRegressionInfoCollectionPtr Values ( )

inline

Get the class collection.

Returns

The values.

Exceptions

Any	exception derived from std::exception including CvbException.