BornAgain  1.19.0
Simulate and fit neutron and x-ray scattering at grazing incidence
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
ISampleBuilder Class Referenceabstract
ISimulation and instrument internals

Interface to the class capable to build samples to simulate. More...

Inheritance diagram for ISampleBuilder:
[legend]
Collaboration diagram for ISampleBuilder:
[legend]

Public Member Functions

 ISampleBuilder ()
 
virtual ~ISampleBuilder ()
 
virtual MultiLayer * buildSample () const =0
 
virtual ParameterPool * createParameterTree () const
 Creates new parameter pool, with all local parameters and those of its children. More...
 
virtual MultiLayer * createSampleByIndex (size_t)
 
const std::string & getName () const
 
virtual void onChange ()
 Action to be taken in inherited class when a parameter has changed. More...
 
RealParameter * parameter (const std::string &name) const
 Returns parameter with given 'name'. More...
 
ParameterPool * parameterPool () const
 Returns pointer to the parameter pool. More...
 
std::string parametersToString () const
 Returns multiline string representing available parameters. More...
 
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 removeParameter (const std::string &name)
 
void removeVector (const std::string &base_name)
 
void setName (const std::string &name)
 
void setParameterValue (const std::string &name, double value)
 
void setVectorValue (const std::string &base_name, kvector_t value)
 
virtual size_t size ()
 

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

std::string m_name
 
std::unique_ptr< ParameterPool > m_pool
 parameter pool (kind of pointer-to-implementation) More...
 

Detailed Description

Interface to the class capable to build samples to simulate.

Definition at line 26 of file ISampleBuilder.h.

Constructor & Destructor Documentation

◆ ISampleBuilder()

ISampleBuilder::ISampleBuilder ( )

Definition at line 17 of file ISampleBuilder.cpp.

18 {
19  setName("SampleBuilder");
20 }
IParametricComponent::setName
void setName(const std::string &name)
Definition: IParametricComponent.h:69

References IParametricComponent::setName().

Here is the call graph for this function:

◆ ~ISampleBuilder()

ISampleBuilder::~ISampleBuilder ( )
virtualdefault

Member Function Documentation

◆ buildSample()

virtual MultiLayer* ISampleBuilder::buildSample ( ) const
pure virtual

Implemented in ThickAbsorptiveSampleBuilder, PlainMultiLayerBySLDBuilder, MultiLayerWithNCRoughnessBuilder, SimpleMagneticRotationBuilder, TwoLayerRoughnessBuilder, SuperLatticeBuilder, FiniteSquareLattice2DBuilder, RotatedSquareLattice2DBuilder, CenteredSquareLattice2DBuilder, SquareLattice2DBuilder, Basic2DLatticeBuilder, TransformBoxBuilder, AveragedSlicedCylindersBuilder, SLDSlicedCylindersBuilder, SlicedCylindersBuilder, SlicedCompositionBuilder, CylindersInSSCABuilder, SizeDistributionSSCAModelBuilder, SizeDistributionLMAModelBuilder, SizeDistributionDAModelBuilder, RotatedPyramidsBuilder, AsymRippleBuilder, TriangularRippleBuilder, CosineRippleBuilder, ResonatorBuilder, HardDiskBuilder, ParticleInVacuumBuilder, LinkedBoxDistributionBuilder, ConesWithLimitsDistributionBuilder, SpheresWithLimitsDistributionBuilder, RotatedPyramidsDistributionBuilder, TwoTypesCylindersDistributionBuilder, CylindersWithSizeDistributionBuilder, ParticleCompositionBuilder, RectParaCrystalBuilder, HexParaCrystalBuilder, Basic2DParaCrystalBuilder, RadialParaCrystalBuilder, MultipleLayoutBuilder, MultiLayerWithRoughnessBuilder, MesoCrystalBuilder, MagneticSpheresBuilder, MagneticCylindersBuilder, MagneticParticleZeroFieldBuilder, MagneticRotationBuilder, MagneticLayerBuilder, SimpleMagneticLayerBuilder, MagneticSubstrateZeroFieldBuilder, LayersWithAbsorptionBySLDBuilder, LayersWithAbsorptionBuilder, Lattice1DBuilder, HomogeneousMultilayerBuilder, FeNiBilayerSpinFlipNCBuilder, FeNiBilayerSpinFlipTanhBuilder, FeNiBilayerSpinFlipBuilder, FeNiBilayerNCBuilder, FeNiBilayerTanhBuilder, FeNiBilayerBuilder, RotatedCylindersBuilder, LargeCylindersInDWBABuilder, CylindersInBABuilder, CylindersInDWBABuilder, CylindersAndPrismsBuilder, CustomMorphologyBuilder, CoreShellBoxRotateZandYBuilder, CoreShellParticleBuilder, BoxesSquareLattice2DBuilder, BoxStackCompositionBuilder, BoxCompositionRotateZandYBuilder, BoxCompositionRotateZBuilder, BoxCompositionRotateYBuilder, BoxCompositionRotateXBuilder, and FixedBuilder.

