Profile2DCauchy Class Reference

Description

Two-dimensional Cauchy distribution in Fourier space; corresponds to a normalized exp(-r) in real space, with .

Definition at line 71 of file Profiles2D.h.

Inheritance diagram for Profile2DCauchy:

Collaboration diagram for Profile2DCauchy:

Public Member Functions
	Profile2DCauchy (double omega_x, double omega_y, double gamma)
	Profile2DCauchy (std::vector< double > P)
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...
Profile2DCauchy *	clone () const override
std::unique_ptr< IDistribution2DSampler >	createSampler () const override
double	decayFT2D (double qx, double qy) const override
double	decayLengthX () const
double	decayLengthY () const
double	delta () const
	Angle in direct space between X- and Y-axis of distribution. More...
double	gamma () const
virtual std::vector< const INode * >	nodeChildren () const
	Returns all children. More...
std::vector< const INode * >	nodeOffspring () const
	Returns all descendants. More...
double	omegaX () const
double	omegaY () const
std::vector< ParaMeta >	parDefs () const final
	Returns the parameter definitions, to be hard-coded in each leaf class. More...
virtual std::string	pythonConstructor () const
	Creates the Python constructor of this class (or derived classes) More...
double	standardizedFT2D (double qx, double qy) const override
	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...
virtual void	transferToCPP ()
	Used for Python overriding of clone (see swig/tweaks.py) More...

Protected Member Functions
double	sumsq (double qx, double qy) const

Protected Attributes
const double &	m_gamma
const double &	m_omega_x
const double &	m_omega_y
std::vector< double >	m_P

Constructor & Destructor Documentation

Profile2DCauchy() [1/2]

Profile2DCauchy::Profile2DCauchy

(

std::vector< double >

P

)

Definition at line 50 of file Profiles2D.cpp.

    : IProfile2D(P)
{
    checkNodeArgs();
}

References INode::checkNodeArgs().

Referenced by clone().

Here is the call graph for this function:

Profile2DCauchy() [2/2]

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

Definition at line 56 of file Profiles2D.cpp.

    : Profile2DCauchy(std::vector<double>{omega_x, omega_y, gamma})
{
}

References IProfile2D::gamma().

Here is the call graph for this function:

Member Function Documentation

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(), 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 Profile2DCauchy::className ( ) const

inlinefinalvirtual

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

Implements INode.

Definition at line 77 of file Profiles2D.h.

{ return "Profile2DCauchy"; }

clone()

Profile2DCauchy * Profile2DCauchy::clone ( ) const

overridevirtual

Implements IProfile2D.

Definition at line 61 of file Profiles2D.cpp.

{
    return new Profile2DCauchy(m_omega_x, m_omega_y, m_gamma);
}

References Profile2DCauchy(), IProfile2D::m_gamma, IProfile2D::m_omega_x, and IProfile2D::m_omega_y.

Here is the call graph for this function:

createSampler()

std::unique_ptr< IDistribution2DSampler > Profile2DCauchy::createSampler ( ) const

overridevirtual

Implements IProfile2D.

Definition at line 77 of file Profiles2D.cpp.

{
    return std::make_unique<Distribution2DCauchySampler>(m_omega_x, m_omega_y);
}

References IProfile2D::m_omega_x, and IProfile2D::m_omega_y.

decayFT2D()

double Profile2DCauchy::decayFT2D ( double  qx, double  qy  ) const

overridevirtual

Implements IProfile2D.

Definition at line 71 of file Profiles2D.cpp.

{
    double sum_sq = qx * qx * m_omega_x * m_omega_x + qy * qy * m_omega_y * m_omega_y;
    return M_TWOPI * m_omega_x * m_omega_y * std::pow(1.0 + sum_sq, -1.5);
}

References IProfile2D::m_omega_x, IProfile2D::m_omega_y, and M_TWOPI.

decayLengthX()

double IProfile2D::decayLengthX ( ) const

inlineinherited

Definition at line 37 of file Profiles2D.h.

{ return m_omega_x; }

References IProfile2D::m_omega_x.

decayLengthY()

double IProfile2D::decayLengthY ( ) const

inlineinherited

Definition at line 38 of file Profiles2D.h.

{ return m_omega_y; }

References IProfile2D::m_omega_y.

delta()

double IProfile2D::delta ( ) const

inlineinherited

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

Definition at line 42 of file Profiles2D.h.

{ return M_PI_2; }

References M_PI_2.

Referenced by Interference2DParaCrystal::FTPDF().

gamma()

double IProfile2D::gamma ( ) const

inlineinherited

Definition at line 39 of file Profiles2D.h.

{ return m_gamma; }

References IProfile2D::m_gamma.

