iRoCS Toolbox  1.1.0
Public Types | Public Member Functions
svt::SVMApplication< FV, ALGORITHMS, LOAD_SAVE_POLICY > Class Template Reference

The SVMApplication class specifies a complete command line application. More...

#include <SVMApplication.hh>

Inheritance diagram for svt::SVMApplication< FV, ALGORITHMS, LOAD_SAVE_POLICY >:
Collaboration diagram for svt::SVMApplication< FV, ALGORITHMS, LOAD_SAVE_POLICY >:

Public Types

typedef LOAD_SAVE_POLICY::STDATA STDATA
 

Public Member Functions

 SVMApplication ()
 
virtual ~SVMApplication ()
 
virtual void checkWrongParameters (StDataCmdLine &cmdline)
 check for wrong ( = unused) parameters in cmdline More...
 
virtual int doClassification (StDataCmdLine &cmdline, std::ostream &os=std::cout)
 do Classification with given command line parameters More...
 
virtual int doCrossValidation (StDataCmdLine &cmdline, std::ostream &os=std::cout)
 do cross validation with given command line parameters More...
 
virtual int doGridSearch (StDataCmdLine &cmdline, std::ostream &os=std::cout)
 do cross validation with given command line parameters More...
 
virtual int doTraining (StDataCmdLine &cmdline, std::ostream &os=std::cout)
 do Training with given command line parameters More...
 
virtual int main (int argc, const char **argv, std::ostream &os=std::cout)
 main function for an SVM-Application. More...
 
virtual int main (StDataCmdLine &cmdLine, std::ostream &os=std::cout)
 main function for an SVM-Application, after cmdline has been parsed. More...
 
virtual const std::string & programName () const
 return the name of the shell program. More...
 
void setPrettyPrintColumn (int column)
 
virtual void setProgramName (const std::string &name)
 Overwrite program name that was extracted from argv[0]. More...
 

Detailed Description

template<typename FV, typename ALGORITHMS, typename LOAD_SAVE_POLICY>
class svt::SVMApplication< FV, ALGORITHMS, LOAD_SAVE_POLICY >

The SVMApplication class specifies a complete command line application.

see svmtl.cc for an example how to use it

Parameters
FVfeature vector class
ALGORITHMSlists of multi-class, two-class, one-class algorithms an kernel functions
LOAD_SAVE_POLICYpolicy for loading and saving of data

Definition at line 108 of file SVMApplication.hh.

Member Typedef Documentation

◆ STDATA

template<typename FV , typename ALGORITHMS , typename LOAD_SAVE_POLICY >
typedef LOAD_SAVE_POLICY::STDATA svt::SVMApplication< FV, ALGORITHMS, LOAD_SAVE_POLICY >::STDATA

Definition at line 111 of file SVMApplication.hh.

Constructor & Destructor Documentation

◆ SVMApplication()

template<typename FV , typename ALGORITHMS , typename LOAD_SAVE_POLICY >
svt::SVMApplication< FV, ALGORITHMS, LOAD_SAVE_POLICY >::SVMApplication ( )
inline

Definition at line 113 of file SVMApplication.hh.

◆ ~SVMApplication()

template<typename FV , typename ALGORITHMS , typename LOAD_SAVE_POLICY >
virtual svt::SVMApplication< FV, ALGORITHMS, LOAD_SAVE_POLICY >::~SVMApplication ( )
inlinevirtual

Definition at line 118 of file SVMApplication.hh.

Member Function Documentation

◆ main() [1/2]

template<typename FV , typename ALGORITHMS , typename LOAD_SAVE_POLICY >
virtual int svt::SVMApplication< FV, ALGORITHMS, LOAD_SAVE_POLICY >::main ( int  argc,
const char **  argv,
std::ostream &  os = std::cout 
)
virtual

main function for an SVM-Application.

Call this if you don't want to go into details

Parameters
argcnumber of command line arguments
argvarray of c-style strings containing command line arguments
osoutput stream for help text, progress messages, etc
Returns
0: success 1: an error occured

Referenced by svt::SVMApplication< FV, ALGORITHMS, LOAD_SAVE_POLICY >::~SVMApplication().

◆ main() [2/2]

template<typename FV , typename ALGORITHMS , typename LOAD_SAVE_POLICY >
virtual int svt::SVMApplication< FV, ALGORITHMS, LOAD_SAVE_POLICY >::main ( StDataCmdLine cmdLine,
std::ostream &  os = std::cout 
)
virtual

