Description

A parametric distribution function, for use with any model parameter.

Definition at line 27 of file ParameterDistribution.h.

Collaboration diagram for ParameterDistribution:

Public Types
enum	WhichParameter { None , BeamWavelength , BeamInclinationAngle , BeamAzimuthalAngle }

Public Member Functions
	ParameterDistribution (const ParameterDistribution &other)

	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)

virtual	~ParameterDistribution ()

std::vector< ParameterSample >	generateSamples () const
	generate list of sampled values with their weight More...

IDistribution1D *	getDistribution ()

const IDistribution1D *	getDistribution () const

RealLimits	getLimits () const

double	getMaxValue () const

double	getMinValue () const

size_t	nDraws () const
	get number of samples for this distribution More...

ParameterDistribution &	operator= (const ParameterDistribution &other)
	Overload assignment operator. More...

double	sigmaFactor () const
	get the sigma factor More...

WhichParameter	whichParameter () const

std::string	whichParameterAsPyEnum () const

Private Attributes
std::unique_ptr< IDistribution1D >	m_distribution

RealLimits	m_limits

size_t	m_nbr_samples

double	m_sigma_factor

WhichParameter	m_whichParameter

double	m_xmax

double	m_xmin

Member Enumeration Documentation

◆ WhichParameter

enum ParameterDistribution::WhichParameter

Enumerator
None
BeamWavelength
BeamInclinationAngle
BeamAzimuthalAngle

Definition at line 29 of file ParameterDistribution.h.

                         {
         None, // #baPool ++ really necessary?? Try to refactor the relevant place
         BeamWavelength,
         BeamInclinationAngle,
         BeamAzimuthalAngle
     };

Constructor & Destructor Documentation

◆ ParameterDistribution() [1/3]

ParameterDistribution::ParameterDistribution	(	WhichParameter	whichParameter,
		const IDistribution1D &	distribution,
		size_t	nbr_samples,
		double	sigma_factor = `0.0`,
		const RealLimits &	limits = `RealLimits()`
	)

Definition at line 18 of file ParameterDistribution.cpp.

     : m_whichParameter(whichParameter)
     , m_nbr_samples(nbr_samples)
     , m_sigma_factor(sigma_factor)
     , m_limits(limits)
     , m_xmin(1.0)
     , m_xmax(-1.0)
 {
     m_distribution.reset(distribution.clone());
     if (m_sigma_factor < 0.0)
         throw std::runtime_error("ParameterDistribution::ParameterDistribution() -> Error."
                                  "sigma factor cannot be negative");
     if (nbr_samples == 0)
         throw std::runtime_error("ParameterDistribution::ParameterDistribution() -> Error."
                                  "Number of samples can't be zero.");
 }

References IDistribution1D::clone(), m_distribution, and m_sigma_factor.

Here is the call graph for this function:

◆ ParameterDistribution() [2/3]

ParameterDistribution::ParameterDistribution	(	WhichParameter	whichParameter,
		const IDistribution1D &	distribution,
		size_t	nbr_samples,
		double	xmin,
		double	xmax
	)

Definition at line 38 of file ParameterDistribution.cpp.

     : m_whichParameter(whichParameter)
     , m_nbr_samples(nbr_samples)
     , m_sigma_factor(0.0)
     , m_xmin(xmin)
     , m_xmax(xmax)
 {
     m_distribution.reset(distribution.clone());
     if (m_sigma_factor < 0.0)
         throw std::runtime_error("ParameterDistribution::ParameterDistribution() -> Error."
                                  "sigma factor cannot be negative");
     if (nbr_samples == 0)
         throw std::runtime_error("ParameterDistribution::ParameterDistribution() -> Error."
                                  "Number of samples can't be zero.");
     if (xmin >= xmax)
         throw std::runtime_error("ParameterDistribution::ParameterDistribution() -> Error."
                                  "xmin>=xmax");
 }

References IDistribution1D::clone(), m_distribution, and m_sigma_factor.

