LorentzFisherPeakShape Class Reference

Description

A peak shape that is Lorentzian in the radial direction and uses the Mises-Fisher distribution in the angular direction.

Definition at line 118 of file IPeakShape.h.

Inheritance diagram for LorentzFisherPeakShape:

Collaboration diagram for LorentzFisherPeakShape:

Public Member Functions
	LorentzFisherPeakShape (double max_intensity, double radial_size, double kappa)
	~LorentzFisherPeakShape () override
bool	angularDisorder () const override
	Indicates if the peak shape encodes angular disorder, in which case all peaks in a spherical shell are needed. More...
void	checkNodeArgs () const
	Raises exception if a parameter value is invalid. More...
std::string	className () const final
	Returns the class name, to be hard-coded in each leaf class that inherits from INode. More...
LorentzFisherPeakShape *	clone () const override
virtual std::vector< const INode * >	nodeChildren () const
	Returns all children. More...
std::vector< const INode * >	nodeOffspring () const
	Returns all descendants. More...
std::vector< ParaMeta >	parDefs () const final
	Returns the parameter definitions, to be hard-coded in each leaf class. More...
double	peakDistribution (R3 q, R3 q_lattice_point) const override
	Peak shape at q from a reciprocal lattice point at q_lattice_point. More...
virtual void	transferToCPP ()
	Used for Python overriding of clone (see swig/tweaks.py) More...

Protected Attributes
std::vector< double >	m_P

Private Attributes
double	m_kappa
double	m_max_intensity
double	m_radial_size

Constructor & Destructor Documentation

LorentzFisherPeakShape()

LorentzFisherPeakShape::LorentzFisherPeakShape	(	double	max_intensity,
		double	radial_size,
		double	kappa
	)

Definition at line 175 of file IPeakShape.cpp.

    : m_max_intensity(max_intensity)
    , m_radial_size(radial_size)
    , m_kappa(kappa)
{
}

Referenced by clone().

~LorentzFisherPeakShape()

LorentzFisherPeakShape::~LorentzFisherPeakShape ( )

overridedefault

Member Function Documentation

angularDisorder()

bool LorentzFisherPeakShape::angularDisorder ( ) const

inlineoverridevirtual

Indicates if the peak shape encodes angular disorder, in which case all peaks in a spherical shell are needed.

Reimplemented from IPeakShape.

Definition at line 134 of file IPeakShape.h.

{ return true; }

checkNodeArgs()

void INode::checkNodeArgs ( ) const

inherited

Raises exception if a parameter value is invalid.

Definition at line 27 of file INode.cpp.

{
    size_t nP = m_P.size();
    if (parDefs().size() != nP) {
        std::cerr << "BUG in class " << className() << std::endl;
        std::cerr << "#m_P = " << nP << std::endl;
        std::cerr << "#PDf = " << parDefs().size() << std::endl;
        for (const ParaMeta& pm : parDefs())
            std::cerr << "  PDf: " << pm.name << std::endl;
        ASSERT(0);
    }
    ASSERT(parDefs().size() == nP);
    for (size_t i = 0; i < nP; ++i) {
        const ParaMeta pm = parDefs()[i];
 
        RealLimits limits = RealLimits::limitless();
        if (pm.vMin == -INF) {
            ASSERT(pm.vMax == +INF);
            // nothing to do
        } else if (pm.vMax == +INF) {
            ASSERT(pm.vMin == 0);
            limits = RealLimits::nonnegative();
        } else {
            limits = RealLimits::limited(pm.vMin, pm.vMax);
        }
        limits.check(pm.name, m_P[i]);
    }
}

References ASSERT, RealLimits::check(), INode::className(), INF, RealLimits::limited(), RealLimits::limitless(), INode::m_P, ParaMeta::name, RealLimits::nonnegative(), INode::parDefs(), ParaMeta::vMax, and ParaMeta::vMin.

Referenced by BarGauss::BarGauss(), BarLorentz::BarLorentz(), Bipyramid4::Bipyramid4(), Box::Box(), CantellatedCube::CantellatedCube(), Cone::Cone(), ConstantBackground::ConstantBackground(), CosineRippleBox::CosineRippleBox(), CosineRippleGauss::CosineRippleGauss(), CosineRippleLorentz::CosineRippleLorentz(), Cylinder::Cylinder(), DistributionCosine::DistributionCosine(), DistributionGate::DistributionGate(), DistributionGaussian::DistributionGaussian(), DistributionLogNormal::DistributionLogNormal(), DistributionLorentz::DistributionLorentz(), DistributionTrapezoid::DistributionTrapezoid(), Dodecahedron::Dodecahedron(), EllipsoidalCylinder::EllipsoidalCylinder(), FootprintGauss::FootprintGauss(), FootprintSquare::FootprintSquare(), FuzzySphere::FuzzySphere(), GaussSphere::GaussSphere(), HemiEllipsoid::HemiEllipsoid(), HollowSphere::HollowSphere(), HorizontalCylinder::HorizontalCylinder(), Icosahedron::Icosahedron(), LongBoxGauss::LongBoxGauss(), LongBoxLorentz::LongBoxLorentz(), PlatonicOctahedron::PlatonicOctahedron(), PlatonicTetrahedron::PlatonicTetrahedron(), Prism3::Prism3(), Prism6::Prism6(), Profile1DCauchy::Profile1DCauchy(), Profile1DCosine::Profile1DCosine(), Profile1DGate::Profile1DGate(), Profile1DGauss::Profile1DGauss(), Profile1DTriangle::Profile1DTriangle(), Profile1DVoigt::Profile1DVoigt(), Profile2DCauchy::Profile2DCauchy(), Profile2DCone::Profile2DCone(), Profile2DGate::Profile2DGate(), Profile2DGauss::Profile2DGauss(), Profile2DVoigt::Profile2DVoigt(), Pyramid2::Pyramid2(), Pyramid3::Pyramid3(), Pyramid4::Pyramid4(), Pyramid6::Pyramid6(), RotationEuler::RotationEuler(), RotationX::RotationX(), RotationY::RotationY(), RotationZ::RotationZ(), SawtoothRippleBox::SawtoothRippleBox(), SawtoothRippleGauss::SawtoothRippleGauss(), SawtoothRippleLorentz::SawtoothRippleLorentz(), Sphere::Sphere(), Spheroid::Spheroid(), TruncatedCube::TruncatedCube(), TruncatedSphere::TruncatedSphere(), and TruncatedSpheroid::TruncatedSpheroid().

