IHisto.hpp

#ifndef OPALS_IHISTO_HPP_INCLUDED
#define OPALS_IHISTO_HPP_INCLUDED

#include <opals/IModuleBase.hpp>

#if !defined(OPALS_EXPORTS) && !defined(OPALS_MODULE_EXPORTS)
  #if defined _DEBUG && !defined OPALS_NO_DEBUG
      #pragma comment(lib, "opalsHisto_d.lib")
  #else
      #pragma comment(lib, "opalsHisto.lib")
  #endif
#endif

#include <opals/String.hpp>
#include <opals/Path.hpp>
#include <opals/Array.hpp>
#include <opals/Vector.hpp>
#include <opals/HistoMode.hpp>
#include <opals/HistoStats.hpp>

typedef opals::Array<float,2> ArrayF2;
typedef opals::Array<double,4> ArrayD4;

namespace opals {

  namespace opts
  {
    namespace Histo
    {
      /// Options of \ref ModuleHisto
      typedef IGroup< Names::_, false, Cons<
        ILeaf< Names::inFile, false, opals::Vector<opals::Path> >, Cons<
        ILeaf< Names::attribute, false, opals::Vector<opals::String> >, Cons<
        ILeaf< Names::histogram, true, opals::Vector<opals::HistoStats> >, Cons<
        ILeaf< Names::nBins, false, unsigned >, Cons<
        ILeaf< Names::binWidth, false, float >, Cons<
        ILeaf< Names::sampleRange, false, ArrayF2 >, Cons<
        ILeaf< Names::densityRange, false, ArrayF2 >, Cons<
        ILeaf< Names::limit, false, ArrayD4 >, Cons<
        ILeaf< Names::filter, false, opals::String >, Cons<
        ILeaf< Names::plotFile, false, opals::Vector<opals::Path> >, Cons<
        ILeaf< Names::probabilities, false, opals::Vector<double> >, Cons<
        ILeaf< Names::procMode, false, opals::HistoMode::Type >, Cons<
        ILeaf< Names::exactComputation, false, bool >
      > > > > > > > > > > > > > > Options;
    }
  }

  /// Derives histograms and descriptive statistics (min, max, mean, r.m.s, etc.) for ODM or grid/raster data sets and stores the results graphically (SVG) and numerically (XML).
  /** The boost::accumulator framework is used to analyze the data, to calculate
      standard statistics (min max, mean, median, quantiles,...) and to create the
      histogram itself. Finally, if requested by the user, a plot file in SVG format
      is generated using boost::svg_plot (not yet part of the boost library). */
  /// \see \ref ModuleHisto
  class OPALS_API IHisto : virtual public IModuleBase
  {

  public:
    static IHisto* New();
    static IHisto* New( IControlObject &controlObject );
    static IHisto* New( const IModuleBase &parent );
    static IHisto* New( const IModuleBase &parent, IControlObject &controlObject );

    virtual ~IHisto() {}

    /// \name Access to module-specific options.
    ///@{
    typedef opts::Histo::Options Options;
    virtual       Options& opts()       = 0;
    virtual const Options& opts() const = 0;
    ///}@

  };

};

#endif