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

Public Member Functions

 ~IParticle ()
 
IParticle * clone () const override=0
 
virtual IFormFactor * createFormFactor () const
 
virtual SlicedParticle createSlicedParticle (ZLimits limits) const
 
kvector_t position () const
 
void setPosition (kvector_t position)
 
void setPosition (double x, double y, double z)
 
void translate (kvector_t translation) override final
 
const IRotation * rotation () const
 
void setRotation (const IRotation &rotation)
 
void rotate (const IRotation &rotation) override final
 
std::vector< const INode * > getChildren () const override
 
void registerAbundance (bool make_registered=true)
 
void registerPosition (bool make_registered=true)
 
virtual SafePointerVector< IParticle > decompose () const
 
virtual ParticleLimits bottomTopZ () const
 
virtual void accept (INodeVisitor *visitor) const
 
double abundance () const
 
void setAbundance (double abundance)
 
virtual const Material * material () const
 
std::vector< const Material * > containedMaterials () const
 
virtual void transferToCPP ()
 
virtual std::string treeToString () const
 
void registerChild (INode *node)
 
virtual void setParent (const INode *newParent)
 
const INode * parent () const
 
INode * parent ()
 
int copyNumber (const INode *node) const
 
std::string displayName () const
 
ParameterPool * createParameterTree () const
 
ParameterPool * parameterPool () 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)
 

Protected Member Functions

IRotation * createComposedRotation (const IRotation *p_rotation) const
 
kvector_t composedTranslation (const IRotation *p_rotation, kvector_t translation) const
 
void registerParticleProperties ()
 

Protected Attributes

kvector_t m_position
 
std::unique_ptr< IRotation > mP_rotation
 
double m_abundance {1.0}
 
const size_t m_NP
 
std::vector< double > m_P
 

Private Attributes

const INode * m_parent {nullptr}
 
std::string m_name
 
std::unique_ptr< ParameterPool > m_pool
 

Detailed Description

Pure virtual base class for Particle, ParticleComposition, ParticleCoreShell, MesoCrystal.

Provides position/rotation and form factor. Abundance is inherited from IAbstractParticle.

Definition at line 32 of file IParticle.h.

Constructor & Destructor Documentation

◆ ~IParticle()

IParticle::~IParticle ( )
default

Member Function Documentation

◆ clone()

IParticle* IParticle::clone ( ) const
overridepure virtual

Returns a clone of this ISample object.

Implements IAbstractParticle.

Implemented in ParticleCoreShell, ParticleComposition, Particle, and MesoCrystal.

Referenced by ParticleComposition::addParticle(), Crystal::Crystal(), decompose(), and ParticleDistribution::ParticleDistribution().

◆ createFormFactor()

IFormFactor * IParticle::createFormFactor ( ) const
virtual

Creates a form factor for this particle.

Reimplemented in ParticleComposition.

Definition at line 23 of file IParticle.cpp.

24 {
25  return createSlicedParticle(ZLimits{}).mP_slicedff.release();
26 }
IParticle::createSlicedParticle
virtual SlicedParticle createSlicedParticle(ZLimits limits) const
Creates a sliced form factor for this particle.
Definition: IParticle.cpp:28
ZLimits
Class that contains upper and lower limits of the z-coordinate for the slicing of form factors.
Definition: ZLimits.h:41

References createSlicedParticle().

Referenced by bottomTopZ().

Here is the call graph for this function:

◆ createSlicedParticle()

SlicedParticle IParticle::createSlicedParticle ( ZLimits  limits) const
virtual

Creates a sliced form factor for this particle.

Reimplemented in ParticleCoreShell, Particle, and MesoCrystal.

Definition at line 28 of file IParticle.cpp.

29 {
30  throw std::runtime_error("IParticle::createSlicedParticle error: "
31  "not implemented!");
32 }

Referenced by SlicedFormFactorList::addParticle(), and createFormFactor().

◆ position()

kvector_t IParticle::position ( ) const
inline

Returns particle position.

Definition at line 45 of file IParticle.h.

45 { return m_position; }
IParticle::m_position
kvector_t m_position
Definition: IParticle.h:94

