BornAgain  1.18.0
Simulate and fit neutron and x-ray scattering at grazing incidence
Public Types | Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
DistributionHandler Class Reference
Inheritance diagram for DistributionHandler:
Collaboration diagram for DistributionHandler:

Public Types

typedef std::vector< ParameterDistribution > Distributions_t
 

Public Member Functions

 DistributionHandler ()
 
virtual ~DistributionHandler ()
 
void addParameterDistribution (const std::string &param_name, const IDistribution1D &distribution, size_t nbr_samples, double sigma_factor=0.0, const RealLimits &limits=RealLimits())
 
void addParameterDistribution (const ParameterDistribution &par_distr)
 
size_t getTotalNumberOfSamples () const
 
double setParameterValues (ParameterPool *p_parameter_pool, size_t index)
 
void setParameterToMeans (ParameterPool *p_parameter_pool) const
 
const Distributions_t & getDistributions () const
 
ParameterPool * parameterPool () const
 
virtual ParameterPool * createParameterTree () const
 
std::string parametersToString () const
 
RealParameter & registerParameter (const std::string &name, double *parpointer)
 
void registerVector (const std::string &base_name, kvector_t *p_vec, const std::string &units="nm")
 
void setParameterValue (const std::string &name, double value)
 
void setVectorValue (const std::string &base_name, kvector_t value)
 
RealParameter * parameter (const std::string &name) const
 
virtual void onChange ()
 
void removeParameter (const std::string &name)
 
void removeVector (const std::string &base_name)
 
void setName (const std::string &name)
 
const std::string & getName () const
 

Static Public Member Functions

static std::string XComponentName (const std::string &base_name)
 
static std::string YComponentName (const std::string &base_name)
 
static std::string ZComponentName (const std::string &base_name)
 

Private Attributes

size_t m_nbr_combinations
 
Distributions_t m_distributions
 
std::vector< std::vector< ParameterSample > > m_cached_samples
 
std::string m_name
 
std::unique_ptr< ParameterPool > m_pool
 

Detailed Description

Provides the functionality to average over parameter distributions with weights.

Definition at line 24 of file DistributionHandler.h.

Member Typedef Documentation

◆ Distributions_t

typedef std::vector<ParameterDistribution> DistributionHandler::Distributions_t

Definition at line 27 of file DistributionHandler.h.

Constructor & Destructor Documentation

◆ DistributionHandler()

DistributionHandler::DistributionHandler ( )

Definition at line 20 of file DistributionHandler.cpp.

20  : m_nbr_combinations(1)
21 {
22  setName("DistributionHandler");
23 }
IParameterized::setName
void setName(const std::string &name)
Definition: IParameterized.h:68

References IParameterized::setName().

Here is the call graph for this function:

◆ ~DistributionHandler()

DistributionHandler::~DistributionHandler ( )
virtualdefault

Member Function Documentation

◆ addParameterDistribution() [1/2]

void DistributionHandler::addParameterDistribution ( const std::string &  param_name,
const IDistribution1D &  distribution,
size_t  nbr_samples,
double  sigma_factor = 0.0,
const RealLimits &  limits = RealLimits() 
)

add a sampled parameter distribution

Referenced by Simulation::addParameterDistribution().

◆ addParameterDistribution() [2/2]

void DistributionHandler::addParameterDistribution ( const ParameterDistribution &  par_distr)

Definition at line 27 of file DistributionHandler.cpp.

28 {
29  if (par_distr.getNbrSamples() > 0) {
30  m_distributions.push_back(par_distr);
31  m_nbr_combinations *= par_distr.getNbrSamples();
32  m_cached_samples.push_back(par_distr.generateSamples());
33  }
34 }
DistributionHandler::m_distributions
Distributions_t m_distributions
Definition: DistributionHandler.h:56
DistributionHandler::m_cached_samples
std::vector< std::vector< ParameterSample > > m_cached_samples
Definition: DistributionHandler.h:57
ParameterDistribution::getNbrSamples
size_t getNbrSamples() const
get number of samples for this distribution
Definition: ParameterDistribution.cpp:93
ParameterDistribution::generateSamples
std::vector< ParameterSample > generateSamples() const
generate list of sampled values with their weight
Definition: ParameterDistribution.cpp:100