Referenced by createSampleByIndex().

◆ createParameterTree()

ParameterPool * IParametricComponent::createParameterTree ( ) const
virtualinherited

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

Reimplemented in INode.

Definition at line 36 of file IParametricComponent.cpp.

37 {
38  auto* result = new ParameterPool;
39  m_pool->copyToExternalPool("/" + getName() + "/", result);
40  return result;
41 }
IParametricComponent::getName
const std::string & getName() const
Definition: IParametricComponent.h:70
IParametricComponent::m_pool
std::unique_ptr< ParameterPool > m_pool
parameter pool (kind of pointer-to-implementation)
Definition: IParametricComponent.h:74
ParameterPool
Container with parameters for IParametricComponent object.
Definition: ParameterPool.h:29

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

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

Here is the call graph for this function:

◆ createSampleByIndex()

virtual MultiLayer* ISampleBuilder::createSampleByIndex ( size_t  )
inlinevirtual

Reimplemented in SimpleMagneticRotationBuilder, ParticleInVacuumBuilder, Basic2DParaCrystalBuilder, and LayersWithAbsorptionBuilder.

Definition at line 33 of file ISampleBuilder.h.

33 { return buildSample(); }
ISampleBuilder::buildSample
virtual MultiLayer * buildSample() const =0

References buildSample().

Here is the call graph for this function:

◆ getName()

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

Definition at line 70 of file IParametricComponent.h.

70 { return m_name; }

References IParametricComponent::m_name.

Referenced by Beam::Beam(), ConvolutionDetectorResolution::ConvolutionDetectorResolution(), IDetector::IDetector(), Instrument::Instrument(), IParametricComponent::IParametricComponent(), SampleBuilderNode::SampleBuilderNode(), Layer::clone(), INode::copyNumber(), IParametricComponent::createParameterTree(), IFormFactor::createSlicedFormFactor(), SampleToPython::defineInterferenceFunctions(), INode::displayName(), Beam::operator=(), SampleBuilderNode::operator=(), GUIObjectBuilder::populateInstrumentModel(), PyImportAssistant::populateModels(), GUIDomainSampleVisitor::populateSampleModel(), IParametricComponent::registerParameter(), IFormFactor::sliceFormFactor(), and GUIDomainSampleVisitor::visit().

◆ onChange()

virtual void IParametricComponent::onChange ( )
inlinevirtualinherited

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

Reimplemented in IProfileRipple, Lattice3D, InterferenceFunction3DLattice, InterferenceFunction2DLattice, 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, and Lattice2D.

Definition at line 59 of file IParametricComponent.h.

59 {}

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

◆ parameter()

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

Returns parameter with given 'name'.

Definition at line 86 of file IParametricComponent.cpp.

87 {
88  return m_pool->parameter(name);
89 }
RealSpace::Particles::name
QString const & name(EShape k)
Definition: particles.cpp:21

References IParametricComponent::m_pool, and RealSpace::Particles::name().

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

Here is the call graph for this function:

◆ parameterPool()

ParameterPool* IParametricComponent::parameterPool ( ) const
inlineinherited

Returns pointer to the parameter pool.

Definition at line 39 of file IParametricComponent.h.

39 { return m_pool.get(); } // has non-const usages!

References IParametricComponent::m_pool.

Referenced by INode::INode(), IParametricComponent::IParametricComponent(), pyfmt2::argumentList(), SampleBuilderNode::borrow_builder_parameters(), SampleBuilderNode::reset(), and IDistribution1D::setUnits().

◆ parametersToString()

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

Returns multiline string representing available parameters.

Definition at line 43 of file IParametricComponent.cpp.

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

References IParametricComponent::createParameterTree().

Here is the call graph for this function:

◆ registerParameter()

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

Definition at line 51 of file IParametricComponent.cpp.

