IProfile2D Class Reference

Description

Interface for two-dimensional distributions in Fourier space.

Definition at line 29 of file Profiles2D.h.

Inheritance diagram for IProfile2D:

Collaboration diagram for IProfile2D:

Public Member Functions
	IProfile2D (const std::vector< double > &PValues)
void	checkNodeArgs () const
	Raises exception if a parameter value is invalid. More...
virtual std::string	className () const =0
	Returns the class name, to be hard-coded in each leaf class that inherits from INode. More...
IProfile2D *	clone () const override=0
virtual std::unique_ptr< IDistribution2DSampler >	createSampler () const =0
virtual double	decayFT2D (double qx, double qy) const =0
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
virtual std::vector< ParaMeta >	parDefs () const
	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...
virtual double	standardizedFT2D (double qx, double qy) const =0
	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

IProfile2D()

IProfile2D::IProfile2D

(

const std::vector< double > &

PValues

)

Definition at line 26 of file Profiles2D.cpp.

    : INode(PValues)
    , m_omega_x(m_P[0])
    , m_omega_y(m_P[1])
    , m_gamma(m_P[2])
{
}

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

virtual std::string INode::className ( ) const

pure virtualinherited

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

Implemented in Particle, SphericalDetector, SpecularSimulation, ScatteringSimulation, OffspecSimulation, DepthProbeSimulation, PoissonBackground, ConstantBackground, GaussSphere, FuzzySphere, RotationEuler, RotationZ, RotationY, RotationX, IdentityRotation, ParticleCoreShell, ParticleComposition, MesoCrystal, Crystal, MultiLayer, Layer, Lattice3D, HexagonalLattice2D, SquareLattice2D, BasicLattice2D, LayerRoughness, LayerInterface, TruncatedSpheroid, TruncatedSphere, TruncatedCube, Spheroid, Sphere, SawtoothRippleLorentz, SawtoothRippleGauss, SawtoothRippleBox, Pyramid6, Pyramid4, Pyramid3, Pyramid2, Prism6, Prism3, PlatonicTetrahedron, PlatonicOctahedron, LongBoxLorentz, LongBoxGauss, Icosahedron, HorizontalCylinder, HollowSphere, HemiEllipsoid, EllipsoidalCylinder, Dodecahedron, Cylinder, CosineRippleLorentz, CosineRippleGauss, CosineRippleBox, Cone, CantellatedCube, Box, Bipyramid4, BarLorentz, BarGauss, Profile2DVoigt, Profile2DCone, Profile2DGate, Profile2DGauss, Profile2DCauchy, Profile1DVoigt, Profile1DCosine, Profile1DTriangle, Profile1DGate, Profile1DGauss, Profile1DCauchy, MisesGaussPeakShape, MisesFisherGaussPeakShape, LorentzFisherPeakShape, GaussFisherPeakShape, IsotropicLorentzPeakShape, IsotropicGaussPeakShape, ParticleLayout, InterferenceTwin, InterferenceRadialParaCrystal, InterferenceNone, InterferenceHardDisk, InterferenceFinite3DLattice, InterferenceFinite2DLattice, Interference3DLattice, Interference2DSuperLattice, Interference2DParaCrystal, Interference2DLattice, Interference1DLattice, DistributionTrapezoid, DistributionCosine, DistributionLogNormal, DistributionGaussian, DistributionLorentz, DistributionGate, ResolutionFunction2DGaussian, ConvolutionDetectorResolution, PolFilter, RectangularDetector, FootprintSquare, FootprintGauss, and Beam.

Referenced by INode::checkNodeArgs(), ExemplarySamples::createBasic2DParaCrystalWithFTDis(), IProfile1D::pythonConstructor(), pythonConstructor(), IFormFactor::pythonConstructor(), and IFormFactor::shapeName().

clone()

IProfile2D* IProfile2D::clone ( ) const

overridepure virtual

Implements ICloneable.

Implemented in Profile2DVoigt, Profile2DCone, Profile2DGate, Profile2DGauss, and Profile2DCauchy.

Referenced by Interference2DLattice::setDecayFunction(), and Interference2DParaCrystal::setProbabilityDistributions().

createSampler()

virtual std::unique_ptr<IDistribution2DSampler> IProfile2D::createSampler ( ) const

pure virtual

Implemented in Profile2DVoigt, Profile2DCone, Profile2DGate, Profile2DGauss, and Profile2DCauchy.

decayFT2D()

virtual double IProfile2D::decayFT2D ( double  qx, double  qy  ) const

pure virtual

Implemented in Profile2DVoigt, Profile2DCone, Profile2DGate, Profile2DGauss, and Profile2DCauchy.

