ParameterDistribution.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Param/Distrib/ParameterDistribution.h
//! @brief     Defines class ParameterDistribution.
//!
//! @homepage  http://www.bornagainproject.org
//! @license   GNU General Public License v3 or higher (see COPYING)
//! @copyright Forschungszentrum Jülich GmbH 2018
//! @authors   Scientific Computing Group at MLZ (see CITATION, AUTHORS)
//
//  ************************************************************************************************
 
#ifndef BORNAGAIN_PARAM_DISTRIB_PARAMETERDISTRIBUTION_H
#define BORNAGAIN_PARAM_DISTRIB_PARAMETERDISTRIBUTION_H
 
#include "Fit/Param/RealLimits.h"
#include "Param/Distrib/ParameterSample.h"
#include <memory>
#include <vector>
 
class IDistribution1D;
 
//! A parametric distribution function, for use with any model parameter.
 
class ParameterDistribution {
public:
    enum WhichParameter {
        None, // #baPool ++ really necessary?? Try to refactor the relevant place
        BeamWavelength,
        BeamInclinationAngle,
        BeamAzimuthalAngle
    };
 
    ParameterDistribution(WhichParameter whichParameter, const IDistribution1D& distribution,
                          size_t nbr_samples, double sigma_factor = 0.0,
                          const RealLimits& limits = RealLimits());
 
    ParameterDistribution(WhichParameter whichParameter, const IDistribution1D& distribution,
                          size_t nbr_samples, double xmin, double xmax);
 
 
    ParameterDistribution(const ParameterDistribution& other);
    virtual ~ParameterDistribution();
 
    //! Overload assignment operator
    ParameterDistribution& operator=(const ParameterDistribution& other);
 
    WhichParameter whichParameter() const;
    std::string whichParameterAsPyEnum() const;
 
    //! get number of samples for this distribution
    size_t nDraws() const;
 
    //! get the sigma factor
    double sigmaFactor() const { return m_sigma_factor; }
 
    const IDistribution1D* getDistribution() const;
    IDistribution1D* getDistribution();
 
    //! generate list of sampled values with their weight
    std::vector<ParameterSample> generateSamples() const;
 
    RealLimits getLimits() const { return m_limits; }
 
    double getMinValue() const { return m_xmin; }
    double getMaxValue() const { return m_xmax; }
 
private:
    WhichParameter m_whichParameter;
    std::unique_ptr<IDistribution1D> m_distribution;
    size_t m_nbr_samples;
    double m_sigma_factor;
    RealLimits m_limits;
    double m_xmin;
    double m_xmax;
};
 
#endif // BORNAGAIN_PARAM_DISTRIB_PARAMETERDISTRIBUTION_H