ReadFramework
rdf::SuperPixelLabelerConfig Class Reference

This class configures the feature collection process. It controls I/O paths for feature labels and feature cache files and the normalization process through the read settings file. More...

#include <SuperPixelTrainer.h>

Inheritance diagram for rdf::SuperPixelLabelerConfig:
Collaboration diagram for rdf::SuperPixelLabelerConfig:

Public Member Functions

 SuperPixelLabelerConfig ()
 Initializes a new instance of the SuperPixelLabelerConfig class. This class configures the feature collection process. More...
 
QString featureFilePath () const
 Full file path to the feature cache file. This file is the collection's output and contains all features collected. More...
 
QString labelConfigFilePath () const
 Full file path to the label config file. The label config file configures the labeling process (e.g. if TextRegion is handwritten or printed). More...
 
int maxNumFeaturesPerImage () const
 Sepcify the maximum number of images collected per image. More...
 
int minNumFeaturesPerClass () const
 If less features are found for a class, it is not saved. More...
 
int maxNumFeaturesPerClass () const
 The maximum number of features collected per class. More...
 
QString backgroundLabelName () const
 
virtual QString toString () const override
 
- Public Member Functions inherited from rdf::ModuleConfig
 ModuleConfig (const QString &moduleName="Generic Module")
 
void loadSettings ()
 
void loadSettings (QSettings &settings)
 
void saveSettings () const
 
void saveSettings (QSettings &settings) const
 
void saveDefaultSettings () const
 
virtual void saveDefaultSettings (QSettings &settings) const
 
QString name () const
 

Protected Member Functions

void load (const QSettings &settings) override
 
void save (QSettings &settings) const override
 
- Protected Member Functions inherited from rdf::ModuleConfig
template<class num >
num checkParam (num param, num min, num max, const QString &name) const
 

Protected Attributes

QString mFeatureFilePath
 
QString mLabelConfigFilePath
 
QString mBackgroundLabelName = ""
 
int mMaxNumFeaturesPerImage = 1000000
 
int mMinNumFeaturesPerClass = 10000
 
int mMaxNumFeaturesPerClass = 10000
 
- Protected Attributes inherited from rdf::ModuleConfig
QString mModuleName
 

Detailed Description

This class configures the feature collection process. It controls I/O paths for feature labels and feature cache files and the normalization process through the read settings file.

See also
ModuleConfig

Constructor & Destructor Documentation

rdf::SuperPixelLabelerConfig::SuperPixelLabelerConfig ( )

Initializes a new instance of the SuperPixelLabelerConfig class. This class configures the feature collection process.

Member Function Documentation

QString rdf::SuperPixelLabelerConfig::backgroundLabelName ( ) const
QString rdf::SuperPixelLabelerConfig::featureFilePath ( ) const

Full file path to the feature cache file. This file is the collection's output and contains all features collected.

Returns
QString rdf::SuperPixelLabelerConfig::labelConfigFilePath ( ) const

Full file path to the label config file. The label config file configures the labeling process (e.g. if TextRegion is handwritten or printed).

Returns
void rdf::SuperPixelLabelerConfig::load ( const QSettings &  settings)
overrideprotectedvirtual

Reimplemented from rdf::ModuleConfig.

int rdf::SuperPixelLabelerConfig::maxNumFeaturesPerClass ( ) const

The maximum number of features collected per class.

Returns
int rdf::SuperPixelLabelerConfig::maxNumFeaturesPerImage ( ) const

Sepcify the maximum number of images collected per image.

Returns
int rdf::SuperPixelLabelerConfig::minNumFeaturesPerClass ( ) const

If less features are found for a class, it is not saved.

Returns
void rdf::SuperPixelLabelerConfig::save ( QSettings &  settings) const
overrideprotectedvirtual

Reimplemented from rdf::ModuleConfig.

QString rdf::SuperPixelLabelerConfig::toString ( ) const
overridevirtual

Reimplemented from rdf::ModuleConfig.

Member Data Documentation

QString rdf::SuperPixelLabelerConfig::mBackgroundLabelName = ""
protected
QString rdf::SuperPixelLabelerConfig::mFeatureFilePath
protected
QString rdf::SuperPixelLabelerConfig::mLabelConfigFilePath
protected
int rdf::SuperPixelLabelerConfig::mMaxNumFeaturesPerClass = 10000
protected
int rdf::SuperPixelLabelerConfig::mMaxNumFeaturesPerImage = 1000000
protected
int rdf::SuperPixelLabelerConfig::mMinNumFeaturesPerClass = 10000
protected

The documentation for this class was generated from the following files: