SampleListImageDataType Class Reference

Descriptor for image data to be digested by an image list. More...

#include <cvb/sample_database/sample_list_image_data_type.hpp>

Public Member Functions
	SampleListImageDataType (Size2D< int > imageSize, int imageDimension, DataType imageDataType, Point2D< int > featureWindowOrigin, Point2D< int > featureWindowLoc, Size2D< int > featureWindowSize)
	Construct an image list data type descriptor for image lists that digest images. More...
	SampleListImageDataType (Size2D< int > imageSize, int imageDimension, DataType imageDataType, Point2D< int > featureWindowOrigin)
	Construct an image list data type descriptor for image lists that digest images. More...
void *	Handle () const noexcept
	Classic API SIL handle. More...
Size2D< int >	ImageSize () const noexcept
	Size of the images to be added to the image list. More...
int	ImageDimension () const noexcept
	Dimension of the images to be added to the image list. More...
DataType	ImageDataType () const noexcept
	Data type of the images to be added to the image list. More...
Size2D< int >	FeatureWindowSize () const noexcept
	Size of the feature window. More...
Point2D< int >	FeatureWindowLocation () const noexcept
	Location of the feature window (position of left top corner inside the image). More...
Point2D< int >	FeatureWindowOrigin () const noexcept
	Location of the feature window origin in pixel coordinates measured from the left top corner of the feature window. More...

Detailed Description

Descriptor for image data to be digested by an image list.

Constructor & Destructor Documentation

SampleListImageDataType() [1/2]

SampleListImageDataType ( Size2D< int >  imageSize, int  imageDimension, DataType  imageDataType, Point2D< int >  featureWindowOrigin, Point2D< int >  featureWindowLoc, Size2D< int >  featureWindowSize  )

inline

Construct an image list data type descriptor for image lists that digest images.

Parameters

[in]	imageSize	Size of the images to be processed inside an image list.
[in]	imageDimension	Dimension of the images to be processed inside an image list.
[in]	imageDataType	Data type of the images to be processed inside an image list.
[in]	featureWindowOrigin	Origin of the feature window.
[in]	featureWindowLoc	Position (left, top) of the feature window inside the image.
[in]	featureWindowSize	Size of the feature window.

Exceptions

Any	exception derived from std::exception including CvbException.

SampleListImageDataType() [2/2]

SampleListImageDataType ( Size2D< int >  imageSize, int  imageDimension, DataType  imageDataType, Point2D< int >  featureWindowOrigin  )

inline

Construct an image list data type descriptor for image lists that digest images.

Parameters

[in]	imageSize	Size of the images to be processed inside an image list.
[in]	imageDimension	Dimension of the images to be processed inside an image list.
[in]	imageDataType	Data type of the images to be processed inside an image list.
[in]	featureWindowOrigin	Origin of the feature window.

Exceptions

Any	exception derived from std::exception including CvbException.

Member Function Documentation

FeatureWindowLocation()

Point2D<int> FeatureWindowLocation ( ) const

inlinenoexcept

Location of the feature window (position of left top corner inside the image).

Returns

The feature window location.

Exceptions

Does	not throw any exception.

FeatureWindowOrigin()

Point2D<int> FeatureWindowOrigin ( ) const

inlinenoexcept

Location of the feature window origin in pixel coordinates measured from the left top corner of the feature window.

Returns

The feature window origin.

Exceptions

Does	not throw any exception.

FeatureWindowSize()

Size2D<int> FeatureWindowSize ( ) const

inlinenoexcept

Size of the feature window.

Returns

The feature window size.

Exceptions

Does	not throw any exception.

Handle()

void* Handle ( ) const

inlinenoexcept

Classic API SIL handle.

Returns

Classic API handle.

Exceptions

Does	not throw any exception.

It is normally not necessary to work with this handle.

ImageDataType()

DataType ImageDataType ( ) const

inlinenoexcept

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

Returns

The image data type.

Exceptions

Does	not throw any exception.

ImageDimension()

int ImageDimension ( ) const

inlinenoexcept

Dimension of the images to be added to the image list.

Returns

The image dimension.

Exceptions

Does	not throw any exception.

ImageSize()

Size2D<int> ImageSize ( ) const

inlinenoexcept

Size of the images to be added to the image list.

Returns

The image size.

Exceptions

Does	not throw any exception.