BornAgain  1.19.79
Open-source research software to simulate and fit neutron and x-ray reflectometry and grazing-incidence small-angle scattering
ParameterDistribution Class Reference

Description

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

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< ParameterSamplegenerateSamples () 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...
 
ParameterDistributionoperator= (const ParameterDistribution &other)
 Overload assignment operator. More...
 
double sigmaFactor () const
 get the sigma factor More...
 
WhichParameter whichParameter () const
 
std::string whichParameterAsPyEnum () const
 

Member Enumeration Documentation

◆ WhichParameter

Enumerator
None 
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() 
)

◆ ParameterDistribution() [2/3]

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

◆ ParameterDistribution() [3/3]

ParameterDistribution::ParameterDistribution ( const ParameterDistribution other)

◆ ~ParameterDistribution()

virtual ParameterDistribution::~ParameterDistribution ( )
virtual

Member Function Documentation

◆ generateSamples()

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

generate list of sampled values with their weight

◆ getDistribution() [1/2]

IDistribution1D* ParameterDistribution::getDistribution ( )

◆ getDistribution() [2/2]

const IDistribution1D* ParameterDistribution::getDistribution ( ) const

◆ getLimits()

RealLimits ParameterDistribution::getLimits ( ) const

◆ getMaxValue()

double ParameterDistribution::getMaxValue ( ) const

◆ getMinValue()

double ParameterDistribution::getMinValue ( ) const

◆ nDraws()

size_t ParameterDistribution::nDraws ( ) const

get number of samples for this distribution

◆ operator=()

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

Overload assignment operator.

◆ sigmaFactor()

double ParameterDistribution::sigmaFactor ( ) const

get the sigma factor

◆ whichParameter()

WhichParameter ParameterDistribution::whichParameter ( ) const

◆ whichParameterAsPyEnum()

std::string ParameterDistribution::whichParameterAsPyEnum ( ) const