IZonalFit.hpp

#pragma once
 
#include <opals/IModuleBase.hpp>
#include <opals/SearchMode.hpp>
#include <opals/SelectionMode.hpp>
#include <opals/String.hpp>
#include <opals/Path.hpp>
#include <opals/Array.hpp>
#include <opals/Vector.hpp>
#include <opals/HistoStats.hpp>
#include <opals/GeomModel.hpp>
#include <DM/StatFeature.hpp>
 
#if defined(_MSC_VER) && !defined(OPALS_NO_AUTOLINK)
  #if defined _DEBUG && !defined OPALS_NO_DEBUG
    #pragma comment(lib, "opalsZonalFit_d.lib")
  #else
    #pragma comment(lib, "opalsZonalFit.lib")
  #endif
#endif
 
namespace opals {
 
  namespace opts
  {
    /// Options of \ref ModuleZonalFit
    namespace ZonalFit
    {
      /// Options of \ref ModuleZonalFit
      using Options =
        IGroup< Names::_, false,
          ILeaf< Names::inFile, false, Path  >,
          ILeaf< Names::attribute, false, String  >,
          ILeaf< Names::aoi, false, String  >,
          ILeaf< Names::filter, false, String  >,
          ILeaf< Names::plotFile, false, String  >,
          ILeaf< Names::binWidth, false, double  >,
          ILeaf< Names::sampleRange, false, Array<double, 2>  >,
          ILeaf< Names::densityRange, false, Array<double, 2>  >,
          ILeaf< Names::outGeometry, true, Vector<String>  >,
          ILeaf< Names::limit, false, Array<double,4>  >,
          ILeaf< Names::histogram, true, Vector<HistoStats>  >,
          ILeaf< Names::geometryModel, false, GeomModel  >,
          ILeaf< Names::neighbours, false, int  >,
          ILeaf< Names::searchRadius, false, Vector< float >  >,
          ILeaf< Names::searchMode, false, SearchMode  >,
          ILeaf< Names::selMode, false, SelectionMode  >,
          ILeaf< Names::storeStatistics, false, Vector<DM::StatFeature>  >,
          ILeaf< Names::byproduct, false, Path  >
        >;
    }
  }
 
  /// Fits geometry models to a set of data points for multiple regions-of-interest
  /** TODO: 
      More details on opalsopalsZonalFit with much more words,
      possibly on several lines. */
  /// \see \ref ModuleZonalFit
  class OPALS_API IZonalFit : virtual public IModuleBase
  {
 
  public:
    static IZonalFit* New();
    static IZonalFit* New( IControlObject &controlObject );
    static IZonalFit* New( const IModuleBase &parent );
    static IZonalFit* New( const IModuleBase &parent, IControlObject &controlObject );
 
    virtual ~IZonalFit() {}
 
    /// \name Access to module-specific options.
    ///@{
    using Options = opts::ZonalFit::Options;
    virtual       Options& opts()       = 0;
    virtual const Options& opts() const = 0;
    ///@}
 
  };
 
};