References m_position.

Referenced by ParticleComposition::addParticle(), ParticleComposition::decompose(), setPosition(), and SampleToPython::setPositionInformation().

◆ setPosition() [1/2]

void IParticle::setPosition ( kvector_t  position)
inline

Sets relative position of the particle's reference point in the coordinate system of parent.

Parameters
positionrelative position vector (components are in nanometers)

Definition at line 50 of file IParticle.h.

50 { m_position = position; }
IParticle::position
kvector_t position() const
Returns particle position.
Definition: IParticle.h:45

References m_position, and position().

Referenced by BoxCompositionRotateXBuilder::buildSample(), BoxCompositionRotateYBuilder::buildSample(), BoxCompositionRotateZBuilder::buildSample(), BoxCompositionRotateZandYBuilder::buildSample(), BoxStackCompositionBuilder::buildSample(), CoreShellBoxRotateZandYBuilder::buildSample(), CustomMorphologyBuilder::buildSample(), LayersWithAbsorptionBuilder::buildSample(), LayersWithAbsorptionBySLDBuilder::buildSample(), SlicedCompositionBuilder::buildSample(), TransformBoxBuilder::buildSample(), MesoCrystal::clone(), Particle::clone(), ParticleComposition::clone(), and ParticleCoreShell::clone().

Here is the call graph for this function:

◆ setPosition() [2/2]

void IParticle::setPosition ( double  x,
double  y,
double  z 
)
inline

Sets relative position of the particle's reference point in the coordinate system of parent.

Parameters
xx-coordinate in nanometers
yy-coordinate in nanometers
zz-coordinate in nanometers

Definition at line 57 of file IParticle.h.

57 { m_position = kvector_t(x, y, z); }
kvector_t
BasicVector3D< double > kvector_t
Definition: Vectors3D.h:21

References m_position.

◆ translate()

void IParticle::translate ( kvector_t  translation)
finaloverridevirtual

Translates the particle.

Implements IAbstractParticle.

Definition at line 34 of file IParticle.cpp.

35 {
36  m_position += translation;
37 }

References m_position.

Referenced by ParticleComposition::addParticle(), and SlicedFormFactorList::addParticle().

◆ rotation()

const IRotation * IParticle::rotation ( ) const

Returns rotation object.

Definition at line 39 of file IParticle.cpp.

40 {
41  return mP_rotation.get();
42 }
IParticle::mP_rotation
std::unique_ptr< IRotation > mP_rotation
Definition: IParticle.h:95

References mP_rotation.

Referenced by ParticleComposition::decompose(), Particle::Particle(), rotate(), setRotation(), and SampleToPython::setRotationInformation().

◆ setRotation()

void IParticle::setRotation ( const IRotation &  rotation)

Sets transformation.

Definition at line 44 of file IParticle.cpp.

45 {
46  mP_rotation.reset(rotation.clone());
47  registerChild(mP_rotation.get());
48 }
INode::registerChild
void registerChild(INode *node)
Definition: INode.cpp:58
IParticle::rotation
const IRotation * rotation() const
Returns rotation object.
Definition: IParticle.cpp:39
IRotation::clone
virtual IRotation * clone() const =0

References IRotation::clone(), mP_rotation, INode::registerChild(), and rotation().

Referenced by BoxCompositionRotateXBuilder::buildSample(), BoxCompositionRotateYBuilder::buildSample(), BoxCompositionRotateZBuilder::buildSample(), BoxCompositionRotateZandYBuilder::buildSample(), BoxStackCompositionBuilder::buildSample(), CoreShellBoxRotateZandYBuilder::buildSample(), LayersWithAbsorptionBuilder::buildSample(), LayersWithAbsorptionBySLDBuilder::buildSample(), RotatedPyramidsDistributionBuilder::buildSample(), SlicedCompositionBuilder::buildSample(), TransformBoxBuilder::buildSample(), MesoCrystal::clone(), Particle::clone(), ParticleComposition::clone(), ParticleCoreShell::clone(), and Particle::Particle().

Here is the call graph for this function:

◆ rotate()

void IParticle::rotate ( const IRotation &  rotation)
finaloverridevirtual

