ResolutionFunction2DGaussian Class Reference

Description

Simple gaussian two-dimensional resolution function.

Definition at line 22 of file ResolutionFunction2DGaussian.h.

Inheritance diagram for ResolutionFunction2DGaussian:

Collaboration diagram for ResolutionFunction2DGaussian:

Public Member Functions
	ResolutionFunction2DGaussian (double sigma_x, double sigma_y)
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...
ResolutionFunction2DGaussian *	clone () const override
double	evaluateCDF (double x, double y) 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	sigmaX () const
double	sigmaY () const
virtual void	transferToCPP ()
	Used for Python overriding of clone (see swig/tweaks.py) More...

Protected Attributes
std::vector< double >	m_P

Private Member Functions
ResolutionFunction2DGaussian &	operator= (const ResolutionFunction2DGaussian &)

Private Attributes
double	m_sigma_x
double	m_sigma_y

Constructor & Destructor Documentation

ResolutionFunction2DGaussian()

ResolutionFunction2DGaussian::ResolutionFunction2DGaussian	(	double	sigma_x,
		double	sigma_y
	)

Definition at line 19 of file ResolutionFunction2DGaussian.cpp.

    : m_sigma_x(sigma_x)
    , m_sigma_y(sigma_y)
{
    RealLimits::nonnegative().check("SigmaX", m_sigma_x);
    RealLimits::nonnegative().check("SigmaY", m_sigma_y);
}

References RealLimits::check(), m_sigma_x, m_sigma_y, and RealLimits::nonnegative().

Referenced by clone().

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

inlinefinalvirtual

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

Implements INode.

Definition at line 30 of file ResolutionFunction2DGaussian.h.

{ return "ResolutionFunction2DGaussian"; }

clone()

ResolutionFunction2DGaussian* ResolutionFunction2DGaussian::clone ( ) const

inlineoverridevirtual

Implements IResolutionFunction2D.

Definition at line 26 of file ResolutionFunction2DGaussian.h.

    {
        return new ResolutionFunction2DGaussian(m_sigma_x, m_sigma_y);
    }

References ResolutionFunction2DGaussian(), m_sigma_x, and m_sigma_y.

Here is the call graph for this function:

evaluateCDF()

double ResolutionFunction2DGaussian::evaluateCDF ( double  x, double  y  ) const

overridevirtual

Implements IResolutionFunction2D.

Definition at line 27 of file ResolutionFunction2DGaussian.cpp.

{
    return Math::IntegratedGaussian(x, 0.0, m_sigma_x)
           * Math::IntegratedGaussian(y, 0.0, m_sigma_y);
}

References Math::IntegratedGaussian(), m_sigma_x, and m_sigma_y.

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:

operator=()

ResolutionFunction2DGaussian& ResolutionFunction2DGaussian::operator= ( const ResolutionFunction2DGaussian &  )

private

parDefs()

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

inlinefinalvirtual

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

Reimplemented from INode.

Definition at line 31 of file ResolutionFunction2DGaussian.h.

    {
        return {{"Sigma_x", "?", "sigma_x", 0, +INF, 0}, {"Sigma_y", "?", "sigma_y", 0, +INF, 0}};
    }

References INF.

sigmaX()

double ResolutionFunction2DGaussian::sigmaX ( ) const

inline

Definition at line 38 of file ResolutionFunction2DGaussian.h.

{ return m_sigma_x; }

References m_sigma_x.

sigmaY()

double ResolutionFunction2DGaussian::sigmaY ( ) const

inline

Definition at line 39 of file ResolutionFunction2DGaussian.h.

{ return m_sigma_y; }

References m_sigma_y.

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_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_sigma_x

double ResolutionFunction2DGaussian::m_sigma_x

private

Definition at line 44 of file ResolutionFunction2DGaussian.h.

Referenced by ResolutionFunction2DGaussian(), clone(), evaluateCDF(), and sigmaX().

m_sigma_y

double ResolutionFunction2DGaussian::m_sigma_y

private

Definition at line 45 of file ResolutionFunction2DGaussian.h.

Referenced by ResolutionFunction2DGaussian(), clone(), evaluateCDF(), and sigmaY().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Device/Resolution/ResolutionFunction2DGaussian.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Device/Resolution/ResolutionFunction2DGaussian.cpp