Here is the call graph for this function:

className()

std::string LorentzFisherPeakShape::className ( ) const

inlinefinalvirtual

Returns the class name, to be hard-coded in each leaf class that inherits from INode.

Implements INode.

Definition at line 124 of file IPeakShape.h.

{ return "LorentzFisherPeakShape"; }

clone()

LorentzFisherPeakShape * LorentzFisherPeakShape::clone ( ) const

overridevirtual

Implements IPeakShape.

Definition at line 185 of file IPeakShape.cpp.

{
    return new LorentzFisherPeakShape(m_max_intensity, m_radial_size, m_kappa);
}

References LorentzFisherPeakShape(), m_kappa, m_max_intensity, and m_radial_size.

Here is the call graph for this function:

nodeChildren()

std::vector< const INode * > INode::nodeChildren ( ) const

virtualinherited

Returns all children.

Reimplemented in ISimulation2D, ISimulation, ParticleCoreShell, ParticleComposition, Particle, MesoCrystal, IParticle, Crystal, MultiLayer, Layer, LayerInterface, ParticleLayout, InterferenceRadialParaCrystal, InterferenceFinite3DLattice, InterferenceFinite2DLattice, Interference3DLattice, Interference2DSuperLattice, Interference2DParaCrystal, Interference2DLattice, Interference1DLattice, ConvolutionDetectorResolution, IDetector, and Beam.

Definition at line 56 of file INode.cpp.

{
    return {};
}

Referenced by NodeUtils::AllDescendantsOfType(), NodeUtils::ChildNodesOfType(), ISampleNode::containedMaterials(), and INode::nodeOffspring().

nodeOffspring()

std::vector< const INode * > INode::nodeOffspring ( ) const

inherited

Returns all descendants.

Definition at line 61 of file INode.cpp.

{
    std::vector<const INode*> result;
    result.push_back(this);
    for (const auto* child : nodeChildren()) {
        for (const auto* p : child->nodeOffspring())
            result.push_back(p);
    }
    return result;
}

References INode::nodeChildren().

Here is the call graph for this function:

parDefs()

std::vector<ParaMeta> LorentzFisherPeakShape::parDefs ( ) const

inlinefinalvirtual

Returns the parameter definitions, to be hard-coded in each leaf class.

Reimplemented from INode.

Definition at line 125 of file IPeakShape.h.

    {
        return {{"MaxIntensity", "", "maximum intensity", 0, +INF, -1},
                {"DomainSize", "nm", "domain size", 0, +INF, -1},
                {"Kappa", "", "?", 0, +INF, -1}};
    }

References INF.

peakDistribution()

double LorentzFisherPeakShape::peakDistribution ( R3  q, R3  q_lattice_point  ) const

overridevirtual

Peak shape at q from a reciprocal lattice point at q_lattice_point.

Implements IPeakShape.

Definition at line 190 of file IPeakShape.cpp.

{
    const double q_r = q.mag();
    const double q_lat_r = q_lattice_point.mag();
    const double dq2 = (q_r - q_lat_r) * (q_r - q_lat_r);
    if (q_lat_r == 0.0)
        return m_max_intensity * Cauchy3D(dq2, m_radial_size);
    const double radial_part = m_radial_size / (1.0 + dq2 * m_radial_size * m_radial_size) / M_PI;
    double angular_part = 1.0;
    if (q_r * q_lat_r > 0.0) {
        const double dot_norm = q.dot(q_lattice_point) / q_r / q_lat_r;
        angular_part = FisherDistribution(dot_norm, m_kappa) / (q_r * q_r);
    }
    return m_max_intensity * radial_part * angular_part;
}

References m_kappa, m_max_intensity, M_PI, and m_radial_size.

transferToCPP()

virtual void ICloneable::transferToCPP ( )

inlinevirtualinherited

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

Definition at line 32 of file ICloneable.h.

Member Data Documentation

m_kappa

double LorentzFisherPeakShape::m_kappa

private

Definition at line 139 of file IPeakShape.h.

Referenced by clone(), and peakDistribution().

m_max_intensity

double LorentzFisherPeakShape::m_max_intensity

private

Definition at line 137 of file IPeakShape.h.

Referenced by clone(), and peakDistribution().

m_P

std::vector<double> INode::m_P

protectedinherited

Definition at line 63 of file INode.h.

Referenced by IFootprintFactor::IFootprintFactor(), INode::checkNodeArgs(), IProfile1D::pythonConstructor(), IProfile2D::pythonConstructor(), IFormFactor::pythonConstructor(), Profile1DVoigt::pythonConstructor(), and Profile2DVoigt::pythonConstructor().

m_radial_size

double LorentzFisherPeakShape::m_radial_size

private

Definition at line 138 of file IPeakShape.h.

Referenced by clone(), and peakDistribution().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Sample/Correlations/IPeakShape.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Sample/Correlations/IPeakShape.cpp