52 {
53  return m_pool->addParameter(
54  new RealParameter(name, data, getName(), [&]() -> void { onChange(); }));
55 }
IParametricComponent::onChange
virtual void onChange()
Action to be taken in inherited class when a parameter has changed.
Definition: IParametricComponent.h:59
RealParameter
Wraps a parameter of type double.
Definition: RealParameter.h:31

References IParametricComponent::getName(), IParametricComponent::m_pool, RealSpace::Particles::name(), and IParametricComponent::onChange().

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

Here is the call graph for this function:

◆ registerVector()

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

Definition at line 57 of file IParametricComponent.cpp.

59 {
60  registerParameter(XComponentName(base_name), &((*p_vec)[0])).setUnit(units);
61  registerParameter(YComponentName(base_name), &((*p_vec)[1])).setUnit(units);
62  registerParameter(ZComponentName(base_name), &((*p_vec)[2])).setUnit(units);
63 }
IParametricComponent::XComponentName
static std::string XComponentName(const std::string &base_name)
Definition: IParametricComponent.cpp:103
IParametricComponent::ZComponentName
static std::string ZComponentName(const std::string &base_name)
Definition: IParametricComponent.cpp:113
IParametricComponent::registerParameter
RealParameter & registerParameter(const std::string &name, double *parpointer)
Definition: IParametricComponent.cpp:51
IParametricComponent::YComponentName
static std::string YComponentName(const std::string &base_name)
Definition: IParametricComponent.cpp:108
RealParameter::setUnit
RealParameter & setUnit(const std::string &name)
Definition: RealParameter.cpp:97
ModelView::Utils::base_name
MVVM_MODEL_EXPORT std::string base_name(const std::string &path)
Provide the filename of a file path.
Definition: fileutils.cpp:78

References ModelView::Utils::base_name(), IParametricComponent::registerParameter(), RealParameter::setUnit(), IParametricComponent::XComponentName(), IParametricComponent::YComponentName(), and IParametricComponent::ZComponentName().

Referenced by Beam::Beam(), DetectionProperties::DetectionProperties(), InterferenceFunctionTwin::InterferenceFunctionTwin(), MultiLayer::MultiLayer(), Lattice3D::initialize(), and IParticle::registerPosition().

Here is the call graph for this function:

◆ removeParameter()

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

Definition at line 91 of file IParametricComponent.cpp.

92 {
93  m_pool->removeParameter(name);
94 }

References IParametricComponent::m_pool, and RealSpace::Particles::name().

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

Here is the call graph for this function:

◆ removeVector()

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

Definition at line 96 of file IParametricComponent.cpp.

97 {
98  removeParameter(XComponentName(base_name));
99  removeParameter(YComponentName(base_name));
100  removeParameter(ZComponentName(base_name));
101 }
IParametricComponent::removeParameter
void removeParameter(const std::string &name)
Definition: IParametricComponent.cpp:91

References ModelView::Utils::base_name(), IParametricComponent::removeParameter(), IParametricComponent::XComponentName(), IParametricComponent::YComponentName(), and IParametricComponent::ZComponentName().

Referenced by IParticle::registerPosition().

Here is the call graph for this function:

◆ setName()

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

Definition at line 69 of file IParametricComponent.h.

69 { m_name = name; }

References IParametricComponent::m_name, and RealSpace::Particles::name().

Referenced by BasicLattice2D::BasicLattice2D(), Beam::Beam(), ConvolutionDetectorResolution::ConvolutionDetectorResolution(), Crystal::Crystal(), DetectionProperties::DetectionProperties(), DistributionHandler::DistributionHandler(), FormFactorCoreShell::FormFactorCoreShell(), FormFactorCrystal::FormFactorCrystal(), FormFactorDecoratorMaterial::FormFactorDecoratorMaterial(), FormFactorDecoratorPositionFactor::FormFactorDecoratorPositionFactor(), FormFactorDecoratorRotation::FormFactorDecoratorRotation(), FormFactorWeighted::FormFactorWeighted(), HexagonalLattice2D::HexagonalLattice2D(), IDetector::IDetector(), 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(), IsGISAXSDetector::IsGISAXSDetector(), Lattice3D::Lattice3D(), Layer::Layer(), LayerInterface::LayerInterface(), LayerRoughness::LayerRoughness(), MultiLayer::MultiLayer(), ParticleCoreShell::ParticleCoreShell(), ParticleDistribution::ParticleDistribution(), ParticleLayout::ParticleLayout(), RectangularDetector::RectangularDetector(), ResolutionFunction2DGaussian::ResolutionFunction2DGaussian(), SampleBuilderNode::SampleBuilderNode(), SphericalDetector::SphericalDetector(), SquareLattice2D::SquareLattice2D(), Layer::clone(), LayersWithAbsorptionBuilder::createSampleByIndex(), Basic2DParaCrystalBuilder::createSampleByIndex(), ParticleInVacuumBuilder::createSampleByIndex(), SimpleMagneticRotationBuilder::createSampleByIndex(), DepthProbeSimulation::initialize(), GISASSimulation::initialize(), OffSpecularSimulation::initialize(), SpecularSimulation::initialize(), SpecularDetector1D::initialize(), MesoCrystal::initialize(), Particle::initialize(), ParticleComposition::initialize(), Beam::operator=(), SampleBuilderNode::operator=(), SampleBuilderNode::reset(), and SampleBuilderNode::setSBN().

