iRoCS Toolbox  1.1.0
Public Member Functions | Static Public Member Functions
svt::ProgressReporter Class Reference

#include <ProgressReporter.hh>

Inheritance diagram for svt::ProgressReporter:
Collaboration diagram for svt::ProgressReporter:

Public Member Functions

 ProgressReporter (std::ostream &os=std::cerr)
 
virtual ~ProgressReporter ()
 
virtual void additionalInfo (int taskLevel, const std::string &text)
 (description) More...
 
virtual void clearScreen ()
 (description) More...
 
template<typename STDATA >
void loadParameters (STDATA &stData)
 
virtual void reportProgress (int taskLevel, const std::string &taskName, float completenessPercent, const std::string &completenessPlainText)
 This method is called if some progress was made. More...
 
template<typename STDATA >
void saveParameters (STDATA &stData) const
 
virtual void setMaxTaskLevel (int n)
 
void setVerboseLevel (int verboseLevel)
 set the reporting level for reportProgress() method. More...
 

Static Public Member Functions

static const char * description ()
 
static void getParamInfos (std::vector< ParamInfo > &p)
 get information about the parameters, that are used in loadParameters() and saveParameters(). More...
 
static const char * name ()
 

Detailed Description

Definition at line 83 of file ProgressReporter.hh.

Constructor & Destructor Documentation

◆ ProgressReporter()

svt::ProgressReporter::ProgressReporter ( std::ostream &  os = std::cerr)
inline

Definition at line 86 of file ProgressReporter.hh.

◆ ~ProgressReporter()

virtual svt::ProgressReporter::~ProgressReporter ( )
inlinevirtual

Definition at line 103 of file ProgressReporter.hh.

Member Function Documentation

◆ setMaxTaskLevel()

virtual void svt::ProgressReporter::setMaxTaskLevel ( int  n)
inlinevirtual

Definition at line 107 of file ProgressReporter.hh.

◆ clearScreen()

virtual void svt::ProgressReporter::clearScreen ( )
inlinevirtual

(description)

Parameters

Definition at line 123 of file ProgressReporter.hh.

◆ reportProgress()

virtual void svt::ProgressReporter::reportProgress ( int  taskLevel,
const std::string &  taskName,
float  completenessPercent,
const std::string &  completenessPlainText 
)
inlinevirtual

This method is called if some progress was made.

Parameters
taskLevellevel of current task, e.g. 1 for parameter tuning, 2 for cross validation, 3 for multiclass algorithm, 4 for twoclass algorithm, etc.
taskNameplain test name of current task
completenessPercentcompleteness of current task as float between 0.0 and 1.0 (-1 means cannot be calculated, -2 means start of such a task without percent values)
completenessPlainTextcompleteness of current task as plain text message, e.g. "3 of 32"
Exceptions
TrainingCanceledcould be thrown, when user canceled the training process or when a timeOut appeared

Definition at line 156 of file ProgressReporter.hh.

Referenced by svt::CrossValidator< FV, SVMTYPE, PROBLEM >::preprocessTrainingData().

◆ additionalInfo()

virtual void svt::ProgressReporter::additionalInfo ( int  taskLevel,
const std::string &  text 
)
inlinevirtual

(description)

Parameters

Definition at line 304 of file ProgressReporter.hh.

◆ setVerboseLevel()

void svt::ProgressReporter::setVerboseLevel ( int  verboseLevel)
inline

set the reporting level for reportProgress() method.

0 means report nothing. Higher numbers mean: report more.

Parameters
verboseLevelonly report progress events equal to or below this level

Definition at line 337 of file ProgressReporter.hh.

◆ loadParameters()

template<typename STDATA >
void svt::ProgressReporter::loadParameters ( STDATA &  stData)
inline

Definition at line 343 of file ProgressReporter.hh.

◆ saveParameters()

template<typename STDATA >
void svt::ProgressReporter::saveParameters ( STDATA &  stData) const
inline

Definition at line 350 of file ProgressReporter.hh.

◆ getParamInfos()

static void svt::ProgressReporter::getParamInfos ( std::vector< ParamInfo > &  p)
inlinestatic

get information about the parameters, that are used in loadParameters() and saveParameters().

The Infos are appended to the passed array

Parameters
parray of ParamInfos. The Infos will be appended to this array

Definition at line 366 of file ProgressReporter.hh.

◆ name()

static const char* svt::ProgressReporter::name ( )
inlinestatic

Definition at line 383 of file ProgressReporter.hh.

◆ description()

static const char* svt::ProgressReporter::description ( )
inlinestatic

Definition at line 388 of file ProgressReporter.hh.


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