CFAlgoStartPointCompat.h
Go to the documentation of this file.
1 /**
2  * \file CFAlgoStartPointCompat.h
3  *
4  * \ingroup CMTool
5  *
6  * \brief Class def header for a class CFAlgoStartPointCompat
7  *
8  * @author david
9  */
10 
11 /** \addtogroup CMTool
12 
13  @{*/
14 #ifndef RECOTOOL_CFALGOSTARTPOINTCOMPAT_H
15 #define RECOTOOL_CFALGOSTARTPOINTCOMPAT_H
16 
18 
19 namespace cmtool {
20  /**
21  \class CFAlgoStartPointCompat
22  User implementation for CFloatAlgoBase class
23  doxygen documentation!
24  */
26 
27  public:
28 
29  /// Default constructor
31 
32  /// Default destructor
34 
35  //
36  // Author should be aware of 3 functions at least: Float, Report,
37  // and Reset. More possibly-useful functions can be found in the later
38  // part but commented out. All of these functions are virtual and defined
39  // in the base class.
40 
41  /**
42  Core function: given a set of CPANs, return a float which indicates
43  the compatibility the cluster combination.
44  */
45  virtual float Float(const std::vector<const cluster::ClusterParamsAlg*> &clusters);
46 
47  /**
48  Optional function: called after each iterative approach if a manager class is
49  run with verbosity level <= kPerIteration. Maybe useful for debugging.
50  */
51  virtual void Report();
52 
53  /// Function to reset the algorithm instance, called together with manager's Reset()
54  virtual void Reset();
55 
56  /// Function to set verbose output
57  void SetVerbose( bool on ) { _verbose = on; }
58 
59  private:
60 
61  double _w2cm, _t2cm;
62  //double _MaxArea;
63  bool _verbose;
64  };
65 
66 
67 }
68 #endif
69 /** @} */ // end of doxygen group
Class def header for a class CFloatAlgoBase.
virtual ~CFAlgoStartPointCompat()
Default destructor.
void SetVerbose(bool on)
Function to set verbose output.
virtual float Float(const std::vector< const cluster::ClusterParamsAlg * > &clusters)
CFAlgoStartPointCompat()
Default constructor.
virtual void Reset()
Function to reset the algorithm instance, called together with manager&#39;s Reset()
Definition: cfalgo.cc:3