ReadFramework
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
rdf::Module Class Referenceabstract

This is the base class for all modules. It provides all functions which are implemented by the modules. More...

#include <BaseModule.h>

Inheritance diagram for rdf::Module:
Inheritance graph
[legend]

Public Member Functions

 Module ()
 Default constructor Initializes a new instance of the Module class. More...
 
virtual bool isEmpty () const =0
 Returns true if the module was initialized with the default constructor. Note, if empty is true, nothing can be computed. More...
 
virtual QString name () const
 Returns the module's name. More...
 
virtual QString toString () const
 Converts the module's parameters and results to a string. More...
 
virtual bool compute ()=0
 Runs the algorithm implemented by the module. More...
 
virtual void setConfig (QSharedPointer< ModuleConfig > config)
 
QSharedPointer< ModuleConfig > config () const
 

Protected Member Functions

virtual bool checkInput () const =0
 
QString debugName () const
 

Protected Attributes

QSharedPointer< ModuleConfig > mConfig
 

Friends

DllCoreExport QDataStream & operator<< (QDataStream &s, const Module &m)
 
DllCoreExport QDebug operator<< (QDebug d, const Module &m)
 

Detailed Description

This is the base class for all modules. It provides all functions which are implemented by the modules.

Constructor & Destructor Documentation

rdf::Module::Module ( )

Default constructor Initializes a new instance of the Module class.

Member Function Documentation

virtual bool rdf::Module::checkInput ( ) const
protectedpure virtual

checks if all input images are in the specified format.

Implemented in rdf::LineTraceLSD, rdf::TextLineSkew, rdf::LineSuperPixel, rdf::LineTrace, rdf::BaseSkewEstimation, rdf::BaseBinarizationSu, rdf::GradientVector, and rdf::SuperPixelBase.

virtual bool rdf::Module::compute ( )
pure virtual

Runs the algorithm implemented by the module.

Returns
True on success.

Implemented in rdf::LocalOrientation, rdf::GridSuperPixel, rdf::FormFeatures, rdf::SuperPixelTrainer, rdf::GraphCutTextLine, rdf::LineTraceLSD, rdf::GraphCutLineSpacing, rdf::BinarizationSuFgdWeight, rdf::LineSuperPixel, rdf::TextLineSkew, rdf::SuperPixelLabeler, rdf::BinarizationSuAdapted, rdf::GraphCutPixelLabel, rdf::LineTrace, rdf::SuperPixel, rdf::TextLineSegmentation, rdf::GraphCutOrientation, rdf::BaseSkewEstimation, rdf::BaseBinarizationSu, rdf::SuperPixelClassifier, rdf::GradientVector, rdf::LayoutAnalysis, rdf::TabStopAnalysis, rdf::ScaleSpaceSuperPixel< SuperPixelModule >, rdf::WriterRetrieval, rdf::SimpleBinarization, rdf::SimpleTextLineSegmentation, rdf::PageSegmentation, rdf::SuperPixelFeature, and rdf::SuperPixelEval.

QSharedPointer< ModuleConfig > rdf::Module::config ( ) const

Here is the caller graph for this function:

QString rdf::Module::debugName ( ) const
protected

Here is the caller graph for this function:

virtual bool rdf::Module::isEmpty ( ) const
pure virtual

Returns true if the module was initialized with the default constructor. Note, if empty is true, nothing can be computed.

Returns
Returns true if the module was initialized.

Implemented in rdf::LocalOrientation, rdf::FormFeatures, rdf::SuperPixelTrainer, rdf::LineTraceLSD, rdf::TextLineSkew, rdf::SuperPixelLabeler, rdf::LineTrace, rdf::TextLineSegmentation, rdf::BaseSkewEstimation, rdf::BaseBinarizationSu, rdf::SuperPixelClassifier, rdf::GradientVector, rdf::LayoutAnalysis, rdf::TabStopAnalysis, rdf::SimpleBinarization, rdf::GraphCutPixel, rdf::SimpleTextLineSegmentation, rdf::PageSegmentation, rdf::SuperPixelBase, rdf::SuperPixelFeature, and rdf::SuperPixelEval.

Here is the caller graph for this function:

QString rdf::Module::name ( ) const
virtual

Returns the module's name.

Returns
The module's name.
void rdf::Module::setConfig ( QSharedPointer< ModuleConfig >  config)
virtual

Here is the caller graph for this function:

QString rdf::Module::toString ( ) const
virtual

Converts the module's parameters and results to a string.

Returns
The string containing all parameters and results of the module.

Reimplemented in rdf::LocalOrientation, rdf::FormFeatures, rdf::GridSuperPixel, rdf::SuperPixelTrainer, rdf::LineTraceLSD, rdf::LineSuperPixel, rdf::TextLineSkew, rdf::SuperPixelLabeler, rdf::BinarizationSuAdapted, rdf::ScaleSpaceSuperPixel< SuperPixelModule >, rdf::LineTrace, rdf::TextLineSegmentation, rdf::SuperPixel, rdf::BaseSkewEstimation, rdf::BaseBinarizationSu, rdf::SuperPixelClassifier, rdf::GradientVector, rdf::LayoutAnalysis, rdf::TabStopAnalysis, rdf::WriterRetrieval, rdf::SimpleBinarization, rdf::SimpleTextLineSegmentation, rdf::PageSegmentation, rdf::SuperPixelFeature, and rdf::SuperPixelEval.

Here is the caller graph for this function:

Friends And Related Function Documentation

DllCoreExport QDataStream& operator<< ( QDataStream &  s,
const Module &  m 
)
friend
DllCoreExport QDebug operator<< ( QDebug  d,
const Module &  m 
)
friend

Member Data Documentation

QSharedPointer<ModuleConfig> rdf::Module::mConfig
protected

the module config

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