IHisto.hpp

#pragma once
 
#include <opals/IModuleBase.hpp>
#include <opals/Array.hpp>
#include <opals/HistoMode.hpp>
#include <opals/HistoStats.hpp>
#include <opals/OdmOrRasterFile.hpp>
#include <opals/Path.hpp>
#include <opals/String.hpp>
#include <opals/Vector.hpp>
#include <opals/AbsValueOrQuantile.hpp>
#include <opals/DistributionDescription.hpp>
 
#if defined(_MSC_VER) && !defined(OPALS_NO_AUTOLINK)
  #if defined _DEBUG && !defined OPALS_NO_DEBUG
      #pragma comment(lib, "opalsHisto_d.lib")
  #else
      #pragma comment(lib, "opalsHisto.lib")
  #endif
#endif
 
namespace opals {
 
  namespace opts
  {
    /// Options of \ref ModuleHisto
    namespace Histo
    {
      /// Options of \ref ModuleHisto
      using Options =
        IGroup< Names::_,
          IValue< Names::inFile, false, Vector<OdmOrRasterFile>  >,
          IValue< Names::attribute, false, Vector<String>  >,
          IValue< Names::histogram, true, Vector<HistoStats>  >,
          IValue< Names::nBins, false, unsigned  >,
          IValue< Names::binWidth, false, float  >,
          IValue< Names::sampleRange, false, Array<opals::AbsValueOrQuantile, 2>  >,
          IValue< Names::densityRange, false, Array<float, 2>  >,
          IValue< Names::limit, false, Array<double, 4>  >,
          IValue< Names::filter, false, String  >,
          IValue< Names::plotFile, false, Vector<Path>  >,
          IValue< Names::probabilities, false, Vector<double>  >,
          IValue< Names::procMode, false, HistoMode  >,
          IValue< Names::exactComputation, false, bool  >,
          IValue< Names::skipEmptyBins, false, bool  >,
          IValue< Names::distributionFunc, false, opals::DistributionDescription  >,
          IValue< Names::cumulativeHistogram, false, bool  >
        >;
    }
  }
 
  /// 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.
    ///@{
    using Options = opts::Histo::Options;
          Options& opts()       override = 0;
    const Options& opts() const override = 0;
    ///@}
 
  };
 
};