BornAgain  1.19.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
FTDistribution2DGauss Class Reference
Fourier-space distribution functions

Two-dimensional Gauss distribution in Fourier space; corresponds to normalized exp(-r^2/2) in real space with $r=\sqrt{(\frac{x}{\omega_x})^2 + (\frac{y}{\omega_y})^2}$. More...

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

Public Member Functions

 FTDistribution2DGauss (const std::vector< double > P)
 
 FTDistribution2DGauss (double omega_x, double omega_y, double gamma)
 
void accept (INodeVisitor *visitor) const final
 Calls the INodeVisitor's visit method. More...
 
FTDistribution2DGauss * clone () const final
 
int copyNumber (const INode *node) const
 Returns copyNumber of child, which takes into account existence of children with same name. More...
 
ParameterPool * createParameterTree () const
 Creates new parameter pool, with all local parameters and those of its children. More...
 
std::unique_ptr< IDistribution2DSampler > createSampler () const final
 
double delta () const
 Angle in direct space between X- and Y-axis of distribution. More...
 
std::string displayName () const
 Returns display name, composed from the name of node and it's copy number. More...
 
double evaluate (double qx, double qy) const final
 evaluate Fourier transformed distribution for q in X,Y coordinates the original distribution (in real space) is assumed to be normalized: total integral is equal to 1 More...
 
double gamma () const
 
virtual std::vector< const INode * > getChildren () const
 Returns a vector of children. More...
 
const std::string & getName () const
 
double omegaX () const
 
double omegaY () 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...
 
INode * parent ()
 
const INode * parent () const
 
std::vector< const INode * > progeny () const
 Returns a vector of all descendants. More...
 
void registerChild (INode *node)
 
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)
 
virtual void setParent (const INode *newParent)
 
void setVectorValue (const std::string &base_name, kvector_t value)
 
virtual void transferToCPP ()
 Used for Python overriding of clone (see swig/tweaks.py) More...
 
virtual std::string treeToString () const
 Returns multiline string representing tree structure below the node. More...
 

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

double sumsq (double qx, double qy) const
 

Protected Attributes

const double & m_gamma
 
const size_t m_NP
 
const double & m_omega_x
 
const double & m_omega_y
 
std::vector< double > m_P
 

Private Attributes

std::string m_name
 
const INode * m_parent {nullptr}
 
std::unique_ptr< ParameterPool > m_pool
 parameter pool (kind of pointer-to-implementation) More...
 

Detailed Description

Two-dimensional Gauss distribution in Fourier space; corresponds to normalized exp(-r^2/2) in real space with $r=\sqrt{(\frac{x}{\omega_x})^2 + (\frac{y}{\omega_y})^2}$.

Definition at line 83 of file FTDistributions2D.h.

Constructor & Destructor Documentation

◆ FTDistribution2DGauss() [1/2]

FTDistribution2DGauss::FTDistribution2DGauss ( const std::vector< double >  P)

Definition at line 76 of file FTDistributions2D.cpp.

77  : IFTDistribution2D({"FTDistribution2DGauss", "class_tooltip", {}}, P)
78 {
79 }
IFTDistribution2D::IFTDistribution2D
IFTDistribution2D(const NodeMeta &meta, const std::vector< double > &PValues)
Definition: FTDistributions2D.cpp:24

Referenced by clone().

◆ FTDistribution2DGauss() [2/2]

FTDistribution2DGauss::FTDistribution2DGauss ( double  omega_x,
double  omega_y,
double  gamma 
)

Definition at line 81 of file FTDistributions2D.cpp.

82  : FTDistribution2DGauss(std::vector<double>{omega_x, omega_y, gamma})
83 {
84 }
FTDistribution2DGauss::FTDistribution2DGauss
FTDistribution2DGauss(const std::vector< double > P)
Definition: FTDistributions2D.cpp:76
IFTDistribution2D::gamma
double gamma() const
Definition: FTDistributions2D.h:36

References IFTDistribution2D::gamma().

Here is the call graph for this function:

Member Function Documentation

◆ accept()

void FTDistribution2DGauss::accept ( INodeVisitor *  visitor) const
inlinefinalvirtual

Calls the INodeVisitor's visit method.

Implements INode.

Definition at line 89 of file FTDistributions2D.h.

89 { visitor->visit(this); }
INodeVisitor::visit
virtual void visit(const BasicLattice2D *)
Definition: INodeVisitor.h:151

◆ clone()

FTDistribution2DGauss * FTDistribution2DGauss::clone ( ) const
finalvirtual

Implements IFTDistribution2D.

Definition at line 86 of file FTDistributions2D.cpp.

87 {
88  return new FTDistribution2DGauss(m_omega_x, m_omega_y, m_gamma);
89 }
IFTDistribution2D::m_gamma
const double & m_gamma
Definition: FTDistributions2D.h:55
IFTDistribution2D::m_omega_y
const double & m_omega_y
Definition: FTDistributions2D.h:54
IFTDistribution2D::m_omega_x
const double & m_omega_x
Definition: FTDistributions2D.h:53

