DistributionLorentz Class Reference

Inheritance diagram for DistributionLorentz:

Collaboration diagram for DistributionLorentz:

Public Member Functions
	DistributionLorentz (const std::vector< double > P)
	DistributionLorentz (double mean, double hwhm)
	DistributionLorentz ()
DistributionLorentz *	clone () const final
double	probabilityDensity (double x) const final
double	getMean () const final
double	getHWHM () const
virtual std::vector< double >	equidistantPoints (size_t nbr_samples, double sigma_factor, const RealLimits &limits=RealLimits()) const
bool	isDelta () const final
void	accept (INodeVisitor *visitor) const final
std::vector< ParameterSample >	equidistantSamples (size_t nbr_samples, double sigma_factor=0., const RealLimits &limits=RealLimits()) const
std::vector< ParameterSample >	equidistantSamplesInRange (size_t nbr_samples, double xmin, double xmax) const
virtual std::vector< double >	equidistantPointsInRange (size_t nbr_samples, double xmin, double xmax) const
virtual void	setUnits (const std::string &units)
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 Member Functions
void	adjustMinMaxForLimits (double &xmin, double &xmax, const RealLimits &limits) const
std::vector< ParameterSample >	generateSamplesFromValues (const std::vector< double > &sample_values) const

Protected Attributes
const size_t	m_NP
std::vector< double >	m_P

Private Attributes
const double &	m_mean
const double &	m_hwhm
const INode *	m_parent {nullptr}
std::string	m_name
std::unique_ptr< ParameterPool >	m_pool

Detailed Description

Lorentz distribution with half width hwhm.

Definition at line 119 of file Distributions.h.

Constructor & Destructor Documentation

DistributionLorentz() [1/3]

DistributionLorentz::DistributionLorentz

(

const std::vector< double >

P

)

Definition at line 173 of file Distributions.cpp.

    : IDistribution1D({"DistributionLorentz",
                       "class_tooltip",
                       {{"Mean", "", "para_tooltip", -INF, +INF, 0},
                        {"HWHM", "", "para_tooltip", -INF, +INF, 0}}},
                      P),
      m_mean(m_P[0]), m_hwhm(m_P[1])
{
    if (m_hwhm < 0.0)
        throw Exceptions::ClassInitializationException("DistributionLorentz: hwhm<0");
}

References INF.

DistributionLorentz() [2/3]

DistributionLorentz::DistributionLorentz	(	double	mean,
		double	hwhm
	)

Definition at line 185 of file Distributions.cpp.

    : DistributionLorentz(std::vector<double>{mean, hwhm})
{
}

DistributionLorentz() [3/3]

DistributionLorentz::DistributionLorentz

(

)

Definition at line 190 of file Distributions.cpp.

: DistributionLorentz(0., 1.) {}

Referenced by clone().

Member Function Documentation

clone()

DistributionLorentz* DistributionLorentz::clone ( ) const

inlinefinalvirtual

Implements IDistribution1D.

Definition at line 126 of file Distributions.h.

{ return new DistributionLorentz(m_mean, m_hwhm); }

References DistributionLorentz(), m_hwhm, and m_mean.

Here is the call graph for this function:

probabilityDensity()

double DistributionLorentz::probabilityDensity ( double  x ) const

finalvirtual

Returns the distribution-specific probability density for value x.

Implements IDistribution1D.

Definition at line 192 of file Distributions.cpp.

{
    if (m_hwhm == 0.0)
        return DoubleEqual(x, m_mean) ? 1.0 : 0.0;
    return m_hwhm / (m_hwhm * m_hwhm + (x - m_mean) * (x - m_mean)) / M_PI;
}

References anonymous_namespace{Distributions.cpp}::DoubleEqual(), m_hwhm, m_mean, and M_PI.

Here is the call graph for this function:

getMean()

double DistributionLorentz::getMean ( ) const

inlinefinalvirtual

Returns the distribution-specific mean.

Implements IDistribution1D.

Definition at line 129 of file Distributions.h.

{ return m_mean; }

References m_mean.

getHWHM()

double DistributionLorentz::getHWHM ( ) const

inline

Definition at line 130 of file Distributions.h.

{ return m_hwhm; }

References m_hwhm.

equidistantPoints()

std::vector< double > DistributionLorentz::equidistantPoints ( size_t  nbr_samples, double  sigma_factor, const RealLimits &  limits = RealLimits()  ) const

virtual

generate list of sample values

Implements IDistribution1D.

Definition at line 199 of file Distributions.cpp.

{
    if (sigma_factor <= 0.0)
        sigma_factor = 2.0;
    double xmin = m_mean - sigma_factor * m_hwhm;
    double xmax = m_mean + sigma_factor * m_hwhm;
    adjustMinMaxForLimits(xmin, xmax, limits);
    return equidistantPointsInRange(nbr_samples, xmin, xmax);
}