Here is the call graph for this function:

◆ ParameterDistribution() [3/3]

ParameterDistribution::ParameterDistribution ( const ParameterDistribution & other )

Definition at line 59 of file ParameterDistribution.cpp.

     : m_whichParameter(other.m_whichParameter)
     , m_nbr_samples(other.m_nbr_samples)
     , m_sigma_factor(other.m_sigma_factor)
     , m_limits(other.m_limits)
     , m_xmin(other.m_xmin)
     , m_xmax(other.m_xmax)
 {
     m_distribution.reset(other.m_distribution->clone());
 }

References m_distribution.

◆ ~ParameterDistribution()

ParameterDistribution::~ParameterDistribution ( )

virtualdefault

Member Function Documentation

◆ generateSamples()

std::vector< ParameterSample > ParameterDistribution::generateSamples ( ) const

generate list of sampled values with their weight

Definition at line 112 of file ParameterDistribution.cpp.

 {
     if (m_xmin < m_xmax)
         return m_distribution->equidistantSamplesInRange(m_nbr_samples, m_xmin, m_xmax);
     return m_distribution->equidistantSamples(m_nbr_samples, m_sigma_factor, m_limits);
 }

References m_distribution, m_limits, m_nbr_samples, m_sigma_factor, m_xmax, and m_xmin.

Referenced by DistributionHandler::addParameterDistribution().

◆ getDistribution() [1/2]

IDistribution1D * ParameterDistribution::getDistribution ( )

Definition at line 124 of file ParameterDistribution.cpp.

 {
     return m_distribution.get();
 }

References m_distribution.

◆ getDistribution() [2/2]

const IDistribution1D * ParameterDistribution::getDistribution ( ) const

Definition at line 119 of file ParameterDistribution.cpp.

 {
     return m_distribution.get();
 }

References m_distribution.

Referenced by DepthProbeSimulation::validateParametrization(), OffspecSimulation::validateParametrization(), and SpecularSimulation::validateParametrization().

◆ getLimits()

RealLimits ParameterDistribution::getLimits ( ) const

inline

Definition at line 65 of file ParameterDistribution.h.

65 { return m_limits; }

References m_limits.

Referenced by Py::Fmt2::printParameterDistribution().

◆ getMaxValue()

double ParameterDistribution::getMaxValue ( ) const

inline

Definition at line 68 of file ParameterDistribution.h.

68 { return m_xmax; }

References m_xmax.

◆ getMinValue()

double ParameterDistribution::getMinValue ( ) const

inline

Definition at line 67 of file ParameterDistribution.h.

67 { return m_xmin; }

References m_xmin.

◆ nDraws()

size_t ParameterDistribution::nDraws ( ) const

get number of samples for this distribution

Definition at line 105 of file ParameterDistribution.cpp.

 {
     if (m_distribution && m_distribution->isDelta())
         return 1;
     return m_nbr_samples;
 }

References m_distribution, and m_nbr_samples.

Referenced by DistributionHandler::addParameterDistribution(), and Py::Fmt2::printParameterDistribution().

◆ operator=()

ParameterDistribution & ParameterDistribution::operator= ( const ParameterDistribution & other )

Overload assignment operator.

Definition at line 72 of file ParameterDistribution.cpp.

 {
     if (this != &other) {
         this->m_whichParameter = other.m_whichParameter;
         m_nbr_samples = other.m_nbr_samples;
         m_sigma_factor = other.m_sigma_factor;
         m_distribution.reset(other.m_distribution->clone());
         m_limits = other.m_limits;
         m_xmin = other.m_xmin;
         m_xmax = other.m_xmax;
     }
     return *this;
 }

References m_distribution, m_limits, m_nbr_samples, m_sigma_factor, m_whichParameter, m_xmax, and m_xmin.

◆ sigmaFactor()

double ParameterDistribution::sigmaFactor ( ) const

inline

get the sigma factor