References FTDistribution2DGauss(), IFTDistribution2D::m_gamma, IFTDistribution2D::m_omega_x, and IFTDistribution2D::m_omega_y.

Here is the call graph for this function:

◆ 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 94 of file INode.cpp.

95 {
96  if (node->parent() != this)
97  return -1;
98 
99  int result(-1), count(0);
100  for (auto child : getChildren()) {
101 
102  if (child == nullptr)
103  throw std::runtime_error("INode::copyNumber() -> Error. Nullptr as child.");
104 
105  if (child == node)
106  result = count;
107 
108  if (child->getName() == node->getName())
109  ++count;
110  }
111 
112  return count > 1 ? result : -1;
113 }
INode::parent
const INode * parent() const
Definition: INode.cpp:84
INode::getChildren
virtual std::vector< const INode * > getChildren() const
Returns a vector of children.
Definition: INode.cpp:63
IParametricComponent::getName
const std::string & getName() const
Definition: IParametricComponent.h:70

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

Referenced by INode::displayName().

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 IParametricComponent.

Definition at line 126 of file INode.cpp.

127 {
128  std::unique_ptr<ParameterPool> result(new ParameterPool);
129 
130  for (const INode* child : progeny()) {
131  const std::string path = NodeUtils::nodePath(child, parent()) + "/";
132  child->parameterPool()->copyToExternalPool(path, result.get());
133  }
134 
135  return result.release();
136 }
INode
Base class for tree-like structures containing parameterized objects.
Definition: INode.h:49
INode::progeny
std::vector< const INode * > progeny() const
Returns a vector of all descendants.
Definition: INode.cpp:68
ParameterPool
Container with parameters for IParametricComponent object.
Definition: ParameterPool.h:29
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:89

References NodeUtils::nodePath(), INode::parent(), and INode::progeny().

Referenced by ISimulation::runSimulation(), DepthProbeSimulation::validateParametrization(), OffSpecularSimulation::validateParametrization(), and SpecularSimulation::validateParametrization().

Here is the call graph for this function:

◆ createSampler()

std::unique_ptr< IDistribution2DSampler > FTDistribution2DGauss::createSampler ( ) const
finalvirtual

Implements IFTDistribution2D.

Definition at line 96 of file FTDistributions2D.cpp.

97 {
98  return std::make_unique<Distribution2DGaussSampler>(m_omega_x, m_omega_y);
99 }

References IFTDistribution2D::m_omega_x, and IFTDistribution2D::m_omega_y.

◆ delta()

double IFTDistribution2D::delta ( ) const
inlineinherited

Angle in direct space between X- and Y-axis of distribution.

Definition at line 39 of file FTDistributions2D.h.

39 { return M_PI_2; }
M_PI_2
#define M_PI_2
Definition: Constants.h:45

References M_PI_2.

Referenced by InterferenceFunction2DParaCrystal::FTPDF().

◆ displayName()

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

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

Definition at line 115 of file INode.cpp.

116 {
117  std::string result = getName();
118  if (m_parent) {
119  int index = m_parent->copyNumber(this);
120  if (index >= 0)
121  result = result + std::to_string(index);
122  }
123  return result;
124 }
INode::m_parent
const INode * m_parent
Definition: INode.h:83
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:94

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

Referenced by NodeUtils::nodePath().

Here is the call graph for this function:

◆ evaluate()

double FTDistribution2DGauss::evaluate ( double  qx,
double  qy 
) const
finalvirtual

evaluate Fourier transformed distribution for q in X,Y coordinates the original distribution (in real space) is assumed to be normalized: total integral is equal to 1

Implements IFTDistribution2D.

Definition at line 91 of file FTDistributions2D.cpp.

92 {
93  return std::exp(-sumsq(qx, qy) / 2);
94 }
IFTDistribution2D::sumsq
double sumsq(double qx, double qy) const
Definition: FTDistributions2D.cpp:38

References IFTDistribution2D::sumsq().

Here is the call graph for this function:

◆ gamma()

double IFTDistribution2D::gamma ( ) const
inlineinherited

Definition at line 36 of file FTDistributions2D.h.

36 { return m_gamma; }

References IFTDistribution2D::m_gamma.

Referenced by FTDistribution2DCauchy::FTDistribution2DCauchy(), FTDistribution2DCone::FTDistribution2DCone(), FTDistribution2DGate::FTDistribution2DGate(), FTDistribution2DGauss(), FTDistribution2DVoigt::FTDistribution2DVoigt(), and InterferenceFunction2DParaCrystal::FTPDF().

◆ getChildren()

std::vector< const INode * > INode::getChildren ( ) const
virtualinherited

Returns a vector of children.

Reimplemented in SampleProvider, IParticle, ParticleLayout, InterferenceFunctionFinite3DLattice, InterferenceFunctionFinite2DLattice, InterferenceFunction3DLattice, InterferenceFunction2DSuperLattice, InterferenceFunction2DParaCrystal, InterferenceFunction2DLattice, InterferenceFunction1DLattice, IDetector, Beam, ParticleDistribution, ParticleCoreShell, ParticleComposition, Particle, MesoCrystal, Crystal, MultiLayer, Layer, InterferenceFunctionRadialParaCrystal, LayerInterface, ConvolutionDetectorResolution, Instrument, and ISimulation.