References IDistribution1D::adjustMinMaxForLimits(), IDistribution1D::equidistantPointsInRange(), m_hwhm, and m_mean.

Here is the call graph for this function:

isDelta()

bool DistributionLorentz::isDelta ( ) const

finalvirtual

Returns true if the distribution is in the limit case of a Dirac delta distribution.

Implements IDistribution1D.

Definition at line 210 of file Distributions.cpp.

{
    return m_hwhm == 0.0;
}

References m_hwhm.

accept()

void DistributionLorentz::accept ( INodeVisitor *  visitor ) const

inlinefinalvirtual

Calls the INodeVisitor's visit method.

Implements INode.

Definition at line 138 of file Distributions.h.

{ visitor->visit(this); }

equidistantSamples()

std::vector< ParameterSample > IDistribution1D::equidistantSamples ( size_t  nbr_samples, double  sigma_factor = 0., const RealLimits &  limits = RealLimits()  ) const

inherited

Returns equidistant samples, using intrinsic parameters, weighted with probabilityDensity().

Definition at line 42 of file Distributions.cpp.

{
    if (nbr_samples == 0)
        throw Exceptions::OutOfBoundsException(
            "IDistribution1D::generateSamples: "
            "number of generated samples must be bigger than zero");
    if (isDelta())
        return {ParameterSample(getMean())};
    return generateSamplesFromValues(equidistantPoints(nbr_samples, sigma_factor, limits));
}

References IDistribution1D::equidistantPoints(), IDistribution1D::generateSamplesFromValues(), IDistribution1D::getMean(), and IDistribution1D::isDelta().

Here is the call graph for this function:

equidistantSamplesInRange()

std::vector< ParameterSample > IDistribution1D::equidistantSamplesInRange ( size_t  nbr_samples, double  xmin, double  xmax  ) const

inherited

Returns equidistant samples from xmin to xmax, weighted with probabilityDensity().

Definition at line 58 of file Distributions.cpp.

{
    if (nbr_samples == 0)
        throw Exceptions::OutOfBoundsException(
            "IDistribution1D::generateSamples: "
            "number of generated samples must be bigger than zero");
    if (isDelta())
        return {ParameterSample(getMean())};
    return generateSamplesFromValues(equidistantPointsInRange(nbr_samples, xmin, xmax));
}

References IDistribution1D::equidistantPointsInRange(), IDistribution1D::generateSamplesFromValues(), IDistribution1D::getMean(), and IDistribution1D::isDelta().

Here is the call graph for this function:

equidistantPointsInRange()

std::vector< double > IDistribution1D::equidistantPointsInRange ( size_t  nbr_samples, double  xmin, double  xmax  ) const

virtualinherited

Returns equidistant interpolation points from xmin to xmax.

Definition at line 71 of file Distributions.cpp.

{
    if (nbr_samples < 2 || DoubleEqual(xmin, xmax))
        return {getMean()};
    std::vector<double> result(nbr_samples);
    for (size_t i = 0; i < nbr_samples; ++i)
        result[i] = xmin + i * (xmax - xmin) / (nbr_samples - 1.0);
    return result;
}

References anonymous_namespace{Distributions.cpp}::DoubleEqual(), and IDistribution1D::getMean().

Referenced by DistributionGate::equidistantPoints(), equidistantPoints(), DistributionGaussian::equidistantPoints(), DistributionLogNormal::equidistantPoints(), DistributionCosine::equidistantPoints(), DistributionTrapezoid::equidistantPoints(), and IDistribution1D::equidistantSamplesInRange().

Here is the call graph for this function:

setUnits()

void IDistribution1D::setUnits ( const std::string &  units )

virtualinherited

Sets distribution units.

Reimplemented in DistributionLogNormal.

Definition at line 82 of file Distributions.cpp.

{
    for (auto* par : parameterPool()->parameters())
        par->setUnit(units);
}

References IParameterized::parameterPool().

Here is the call graph for this function:

adjustMinMaxForLimits()

void IDistribution1D::adjustMinMaxForLimits ( double &  xmin, double &  xmax, const RealLimits &  limits  ) const

protectedinherited

modifies xmin and xmax if they are outside of limits

Definition at line 88 of file Distributions.cpp.

{
    if (limits.hasLowerLimit() && xmin < limits.lowerLimit())
        xmin = limits.lowerLimit();
    if (limits.hasUpperLimit() && xmax > limits.upperLimit())
        xmax = limits.upperLimit();
    if (xmin > xmax) {
        std::ostringstream ostr;
        ostr << "IDistribution1D::adjustMinMaxForLimits() -> Error. Can't' adjust ";
        ostr << "xmin:" << xmin << " xmax:" << xmax << " for given limits " << limits << std::endl;
        throw Exceptions::DomainErrorException(ostr.str());
    }
}

References RealLimits::hasLowerLimit(), RealLimits::hasUpperLimit(), RealLimits::lowerLimit(), and RealLimits::upperLimit().