Referenced by Profile2DCauchy(), Profile2DCone::Profile2DCone(), Profile2DGate::Profile2DGate(), Profile2DGauss::Profile2DGauss(), Profile2DVoigt::Profile2DVoigt(), and Interference2DParaCrystal::FTPDF().

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:

omegaX()

double IProfile2D::omegaX ( ) const

inlineinherited

Definition at line 35 of file Profiles2D.h.

{ return m_omega_x; }

References IProfile2D::m_omega_x.

omegaY()

double IProfile2D::omegaY ( ) const

inlineinherited

Definition at line 36 of file Profiles2D.h.

{ return m_omega_y; }

References IProfile2D::m_omega_y.

parDefs()

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

inlinefinalvirtual

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

Reimplemented from INode.

Definition at line 79 of file Profiles2D.h.

    {
        return {{"OmegaX", "nm", "Half-width along x axis", 0, INF, 1.},
                {"OmegaY", "nm", "Half-width along y axis", 0, INF, 1.},
                {"Gamma", "rad",
                 "direct-space orientation with respect to the first lattice vector", -M_PI_2,
                 +M_PI_2, 0}};
    }

References INF, and M_PI_2.

pythonConstructor()

std::string IProfile2D::pythonConstructor ( ) const

virtualinherited

Creates the Python constructor of this class (or derived classes)

Reimplemented in Profile2DVoigt.

Definition at line 34 of file Profiles2D.cpp.

{
    ASSERT(m_P.size() == 3);
    return Py::Fmt::printFunction(className(),
                                  {{m_omega_x, "nm"}, {m_omega_y, "nm"}, {m_gamma, "rad"}});
}

References ASSERT, INode::className(), IProfile2D::m_gamma, IProfile2D::m_omega_x, IProfile2D::m_omega_y, INode::m_P, and Py::Fmt::printFunction().

Referenced by SampleToPython::defineInterferences().

Here is the call graph for this function:

standardizedFT2D()

double Profile2DCauchy::standardizedFT2D ( double  qx, double  qy  ) const

overridevirtual

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

Definition at line 66 of file Profiles2D.cpp.

{
    return std::pow(1.0 + sumsq(qx, qy), -1.5);
}

References IProfile2D::sumsq().

Here is the call graph for this function:

sumsq()

double IProfile2D::sumsq ( double  qx, double  qy  ) const

protectedinherited

Definition at line 41 of file Profiles2D.cpp.

{
    return qx * qx * m_omega_x * m_omega_x + qy * qy * m_omega_y * m_omega_y;
}

References IProfile2D::m_omega_x, and IProfile2D::m_omega_y.

Referenced by standardizedFT2D(), Profile2DGauss::standardizedFT2D(), Profile2DGate::standardizedFT2D(), Profile2DCone::standardizedFT2D(), and Profile2DVoigt::standardizedFT2D().

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_gamma

const double& IProfile2D::m_gamma

protectedinherited

Definition at line 61 of file Profiles2D.h.

Referenced by clone(), Profile2DGauss::clone(), Profile2DGate::clone(), Profile2DCone::clone(), Profile2DVoigt::clone(), IProfile2D::gamma(), IProfile2D::pythonConstructor(), and Profile2DVoigt::pythonConstructor().

m_omega_x

const double& IProfile2D::m_omega_x

protectedinherited

Definition at line 59 of file Profiles2D.h.

Referenced by clone(), Profile2DGauss::clone(), Profile2DGate::clone(), Profile2DCone::clone(), Profile2DVoigt::clone(), createSampler(), Profile2DGauss::createSampler(), Profile2DGate::createSampler(), Profile2DCone::createSampler(), decayFT2D(), Profile2DGauss::decayFT2D(), Profile2DVoigt::decayFT2D(), IProfile2D::decayLengthX(), IProfile2D::omegaX(), IProfile2D::pythonConstructor(), Profile2DVoigt::pythonConstructor(), and IProfile2D::sumsq().

m_omega_y

const double& IProfile2D::m_omega_y

protectedinherited

Definition at line 60 of file Profiles2D.h.

Referenced by clone(), Profile2DGauss::clone(), Profile2DGate::clone(), Profile2DCone::clone(), Profile2DVoigt::clone(), createSampler(), Profile2DGauss::createSampler(), Profile2DGate::createSampler(), Profile2DCone::createSampler(), decayFT2D(), Profile2DGauss::decayFT2D(), Profile2DVoigt::decayFT2D(), IProfile2D::decayLengthY(), IProfile2D::omegaY(), IProfile2D::pythonConstructor(), Profile2DVoigt::pythonConstructor(), and IProfile2D::sumsq().

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

---

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

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