main function for an SVM-Application, after cmdline has been parsed.

Use this, if you want to add your own modes, e.g. "svmtl hurz ...".

Parameters
cmdlineparsed command line arguments
osoutput stream for help text, progress messages, etc
Returns
0: success 1: an error occured

◆ programName()

template<typename FV , typename ALGORITHMS , typename LOAD_SAVE_POLICY >
virtual const std::string& svt::SVMApplication< FV, ALGORITHMS, LOAD_SAVE_POLICY >::programName ( ) const
inlinevirtual

return the name of the shell program.

This is the string from argv[0] by default, but could be replaced with setProgramName()

Returns
program name

Definition at line 164 of file SVMApplication.hh.

◆ setProgramName()

template<typename FV , typename ALGORITHMS , typename LOAD_SAVE_POLICY >
virtual void svt::SVMApplication< FV, ALGORITHMS, LOAD_SAVE_POLICY >::setProgramName ( const std::string &  name)
inlinevirtual

Overwrite program name that was extracted from argv[0].

The programName() ist used from the several writeHelp() methods

Parameters
nameprogram name

Definition at line 177 of file SVMApplication.hh.

◆ checkWrongParameters()

template<typename FV , typename ALGORITHMS , typename LOAD_SAVE_POLICY >
virtual void svt::SVMApplication< FV, ALGORITHMS, LOAD_SAVE_POLICY >::checkWrongParameters ( StDataCmdLine cmdline)
virtual

check for wrong ( = unused) parameters in cmdline

Parameters
cmdlinecommand line parameters
Exceptions
svt::CmdLineError

Referenced by svt::SVMApplication< FV, ALGORITHMS, LOAD_SAVE_POLICY >::setProgramName().

◆ doTraining()

template<typename FV , typename ALGORITHMS , typename LOAD_SAVE_POLICY >
virtual int svt::SVMApplication< FV, ALGORITHMS, LOAD_SAVE_POLICY >::doTraining ( StDataCmdLine cmdline,
std::ostream &  os = std::cout 
)
virtual

do Training with given command line parameters

Parameters
cmdlinecommand line parameters
Exceptions

Referenced by svt::SVMApplication< FV, ALGORITHMS, LOAD_SAVE_POLICY >::setProgramName().

◆ doClassification()

template<typename FV , typename ALGORITHMS , typename LOAD_SAVE_POLICY >
virtual int svt::SVMApplication< FV, ALGORITHMS, LOAD_SAVE_POLICY >::doClassification ( StDataCmdLine cmdline,
std::ostream &  os = std::cout 
)
virtual

do Classification with given command line parameters

Parameters
cmdlinecommand line parameters
Exceptions

Referenced by svt::SVMApplication< FV, ALGORITHMS, LOAD_SAVE_POLICY >::setProgramName().

◆ doCrossValidation()

template<typename FV , typename ALGORITHMS , typename LOAD_SAVE_POLICY >
virtual int svt::SVMApplication< FV, ALGORITHMS, LOAD_SAVE_POLICY >::doCrossValidation ( StDataCmdLine cmdline,
std::ostream &  os = std::cout 
)
virtual

do cross validation with given command line parameters

Parameters
cmdlinecommand line parameters
Exceptions

Referenced by svt::SVMApplication< FV, ALGORITHMS, LOAD_SAVE_POLICY >::setProgramName().

◆ doGridSearch()

template<typename FV , typename ALGORITHMS , typename LOAD_SAVE_POLICY >
virtual int svt::SVMApplication< FV, ALGORITHMS, LOAD_SAVE_POLICY >::doGridSearch ( StDataCmdLine cmdline,
std::ostream &  os = std::cout 
)
virtual

do cross validation with given command line parameters

Parameters
cmdlinecommand line parameters
Exceptions

Referenced by svt::SVMApplication< FV, ALGORITHMS, LOAD_SAVE_POLICY >::setProgramName().

◆ setPrettyPrintColumn()

template<typename FV , typename ALGORITHMS , typename LOAD_SAVE_POLICY >
void svt::SVMApplication< FV, ALGORITHMS, LOAD_SAVE_POLICY >::setPrettyPrintColumn ( int  column)
inline

Definition at line 264 of file SVMApplication.hh.


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