Referenced by DistributionGate::equidistantPoints(), equidistantPoints(), DistributionGaussian::equidistantPoints(), DistributionLogNormal::equidistantPoints(), DistributionCosine::equidistantPoints(), and DistributionTrapezoid::equidistantPoints().

Here is the call graph for this function:

generateSamplesFromValues()

std::vector< ParameterSample > IDistribution1D::generateSamplesFromValues ( const std::vector< double > &  sample_values ) const

protectedinherited

Returns weighted samples from given interpolation points and probabilityDensity().

Definition at line 106 of file Distributions.cpp.

{
    std::vector<ParameterSample> result;
    double norm_factor = 0.0;
    for (double value : sample_values) {
        double pdf = probabilityDensity(value);
        result.push_back(ParameterSample(value, pdf));
        norm_factor += pdf;
    }
    if (norm_factor <= 0.0)
        throw Exceptions::RuntimeErrorException("IDistribution1D::generateSamples: "
                                                "total probability must be bigger than zero");
    for (ParameterSample& sample : result)
        sample.weight /= norm_factor;
    return result;
}

References IDistribution1D::probabilityDensity().

Referenced by IDistribution1D::equidistantSamples(), and IDistribution1D::equidistantSamplesInRange().

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.

{
    return NodeUtils::nodeToString(*this);
}

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.

{
    ASSERT(node);
    node->setParent(this);
}

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.

{
    return {};
}

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.

{
    m_parent = newParent;
}

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.

{
    return m_parent;
}

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.

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

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.

{
    if (node->parent() != this)
        return -1;
 
    int result(-1), count(0);
    for (auto child : getChildren()) {
 
        if (child == nullptr)
            throw std::runtime_error("INode::copyNumber() -> Error. Nullptr as child.");
 
        if (child == node)
            result = count;
 
        if (child->getName() == node->getName())
            ++count;
    }
 
    return count > 1 ? result : -1;
}

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.

{
    std::string result = getName();
    if (m_parent) {
        int index = m_parent->copyNumber(this);
        if (index >= 0)
            result = result + std::to_string(index);
    }
    return result;
}

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.

{
    std::unique_ptr<ParameterPool> result(new ParameterPool);
 
    NodeIterator<PreorderStrategy> it(this);
    it.first();
    while (!it.isDone()) {
        const INode* child = it.getCurrent();
        const std::string path = NodeUtils::nodePath(*child, this->parent()) + "/";
        child->parameterPool()->copyToExternalPool(path, result.get());
        it.next();
    }
 
    return result.release();
}

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.

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

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.

{
    std::ostringstream result;
    std::unique_ptr<ParameterPool> P_pool(createParameterTree());
    result << *P_pool << "\n";
    return result.str();
}

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.

{
    return m_pool->addParameter(
        new RealParameter(name, data, getName(), [&]() -> void { onChange(); }));
}

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.

{
    registerParameter(XComponentName(base_name), &((*p_vec)[0])).setUnit(units);
    registerParameter(YComponentName(base_name), &((*p_vec)[1])).setUnit(units);
    registerParameter(ZComponentName(base_name), &((*p_vec)[2])).setUnit(units);
}

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.

{
    if (name.find('*') == std::string::npos && name.find('/') == std::string::npos) {
        m_pool->setParameterValue(name, value);
    } else {
        std::unique_ptr<ParameterPool> P_pool{createParameterTree()};
        if (name.find('*') != std::string::npos)
            P_pool->setMatchedParametersValue(name, value);
        else
            P_pool->setParameterValue(name, value);
    }
}

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.

{
    setParameterValue(XComponentName(base_name), value.x());
    setParameterValue(YComponentName(base_name), value.y());
    setParameterValue(ZComponentName(base_name), value.z());
}

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.

{
    return m_pool->parameter(name);
}

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.

{}

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

removeParameter()

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

inherited

Definition at line 88 of file IParameterized.cpp.

{
    m_pool->removeParameter(name);
}

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.

{
    removeParameter(XComponentName(base_name));
    removeParameter(YComponentName(base_name));
    removeParameter(ZComponentName(base_name));
}

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.

{
    return base_name + "X";
}

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.

{
    return base_name + "Y";
}

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.

{
    return base_name + "Z";
}

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.

{ m_name = name; }

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.

{ 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_mean

const double& DistributionLorentz::m_mean

private

Definition at line 141 of file Distributions.h.

Referenced by clone(), equidistantPoints(), getMean(), and probabilityDensity().

m_hwhm

const double& DistributionLorentz::m_hwhm

private

Definition at line 142 of file Distributions.h.

Referenced by clone(), equidistantPoints(), getHWHM(), isDelta(), and probabilityDensity().

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:

• /home/www/ba/Param/Distrib/Distributions.h
• /home/www/ba/Param/Distrib/Distributions.cpp