Here is the call graph for this function:

◆ setParameterValue()

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

Definition at line 65 of file IParametricComponent.cpp.

66 {
67  if (name.find('*') == std::string::npos && name.find('/') == std::string::npos) {
68  m_pool->setParameterValue(name, value);
69  } else {
70  std::unique_ptr<ParameterPool> P_pool{createParameterTree()};
71  if (name.find('*') != std::string::npos)
72  P_pool->setMatchedParametersValue(name, value);
73  else
74  P_pool->setParameterValue(name, value);
75  }
76 }
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:145

References IParametricComponent::createParameterTree(), IParametricComponent::m_pool, RealSpace::Particles::name(), and ParameterPool::setMatchedParametersValue().

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

Here is the call graph for this function:

◆ setVectorValue()

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

Definition at line 78 of file IParametricComponent.cpp.

79 {
80  setParameterValue(XComponentName(base_name), value.x());
81  setParameterValue(YComponentName(base_name), value.y());
82  setParameterValue(ZComponentName(base_name), value.z());
83 }
BasicVector3D::z
T z() const
Returns z-component in cartesian coordinate system.
Definition: BasicVector3D.h:67
BasicVector3D::y
T y() const
Returns y-component in cartesian coordinate system.
Definition: BasicVector3D.h:65
BasicVector3D::x
T x() const
Returns x-component in cartesian coordinate system.
Definition: BasicVector3D.h:63
IParametricComponent::setParameterValue
void setParameterValue(const std::string &name, double value)
Definition: IParametricComponent.cpp:65

References ModelView::Utils::base_name(), IParametricComponent::setParameterValue(), BasicVector3D< T >::x(), IParametricComponent::XComponentName(), BasicVector3D< T >::y(), IParametricComponent::YComponentName(), BasicVector3D< T >::z(), and IParametricComponent::ZComponentName().

Here is the call graph for this function:

◆ size()

virtual size_t ISampleBuilder::size ( )
inlinevirtual

Reimplemented in SimpleMagneticRotationBuilder, ParticleInVacuumBuilder, and LayersWithAbsorptionBuilder.

Definition at line 34 of file ISampleBuilder.h.

34 { return 1; }

Referenced by Basic2DParaCrystalBuilder::createSampleByIndex().

◆ XComponentName()

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

Definition at line 103 of file IParametricComponent.cpp.

104 {
105  return base_name + "X";
106 }

References ModelView::Utils::base_name().

Referenced by Lattice3D::initialize(), IParticle::registerPosition(), IParametricComponent::registerVector(), IParametricComponent::removeVector(), IParametricComponent::setVectorValue(), and VectorParameterTranslator::translate().

Here is the call graph for this function:

◆ YComponentName()

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

Definition at line 108 of file IParametricComponent.cpp.

109 {
110  return base_name + "Y";
111 }

References ModelView::Utils::base_name().

Referenced by IParametricComponent::registerVector(), IParametricComponent::removeVector(), IParametricComponent::setVectorValue(), and VectorParameterTranslator::translate().

Here is the call graph for this function:

◆ ZComponentName()

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

Definition at line 113 of file IParametricComponent.cpp.

114 {
115  return base_name + "Z";
116 }

References ModelView::Utils::base_name().

Referenced by IParametricComponent::registerVector(), IParametricComponent::removeVector(), IParametricComponent::setVectorValue(), and VectorParameterTranslator::translate().

Here is the call graph for this function:

Member Data Documentation

◆ m_name

std::string IParametricComponent::m_name
privateinherited

Definition at line 73 of file IParametricComponent.h.

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

◆ m_pool

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

parameter pool (kind of pointer-to-implementation)

Definition at line 74 of file IParametricComponent.h.

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

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