decayLengthX()

double IProfile2D::decayLengthX ( ) const

inline

Definition at line 37 of file Profiles2D.h.

{ return m_omega_x; }

References m_omega_x.

decayLengthY()

double IProfile2D::decayLengthY ( ) const

inline

Definition at line 38 of file Profiles2D.h.

{ return m_omega_y; }

References m_omega_y.

delta()

double IProfile2D::delta ( ) const

inline

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

inline

Definition at line 39 of file Profiles2D.h.

{ return m_gamma; }

References m_gamma.

Referenced by Profile2DCauchy::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

inline

Definition at line 35 of file Profiles2D.h.

{ return m_omega_x; }

References m_omega_x.

omegaY()

double IProfile2D::omegaY ( ) const

inline

Definition at line 36 of file Profiles2D.h.

{ return m_omega_y; }

References m_omega_y.

parDefs()

virtual std::vector<ParaMeta> INode::parDefs ( ) const

inlinevirtualinherited

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

Reimplemented in ConstantBackground, GaussSphere, FuzzySphere, RotationEuler, RotationZ, RotationY, RotationX, Crystal, Layer, HexagonalLattice2D, SquareLattice2D, BasicLattice2D, LayerRoughness, TruncatedSpheroid, TruncatedSphere, TruncatedCube, Spheroid, Sphere, SawtoothRippleLorentz, SawtoothRippleGauss, SawtoothRippleBox, Pyramid6, Pyramid4, Pyramid3, Pyramid2, Prism6, Prism3, PlatonicTetrahedron, PlatonicOctahedron, LongBoxLorentz, LongBoxGauss, Icosahedron, HorizontalCylinder, HollowSphere, HemiEllipsoid, EllipsoidalCylinder, Dodecahedron, Cylinder, CosineRippleLorentz, CosineRippleGauss, CosineRippleBox, Cone, CantellatedCube, Box, Bipyramid4, BarLorentz, BarGauss, Profile2DVoigt, Profile2DCone, Profile2DGate, Profile2DGauss, Profile2DCauchy, Profile1DVoigt, Profile1DCosine, Profile1DTriangle, Profile1DGate, Profile1DGauss, Profile1DCauchy, MisesGaussPeakShape, MisesFisherGaussPeakShape, LorentzFisherPeakShape, GaussFisherPeakShape, IsotropicLorentzPeakShape, IsotropicGaussPeakShape, ParticleLayout, InterferenceTwin, InterferenceRadialParaCrystal, InterferenceHardDisk, Interference2DSuperLattice, Interference2DParaCrystal, Interference1DLattice, DistributionTrapezoid, DistributionCosine, DistributionLogNormal, DistributionGaussian, DistributionLorentz, DistributionGate, ResolutionFunction2DGaussian, PolFilter, FootprintSquare, and FootprintGauss.

Definition at line 51 of file INode.h.

{ return {}; }

Referenced by INode::checkNodeArgs(), and IFormFactor::pythonConstructor().

pythonConstructor()

std::string IProfile2D::pythonConstructor ( ) const

virtual

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(), m_gamma, m_omega_x, m_omega_y, INode::m_P, and Py::Fmt::printFunction().

Referenced by SampleToPython::defineInterferences().

Here is the call graph for this function:

standardizedFT2D()

virtual double IProfile2D::standardizedFT2D ( double  qx, double  qy  ) const

pure virtual

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.

Implemented in Profile2DVoigt, Profile2DCone, Profile2DGate, Profile2DGauss, and Profile2DCauchy.

Referenced by Interference2DParaCrystal::FTPDF().

sumsq()

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

protected

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 m_omega_x, and m_omega_y.

Referenced by Profile2DCauchy::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

protected

Definition at line 61 of file Profiles2D.h.

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

m_omega_x

const double& IProfile2D::m_omega_x

protected

Definition at line 59 of file Profiles2D.h.

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

m_omega_y

const double& IProfile2D::m_omega_y

protected

Definition at line 60 of file Profiles2D.h.

Referenced by Profile2DCauchy::clone(), Profile2DGauss::clone(), Profile2DGate::clone(), Profile2DCone::clone(), Profile2DVoigt::clone(), Profile2DCauchy::createSampler(), Profile2DGauss::createSampler(), Profile2DGate::createSampler(), Profile2DCone::createSampler(), Profile2DCauchy::decayFT2D(), Profile2DGauss::decayFT2D(), Profile2DVoigt::decayFT2D(), decayLengthY(), omegaY(), pythonConstructor(), Profile2DVoigt::pythonConstructor(), and 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(), 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