Definition at line 57 of file ParameterDistribution.h.

57 { return m_sigma_factor; }

References m_sigma_factor.

Referenced by Py::Fmt2::printParameterDistribution().

◆ whichParameter()

ParameterDistribution::WhichParameter ParameterDistribution::whichParameter ( ) const

Definition at line 86 of file ParameterDistribution.cpp.

 {
     return m_whichParameter;
 }

References m_whichParameter.

Referenced by whichParameterAsPyEnum().

◆ whichParameterAsPyEnum()

std::string ParameterDistribution::whichParameterAsPyEnum ( ) const

Definition at line 91 of file ParameterDistribution.cpp.

 {
     switch (whichParameter()) {
     case ParameterDistribution::BeamWavelength:
         return "ParameterDistribution.BeamWavelength";
     case ParameterDistribution::BeamInclinationAngle:
         return "ParameterDistribution.BeamInclinationAngle";
     case ParameterDistribution::BeamAzimuthalAngle:
         return "ParameterDistribution.BeamAzimuthalAngle";
     default:
         throw std::runtime_error("printParameterDistribution(): missing implementation");
     }
 }

References BeamAzimuthalAngle, BeamInclinationAngle, BeamWavelength, and whichParameter().

Referenced by Py::Fmt2::printParameterDistribution().

Here is the call graph for this function:

Member Data Documentation

◆ m_distribution

std::unique_ptr<IDistribution1D> ParameterDistribution::m_distribution

private

Definition at line 72 of file ParameterDistribution.h.

Referenced by ParameterDistribution(), generateSamples(), getDistribution(), nDraws(), and operator=().

◆ m_limits

RealLimits ParameterDistribution::m_limits

private

Definition at line 75 of file ParameterDistribution.h.

Referenced by generateSamples(), getLimits(), and operator=().

◆ m_nbr_samples

size_t ParameterDistribution::m_nbr_samples

private

Definition at line 73 of file ParameterDistribution.h.

Referenced by generateSamples(), nDraws(), and operator=().

◆ m_sigma_factor

double ParameterDistribution::m_sigma_factor

private

Definition at line 74 of file ParameterDistribution.h.

Referenced by ParameterDistribution(), generateSamples(), operator=(), and sigmaFactor().

◆ m_whichParameter

WhichParameter ParameterDistribution::m_whichParameter

private

Definition at line 71 of file ParameterDistribution.h.

Referenced by operator=(), and whichParameter().

◆ m_xmax

double ParameterDistribution::m_xmax

private

Definition at line 77 of file ParameterDistribution.h.

Referenced by generateSamples(), getMaxValue(), and operator=().

◆ m_xmin

double ParameterDistribution::m_xmin

private

Definition at line 76 of file ParameterDistribution.h.

Referenced by generateSamples(), getMinValue(), and operator=().

The documentation for this class was generated from the following files:

/home/build/builds/o5h8MZZm/0/mlz/bornagain/Param/Distrib/ParameterDistribution.h
/home/build/builds/o5h8MZZm/0/mlz/bornagain/Param/Distrib/ParameterDistribution.cpp

Description

Public Types

Public Member Functions

Private Attributes

Member Enumeration Documentation

◆ WhichParameter

Constructor & Destructor Documentation

◆ ParameterDistribution() [1/3]

◆ ParameterDistribution() [2/3]

◆ ParameterDistribution() [3/3]

◆ ~ParameterDistribution()

Member Function Documentation

◆ generateSamples()

◆ getDistribution() [1/2]

◆ getDistribution() [2/2]

◆ getLimits()

◆ getMaxValue()

◆ getMinValue()

◆ nDraws()

◆ operator=()

◆ sigmaFactor()

◆ whichParameter()

◆ whichParameterAsPyEnum()

Member Data Documentation

◆ m_distribution

◆ m_limits

◆ m_nbr_samples

◆ m_sigma_factor

◆ m_whichParameter

◆ m_xmax

◆ m_xmin