Rotates the particle.

Implements IAbstractParticle.

Definition at line 50 of file IParticle.cpp.

51 {
52  if (mP_rotation) {
53  mP_rotation.reset(createProduct(rotation, *mP_rotation));
54  } else {
55  mP_rotation.reset(rotation.clone());
56  }
57  m_position = rotation.transformed(m_position);
58  registerChild(mP_rotation.get());
59 }
createProduct
IRotation * createProduct(const IRotation &left, const IRotation &right)
Returns concatenated rotation (first right, then left).
Definition: Rotations.cpp:75
IRotation::transformed
kvector_t transformed(const kvector_t &v) const
Definition: Rotations.cpp:58

References IRotation::clone(), createProduct(), m_position, mP_rotation, INode::registerChild(), rotation(), and IRotation::transformed().

Referenced by BoxCompositionRotateZandYBuilder::buildSample(), CoreShellBoxRotateZandYBuilder::buildSample(), LayersWithAbsorptionBuilder::buildSample(), LayersWithAbsorptionBySLDBuilder::buildSample(), and TransformBoxBuilder::buildSample().

Here is the call graph for this function:

◆ getChildren()

std::vector< const INode * > IParticle::getChildren ( ) const
overridevirtual

Returns a vector of children (const).

Reimplemented from INode.

Reimplemented in ParticleCoreShell, ParticleComposition, Particle, and MesoCrystal.

Definition at line 61 of file IParticle.cpp.

62 {
63  return std::vector<const INode*>() << mP_rotation;
64 }

References mP_rotation.

Referenced by MesoCrystal::getChildren(), Particle::getChildren(), ParticleComposition::getChildren(), and ParticleCoreShell::getChildren().

◆ registerAbundance()

void IParticle::registerAbundance ( bool  make_registered = true)

Definition at line 66 of file IParticle.cpp.

67 {
68  if (make_registered) {
69  if (!parameter("Abundance"))
70  registerParameter("Abundance", &m_abundance);
71  } else {
72  removeParameter("Abundance");
73  }
74 }
IParameterized::registerParameter
RealParameter & registerParameter(const std::string &name, double *parpointer)
Definition: IParameterized.cpp:48
IParameterized::parameter
RealParameter * parameter(const std::string &name) const
Returns parameter with given 'name'.
Definition: IParameterized.cpp:83
IParameterized::removeParameter
void removeParameter(const std::string &name)
Definition: IParameterized.cpp:88

References IAbstractParticle::m_abundance, IParameterized::parameter(), IParameterized::registerParameter(), and IParameterized::removeParameter().

Referenced by ParticleComposition::addParticlePointer(), and registerParticleProperties().

Here is the call graph for this function:

◆ registerPosition()

void IParticle::registerPosition ( bool  make_registered = true)

Registers the three components of its position.

Definition at line 76 of file IParticle.cpp.

77 {
78  if (make_registered) {
79  if (!parameter(XComponentName("Position"))) {
80  registerVector("Position", &m_position, "nm");
81  }
82  } else {
83  removeVector("Position");
84  }
85 }
IParameterized::XComponentName
static std::string XComponentName(const std::string &base_name)
Definition: IParameterized.cpp:100
IParameterized::removeVector
void removeVector(const std::string &base_name)
Definition: IParameterized.cpp:93
IParameterized::registerVector
void registerVector(const std::string &base_name, kvector_t *p_vec, const std::string &units="nm")
Definition: IParameterized.cpp:54

References m_position, IParameterized::parameter(), IParameterized::registerVector(), IParameterized::removeVector(), and IParameterized::XComponentName().

Referenced by registerParticleProperties().

Here is the call graph for this function:

◆ decompose()

SafePointerVector< IParticle > IParticle::decompose ( ) const
virtual

Decompose in constituent IParticle objects.

Reimplemented in ParticleComposition.

Definition at line 87 of file IParticle.cpp.

