From 4b4924a68d3d77ea130196007180a5d826a044a5 Mon Sep 17 00:00:00 2001 From: "Joachim Wuttke (h)" <j.wuttke@fz-juelich.de> Date: Mon, 11 May 2020 12:42:23 +0200 Subject: [PATCH] Spelling in comments and register strings: "form factor" with blank. --- .../DecoratedFormFactor/FormFactorDecoratorPositionFactor.h | 2 +- Core/DecoratedFormFactor/FormFactorDecoratorRotation.h | 2 +- Core/HardParticle/FormFactorCone.cpp | 2 +- Core/HardParticle/FormFactorHemiEllipsoid.cpp | 2 +- Core/HardParticle/FormFactorLongBox.h | 2 +- Core/HardParticle/FormFactorLongBoxGauss.h | 2 +- Core/HardParticle/FormFactorLongBoxLorentz.h | 2 +- Core/HardParticle/FormFactorLongRipple1Gauss.cpp | 4 ++-- Core/HardParticle/FormFactorLongRipple1Gauss.h | 2 +- Core/HardParticle/FormFactorLongRipple1Lorentz.cpp | 4 ++-- Core/HardParticle/FormFactorLongRipple1Lorentz.h | 2 +- Core/HardParticle/FormFactorLongRipple2Gauss.cpp | 2 +- Core/HardParticle/FormFactorLongRipple2Gauss.h | 2 +- Core/HardParticle/FormFactorLongRipple2Lorentz.cpp | 2 +- Core/HardParticle/FormFactorLongRipple2Lorentz.h | 2 +- Core/HardParticle/FormFactorRipple1.cpp | 4 ++-- Core/HardParticle/FormFactorRipple1.h | 2 +- Core/HardParticle/FormFactorRipple2.cpp | 2 +- Core/HardParticle/FormFactorRipple2.h | 2 +- Core/HardParticle/FormFactorTruncatedSphere.cpp | 4 ++-- Core/HardParticle/FormFactorTruncatedSpheroid.cpp | 2 +- Core/Multilayer/IInterferenceFunctionStrategy.cpp | 2 +- Core/Particle/FormFactorCrystal.h | 2 +- Core/SoftParticle/FormFactorDebyeBueche.h | 2 +- Core/SoftParticle/FormFactorGauss.h | 2 +- Core/SoftParticle/FormFactorLorentz.h | 2 +- Core/SoftParticle/FormFactorOrnsteinZernike.h | 2 +- Core/StandardSamples/CylindersBuilder.h | 6 +++--- Core/StandardSamples/SampleBuilderFactory.cpp | 6 +++--- .../ex01_BasicParticles/AllFormFactorsAvailable.py | 4 ++-- .../python/simulation/ex01_BasicParticles/CylindersInBA.py | 2 +- .../simulation/ex01_BasicParticles/CylindersInDWBA.py | 2 +- .../ex04_ComplexShapes/LargeParticlesFormFactor.py | 2 +- Tests/Functional/Python/PyCore/parameterpool.py | 2 +- Tests/UnitTests/Core/Sample/ParticleTest.cpp | 2 +- Tests/UnitTests/GUI/TestComponentProxyModel.cpp | 2 +- Tests/UnitTests/GUI/TestParticleDistributionItem.cpp | 2 +- dev-tools/plot-ff/plotff.py | 6 +++--- dev-tools/plot-ff/plotpardep.py | 4 ++-- dev-tools/plot-ff/plotpardeppyramid.py | 4 ++-- 40 files changed, 53 insertions(+), 53 deletions(-) diff --git a/Core/DecoratedFormFactor/FormFactorDecoratorPositionFactor.h b/Core/DecoratedFormFactor/FormFactorDecoratorPositionFactor.h index 3c21e45c84a..38256e7b0ae 100644 --- a/Core/DecoratedFormFactor/FormFactorDecoratorPositionFactor.h +++ b/Core/DecoratedFormFactor/FormFactorDecoratorPositionFactor.h @@ -18,7 +18,7 @@ #include "IFormFactorDecorator.h" #include "Vectors3D.h" -//! Decorates a formfactor with a position dependent phase factor. +//! Decorates a form factor with a position dependent phase factor. //! @ingroup formfactors_internal class BA_CORE_API_ FormFactorDecoratorPositionFactor : public IFormFactorDecorator diff --git a/Core/DecoratedFormFactor/FormFactorDecoratorRotation.h b/Core/DecoratedFormFactor/FormFactorDecoratorRotation.h index 336d61621ab..9ff3fd66108 100644 --- a/Core/DecoratedFormFactor/FormFactorDecoratorRotation.h +++ b/Core/DecoratedFormFactor/FormFactorDecoratorRotation.h @@ -18,7 +18,7 @@ #include "IFormFactorDecorator.h" #include "Rotations.h" -//! Equips a formfactor with a rotation. +//! Equips a form factor with a rotation. //! @ingroup formfactors_internal class BA_CORE_API_ FormFactorDecoratorRotation : public IFormFactorDecorator diff --git a/Core/HardParticle/FormFactorCone.cpp b/Core/HardParticle/FormFactorCone.cpp index 83726f3feab..9863ba8d49c 100644 --- a/Core/HardParticle/FormFactorCone.cpp +++ b/Core/HardParticle/FormFactorCone.cpp @@ -51,7 +51,7 @@ FormFactorCone::FormFactorCone(double radius, double height, double alpha) onChange(); } -//! Integrand for complex formfactor. +//! Integrand for complex form factor. complex_t FormFactorCone::Integrand(double Z) const { double Rz = m_radius - Z * m_cot_alpha; diff --git a/Core/HardParticle/FormFactorHemiEllipsoid.cpp b/Core/HardParticle/FormFactorHemiEllipsoid.cpp index 4335bec97f2..cb4c9f45ce4 100644 --- a/Core/HardParticle/FormFactorHemiEllipsoid.cpp +++ b/Core/HardParticle/FormFactorHemiEllipsoid.cpp @@ -40,7 +40,7 @@ double FormFactorHemiEllipsoid::radialExtension() const return (m_radius_x + m_radius_y) / 2.0; } -//! Integrand for complex formfactor. +//! Integrand for complex form factor. complex_t FormFactorHemiEllipsoid::Integrand(double Z) const { double R = m_radius_x; diff --git a/Core/HardParticle/FormFactorLongBox.h b/Core/HardParticle/FormFactorLongBox.h index 2ad1204e8f3..089443bf070 100644 --- a/Core/HardParticle/FormFactorLongBox.h +++ b/Core/HardParticle/FormFactorLongBox.h @@ -17,7 +17,7 @@ #include "IFormFactorBorn.h" -//! The formfactor for a long rectangular box. +//! The form factor for a long rectangular box. //! Approximates the rapidly oscillating sinc function by the square root of a Lorentzian //! @ingroup legacyGrating diff --git a/Core/HardParticle/FormFactorLongBoxGauss.h b/Core/HardParticle/FormFactorLongBoxGauss.h index 24b193f8619..356da76ad4a 100644 --- a/Core/HardParticle/FormFactorLongBoxGauss.h +++ b/Core/HardParticle/FormFactorLongBoxGauss.h @@ -17,7 +17,7 @@ #include "IFormFactorBorn.h" -//! The formfactor for a long rectangular box. +//! The form factor for a long rectangular box. //! @ingroup legacyGrating class BA_CORE_API_ FormFactorLongBoxGauss : public IFormFactorBorn diff --git a/Core/HardParticle/FormFactorLongBoxLorentz.h b/Core/HardParticle/FormFactorLongBoxLorentz.h index 29401665ae5..1d621a6e939 100644 --- a/Core/HardParticle/FormFactorLongBoxLorentz.h +++ b/Core/HardParticle/FormFactorLongBoxLorentz.h @@ -17,7 +17,7 @@ #include "IFormFactorBorn.h" -//! The formfactor for a long rectangular box. +//! The form factor for a long rectangular box. //! @ingroup legacyGrating class BA_CORE_API_ FormFactorLongBoxLorentz : public IFormFactorBorn diff --git a/Core/HardParticle/FormFactorLongRipple1Gauss.cpp b/Core/HardParticle/FormFactorLongRipple1Gauss.cpp index 790def7cfa0..4c2288153b3 100644 --- a/Core/HardParticle/FormFactorLongRipple1Gauss.cpp +++ b/Core/HardParticle/FormFactorLongRipple1Gauss.cpp @@ -53,13 +53,13 @@ double FormFactorLongRipple1Gauss::radialExtension() const return (m_width + m_length) / 4.0; } -//! Integrand for complex formfactor. +//! Integrand for complex form factor. complex_t FormFactorLongRipple1Gauss::Integrand(double u) const { return sin(u) * exp(m_az * std::cos(u)) * (m_ay == 0. ? u : sin(m_ay * u) / m_ay); } -//! Complex formfactor. +//! Complex form factor. complex_t FormFactorLongRipple1Gauss::evaluate_for_q(cvector_t q) const { complex_t qxL2 = std::pow(m_length * q.x(), 2) / 2.0; diff --git a/Core/HardParticle/FormFactorLongRipple1Gauss.h b/Core/HardParticle/FormFactorLongRipple1Gauss.h index 84a03498702..d80ff7f32a0 100644 --- a/Core/HardParticle/FormFactorLongRipple1Gauss.h +++ b/Core/HardParticle/FormFactorLongRipple1Gauss.h @@ -18,7 +18,7 @@ #include "IFormFactorBorn.h" #include "IntegratorComplex.h" -//! The formfactor for a cosine ripple. +//! The form factor for a cosine ripple. //! @ingroup legacyGrating class BA_CORE_API_ FormFactorLongRipple1Gauss : public IFormFactorBorn diff --git a/Core/HardParticle/FormFactorLongRipple1Lorentz.cpp b/Core/HardParticle/FormFactorLongRipple1Lorentz.cpp index cb838305c77..75603b2962f 100644 --- a/Core/HardParticle/FormFactorLongRipple1Lorentz.cpp +++ b/Core/HardParticle/FormFactorLongRipple1Lorentz.cpp @@ -53,13 +53,13 @@ double FormFactorLongRipple1Lorentz::radialExtension() const return (m_width + m_length) / 4.0; } -//! Integrand for complex formfactor. +//! Integrand for complex form factor. complex_t FormFactorLongRipple1Lorentz::Integrand(double u) const { return sin(u) * exp(m_az * std::cos(u)) * (m_ay == 0. ? u : sin(m_ay * u) / m_ay); } -//! Complex formfactor. +//! Complex form factor. complex_t FormFactorLongRipple1Lorentz::evaluate_for_q(cvector_t q) const { complex_t qxL2 = 2.5 * std::pow(m_length * q.x(), 2); diff --git a/Core/HardParticle/FormFactorLongRipple1Lorentz.h b/Core/HardParticle/FormFactorLongRipple1Lorentz.h index 02a4aea217a..c46adcdccfb 100644 --- a/Core/HardParticle/FormFactorLongRipple1Lorentz.h +++ b/Core/HardParticle/FormFactorLongRipple1Lorentz.h @@ -18,7 +18,7 @@ #include "IFormFactorBorn.h" #include "IntegratorComplex.h" -//! The formfactor for a cosine ripple. +//! The form factor for a cosine ripple. //! @ingroup legacyGrating class BA_CORE_API_ FormFactorLongRipple1Lorentz : public IFormFactorBorn diff --git a/Core/HardParticle/FormFactorLongRipple2Gauss.cpp b/Core/HardParticle/FormFactorLongRipple2Gauss.cpp index c5d19f93538..f17399b9906 100644 --- a/Core/HardParticle/FormFactorLongRipple2Gauss.cpp +++ b/Core/HardParticle/FormFactorLongRipple2Gauss.cpp @@ -66,7 +66,7 @@ double FormFactorLongRipple2Gauss::radialExtension() const return (m_width + m_length) / 4.0; } -//! Complex formfactor. +//! Complex form factor. complex_t FormFactorLongRipple2Gauss::evaluate_for_q(cvector_t q) const { m_q = q; diff --git a/Core/HardParticle/FormFactorLongRipple2Gauss.h b/Core/HardParticle/FormFactorLongRipple2Gauss.h index c88de5eb3a7..4c6f15fe805 100644 --- a/Core/HardParticle/FormFactorLongRipple2Gauss.h +++ b/Core/HardParticle/FormFactorLongRipple2Gauss.h @@ -17,7 +17,7 @@ #include "IFormFactorBorn.h" -//! The formfactor for a triangular ripple. +//! The form factor for a triangular ripple. //! @ingroup legacyGrating class BA_CORE_API_ FormFactorLongRipple2Gauss : public IFormFactorBorn diff --git a/Core/HardParticle/FormFactorLongRipple2Lorentz.cpp b/Core/HardParticle/FormFactorLongRipple2Lorentz.cpp index 3e07c1b9317..2addea46b0e 100644 --- a/Core/HardParticle/FormFactorLongRipple2Lorentz.cpp +++ b/Core/HardParticle/FormFactorLongRipple2Lorentz.cpp @@ -69,7 +69,7 @@ double FormFactorLongRipple2Lorentz::radialExtension() const return (m_width + m_length) / 4.0; } -//! Complex formfactor. +//! Complex form factor. complex_t FormFactorLongRipple2Lorentz::evaluate_for_q(cvector_t q) const { check_parameters(); diff --git a/Core/HardParticle/FormFactorLongRipple2Lorentz.h b/Core/HardParticle/FormFactorLongRipple2Lorentz.h index f73ffb2b199..b70cd166550 100644 --- a/Core/HardParticle/FormFactorLongRipple2Lorentz.h +++ b/Core/HardParticle/FormFactorLongRipple2Lorentz.h @@ -17,7 +17,7 @@ #include "IFormFactorBorn.h" -//! The formfactor for a triangular ripple. +//! The form factor for a triangular ripple. //! @ingroup legacyGrating class BA_CORE_API_ FormFactorLongRipple2Lorentz : public IFormFactorBorn diff --git a/Core/HardParticle/FormFactorRipple1.cpp b/Core/HardParticle/FormFactorRipple1.cpp index 3246a0a1817..e71b2da22bb 100644 --- a/Core/HardParticle/FormFactorRipple1.cpp +++ b/Core/HardParticle/FormFactorRipple1.cpp @@ -57,13 +57,13 @@ double FormFactorRipple1::radialExtension() const return (m_width + m_length) / 4.0; } -//! Integrand for complex formfactor. +//! Integrand for complex form factor. complex_t FormFactorRipple1::Integrand(double u) const { return sin(u) * exp(m_az * std::cos(u)) * (m_ay == 0. ? u : sin(m_ay * u) / m_ay); } -//! Complex formfactor. +//! Complex form factor. complex_t FormFactorRipple1::evaluate_for_q(cvector_t q) const { complex_t factor = m_length * MathFunctions::sinc(q.x() * m_length * 0.5) * m_width / M_PI; diff --git a/Core/HardParticle/FormFactorRipple1.h b/Core/HardParticle/FormFactorRipple1.h index 8ed565a067d..faddc554a38 100644 --- a/Core/HardParticle/FormFactorRipple1.h +++ b/Core/HardParticle/FormFactorRipple1.h @@ -18,7 +18,7 @@ #include "IFormFactorBorn.h" #include "IntegratorComplex.h" -//! The formfactor for a cosine ripple. +//! The form factor for a cosine ripple. //! @ingroup legacyGrating class BA_CORE_API_ FormFactorRipple1 : public IFormFactorBorn diff --git a/Core/HardParticle/FormFactorRipple2.cpp b/Core/HardParticle/FormFactorRipple2.cpp index 91c569e6474..50a70d831c4 100644 --- a/Core/HardParticle/FormFactorRipple2.cpp +++ b/Core/HardParticle/FormFactorRipple2.cpp @@ -41,7 +41,7 @@ double FormFactorRipple2::radialExtension() const return (m_width + m_length) / 4.0; } -//! Complex formfactor. +//! Complex form factor. complex_t FormFactorRipple2::evaluate_for_q(cvector_t q) const { complex_t factor = m_length * MathFunctions::sinc(q.x() * m_length / 2.) * m_height * m_width; diff --git a/Core/HardParticle/FormFactorRipple2.h b/Core/HardParticle/FormFactorRipple2.h index 86cb37110df..6d0ba036863 100644 --- a/Core/HardParticle/FormFactorRipple2.h +++ b/Core/HardParticle/FormFactorRipple2.h @@ -17,7 +17,7 @@ #include "IFormFactorBorn.h" -//! The formfactor for a triangular ripple. +//! The form factor for a triangular ripple. //! @ingroup legacyGrating class BA_CORE_API_ FormFactorRipple2 : public IFormFactorBorn diff --git a/Core/HardParticle/FormFactorTruncatedSphere.cpp b/Core/HardParticle/FormFactorTruncatedSphere.cpp index 5feb6439120..7edb0a4d5f3 100644 --- a/Core/HardParticle/FormFactorTruncatedSphere.cpp +++ b/Core/HardParticle/FormFactorTruncatedSphere.cpp @@ -52,7 +52,7 @@ bool FormFactorTruncatedSphere::check_initialization() const return result; } -//! Integrand for complex formfactor. +//! Integrand for complex form factor. complex_t FormFactorTruncatedSphere::Integrand(double Z) const { double Rz = std::sqrt(m_radius * m_radius - Z * Z); @@ -62,7 +62,7 @@ complex_t FormFactorTruncatedSphere::Integrand(double Z) const return Rz * Rz * MathFunctions::Bessel_J1c(q_p * Rz) * exp_I(m_q.z() * Z); } -//! Complex formfactor. +//! Complex form factor. complex_t FormFactorTruncatedSphere::evaluate_for_q(cvector_t q) const { m_q = q; diff --git a/Core/HardParticle/FormFactorTruncatedSpheroid.cpp b/Core/HardParticle/FormFactorTruncatedSpheroid.cpp index 0c5ee9f4e75..d2f64fc8ea3 100644 --- a/Core/HardParticle/FormFactorTruncatedSpheroid.cpp +++ b/Core/HardParticle/FormFactorTruncatedSpheroid.cpp @@ -55,7 +55,7 @@ bool FormFactorTruncatedSpheroid::check_initialization() const return result; } -//! Integrand for complex formfactor. +//! Integrand for complex form factor. complex_t FormFactorTruncatedSpheroid::Integrand(double Z) const { double R = m_radius; diff --git a/Core/Multilayer/IInterferenceFunctionStrategy.cpp b/Core/Multilayer/IInterferenceFunctionStrategy.cpp index c1a4c44143e..ed192fb4fad 100644 --- a/Core/Multilayer/IInterferenceFunctionStrategy.cpp +++ b/Core/Multilayer/IInterferenceFunctionStrategy.cpp @@ -35,7 +35,7 @@ void IInterferenceFunctionStrategy::init( { if (weighted_formfactors.size() == 0) throw Exceptions::ClassInitializationException( - "IInterferenceFunctionStrategy::init: strategy gets no formfactors."); + "IInterferenceFunctionStrategy::init: strategy gets no form factors."); m_formfactor_wrappers = weighted_formfactors; if (p_iff) mP_iff.reset(p_iff->clone()); diff --git a/Core/Particle/FormFactorCrystal.h b/Core/Particle/FormFactorCrystal.h index 9ac0967c877..b4b36a4ef88 100644 --- a/Core/Particle/FormFactorCrystal.h +++ b/Core/Particle/FormFactorCrystal.h @@ -18,7 +18,7 @@ #include "IFormFactorBorn.h" #include "Lattice.h" -//! The formfactor of a MesoCrystal. +//! The form factor of a MesoCrystal. //! @ingroup formfactors class BA_CORE_API_ FormFactorCrystal : public IFormFactor diff --git a/Core/SoftParticle/FormFactorDebyeBueche.h b/Core/SoftParticle/FormFactorDebyeBueche.h index dd3fe405a05..4ac5c24caec 100644 --- a/Core/SoftParticle/FormFactorDebyeBueche.h +++ b/Core/SoftParticle/FormFactorDebyeBueche.h @@ -17,7 +17,7 @@ #include "IFormFactorBorn.h" -//! The formfactor of a Debye-Bueche (see doi:10.1038/pj.2010.110). +//! The form factor of a Debye-Bueche (see doi:10.1038/pj.2010.110). //! @ingroup softParticle class BA_CORE_API_ FormFactorDebyeBueche : public IFormFactorBorn diff --git a/Core/SoftParticle/FormFactorGauss.h b/Core/SoftParticle/FormFactorGauss.h index d38ee47e34c..e26e0343393 100644 --- a/Core/SoftParticle/FormFactorGauss.h +++ b/Core/SoftParticle/FormFactorGauss.h @@ -17,7 +17,7 @@ #include "IFormFactorBorn.h" -//! The formfactor of a gaussian. +//! The form factor of a gaussian. //! @ingroup softParticle class BA_CORE_API_ FormFactorGauss : public IFormFactorBorn diff --git a/Core/SoftParticle/FormFactorLorentz.h b/Core/SoftParticle/FormFactorLorentz.h index 7a9ab73f9ec..62ea554a634 100644 --- a/Core/SoftParticle/FormFactorLorentz.h +++ b/Core/SoftParticle/FormFactorLorentz.h @@ -17,7 +17,7 @@ #include "IFormFactorBorn.h" -//! The formfactor of a lorentzian. +//! The form factor of a lorentzian. //! @ingroup softParticle class BA_CORE_API_ FormFactorLorentz : public IFormFactorBorn diff --git a/Core/SoftParticle/FormFactorOrnsteinZernike.h b/Core/SoftParticle/FormFactorOrnsteinZernike.h index 934e2af88ec..513348d325e 100644 --- a/Core/SoftParticle/FormFactorOrnsteinZernike.h +++ b/Core/SoftParticle/FormFactorOrnsteinZernike.h @@ -17,7 +17,7 @@ #include "IFormFactorBorn.h" -//! The formfactor of a Ornstein-Zernike (see doi:10.1038/pj.2010.110). +//! The form factor of a Ornstein-Zernike (see doi:10.1038/pj.2010.110). //! @ingroup softParticle class BA_CORE_API_ FormFactorOrnsteinZernike : public IFormFactorBorn diff --git a/Core/StandardSamples/CylindersBuilder.h b/Core/StandardSamples/CylindersBuilder.h index 22dac4f280b..cc10a892a73 100644 --- a/Core/StandardSamples/CylindersBuilder.h +++ b/Core/StandardSamples/CylindersBuilder.h @@ -19,7 +19,7 @@ class ISample; -//! Builds sample: cylinder formfactor in DWBA (IsGISAXS example #3, part I). +//! Builds sample: cylinder form factor in DWBA (IsGISAXS example #3, part I). //! @ingroup standard_samples class BA_CORE_API_ CylindersInDWBABuilder : public IMultiLayerBuilder @@ -33,7 +33,7 @@ private: double m_radius; }; -//! Builds sample: cylinder formfactor in BA (IsGISAXS example #3, part II). +//! Builds sample: cylinder form factor in BA (IsGISAXS example #3, part II). //! @ingroup standard_samples class BA_CORE_API_ CylindersInBABuilder : public IMultiLayerBuilder @@ -61,7 +61,7 @@ private: double m_radius; }; -//! Builds sample: cylinder formfactor in DWBA (IsGISAXS example #3, part I). +//! Builds sample: cylinder form factor in DWBA (IsGISAXS example #3, part I). //! @ingroup standard_samples class BA_CORE_API_ RotatedCylindersBuilder : public IMultiLayerBuilder diff --git a/Core/StandardSamples/SampleBuilderFactory.cpp b/Core/StandardSamples/SampleBuilderFactory.cpp index c1e4612c511..9959bc3c37b 100644 --- a/Core/StandardSamples/SampleBuilderFactory.cpp +++ b/Core/StandardSamples/SampleBuilderFactory.cpp @@ -57,15 +57,15 @@ SampleBuilderFactory::SampleBuilderFactory() "Mixture of cylinder particles with two types size distribution "); registerItem("CylindersInBABuilder", create_new<CylindersInBABuilder>, - "Cylinder formfactor in BA"); + "Cylinder form factor in BA"); registerItem("CylindersInDWBABuilder", create_new<CylindersInDWBABuilder>, - "Cylinder formfactor in DWBA"); + "Cylinder form factor in DWBA"); registerItem("LargeCylindersInDWBABuilder", create_new<LargeCylindersInDWBABuilder>, "Large cylinders in DWBA"); registerItem("CylindersWithSizeDistributionBuilder", create_new<CylindersWithSizeDistributionBuilder>, - "Cylinder formfactor in BA with size distribution"); + "Cylinder form factor in BA with size distribution"); registerItem("RadialParaCrystalBuilder", create_new<RadialParaCrystalBuilder>, "Interference function of radial paracrystal"); diff --git a/Examples/python/simulation/ex01_BasicParticles/AllFormFactorsAvailable.py b/Examples/python/simulation/ex01_BasicParticles/AllFormFactorsAvailable.py index 2e63be4b7b2..426e01b60ab 100644 --- a/Examples/python/simulation/ex01_BasicParticles/AllFormFactorsAvailable.py +++ b/Examples/python/simulation/ex01_BasicParticles/AllFormFactorsAvailable.py @@ -1,5 +1,5 @@ """ -All formfactors available in BornAgain in the Born Approximation +All form factors available in BornAgain in the Born Approximation """ import numpy import bornagain as ba @@ -97,7 +97,7 @@ def run_simulation(): plt.subplot(5, 5, nplot+1) plt.subplots_adjust(wspace=0.3, hspace=0.3) - ba.plot_colormap(result, xlabel="", ylabel="", zlabel="", + ba.plot_colormap(result, xlabel="", ylabel="", zlabel="", cmap='jet', aspect='auto') plt.tick_params(axis='both', which='major', labelsize=8) diff --git a/Examples/python/simulation/ex01_BasicParticles/CylindersInBA.py b/Examples/python/simulation/ex01_BasicParticles/CylindersInBA.py index 5584895c482..c68006c4e2a 100644 --- a/Examples/python/simulation/ex01_BasicParticles/CylindersInBA.py +++ b/Examples/python/simulation/ex01_BasicParticles/CylindersInBA.py @@ -1,5 +1,5 @@ """ -Cylinder formfactor in Born approximation +Cylinder form factor in Born approximation """ import bornagain as ba from bornagain import deg, angstrom, nm diff --git a/Examples/python/simulation/ex01_BasicParticles/CylindersInDWBA.py b/Examples/python/simulation/ex01_BasicParticles/CylindersInDWBA.py index 8fd996efe55..ba8678ec828 100644 --- a/Examples/python/simulation/ex01_BasicParticles/CylindersInDWBA.py +++ b/Examples/python/simulation/ex01_BasicParticles/CylindersInDWBA.py @@ -1,5 +1,5 @@ """ -Cylinder formfactor in DWBA +Cylinder form factor in DWBA """ import bornagain as ba from bornagain import deg, angstrom, nm diff --git a/Examples/python/simulation/ex04_ComplexShapes/LargeParticlesFormFactor.py b/Examples/python/simulation/ex04_ComplexShapes/LargeParticlesFormFactor.py index 6c332c36a76..5915af6ffc2 100644 --- a/Examples/python/simulation/ex04_ComplexShapes/LargeParticlesFormFactor.py +++ b/Examples/python/simulation/ex04_ComplexShapes/LargeParticlesFormFactor.py @@ -1,7 +1,7 @@ """ Large cylinders in DWBA. -This example demonstrates that for large particles (~1000nm) the formfactor +This example demonstrates that for large particles (~1000nm) the form factor oscillates rapidly within one detector bin and analytical calculations (performed for the bin center) give completely wrong intensity pattern. In this case Monte-Carlo integration over detector bin should be used. diff --git a/Tests/Functional/Python/PyCore/parameterpool.py b/Tests/Functional/Python/PyCore/parameterpool.py index 37b52af3dc1..a94aab773d4 100644 --- a/Tests/Functional/Python/PyCore/parameterpool.py +++ b/Tests/Functional/Python/PyCore/parameterpool.py @@ -50,7 +50,7 @@ class ParameterPoolTest(unittest.TestCase): def test_parameterTreeAccess(self): """ Checks values in particle's parameter tree. Parameter tree is a pool with parameters of - particle and its children (in given case, formfactor of cylinder) + particle and its children (in given case, form factor of cylinder) """ ff = ba.FormFactorCylinder(5*nm, 6*nm) particle = ba.Particle(ba.HomogeneousMaterial("Air", 0.0, 0.0), ff) diff --git a/Tests/UnitTests/Core/Sample/ParticleTest.cpp b/Tests/UnitTests/Core/Sample/ParticleTest.cpp index 0965a42bd5c..72c1d292483 100644 --- a/Tests/UnitTests/Core/Sample/ParticleTest.cpp +++ b/Tests/UnitTests/Core/Sample/ParticleTest.cpp @@ -45,7 +45,7 @@ TEST_F(ParticleTest, Constructors) EXPECT_EQ(nullptr, p1->createFormFactor()); EXPECT_EQ(nullptr, p1->rotation()); - // construction with formfactor + // construction with form factor std::unique_ptr<Particle> p2(new Particle(mat, sphere)); EXPECT_EQ(mat, *p2->material()); EXPECT_TRUE(dynamic_cast<FormFactorDecoratorMaterial*>(p2->createFormFactor())); diff --git a/Tests/UnitTests/GUI/TestComponentProxyModel.cpp b/Tests/UnitTests/GUI/TestComponentProxyModel.cpp index c0a3843c573..70dbb2335bd 100644 --- a/Tests/UnitTests/GUI/TestComponentProxyModel.cpp +++ b/Tests/UnitTests/GUI/TestComponentProxyModel.cpp @@ -283,7 +283,7 @@ TEST_F(TestComponentProxyModel, test_componentStrategy) } //! Checking the mapping of ComponentProxyStrategy in the case of ParticleItem inserted in -//! the source. We are changing Particle's formfactor back and forth and checking for change +//! the source. We are changing Particle's form factor back and forth and checking for change //! in GroupProperty. TEST_F(TestComponentProxyModel, test_componentStrategyFormFactorChanges) diff --git a/Tests/UnitTests/GUI/TestParticleDistributionItem.cpp b/Tests/UnitTests/GUI/TestParticleDistributionItem.cpp index f5bb27ead7a..3212aab11f0 100644 --- a/Tests/UnitTests/GUI/TestParticleDistributionItem.cpp +++ b/Tests/UnitTests/GUI/TestParticleDistributionItem.cpp @@ -96,7 +96,7 @@ TEST_F(TestParticleDistributionItem, test_AddParticle) EXPECT_EQ(prop.getValues(), expectedLinked); EXPECT_EQ(prop.getValue(), ""); - // changing formfactor of the particle + // changing form factor of the particle particle->setGroupProperty(ParticleItem::P_FORM_FACTOR, Constants::BoxType); prop = dist->getItemValue(ParticleDistributionItem::P_DISTRIBUTED_PARAMETER) diff --git a/dev-tools/plot-ff/plotff.py b/dev-tools/plot-ff/plotff.py index d8392424dd8..bb50b79f06f 100644 --- a/dev-tools/plot-ff/plotff.py +++ b/dev-tools/plot-ff/plotff.py @@ -1,18 +1,18 @@ -# script to plot the formfactor +# script to plot the form factor # after the ROOT window with plots appear, # just save the picture in that format which you need import ROOT from libBornAgainCore import * -# define a formfactor, I recommend a 10--20 nm diameter +# define a form factor, I recommend a 10--20 nm diameter #ff = FormFactorFullSphere(10.0*nanometer) #ff = FormFactorSphere(10.0*nanometer, 13.0*nanometer) ff = FormFactorPyramid(13*nanometer, 10.0*nanometer, 60*degree) # volume -# I suggest, that the formfactor evaluated for q=0 gives the volume +# I suggest, that the form factor evaluated for q=0 gives the volume # please correct if not zero = cvector_t(0,0,0) V = abs(ff.evaluate_for_q(zero)) diff --git a/dev-tools/plot-ff/plotpardep.py b/dev-tools/plot-ff/plotpardep.py index 2fb0a595e45..784864bda20 100644 --- a/dev-tools/plot-ff/plotpardep.py +++ b/dev-tools/plot-ff/plotpardep.py @@ -1,11 +1,11 @@ -# script to plot the formfactor +# script to plot the form factor # after the ROOT window with plots appear, # just save the picture in that format which you need import ROOT from libBornAgainCore import * -# define a formfactor, I recommend a 10--20 nm diameter +# define a form factor, I recommend a 10--20 nm diameter #ff = FormFactorFullSphere(10.0*nanometer) ff05 = FormFactorSphere(10.0*nanometer, 5.0*nanometer) ff10 = FormFactorSphere(10.0*nanometer, 10.0*nanometer) diff --git a/dev-tools/plot-ff/plotpardeppyramid.py b/dev-tools/plot-ff/plotpardeppyramid.py index b695664bb69..bcc91437e47 100644 --- a/dev-tools/plot-ff/plotpardeppyramid.py +++ b/dev-tools/plot-ff/plotpardeppyramid.py @@ -1,11 +1,11 @@ -# script to plot the formfactor +# script to plot the form factor # after the ROOT window with plots appear, # just save the picture in that format which you need import ROOT from libBornAgainCore import * -# define a formfactor, I recommend a 10--20 nm diameter +# define a form factor, I recommend a 10--20 nm diameter # vary H ff05 = FormFactorPyramid(2.5*nanometer, 5.0*nanometer, 60*degree) ff10 = FormFactorPyramid(5.0*nanometer, 5.0*nanometer, 60*degree) -- GitLab