BornAgain  1.18.0
Simulate and fit neutron and x-ray scattering at grazing incidence
Public Member Functions | Static Public Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
FTDecayFunction2DCauchy Class Reference
Fourier-space decay functions
Inheritance diagram for FTDecayFunction2DCauchy:
Collaboration diagram for FTDecayFunction2DCauchy:

Public Member Functions

 FTDecayFunction2DCauchy (const std::vector< double > P)
 
 FTDecayFunction2DCauchy (double decay_length_x, double decay_length_y, double gamma)
 
FTDecayFunction2DCauchy * clone () const
 
void accept (INodeVisitor *visitor) const final
 
double evaluate (double qx, double qy) const final
 
double decayLengthX () const
 
double decayLengthY () const
 
double gamma () const
 
std::pair< double, double > boundingReciprocalLatticeCoordinates (double qX, double qY, double a, double b, double alpha) const
 
virtual void transferToCPP ()
 
virtual std::string treeToString () const
 
void registerChild (INode *node)
 
virtual std::vector< const INode * > getChildren () const
 
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 Attributes

const double & m_decay_length_x
 
const double & m_decay_length_y
 
const double & m_gamma
 
const size_t m_NP
 
std::vector< double > m_P
 

Private Member Functions

std::pair< double, double > transformToRecLatticeCoordinates (double qX, double qY, double a, double b, double alpha) const
 

Private Attributes

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

Detailed Description

Two-dimensional Cauchy decay function in reciprocal space; corresponds to exp(-r) in real space, with $r=\sqrt{(\frac{x}{\omega_x})^2 + (\frac{y}{\omega_y})^2}$.

Definition at line 62 of file FTDecay2D.h.

Constructor & Destructor Documentation

◆ FTDecayFunction2DCauchy() [1/2]

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

Definition at line 60 of file FTDecay2D.cpp.

61  : IFTDecayFunction2D({"FTDecayFunction2DCauchy", "class_tooltip", {}}, P)
62 {
63 }
IFTDecayFunction2D::IFTDecayFunction2D
IFTDecayFunction2D(const NodeMeta &meta, const std::vector< double > &PValues)
Definition: FTDecay2D.cpp:23

Referenced by clone().

◆ FTDecayFunction2DCauchy() [2/2]

FTDecayFunction2DCauchy::FTDecayFunction2DCauchy ( double  decay_length_x,
double  decay_length_y,
double  gamma 
)

Definition at line 65 of file FTDecay2D.cpp.

67  : FTDecayFunction2DCauchy(std::vector<double>{decay_length_x, decay_length_y, gamma})
68 {
69 }
FTDecayFunction2DCauchy::FTDecayFunction2DCauchy
FTDecayFunction2DCauchy(const std::vector< double > P)
Definition: FTDecay2D.cpp:60
IFTDecayFunction2D::gamma
double gamma() const
get angle between first lattice vector and X-axis of distribution (both in direct space)
Definition: FTDecay2D.h:37

References IFTDecayFunction2D::gamma().

Here is the call graph for this function:

Member Function Documentation

◆ clone()

FTDecayFunction2DCauchy * FTDecayFunction2DCauchy::clone ( ) const
virtual

Implements IFTDecayFunction2D.

Definition at line 71 of file FTDecay2D.cpp.

72 {
73  return new FTDecayFunction2DCauchy(m_decay_length_x, m_decay_length_y, m_gamma);
74 }
IFTDecayFunction2D::m_gamma
const double & m_gamma
Definition: FTDecay2D.h:49
IFTDecayFunction2D::m_decay_length_x
const double & m_decay_length_x
Definition: FTDecay2D.h:47
IFTDecayFunction2D::m_decay_length_y
const double & m_decay_length_y
Definition: FTDecay2D.h:48

References FTDecayFunction2DCauchy(), IFTDecayFunction2D::m_decay_length_x, IFTDecayFunction2D::m_decay_length_y, and IFTDecayFunction2D::m_gamma.

Here is the call graph for this function:

◆ accept()

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

Calls the INodeVisitor's visit method.

Implements INode.

Definition at line 69 of file FTDecay2D.h.

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

◆ evaluate()

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

evaluate Fourier transformed decay function for q in X,Y coordinates

Implements IFTDecayFunction2D.

Definition at line 76 of file FTDecay2D.cpp.