88 {
89  SafePointerVector<IParticle> result;
90  result.push_back(this->clone());
91  return result;
92 }
IParticle::clone
IParticle * clone() const override=0
Returns a clone of this ISample object.
SafePointerVector
A vector of pointers, owned by *this, with methods to handle them safely.
Definition: SafePointerVector.h:27
SafePointerVector::push_back
void push_back(T *pointer)
Definition: SafePointerVector.h:40

References clone(), and SafePointerVector< T >::push_back().

Referenced by SlicedFormFactorList::createSlicedFormFactors().

Here is the call graph for this function:

◆ bottomTopZ()

ParticleLimits IParticle::bottomTopZ ( ) const
virtual

Top and bottom z-coordinate.

Reimplemented in ParticleComposition.

Definition at line 94 of file IParticle.cpp.

95 {
96  std::unique_ptr<IFormFactor> P_ff(createFormFactor());
97  std::unique_ptr<IRotation> P_rot(IRotation::createIdentity());
98  return {P_ff->bottomZ(*P_rot), P_ff->topZ(*P_rot)};
99 }
IParticle::createFormFactor
virtual IFormFactor * createFormFactor() const
Creates a form factor for this particle.
Definition: IParticle.cpp:23
IRotation::createIdentity
static IRotation * createIdentity()
Definition: Rotations.cpp:53

References createFormFactor(), and IRotation::createIdentity().

Referenced by anonymous_namespace{SlicedFormFactorList.cpp}::SliceIndexSpan().

Here is the call graph for this function:

◆ createComposedRotation()

IRotation * IParticle::createComposedRotation ( const IRotation *  p_rotation) const
protected

Creates a composed IRotation object.

Definition at line 101 of file IParticle.cpp.

102 {
103  if (p_rotation) {
104  if (mP_rotation)
105  return createProduct(*p_rotation, *mP_rotation);
106  else
107  return p_rotation->clone();
108  } else {
109  if (mP_rotation)
110  return mP_rotation->clone();
111  else
112  return nullptr;
113  }
114 }

References IRotation::clone(), createProduct(), and mP_rotation.

Here is the call graph for this function:

◆ composedTranslation()

kvector_t IParticle::composedTranslation ( const IRotation *  p_rotation,
kvector_t  translation 
) const
protected

Gets a composed translation vector.

Definition at line 116 of file IParticle.cpp.

117 {
118  if (p_rotation) {
119  return translation + p_rotation->transformed(m_position);
120  } else {
121  return translation + m_position;
122  }
123 }

References m_position, and IRotation::transformed().

Here is the call graph for this function:

◆ registerParticleProperties()

void IParticle::registerParticleProperties ( )
protected

Registers abundance and position.

Definition at line 125 of file IParticle.cpp.

126 {
127  registerAbundance();
128  registerPosition();
129 }
IParticle::registerAbundance
void registerAbundance(bool make_registered=true)
Definition: IParticle.cpp:66
IParticle::registerPosition
void registerPosition(bool make_registered=true)
Registers the three components of its position.
Definition: IParticle.cpp:76

References registerAbundance(), and registerPosition().

Referenced by MesoCrystal::initialize(), Particle::initialize(), ParticleComposition::initialize(), and ParticleCoreShell::ParticleCoreShell().

Here is the call graph for this function:

◆ accept()

void IAbstractParticle::accept ( INodeVisitor *  visitor) const
virtualinherited

Calls the INodeVisitor's visit method.

Implements INode.

Reimplemented in ParticleDistribution, ParticleCoreShell, ParticleComposition, Particle, and MesoCrystal.

Definition at line 22 of file IAbstractParticle.cpp.

23 {
24  visitor->visit(this);
25 }
INodeVisitor::visit
virtual void visit(const BasicLattice *)
Definition: INodeVisitor.h:154

References INodeVisitor::visit().

Here is the call graph for this function:

◆ abundance()

double IAbstractParticle::abundance ( ) const
inlineinherited

Definition at line 39 of file IAbstractParticle.h.

39 { return m_abundance; }

References IAbstractParticle::m_abundance.

Referenced by ParticleDistribution::generateParticles(), ProcessedLayout::ProcessParticle(), and IAbstractParticle::setAbundance().

◆ setAbundance()

void IAbstractParticle::setAbundance ( double  abundance)
inlineinherited