References ParameterDistribution::generateSamples(), ParameterDistribution::getNbrSamples(), m_cached_samples, m_distributions, and m_nbr_combinations.

Here is the call graph for this function:

◆ getTotalNumberOfSamples()

size_t DistributionHandler::getTotalNumberOfSamples ( ) const

get the total number of parameter value combinations (product of the individual sizes of each parameter distribution

Definition at line 36 of file DistributionHandler.cpp.

37 {
38  return m_nbr_combinations;
39 }

References m_nbr_combinations.

Referenced by Simulation::runSimulation().

◆ setParameterValues()

double DistributionHandler::setParameterValues ( ParameterPool *  p_parameter_pool,
size_t  index 
)

set the parameter values of the simulation object to a specific combination of values, determined by the index (which must be smaller than the total number of combinations) and returns the weight associated with this combination of parameter values

Definition at line 41 of file DistributionHandler.cpp.

42 {
43  if (index >= m_nbr_combinations)
44  throw Exceptions::RuntimeErrorException(
45  "DistributionWeighter::setParameterValues: "
46  "index must be smaller than the total number of parameter combinations");
47  size_t n_distr = m_distributions.size();
48  double weight = 1.0;
49  if (n_distr == 0)
50  return weight;
51  for (size_t param_index = n_distr - 1;; --param_index) {
52  size_t remainder = index % m_distributions[param_index].getNbrSamples();
53  index /= m_distributions[param_index].getNbrSamples();
54  int changed = p_parameter_pool->setMatchedParametersValue(
55  m_distributions[param_index].getMainParameterName(),
56  m_cached_samples[param_index][remainder].value);
57  if (changed != 1) {
58  throw Exceptions::RuntimeErrorException("DistributionWeighter::setParameterValues: "
59  "parameter name matches nothing or more than "
60  "one parameter");
61  }
62  weight *= m_cached_samples[param_index][remainder].weight;
63  if (param_index == 0)
64  break;
65  }
66  return weight;
67 }
ParameterPool::setMatchedParametersValue
int setMatchedParametersValue(const std::string &wildcards, double value)
Sets value of the nonzero parameters that match pattern ('*' allowed), or throws.
Definition: ParameterPool.cpp:147

References m_cached_samples, m_distributions, m_nbr_combinations, and ParameterPool::setMatchedParametersValue().

Referenced by Simulation::runSimulation().

Here is the call graph for this function:

◆ setParameterToMeans()

void DistributionHandler::setParameterToMeans ( ParameterPool *  p_parameter_pool) const

Sets mean distribution values to the parameter pool.

Definition at line 69 of file DistributionHandler.cpp.

70 {
71  for (auto& distribution : m_distributions) {
72  const std::string par_name = distribution.getMainParameterName();
73  const double mean_val = distribution.getDistribution()->getMean();
74  if (p_parameter_pool->setMatchedParametersValue(par_name, mean_val) != 1)
75  throw std::runtime_error("Error in DistributionHandler::setParameterToMeans: parameter "
76  "name matches nothing or more than "
77  "one parameter");
78  }
79 }

References m_distributions, and ParameterPool::setMatchedParametersValue().

Referenced by Simulation::runSimulation().

Here is the call graph for this function:

◆ getDistributions()

const DistributionHandler::Distributions_t & DistributionHandler::getDistributions ( ) const

Definition at line 81 of file DistributionHandler.cpp.

82 {
83  return m_distributions;
84 }

References m_distributions.

Referenced by SimulationToPython::defineParameterDistributions().

◆ parameterPool()

ParameterPool* IParameterized::parameterPool ( ) const
inlineinherited

Returns pointer to the parameter pool.

Definition at line 38 of file IParameterized.h.

38 { return m_pool.get(); } // has non-const usages!
IParameterized::m_pool
std::unique_ptr< ParameterPool > m_pool
parameter pool (kind of pointer-to-implementation)
Definition: IParameterized.h:73

References IParameterized::m_pool.

Referenced by pyfmt2::argumentList(), SampleBuilderNode::borrow_builder_parameters(), INode::createParameterTree(), INode::INode(), IParameterized::IParameterized(), anonymous_namespace{NodeUtils.cpp}::poolToString(), SampleBuilderNode::reset(), and IDistribution1D::setUnits().

◆ createParameterTree()

ParameterPool * IParameterized::createParameterTree ( ) const
virtualinherited

Creates new parameter pool, with all local parameters and those of its children.

Reimplemented in INode.

Definition at line 33 of file IParameterized.cpp.

34 {
35  auto* result = new ParameterPool;
36  m_pool->copyToExternalPool("/" + getName() + "/", result);
37  return result;
38 }
IParameterized::getName
const std::string & getName() const
Definition: IParameterized.h:69
ParameterPool
Container with parameters for IParameterized object.
Definition: ParameterPool.h:30

References IParameterized::getName(), and IParameterized::m_pool.

Referenced by IParameterized::parametersToString(), ParameterUtils::poolParameterUnits(), and IParameterized::setParameterValue().

Here is the call graph for this function:

◆ parametersToString()

std::string IParameterized::parametersToString ( ) const
inherited

Returns multiline string representing available parameters.

Definition at line 40 of file IParameterized.cpp.

41 {
42  std::ostringstream result;
43  std::unique_ptr<ParameterPool> P_pool(createParameterTree());
44  result << *P_pool << "\n";
45  return result.str();
46 }
IParameterized::createParameterTree
virtual ParameterPool * createParameterTree() const
Creates new parameter pool, with all local parameters and those of its children.
Definition: IParameterized.cpp:33

References IParameterized::createParameterTree().

Here is the call graph for this function:

◆ registerParameter()

RealParameter & IParameterized::registerParameter ( const std::string &  name,
double *  parpointer 
)
inherited

Definition at line 48 of file IParameterized.cpp.

49 {
50  return m_pool->addParameter(
51  new RealParameter(name, data, getName(), [&]() -> void { onChange(); }));
52 }
IParameterized::onChange
virtual void onChange()
Action to be taken in inherited class when a parameter has changed.
Definition: IParameterized.h:58
RealParameter
Wraps a parameter of type double.
Definition: RealParameter.h:32

References IParameterized::getName(), IParameterized::m_pool, and IParameterized::onChange().

Referenced by BasicLattice::BasicLattice(), Beam::Beam(), CylindersInBABuilder::CylindersInBABuilder(), DetectionProperties::DetectionProperties(), HexagonalLattice::HexagonalLattice(), IInterferenceFunction::IInterferenceFunction(), INode::INode(), InterferenceFunction1DLattice::InterferenceFunction1DLattice(), InterferenceFunction2DParaCrystal::InterferenceFunction2DParaCrystal(), InterferenceFunctionHardDisk::InterferenceFunctionHardDisk(), InterferenceFunctionRadialParaCrystal::InterferenceFunctionRadialParaCrystal(), InterferenceFunctionTwin::InterferenceFunctionTwin(), Lattice2D::Lattice2D(), LayerRoughness::LayerRoughness(), MultiLayer::MultiLayer(), ParticleDistribution::ParticleDistribution(), PlainMultiLayerBySLDBuilder::PlainMultiLayerBySLDBuilder(), IParticle::registerAbundance(), ParticleLayout::registerParticleDensity(), Layer::registerThickness(), IParameterized::registerVector(), ParticleLayout::registerWeight(), ResolutionFunction2DGaussian::ResolutionFunction2DGaussian(), ResonatorBuilder::ResonatorBuilder(), Lattice2D::setRotationEnabled(), SquareLattice::SquareLattice(), and TriangularRippleBuilder::TriangularRippleBuilder().

Here is the call graph for this function:

◆ registerVector()

void IParameterized::registerVector ( const std::string &  base_name,
kvector_t *  p_vec,
const std::string &  units = "nm" 
)
inherited

Definition at line 54 of file IParameterized.cpp.

56 {
57  registerParameter(XComponentName(base_name), &((*p_vec)[0])).setUnit(units);
58  registerParameter(YComponentName(base_name), &((*p_vec)[1])).setUnit(units);
59  registerParameter(ZComponentName(base_name), &((*p_vec)[2])).setUnit(units);
60 }
IParameterized::registerParameter
RealParameter & registerParameter(const std::string &name, double *parpointer)
Definition: IParameterized.cpp:48
IParameterized::XComponentName
static std::string XComponentName(const std::string &base_name)
Definition: IParameterized.cpp:100
IParameterized::YComponentName
static std::string YComponentName(const std::string &base_name)
Definition: IParameterized.cpp:105
IParameterized::ZComponentName
static std::string ZComponentName(const std::string &base_name)
Definition: IParameterized.cpp:110
RealParameter::setUnit
RealParameter & setUnit(const std::string &name)
Definition: RealParameter.cpp:97

References IParameterized::registerParameter(), RealParameter::setUnit(), IParameterized::XComponentName(), IParameterized::YComponentName(), and IParameterized::ZComponentName().

Referenced by Beam::Beam(), DetectionProperties::DetectionProperties(), InterferenceFunctionTwin::InterferenceFunctionTwin(), MultiLayer::MultiLayer(), Lattice::registerBasisVectors(), and IParticle::registerPosition().

Here is the call graph for this function:

◆ setParameterValue()

void IParameterized::setParameterValue ( const std::string &  name,
double  value 
)
inherited

Definition at line 62 of file IParameterized.cpp.

63 {
64  if (name.find('*') == std::string::npos && name.find('/') == std::string::npos) {
65  m_pool->setParameterValue(name, value);
66  } else {
67  std::unique_ptr<ParameterPool> P_pool{createParameterTree()};
68  if (name.find('*') != std::string::npos)
69  P_pool->setMatchedParametersValue(name, value);
70  else
71  P_pool->setParameterValue(name, value);
72  }
73 }

References IParameterized::createParameterTree(), IParameterized::m_pool, and ParameterPool::setMatchedParametersValue().

Referenced by AsymRippleBuilder::buildSample(), and IParameterized::setVectorValue().

Here is the call graph for this function:

◆ setVectorValue()

void IParameterized::setVectorValue ( const std::string &  base_name,
kvector_t  value 
)
inherited

Definition at line 75 of file IParameterized.cpp.

76 {
77  setParameterValue(XComponentName(base_name), value.x());
78  setParameterValue(YComponentName(base_name), value.y());
79  setParameterValue(ZComponentName(base_name), value.z());
80 }
BasicVector3D::z
T z() const
Returns z-component in cartesian coordinate system.
Definition: BasicVector3D.h:68
BasicVector3D::y
T y() const
Returns y-component in cartesian coordinate system.
Definition: BasicVector3D.h:66
BasicVector3D::x
T x() const
Returns x-component in cartesian coordinate system.
Definition: BasicVector3D.h:64
IParameterized::setParameterValue
void setParameterValue(const std::string &name, double value)
Definition: IParameterized.cpp:62

References IParameterized::setParameterValue(), BasicVector3D< T >::x(), IParameterized::XComponentName(), BasicVector3D< T >::y(), IParameterized::YComponentName(), BasicVector3D< T >::z(), and IParameterized::ZComponentName().

Here is the call graph for this function:

◆ parameter()

RealParameter * IParameterized::parameter ( const std::string &  name) const
inherited

Returns parameter with given 'name'.

Definition at line 83 of file IParameterized.cpp.

84 {
85  return m_pool->parameter(name);
86 }

References IParameterized::m_pool.

Referenced by DepthProbeSimulation::initialize(), SpecularSimulation::initialize(), IParticle::registerAbundance(), Lattice::registerBasisVectors(), ParticleLayout::registerParticleDensity(), IParticle::registerPosition(), Layer::registerThickness(), Lattice2D::setRotationEnabled(), and DistributionLogNormal::setUnits().

◆ onChange()

virtual void IParameterized::onChange ( )
inlinevirtualinherited

Action to be taken in inherited class when a parameter has changed.

Reimplemented in IProfileRipple, FormFactorSphereLogNormalRadius, FormFactorSphereGaussianRadius, FormFactorGaussSphere, ISawtoothRipple, ICosineRipple, IProfileRectangularRipple, FormFactorTruncatedSpheroid, FormFactorTruncatedSphere, FormFactorTruncatedCube, FormFactorTetrahedron, FormFactorPyramid, FormFactorPrism6, FormFactorPrism3, FormFactorLongBoxLorentz, FormFactorLongBoxGauss, FormFactorIcosahedron, FormFactorHollowSphere, FormFactorHemiEllipsoid, FormFactorFullSpheroid, FormFactorFullSphere, FormFactorEllipsoidalCylinder, FormFactorDodecahedron, FormFactorCylinder, FormFactorCuboctahedron, FormFactorCone6, FormFactorCone, FormFactorCantellatedCube, FormFactorBox, FormFactorAnisoPyramid, InterferenceFunction3DLattice, InterferenceFunction2DLattice, Lattice, and Lattice2D.

Definition at line 58 of file IParameterized.h.

58 {}

Referenced by Lattice2D::onChange(), and IParameterized::registerParameter().

◆ removeParameter()

void IParameterized::removeParameter ( const std::string &  name)
inherited

Definition at line 88 of file IParameterized.cpp.

89 {
90  m_pool->removeParameter(name);
91 }

References IParameterized::m_pool.

Referenced by IParticle::registerAbundance(), ParticleLayout::registerParticleDensity(), Layer::registerThickness(), IParameterized::removeVector(), and Lattice2D::setRotationEnabled().

◆ removeVector()

void IParameterized::removeVector ( const std::string &  base_name)
inherited

Definition at line 93 of file IParameterized.cpp.

94 {
95  removeParameter(XComponentName(base_name));
96  removeParameter(YComponentName(base_name));
97  removeParameter(ZComponentName(base_name));
98 }
IParameterized::removeParameter
void removeParameter(const std::string &name)
Definition: IParameterized.cpp:88

References IParameterized::removeParameter(), IParameterized::XComponentName(), IParameterized::YComponentName(), and IParameterized::ZComponentName().

Referenced by IParticle::registerPosition().

Here is the call graph for this function:

◆ XComponentName()

std::string IParameterized::XComponentName ( const std::string &  base_name)
staticinherited

Definition at line 100 of file IParameterized.cpp.

101 {
102  return base_name + "X";
103 }

Referenced by Lattice::registerBasisVectors(), IParticle::registerPosition(), IParameterized::registerVector(), IParameterized::removeVector(), and IParameterized::setVectorValue().

◆ YComponentName()

std::string IParameterized::YComponentName ( const std::string &  base_name)
staticinherited

Definition at line 105 of file IParameterized.cpp.

106 {
107  return base_name + "Y";
108 }

Referenced by IParameterized::registerVector(), IParameterized::removeVector(), and IParameterized::setVectorValue().

◆ ZComponentName()

std::string IParameterized::ZComponentName ( const std::string &  base_name)
staticinherited

Definition at line 110 of file IParameterized.cpp.

111 {
112  return base_name + "Z";
113 }

Referenced by IParameterized::registerVector(), IParameterized::removeVector(), and IParameterized::setVectorValue().

◆ setName()

void IParameterized::setName ( const std::string &  name)
inlineinherited

Definition at line 68 of file IParameterized.h.

68 { m_name = name; }
IParameterized::m_name
std::string m_name
Definition: IParameterized.h:72

References IParameterized::m_name.

Referenced by BasicLattice::BasicLattice(), Beam::Beam(), Layer::clone(), ConvolutionDetectorResolution::ConvolutionDetectorResolution(), LayersWithAbsorptionBuilder::createSampleByIndex(), Basic2DParaCrystalBuilder::createSampleByIndex(), ParticleInVacuumBuilder::createSampleByIndex(), SimpleMagneticRotationBuilder::createSampleByIndex(), Crystal::Crystal(), DetectionProperties::DetectionProperties(), DistributionHandler(), FormFactorBAPol::FormFactorBAPol(), FormFactorCoreShell::FormFactorCoreShell(), FormFactorCrystal::FormFactorCrystal(), FormFactorDecoratorMaterial::FormFactorDecoratorMaterial(), FormFactorDecoratorPositionFactor::FormFactorDecoratorPositionFactor(), FormFactorDecoratorRotation::FormFactorDecoratorRotation(), FormFactorDWBA::FormFactorDWBA(), FormFactorDWBAPol::FormFactorDWBAPol(), FormFactorWeighted::FormFactorWeighted(), HexagonalLattice::HexagonalLattice(), IDetector::IDetector(), DepthProbeSimulation::initialize(), GISASSimulation::initialize(), OffSpecSimulation::initialize(), SpecularSimulation::initialize(), SpecularDetector1D::initialize(), MesoCrystal::initialize(), Particle::initialize(), ParticleComposition::initialize(), INode::INode(), Instrument::Instrument(), InterferenceFunction1DLattice::InterferenceFunction1DLattice(), InterferenceFunction2DLattice::InterferenceFunction2DLattice(), InterferenceFunction2DParaCrystal::InterferenceFunction2DParaCrystal(), InterferenceFunction2DSuperLattice::InterferenceFunction2DSuperLattice(), InterferenceFunction3DLattice::InterferenceFunction3DLattice(), InterferenceFunctionFinite2DLattice::InterferenceFunctionFinite2DLattice(), InterferenceFunctionFinite3DLattice::InterferenceFunctionFinite3DLattice(), InterferenceFunctionHardDisk::InterferenceFunctionHardDisk(), InterferenceFunctionNone::InterferenceFunctionNone(), InterferenceFunctionRadialParaCrystal::InterferenceFunctionRadialParaCrystal(), InterferenceFunctionTwin::InterferenceFunctionTwin(), ISampleBuilder::ISampleBuilder(), IsGISAXSDetector::IsGISAXSDetector(), Lattice::Lattice(), Layer::Layer(), LayerInterface::LayerInterface(), LayerRoughness::LayerRoughness(), MultiLayer::MultiLayer(), Beam::operator=(), SampleBuilderNode::operator=(), ParticleCoreShell::ParticleCoreShell(), ParticleDistribution::ParticleDistribution(), ParticleLayout::ParticleLayout(), RectangularDetector::RectangularDetector(), SampleBuilderNode::reset(), ResolutionFunction2DGaussian::ResolutionFunction2DGaussian(), SampleBuilderNode::SampleBuilderNode(), SampleBuilderNode::setSBN(), SphericalDetector::SphericalDetector(), and SquareLattice::SquareLattice().

◆ getName()

const std::string& IParameterized::getName ( ) const
inlineinherited

Definition at line 69 of file IParameterized.h.

69 { return m_name; }

References IParameterized::m_name.

Referenced by Beam::Beam(), Layer::clone(), IFormFactorBorn::computeSlicingEffects(), ConvolutionDetectorResolution::ConvolutionDetectorResolution(), INode::copyNumber(), IParameterized::createParameterTree(), IFormFactor::createSlicedFormFactor(), SampleToPython::defineFormFactors(), SampleToPython::defineInterferenceFunctions(), INode::displayName(), IDetector::IDetector(), Instrument::Instrument(), IParameterized::IParameterized(), Beam::operator=(), SampleBuilderNode::operator=(), anonymous_namespace{ParticleLayout.cpp}::particleDensityIsProvidedByInterference(), IParameterized::registerParameter(), SampleBuilderNode::SampleBuilderNode(), and IFormFactor::sliceFormFactor().

Member Data Documentation

◆ m_nbr_combinations

size_t DistributionHandler::m_nbr_combinations
private

Definition at line 55 of file DistributionHandler.h.

Referenced by addParameterDistribution(), getTotalNumberOfSamples(), and setParameterValues().

◆ m_distributions

Distributions_t DistributionHandler::m_distributions
private

Definition at line 56 of file DistributionHandler.h.

Referenced by addParameterDistribution(), getDistributions(), setParameterToMeans(), and setParameterValues().

◆ m_cached_samples

std::vector<std::vector<ParameterSample> > DistributionHandler::m_cached_samples
private

Definition at line 57 of file DistributionHandler.h.

Referenced by addParameterDistribution(), and setParameterValues().

◆ m_name

std::string IParameterized::m_name
privateinherited

Definition at line 72 of file IParameterized.h.

Referenced by IParameterized::getName(), and IParameterized::setName().

◆ m_pool

std::unique_ptr<ParameterPool> IParameterized::m_pool
privateinherited

parameter pool (kind of pointer-to-implementation)

Definition at line 73 of file IParameterized.h.

Referenced by IParameterized::createParameterTree(), IParameterized::parameter(), IParameterized::parameterPool(), IParameterized::registerParameter(), IParameterized::removeParameter(), and IParameterized::setParameterValue().

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