77 {
78  double sum_sq = qx * qx * m_decay_length_x * m_decay_length_x
79  + qy * qy * m_decay_length_y * m_decay_length_y;
80  return M_TWOPI * m_decay_length_x * m_decay_length_y * std::pow(1.0 + sum_sq, -1.5);
81 }
M_TWOPI
#define M_TWOPI
Definition: MathConstants.h:49

References IFTDecayFunction2D::m_decay_length_x, IFTDecayFunction2D::m_decay_length_y, and M_TWOPI.

◆ decayLengthX()

double IFTDecayFunction2D::decayLengthX ( ) const
inlineinherited

get decay length in distribution's X-direction

Definition at line 33 of file FTDecay2D.h.

33 { return m_decay_length_x; }

References IFTDecayFunction2D::m_decay_length_x.

◆ decayLengthY()

double IFTDecayFunction2D::decayLengthY ( ) const
inlineinherited

get decay length in distribution's Y-direction

Definition at line 35 of file FTDecay2D.h.

35 { return m_decay_length_y; }

References IFTDecayFunction2D::m_decay_length_y.

◆ gamma()

double IFTDecayFunction2D::gamma ( ) const
inlineinherited

get angle between first lattice vector and X-axis of distribution (both in direct space)

Definition at line 37 of file FTDecay2D.h.

37 { return m_gamma; }

References IFTDecayFunction2D::m_gamma.

Referenced by FTDecayFunction2DCauchy(), FTDecayFunction2DGauss::FTDecayFunction2DGauss(), and FTDecayFunction2DVoigt::FTDecayFunction2DVoigt().

◆ boundingReciprocalLatticeCoordinates()

std::pair< double, double > IFTDecayFunction2D::boundingReciprocalLatticeCoordinates ( double  qX,
double  qY,
double  a,
double  b,
double  alpha 
) const
inherited

transform back to a*, b* basis:

Calculates bounding values of reciprocal lattice coordinates that contain the centered rectangle with a corner defined by qX and qY.

Definition at line 37 of file FTDecay2D.cpp.

39 {
40  auto q_bounds_1 = transformToRecLatticeCoordinates(qX, qY, a, b, alpha);
41  auto q_bounds_2 = transformToRecLatticeCoordinates(qX, -qY, a, b, alpha);
42  double qa_max = std::max(std::abs(q_bounds_1.first), std::abs(q_bounds_2.first));
43  double qb_max = std::max(std::abs(q_bounds_1.second), std::abs(q_bounds_2.second));
44  return {qa_max, qb_max};
45 }
IFTDecayFunction2D::transformToRecLatticeCoordinates
std::pair< double, double > transformToRecLatticeCoordinates(double qX, double qY, double a, double b, double alpha) const
transform reciprocal coordinate system of this decay function to the reciprocal lattice system
Definition: FTDecay2D.cpp:47

References IFTDecayFunction2D::transformToRecLatticeCoordinates().

Here is the call graph for this function:

◆ transformToRecLatticeCoordinates()

std::pair< double, double > IFTDecayFunction2D::transformToRecLatticeCoordinates ( double  qX,
double  qY,
double  a,
double  b,
double  alpha 
) const
privateinherited

transform reciprocal coordinate system of this decay function to the reciprocal lattice system

Definition at line 47 of file FTDecay2D.cpp.

50 {
51  double qa = (a * qX * std::cos(m_gamma) - a * qY * std::sin(m_gamma)) / M_TWOPI;
52  double qb = (b * qX * std::cos(alpha - m_gamma) + b * qY * std::sin(alpha - m_gamma)) / M_TWOPI;
53  return {qa, qb};
54 }

References IFTDecayFunction2D::m_gamma, and M_TWOPI.

Referenced by IFTDecayFunction2D::boundingReciprocalLatticeCoordinates().

◆ 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(), IParticle::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(), IParticle::setRotation(), LayerInterface::setRoughness(), and InterferenceFunction2DSuperLattice::setSubstructureIFF().

Here is the call graph for this function:

◆ getChildren()

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

Returns a vector of children (const).

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

Definition at line 64 of file INode.cpp.

65 {
66  return {};
67 }