Sets particle abundance.

Parameters
abundanceproportion of this type of particles normalized to the total number of particles in the layout.

Definition at line 44 of file IAbstractParticle.h.

44 { m_abundance = abundance; }
IAbstractParticle::abundance
double abundance() const
Definition: IAbstractParticle.h:39

References IAbstractParticle::abundance(), and IAbstractParticle::m_abundance.

Referenced by ParticleLayout::addParticle(), MesoCrystal::clone(), Particle::clone(), ParticleComposition::clone(), ParticleCoreShell::clone(), ParticleDistribution::clone(), and ParticleDistribution::generateParticles().

Here is the call graph for this function:

◆ material()

virtual const Material* ISample::material ( ) const
inlinevirtualinherited

Returns nullptr, unless overwritten to return a specific material.

Reimplemented in Particle, and Layer.

Definition at line 37 of file ISample.h.

37 { return nullptr; }

Referenced by ISample::containedMaterials(), FormFactorCrystal::setAmbientMaterial(), FormFactorBAPol::setAmbientMaterial(), FormFactorDecoratorMaterial::setAmbientMaterial(), FormFactorDWBA::setAmbientMaterial(), FormFactorDWBAPol::setAmbientMaterial(), IFormFactorDecorator::setAmbientMaterial(), FormFactorCoreShell::setAmbientMaterial(), FormFactorWeighted::setAmbientMaterial(), and FormFactorDecoratorMaterial::setMaterial().

◆ containedMaterials()

std::vector< const Material * > ISample::containedMaterials ( ) const
inherited

Returns set of unique materials contained in this ISample.

Definition at line 23 of file ISample.cpp.

24 {
25  std::vector<const Material*> result;
26  if (const Material* p_material = material())
27  result.push_back(p_material);
28  for (auto child : getChildren()) {
29  if (const ISample* sample = dynamic_cast<const ISample*>(child)) {
30  for (const Material* p_material : sample->containedMaterials())
31  result.push_back(p_material);
32  }
33  }
34  return result;
35 }
INode::getChildren
virtual std::vector< const INode * > getChildren() const
Returns a vector of children (const).
Definition: INode.cpp:64
ISample
Pure virtual base class for sample components and properties related to scattering.
Definition: ISample.h:28
ISample::material
virtual const Material * material() const
Returns nullptr, unless overwritten to return a specific material.
Definition: ISample.h:37
Material
A wrapper for underlying material implementation.
Definition: Material.h:29

References INode::getChildren(), and ISample::material().

Referenced by MultiLayerUtils::ContainsCompatibleMaterials(), anonymous_namespace{ProcessedSample.cpp}::ContainsMagneticMaterial(), and SampleToPython::initLabels().

Here is the call graph for this function:

◆ transferToCPP()

virtual void ICloneable::transferToCPP ( )
inlinevirtualinherited

Used for Python overriding of clone (see swig/tweaks.py)

Definition at line 34 of file ICloneable.h.

◆ treeToString()

std::string INode::treeToString ( ) const
virtualinherited

Returns multiline string representing tree structure below the node.

Definition at line 53 of file INode.cpp.

54 {
55  return NodeUtils::nodeToString(*this);
56 }
NodeUtils::nodeToString
std::string nodeToString(const INode &node)
Returns multiline string representing tree structure starting from given node.
Definition: NodeUtils.cpp:67

References NodeUtils::nodeToString().

Here is the call graph for this function:

◆ registerChild()

void INode::registerChild ( INode *  node)
inherited

Definition at line 58 of file INode.cpp.

59 {
60  ASSERT(node);
61  node->setParent(this);
62 }
ASSERT
#define ASSERT(condition)
Definition: Assert.h:26
INode::setParent
virtual void setParent(const INode *newParent)
Definition: INode.cpp:69

References ASSERT, and INode::setParent().

