Classifier type that operates on images. More...
#include <cvb/sample_database/sample_classification_image_list.hpp>
Inherits SampleImageList.
Public Member Functions | |
SampleClassificationImageList (const SampleListImageDataType &imageDataType) | |
Create a sample image list suitable for classification tasks. More... | |
SampleClassificationImageList (const String &fileName) | |
Load a sample classification image from a file. More... | |
ImageClassificationInfoCollectionPtr | Classes () |
Get the class collection. More... | |
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. More... | |
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. More... | |
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. More... | |
std::unique_ptr< ImageClassificationLabelInfo > | GetClassFromSample (int sampleIndex) |
Retrieve the label information that goes with a given sample. More... | |
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. 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< SampleClassificationImageList > | FromHandle (ReleaseObjectGuard &&guard, const String &fileName=String()) |
Creates classification image list from a classic API handle. More... | |
static std::unique_ptr< SampleClassificationImageList > | ImportMantoSil (const String &fileName) |
Load a Manto2 sample list from disc. More... | |
Classifier type that operates on images.
|
inlineexplicit |
Create a sample image list suitable for classification tasks.
[in] | imageDataType | Data type of the images to be added to the sample image list. |
Any | exception derived from std::exception including CvbException. |
|
inlineexplicit |
Load a sample classification image from a file.
[in] | fileName | Name of the file to be loaded. |
Any | exception derived from std::exception including CvbException. |
|
inline |
Get the class collection.
Any | exception derived from std::exception including CvbException. |
|
inlinestatic |
Creates classification image list from a classic API handle.
[in] | guard | Life time guard for C-API handle. |
[in] | fileName | The file name of the classifier. |
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.
|
inline |
Retrieve the label information that goes with a given sample.
[in] | sampleIndex | Index of the sample for which to retrieve the class information. |
Any | exception derived from std::exception including CvbException. |
|
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.
[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). |
Any | exception derived from std::exception including CvbException. |
|
inlinestatic |
Load a Manto2 sample list from disc.
[in] | fileName | File to import. |
Any | exception derived from std::exception including CvbException. |
|
inline |
Transform this sample image list into a new sample image list by transforming each sample inside it.
[in] | transformCallback | Sample transformation callback. |
Any | exception derived from std::exception including CvbException. |
|
inline |
Transform this sample image list into a new sample image list by transforming each label inside it.
[in] | transformCallback | Label transformation callback. |
Any | exception derived from std::exception including CvbException. |
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.
[in] | transformCallback | Label transformation callback. |
Any | exception derived from std::exception including CvbException. |