1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
|
// ************************************************************************************************
//
// 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 <memory>
#include <string>
#include <vector>
class IDistribution1D;
struct ParameterSample;
//! 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,
BeamGrazingAngle,
BeamAzimuthalAngle
};
ParameterDistribution(WhichParameter whichParameter, const IDistribution1D& distribution);
ParameterDistribution(const ParameterDistribution& other);
virtual ~ParameterDistribution();
#ifndef SWIG
//... Getters:
WhichParameter whichParameter() const { return m_which_parameter; }
const IDistribution1D* getDistribution() const { return m_distribution.get(); }
//! get number of samples for this distribution
size_t nDraws() const;
double relSamplingWidth() const;
std::string whichParameterAsPyEnum() const;
//! generate list of sampled values with their weight
std::vector<ParameterSample> generateSamples() const;
std::string unitOfParameter() const;
private:
WhichParameter m_which_parameter;
std::unique_ptr<IDistribution1D> m_distribution;
#endif // SWIG
};
#endif // BORNAGAIN_PARAM_DISTRIB_PARAMETERDISTRIBUTION_H
|
