RotationEuler Class Reference

Description

A sequence of rotations about the z-x'-z'' axes.

Definition at line 146 of file Rotations.h.

Inheritance diagram for RotationEuler:

Collaboration diagram for RotationEuler:

Public Member Functions
	RotationEuler (double alpha, double beta, double gamma)
	RotationEuler (std::vector< double > P)
double	alpha () const
double	beta () const
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...
RotationEuler *	clone () const override
IRotation *	createInverse () const override
	Returns a new IRotation object that is the current object's inverse. More...
double	gamma () const
virtual bool	isIdentity () const
	Returns true if rotation matrix is identity matrix (no rotations) More...
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...
RotMatrix	rotMatrix () const override
	Returns transformation. More...
virtual void	transferToCPP ()
	Used for Python overriding of clone (see swig/tweaks.py) More...
R3	transformed (const R3 &v) const
bool	zInvariant () const

Static Public Member Functions
static IRotation *	createRotation (const RotMatrix &transform)

Protected Attributes
double	m_alpha
double	m_beta
double	m_gamma
std::vector< double >	m_P

Constructor & Destructor Documentation

RotationEuler() [1/2]

RotationEuler::RotationEuler

(

std::vector< double >

P

)

Definition at line 153 of file Rotations.cpp.

    : IRotation(P)
    , m_alpha(m_P[0])
    , m_beta(m_P[1])
    , m_gamma(m_P[2])
{
    checkNodeArgs();
}

References INode::checkNodeArgs().

Referenced by clone().

Here is the call graph for this function:

RotationEuler() [2/2]

RotationEuler::RotationEuler	(	double	alpha,
		double	beta,
		double	gamma
	)

Definition at line 162 of file Rotations.cpp.

    : RotationEuler(std::vector<double>{alpha, beta, gamma})
{
}

References alpha(), beta(), and gamma().

Here is the call graph for this function:

Member Function Documentation

alpha()

double RotationEuler::alpha ( ) const

inline

Definition at line 162 of file Rotations.h.

{ return m_alpha; }

References m_alpha.

Referenced by RotationEuler().

beta()

double RotationEuler::beta ( ) const

inline

Definition at line 163 of file Rotations.h.

{ return m_beta; }

References m_beta.

Referenced by RotationEuler().

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

inlinefinalvirtual

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

Implements INode.

Definition at line 152 of file Rotations.h.

{ return "RotationEuler"; }

clone()

RotationEuler* RotationEuler::clone ( ) const

inlineoverridevirtual

Implements IRotation.

Definition at line 151 of file Rotations.h.

{ return new RotationEuler(m_alpha, m_beta, m_gamma); }

References RotationEuler(), m_alpha, m_beta, and m_gamma.

Here is the call graph for this function:

createInverse()

IRotation * RotationEuler::createInverse ( ) const

overridevirtual

Returns a new IRotation object that is the current object's inverse.

Implements IRotation.

Definition at line 167 of file Rotations.cpp.

{
    RotMatrix inverse_transform(rotMatrix().Inverse());
    return createRotation(inverse_transform);
}

References IRotation::createRotation(), ROOT::Minuit2::Inverse(), and rotMatrix().

Here is the call graph for this function:

createRotation()

IRotation * IRotation::createRotation ( const RotMatrix &  transform )

staticinherited

Definition at line 28 of file Rotations.cpp.

{
    if (matrix.isIdentity())
        return new IdentityRotation;
    if (std::optional<double> angle = matrix.angleAroundCoordAxis(0))
        return new RotationX(angle.value());
    if (std::optional<double> angle = matrix.angleAroundCoordAxis(1))
        return new RotationY(angle.value());
    if (std::optional<double> angle = matrix.angleAroundCoordAxis(2))
        return new RotationZ(angle.value());
    auto angles = matrix.zxzEulerAngles();
    return new RotationEuler(angles[0], angles[1], angles[2]);
}

References RotMatrix::angleAroundCoordAxis(), RotMatrix::isIdentity(), and RotMatrix::zxzEulerAngles().

Referenced by ReParticle::bottomZ(), createInverse(), createProduct(), and ReParticle::topZ().

Here is the call graph for this function:

gamma()

double RotationEuler::gamma ( ) const

inline

Definition at line 164 of file Rotations.h.

{ return m_gamma; }

References m_gamma.

Referenced by RotationEuler().

isIdentity()

bool IRotation::isIdentity ( ) const

virtualinherited

Returns true if rotation matrix is identity matrix (no rotations)

Reimplemented in IdentityRotation.

Definition at line 47 of file Rotations.cpp.

{
    return rotMatrix().isIdentity();
}

References RotMatrix::isIdentity(), and IRotation::rotMatrix().

Referenced by ReParticle::createTransformedFormFactor().

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> RotationEuler::parDefs ( ) const

inlinefinalvirtual

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

Reimplemented from INode.

Definition at line 154 of file Rotations.h.

    {
        return {{"Alpha", "rad", "First Euler angle, rotation around z axis", -INF, +INF, 0},
                {"Beta", "rad", "Second Euler angle, rotation around x' axis", -INF, +INF, 0},
                {"Gamma", "rad", "Third Euler angle, rotation around z'' axis", -INF, +INF, 0}};
    }

References INF.

rotMatrix()

RotMatrix RotationEuler::rotMatrix ( ) const

overridevirtual

Returns transformation.

Implements IRotation.

Definition at line 173 of file Rotations.cpp.

{
    return RotMatrix::EulerZXZ(m_alpha, m_beta, m_gamma);
}

References RotMatrix::EulerZXZ(), m_alpha, m_beta, and m_gamma.

Referenced by createInverse().

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 32 of file ICloneable.h.

transformed()

R3 IRotation::transformed ( const R3 &  v ) const

inherited

Definition at line 42 of file Rotations.cpp.

{
    return rotMatrix().transformed(v);
}

References IRotation::rotMatrix(), and RotMatrix::transformed().

Referenced by ReParticle::bottomZ(), Sphere::bottomZ(), IParticle::rotate(), ReParticle::topZ(), and Sphere::topZ().

Here is the call graph for this function:

zInvariant()

bool IRotation::zInvariant ( ) const

inherited

Definition at line 52 of file Rotations.cpp.

{
    return rotMatrix().isZRotation();
}

References RotMatrix::isZRotation(), and IRotation::rotMatrix().

Referenced by IFormFactor::canSliceAnalytically().

Here is the call graph for this function:

Member Data Documentation

m_alpha

double RotationEuler::m_alpha

protected

Definition at line 169 of file Rotations.h.

Referenced by alpha(), clone(), and rotMatrix().

m_beta

double RotationEuler::m_beta

protected

Definition at line 169 of file Rotations.h.

Referenced by beta(), clone(), and rotMatrix().

m_gamma

double RotationEuler::m_gamma

protected

Definition at line 169 of file Rotations.h.

Referenced by clone(), gamma(), and rotMatrix().

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/Scattering/Rotations.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Sample/Scattering/Rotations.cpp