Definition at line 63 of file INode.cpp.

64 {
65  return {};
66 }

Referenced by node_progeny::AllDescendantsOfType(), node_progeny::ChildNodesOfType(), ISampleNode::containedMaterials(), INode::copyNumber(), INode::progeny(), and NodeUtils::progenyPlus().

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

◆ omegaX()

double IFTDistribution2D::omegaX ( ) const
inlineinherited

Definition at line 34 of file FTDistributions2D.h.

34 { return m_omega_x; }

References IFTDistribution2D::m_omega_x.

◆ omegaY()

double IFTDistribution2D::omegaY ( ) const
inlineinherited

Definition at line 35 of file FTDistributions2D.h.

35 { return m_omega_y; }

References IFTDistribution2D::m_omega_y.

◆ 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 }
IParametricComponent::m_pool
std::unique_ptr< ParameterPool > m_pool
parameter pool (kind of pointer-to-implementation)
Definition: IParametricComponent.h:74
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:

◆ parent() [1/2]

INode * INode::parent ( )
inherited

Definition at line 89 of file INode.cpp.

90 {
91  return const_cast<INode*>(m_parent);
92 }

References INode::m_parent.

◆ parent() [2/2]

const INode * INode::parent ( ) const
inherited

Definition at line 84 of file INode.cpp.

85 {
86  return m_parent;
87 }

References INode::m_parent.

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

◆ progeny()

std::vector< const INode * > INode::progeny ( ) const
inherited

Returns a vector of all descendants.

Definition at line 68 of file INode.cpp.

69 {
70  std::vector<const INode*> result;
71  result.push_back(this);
72  for (const auto* child : getChildren()) {
73  for (const auto* p : child->progeny())
74  result.push_back(p);
75  }
76  return result;
77 }

References INode::getChildren().

Referenced by INode::createParameterTree(), and ParticleDistribution::generateParticles().

Here is the call graph for this function:

◆ registerChild()

void INode::registerChild ( INode *  node)
inherited

Definition at line 57 of file INode.cpp.

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

References ASSERT, and INode::setParent().

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

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

◆ setParent()

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

Reimplemented in SampleProvider.

Definition at line 79 of file INode.cpp.

80 {
81  m_parent = newParent;
82 }

References INode::m_parent.

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

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

◆ sumsq()

double IFTDistribution2D::sumsq ( double  qx,
double  qy 
) const
protectedinherited

Definition at line 38 of file FTDistributions2D.cpp.

39 {
40  return qx * qx * m_omega_x * m_omega_x + qy * qy * m_omega_y * m_omega_y;
41 }

References IFTDistribution2D::m_omega_x, and IFTDistribution2D::m_omega_y.

Referenced by FTDistribution2DCauchy::evaluate(), evaluate(), FTDistribution2DGate::evaluate(), FTDistribution2DCone::evaluate(), and FTDistribution2DVoigt::evaluate().

◆ 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 52 of file INode.cpp.

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

References NodeUtils::nodeToString().

Here is the call graph for this function:

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

const double& IFTDistribution2D::m_gamma
protectedinherited

Definition at line 55 of file FTDistributions2D.h.

Referenced by FTDistribution2DCauchy::clone(), clone(), FTDistribution2DGate::clone(), FTDistribution2DCone::clone(), FTDistribution2DVoigt::clone(), and IFTDistribution2D::gamma().

◆ m_name

std::string IParametricComponent::m_name
privateinherited

Definition at line 73 of file IParametricComponent.h.

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

◆ m_NP

const size_t INode::m_NP
protectedinherited

Definition at line 88 of file INode.h.

Referenced by INode::INode().

◆ m_omega_x

const double& IFTDistribution2D::m_omega_x
protectedinherited

Definition at line 53 of file FTDistributions2D.h.

Referenced by FTDistribution2DCauchy::clone(), clone(), FTDistribution2DGate::clone(), FTDistribution2DCone::clone(), FTDistribution2DVoigt::clone(), FTDistribution2DCauchy::createSampler(), createSampler(), FTDistribution2DGate::createSampler(), FTDistribution2DCone::createSampler(), IFTDistribution2D::omegaX(), and IFTDistribution2D::sumsq().

◆ m_omega_y

const double& IFTDistribution2D::m_omega_y
protectedinherited

Definition at line 54 of file FTDistributions2D.h.

Referenced by FTDistribution2DCauchy::clone(), clone(), FTDistribution2DGate::clone(), FTDistribution2DCone::clone(), FTDistribution2DVoigt::clone(), FTDistribution2DCauchy::createSampler(), createSampler(), FTDistribution2DGate::createSampler(), FTDistribution2DCone::createSampler(), IFTDistribution2D::omegaY(), and IFTDistribution2D::sumsq().

◆ m_P

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

Definition at line 89 of file INode.h.

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

◆ m_parent

const INode* INode::m_parent {nullptr}
privateinherited

Definition at line 83 of file INode.h.

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

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