Referenced by INodeUtils::AllDescendantsOfType(), INodeUtils::ChildNodesOfType(), ISample::containedMaterials(), INode::copyNumber(), PostorderStrategy::first(), PreorderStrategy::next(), and PostorderStrategy::next().

◆ 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
INode::getChildren
virtual std::vector< const INode * > getChildren() const
Returns a vector of children (const).
Definition: INode.cpp:64
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(), IParticle::registerAbundance(), ParticleLayout::registerParticleDensity(), Layer::registerThickness(), IParameterized::registerVector(), ParticleLayout::registerWeight(), ResolutionFunction2DGaussian::ResolutionFunction2DGaussian(), ResonatorBuilder::ResonatorBuilder(), Lattice2D::setRotationEnabled(), SquareLattice::SquareLattice(), and TriangularRippleBuilder::TriangularRippleBuilder().

Here is the call graph for this function:

◆ registerVector()

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

Definition at line 54 of file IParameterized.cpp.

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

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

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

Here is the call graph for this function:

◆ setParameterValue()

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

Definition at line 62 of file IParameterized.cpp.

63 {
64  if (name.find('*') == std::string::npos && name.find('/') == std::string::npos) {
65  m_pool->setParameterValue(name, value);
66  } else {
67  std::unique_ptr<ParameterPool> P_pool{createParameterTree()};
68  if (name.find('*') != std::string::npos)
69  P_pool->setMatchedParametersValue(name, value);
70  else
71  P_pool->setParameterValue(name, value);
72  }
73 }
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(), IParticle::registerAbundance(), Lattice::registerBasisVectors(), ParticleLayout::registerParticleDensity(), IParticle::registerPosition(), Layer::registerThickness(), Lattice2D::setRotationEnabled(), and DistributionLogNormal::setUnits().

◆ onChange()

virtual void IParameterized::onChange ( )
inlinevirtualinherited

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

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

Definition at line 58 of file IParameterized.h.

58 {}

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

◆ removeParameter()

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

Definition at line 88 of file IParameterized.cpp.

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

References IParameterized::m_pool.

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

◆ removeVector()

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

Definition at line 93 of file IParameterized.cpp.

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

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

Referenced by IParticle::registerPosition().

Here is the call graph for this function:

◆ XComponentName()

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

Definition at line 100 of file IParameterized.cpp.

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

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

◆ YComponentName()

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

Definition at line 105 of file IParameterized.cpp.

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

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

◆ ZComponentName()

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

Definition at line 110 of file IParameterized.cpp.

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

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

◆ setName()

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

Definition at line 68 of file IParameterized.h.

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

References IParameterized::m_name.

Referenced by BasicLattice::BasicLattice(), Beam::Beam(), Layer::clone(), ConvolutionDetectorResolution::ConvolutionDetectorResolution(), LayersWithAbsorptionBuilder::createSampleByIndex(), Basic2DParaCrystalBuilder::createSampleByIndex(), ParticleInVacuumBuilder::createSampleByIndex(), SimpleMagneticRotationBuilder::createSampleByIndex(), Crystal::Crystal(), DetectionProperties::DetectionProperties(), DistributionHandler::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_decay_length_x

const double& IFTDecayFunction2D::m_decay_length_x
protectedinherited

Definition at line 47 of file FTDecay2D.h.

Referenced by clone(), FTDecayFunction2DGauss::clone(), FTDecayFunction2DVoigt::clone(), IFTDecayFunction2D::decayLengthX(), evaluate(), FTDecayFunction2DGauss::evaluate(), and FTDecayFunction2DVoigt::evaluate().

◆ m_decay_length_y

const double& IFTDecayFunction2D::m_decay_length_y
protectedinherited

Definition at line 48 of file FTDecay2D.h.

Referenced by clone(), FTDecayFunction2DGauss::clone(), FTDecayFunction2DVoigt::clone(), IFTDecayFunction2D::decayLengthY(), evaluate(), FTDecayFunction2DGauss::evaluate(), and FTDecayFunction2DVoigt::evaluate().

◆ m_gamma

const double& IFTDecayFunction2D::m_gamma
protectedinherited

Definition at line 49 of file FTDecay2D.h.

Referenced by clone(), FTDecayFunction2DGauss::clone(), FTDecayFunction2DVoigt::clone(), IFTDecayFunction2D::gamma(), and IFTDecayFunction2D::transformToRecLatticeCoordinates().

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