Referenced by ParticleLayout::addAndRegisterAbstractParticle(), ParticleCoreShell::addAndRegisterCore(), MultiLayer::addAndRegisterInterface(), MultiLayer::addAndRegisterLayer(), ParticleCoreShell::addAndRegisterShell(), Layer::addLayout(), ParticleComposition::addParticlePointer(), Beam::Beam(), Crystal::Crystal(), IDetector::IDetector(), Simulation::initialize(), MesoCrystal::initialize(), Instrument::Instrument(), Beam::operator=(), Instrument::operator=(), Particle::Particle(), ParticleDistribution::ParticleDistribution(), rotate(), ParticleLayout::setAndRegisterInterferenceFunction(), Simulation::setBackground(), InterferenceFunction1DLattice::setDecayFunction(), InterferenceFunction2DLattice::setDecayFunction(), Instrument::setDetector(), IDetector::setDetectorResolution(), Beam::setFootprintFactor(), Particle::setFormFactor(), InterferenceFunctionFinite3DLattice::setLattice(), InterferenceFunction2DLattice::setLattice(), InterferenceFunction2DParaCrystal::setLattice(), InterferenceFunction2DSuperLattice::setLattice(), InterferenceFunctionFinite2DLattice::setLattice(), InterferenceFunctionRadialParaCrystal::setProbabilityDistribution(), InterferenceFunction2DParaCrystal::setProbabilityDistributions(), ConvolutionDetectorResolution::setResolutionFunction(), setRotation(), LayerInterface::setRoughness(), and InterferenceFunction2DSuperLattice::setSubstructureIFF().

Here is the call graph for this function:

◆ setParent()

void INode::setParent ( const INode *  newParent)
virtualinherited

Reimplemented in SampleProvider.

Definition at line 69 of file INode.cpp.

70 {
71  m_parent = newParent;
72 }
INode::m_parent
const INode * m_parent
Definition: INode.h:81

References INode::m_parent.

Referenced by INode::registerChild(), SampleProvider::setBuilder(), and SampleProvider::setParent().

◆ parent() [1/2]

const INode * INode::parent ( ) const
inherited

Definition at line 74 of file INode.cpp.

75 {
76  return m_parent;
77 }

References INode::m_parent.

Referenced by INode::copyNumber(), INode::createParameterTree(), NodeUtils::nodePath(), Lattice2D::onChange(), SampleProvider::setBuilder(), SampleProvider::setParent(), and SampleProvider::setSample().

◆ parent() [2/2]

INode * INode::parent ( )
inherited

Definition at line 79 of file INode.cpp.

80 {
81  return const_cast<INode*>(m_parent);
82 }
INode
Base class for tree-like structures containing parameterized objects.
Definition: INode.h:49

References INode::m_parent.

◆ copyNumber()

int INode::copyNumber ( const INode *  node) const
inherited

Returns copyNumber of child, which takes into account existence of children with same name.

Definition at line 84 of file INode.cpp.

85 {
86  if (node->parent() != this)
87  return -1;
88 
89  int result(-1), count(0);
90  for (auto child : getChildren()) {
91 
92  if (child == nullptr)
93  throw std::runtime_error("INode::copyNumber() -> Error. Nullptr as child.");
94 
95  if (child == node)
96  result = count;
97 
98  if (child->getName() == node->getName())
99  ++count;
100  }
101 
102  return count > 1 ? result : -1;
103 }
INode::parent
const INode * parent() const
Definition: INode.cpp:74
IParameterized::getName
const std::string & getName() const
Definition: IParameterized.h:69

References INode::getChildren(), IParameterized::getName(), and INode::parent().

Referenced by INode::displayName().

Here is the call graph for this function:

◆ displayName()

std::string INode::displayName ( ) const
inherited

Returns display name, composed from the name of node and it's copy number.

Definition at line 105 of file INode.cpp.

106 {
107  std::string result = getName();
108  if (m_parent) {
109  int index = m_parent->copyNumber(this);
110  if (index >= 0)
111  result = result + std::to_string(index);
112  }
113  return result;
114 }
INode::copyNumber
int copyNumber(const INode *node) const
Returns copyNumber of child, which takes into account existence of children with same name.
Definition: INode.cpp:84

References INode::copyNumber(), IParameterized::getName(), and INode::m_parent.

Referenced by NodeUtils::nodePath(), and anonymous_namespace{NodeUtils.cpp}::nodeString().

Here is the call graph for this function:

◆ createParameterTree()

ParameterPool * INode::createParameterTree ( ) const
virtualinherited

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

Reimplemented from IParameterized.

Definition at line 116 of file INode.cpp.

117 {
118  std::unique_ptr<ParameterPool> result(new ParameterPool);
119 
120  NodeIterator<PreorderStrategy> it(this);
121  it.first();
122  while (!it.isDone()) {
123  const INode* child = it.getCurrent();
124  const std::string path = NodeUtils::nodePath(*child, this->parent()) + "/";
125  child->parameterPool()->copyToExternalPool(path, result.get());
126  it.next();
127  }
128 
129  return result.release();
130 }
IParameterized::parameterPool
ParameterPool * parameterPool() const
Returns pointer to the parameter pool.
Definition: IParameterized.h:38
NodeIterator
Iterator through INode tree of objects.
Definition: NodeIterator.h:90
ParameterPool
Container with parameters for IParameterized object.
Definition: ParameterPool.h:30
ParameterPool::copyToExternalPool
void copyToExternalPool(const std::string &prefix, ParameterPool *other_pool) const
Copies parameters of given pool to other pool, prepeding prefix to the parameter names.
Definition: ParameterPool.cpp:72
NodeUtils::nodePath
std::string nodePath(const INode &node, const INode *root=nullptr)
Returns path composed of node's displayName, with respect to root node.
Definition: NodeUtils.cpp:82

References ParameterPool::copyToExternalPool(), NodeIterator< Strategy >::first(), NodeIterator< Strategy >::getCurrent(), NodeIterator< Strategy >::isDone(), NodeIterator< Strategy >::next(), NodeUtils::nodePath(), IParameterized::parameterPool(), and INode::parent().

Referenced by ParticleDistribution::generateParticles(), Simulation::runSimulation(), DepthProbeSimulation::validateParametrization(), OffSpecSimulation::validateParametrization(), and SpecularSimulation::validateParametrization().

Here is the call graph for this function:

◆ 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().

◆ 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(), 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::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 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 }
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 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(), registerAbundance(), Lattice::registerBasisVectors(), ParticleLayout::registerParticleDensity(), 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 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 }

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

Referenced by 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(), 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::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_position

kvector_t IParticle::m_position
protected

Definition at line 94 of file IParticle.h.

Referenced by MesoCrystal::clone(), Particle::clone(), ParticleComposition::clone(), ParticleCoreShell::clone(), composedTranslation(), MesoCrystal::createSlicedParticle(), Particle::createSlicedParticle(), ParticleCoreShell::createSlicedParticle(), position(), registerPosition(), rotate(), setPosition(), and translate().

◆ mP_rotation

std::unique_ptr<IRotation> IParticle::mP_rotation
protected

Definition at line 95 of file IParticle.h.

Referenced by MesoCrystal::clone(), Particle::clone(), ParticleComposition::clone(), ParticleCoreShell::clone(), createComposedRotation(), MesoCrystal::createSlicedParticle(), Particle::createSlicedParticle(), ParticleCoreShell::createSlicedParticle(), getChildren(), rotate(), rotation(), and setRotation().

◆ m_abundance

double IAbstractParticle::m_abundance {1.0}
protectedinherited

Definition at line 53 of file IAbstractParticle.h.

Referenced by IAbstractParticle::abundance(), MesoCrystal::clone(), Particle::clone(), ParticleComposition::clone(), ParticleCoreShell::clone(), ParticleDistribution::clone(), ParticleDistribution::ParticleDistribution(), registerAbundance(), and IAbstractParticle::setAbundance().

◆ m_parent

const INode* INode::m_parent {nullptr}
privateinherited

Definition at line 81 of file INode.h.

Referenced by INode::displayName(), INode::parent(), and INode::setParent().

◆ m_NP

const size_t INode::m_NP
protectedinherited

Definition at line 86 of file INode.h.

Referenced by INode::INode().

◆ m_P

std::vector<double> INode::m_P
protectedinherited

Definition at line 87 of file INode.h.

Referenced by INode::INode(), and IFootprintFactor::setWidthRatio().

◆ 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: