From 9453ebfee9bd73721857106d6bc4fcf036b83582 Mon Sep 17 00:00:00 2001
From: "Joachim Wuttke (o)" <j.wuttke@fz-juelich.de>
Date: Tue, 1 Sep 2020 12:44:09 +0200
Subject: [PATCH] rm return types (circular use of decltype) from
BasicVector3D; run ALLCONFIG
---
Core/Vector/BasicVector3D.cpp | 2 +-
Core/Vector/BasicVector3D.h | 19 +-
auto/Wrap/doxygen_core.i | 2258 ++++++++++++---------------
auto/Wrap/libBornAgainCore.py | 848 ++++------
auto/Wrap/libBornAgainCore_wrap.cpp | 771 +++------
5 files changed, 1553 insertions(+), 2345 deletions(-)
diff --git a/Core/Vector/BasicVector3D.cpp b/Core/Vector/BasicVector3D.cpp
index 1e7d7ab00d1..cf42c4fc035 100644
--- a/Core/Vector/BasicVector3D.cpp
+++ b/Core/Vector/BasicVector3D.cpp
@@ -3,7 +3,7 @@
// BornAgain: simulate and fit scattering at grazing incidence
//
//! @file Core/Vector/BasicVector3D.cpp
-//! @brief Implements template class BasicVector3D.
+//! @brief Implements type-specific functions from template class BasicVector3D.
//!
//! @homepage http://www.bornagainproject.org
//! @license GNU General Public License v3 or higher (see COPYING)
diff --git a/Core/Vector/BasicVector3D.h b/Core/Vector/BasicVector3D.h
index bc8f846593a..65c04858fd6 100644
--- a/Core/Vector/BasicVector3D.h
+++ b/Core/Vector/BasicVector3D.h
@@ -3,7 +3,7 @@
// BornAgain: simulate and fit scattering at grazing incidence
//
//! @file Core/Vector/BasicVector3D.h
-//! @brief Declares template class BasicVector3D.
+//! @brief Declares and partly implements template class BasicVector3D.
//!
//! @homepage http://www.bornagainproject.org
//! @license GNU General Public License v3 or higher (see COPYING)
@@ -16,7 +16,7 @@
#define BORNAGAIN_CORE_VECTOR_BASICVECTOR3D_H
//! Forked from CLHEP/Geometry by E. Chernyaev <Evgueni.Tcherniaev@cern.ch>,
-//! then reworked beyond recongnition. Removed split of point and vector semantics.
+//! then reworked beyond recognition. Removed split of point and vector semantics.
//! Transforms are relegated to a separate class Transform3D.
#include "Wrap/WinDllMacros.h"
@@ -99,7 +99,7 @@ public:
//! Multiplies this with a scalar, and returns result.
#ifndef SWIG
- template <class U> auto operator*=(U a) -> BasicVector3D<decltype(this->x() * a)>&
+ template <class U> auto operator*=(U a)
{
v_[0] *= a;
v_[1] *= a;
@@ -110,7 +110,7 @@ public:
//! Divides this by a scalar, and returns result.
#ifndef SWIG
- template <class U> auto operator/=(U a) -> BasicVector3D<decltype(this->x() * a)>&
+ template <class U> auto operator/=(U a)
{
v_[0] /= a;
v_[1] /= a;
@@ -165,13 +165,13 @@ public:
//! Returns dot product of vectors (antilinear in the first [=self] argument).
#ifndef SWIG
- template <class U> auto dot(const BasicVector3D<U>& v) const -> decltype(this->x() * v.x());
+ template <class U> auto dot(const BasicVector3D<U>& v) const;
#endif // SWIG
//! Returns cross product of vectors (linear in both arguments).
#ifndef SWIG
template <class U>
- auto cross(const BasicVector3D<U>& v) const -> BasicVector3D<decltype(this->x() * v.x())>;
+ auto cross(const BasicVector3D<U>& v) const;
#endif // SWIG
//! Returns angle with respect to another vector.
@@ -253,7 +253,7 @@ inline BasicVector3D<T> operator-(const BasicVector3D<T>& a, const BasicVector3D
//! @relates BasicVector3D
#ifndef SWIG
template <class T, class U>
-inline auto operator*(const BasicVector3D<T>& v, const U a) -> BasicVector3D<decltype(v.x() * a)>
+inline auto operator*(const BasicVector3D<T>& v, const U a)
{
return BasicVector3D<decltype(v.x() * a)>(v.x() * a, v.y() * a, v.z() * a);
}
@@ -263,7 +263,7 @@ inline auto operator*(const BasicVector3D<T>& v, const U a) -> BasicVector3D<dec
//! @relates BasicVector3D
#ifndef SWIG
template <class T, class U>
-inline auto operator*(const U a, const BasicVector3D<T>& v) -> BasicVector3D<decltype(a * v.x())>
+inline auto operator*(const U a, const BasicVector3D<T>& v)
{
return BasicVector3D<decltype(a * v.x())>(a * v.x(), a * v.y(), a * v.z());
}
@@ -311,7 +311,7 @@ BA_CORE_API_ BasicVector3D<double> vecOfLambdaAlphaPhi(double _lambda, double _a
#ifndef SWIG
template <class T>
template <class U>
-inline auto BasicVector3D<T>::dot(const BasicVector3D<U>& v) const -> decltype(this->x() * v.x())
+inline auto BasicVector3D<T>::dot(const BasicVector3D<U>& v) const
{
BasicVector3D<T> left_star = this->conj();
return left_star.x() * v.x() + left_star.y() * v.y() + left_star.z() * v.z();
@@ -323,7 +323,6 @@ inline auto BasicVector3D<T>::dot(const BasicVector3D<U>& v) const -> decltype(t
template <class T>
template <class U>
inline auto BasicVector3D<T>::cross(const BasicVector3D<U>& v) const
- -> BasicVector3D<decltype(this->x() * v.x())>
{
return BasicVector3D<decltype(this->x() * v.x())>(
y() * v.z() - v.y() * z(), z() * v.x() - v.z() * x(), x() * v.y() - v.x() * y());
diff --git a/auto/Wrap/doxygen_core.i b/auto/Wrap/doxygen_core.i
index a1ce1cf0034..44d390cef7d 100644
--- a/auto/Wrap/doxygen_core.i
+++ b/auto/Wrap/doxygen_core.i
@@ -236,7 +236,7 @@ Returns ( $ \\\\pi/\\\\lambda^2 $ - sld), sld being the scattering length densi
Returns ( $ \\\\pi/\\\\lambda^2 $ - sld) matrix with magnetization corrections.
";
-%feature("docstring") BaseMaterialImpl::transformedMaterial "virtual BaseMaterialImpl* BaseMaterialImpl::transformedMaterial(const Transform3D &transform) const =0
+%feature("docstring") BaseMaterialImpl::rotatedMaterial "virtual BaseMaterialImpl* BaseMaterialImpl::rotatedMaterial(const Transform3D &transform) const =0
";
%feature("docstring") BaseMaterialImpl::print "virtual void BaseMaterialImpl::print(std::ostream &ostr) const =0
@@ -285,14 +285,11 @@ C++ includes: ParaCrystalBuilder.h
%feature("docstring") Basic2DParaCrystalBuilder::createSample "MultiLayer * Basic2DParaCrystalBuilder::createSample(size_t index=0)
";
-%feature("docstring") Basic2DParaCrystalBuilder::size "size_t Basic2DParaCrystalBuilder::size()
-";
-
// File: classBasicLattice.xml
%feature("docstring") BasicLattice "";
-%feature("docstring") BasicLattice::BasicLattice "BasicLattice::BasicLattice(double length1, double length2, double angle, double rotation_angle=0.0)
+%feature("docstring") BasicLattice::BasicLattice "BasicLattice::BasicLattice(double length1, double length2, double angle, double xi)
";
%feature("docstring") BasicLattice::clone "BasicLattice * BasicLattice::clone() const
@@ -319,7 +316,7 @@ Calls the INodeVisitor's visit method.
// File: classBasicVector3D.xml
%feature("docstring") BasicVector3D "
-Forked from CLHEP/Geometry by E. Chernyaev Evgueni.Tcherniaev@cern.ch, then reworked beyond recongnition. Removed split of point and vector semantics. Transforms are relegated to a separate class Transform3D. Three-dimensional vector template, for use with integer, double, or complex components.
+Forked from CLHEP/Geometry by E. Chernyaev Evgueni.Tcherniaev@cern.ch, then reworked beyond recognition. Removed split of point and vector semantics. Transforms are relegated to a separate class Transform3D. Three-dimensional vector template, for use with integer, double, or complex components.
C++ includes: BasicVector3D.h
";
@@ -424,14 +421,14 @@ Returns this, trivially converted to complex type.
Returns real parts.
";
-%feature("docstring") BasicVector3D::dot "auto BasicVector3D< T >::dot(const BasicVector3D< U > &v) const -> decltype(this->x() *v.x())
+%feature("docstring") BasicVector3D::dot "auto BasicVector3D< T >::dot(const BasicVector3D< U > &v) const
Returns dot product of vectors (antilinear in the first [=self] argument).
Returns dot product of (complex) vectors (antilinear in the first [=self] argument).
";
-%feature("docstring") BasicVector3D::cross "auto BasicVector3D< T >::cross(const BasicVector3D< U > &v) const -> BasicVector3D< decltype(this->x() *v.x())>
+%feature("docstring") BasicVector3D::cross "auto BasicVector3D< T >::cross(const BasicVector3D< U > &v) const
Returns cross product of vectors (linear in both arguments).
@@ -486,7 +483,7 @@ Beam defined by wavelength, direction and intensity.
C++ includes: Beam.h
";
-%feature("docstring") Beam::Beam "Beam::Beam()
+%feature("docstring") Beam::Beam "Beam::Beam(double wavelength, double alpha, double phi, double intensity)
";
%feature("docstring") Beam::Beam "Beam::Beam(const Beam &other)
@@ -933,10 +930,10 @@ Class representing a constant background signal
C++ includes: ConstantBackground.h
";
-%feature("docstring") ConstantBackground::ConstantBackground "ConstantBackground::ConstantBackground(double background_value)
+%feature("docstring") ConstantBackground::ConstantBackground "ConstantBackground::ConstantBackground(const std::vector< double > P)
";
-%feature("docstring") ConstantBackground::~ConstantBackground "ConstantBackground::~ConstantBackground()
+%feature("docstring") ConstantBackground::ConstantBackground "ConstantBackground::ConstantBackground(double background_value)
";
%feature("docstring") ConstantBackground::clone "ConstantBackground * ConstantBackground::clone() const override final
@@ -1549,13 +1546,16 @@ Detector properties (efficiency, transmission).
C++ includes: DetectionProperties.h
";
+%feature("docstring") DetectionProperties::DetectionProperties "DetectionProperties::DetectionProperties(kvector_t direction, double efficiency, double total_transmission)
+";
+
%feature("docstring") DetectionProperties::DetectionProperties "DetectionProperties::DetectionProperties()
";
%feature("docstring") DetectionProperties::DetectionProperties "DetectionProperties::DetectionProperties(const DetectionProperties &other)
";
-%feature("docstring") DetectionProperties::~DetectionProperties "DetectionProperties::~DetectionProperties()
+%feature("docstring") DetectionProperties::~DetectionProperties "virtual DetectionProperties::~DetectionProperties()=default
";
%feature("docstring") DetectionProperties::setAnalyzerProperties "void DetectionProperties::setAnalyzerProperties(const kvector_t direction, double efficiency, double total_transmission)
@@ -1776,13 +1776,13 @@ Cosine distribution.
C++ includes: Distributions.h
";
-%feature("docstring") DistributionCosine::DistributionCosine "DistributionCosine::DistributionCosine()
+%feature("docstring") DistributionCosine::DistributionCosine "DistributionCosine::DistributionCosine(const std::vector< double > P)
";
%feature("docstring") DistributionCosine::DistributionCosine "DistributionCosine::DistributionCosine(double mean, double sigma)
";
-%feature("docstring") DistributionCosine::~DistributionCosine "virtual DistributionCosine::~DistributionCosine()
+%feature("docstring") DistributionCosine::DistributionCosine "DistributionCosine::DistributionCosine()
";
%feature("docstring") DistributionCosine::clone "DistributionCosine* DistributionCosine::clone() const final
@@ -1825,13 +1825,13 @@ Uniform distribution function with half width hwhm.
C++ includes: Distributions.h
";
-%feature("docstring") DistributionGate::DistributionGate "DistributionGate::DistributionGate()
+%feature("docstring") DistributionGate::DistributionGate "DistributionGate::DistributionGate(const std::vector< double > P)
";
%feature("docstring") DistributionGate::DistributionGate "DistributionGate::DistributionGate(double min, double max)
";
-%feature("docstring") DistributionGate::~DistributionGate "virtual DistributionGate::~DistributionGate()
+%feature("docstring") DistributionGate::DistributionGate "DistributionGate::DistributionGate()
";
%feature("docstring") DistributionGate::clone "DistributionGate* DistributionGate::clone() const final
@@ -1877,13 +1877,13 @@ Gaussian distribution with standard deviation std_dev.
C++ includes: Distributions.h
";
-%feature("docstring") DistributionGaussian::DistributionGaussian "DistributionGaussian::DistributionGaussian()
+%feature("docstring") DistributionGaussian::DistributionGaussian "DistributionGaussian::DistributionGaussian(const std::vector< double > P)
";
%feature("docstring") DistributionGaussian::DistributionGaussian "DistributionGaussian::DistributionGaussian(double mean, double std_dev)
";
-%feature("docstring") DistributionGaussian::~DistributionGaussian "virtual DistributionGaussian::~DistributionGaussian()
+%feature("docstring") DistributionGaussian::DistributionGaussian "DistributionGaussian::DistributionGaussian()
";
%feature("docstring") DistributionGaussian::clone "DistributionGaussian* DistributionGaussian::clone() const final
@@ -1967,13 +1967,13 @@ Log-normal distribution.
C++ includes: Distributions.h
";
-%feature("docstring") DistributionLogNormal::DistributionLogNormal "DistributionLogNormal::DistributionLogNormal(double scale_param)
+%feature("docstring") DistributionLogNormal::DistributionLogNormal "DistributionLogNormal::DistributionLogNormal(const std::vector< double > P)
";
%feature("docstring") DistributionLogNormal::DistributionLogNormal "DistributionLogNormal::DistributionLogNormal(double median, double scale_param)
";
-%feature("docstring") DistributionLogNormal::~DistributionLogNormal "virtual DistributionLogNormal::~DistributionLogNormal()
+%feature("docstring") DistributionLogNormal::DistributionLogNormal "DistributionLogNormal::DistributionLogNormal()=delete
";
%feature("docstring") DistributionLogNormal::clone "DistributionLogNormal* DistributionLogNormal::clone() const final
@@ -2024,13 +2024,13 @@ Lorentz distribution with half width hwhm.
C++ includes: Distributions.h
";
-%feature("docstring") DistributionLorentz::DistributionLorentz "DistributionLorentz::DistributionLorentz()
+%feature("docstring") DistributionLorentz::DistributionLorentz "DistributionLorentz::DistributionLorentz(const std::vector< double > P)
";
%feature("docstring") DistributionLorentz::DistributionLorentz "DistributionLorentz::DistributionLorentz(double mean, double hwhm)
";
-%feature("docstring") DistributionLorentz::~DistributionLorentz "virtual DistributionLorentz::~DistributionLorentz()
+%feature("docstring") DistributionLorentz::DistributionLorentz "DistributionLorentz::DistributionLorentz()
";
%feature("docstring") DistributionLorentz::clone "DistributionLorentz* DistributionLorentz::clone() const final
@@ -2073,13 +2073,13 @@ Trapezoidal distribution.
C++ includes: Distributions.h
";
-%feature("docstring") DistributionTrapezoid::DistributionTrapezoid "DistributionTrapezoid::DistributionTrapezoid()
+%feature("docstring") DistributionTrapezoid::DistributionTrapezoid "DistributionTrapezoid::DistributionTrapezoid(const std::vector< double > P)
";
-%feature("docstring") DistributionTrapezoid::DistributionTrapezoid "DistributionTrapezoid::DistributionTrapezoid(double center, double left_width, double middle_width, double right_width)
+%feature("docstring") DistributionTrapezoid::DistributionTrapezoid "DistributionTrapezoid::DistributionTrapezoid(double center, double left, double middle, double right)
";
-%feature("docstring") DistributionTrapezoid::~DistributionTrapezoid "virtual DistributionTrapezoid::~DistributionTrapezoid()
+%feature("docstring") DistributionTrapezoid::DistributionTrapezoid "DistributionTrapezoid::DistributionTrapezoid()
";
%feature("docstring") DistributionTrapezoid::clone "DistributionTrapezoid* DistributionTrapezoid::clone() const final
@@ -2696,6 +2696,9 @@ Calculates footprint coefficient for a gaussian beam Beam width is interpreted
C++ includes: FootprintGauss.h
";
+%feature("docstring") FootprintGauss::FootprintGauss "FootprintGauss::FootprintGauss(const std::vector< double > P)
+";
+
%feature("docstring") FootprintGauss::FootprintGauss "FootprintGauss::FootprintGauss(double width_ratio)
";
@@ -2726,6 +2729,9 @@ Calculates footprint coefficient for a square beam
C++ includes: FootprintSquare.h
";
+%feature("docstring") FootprintSquare::FootprintSquare "FootprintSquare::FootprintSquare(const std::vector< double > P)
+";
+
%feature("docstring") FootprintSquare::FootprintSquare "FootprintSquare::FootprintSquare(double width_ratio)
";
@@ -2763,7 +2769,7 @@ A frustum (truncated pyramid) with rectangular base.
C++ includes: FormFactorAnisoPyramid.h
";
-%feature("docstring") FormFactorAnisoPyramid::FormFactorAnisoPyramid "FormFactorAnisoPyramid::FormFactorAnisoPyramid(double length, double width, double height, double alpha)
+%feature("docstring") FormFactorAnisoPyramid::FormFactorAnisoPyramid "FormFactorAnisoPyramid::FormFactorAnisoPyramid(const std::vector< double > P)
Constructor of a truncated pyramid with a rectangular base.
@@ -2783,6 +2789,9 @@ alpha:
dihedral angle in radians between base and facet
";
+%feature("docstring") FormFactorAnisoPyramid::FormFactorAnisoPyramid "FormFactorAnisoPyramid::FormFactorAnisoPyramid(double length, double width, double height, double alpha)
+";
+
%feature("docstring") FormFactorAnisoPyramid::clone "FormFactorAnisoPyramid* FormFactorAnisoPyramid::clone() const override final
Returns a clone of this ISample object.
@@ -2874,15 +2883,18 @@ The form factor of an elongated bar, with Gaussian profile in elongation directi
C++ includes: FormFactorBar.h
";
+%feature("docstring") FormFactorBarGauss::FormFactorBarGauss "FormFactorBarGauss::FormFactorBarGauss(const std::vector< double > P)
+";
+
%feature("docstring") FormFactorBarGauss::FormFactorBarGauss "FormFactorBarGauss::FormFactorBarGauss(double length, double width, double height)
";
-%feature("docstring") FormFactorBarGauss::clone "FormFactorBarGauss * FormFactorBarGauss::clone() const override final
+%feature("docstring") FormFactorBarGauss::clone "FormFactorBarGauss * FormFactorBarGauss::clone() const final
Returns a clone of this ISample object.
";
-%feature("docstring") FormFactorBarGauss::accept "void FormFactorBarGauss::accept(INodeVisitor *visitor) const override final
+%feature("docstring") FormFactorBarGauss::accept "void FormFactorBarGauss::accept(INodeVisitor *visitor) const final
Calls the INodeVisitor's visit method.
";
@@ -2896,15 +2908,18 @@ The form factor of an elongated, with Lorentz form factor in elongation directio
C++ includes: FormFactorBar.h
";
+%feature("docstring") FormFactorBarLorentz::FormFactorBarLorentz "FormFactorBarLorentz::FormFactorBarLorentz(const std::vector< double > P)
+";
+
%feature("docstring") FormFactorBarLorentz::FormFactorBarLorentz "FormFactorBarLorentz::FormFactorBarLorentz(double length, double width, double height)
";
-%feature("docstring") FormFactorBarLorentz::clone "FormFactorBarLorentz * FormFactorBarLorentz::clone() const override final
+%feature("docstring") FormFactorBarLorentz::clone "FormFactorBarLorentz * FormFactorBarLorentz::clone() const final
Returns a clone of this ISample object.
";
-%feature("docstring") FormFactorBarLorentz::accept "void FormFactorBarLorentz::accept(INodeVisitor *visitor) const override final
+%feature("docstring") FormFactorBarLorentz::accept "void FormFactorBarLorentz::accept(INodeVisitor *visitor) const final
Calls the INodeVisitor's visit method.
";
@@ -2918,7 +2933,7 @@ A rectangular prism (parallelepiped).
C++ includes: FormFactorBox.h
";
-%feature("docstring") FormFactorBox::FormFactorBox "FormFactorBox::FormFactorBox(double length, double width, double height)
+%feature("docstring") FormFactorBox::FormFactorBox "FormFactorBox::FormFactorBox(const std::vector< double > P)
Constructor of a rectangular cuboid.
@@ -2935,6 +2950,9 @@ height:
height of the box in nanometers
";
+%feature("docstring") FormFactorBox::FormFactorBox "FormFactorBox::FormFactorBox(double length, double width, double height)
+";
+
%feature("docstring") FormFactorBox::clone "FormFactorBox* FormFactorBox::clone() const override final
Returns a clone of this ISample object.
@@ -2975,7 +2993,7 @@ A cube, with truncation of all edges and corners, as in Croset (2017) Fig 7
C++ includes: FormFactorCantellatedCube.h
";
-%feature("docstring") FormFactorCantellatedCube::FormFactorCantellatedCube "FormFactorCantellatedCube::FormFactorCantellatedCube(double length, double removed_length)
+%feature("docstring") FormFactorCantellatedCube::FormFactorCantellatedCube "FormFactorCantellatedCube::FormFactorCantellatedCube(const std::vector< double > P)
Constructor of a truncated cube.
@@ -2989,6 +3007,9 @@ removed_length:
removed length from each edge of the cube in nanometers
";
+%feature("docstring") FormFactorCantellatedCube::FormFactorCantellatedCube "FormFactorCantellatedCube::FormFactorCantellatedCube(double length, double removed_length)
+";
+
%feature("docstring") FormFactorCantellatedCube::clone "FormFactorCantellatedCube* FormFactorCantellatedCube::clone() const override final
Returns a clone of this ISample object.
@@ -3089,7 +3110,7 @@ A conical frustum (cone truncated parallel to the base) with circular base.
C++ includes: FormFactorCone.h
";
-%feature("docstring") FormFactorCone::FormFactorCone "FormFactorCone::FormFactorCone(double radius, double height, double alpha)
+%feature("docstring") FormFactorCone::FormFactorCone "FormFactorCone::FormFactorCone(const std::vector< double > P)
Constructor of a truncated cone with circular base.
@@ -3106,6 +3127,9 @@ alpha:
angle between the base and the side surface in radians
";
+%feature("docstring") FormFactorCone::FormFactorCone "FormFactorCone::FormFactorCone(double radius, double height, double alpha)
+";
+
%feature("docstring") FormFactorCone::clone "FormFactorCone* FormFactorCone::clone() const override final
Returns a clone of this ISample object.
@@ -3144,7 +3168,7 @@ A frustum (truncated pyramid) with regular hexagonal base.
C++ includes: FormFactorCone6.h
";
-%feature("docstring") FormFactorCone6::FormFactorCone6 "FormFactorCone6::FormFactorCone6(double base_edge, double height, double alpha)
+%feature("docstring") FormFactorCone6::FormFactorCone6 "FormFactorCone6::FormFactorCone6(const std::vector< double > P)
Constructor of a truncated pyramid, based on a regular hexagon
@@ -3161,6 +3185,9 @@ alpha:
dihedral angle in radians between base and facet
";
+%feature("docstring") FormFactorCone6::FormFactorCone6 "FormFactorCone6::FormFactorCone6(double base_edge, double height, double alpha)
+";
+
%feature("docstring") FormFactorCone6::clone "FormFactorCone6* FormFactorCone6::clone() const override final
Returns a clone of this ISample object.
@@ -3238,6 +3265,81 @@ Calculates and returns a polarized form factor calculation in DWBA.
";
+// File: classFormFactorCosineRippleBox.xml
+%feature("docstring") FormFactorCosineRippleBox "
+
+The form factor for a cosine ripple, with box profile in elongation direction.
+
+C++ includes: FormFactorCosineRipple.h
+";
+
+%feature("docstring") FormFactorCosineRippleBox::FormFactorCosineRippleBox "FormFactorCosineRippleBox::FormFactorCosineRippleBox(const std::vector< double > P)
+";
+
+%feature("docstring") FormFactorCosineRippleBox::FormFactorCosineRippleBox "FormFactorCosineRippleBox::FormFactorCosineRippleBox(double length, double width, double height)
+";
+
+%feature("docstring") FormFactorCosineRippleBox::clone "FormFactorCosineRippleBox * FormFactorCosineRippleBox::clone() const override final
+
+Returns a clone of this ISample object.
+";
+
+%feature("docstring") FormFactorCosineRippleBox::accept "void FormFactorCosineRippleBox::accept(INodeVisitor *visitor) const override final
+
+Calls the INodeVisitor's visit method.
+";
+
+
+// File: classFormFactorCosineRippleGauss.xml
+%feature("docstring") FormFactorCosineRippleGauss "
+
+The form factor for a cosine ripple, with Gaussian profile in elongation direction.
+
+C++ includes: FormFactorCosineRipple.h
+";
+
+%feature("docstring") FormFactorCosineRippleGauss::FormFactorCosineRippleGauss "FormFactorCosineRippleGauss::FormFactorCosineRippleGauss(const std::vector< double > P)
+";
+
+%feature("docstring") FormFactorCosineRippleGauss::FormFactorCosineRippleGauss "FormFactorCosineRippleGauss::FormFactorCosineRippleGauss(double length, double width, double height)
+";
+
+%feature("docstring") FormFactorCosineRippleGauss::clone "FormFactorCosineRippleGauss * FormFactorCosineRippleGauss::clone() const override final
+
+Returns a clone of this ISample object.
+";
+
+%feature("docstring") FormFactorCosineRippleGauss::accept "void FormFactorCosineRippleGauss::accept(INodeVisitor *visitor) const override final
+
+Calls the INodeVisitor's visit method.
+";
+
+
+// File: classFormFactorCosineRippleLorentz.xml
+%feature("docstring") FormFactorCosineRippleLorentz "
+
+The form factor for a cosine ripple, with Lorentz form factor in elongation direction.
+
+C++ includes: FormFactorCosineRipple.h
+";
+
+%feature("docstring") FormFactorCosineRippleLorentz::FormFactorCosineRippleLorentz "FormFactorCosineRippleLorentz::FormFactorCosineRippleLorentz(const std::vector< double > P)
+";
+
+%feature("docstring") FormFactorCosineRippleLorentz::FormFactorCosineRippleLorentz "FormFactorCosineRippleLorentz::FormFactorCosineRippleLorentz(double length, double width, double height)
+";
+
+%feature("docstring") FormFactorCosineRippleLorentz::clone "FormFactorCosineRippleLorentz * FormFactorCosineRippleLorentz::clone() const override final
+
+Returns a clone of this ISample object.
+";
+
+%feature("docstring") FormFactorCosineRippleLorentz::accept "void FormFactorCosineRippleLorentz::accept(INodeVisitor *visitor) const override final
+
+Calls the INodeVisitor's visit method.
+";
+
+
// File: classFormFactorCrystal.xml
%feature("docstring") FormFactorCrystal "
@@ -3306,7 +3408,7 @@ A truncated bifrustum with quadratic base.
C++ includes: FormFactorCuboctahedron.h
";
-%feature("docstring") FormFactorCuboctahedron::FormFactorCuboctahedron "FormFactorCuboctahedron::FormFactorCuboctahedron(double length, double height, double height_ratio, double alpha)
+%feature("docstring") FormFactorCuboctahedron::FormFactorCuboctahedron "FormFactorCuboctahedron::FormFactorCuboctahedron(const std::vector< double > P)
Constructor of cuboctahedron (compound of two truncated pyramids with a common square base and opposite orientations).
@@ -3326,6 +3428,9 @@ alpha:
dihedral angle in radians between base and facet
";
+%feature("docstring") FormFactorCuboctahedron::FormFactorCuboctahedron "FormFactorCuboctahedron::FormFactorCuboctahedron(double length, double height, double height_ratio, double alpha)
+";
+
%feature("docstring") FormFactorCuboctahedron::clone "FormFactorCuboctahedron* FormFactorCuboctahedron::clone() const override final
Returns a clone of this ISample object.
@@ -3357,7 +3462,7 @@ A circular cylinder.
C++ includes: FormFactorCylinder.h
";
-%feature("docstring") FormFactorCylinder::FormFactorCylinder "FormFactorCylinder::FormFactorCylinder(double radius, double height)
+%feature("docstring") FormFactorCylinder::FormFactorCylinder "FormFactorCylinder::FormFactorCylinder(const std::vector< double > P)
Constructor of a cylinder with a circular base.
@@ -3371,6 +3476,9 @@ height:
height of the cylinder in nanometers
";
+%feature("docstring") FormFactorCylinder::FormFactorCylinder "FormFactorCylinder::FormFactorCylinder(double radius, double height)
+";
+
%feature("docstring") FormFactorCylinder::clone "FormFactorCylinder* FormFactorCylinder::clone() const override final
Returns a clone of this ISample object.
@@ -3398,38 +3506,6 @@ Returns scattering amplitude for complex scattering wavevector q=k_i-k_f. This m
";
-// File: classFormFactorDebyeBueche.xml
-%feature("docstring") FormFactorDebyeBueche "
-
-The form factor of a Debye-Bueche (see doi:10.1038/pj.2010.110).
-
-C++ includes: FormFactorDebyeBueche.h
-";
-
-%feature("docstring") FormFactorDebyeBueche::FormFactorDebyeBueche "FormFactorDebyeBueche::FormFactorDebyeBueche(double I0, double xi)
-";
-
-%feature("docstring") FormFactorDebyeBueche::clone "FormFactorDebyeBueche* FormFactorDebyeBueche::clone() const override final
-
-Returns a clone of this ISample object.
-";
-
-%feature("docstring") FormFactorDebyeBueche::accept "void FormFactorDebyeBueche::accept(INodeVisitor *visitor) const override final
-
-Calls the INodeVisitor's visit method.
-";
-
-%feature("docstring") FormFactorDebyeBueche::radialExtension "double FormFactorDebyeBueche::radialExtension() const override final
-
-Returns the (approximate in some cases) radial size of the particle of this form factor's shape. This is used for SSCA calculations
-";
-
-%feature("docstring") FormFactorDebyeBueche::evaluate_for_q "complex_t FormFactorDebyeBueche::evaluate_for_q(cvector_t q) const override final
-
-Returns scattering amplitude for complex scattering wavevector q=k_i-k_f. This method is public only for convenience of plotting form factors in Python.
-";
-
-
// File: classFormFactorDecoratorMaterial.xml
%feature("docstring") FormFactorDecoratorMaterial "
@@ -3569,7 +3645,7 @@ A regular dodecahedron.
C++ includes: FormFactorDodecahedron.h
";
-%feature("docstring") FormFactorDodecahedron::FormFactorDodecahedron "FormFactorDodecahedron::FormFactorDodecahedron(double edge)
+%feature("docstring") FormFactorDodecahedron::FormFactorDodecahedron "FormFactorDodecahedron::FormFactorDodecahedron(const std::vector< double > P)
Constructs a regular dodecahedron.
@@ -3588,6 +3664,9 @@ edge:
length of the edge in nanometers
";
+%feature("docstring") FormFactorDodecahedron::FormFactorDodecahedron "FormFactorDodecahedron::FormFactorDodecahedron(double edge)
+";
+
%feature("docstring") FormFactorDodecahedron::clone "FormFactorDodecahedron* FormFactorDodecahedron::clone() const override final
Returns a clone of this ISample object.
@@ -3610,7 +3689,7 @@ A dot, with scattering power as a sphere of radius rscat, but with F(q)=const.
C++ includes: FormFactorDot.h
";
-%feature("docstring") FormFactorDot::FormFactorDot "FormFactorDot::FormFactorDot(double radius)
+%feature("docstring") FormFactorDot::FormFactorDot "FormFactorDot::FormFactorDot(const std::vector< double > P)
Constructor.
@@ -3621,6 +3700,9 @@ rscat:
radius of a sphere with same forward scattering power, in nanometers
";
+%feature("docstring") FormFactorDot::FormFactorDot "FormFactorDot::FormFactorDot(double radius)
+";
+
%feature("docstring") FormFactorDot::clone "FormFactorDot* FormFactorDot::clone() const override final
Returns a clone of this ISample object.
@@ -3788,7 +3870,7 @@ A cylinder with elliptical base.
C++ includes: FormFactorEllipsoidalCylinder.h
";
-%feature("docstring") FormFactorEllipsoidalCylinder::FormFactorEllipsoidalCylinder "FormFactorEllipsoidalCylinder::FormFactorEllipsoidalCylinder(double radius_x, double radius_y, double height)
+%feature("docstring") FormFactorEllipsoidalCylinder::FormFactorEllipsoidalCylinder "FormFactorEllipsoidalCylinder::FormFactorEllipsoidalCylinder(const std::vector< double > P)
Constructor of a cylinder with an ellipse cross section.
@@ -3805,6 +3887,9 @@ height:
height of the ellipsoidal cylinder in nanometers
";
+%feature("docstring") FormFactorEllipsoidalCylinder::FormFactorEllipsoidalCylinder "FormFactorEllipsoidalCylinder::FormFactorEllipsoidalCylinder(double radius_x, double radius_y, double height)
+";
+
%feature("docstring") FormFactorEllipsoidalCylinder::clone "FormFactorEllipsoidalCylinder* FormFactorEllipsoidalCylinder::clone() const override final
Returns a clone of this ISample object.
@@ -3843,7 +3928,7 @@ A full sphere.
C++ includes: FormFactorFullSphere.h
";
-%feature("docstring") FormFactorFullSphere::FormFactorFullSphere "FormFactorFullSphere::FormFactorFullSphere(double radius, bool position_at_center=false)
+%feature("docstring") FormFactorFullSphere::FormFactorFullSphere "FormFactorFullSphere::FormFactorFullSphere(const std::vector< double > P, bool position_at_center=false)
Constructor of a full sphere.
@@ -3854,6 +3939,9 @@ radius:
radius of the sphere in nanometers
";
+%feature("docstring") FormFactorFullSphere::FormFactorFullSphere "FormFactorFullSphere::FormFactorFullSphere(double radius, bool position_at_center=false)
+";
+
%feature("docstring") FormFactorFullSphere::clone "FormFactorFullSphere* FormFactorFullSphere::clone() const override final
Returns a clone of this ISample object.
@@ -3896,7 +3984,7 @@ A full spheroid (an ellipsoid with two equal axes, hence with circular cross sec
C++ includes: FormFactorFullSpheroid.h
";
-%feature("docstring") FormFactorFullSpheroid::FormFactorFullSpheroid "FormFactorFullSpheroid::FormFactorFullSpheroid(double radius, double height)
+%feature("docstring") FormFactorFullSpheroid::FormFactorFullSpheroid "FormFactorFullSpheroid::FormFactorFullSpheroid(const std::vector< double > P)
Constructor of full spheroid.
@@ -3910,6 +3998,9 @@ height:
height of the full spheroid in nanometers
";
+%feature("docstring") FormFactorFullSpheroid::FormFactorFullSpheroid "FormFactorFullSpheroid::FormFactorFullSpheroid(double radius, double height)
+";
+
%feature("docstring") FormFactorFullSpheroid::clone "FormFactorFullSpheroid* FormFactorFullSpheroid::clone() const override final
Returns a clone of this ISample object.
@@ -3937,42 +4028,39 @@ Returns scattering amplitude for complex scattering wavevector q=k_i-k_f. This m
";
-// File: classFormFactorGauss.xml
-%feature("docstring") FormFactorGauss "
+// File: classFormFactorGaussSphere.xml
+%feature("docstring") FormFactorGaussSphere "
-The form factor of a gaussian.
+The form factor of a Gaussian sphere.
C++ includes: FormFactorGauss.h
";
-%feature("docstring") FormFactorGauss::FormFactorGauss "FormFactorGauss::FormFactorGauss(double length)
+%feature("docstring") FormFactorGaussSphere::FormFactorGaussSphere "FormFactorGaussSphere::FormFactorGaussSphere(const std::vector< double > P)
";
-%feature("docstring") FormFactorGauss::FormFactorGauss "FormFactorGauss::FormFactorGauss(double width, double height)
+%feature("docstring") FormFactorGaussSphere::FormFactorGaussSphere "FormFactorGaussSphere::FormFactorGaussSphere(double mean_radius)
";
-%feature("docstring") FormFactorGauss::clone "FormFactorGauss* FormFactorGauss::clone() const override final
+%feature("docstring") FormFactorGaussSphere::clone "FormFactorGaussSphere* FormFactorGaussSphere::clone() const override final
Returns a clone of this ISample object.
";
-%feature("docstring") FormFactorGauss::accept "void FormFactorGauss::accept(INodeVisitor *visitor) const override final
+%feature("docstring") FormFactorGaussSphere::accept "void FormFactorGaussSphere::accept(INodeVisitor *visitor) const override final
Calls the INodeVisitor's visit method.
";
-%feature("docstring") FormFactorGauss::getWidth "double FormFactorGauss::getWidth() const
-";
-
-%feature("docstring") FormFactorGauss::getHeight "double FormFactorGauss::getHeight() const
+%feature("docstring") FormFactorGaussSphere::getMeanRadius "double FormFactorGaussSphere::getMeanRadius() const
";
-%feature("docstring") FormFactorGauss::radialExtension "double FormFactorGauss::radialExtension() const override final
+%feature("docstring") FormFactorGaussSphere::radialExtension "double FormFactorGaussSphere::radialExtension() const override final
Returns the (approximate in some cases) radial size of the particle of this form factor's shape. This is used for SSCA calculations
";
-%feature("docstring") FormFactorGauss::evaluate_for_q "complex_t FormFactorGauss::evaluate_for_q(cvector_t q) const override final
+%feature("docstring") FormFactorGaussSphere::evaluate_for_q "complex_t FormFactorGaussSphere::evaluate_for_q(cvector_t q) const override final
Returns scattering amplitude for complex scattering wavevector q=k_i-k_f. This method is public only for convenience of plotting form factors in Python.
";
@@ -3986,7 +4074,7 @@ An hemi ellipsoid, obtained by truncating a full ellipsoid in the middle plane s
C++ includes: FormFactorHemiEllipsoid.h
";
-%feature("docstring") FormFactorHemiEllipsoid::FormFactorHemiEllipsoid "FormFactorHemiEllipsoid::FormFactorHemiEllipsoid(double radius_x, double radius_y, double height)
+%feature("docstring") FormFactorHemiEllipsoid::FormFactorHemiEllipsoid "FormFactorHemiEllipsoid::FormFactorHemiEllipsoid(const std::vector< double > P)
Constructor of horizontally oriented ellipsoid, truncated at the central plane.
@@ -4003,6 +4091,9 @@ height:
height of the hemi ellipsoid in nanometers
";
+%feature("docstring") FormFactorHemiEllipsoid::FormFactorHemiEllipsoid "FormFactorHemiEllipsoid::FormFactorHemiEllipsoid(double radius_x, double radius_y, double height)
+";
+
%feature("docstring") FormFactorHemiEllipsoid::~FormFactorHemiEllipsoid "virtual FormFactorHemiEllipsoid::~FormFactorHemiEllipsoid()
";
@@ -4044,6 +4135,9 @@ Integrated full sphere form factor over a uniform distribution of radii.
C++ includes: FormFactorHollowSphere.h
";
+%feature("docstring") FormFactorHollowSphere::FormFactorHollowSphere "FormFactorHollowSphere::FormFactorHollowSphere(const std::vector< double > P)
+";
+
%feature("docstring") FormFactorHollowSphere::FormFactorHollowSphere "FormFactorHollowSphere::FormFactorHollowSphere(double mean, double full_width)
";
@@ -4076,7 +4170,7 @@ A regular icosahedron.
C++ includes: FormFactorIcosahedron.h
";
-%feature("docstring") FormFactorIcosahedron::FormFactorIcosahedron "FormFactorIcosahedron::FormFactorIcosahedron(double edge)
+%feature("docstring") FormFactorIcosahedron::FormFactorIcosahedron "FormFactorIcosahedron::FormFactorIcosahedron(const std::vector< double > P)
Constructor of a icosahedron.
@@ -4087,6 +4181,9 @@ edge:
length of the edge in nanometers
";
+%feature("docstring") FormFactorIcosahedron::FormFactorIcosahedron "FormFactorIcosahedron::FormFactorIcosahedron(double edge)
+";
+
%feature("docstring") FormFactorIcosahedron::clone "FormFactorIcosahedron* FormFactorIcosahedron::clone() const override final
Returns a clone of this ISample object.
@@ -4109,7 +4206,7 @@ The form factor for a long rectangular box.
C++ includes: FormFactorLongBoxGauss.h
";
-%feature("docstring") FormFactorLongBoxGauss::FormFactorLongBoxGauss "FormFactorLongBoxGauss::FormFactorLongBoxGauss(double length, double width, double height)
+%feature("docstring") FormFactorLongBoxGauss::FormFactorLongBoxGauss "FormFactorLongBoxGauss::FormFactorLongBoxGauss(const std::vector< double > P)
Box constructor.
@@ -4126,6 +4223,9 @@ height:
of Box
";
+%feature("docstring") FormFactorLongBoxGauss::FormFactorLongBoxGauss "FormFactorLongBoxGauss::FormFactorLongBoxGauss(double length, double width, double height)
+";
+
%feature("docstring") FormFactorLongBoxGauss::clone "FormFactorLongBoxGauss* FormFactorLongBoxGauss::clone() const override final
Returns a clone of this ISample object.
@@ -4164,7 +4264,7 @@ The form factor for a long rectangular box.
C++ includes: FormFactorLongBoxLorentz.h
";
-%feature("docstring") FormFactorLongBoxLorentz::FormFactorLongBoxLorentz "FormFactorLongBoxLorentz::FormFactorLongBoxLorentz(double length, double width, double height)
+%feature("docstring") FormFactorLongBoxLorentz::FormFactorLongBoxLorentz "FormFactorLongBoxLorentz::FormFactorLongBoxLorentz(const std::vector< double > P)
Box constructor.
@@ -4181,6 +4281,9 @@ height:
of Box
";
+%feature("docstring") FormFactorLongBoxLorentz::FormFactorLongBoxLorentz "FormFactorLongBoxLorentz::FormFactorLongBoxLorentz(double length, double width, double height)
+";
+
%feature("docstring") FormFactorLongBoxLorentz::clone "FormFactorLongBoxLorentz* FormFactorLongBoxLorentz::clone() const override final
Returns a clone of this ISample object.
@@ -4211,79 +4314,6 @@ Returns scattering amplitude for complex scattering wavevector q=k_i-k_f. This m
";
-// File: classFormFactorLorentz.xml
-%feature("docstring") FormFactorLorentz "
-
-The form factor of a lorentzian.
-
-C++ includes: FormFactorLorentz.h
-";
-
-%feature("docstring") FormFactorLorentz::FormFactorLorentz "FormFactorLorentz::FormFactorLorentz(double length)
-";
-
-%feature("docstring") FormFactorLorentz::FormFactorLorentz "FormFactorLorentz::FormFactorLorentz(double width, double height)
-";
-
-%feature("docstring") FormFactorLorentz::clone "FormFactorLorentz* FormFactorLorentz::clone() const override final
-
-Returns a clone of this ISample object.
-";
-
-%feature("docstring") FormFactorLorentz::accept "void FormFactorLorentz::accept(INodeVisitor *visitor) const override final
-
-Calls the INodeVisitor's visit method.
-";
-
-%feature("docstring") FormFactorLorentz::getWidth "double FormFactorLorentz::getWidth() const
-";
-
-%feature("docstring") FormFactorLorentz::getHeight "double FormFactorLorentz::getHeight() const
-";
-
-%feature("docstring") FormFactorLorentz::radialExtension "double FormFactorLorentz::radialExtension() const override final
-
-Returns the (approximate in some cases) radial size of the particle of this form factor's shape. This is used for SSCA calculations
-";
-
-%feature("docstring") FormFactorLorentz::evaluate_for_q "complex_t FormFactorLorentz::evaluate_for_q(cvector_t q) const override final
-
-Returns scattering amplitude for complex scattering wavevector q=k_i-k_f. This method is public only for convenience of plotting form factors in Python.
-";
-
-
-// File: classFormFactorOrnsteinZernike.xml
-%feature("docstring") FormFactorOrnsteinZernike "
-
-The form factor of a Ornstein-Zernike (see doi:10.1038/pj.2010.110).
-
-C++ includes: FormFactorOrnsteinZernike.h
-";
-
-%feature("docstring") FormFactorOrnsteinZernike::FormFactorOrnsteinZernike "FormFactorOrnsteinZernike::FormFactorOrnsteinZernike(double I0, double xi_xy, double xi_z)
-";
-
-%feature("docstring") FormFactorOrnsteinZernike::clone "FormFactorOrnsteinZernike* FormFactorOrnsteinZernike::clone() const override final
-
-Returns a clone of this ISample object.
-";
-
-%feature("docstring") FormFactorOrnsteinZernike::accept "void FormFactorOrnsteinZernike::accept(INodeVisitor *visitor) const override final
-
-Calls the INodeVisitor's visit method.
-";
-
-%feature("docstring") FormFactorOrnsteinZernike::radialExtension "double FormFactorOrnsteinZernike::radialExtension() const override final
-
-Returns the (approximate in some cases) radial size of the particle of this form factor's shape. This is used for SSCA calculations
-";
-
-%feature("docstring") FormFactorOrnsteinZernike::evaluate_for_q "complex_t FormFactorOrnsteinZernike::evaluate_for_q(cvector_t q) const override final
-
-Returns scattering amplitude for complex scattering wavevector q=k_i-k_f. This method is public only for convenience of plotting form factors in Python.
-";
-
-
// File: classFormFactorPolygonalPrism.xml
%feature("docstring") FormFactorPolygonalPrism "
@@ -4295,7 +4325,7 @@ C++ includes: FormFactorPolyhedron.h
%feature("docstring") FormFactorPolygonalPrism::FormFactorPolygonalPrism "FormFactorPolygonalPrism::FormFactorPolygonalPrism()=default
";
-%feature("docstring") FormFactorPolygonalPrism::FormFactorPolygonalPrism "FormFactorPolygonalPrism::FormFactorPolygonalPrism(const INode *parent, const std::vector< const char * > PName, const std::vector< const char * > PUnit, const std::vector< double > PMin, const std::vector< double > PMax, const std::vector< double > PDefault, std::vector< double > P)
+%feature("docstring") FormFactorPolygonalPrism::FormFactorPolygonalPrism "FormFactorPolygonalPrism::FormFactorPolygonalPrism(const NodeMeta &meta, const std::vector< double > &PValues)
";
%feature("docstring") FormFactorPolygonalPrism::bottomZ "double FormFactorPolygonalPrism::bottomZ(const IRotation &rotation) const override final
@@ -4338,7 +4368,7 @@ C++ includes: FormFactorPolyhedron.h
%feature("docstring") FormFactorPolygonalSurface::FormFactorPolygonalSurface "FormFactorPolygonalSurface::FormFactorPolygonalSurface()=default
";
-%feature("docstring") FormFactorPolygonalSurface::FormFactorPolygonalSurface "FormFactorPolygonalSurface::FormFactorPolygonalSurface(const INode *parent, const std::vector< const char * > PName, const std::vector< const char * > PUnit, const std::vector< double > PMin, const std::vector< double > PMax, const std::vector< double > PDefault, std::vector< double > P)
+%feature("docstring") FormFactorPolygonalSurface::FormFactorPolygonalSurface "FormFactorPolygonalSurface::FormFactorPolygonalSurface(const NodeMeta &meta, const std::vector< double > &PValues)
";
%feature("docstring") FormFactorPolygonalSurface::evaluate_for_q "complex_t FormFactorPolygonalSurface::evaluate_for_q(cvector_t q) const override final
@@ -4368,7 +4398,7 @@ C++ includes: FormFactorPolyhedron.h
%feature("docstring") FormFactorPolyhedron::FormFactorPolyhedron "FormFactorPolyhedron::FormFactorPolyhedron()
";
-%feature("docstring") FormFactorPolyhedron::FormFactorPolyhedron "FormFactorPolyhedron::FormFactorPolyhedron(const INode *parent, const std::vector< const char * > PName, const std::vector< const char * > PUnit, const std::vector< double > PMin, const std::vector< double > PMax, const std::vector< double > PDefault, std::vector< double > P)
+%feature("docstring") FormFactorPolyhedron::FormFactorPolyhedron "FormFactorPolyhedron::FormFactorPolyhedron(const NodeMeta &meta, const std::vector< double > &PValues)
";
%feature("docstring") FormFactorPolyhedron::bottomZ "double FormFactorPolyhedron::bottomZ(const IRotation &rotation) const override final
@@ -4415,7 +4445,7 @@ A prism based on an equilateral triangle.
C++ includes: FormFactorPrism3.h
";
-%feature("docstring") FormFactorPrism3::FormFactorPrism3 "FormFactorPrism3::FormFactorPrism3(double base_edge, double height)
+%feature("docstring") FormFactorPrism3::FormFactorPrism3 "FormFactorPrism3::FormFactorPrism3(const std::vector< double > P)
Constructor of a prism with an equilaterial triangle base.
@@ -4429,6 +4459,9 @@ height:
height in nanometers
";
+%feature("docstring") FormFactorPrism3::FormFactorPrism3 "FormFactorPrism3::FormFactorPrism3(double base_edge, double height)
+";
+
%feature("docstring") FormFactorPrism3::clone "FormFactorPrism3* FormFactorPrism3::clone() const override final
Returns a clone of this ISample object.
@@ -4451,7 +4484,7 @@ A prism based on a regular hexagonal.
C++ includes: FormFactorPrism6.h
";
-%feature("docstring") FormFactorPrism6::FormFactorPrism6 "FormFactorPrism6::FormFactorPrism6(double base_edge, double height)
+%feature("docstring") FormFactorPrism6::FormFactorPrism6 "FormFactorPrism6::FormFactorPrism6(const std::vector< double > P)
Constructor of a prism with a regular hexagonal base.
@@ -4465,6 +4498,9 @@ height:
height in nanometers
";
+%feature("docstring") FormFactorPrism6::FormFactorPrism6 "FormFactorPrism6::FormFactorPrism6(double base_edge, double height)
+";
+
%feature("docstring") FormFactorPrism6::clone "FormFactorPrism6* FormFactorPrism6::clone() const override final
Returns a clone of this ISample object.
@@ -4487,7 +4523,7 @@ A frustum with a quadratic base.
C++ includes: FormFactorPyramid.h
";
-%feature("docstring") FormFactorPyramid::FormFactorPyramid "FormFactorPyramid::FormFactorPyramid(double base_edge, double height, double alpha)
+%feature("docstring") FormFactorPyramid::FormFactorPyramid "FormFactorPyramid::FormFactorPyramid(const std::vector< double > P)
Constructor of a truncated pyramid with a square base
@@ -4504,6 +4540,9 @@ alpha:
dihedral angle between the base and a side face in radians
";
+%feature("docstring") FormFactorPyramid::FormFactorPyramid "FormFactorPyramid::FormFactorPyramid(double base_edge, double height, double alpha)
+";
+
%feature("docstring") FormFactorPyramid::clone "FormFactorPyramid* FormFactorPyramid::clone() const override final
Returns a clone of this ISample object.
@@ -4524,167 +4563,113 @@ Calls the INodeVisitor's visit method.
";
-// File: classFormFactorRipple1Box.xml
-%feature("docstring") FormFactorRipple1Box "
+// File: classFormFactorSawtoothRippleBox.xml
+%feature("docstring") FormFactorSawtoothRippleBox "
The form factor for a cosine ripple, with box profile in elongation direction.
-C++ includes: FormFactorRipple1.h
+C++ includes: FormFactorSawtoothRipple.h
+";
+
+%feature("docstring") FormFactorSawtoothRippleBox::FormFactorSawtoothRippleBox "FormFactorSawtoothRippleBox::FormFactorSawtoothRippleBox(const std::vector< double > P)
";
-%feature("docstring") FormFactorRipple1Box::FormFactorRipple1Box "FormFactorRipple1Box::FormFactorRipple1Box(double length, double width, double height)
+%feature("docstring") FormFactorSawtoothRippleBox::FormFactorSawtoothRippleBox "FormFactorSawtoothRippleBox::FormFactorSawtoothRippleBox(double length, double width, double height, double asymmetry)
";
-%feature("docstring") FormFactorRipple1Box::clone "FormFactorRipple1Box * FormFactorRipple1Box::clone() const override final
+%feature("docstring") FormFactorSawtoothRippleBox::clone "FormFactorSawtoothRippleBox * FormFactorSawtoothRippleBox::clone() const override final
Returns a clone of this ISample object.
";
-%feature("docstring") FormFactorRipple1Box::accept "void FormFactorRipple1Box::accept(INodeVisitor *visitor) const override final
+%feature("docstring") FormFactorSawtoothRippleBox::accept "void FormFactorSawtoothRippleBox::accept(INodeVisitor *visitor) const override final
Calls the INodeVisitor's visit method.
";
-// File: classFormFactorRipple1Gauss.xml
-%feature("docstring") FormFactorRipple1Gauss "
+// File: classFormFactorSawtoothRippleGauss.xml
+%feature("docstring") FormFactorSawtoothRippleGauss "
The form factor for a cosine ripple, with Gaussian profile in elongation direction.
-C++ includes: FormFactorRipple1.h
+C++ includes: FormFactorSawtoothRipple.h
+";
+
+%feature("docstring") FormFactorSawtoothRippleGauss::FormFactorSawtoothRippleGauss "FormFactorSawtoothRippleGauss::FormFactorSawtoothRippleGauss(const std::vector< double > P)
";
-%feature("docstring") FormFactorRipple1Gauss::FormFactorRipple1Gauss "FormFactorRipple1Gauss::FormFactorRipple1Gauss(double length, double width, double height)
+%feature("docstring") FormFactorSawtoothRippleGauss::FormFactorSawtoothRippleGauss "FormFactorSawtoothRippleGauss::FormFactorSawtoothRippleGauss(double length, double width, double height, double asymmetry)
";
-%feature("docstring") FormFactorRipple1Gauss::clone "FormFactorRipple1Gauss * FormFactorRipple1Gauss::clone() const override final
+%feature("docstring") FormFactorSawtoothRippleGauss::clone "FormFactorSawtoothRippleGauss * FormFactorSawtoothRippleGauss::clone() const override final
Returns a clone of this ISample object.
";
-%feature("docstring") FormFactorRipple1Gauss::accept "void FormFactorRipple1Gauss::accept(INodeVisitor *visitor) const override final
+%feature("docstring") FormFactorSawtoothRippleGauss::accept "void FormFactorSawtoothRippleGauss::accept(INodeVisitor *visitor) const override final
Calls the INodeVisitor's visit method.
";
-// File: classFormFactorRipple1Lorentz.xml
-%feature("docstring") FormFactorRipple1Lorentz "
+// File: classFormFactorSawtoothRippleLorentz.xml
+%feature("docstring") FormFactorSawtoothRippleLorentz "
The form factor for a cosine ripple, with Lorentz form factor in elongation direction.
-C++ includes: FormFactorRipple1.h
+C++ includes: FormFactorSawtoothRipple.h
+";
+
+%feature("docstring") FormFactorSawtoothRippleLorentz::FormFactorSawtoothRippleLorentz "FormFactorSawtoothRippleLorentz::FormFactorSawtoothRippleLorentz(const std::vector< double > P)
";
-%feature("docstring") FormFactorRipple1Lorentz::FormFactorRipple1Lorentz "FormFactorRipple1Lorentz::FormFactorRipple1Lorentz(double length, double width, double height)
+%feature("docstring") FormFactorSawtoothRippleLorentz::FormFactorSawtoothRippleLorentz "FormFactorSawtoothRippleLorentz::FormFactorSawtoothRippleLorentz(double length, double width, double height, double asymmetry)
";
-%feature("docstring") FormFactorRipple1Lorentz::clone "FormFactorRipple1Lorentz * FormFactorRipple1Lorentz::clone() const override final
+%feature("docstring") FormFactorSawtoothRippleLorentz::clone "FormFactorSawtoothRippleLorentz * FormFactorSawtoothRippleLorentz::clone() const override final
Returns a clone of this ISample object.
";
-%feature("docstring") FormFactorRipple1Lorentz::accept "void FormFactorRipple1Lorentz::accept(INodeVisitor *visitor) const override final
+%feature("docstring") FormFactorSawtoothRippleLorentz::accept "void FormFactorSawtoothRippleLorentz::accept(INodeVisitor *visitor) const override final
Calls the INodeVisitor's visit method.
";
-// File: classFormFactorRipple2Box.xml
-%feature("docstring") FormFactorRipple2Box "
+// File: classFormFactorSphereGaussianRadius.xml
+%feature("docstring") FormFactorSphereGaussianRadius "
+
+A sphere with gaussian radius distribution.
-The form factor for a cosine ripple, with box profile in elongation direction.
+C++ includes: FormFactorSphereGaussianRadius.h
+";
-C++ includes: FormFactorRipple2.h
+%feature("docstring") FormFactorSphereGaussianRadius::FormFactorSphereGaussianRadius "FormFactorSphereGaussianRadius::FormFactorSphereGaussianRadius(const std::vector< double > P)
";
-%feature("docstring") FormFactorRipple2Box::FormFactorRipple2Box "FormFactorRipple2Box::FormFactorRipple2Box(double length, double width, double height, double asymmetry)
+%feature("docstring") FormFactorSphereGaussianRadius::FormFactorSphereGaussianRadius "FormFactorSphereGaussianRadius::FormFactorSphereGaussianRadius(double mean, double sigma)
";
-%feature("docstring") FormFactorRipple2Box::clone "FormFactorRipple2Box * FormFactorRipple2Box::clone() const override final
+%feature("docstring") FormFactorSphereGaussianRadius::clone "FormFactorSphereGaussianRadius* FormFactorSphereGaussianRadius::clone() const override final
Returns a clone of this ISample object.
";
-%feature("docstring") FormFactorRipple2Box::accept "void FormFactorRipple2Box::accept(INodeVisitor *visitor) const override final
+%feature("docstring") FormFactorSphereGaussianRadius::accept "void FormFactorSphereGaussianRadius::accept(INodeVisitor *visitor) const override final
Calls the INodeVisitor's visit method.
";
+%feature("docstring") FormFactorSphereGaussianRadius::radialExtension "double FormFactorSphereGaussianRadius::radialExtension() const override final
-// File: classFormFactorRipple2Gauss.xml
-%feature("docstring") FormFactorRipple2Gauss "
+Returns the (approximate in some cases) radial size of the particle of this form factor's shape. This is used for SSCA calculations
+";
-The form factor for a cosine ripple, with Gaussian profile in elongation direction.
+%feature("docstring") FormFactorSphereGaussianRadius::evaluate_for_q "complex_t FormFactorSphereGaussianRadius::evaluate_for_q(cvector_t q) const override final
-C++ includes: FormFactorRipple2.h
-";
-
-%feature("docstring") FormFactorRipple2Gauss::FormFactorRipple2Gauss "FormFactorRipple2Gauss::FormFactorRipple2Gauss(double length, double width, double height, double asymmetry)
-";
-
-%feature("docstring") FormFactorRipple2Gauss::clone "FormFactorRipple2Gauss * FormFactorRipple2Gauss::clone() const override final
-
-Returns a clone of this ISample object.
-";
-
-%feature("docstring") FormFactorRipple2Gauss::accept "void FormFactorRipple2Gauss::accept(INodeVisitor *visitor) const override final
-
-Calls the INodeVisitor's visit method.
-";
-
-
-// File: classFormFactorRipple2Lorentz.xml
-%feature("docstring") FormFactorRipple2Lorentz "
-
-The form factor for a cosine ripple, with Lorentz form factor in elongation direction.
-
-C++ includes: FormFactorRipple2.h
-";
-
-%feature("docstring") FormFactorRipple2Lorentz::FormFactorRipple2Lorentz "FormFactorRipple2Lorentz::FormFactorRipple2Lorentz(double length, double width, double height, double asymmetry)
-";
-
-%feature("docstring") FormFactorRipple2Lorentz::clone "FormFactorRipple2Lorentz * FormFactorRipple2Lorentz::clone() const override final
-
-Returns a clone of this ISample object.
-";
-
-%feature("docstring") FormFactorRipple2Lorentz::accept "void FormFactorRipple2Lorentz::accept(INodeVisitor *visitor) const override final
-
-Calls the INodeVisitor's visit method.
-";
-
-
-// File: classFormFactorSphereGaussianRadius.xml
-%feature("docstring") FormFactorSphereGaussianRadius "
-
-A sphere with gaussian radius distribution.
-
-C++ includes: FormFactorSphereGaussianRadius.h
-";
-
-%feature("docstring") FormFactorSphereGaussianRadius::FormFactorSphereGaussianRadius "FormFactorSphereGaussianRadius::FormFactorSphereGaussianRadius(double mean, double sigma)
-";
-
-%feature("docstring") FormFactorSphereGaussianRadius::clone "FormFactorSphereGaussianRadius* FormFactorSphereGaussianRadius::clone() const override final
-
-Returns a clone of this ISample object.
-";
-
-%feature("docstring") FormFactorSphereGaussianRadius::accept "void FormFactorSphereGaussianRadius::accept(INodeVisitor *visitor) const override final
-
-Calls the INodeVisitor's visit method.
-";
-
-%feature("docstring") FormFactorSphereGaussianRadius::radialExtension "double FormFactorSphereGaussianRadius::radialExtension() const override final
-
-Returns the (approximate in some cases) radial size of the particle of this form factor's shape. This is used for SSCA calculations
-";
-
-%feature("docstring") FormFactorSphereGaussianRadius::evaluate_for_q "complex_t FormFactorSphereGaussianRadius::evaluate_for_q(cvector_t q) const override final
-
-Returns scattering amplitude for complex scattering wavevector q=k_i-k_f. This method is public only for convenience of plotting form factors in Python.
+Returns scattering amplitude for complex scattering wavevector q=k_i-k_f. This method is public only for convenience of plotting form factors in Python.
";
@@ -4696,10 +4681,13 @@ A sphere with log normal radius distribution.
C++ includes: FormFactorSphereLogNormalRadius.h
";
+%feature("docstring") FormFactorSphereLogNormalRadius::FormFactorSphereLogNormalRadius "FormFactorSphereLogNormalRadius::FormFactorSphereLogNormalRadius(const std::vector< double > P, size_t n_samples=0)
+";
+
%feature("docstring") FormFactorSphereLogNormalRadius::FormFactorSphereLogNormalRadius "FormFactorSphereLogNormalRadius::FormFactorSphereLogNormalRadius(double mean, double scale_param, size_t n_samples)
";
-%feature("docstring") FormFactorSphereLogNormalRadius::clone "FormFactorSphereLogNormalRadius* FormFactorSphereLogNormalRadius::clone() const override final
+%feature("docstring") FormFactorSphereLogNormalRadius::clone "FormFactorSphereLogNormalRadius * FormFactorSphereLogNormalRadius::clone() const override final
Returns a clone of this ISample object.
";
@@ -4728,7 +4716,7 @@ A frustum with equilateral trigonal base.
C++ includes: FormFactorTetrahedron.h
";
-%feature("docstring") FormFactorTetrahedron::FormFactorTetrahedron "FormFactorTetrahedron::FormFactorTetrahedron(double base_edge, double height, double alpha)
+%feature("docstring") FormFactorTetrahedron::FormFactorTetrahedron "FormFactorTetrahedron::FormFactorTetrahedron(const std::vector< double > P)
Constructor of a truncated tethrahedron.
@@ -4745,6 +4733,9 @@ alpha:
dihedral angle in radians between base and facet
";
+%feature("docstring") FormFactorTetrahedron::FormFactorTetrahedron "FormFactorTetrahedron::FormFactorTetrahedron(double base_edge, double height, double alpha)
+";
+
%feature("docstring") FormFactorTetrahedron::clone "FormFactorTetrahedron* FormFactorTetrahedron::clone() const override final
Returns a clone of this ISample object.
@@ -4773,6 +4764,9 @@ A planar equilateral triangle, for testing form factor computations.
C++ includes: FormFactorTriangle.h
";
+%feature("docstring") FormFactorTriangle::FormFactorTriangle "FormFactorTriangle::FormFactorTriangle(const std::vector< double > P)
+";
+
%feature("docstring") FormFactorTriangle::FormFactorTriangle "FormFactorTriangle::FormFactorTriangle(double base_edge)
";
@@ -4798,7 +4792,7 @@ A cube, with tetrahedral truncation of all corners
C++ includes: FormFactorTruncatedCube.h
";
-%feature("docstring") FormFactorTruncatedCube::FormFactorTruncatedCube "FormFactorTruncatedCube::FormFactorTruncatedCube(double length, double removed_length)
+%feature("docstring") FormFactorTruncatedCube::FormFactorTruncatedCube "FormFactorTruncatedCube::FormFactorTruncatedCube(const std::vector< double > P)
Constructor of a truncated cube.
@@ -4812,6 +4806,9 @@ removed_length:
removed length from each edge of the cube in nanometers
";
+%feature("docstring") FormFactorTruncatedCube::FormFactorTruncatedCube "FormFactorTruncatedCube::FormFactorTruncatedCube(double length, double removed_length)
+";
+
%feature("docstring") FormFactorTruncatedCube::clone "FormFactorTruncatedCube* FormFactorTruncatedCube::clone() const override final
Returns a clone of this ISample object.
@@ -4837,7 +4834,7 @@ A truncated Sphere.
C++ includes: FormFactorTruncatedSphere.h
";
-%feature("docstring") FormFactorTruncatedSphere::FormFactorTruncatedSphere "FormFactorTruncatedSphere::FormFactorTruncatedSphere(double radius, double height, double dh=0.0)
+%feature("docstring") FormFactorTruncatedSphere::FormFactorTruncatedSphere "FormFactorTruncatedSphere::FormFactorTruncatedSphere(const std::vector< double > P)
Constructor of a spherical dome.
@@ -4854,6 +4851,9 @@ dh:
length of cup truncated from the top
";
+%feature("docstring") FormFactorTruncatedSphere::FormFactorTruncatedSphere "FormFactorTruncatedSphere::FormFactorTruncatedSphere(double radius, double height, double dh)
+";
+
%feature("docstring") FormFactorTruncatedSphere::clone "FormFactorTruncatedSphere* FormFactorTruncatedSphere::clone() const override final
Returns a clone of this ISample object.
@@ -4892,7 +4892,7 @@ A truncated spheroid. An ellipsoid with two equal axis, truncated by a plane per
C++ includes: FormFactorTruncatedSpheroid.h
";
-%feature("docstring") FormFactorTruncatedSpheroid::FormFactorTruncatedSpheroid "FormFactorTruncatedSpheroid::FormFactorTruncatedSpheroid(double radius, double height, double height_flattening, double dh=0.0)
+%feature("docstring") FormFactorTruncatedSpheroid::FormFactorTruncatedSpheroid "FormFactorTruncatedSpheroid::FormFactorTruncatedSpheroid(const std::vector< double > P)
Constructor of a spheroidal dome.
@@ -4912,6 +4912,9 @@ dh:
length of cup truncated from the top
";
+%feature("docstring") FormFactorTruncatedSpheroid::FormFactorTruncatedSpheroid "FormFactorTruncatedSpheroid::FormFactorTruncatedSpheroid(double radius, double height, double height_flattening, double dh)
+";
+
%feature("docstring") FormFactorTruncatedSpheroid::clone "FormFactorTruncatedSpheroid* FormFactorTruncatedSpheroid::clone() const override final
Returns a clone of this ISample object.
@@ -5051,7 +5054,10 @@ prepare arrays for 2D Fourier Transformation (FT) of the given vector
One-dimensional Cauchy decay function in reciprocal space; corresponds to exp(-|x|/decay_length) in real space.
-C++ includes: FTDecayFunctions.h
+C++ includes: FTDecay1D.h
+";
+
+%feature("docstring") FTDecayFunction1DCauchy::FTDecayFunction1DCauchy "FTDecayFunction1DCauchy::FTDecayFunction1DCauchy(const std::vector< double > P)
";
%feature("docstring") FTDecayFunction1DCauchy::FTDecayFunction1DCauchy "FTDecayFunction1DCauchy::FTDecayFunction1DCauchy(double decay_length)
@@ -5074,7 +5080,10 @@ Calls the INodeVisitor's visit method.
One-dimensional Gauss decay function in reciprocal space; corresponds to exp[-x^2/(2*decay_length^2)] in real space.
-C++ includes: FTDecayFunctions.h
+C++ includes: FTDecay1D.h
+";
+
+%feature("docstring") FTDecayFunction1DGauss::FTDecayFunction1DGauss "FTDecayFunction1DGauss::FTDecayFunction1DGauss(const std::vector< double > P)
";
%feature("docstring") FTDecayFunction1DGauss::FTDecayFunction1DGauss "FTDecayFunction1DGauss::FTDecayFunction1DGauss(double decay_length)
@@ -5097,7 +5106,10 @@ Calls the INodeVisitor's visit method.
One-dimensional triangle decay function in reciprocal space; corresponds to 1-|x|/decay_length if |x|<decay_length (and 0 otherwise) in real space.
-C++ includes: FTDecayFunctions.h
+C++ includes: FTDecay1D.h
+";
+
+%feature("docstring") FTDecayFunction1DTriangle::FTDecayFunction1DTriangle "FTDecayFunction1DTriangle::FTDecayFunction1DTriangle(const std::vector< double > P)
";
%feature("docstring") FTDecayFunction1DTriangle::FTDecayFunction1DTriangle "FTDecayFunction1DTriangle::FTDecayFunction1DTriangle(double decay_length)
@@ -5120,10 +5132,10 @@ Calls the INodeVisitor's visit method.
One-dimensional pseudo-Voigt decay function in reciprocal space; corresponds to eta*Gauss + (1-eta)*Cauchy.
-C++ includes: FTDecayFunctions.h
+C++ includes: FTDecay1D.h
";
-%feature("docstring") FTDecayFunction1DVoigt::FTDecayFunction1DVoigt "FTDecayFunction1DVoigt::FTDecayFunction1DVoigt(double decay_length, double eta)
+%feature("docstring") FTDecayFunction1DVoigt::FTDecayFunction1DVoigt "FTDecayFunction1DVoigt::FTDecayFunction1DVoigt(const std::vector< double > P)
Constructor of pseudo-Voigt decay function.
@@ -5137,6 +5149,9 @@ eta:
parameter [0,1] to balance between Cauchy (eta=0.0) and Gauss (eta=1.0)
";
+%feature("docstring") FTDecayFunction1DVoigt::FTDecayFunction1DVoigt "FTDecayFunction1DVoigt::FTDecayFunction1DVoigt(double decay_length, double eta)
+";
+
%feature("docstring") FTDecayFunction1DVoigt::clone "FTDecayFunction1DVoigt * FTDecayFunction1DVoigt::clone() const
";
@@ -5157,10 +5172,13 @@ Calls the INodeVisitor's visit method.
Two-dimensional Cauchy decay function in reciprocal space; corresponds to exp(-r) in real space, with $r=\\\\sqrt{(\\\\frac{x}{\\\\omega_x})^2 + (\\\\frac{y}{\\\\omega_y})^2}$.
-C++ includes: FTDecayFunctions.h
+C++ includes: FTDecay2D.h
+";
+
+%feature("docstring") FTDecayFunction2DCauchy::FTDecayFunction2DCauchy "FTDecayFunction2DCauchy::FTDecayFunction2DCauchy(const std::vector< double > P)
";
-%feature("docstring") FTDecayFunction2DCauchy::FTDecayFunction2DCauchy "FTDecayFunction2DCauchy::FTDecayFunction2DCauchy(double decay_length_x, double decay_length_y, double gamma=0)
+%feature("docstring") FTDecayFunction2DCauchy::FTDecayFunction2DCauchy "FTDecayFunction2DCauchy::FTDecayFunction2DCauchy(double decay_length_x, double decay_length_y, double gamma)
";
%feature("docstring") FTDecayFunction2DCauchy::clone "FTDecayFunction2DCauchy * FTDecayFunction2DCauchy::clone() const
@@ -5182,10 +5200,13 @@ evaluate Fourier transformed decay function for q in X,Y coordinates
Two-dimensional Gauss decay function in reciprocal space; corresponds to exp(-r^2/2) in real space, with $r=\\\\sqrt{(\\\\frac{x}{\\\\omega_x})^2 + (\\\\frac{y}{\\\\omega_y})^2}$.
-C++ includes: FTDecayFunctions.h
+C++ includes: FTDecay2D.h
+";
+
+%feature("docstring") FTDecayFunction2DGauss::FTDecayFunction2DGauss "FTDecayFunction2DGauss::FTDecayFunction2DGauss(const std::vector< double > P)
";
-%feature("docstring") FTDecayFunction2DGauss::FTDecayFunction2DGauss "FTDecayFunction2DGauss::FTDecayFunction2DGauss(double decay_length_x, double decay_length_y, double gamma=0)
+%feature("docstring") FTDecayFunction2DGauss::FTDecayFunction2DGauss "FTDecayFunction2DGauss::FTDecayFunction2DGauss(double decay_length_x, double decay_length_y, double gamma)
";
%feature("docstring") FTDecayFunction2DGauss::clone "FTDecayFunction2DGauss * FTDecayFunction2DGauss::clone() const
@@ -5207,10 +5228,10 @@ evaluate Fourier transformed decay function for q in X,Y coordinates
Two-dimensional pseudo-Voigt decay function in reciprocal space; corresponds to eta*Gauss + (1-eta)*Cauchy.
-C++ includes: FTDecayFunctions.h
+C++ includes: FTDecay2D.h
";
-%feature("docstring") FTDecayFunction2DVoigt::FTDecayFunction2DVoigt "FTDecayFunction2DVoigt::FTDecayFunction2DVoigt(double decay_length_x, double decay_length_y, double eta, double gamma=0)
+%feature("docstring") FTDecayFunction2DVoigt::FTDecayFunction2DVoigt "FTDecayFunction2DVoigt::FTDecayFunction2DVoigt(const std::vector< double > P)
Constructor of two-dimensional pseudo-Voigt decay function in reciprocal space.
@@ -5230,6 +5251,9 @@ gamma:
distribution orientation with respect to the first lattice vector in radians
";
+%feature("docstring") FTDecayFunction2DVoigt::FTDecayFunction2DVoigt "FTDecayFunction2DVoigt::FTDecayFunction2DVoigt(double decay_length_x, double decay_length_y, double gamma, double eta)
+";
+
%feature("docstring") FTDecayFunction2DVoigt::clone "FTDecayFunction2DVoigt * FTDecayFunction2DVoigt::clone() const
";
@@ -5255,6 +5279,9 @@ Exponential IFTDistribution1D exp(-|omega*x|); its Fourier transform evaluate(q
C++ includes: FTDistributions1D.h
";
+%feature("docstring") FTDistribution1DCauchy::FTDistribution1DCauchy "FTDistribution1DCauchy::FTDistribution1DCauchy(const std::vector< double > P)
+";
+
%feature("docstring") FTDistribution1DCauchy::FTDistribution1DCauchy "FTDistribution1DCauchy::FTDistribution1DCauchy(double omega)
";
@@ -5288,6 +5315,9 @@ IFTDistribution1D consisting of one cosine wave [1+cos(pi*x/omega) if |x|<omega,
C++ includes: FTDistributions1D.h
";
+%feature("docstring") FTDistribution1DCosine::FTDistribution1DCosine "FTDistribution1DCosine::FTDistribution1DCosine(const std::vector< double > P)
+";
+
%feature("docstring") FTDistribution1DCosine::FTDistribution1DCosine "FTDistribution1DCosine::FTDistribution1DCosine(double omega)
";
@@ -5321,6 +5351,9 @@ Square gate IFTDistribution1D; its Fourier transform evaluate(q) is a sinc func
C++ includes: FTDistributions1D.h
";
+%feature("docstring") FTDistribution1DGate::FTDistribution1DGate "FTDistribution1DGate::FTDistribution1DGate(const std::vector< double > P)
+";
+
%feature("docstring") FTDistribution1DGate::FTDistribution1DGate "FTDistribution1DGate::FTDistribution1DGate(double omega)
";
@@ -5354,6 +5387,9 @@ Gaussian IFTDistribution1D; its Fourier transform evaluate(q) is a Gaussian sta
C++ includes: FTDistributions1D.h
";
+%feature("docstring") FTDistribution1DGauss::FTDistribution1DGauss "FTDistribution1DGauss::FTDistribution1DGauss(const std::vector< double > P)
+";
+
%feature("docstring") FTDistribution1DGauss::FTDistribution1DGauss "FTDistribution1DGauss::FTDistribution1DGauss(double omega)
";
@@ -5387,6 +5423,9 @@ Triangle IFTDistribution1D [1-|x|/omega if |x|<omega, and 0 otherwise]; its Fou
C++ includes: FTDistributions1D.h
";
+%feature("docstring") FTDistribution1DTriangle::FTDistribution1DTriangle "FTDistribution1DTriangle::FTDistribution1DTriangle(const std::vector< double > P)
+";
+
%feature("docstring") FTDistribution1DTriangle::FTDistribution1DTriangle "FTDistribution1DTriangle::FTDistribution1DTriangle(double omega)
";
@@ -5420,7 +5459,7 @@ IFTDistribution1D that provides a Fourier transform evaluate(q) in form of a pse
C++ includes: FTDistributions1D.h
";
-%feature("docstring") FTDistribution1DVoigt::FTDistribution1DVoigt "FTDistribution1DVoigt::FTDistribution1DVoigt(double omega, double eta)
+%feature("docstring") FTDistribution1DVoigt::FTDistribution1DVoigt "FTDistribution1DVoigt::FTDistribution1DVoigt(const std::vector< double > P)
Constructor of one-dimensional pseudo-Voigt probability distribution.
@@ -5434,6 +5473,9 @@ eta:
parameter [0,1] to balance between Cauchy (eta=0.0) and Gauss (eta=1.0)
";
+%feature("docstring") FTDistribution1DVoigt::FTDistribution1DVoigt "FTDistribution1DVoigt::FTDistribution1DVoigt(double omega, double eta)
+";
+
%feature("docstring") FTDistribution1DVoigt::clone "FTDistribution1DVoigt * FTDistribution1DVoigt::clone() const override final
";
@@ -5467,7 +5509,10 @@ Two-dimensional Cauchy distribution in Fourier space; corresponds to a normalize
C++ includes: FTDistributions2D.h
";
-%feature("docstring") FTDistribution2DCauchy::FTDistribution2DCauchy "FTDistribution2DCauchy::FTDistribution2DCauchy(double omega_x, double omega_y, double gamma=0)
+%feature("docstring") FTDistribution2DCauchy::FTDistribution2DCauchy "FTDistribution2DCauchy::FTDistribution2DCauchy(const std::vector< double > P)
+";
+
+%feature("docstring") FTDistribution2DCauchy::FTDistribution2DCauchy "FTDistribution2DCauchy::FTDistribution2DCauchy(double omega_x, double omega_y, double gamma)
";
%feature("docstring") FTDistribution2DCauchy::clone "FTDistribution2DCauchy * FTDistribution2DCauchy::clone() const final
@@ -5507,7 +5552,10 @@ Two-dimensional cone distribution in Fourier space; corresponds to 1-r if r<1 (a
C++ includes: FTDistributions2D.h
";
-%feature("docstring") FTDistribution2DCone::FTDistribution2DCone "FTDistribution2DCone::FTDistribution2DCone(double omega_x, double omega_y, double gamma=0)
+%feature("docstring") FTDistribution2DCone::FTDistribution2DCone "FTDistribution2DCone::FTDistribution2DCone(const std::vector< double > P)
+";
+
+%feature("docstring") FTDistribution2DCone::FTDistribution2DCone "FTDistribution2DCone::FTDistribution2DCone(double omega_x, double omega_y, double gamma)
";
%feature("docstring") FTDistribution2DCone::clone "FTDistribution2DCone * FTDistribution2DCone::clone() const final
@@ -5535,7 +5583,10 @@ Two-dimensional gate distribution in Fourier space; corresponds to normalized co
C++ includes: FTDistributions2D.h
";
-%feature("docstring") FTDistribution2DGate::FTDistribution2DGate "FTDistribution2DGate::FTDistribution2DGate(double omega_x, double omega_y, double gamma=0)
+%feature("docstring") FTDistribution2DGate::FTDistribution2DGate "FTDistribution2DGate::FTDistribution2DGate(const std::vector< double > P)
+";
+
+%feature("docstring") FTDistribution2DGate::FTDistribution2DGate "FTDistribution2DGate::FTDistribution2DGate(double omega_x, double omega_y, double gamma)
";
%feature("docstring") FTDistribution2DGate::clone "FTDistribution2DGate * FTDistribution2DGate::clone() const final
@@ -5563,7 +5614,10 @@ Two-dimensional Gauss distribution in Fourier space; corresponds to normalized e
C++ includes: FTDistributions2D.h
";
-%feature("docstring") FTDistribution2DGauss::FTDistribution2DGauss "FTDistribution2DGauss::FTDistribution2DGauss(double omega_x, double omega_y, double gamma=0)
+%feature("docstring") FTDistribution2DGauss::FTDistribution2DGauss "FTDistribution2DGauss::FTDistribution2DGauss(const std::vector< double > P)
+";
+
+%feature("docstring") FTDistribution2DGauss::FTDistribution2DGauss "FTDistribution2DGauss::FTDistribution2DGauss(double omega_x, double omega_y, double gamma)
";
%feature("docstring") FTDistribution2DGauss::clone "FTDistribution2DGauss * FTDistribution2DGauss::clone() const final
@@ -5591,7 +5645,7 @@ Two-dimensional Voigt distribution in Fourier space; corresponds to eta*Gauss +
C++ includes: FTDistributions2D.h
";
-%feature("docstring") FTDistribution2DVoigt::FTDistribution2DVoigt "FTDistribution2DVoigt::FTDistribution2DVoigt(double omega_x, double omega_y, double eta, double gamma=0)
+%feature("docstring") FTDistribution2DVoigt::FTDistribution2DVoigt "FTDistribution2DVoigt::FTDistribution2DVoigt(const std::vector< double > P)
Constructor of two-dimensional pseudo-Voigt probability distribution.
@@ -5611,6 +5665,9 @@ gamma:
angle in direct space between first lattice vector and x-axis of the distribution in radians
";
+%feature("docstring") FTDistribution2DVoigt::FTDistribution2DVoigt "FTDistribution2DVoigt::FTDistribution2DVoigt(double omega_x, double omega_y, double gamma, double eta)
+";
+
%feature("docstring") FTDistribution2DVoigt::clone "FTDistribution2DVoigt * FTDistribution2DVoigt::clone() const final
";
@@ -5634,7 +5691,7 @@ evaluate Fourier transformed distribution for q in X,Y coordinates the original
// File: classGaussFisherPeakShape.xml
%feature("docstring") GaussFisherPeakShape "
-Class that implements a peak shape that is Gaussian in the radial direction and uses the von Mises-Fisher distribution in the angular direction.
+A peak shape that is Gaussian in the radial direction and uses the Mises-Fisher distribution in the angular direction.
C++ includes: IPeakShape.h
";
@@ -5754,7 +5811,7 @@ C++ includes: PercusYevickBuilder.h
// File: classHexagonalLattice.xml
%feature("docstring") HexagonalLattice "";
-%feature("docstring") HexagonalLattice::HexagonalLattice "HexagonalLattice::HexagonalLattice(double length, double rotation_angle=0.0)
+%feature("docstring") HexagonalLattice::HexagonalLattice "HexagonalLattice::HexagonalLattice(double length, double xi)
";
%feature("docstring") HexagonalLattice::clone "HexagonalLattice * HexagonalLattice::clone() const
@@ -6115,10 +6172,13 @@ Inherited by IParticle and ParticleDistribution.
C++ includes: IAbstractParticle.h
";
-%feature("docstring") IAbstractParticle::IAbstractParticle "IAbstractParticle::IAbstractParticle()
+%feature("docstring") IAbstractParticle::IAbstractParticle "IAbstractParticle::IAbstractParticle()=default
+";
+
+%feature("docstring") IAbstractParticle::IAbstractParticle "IAbstractParticle::IAbstractParticle(const NodeMeta &meta, const std::vector< double > &PValues)
";
-%feature("docstring") IAbstractParticle::~IAbstractParticle "IAbstractParticle::~IAbstractParticle()
+%feature("docstring") IAbstractParticle::~IAbstractParticle "virtual IAbstractParticle::~IAbstractParticle()=default
";
%feature("docstring") IAbstractParticle::clone "virtual IAbstractParticle* IAbstractParticle::clone() const =0
@@ -6242,6 +6302,9 @@ Interface for a simulating the background signal
C++ includes: IBackground.h
";
+%feature("docstring") IBackground::IBackground "IBackground::IBackground(const NodeMeta &meta, const std::vector< double > &PValues)
+";
+
%feature("docstring") IBackground::~IBackground "IBackground::~IBackground()
";
@@ -6305,15 +6368,18 @@ Child classes of ICloneable must provide clone().
C++ includes: ICloneable.h
";
-%feature("docstring") ICloneable::ICloneable "ICloneable::ICloneable()
+%feature("docstring") ICloneable::ICloneable "ICloneable::ICloneable()=default
";
-%feature("docstring") ICloneable::~ICloneable "ICloneable::~ICloneable()
+%feature("docstring") ICloneable::~ICloneable "virtual ICloneable::~ICloneable()=default
";
%feature("docstring") ICloneable::ICloneable "ICloneable::ICloneable(const ICloneable &)=delete
";
+%feature("docstring") ICloneable::ICloneable "ICloneable::ICloneable(ICloneable &&)=default
+";
+
%feature("docstring") ICloneable::clone "virtual ICloneable* ICloneable::clone() const =0
";
@@ -6373,6 +6439,18 @@ C++ includes: IComputation.h
";
+// File: classICosineRipple.xml
+%feature("docstring") ICosineRipple "
+
+Base class for form factors with a cosine ripple profile in the yz plane.
+
+C++ includes: IProfileRipple.h
+";
+
+%feature("docstring") ICosineRipple::ICosineRipple "ICosineRipple::ICosineRipple(const NodeMeta &meta, const std::vector< double > &PValues)
+";
+
+
// File: classIdentityRotation.xml
%feature("docstring") IdentityRotation "
@@ -6381,12 +6459,10 @@ The identity rotation, which leaves everything in place.
C++ includes: Rotations.h
";
-%feature("docstring") IdentityRotation::IdentityRotation "IdentityRotation::IdentityRotation()=default
+%feature("docstring") IdentityRotation::IdentityRotation "IdentityRotation::IdentityRotation()
";
%feature("docstring") IdentityRotation::clone "IdentityRotation* IdentityRotation::clone() const
-
-Returns a clone of this ISample object.
";
%feature("docstring") IdentityRotation::createInverse "IdentityRotation* IdentityRotation::createInverse() const
@@ -6656,10 +6732,7 @@ Interface for one-dimensional distributions.
C++ includes: Distributions.h
";
-%feature("docstring") IDistribution1D::IDistribution1D "IDistribution1D::IDistribution1D()
-";
-
-%feature("docstring") IDistribution1D::~IDistribution1D "virtual IDistribution1D::~IDistribution1D()
+%feature("docstring") IDistribution1D::IDistribution1D "IDistribution1D::IDistribution1D(const NodeMeta &meta, const std::vector< double > &PValues)
";
%feature("docstring") IDistribution1D::clone "virtual IDistribution1D* IDistribution1D::clone() const =0
@@ -6740,10 +6813,10 @@ Abstract base for classes that calculate the beam footprint factor
C++ includes: IFootprintFactor.h
";
-%feature("docstring") IFootprintFactor::IFootprintFactor "IFootprintFactor::IFootprintFactor()=delete
+%feature("docstring") IFootprintFactor::IFootprintFactor "IFootprintFactor::IFootprintFactor(const NodeMeta &meta, const std::vector< double > &PValues)
";
-%feature("docstring") IFootprintFactor::IFootprintFactor "IFootprintFactor::IFootprintFactor(double width_ratio)
+%feature("docstring") IFootprintFactor::IFootprintFactor "IFootprintFactor::IFootprintFactor()=delete
";
%feature("docstring") IFootprintFactor::~IFootprintFactor "IFootprintFactor::~IFootprintFactor()
@@ -6784,7 +6857,7 @@ C++ includes: IFormFactor.h
%feature("docstring") IFormFactor::IFormFactor "IFormFactor::IFormFactor()=default
";
-%feature("docstring") IFormFactor::IFormFactor "IFormFactor::IFormFactor(const INode *parent, const std::vector< const char * > PName, const std::vector< const char * > PUnit, const std::vector< double > PMin, const std::vector< double > PMax, const std::vector< double > PDefault, std::vector< double > P)
+%feature("docstring") IFormFactor::IFormFactor "IFormFactor::IFormFactor(const NodeMeta &meta, const std::vector< double > &PValues)
";
%feature("docstring") IFormFactor::~IFormFactor "IFormFactor::~IFormFactor()=default
@@ -6854,7 +6927,7 @@ C++ includes: IFormFactorBorn.h
%feature("docstring") IFormFactorBorn::IFormFactorBorn "IFormFactorBorn::IFormFactorBorn()=default
";
-%feature("docstring") IFormFactorBorn::IFormFactorBorn "IFormFactorBorn::IFormFactorBorn(const INode *parent, const std::vector< const char * > PName, const std::vector< const char * > PUnit, const std::vector< double > PMin, const std::vector< double > PMax, const std::vector< double > PDefault, std::vector< double > P)
+%feature("docstring") IFormFactorBorn::IFormFactorBorn "IFormFactorBorn::IFormFactorBorn(const NodeMeta &meta, const std::vector< double > &PValues)
";
%feature("docstring") IFormFactorBorn::clone "IFormFactorBorn* IFormFactorBorn::clone() const override=0
@@ -6984,18 +7057,10 @@ Disables caching of previously computed Fresnel coefficients.
Interface for a one-dimensional decay function, with evaluate(q) returning the Fourier transform, normalized to $\\\\int dq\\\\; {\\\\rm evaluate}(q) = 1$.
-C++ includes: FTDecayFunctions.h
+C++ includes: FTDecay1D.h
";
-%feature("docstring") IFTDecayFunction1D::IFTDecayFunction1D "IFTDecayFunction1D::IFTDecayFunction1D(double decay_length)
-
-Constructor of one-dimensional decay function.
-
-Parameters:
------------
-
-decay_length:
-half-width of the distribution in nanometers
+%feature("docstring") IFTDecayFunction1D::IFTDecayFunction1D "IFTDecayFunction1D::IFTDecayFunction1D(const NodeMeta &meta, const std::vector< double > &PValues)
";
%feature("docstring") IFTDecayFunction1D::clone "virtual IFTDecayFunction1D* IFTDecayFunction1D::clone() const =0
@@ -7013,39 +7078,15 @@ half-width of the distribution in nanometers
Interface for two-dimensional decay function in reciprocal space.
-C++ includes: FTDecayFunctions.h
+C++ includes: FTDecay2D.h
";
-%feature("docstring") IFTDecayFunction2D::IFTDecayFunction2D "IFTDecayFunction2D::IFTDecayFunction2D(double decay_length_x, double decay_length_y, double gamma=0)
-
-Constructor of two-dimensional decay function in reciprocal space.
-
-Parameters:
------------
-
-decay_length_x:
-the decay length in nanometers along x-axis of the distribution
-
-decay_length_y:
-the decay length in nanometers along y-axis of the distribution
-
-gamma:
-distribution orientation with respect to the corresponding lattice vector in radians
+%feature("docstring") IFTDecayFunction2D::IFTDecayFunction2D "IFTDecayFunction2D::IFTDecayFunction2D(const NodeMeta &meta, const std::vector< double > &PValues)
";
%feature("docstring") IFTDecayFunction2D::clone "virtual IFTDecayFunction2D* IFTDecayFunction2D::clone() const =0
";
-%feature("docstring") IFTDecayFunction2D::setGamma "void IFTDecayFunction2D::setGamma(double gamma)
-
-set angle between first lattice vector and X-axis of distribution (both in direct space)
-";
-
-%feature("docstring") IFTDecayFunction2D::gamma "double IFTDecayFunction2D::gamma() const
-
-get angle between first lattice vector and X-axis of distribution (both in direct space)
-";
-
%feature("docstring") IFTDecayFunction2D::decayLengthX "double IFTDecayFunction2D::decayLengthX() const
get decay length in distribution's X-direction
@@ -7056,6 +7097,11 @@ get decay length in distribution's X-direction
get decay length in distribution's Y-direction
";
+%feature("docstring") IFTDecayFunction2D::gamma "double IFTDecayFunction2D::gamma() const
+
+get angle between first lattice vector and X-axis of distribution (both in direct space)
+";
+
%feature("docstring") IFTDecayFunction2D::evaluate "virtual double IFTDecayFunction2D::evaluate(double qx, double qy) const =0
evaluate Fourier transformed decay function for q in X,Y coordinates
@@ -7077,18 +7123,7 @@ Interface for a one-dimensional distribution, with normalization adjusted so tha
C++ includes: FTDistributions1D.h
";
-%feature("docstring") IFTDistribution1D::IFTDistribution1D "IFTDistribution1D::IFTDistribution1D(double omega)
-
-Constructor of one-dimensional probability distribution.
-
-Parameters:
------------
-
-omega:
-half-width of the distribution in nanometers
-";
-
-%feature("docstring") IFTDistribution1D::~IFTDistribution1D "IFTDistribution1D::~IFTDistribution1D()
+%feature("docstring") IFTDistribution1D::IFTDistribution1D "IFTDistribution1D::IFTDistribution1D(const NodeMeta &meta, const std::vector< double > &PValues)
";
%feature("docstring") IFTDistribution1D::clone "virtual IFTDistribution1D* IFTDistribution1D::clone() const =0
@@ -7099,9 +7134,6 @@ half-width of the distribution in nanometers
Returns Fourier transform of this distribution; is a decay function starting at evaluate(0)=1.
";
-%feature("docstring") IFTDistribution1D::setOmega "void IFTDistribution1D::setOmega(double omega)
-";
-
%feature("docstring") IFTDistribution1D::omega "double IFTDistribution1D::omega() const
";
@@ -7122,39 +7154,24 @@ Interface for two-dimensional distributions in Fourier space.
C++ includes: FTDistributions2D.h
";
-%feature("docstring") IFTDistribution2D::IFTDistribution2D "IFTDistribution2D::IFTDistribution2D(double omega_x, double omega_y, double gamma=0)
-
-Constructor of two-dimensional probability distribution.
-
-Parameters:
------------
-
-omega_x:
-half-width of the distribution along its x-axis in nanometers
-
-omega_y:
-half-width of the distribution along its y-axis in nanometers
-
-gamma:
-angle in direct space between first lattice vector and x-axis of the distribution
+%feature("docstring") IFTDistribution2D::IFTDistribution2D "IFTDistribution2D::IFTDistribution2D(const NodeMeta &meta, const std::vector< double > &PValues)
";
%feature("docstring") IFTDistribution2D::clone "IFTDistribution2D* IFTDistribution2D::clone() const =0
";
-%feature("docstring") IFTDistribution2D::setGamma "void IFTDistribution2D::setGamma(double gamma)
+%feature("docstring") IFTDistribution2D::omegaX "double IFTDistribution2D::omegaX() const
";
-%feature("docstring") IFTDistribution2D::gamma "double IFTDistribution2D::gamma() const
+%feature("docstring") IFTDistribution2D::omegaY "double IFTDistribution2D::omegaY() const
";
-%feature("docstring") IFTDistribution2D::delta "double IFTDistribution2D::delta() const
+%feature("docstring") IFTDistribution2D::gamma "double IFTDistribution2D::gamma() const
";
-%feature("docstring") IFTDistribution2D::omegaX "double IFTDistribution2D::omegaX() const
-";
+%feature("docstring") IFTDistribution2D::delta "double IFTDistribution2D::delta() const
-%feature("docstring") IFTDistribution2D::omegaY "double IFTDistribution2D::omegaY() const
+Angle in direct space between X- and Y-axis of distribution.
";
%feature("docstring") IFTDistribution2D::evaluate "virtual double IFTDistribution2D::evaluate(double qx, double qy) const =0
@@ -7482,30 +7499,6 @@ C++ includes: IIntensityFunction.h
";
-// File: classIIntensityNormalizer.xml
-%feature("docstring") IIntensityNormalizer "
-
-Interface to OutputData normalizers.
-
-C++ includes: IIntensityNormalizer.h
-";
-
-%feature("docstring") IIntensityNormalizer::~IIntensityNormalizer "virtual IIntensityNormalizer::~IIntensityNormalizer()
-";
-
-%feature("docstring") IIntensityNormalizer::clone "virtual IIntensityNormalizer* IIntensityNormalizer::clone() const =0
-";
-
-%feature("docstring") IIntensityNormalizer::createNormalizedData "virtual OutputData<double>* IIntensityNormalizer::createNormalizedData(const OutputData< double > &data) const =0
-";
-
-%feature("docstring") IIntensityNormalizer::apply "virtual void IIntensityNormalizer::apply(OutputData< double > &data) const =0
-";
-
-%feature("docstring") IIntensityNormalizer::setMaximumIntensity "virtual void IIntensityNormalizer::setMaximumIntensity(double)=0
-";
-
-
// File: classIInterferenceFunction.xml
%feature("docstring") IInterferenceFunction "
@@ -7514,13 +7507,10 @@ Pure virtual base class of interference functions.
C++ includes: IInterferenceFunction.h
";
-%feature("docstring") IInterferenceFunction::IInterferenceFunction "IInterferenceFunction::IInterferenceFunction()
-";
-
-%feature("docstring") IInterferenceFunction::IInterferenceFunction "IInterferenceFunction::IInterferenceFunction(const IInterferenceFunction &other)
+%feature("docstring") IInterferenceFunction::IInterferenceFunction "IInterferenceFunction::IInterferenceFunction(const NodeMeta &meta, const std::vector< double > &PValues)
";
-%feature("docstring") IInterferenceFunction::~IInterferenceFunction "IInterferenceFunction::~IInterferenceFunction()
+%feature("docstring") IInterferenceFunction::IInterferenceFunction "IInterferenceFunction::IInterferenceFunction(double position_var)
";
%feature("docstring") IInterferenceFunction::clone "virtual IInterferenceFunction* IInterferenceFunction::clone() const =0
@@ -7789,7 +7779,7 @@ C++ includes: INode.h
%feature("docstring") INode::INode "INode::INode()
";
-%feature("docstring") INode::INode "INode::INode(const INode *parent, const std::vector< const char * > PName, const std::vector< const char * > PUnit, const std::vector< double > PMin, const std::vector< double > PMax, const std::vector< double > PDefault, std::vector< double > P)
+%feature("docstring") INode::INode "INode::INode(const NodeMeta &meta, const std::vector< double > &PValues)
";
%feature("docstring") INode::~INode "virtual INode::~INode()
@@ -7956,12 +7946,15 @@ C++ includes: INodeVisitor.h
%feature("docstring") INodeVisitor::visit "virtual void INodeVisitor::visit(const FormFactorFullSpheroid *)
";
-%feature("docstring") INodeVisitor::visit "virtual void INodeVisitor::visit(const FormFactorGauss *)
+%feature("docstring") INodeVisitor::visit "virtual void INodeVisitor::visit(const FormFactorGaussSphere *)
";
%feature("docstring") INodeVisitor::visit "virtual void INodeVisitor::visit(const FormFactorHemiEllipsoid *)
";
+%feature("docstring") INodeVisitor::visit "virtual void INodeVisitor::visit(const FormFactorHollowSphere *)
+";
+
%feature("docstring") INodeVisitor::visit "virtual void INodeVisitor::visit(const FormFactorIcosahedron *)
";
@@ -7971,9 +7964,6 @@ C++ includes: INodeVisitor.h
%feature("docstring") INodeVisitor::visit "virtual void INodeVisitor::visit(const FormFactorLongBoxLorentz *)
";
-%feature("docstring") INodeVisitor::visit "virtual void INodeVisitor::visit(const FormFactorLorentz *)
-";
-
%feature("docstring") INodeVisitor::visit "virtual void INodeVisitor::visit(const FormFactorPrism3 *)
";
@@ -7983,22 +7973,22 @@ C++ includes: INodeVisitor.h
%feature("docstring") INodeVisitor::visit "virtual void INodeVisitor::visit(const FormFactorPyramid *)
";
-%feature("docstring") INodeVisitor::visit "virtual void INodeVisitor::visit(const FormFactorRipple1Box *)
+%feature("docstring") INodeVisitor::visit "virtual void INodeVisitor::visit(const FormFactorCosineRippleBox *)
";
-%feature("docstring") INodeVisitor::visit "virtual void INodeVisitor::visit(const FormFactorRipple1Gauss *)
+%feature("docstring") INodeVisitor::visit "virtual void INodeVisitor::visit(const FormFactorCosineRippleGauss *)
";
-%feature("docstring") INodeVisitor::visit "virtual void INodeVisitor::visit(const FormFactorRipple1Lorentz *)
+%feature("docstring") INodeVisitor::visit "virtual void INodeVisitor::visit(const FormFactorCosineRippleLorentz *)
";
-%feature("docstring") INodeVisitor::visit "virtual void INodeVisitor::visit(const FormFactorRipple2Box *)
+%feature("docstring") INodeVisitor::visit "virtual void INodeVisitor::visit(const FormFactorSawtoothRippleBox *)
";
-%feature("docstring") INodeVisitor::visit "virtual void INodeVisitor::visit(const FormFactorRipple2Gauss *)
+%feature("docstring") INodeVisitor::visit "virtual void INodeVisitor::visit(const FormFactorSawtoothRippleGauss *)
";
-%feature("docstring") INodeVisitor::visit "virtual void INodeVisitor::visit(const FormFactorRipple2Lorentz *)
+%feature("docstring") INodeVisitor::visit "virtual void INodeVisitor::visit(const FormFactorSawtoothRippleLorentz *)
";
%feature("docstring") INodeVisitor::visit "virtual void INodeVisitor::visit(const FormFactorSphereGaussianRadius *)
@@ -8112,12 +8102,6 @@ C++ includes: INodeVisitor.h
%feature("docstring") INodeVisitor::visit "virtual void INodeVisitor::visit(const Instrument *)
";
-%feature("docstring") INodeVisitor::visit "virtual void INodeVisitor::visit(const IntensityNormalizer *)
-";
-
-%feature("docstring") INodeVisitor::visit "virtual void INodeVisitor::visit(const IntensityScaleAndShiftNormalizer *)
-";
-
%feature("docstring") INodeVisitor::visit "virtual void INodeVisitor::visit(const InterferenceFunction1DLattice *)
";
@@ -8424,131 +8408,73 @@ C++ includes: IIntensityFunction.h
";
-// File: classIntensityNormalizer.xml
-%feature("docstring") IntensityNormalizer "
+// File: classInterferenceFunction1DLattice.xml
+%feature("docstring") InterferenceFunction1DLattice "
-Standard OutputData normalizer, with configurable max_intensity.
+Interference function of a 1D lattice.
-C++ includes: IIntensityNormalizer.h
+C++ includes: InterferenceFunction1DLattice.h
";
-%feature("docstring") IntensityNormalizer::IntensityNormalizer "IntensityNormalizer::IntensityNormalizer(double scale=1.0, double shift=0.0)
-";
+%feature("docstring") InterferenceFunction1DLattice::InterferenceFunction1DLattice "InterferenceFunction1DLattice::InterferenceFunction1DLattice(double length, double xi)
-%feature("docstring") IntensityNormalizer::~IntensityNormalizer "virtual IntensityNormalizer::~IntensityNormalizer()
-";
+Constructor of interference function of one-dimensional lattice.
-%feature("docstring") IntensityNormalizer::clone "IntensityNormalizer * IntensityNormalizer::clone() const
-";
+Parameters:
+-----------
-%feature("docstring") IntensityNormalizer::accept "void IntensityNormalizer::accept(INodeVisitor *visitor) const
+length:
+lattice constant in nanometers
-Calls the INodeVisitor's visit method.
+xi:
+rotation of lattice with respect to x-axis in radians
";
-%feature("docstring") IntensityNormalizer::createNormalizedData "OutputData< double > * IntensityNormalizer::createNormalizedData(const OutputData< double > &data) const
+%feature("docstring") InterferenceFunction1DLattice::~InterferenceFunction1DLattice "InterferenceFunction1DLattice::~InterferenceFunction1DLattice() final
";
-%feature("docstring") IntensityNormalizer::apply "void IntensityNormalizer::apply(OutputData< double > &data) const final
+%feature("docstring") InterferenceFunction1DLattice::clone "InterferenceFunction1DLattice * InterferenceFunction1DLattice::clone() const override final
+
+Returns a clone of this ISample object.
";
-%feature("docstring") IntensityNormalizer::setMaximumIntensity "virtual void IntensityNormalizer::setMaximumIntensity(double max_intensity)
+%feature("docstring") InterferenceFunction1DLattice::accept "void InterferenceFunction1DLattice::accept(INodeVisitor *visitor) const override final
+
+Calls the INodeVisitor's visit method.
";
+%feature("docstring") InterferenceFunction1DLattice::setDecayFunction "void InterferenceFunction1DLattice::setDecayFunction(const IFTDecayFunction1D &decay)
-// File: classIntensityScaleAndShiftNormalizer.xml
-%feature("docstring") IntensityScaleAndShiftNormalizer "
+Sets one-dimensional decay function.
-Simplified OutputData normalizer, with max_intensity=1.
+Parameters:
+-----------
-C++ includes: IIntensityNormalizer.h
+decay:
+one-dimensional decay function in reciprocal space
";
-%feature("docstring") IntensityScaleAndShiftNormalizer::IntensityScaleAndShiftNormalizer "IntensityScaleAndShiftNormalizer::IntensityScaleAndShiftNormalizer(double scale=1.0, double shift=0.0)
+%feature("docstring") InterferenceFunction1DLattice::getLength "double InterferenceFunction1DLattice::getLength() const
";
-%feature("docstring") IntensityScaleAndShiftNormalizer::~IntensityScaleAndShiftNormalizer "IntensityScaleAndShiftNormalizer::~IntensityScaleAndShiftNormalizer() final
+%feature("docstring") InterferenceFunction1DLattice::getXi "double InterferenceFunction1DLattice::getXi() const
";
-%feature("docstring") IntensityScaleAndShiftNormalizer::accept "void IntensityScaleAndShiftNormalizer::accept(INodeVisitor *visitor) const final
+%feature("docstring") InterferenceFunction1DLattice::getChildren "std::vector< const INode * > InterferenceFunction1DLattice::getChildren() const override final
-Calls the INodeVisitor's visit method.
+Returns a vector of children (const).
";
-%feature("docstring") IntensityScaleAndShiftNormalizer::setMaximumIntensity "void IntensityScaleAndShiftNormalizer::setMaximumIntensity(double) final
-";
-%feature("docstring") IntensityScaleAndShiftNormalizer::clone "IntensityScaleAndShiftNormalizer* IntensityScaleAndShiftNormalizer::clone() const final
-";
-
-
-// File: classInterferenceFunction1DLattice.xml
-%feature("docstring") InterferenceFunction1DLattice "
-
-Interference function of a 1D lattice.
-
-C++ includes: InterferenceFunction1DLattice.h
-";
-
-%feature("docstring") InterferenceFunction1DLattice::InterferenceFunction1DLattice "InterferenceFunction1DLattice::InterferenceFunction1DLattice(double length, double xi)
-
-Constructor of interference function of one-dimensional lattice.
-
-Parameters:
------------
-
-length:
-lattice constant in nanometers
-
-xi:
-rotation of lattice with respect to x-axis in radians
-";
-
-%feature("docstring") InterferenceFunction1DLattice::~InterferenceFunction1DLattice "InterferenceFunction1DLattice::~InterferenceFunction1DLattice() final
-";
-
-%feature("docstring") InterferenceFunction1DLattice::clone "InterferenceFunction1DLattice * InterferenceFunction1DLattice::clone() const override final
-
-Returns a clone of this ISample object.
-";
-
-%feature("docstring") InterferenceFunction1DLattice::accept "void InterferenceFunction1DLattice::accept(INodeVisitor *visitor) const override final
-
-Calls the INodeVisitor's visit method.
-";
-
-%feature("docstring") InterferenceFunction1DLattice::setDecayFunction "void InterferenceFunction1DLattice::setDecayFunction(const IFTDecayFunction1D &decay)
-
-Sets one-dimensional decay function.
-
-Parameters:
------------
-
-decay:
-one-dimensional decay function in reciprocal space
-";
-
-%feature("docstring") InterferenceFunction1DLattice::getLatticeParameters "Lattice1DParameters InterferenceFunction1DLattice::getLatticeParameters() const
-";
-
-%feature("docstring") InterferenceFunction1DLattice::getChildren "std::vector< const INode * > InterferenceFunction1DLattice::getChildren() const override final
-
-Returns a vector of children (const).
-";
-
-
-// File: classInterferenceFunction2DLattice.xml
-%feature("docstring") InterferenceFunction2DLattice "
+// File: classInterferenceFunction2DLattice.xml
+%feature("docstring") InterferenceFunction2DLattice "
Interference function of a 2D lattice.
C++ includes: InterferenceFunction2DLattice.h
";
-%feature("docstring") InterferenceFunction2DLattice::InterferenceFunction2DLattice "InterferenceFunction2DLattice::InterferenceFunction2DLattice(const Lattice2D &lattice)
-";
-
-%feature("docstring") InterferenceFunction2DLattice::InterferenceFunction2DLattice "InterferenceFunction2DLattice::InterferenceFunction2DLattice(double length_1, double length_2, double alpha, double xi=0.0)
+%feature("docstring") InterferenceFunction2DLattice::InterferenceFunction2DLattice "InterferenceFunction2DLattice::InterferenceFunction2DLattice(double length_1, double length_2, double alpha, double xi)
Constructor of two-dimensional interference function.
@@ -8568,6 +8494,9 @@ xi:
rotation of the lattice with respect to the x-axis (beam direction) in radians
";
+%feature("docstring") InterferenceFunction2DLattice::InterferenceFunction2DLattice "InterferenceFunction2DLattice::InterferenceFunction2DLattice(const Lattice2D &lattice)
+";
+
%feature("docstring") InterferenceFunction2DLattice::~InterferenceFunction2DLattice "InterferenceFunction2DLattice::~InterferenceFunction2DLattice() final
";
@@ -8625,10 +8554,10 @@ Interference function of a 2D paracrystal.
C++ includes: InterferenceFunction2DParaCrystal.h
";
-%feature("docstring") InterferenceFunction2DParaCrystal::InterferenceFunction2DParaCrystal "InterferenceFunction2DParaCrystal::InterferenceFunction2DParaCrystal(const Lattice2D &lattice, double damping_length=0.0, double domain_size_1=0.0, double domain_size_2=0.0)
+%feature("docstring") InterferenceFunction2DParaCrystal::InterferenceFunction2DParaCrystal "InterferenceFunction2DParaCrystal::InterferenceFunction2DParaCrystal(const Lattice2D &lattice, double damping_length, double domain_size_1, double domain_size_2)
";
-%feature("docstring") InterferenceFunction2DParaCrystal::InterferenceFunction2DParaCrystal "InterferenceFunction2DParaCrystal::InterferenceFunction2DParaCrystal(double length_1, double length_2, double alpha, double xi=0.0, double damping_length=0.0)
+%feature("docstring") InterferenceFunction2DParaCrystal::InterferenceFunction2DParaCrystal "InterferenceFunction2DParaCrystal::InterferenceFunction2DParaCrystal(double length_1, double length_2, double alpha, double xi, double damping_length)
Constructor of interference function of two-dimensional paracrystal.
@@ -9026,10 +8955,10 @@ M.S. Ripoll & C.F. Tejero (1995) Approximate analytical expression for the direc
C++ includes: InterferenceFunctionHardDisk.h
";
-%feature("docstring") InterferenceFunctionHardDisk::InterferenceFunctionHardDisk "InterferenceFunctionHardDisk::InterferenceFunctionHardDisk(double radius, double density)
+%feature("docstring") InterferenceFunctionHardDisk::InterferenceFunctionHardDisk "InterferenceFunctionHardDisk::InterferenceFunctionHardDisk(double radius, double density, double position_var=0)
";
-%feature("docstring") InterferenceFunctionHardDisk::~InterferenceFunctionHardDisk "InterferenceFunctionHardDisk::~InterferenceFunctionHardDisk() final
+%feature("docstring") InterferenceFunctionHardDisk::~InterferenceFunctionHardDisk "InterferenceFunctionHardDisk::~InterferenceFunctionHardDisk() final=default
";
%feature("docstring") InterferenceFunctionHardDisk::clone "InterferenceFunctionHardDisk * InterferenceFunctionHardDisk::clone() const override final
@@ -9084,7 +9013,7 @@ Interference function of radial paracrystal.
C++ includes: InterferenceFunctionRadialParaCrystal.h
";
-%feature("docstring") InterferenceFunctionRadialParaCrystal::InterferenceFunctionRadialParaCrystal "InterferenceFunctionRadialParaCrystal::InterferenceFunctionRadialParaCrystal(double peak_distance, double damping_length=0.0)
+%feature("docstring") InterferenceFunctionRadialParaCrystal::InterferenceFunctionRadialParaCrystal "InterferenceFunctionRadialParaCrystal::InterferenceFunctionRadialParaCrystal(double peak_distance, double damping_length)
Constructor of interference function of radial paracrystal.
@@ -9486,6 +9415,12 @@ Pure virtual interface class that defines the peak shape of a Bragg peak.
C++ includes: IPeakShape.h
";
+%feature("docstring") IPeakShape::IPeakShape "IPeakShape::IPeakShape()=default
+";
+
+%feature("docstring") IPeakShape::IPeakShape "IPeakShape::IPeakShape(const NodeMeta &meta, const std::vector< double > &PValues)
+";
+
%feature("docstring") IPeakShape::~IPeakShape "IPeakShape::~IPeakShape()
";
@@ -9532,6 +9467,49 @@ C++ includes: IPixel.h
";
+// File: classIProfileRectangularRipple.xml
+%feature("docstring") IProfileRectangularRipple "
+
+Base class for form factors with a rectangular ripple (bar) profile in the yz plane.
+
+C++ includes: IProfileRipple.h
+";
+
+%feature("docstring") IProfileRectangularRipple::IProfileRectangularRipple "IProfileRectangularRipple::IProfileRectangularRipple(const NodeMeta &meta, const std::vector< double > &PValues)
+";
+
+
+// File: classIProfileRipple.xml
+%feature("docstring") IProfileRipple "
+
+Base class for form factors with a cosine ripple profile in the yz plane.
+
+C++ includes: IProfileRipple.h
+";
+
+%feature("docstring") IProfileRipple::IProfileRipple "IProfileRipple::IProfileRipple(const NodeMeta &meta, const std::vector< double > &PValues)
+";
+
+%feature("docstring") IProfileRipple::getLength "double IProfileRipple::getLength() const
+";
+
+%feature("docstring") IProfileRipple::getHeight "double IProfileRipple::getHeight() const
+";
+
+%feature("docstring") IProfileRipple::getWidth "double IProfileRipple::getWidth() const
+";
+
+%feature("docstring") IProfileRipple::radialExtension "double IProfileRipple::radialExtension() const override final
+
+Returns the (approximate in some cases) radial size of the particle of this form factor's shape. This is used for SSCA calculations
+";
+
+%feature("docstring") IProfileRipple::evaluate_for_q "complex_t IProfileRipple::evaluate_for_q(cvector_t q) const override final
+
+Returns scattering amplitude for complex scattering wavevector q=k_i-k_f. This method is public only for convenience of plotting form factors in Python.
+";
+
+
// File: classIRegistry.xml
%feature("docstring") IRegistry "
@@ -9561,7 +9539,7 @@ C++ includes: IResolutionFunction2D.h
%feature("docstring") IResolutionFunction2D::IResolutionFunction2D "IResolutionFunction2D::IResolutionFunction2D()=default
";
-%feature("docstring") IResolutionFunction2D::IResolutionFunction2D "IResolutionFunction2D::IResolutionFunction2D(const INode *parent, const std::vector< const char * > PName, const std::vector< const char * > PUnit, const std::vector< double > PMin, const std::vector< double > PMax, const std::vector< double > PDefault, std::vector< double > P)
+%feature("docstring") IResolutionFunction2D::IResolutionFunction2D "IResolutionFunction2D::IResolutionFunction2D(const NodeMeta &meta, const std::vector< double > &PValues)
";
%feature("docstring") IResolutionFunction2D::~IResolutionFunction2D "virtual IResolutionFunction2D::~IResolutionFunction2D()
@@ -9582,12 +9560,10 @@ Pure virtual interface for rotations.
C++ includes: Rotations.h
";
-%feature("docstring") IRotation::~IRotation "virtual IRotation::~IRotation()
+%feature("docstring") IRotation::IRotation "IRotation::IRotation(const NodeMeta &meta, const std::vector< double > &PValues)
";
%feature("docstring") IRotation::clone "virtual IRotation* IRotation::clone() const =0
-
-Returns a clone of this ISample object.
";
%feature("docstring") IRotation::createInverse "virtual IRotation* IRotation::createInverse() const =0
@@ -9595,21 +9571,22 @@ Returns a clone of this ISample object.
Returns a new IRotation object that is the current object's inverse.
";
-%feature("docstring") IRotation::accept "void IRotation::accept(INodeVisitor *visitor) const
-
-Calls the INodeVisitor's visit method.
-";
-
%feature("docstring") IRotation::getTransform3D "virtual Transform3D IRotation::getTransform3D() const =0
Returns transformation.
";
+%feature("docstring") IRotation::transformed "kvector_t IRotation::transformed(const kvector_t &v) const
+";
+
%feature("docstring") IRotation::isIdentity "bool IRotation::isIdentity() const
Returns true if rotation matrix is identity matrix (no rotations)
";
+%feature("docstring") IRotation::zInvariant "bool IRotation::zInvariant() const
+";
+
// File: classISample.xml
%feature("docstring") ISample "
@@ -9622,7 +9599,7 @@ C++ includes: ISample.h
%feature("docstring") ISample::ISample "ISample::ISample()=default
";
-%feature("docstring") ISample::ISample "ISample::ISample(const INode *parent, const std::vector< const char * > PName, const std::vector< const char * > PUnit, const std::vector< double > PMin, const std::vector< double > PMax, const std::vector< double > PDefault, std::vector< double > P)
+%feature("docstring") ISample::ISample "ISample::ISample(const NodeMeta &meta, const std::vector< double > &PValues)
";
%feature("docstring") ISample::clone "ISample* ISample::clone() const override=0
@@ -9641,6 +9618,21 @@ Returns set of unique materials contained in this ISample.
";
+// File: classISawtoothRipple.xml
+%feature("docstring") ISawtoothRipple "
+
+Base class for form factors with a triangular ripple profile in the yz plane.
+
+C++ includes: IProfileRipple.h
+";
+
+%feature("docstring") ISawtoothRipple::ISawtoothRipple "ISawtoothRipple::ISawtoothRipple(const NodeMeta &meta, const std::vector< double > &PValues)
+";
+
+%feature("docstring") ISawtoothRipple::getAsymmetry "double ISawtoothRipple::getAsymmetry() const
+";
+
+
// File: classISelectionRule.xml
%feature("docstring") ISelectionRule "
@@ -9774,7 +9766,7 @@ Evaluates the peak shape at q from a reciprocal lattice point at q_lattice_point
// File: classIsotropicLorentzPeakShape.xml
%feature("docstring") IsotropicLorentzPeakShape "
-Class that implements an isotropic Lorentzian peak shape of a Bragg peak.
+An isotropic Lorentzian peak shape of a Bragg peak.
C++ includes: IPeakShape.h
";
@@ -9918,9 +9910,6 @@ For definition of different strategies see https://en.wikipedia.org/wiki/Tree_tr
C++ includes: IterationStrategy.h
";
-%feature("docstring") IterationStrategy::~IterationStrategy "virtual IterationStrategy::~IterationStrategy()
-";
-
%feature("docstring") IterationStrategy::clone "virtual IterationStrategy* IterationStrategy::clone() const =0
";
@@ -10201,37 +10190,16 @@ C++ includes: LatticeBuilder.h
";
-// File: classLattice1DParameters.xml
-%feature("docstring") Lattice1DParameters "
-
-Basic parameters of a one-dimensional lattice.
-
-C++ includes: Lattice1DParameters.h
-";
-
-%feature("docstring") Lattice1DParameters::Lattice1DParameters "Lattice1DParameters::Lattice1DParameters()
-";
-
-%feature("docstring") Lattice1DParameters::Lattice1DParameters "Lattice1DParameters::Lattice1DParameters(double length, double xi)
-
-Parameters:
------------
-
-length:
- Lattice constant.
-
-xi:
- Lattice rotation angle.
-";
-
-
// File: classLattice2D.xml
%feature("docstring") Lattice2D "";
-%feature("docstring") Lattice2D::Lattice2D "Lattice2D::Lattice2D(double rotation_angle=0.0)
+%feature("docstring") Lattice2D::Lattice2D "Lattice2D::Lattice2D(const NodeMeta &meta, const std::vector< double > &PValues)
+";
+
+%feature("docstring") Lattice2D::Lattice2D "Lattice2D::Lattice2D(double xi)
";
-%feature("docstring") Lattice2D::clone "Lattice2D* Lattice2D::clone() const =0
+%feature("docstring") Lattice2D::clone "virtual Lattice2D* Lattice2D::clone() const =0
";
%feature("docstring") Lattice2D::length1 "virtual double Lattice2D::length1() const =0
@@ -10408,9 +10376,6 @@ Based on the article D.K.G. de Boer, Physical review B, Volume 51, Number 8, 15
C++ includes: LayerRoughness.h
";
-%feature("docstring") LayerRoughness::LayerRoughness "LayerRoughness::LayerRoughness()
-";
-
%feature("docstring") LayerRoughness::LayerRoughness "LayerRoughness::LayerRoughness(double sigma, double hurstParameter, double lateralCorrLength)
Constructor of layer roughness.
@@ -10428,6 +10393,9 @@ lateralCorrLength:
lateral correlation length of the roughness in nanometers
";
+%feature("docstring") LayerRoughness::LayerRoughness "LayerRoughness::LayerRoughness()
+";
+
%feature("docstring") LayerRoughness::clone "LayerRoughness* LayerRoughness::clone() const
Returns a clone of this ISample object.
@@ -10690,7 +10658,7 @@ user-defined weighting factors. Used linearly, no matter which norm is chosen.
// File: classLorentzFisherPeakShape.xml
%feature("docstring") LorentzFisherPeakShape "
-Class that implements a peak shape that is Lorentzian in the radial direction and uses the von Mises-Fisher distribution in the angular direction.
+A peak shape that is Lorentzian in the radial direction and uses the Mises-Fisher distribution in the angular direction.
C++ includes: IPeakShape.h
";
@@ -10796,7 +10764,7 @@ Returns the magnetization (in A/m)
Returns ( $ \\\\pi/\\\\lambda^2 $ - sld) matrix with magnetization corrections.
";
-%feature("docstring") MagneticMaterialImpl::transformedMaterial "MagneticMaterialImpl * MagneticMaterialImpl::transformedMaterial(const Transform3D &transform) const override final
+%feature("docstring") MagneticMaterialImpl::rotatedMaterial "MagneticMaterialImpl * MagneticMaterialImpl::rotatedMaterial(const Transform3D &transform) const override final
";
@@ -10946,7 +10914,7 @@ Returns ( $ \\\\pi/\\\\lambda^2 $ - sld), sld (in $nm^{-2}$) being the scatter
Returns ( $ \\\\pi/\\\\lambda^2 $ - sld) matrix with magnetization corrections.
";
-%feature("docstring") Material::transformedMaterial "Material Material::transformedMaterial(const Transform3D &transform) const
+%feature("docstring") Material::rotatedMaterial "Material Material::rotatedMaterial(const Transform3D &transform) const
";
@@ -11224,6 +11192,76 @@ This constructor is best explained by an example. Arguments QX, (1,1,0), QY, (0,
";
+// File: classMisesFisherGaussPeakShape.xml
+%feature("docstring") MisesFisherGaussPeakShape "
+
+A peak shape that is Gaussian in the radial direction and a convolution of a Mises-Fisher distribution with a Mises distribution on the two-sphere.
+
+C++ includes: IPeakShape.h
+";
+
+%feature("docstring") MisesFisherGaussPeakShape::MisesFisherGaussPeakShape "MisesFisherGaussPeakShape::MisesFisherGaussPeakShape(double max_intensity, double radial_size, kvector_t zenith, double kappa_1, double kappa_2)
+";
+
+%feature("docstring") MisesFisherGaussPeakShape::~MisesFisherGaussPeakShape "MisesFisherGaussPeakShape::~MisesFisherGaussPeakShape() override
+";
+
+%feature("docstring") MisesFisherGaussPeakShape::clone "MisesFisherGaussPeakShape * MisesFisherGaussPeakShape::clone() const override
+
+Returns a clone of this ISample object.
+";
+
+%feature("docstring") MisesFisherGaussPeakShape::accept "void MisesFisherGaussPeakShape::accept(INodeVisitor *visitor) const override
+
+Calls the INodeVisitor's visit method.
+";
+
+%feature("docstring") MisesFisherGaussPeakShape::evaluate "double MisesFisherGaussPeakShape::evaluate(const kvector_t q, const kvector_t q_lattice_point) const override
+
+Evaluates the peak shape at q from a reciprocal lattice point at q_lattice_point.
+";
+
+%feature("docstring") MisesFisherGaussPeakShape::angularDisorder "bool MisesFisherGaussPeakShape::angularDisorder() const override
+
+Indicates if the peak shape encodes angular disorder, in which case all peaks in a spherical shell are needed
+";
+
+
+// File: classMisesGaussPeakShape.xml
+%feature("docstring") MisesGaussPeakShape "
+
+A peak shape that is a convolution of a Mises-Fisher distribution with a 3d Gaussian.
+
+C++ includes: IPeakShape.h
+";
+
+%feature("docstring") MisesGaussPeakShape::MisesGaussPeakShape "MisesGaussPeakShape::MisesGaussPeakShape(double max_intensity, double radial_size, kvector_t zenith, double kappa)
+";
+
+%feature("docstring") MisesGaussPeakShape::~MisesGaussPeakShape "MisesGaussPeakShape::~MisesGaussPeakShape() override
+";
+
+%feature("docstring") MisesGaussPeakShape::clone "MisesGaussPeakShape * MisesGaussPeakShape::clone() const override
+
+Returns a clone of this ISample object.
+";
+
+%feature("docstring") MisesGaussPeakShape::accept "void MisesGaussPeakShape::accept(INodeVisitor *visitor) const override
+
+Calls the INodeVisitor's visit method.
+";
+
+%feature("docstring") MisesGaussPeakShape::evaluate "double MisesGaussPeakShape::evaluate(const kvector_t q, const kvector_t q_lattice_point) const override
+
+Evaluates the peak shape at q from a reciprocal lattice point at q_lattice_point.
+";
+
+%feature("docstring") MisesGaussPeakShape::angularDisorder "bool MisesGaussPeakShape::angularDisorder() const override
+
+Indicates if the peak shape encodes angular disorder, in which case all peaks in a spherical shell are needed
+";
+
+
// File: classMPISimulation.xml
%feature("docstring") MPISimulation "";
@@ -11397,6 +11435,15 @@ C++ includes: NodeIterator.h
";
+// File: structNodeMeta.xml
+%feature("docstring") NodeMeta "
+
+Metadata of one model node.
+
+C++ includes: INode.h
+";
+
+
// File: classExceptions_1_1NotImplementedException.xml
%feature("docstring") Exceptions::NotImplementedException "";
@@ -12112,6 +12159,15 @@ Sets concrete writing strategy.
";
+// File: structParaMeta.xml
+%feature("docstring") ParaMeta "
+
+Metadata of one model parameter.
+
+C++ includes: INode.h
+";
+
+
// File: classParameterDistribution.xml
%feature("docstring") ParameterDistribution "
@@ -12832,9 +12888,6 @@ C++ includes: PoissonNoiseBackground.h
%feature("docstring") PoissonNoiseBackground::PoissonNoiseBackground "PoissonNoiseBackground::PoissonNoiseBackground()
";
-%feature("docstring") PoissonNoiseBackground::~PoissonNoiseBackground "PoissonNoiseBackground::~PoissonNoiseBackground()
-";
-
%feature("docstring") PoissonNoiseBackground::clone "PoissonNoiseBackground * PoissonNoiseBackground::clone() const override final
";
@@ -13073,9 +13126,6 @@ C++ includes: IterationStrategy.h
%feature("docstring") PostorderStrategy::clone "PostorderStrategy * PostorderStrategy::clone() const
";
-%feature("docstring") PostorderStrategy::~PostorderStrategy "PostorderStrategy::~PostorderStrategy()
-";
-
%feature("docstring") PostorderStrategy::first "IteratorMemento PostorderStrategy::first(const INode *p_root)
";
@@ -13100,9 +13150,6 @@ C++ includes: IterationStrategy.h
%feature("docstring") PreorderStrategy::clone "PreorderStrategy * PreorderStrategy::clone() const
";
-%feature("docstring") PreorderStrategy::~PreorderStrategy "PreorderStrategy::~PreorderStrategy()
-";
-
%feature("docstring") PreorderStrategy::first "IteratorMemento PreorderStrategy::first(const INode *p_root)
";
@@ -13206,51 +13253,6 @@ Fourier transform of the correlation function of roughnesses between the interfa
";
-// File: classProfileBar.xml
-%feature("docstring") ProfileBar "
-
-Base class for form factors with a cosine ripple profile in the yz plane.
-
-C++ includes: ProfileBar.h
-";
-
-%feature("docstring") ProfileBar::ProfileBar "ProfileBar::ProfileBar(double length, double width, double height)
-
-Constructor of elongated bar.
-
-Parameters:
------------
-
-length:
-length of the rectangular base in nanometers
-
-width:
-width of the rectangular base in nanometers
-
-height:
-height of the ripple in nanometers
-";
-
-%feature("docstring") ProfileBar::getLength "double ProfileBar::getLength() const
-";
-
-%feature("docstring") ProfileBar::getHeight "double ProfileBar::getHeight() const
-";
-
-%feature("docstring") ProfileBar::getWidth "double ProfileBar::getWidth() const
-";
-
-%feature("docstring") ProfileBar::radialExtension "double ProfileBar::radialExtension() const override final
-
-Returns the (approximate in some cases) radial size of the particle of this form factor's shape. This is used for SSCA calculations
-";
-
-%feature("docstring") ProfileBar::evaluate_for_q "complex_t ProfileBar::evaluate_for_q(cvector_t q) const override final
-
-Returns scattering amplitude for complex scattering wavevector q=k_i-k_f. This method is public only for convenience of plotting form factors in Python.
-";
-
-
// File: classProfileHelper.xml
%feature("docstring") ProfileHelper "
@@ -13274,112 +13276,19 @@ C++ includes: ProfileHelper.h
";
-// File: classProfileRipple1.xml
-%feature("docstring") ProfileRipple1 "
+// File: classProgressHandler.xml
+%feature("docstring") ProgressHandler "
-Base class for form factors with a cosine ripple profile in the yz plane.
+Maintains information about progress of a computation. Owner is the computation, which periodically calls the thread-safe function incrementDone(..). An application (GUI or script) may subscribe(..) to be informed about progress. It is then periodically called back by inform(..). The return value of inform(..) can be used to request termination of the computation.
-C++ includes: ProfileRipple1.h
+C++ includes: ProgressHandler.h
";
-%feature("docstring") ProfileRipple1::ProfileRipple1 "ProfileRipple1::ProfileRipple1(double length, double width, double height)
-
-Constructor of cosine ripple.
+%feature("docstring") ProgressHandler::ProgressHandler "ProgressHandler::ProgressHandler()
+";
-Parameters:
------------
-
-length:
-length of the rectangular base in nanometers
-
-width:
-width of the rectangular base in nanometers
-
-height:
-height of the ripple in nanometers
-";
-
-%feature("docstring") ProfileRipple1::getLength "double ProfileRipple1::getLength() const
-";
-
-%feature("docstring") ProfileRipple1::getHeight "double ProfileRipple1::getHeight() const
-";
-
-%feature("docstring") ProfileRipple1::getWidth "double ProfileRipple1::getWidth() const
-";
-
-%feature("docstring") ProfileRipple1::radialExtension "double ProfileRipple1::radialExtension() const override final
-
-Returns the (approximate in some cases) radial size of the particle of this form factor's shape. This is used for SSCA calculations
-";
-
-%feature("docstring") ProfileRipple1::evaluate_for_q "complex_t ProfileRipple1::evaluate_for_q(cvector_t q) const override final
-
-Returns scattering amplitude for complex scattering wavevector q=k_i-k_f. This method is public only for convenience of plotting form factors in Python.
-";
-
-
-// File: classProfileRipple2.xml
-%feature("docstring") ProfileRipple2 "
-
-Base class for form factors with a cosine ripple profile in the yz plane.
-
-C++ includes: ProfileRipple2.h
-";
-
-%feature("docstring") ProfileRipple2::ProfileRipple2 "ProfileRipple2::ProfileRipple2(double length, double width, double height, double asymmetry)
-
-Constructor of triangular ripple.
-
-Parameters:
------------
-
-length:
-length of the rectangular base in nanometers
-
-width:
-width of the rectangular base in nanometers
-
-height:
-height of the ripple in nanometers
-";
-
-%feature("docstring") ProfileRipple2::getLength "double ProfileRipple2::getLength() const
-";
-
-%feature("docstring") ProfileRipple2::getHeight "double ProfileRipple2::getHeight() const
-";
-
-%feature("docstring") ProfileRipple2::getWidth "double ProfileRipple2::getWidth() const
-";
-
-%feature("docstring") ProfileRipple2::getAsymmetry "double ProfileRipple2::getAsymmetry() const
-";
-
-%feature("docstring") ProfileRipple2::radialExtension "double ProfileRipple2::radialExtension() const override final
-
-Returns the (approximate in some cases) radial size of the particle of this form factor's shape. This is used for SSCA calculations
-";
-
-%feature("docstring") ProfileRipple2::evaluate_for_q "complex_t ProfileRipple2::evaluate_for_q(cvector_t q) const override final
-
-Returns scattering amplitude for complex scattering wavevector q=k_i-k_f. This method is public only for convenience of plotting form factors in Python.
-";
-
-
-// File: classProgressHandler.xml
-%feature("docstring") ProgressHandler "
-
-Maintains information about progress of a computation. Owner is the computation, which periodically calls the thread-safe function incrementDone(..). An application (GUI or script) may subscribe(..) to be informed about progress. It is then periodically called back by inform(..). The return value of inform(..) can be used to request termination of the computation.
-
-C++ includes: ProgressHandler.h
-";
-
-%feature("docstring") ProgressHandler::ProgressHandler "ProgressHandler::ProgressHandler()
-";
-
-%feature("docstring") ProgressHandler::ProgressHandler "ProgressHandler::ProgressHandler(const ProgressHandler &other)
-";
+%feature("docstring") ProgressHandler::ProgressHandler "ProgressHandler::ProgressHandler(const ProgressHandler &other)
+";
%feature("docstring") ProgressHandler::subscribe "void ProgressHandler::subscribe(ProgressHandler::Callback_t callback)
";
@@ -13999,7 +13908,7 @@ return default axes units
A pixel in a RectangularDetector.
-C++ includes: RectangularDetector.h
+C++ includes: RectangularPixel.h
";
%feature("docstring") RectangularPixel::RectangularPixel "RectangularPixel::RectangularPixel(kvector_t corner_pos, kvector_t width, kvector_t height)
@@ -14346,26 +14255,13 @@ A sequence of rotations about the z-x'-z'' axes.
C++ includes: Rotations.h
";
-%feature("docstring") RotationEuler::RotationEuler "RotationEuler::RotationEuler(double alpha, double beta, double gamma)
-
-Constructor of Euler rotation (sequence of three rotations following Euler angles notation z-x'-z').
-
-Parameters:
------------
-
-alpha:
-first Euler angle in radians
-
-beta:
-second Euler angle in radians
+%feature("docstring") RotationEuler::RotationEuler "RotationEuler::RotationEuler(const std::vector< double > P)
+";
-gamma:
-third Euler angle in radians
+%feature("docstring") RotationEuler::RotationEuler "RotationEuler::RotationEuler(double alpha, double beta, double gamma)
";
%feature("docstring") RotationEuler::clone "RotationEuler* RotationEuler::clone() const
-
-Returns a clone of this ISample object.
";
%feature("docstring") RotationEuler::createInverse "IRotation * RotationEuler::createInverse() const
@@ -14401,7 +14297,7 @@ A rotation about the x axis.
C++ includes: Rotations.h
";
-%feature("docstring") RotationX::RotationX "RotationX::RotationX(double angle)
+%feature("docstring") RotationX::RotationX "RotationX::RotationX(const std::vector< double > P)
Constructor of rotation around x-axis
@@ -14412,9 +14308,10 @@ angle:
rotation angle around x-axis in radians
";
-%feature("docstring") RotationX::clone "RotationX* RotationX::clone() const
+%feature("docstring") RotationX::RotationX "RotationX::RotationX(double angle)
+";
-Returns a clone of this ISample object.
+%feature("docstring") RotationX::clone "RotationX* RotationX::clone() const
";
%feature("docstring") RotationX::createInverse "RotationX* RotationX::createInverse() const
@@ -14444,7 +14341,7 @@ A rotation about the y axis.
C++ includes: Rotations.h
";
-%feature("docstring") RotationY::RotationY "RotationY::RotationY(double angle)
+%feature("docstring") RotationY::RotationY "RotationY::RotationY(const std::vector< double > P)
Constructor of rotation around y-axis
@@ -14455,9 +14352,10 @@ angle:
rotation angle around y-axis in radians
";
-%feature("docstring") RotationY::clone "RotationY* RotationY::clone() const
+%feature("docstring") RotationY::RotationY "RotationY::RotationY(double angle)
+";
-Returns a clone of this ISample object.
+%feature("docstring") RotationY::clone "RotationY* RotationY::clone() const
";
%feature("docstring") RotationY::createInverse "RotationY* RotationY::createInverse() const
@@ -14487,7 +14385,7 @@ A rotation about the z axis.
C++ includes: Rotations.h
";
-%feature("docstring") RotationZ::RotationZ "RotationZ::RotationZ(double angle=0.0)
+%feature("docstring") RotationZ::RotationZ "RotationZ::RotationZ(const std::vector< double > P)
Constructor of rotation around z-axis
@@ -14498,9 +14396,10 @@ angle:
rotation angle around z-axis in radians
";
-%feature("docstring") RotationZ::clone "RotationZ* RotationZ::clone() const
+%feature("docstring") RotationZ::RotationZ "RotationZ::RotationZ(double angle)
+";
-Returns a clone of this ISample object.
+%feature("docstring") RotationZ::clone "RotationZ* RotationZ::clone() const
";
%feature("docstring") RotationZ::createInverse "RotationZ* RotationZ::createInverse() const
@@ -15297,6 +15196,22 @@ Initializes a progress monitor that prints to stdout.
Returns a vector of children (const).
";
+%feature("docstring") Simulation::convertData "SimulationResult Simulation::convertData(const OutputData< double > &data, bool put_masked_areas_to_zero=true)
+
+Convert user data to SimulationResult object for later drawing in various axes units. User data will be cropped to the ROI defined in the simulation, amplitudes in areas corresponding to the masked areas of the detector will be set to zero.
+
+Parameters:
+-----------
+
+simulation:
+ Simulation object with possible ROI and masks defined.
+
+data:
+User data with amplitudes with the shape of data matching the detector.
+
+SimulationResult object.
+";
+
// File: classSimulation2D.xml
%feature("docstring") Simulation2D "
@@ -16324,7 +16239,7 @@ return default axes units
A pixel in a SphericalDetector.
-C++ includes: SphericalDetector.h
+C++ includes: SphericalPixel.h
";
%feature("docstring") SphericalPixel::SphericalPixel "SphericalPixel::SphericalPixel(const Bin1D &alpha_bin, const Bin1D &phi_bin)
@@ -16349,7 +16264,7 @@ C++ includes: SphericalDetector.h
// File: classSquareLattice.xml
%feature("docstring") SquareLattice "";
-%feature("docstring") SquareLattice::SquareLattice "SquareLattice::SquareLattice(double length, double rotation_angle=0.0)
+%feature("docstring") SquareLattice::SquareLattice "SquareLattice::SquareLattice(double length, double xi=0.0)
";
%feature("docstring") SquareLattice::clone "SquareLattice * SquareLattice::clone() const
@@ -16976,76 +16891,6 @@ Returns true if area defined by two bins is inside or on border of polygon (more
";
-// File: classVonMisesFisherGaussPeakShape.xml
-%feature("docstring") VonMisesFisherGaussPeakShape "
-
-Class that implements a peak shape that is Gaussian in the radial direction and a convolution of a von Mises-Fisher distribution with a von Mises distribution on the two-sphere
-
-C++ includes: IPeakShape.h
-";
-
-%feature("docstring") VonMisesFisherGaussPeakShape::VonMisesFisherGaussPeakShape "VonMisesFisherGaussPeakShape::VonMisesFisherGaussPeakShape(double max_intensity, double radial_size, kvector_t zenith, double kappa_1, double kappa_2)
-";
-
-%feature("docstring") VonMisesFisherGaussPeakShape::~VonMisesFisherGaussPeakShape "VonMisesFisherGaussPeakShape::~VonMisesFisherGaussPeakShape() override
-";
-
-%feature("docstring") VonMisesFisherGaussPeakShape::clone "VonMisesFisherGaussPeakShape * VonMisesFisherGaussPeakShape::clone() const override
-
-Returns a clone of this ISample object.
-";
-
-%feature("docstring") VonMisesFisherGaussPeakShape::accept "void VonMisesFisherGaussPeakShape::accept(INodeVisitor *visitor) const override
-
-Calls the INodeVisitor's visit method.
-";
-
-%feature("docstring") VonMisesFisherGaussPeakShape::evaluate "double VonMisesFisherGaussPeakShape::evaluate(const kvector_t q, const kvector_t q_lattice_point) const override
-
-Evaluates the peak shape at q from a reciprocal lattice point at q_lattice_point.
-";
-
-%feature("docstring") VonMisesFisherGaussPeakShape::angularDisorder "bool VonMisesFisherGaussPeakShape::angularDisorder() const override
-
-Indicates if the peak shape encodes angular disorder, in which case all peaks in a spherical shell are needed
-";
-
-
-// File: classVonMisesGaussPeakShape.xml
-%feature("docstring") VonMisesGaussPeakShape "
-
-Class that implements a peak shape that is a convolution of a von Mises-Fisher distribution with a 3d Gaussian
-
-C++ includes: IPeakShape.h
-";
-
-%feature("docstring") VonMisesGaussPeakShape::VonMisesGaussPeakShape "VonMisesGaussPeakShape::VonMisesGaussPeakShape(double max_intensity, double radial_size, kvector_t zenith, double kappa)
-";
-
-%feature("docstring") VonMisesGaussPeakShape::~VonMisesGaussPeakShape "VonMisesGaussPeakShape::~VonMisesGaussPeakShape() override
-";
-
-%feature("docstring") VonMisesGaussPeakShape::clone "VonMisesGaussPeakShape * VonMisesGaussPeakShape::clone() const override
-
-Returns a clone of this ISample object.
-";
-
-%feature("docstring") VonMisesGaussPeakShape::accept "void VonMisesGaussPeakShape::accept(INodeVisitor *visitor) const override
-
-Calls the INodeVisitor's visit method.
-";
-
-%feature("docstring") VonMisesGaussPeakShape::evaluate "double VonMisesGaussPeakShape::evaluate(const kvector_t q, const kvector_t q_lattice_point) const override
-
-Evaluates the peak shape at q from a reciprocal lattice point at q_lattice_point.
-";
-
-%feature("docstring") VonMisesGaussPeakShape::angularDisorder "bool VonMisesGaussPeakShape::angularDisorder() const override
-
-Indicates if the peak shape encodes angular disorder, in which case all peaks in a spherical shell are needed
-";
-
-
// File: classWavevectorInfo.xml
%feature("docstring") WavevectorInfo "
@@ -17076,10 +16921,10 @@ C++ includes: WavevectorInfo.h
";
-// File: classConvolve_1_1Workspace.xml
+// File: classFourierTransform_1_1Workspace.xml
-// File: classFourierTransform_1_1Workspace.xml
+// File: classConvolve_1_1Workspace.xml
// File: classZLimits.xml
@@ -17109,172 +16954,175 @@ C++ includes: ZLimits.h
";
-// File: namespace_0d100.xml
-
-
-// File: namespace_0d102.xml
-
-
// File: namespace_0d106.xml
-// File: namespace_0d14.xml
+// File: namespace_0d112.xml
-// File: namespace_0d141.xml
+// File: namespace_0d116.xml
// File: namespace_0d147.xml
-// File: namespace_0d154.xml
-
-
// File: namespace_0d159.xml
// File: namespace_0d16.xml
-// File: namespace_0d168.xml
+// File: namespace_0d167.xml
+
+
+// File: namespace_0d172.xml
-// File: namespace_0d170.xml
+// File: namespace_0d181.xml
-// File: namespace_0d174.xml
+// File: namespace_0d183.xml
+
+
+// File: namespace_0d187.xml
// File: namespace_0d2.xml
-// File: namespace_0d212.xml
+// File: namespace_0d227.xml
-// File: namespace_0d247.xml
+// File: namespace_0d24.xml
-// File: namespace_0d255.xml
+// File: namespace_0d256.xml
-// File: namespace_0d261.xml
+// File: namespace_0d260.xml
-// File: namespace_0d265.xml
+// File: namespace_0d264.xml
-// File: namespace_0d28.xml
+// File: namespace_0d270.xml
-// File: namespace_0d285.xml
+// File: namespace_0d274.xml
-// File: namespace_0d305.xml
+// File: namespace_0d288.xml
// File: namespace_0d312.xml
-// File: namespace_0d318.xml
+// File: namespace_0d319.xml
-// File: namespace_0d320.xml
+// File: namespace_0d321.xml
-// File: namespace_0d341.xml
+// File: namespace_0d323.xml
-// File: namespace_0d345.xml
+// File: namespace_0d343.xml
// File: namespace_0d347.xml
-// File: namespace_0d349.xml
+// File: namespace_0d351.xml
+
+
+// File: namespace_0d365.xml
-// File: namespace_0d36.xml
+// File: namespace_0d376.xml
-// File: namespace_0d363.xml
+// File: namespace_0d380.xml
-// File: namespace_0d375.xml
+// File: namespace_0d390.xml
-// File: namespace_0d379.xml
+// File: namespace_0d392.xml
-// File: namespace_0d38.xml
+// File: namespace_0d394.xml
-// File: namespace_0d391.xml
+// File: namespace_0d4.xml
-// File: namespace_0d397.xml
+// File: namespace_0d402.xml
-// File: namespace_0d399.xml
+// File: namespace_0d404.xml
// File: namespace_0d406.xml
-// File: namespace_0d408.xml
+// File: namespace_0d410.xml
// File: namespace_0d412.xml
-// File: namespace_0d414.xml
+// File: namespace_0d422.xml
-// File: namespace_0d424.xml
+// File: namespace_0d435.xml
-// File: namespace_0d437.xml
+// File: namespace_0d444.xml
// File: namespace_0d446.xml
-// File: namespace_0d448.xml
+// File: namespace_0d462.xml
-// File: namespace_0d481.xml
+// File: namespace_0d483.xml
-// File: namespace_0d488.xml
+// File: namespace_0d490.xml
-// File: namespace_0d498.xml
+// File: namespace_0d499.xml
-// File: namespace_0d523.xml
+// File: namespace_0d522.xml
-// File: namespace_0d531.xml
+// File: namespace_0d530.xml
-// File: namespace_0d533.xml
+// File: namespace_0d532.xml
-// File: namespace_0d535.xml
+// File: namespace_0d536.xml
-// File: namespace_0d618.xml
+// File: namespace_0d538.xml
-// File: namespace_0d622.xml
+// File: namespace_0d611.xml
-// File: namespace_0d8.xml
+// File: namespace_0d86.xml
-// File: namespace_0d92.xml
+// File: namespace_0d88.xml
-// File: namespace_0d98.xml
+// File: namespace_0d90.xml
+
+
+// File: namespace_0d94.xml
// File: namespacealgo.xml
@@ -17288,6 +17136,11 @@ Returns the minimum value of function evaluate as applied to the elements of an
Returns the maximum value of function evaluate as applied to the elements of an iterator range.
";
+%feature("docstring") algo::concat "std::vector< T > algo::concat(const std::vector< T > &v1, const std::vector< T > &v2)
+
+Returns the concatenation of two std::vectors.
+";
+
// File: namespaceArrayUtils.xml
%feature("docstring") ArrayUtils::getShape "std::pair< size_t, size_t > ArrayUtils::getShape(const T &data)
@@ -17368,40 +17221,6 @@ vector<vector<double>>
// File: namespaceboost_1_1geometry.xml
-// File: namespaceconvert.xml
-%feature("docstring") convert::ConvertData "SimulationResult convert::ConvertData(const Simulation &simulation, const OutputData< double > &data, bool put_masked_areas_to_zero=true)
-
-Convert user data to SimulationResult object for later drawing in various axes units. User data will be cropped to the ROI defined in the simulation, amplitudes in areas corresponding to the masked areas of the detector will be set to zero.
-
-Parameters:
------------
-
-simulation:
- Simulation object with possible ROI and masks defined.
-
-data:
-User data with amplitudes with the shape of data matching the detector.
-
-SimulationResult object.
-";
-
-%feature("docstring") convert::ConvertData "SimulationResult convert::ConvertData(const Simulation &simulation, const std::vector< std::vector< double >> &data, bool put_masked_areas_to_zero=true)
-";
-
-%feature("docstring") convert::createOutputData "std::unique_ptr< OutputData< double > > convert::createOutputData(const IUnitConverter &converter, AxesUnits units)
-
-Returns zero-valued output data array in specified units.
-";
-
-%feature("docstring") convert::createConverterForGISAS "std::unique_ptr< IUnitConverter > convert::createConverterForGISAS(const Instrument &instrument)
-
-Helper factory function to use in GISASSimulation. Depending on the type of detector, returns either RectangularConverter or SphericalConverter.
-";
-
-%feature("docstring") convert::createConverter "std::unique_ptr< IUnitConverter > convert::createConverter(const Simulation &simulation)
-";
-
-
// File: namespaceDataFormatUtils.xml
%feature("docstring") DataFormatUtils::isCompressed "bool DataFormatUtils::isCompressed(const std::string &name)
@@ -17639,25 +17458,6 @@ Creates OutputData from a 2D Array.
Creates Fourier Transform ( OutputData format) of intensity map ( OutputData format).
";
-%feature("docstring") IntensityDataFunctions::ConvertData "SimulationResult IntensityDataFunctions::ConvertData(const Simulation &simulation, const OutputData< double > &data, bool put_masked_areas_to_zero=true)
-
-Convert user data to SimulationResult object for later drawing in various axes units. User data will be cropped to the ROI defined in the simulation, amplitudes in areas corresponding to the masked areas of the detector will be set to zero.
-
-Parameters:
------------
-
-simulation:
- Simulation object with possible ROI and masks defined.
-
-data:
-User data with amplitudes with the shape of data matching the detector.
-
-SimulationResult object.
-";
-
-%feature("docstring") IntensityDataFunctions::ConvertData "SimulationResult IntensityDataFunctions::ConvertData(const Simulation &simulation, const std::vector< std::vector< double >> &data, bool put_masked_areas_to_zero=true)
-";
-
// File: namespaceInterferenceFunctionUtils.xml
%feature("docstring") InterferenceFunctionUtils::PrecomputeScalarFormFactors "std::vector< complex_t > InterferenceFunctionUtils::PrecomputeScalarFormFactors(const SimulationElement &sim_element, const std::vector< FormFactorCoherentSum > &ff_wrappers)
@@ -18006,130 +17806,132 @@ Returns string representing python stack trace.
";
-// File: namespacePyImport.xml
-%feature("docstring") PyImport::createFromPython "std::unique_ptr< MultiLayer > PyImport::createFromPython(const std::string &script, const std::string &functionName, const std::string &path=\"\")
+// File: namespacepyfmt.xml
+%feature("docstring") pyfmt::scriptPreamble "BA_CORE_API_ std::string pyfmt::scriptPreamble()
+";
-Creates a multi layer by running python code in embedded interpreter.
+%feature("docstring") pyfmt::getSampleFunctionName "BA_CORE_API_ std::string pyfmt::getSampleFunctionName()
+";
-Parameters:
------------
+%feature("docstring") pyfmt::printBool "BA_CORE_API_ std::string pyfmt::printBool(double value)
+";
-script:
-Python script
+%feature("docstring") pyfmt::printDouble "BA_CORE_API_ std::string pyfmt::printDouble(double input)
+";
-functionName:
-A function name in this script which produces a MultiLayer
+%feature("docstring") pyfmt::printNm "BA_CORE_API_ std::string pyfmt::printNm(double input)
+";
-path:
-A path to import BornAgain library. If empty, relies on PYTHONPATH
+%feature("docstring") pyfmt::printNm2 "BA_CORE_API_ std::string pyfmt::printNm2(double input)
";
-%feature("docstring") PyImport::listOfFunctions "std::vector< std::string > PyImport::listOfFunctions(const std::string &script, const std::string &path=\"\")
+%feature("docstring") pyfmt::printScientificDouble "BA_CORE_API_ std::string pyfmt::printScientificDouble(double input)
+";
-Returns list of functions defined in the script.
+%feature("docstring") pyfmt::printDegrees "BA_CORE_API_ std::string pyfmt::printDegrees(double input)
+";
-Parameters:
------------
-
-script:
-Python script
-
-path:
-A path to import BornAgain library. If empty, relies on PYTHONPATH
+%feature("docstring") pyfmt::printValue "BA_CORE_API_ std::string pyfmt::printValue(double value, const std::string &units)
";
-
-// File: namespacePythonFormatting.xml
-%feature("docstring") PythonFormatting::scriptPreamble "BA_CORE_API_ std::string PythonFormatting::scriptPreamble()
+%feature("docstring") pyfmt::printString "BA_CORE_API_ std::string pyfmt::printString(const std::string &value)
";
-%feature("docstring") PythonFormatting::getSampleFunctionName "BA_CORE_API_ std::string PythonFormatting::getSampleFunctionName()
+%feature("docstring") pyfmt::printRealLimits "BA_CORE_API_ std::string pyfmt::printRealLimits(const RealLimits &limits, const std::string &units)
";
-%feature("docstring") PythonFormatting::representShape2D "BA_CORE_API_ std::string PythonFormatting::representShape2D(const std::string &indent, const IShape2D *ishape, bool mask_value, std::function< std::string(double)> printValueFunc)
+%feature("docstring") pyfmt::printRealLimitsArg "BA_CORE_API_ std::string pyfmt::printRealLimitsArg(const RealLimits &limits, const std::string &units)
-Returns fixed Python code snippet that defines the function \"runSimulation\".
+Prints RealLimits in the form of argument (in the context of ParameterDistribution and similar). Default RealLimits will not be printed, any other will be printed as \", ba.RealLimits.limited(1*deg, 2*deg)\"
";
-%feature("docstring") PythonFormatting::printBool "BA_CORE_API_ std::string PythonFormatting::printBool(double value)
-";
+%feature("docstring") pyfmt::isSquare "BA_CORE_API_ bool pyfmt::isSquare(double length1, double length2, double angle)
-%feature("docstring") PythonFormatting::printDouble "BA_CORE_API_ std::string PythonFormatting::printDouble(double input)
-";
+Prints ParameterDistribution. distVarName is a string representing IDistribution1D variable, e.g. \"distr_1\"
-%feature("docstring") PythonFormatting::printNm "BA_CORE_API_ std::string PythonFormatting::printNm(double input)
+ba.ParameterDistribution(\"/Particle/Height\", distr_1, 10, 0.0, ba.RealLimits.limited(1*nm,2*nm))
";
-%feature("docstring") PythonFormatting::printNm2 "BA_CORE_API_ std::string PythonFormatting::printNm2(double input)
+%feature("docstring") pyfmt::isHexagonal "BA_CORE_API_ bool pyfmt::isHexagonal(double length1, double length2, double angle)
";
-%feature("docstring") PythonFormatting::printScientificDouble "BA_CORE_API_ std::string PythonFormatting::printScientificDouble(double input)
+%feature("docstring") pyfmt::printKvector "BA_CORE_API_ std::string pyfmt::printKvector(const kvector_t value)
";
-%feature("docstring") PythonFormatting::printDegrees "BA_CORE_API_ std::string PythonFormatting::printDegrees(double input)
-";
+%feature("docstring") pyfmt::isDefaultDirection "BA_CORE_API_ bool pyfmt::isDefaultDirection(const kvector_t direction)
-%feature("docstring") PythonFormatting::printValue "BA_CORE_API_ std::string PythonFormatting::printValue(double value, const std::string &units)
+returns true if it is (0, -1, 0) vector
";
-%feature("docstring") PythonFormatting::printString "BA_CORE_API_ std::string PythonFormatting::printString(const std::string &value)
-";
+%feature("docstring") pyfmt::indent "BA_CORE_API_ std::string pyfmt::indent(size_t width)
-%feature("docstring") PythonFormatting::isSquare "BA_CORE_API_ bool PythonFormatting::isSquare(double length1, double length2, double angle)
+Returns a string of blanks with given width. By default the width equals standard offset in python files.
";
-%feature("docstring") PythonFormatting::isHexagonal "BA_CORE_API_ bool PythonFormatting::isHexagonal(double length1, double length2, double angle)
+%feature("docstring") pyfmt::printInt "BA_CORE_API_ std::string pyfmt::printInt(int value)
";
-%feature("docstring") PythonFormatting::printKvector "BA_CORE_API_ std::string PythonFormatting::printKvector(const kvector_t value)
-";
-%feature("docstring") PythonFormatting::isDefaultDirection "BA_CORE_API_ bool PythonFormatting::isDefaultDirection(const kvector_t direction)
+// File: namespacepyfmt2.xml
+%feature("docstring") pyfmt2::representShape2D "BA_CORE_API_ std::string pyfmt2::representShape2D(const std::string &indent, const IShape2D *ishape, bool mask_value, std::function< std::string(double)> printValueFunc)
-returns true if it is (0, -1, 0) vector
+Returns fixed Python code snippet that defines the function \"runSimulation\".
";
-%feature("docstring") PythonFormatting::valueTimesUnit "BA_CORE_API_ std::string PythonFormatting::valueTimesUnit(const RealParameter *par)
+%feature("docstring") pyfmt2::valueTimesUnit "BA_CORE_API_ std::string pyfmt2::valueTimesUnit(const RealParameter *par)
Returns parameter value, followed by its unit multiplicator (like \"* nm\").
";
-%feature("docstring") PythonFormatting::argumentList "BA_CORE_API_ std::string PythonFormatting::argumentList(const IParameterized *ip)
+%feature("docstring") pyfmt2::argumentList "BA_CORE_API_ std::string pyfmt2::argumentList(const IParameterized *ip)
Returns comma-separated list of parameter values, including unit multiplicator (like \"* nm\").
";
-%feature("docstring") PythonFormatting::printDistribution "BA_CORE_API_ std::string PythonFormatting::printDistribution(const IDistribution1D &par_distr, const std::string &units)
+%feature("docstring") pyfmt2::printDistribution "BA_CORE_API_ std::string pyfmt2::printDistribution(const IDistribution1D &par_distr, const std::string &units)
Prints distribution with constructor parameters in given units. ba.DistributionGaussian(2.0*deg, 0.02*deg)
";
-%feature("docstring") PythonFormatting::printRealLimits "BA_CORE_API_ std::string PythonFormatting::printRealLimits(const RealLimits &limits, const std::string &units)
+%feature("docstring") pyfmt2::printParameterDistribution "BA_CORE_API_ std::string pyfmt2::printParameterDistribution(const ParameterDistribution &par_distr, const std::string &distVarName, const std::string &units)
";
-%feature("docstring") PythonFormatting::printRealLimitsArg "BA_CORE_API_ std::string PythonFormatting::printRealLimitsArg(const RealLimits &limits, const std::string &units)
+%feature("docstring") pyfmt2::printAxis "BA_CORE_API_ std::string pyfmt2::printAxis(const IAxis &axis, const std::string &units, size_t offset)
-Prints RealLimits in the form of argument (in the context of ParameterDistribution and similar). Default RealLimits will not be printed, any other will be printed as \", ba.RealLimits.limited(1*deg, 2*deg)\"
+Prints python-script definition for given axis. offset is used for alignment and indentation in multiple-line definitions
";
-%feature("docstring") PythonFormatting::printParameterDistribution "BA_CORE_API_ std::string PythonFormatting::printParameterDistribution(const ParameterDistribution &par_distr, const std::string &distVarName, const std::string &units)
-Prints ParameterDistribution. distVarName is a string representing IDistribution1D variable, e.g. \"distr_1\"
+// File: namespacePyImport.xml
+%feature("docstring") PyImport::createFromPython "std::unique_ptr< MultiLayer > PyImport::createFromPython(const std::string &script, const std::string &functionName, const std::string &path=\"\")
-ba.ParameterDistribution(\"/Particle/Height\", distr_1, 10, 0.0, ba.RealLimits.limited(1*nm,2*nm))
-";
+Creates a multi layer by running python code in embedded interpreter.
+
+Parameters:
+-----------
-%feature("docstring") PythonFormatting::printAxis "BA_CORE_API_ std::string PythonFormatting::printAxis(const IAxis &axis, const std::string &units, size_t offset)
+script:
+Python script
-Prints python-script definition for given axis. offset is used for alignment and indentation in multiple-line definitions
+functionName:
+A function name in this script which produces a MultiLayer
+
+path:
+A path to import BornAgain library. If empty, relies on PYTHONPATH
";
-%feature("docstring") PythonFormatting::indent "BA_CORE_API_ std::string PythonFormatting::indent(size_t width)
+%feature("docstring") PyImport::listOfFunctions "std::vector< std::string > PyImport::listOfFunctions(const std::string &script, const std::string &path=\"\")
-Returns a string of blanks with given width. By default the width equals standard offset in python files.
-";
+Returns list of functions defined in the script.
+
+Parameters:
+-----------
+
+script:
+Python script
-%feature("docstring") PythonFormatting::printInt "BA_CORE_API_ std::string PythonFormatting::printInt(int value)
+path:
+A path to import BornAgain library. If empty, relies on PYTHONPATH
";
@@ -18143,6 +17945,30 @@ Returns a string of blanks with given width. By default the width equals standar
%feature("docstring") ripples::factor_x_Lorentz "complex_t ripples::factor_x_Lorentz(complex_t q, double l)
";
+%feature("docstring") ripples::profile_yz_bar "complex_t ripples::profile_yz_bar(complex_t qy, complex_t qz, double width, double height)
+
+Complex form factor of rectangular ripple (bar).
+";
+
+%feature("docstring") ripples::profile_yz_cosine "complex_t ripples::profile_yz_cosine(complex_t qy, complex_t qz, double width, double height)
+
+Complex form factor of triangular ripple.
+";
+
+%feature("docstring") ripples::profile_yz_triangular "complex_t ripples::profile_yz_triangular(complex_t qy, complex_t qz, double width, double height, double asymmetry)
+
+Complex form factor of triangular ripple.
+";
+
+
+// File: namespacesomeff.xml
+%feature("docstring") someff::ffSphere "complex_t someff::ffSphere(cvector_t q, double R)
+
+Returns the form factor of a sphere of radius R.
+
+Used by the hard sphere and by several soft sphere classes.
+";
+
// File: namespaceSpectrumUtils.xml
%feature("docstring") SpectrumUtils::FindPeaks "std::vector< std::pair< double, double > > SpectrumUtils::FindPeaks(const Histogram2D &hist, double sigma=2, const std::string &option={}, double threshold=0.05)
@@ -18365,48 +18191,12 @@ Helper factory function to use in GISASSimulation. Depending on the type of det
";
-// File: FTDecayFunctions_8cpp.xml
-
-
-// File: FTDecayFunctions_8h.xml
-
-
-// File: FTDistributions1D_8cpp.xml
-
-
-// File: FTDistributions1D_8h.xml
-
-
-// File: FTDistributions2D_8cpp.xml
-
-
-// File: FTDistributions2D_8h.xml
-
-
-// File: IDistribution1DSampler_8cpp.xml
-
-
-// File: IDistribution1DSampler_8h.xml
-
-
-// File: IDistribution2DSampler_8cpp.xml
-
-
-// File: IDistribution2DSampler_8h.xml
-
-
// File: IInterferenceFunction_8cpp.xml
// File: IInterferenceFunction_8h.xml
-// File: ILayout_8cpp.xml
-
-
-// File: ILayout_8h.xml
-
-
// File: InterferenceFunction1DLattice_8cpp.xml
@@ -18473,12 +18263,6 @@ Helper factory function to use in GISASSimulation. Depending on the type of det
// File: InterferenceFunctionTwin_8h.xml
-// File: IPeakShape_8cpp.xml
-
-
-// File: IPeakShape_8h.xml
-
-
// File: ParticleLayout_8cpp.xml
@@ -18509,9 +18293,6 @@ Returns exp(I*z), where I is the imaginary unit.
// File: Exceptions_8h.xml
-// File: ICloneable_8cpp.xml
-
-
// File: ICloneable_8h.xml
@@ -18524,6 +18305,9 @@ Returns exp(I*z), where I is the imaginary unit.
// File: PhysicalConstants_8h.xml
+// File: Units_8h.xml
+
+
// File: Beam_8cpp.xml
@@ -18662,10 +18446,44 @@ global helper function for comparison of axes
// File: IComputation_8h.xml
-// File: MultiLayerUtils_8cpp.xml
+// File: LayoutStrategyBuilder_8cpp.xml
-// File: MultiLayerUtils_8h.xml
+// File: LayoutStrategyBuilder_8h.xml
+
+
+// File: MultiLayerFuncs_8cpp.xml
+%feature("docstring") MaterialProfile "std::vector<complex_t> MaterialProfile(const MultiLayer &multilayer, int n_points, double z_min, double z_max)
+
+Calculate average material profile for given multilayer.
+";
+
+%feature("docstring") DefaultMaterialProfileLimits "std::pair<double, double> DefaultMaterialProfileLimits(const MultiLayer &multilayer)
+
+Get default z limits for generating a material profile.
+";
+
+%feature("docstring") GenerateZValues "std::vector<double> GenerateZValues(int n_points, double z_min, double z_max)
+
+Generate z values (equidistant) for use in MaterialProfile.
+";
+
+
+// File: MultiLayerFuncs_8h.xml
+%feature("docstring") MaterialProfile "BA_CORE_API_ std::vector<complex_t> MaterialProfile(const MultiLayer &multilayer, int n_points, double z_min, double z_max)
+
+Calculate average material profile for given multilayer.
+";
+
+%feature("docstring") DefaultMaterialProfileLimits "BA_CORE_API_ std::pair<double, double> DefaultMaterialProfileLimits(const MultiLayer &multilayer)
+
+Get default z limits for generating a material profile.
+";
+
+%feature("docstring") GenerateZValues "BA_CORE_API_ std::vector<double> GenerateZValues(int n_points, double z_min, double z_max)
+
+Generate z values (equidistant) for use in MaterialProfile.
+";
// File: ParticleLayoutComputation_8cpp.xml
@@ -18710,12 +18528,6 @@ global helper function for comparison of axes
// File: RoughMultiLayerComputation_8h.xml
-// File: Slice_8cpp.xml
-
-
-// File: Slice_8h.xml
-
-
// File: SpecularComputation_8cpp.xml
@@ -18728,6 +18540,60 @@ global helper function for comparison of axes
// File: SpecularComputationTerm_8h.xml
+// File: SpecularStrategyBuilder_8cpp.xml
+
+
+// File: SpecularStrategyBuilder_8h.xml
+
+
+// File: FTDecay1D_8cpp.xml
+
+
+// File: FTDecay1D_8h.xml
+
+
+// File: FTDecay2D_8cpp.xml
+
+
+// File: FTDecay2D_8h.xml
+
+
+// File: FTDistributions1D_8cpp.xml
+
+
+// File: FTDistributions1D_8h.xml
+
+
+// File: FTDistributions2D_8cpp.xml
+
+
+// File: FTDistributions2D_8h.xml
+
+
+// File: IDistribution1DSampler_8cpp.xml
+
+
+// File: IDistribution1DSampler_8h.xml
+
+
+// File: IDistribution2DSampler_8cpp.xml
+
+
+// File: IDistribution2DSampler_8h.xml
+
+
+// File: ILayout_8cpp.xml
+
+
+// File: ILayout_8h.xml
+
+
+// File: IPeakShape_8cpp.xml
+
+
+// File: IPeakShape_8h.xml
+
+
// File: ConvolutionDetectorResolution_8cpp.xml
@@ -18797,6 +18663,12 @@ global helper function for comparison of axes
// File: RectangularDetector_8h.xml
+// File: RectangularPixel_8cpp.xml
+
+
+// File: RectangularPixel_8h.xml
+
+
// File: RegionOfInterest_8cpp.xml
@@ -18815,6 +18687,18 @@ global helper function for comparison of axes
// File: ScanResolution_8h.xml
+// File: SimulationArea_8cpp.xml
+
+
+// File: SimulationArea_8h.xml
+
+
+// File: SimulationAreaIterator_8cpp.xml
+
+
+// File: SimulationAreaIterator_8h.xml
+
+
// File: SpecularDetector1D_8cpp.xml
@@ -18827,6 +18711,12 @@ global helper function for comparison of axes
// File: SphericalDetector_8h.xml
+// File: SphericalPixel_8cpp.xml
+
+
+// File: SphericalPixel_8h.xml
+
+
// File: ExportToPython_8cpp.xml
@@ -18836,6 +18726,9 @@ global helper function for comparison of axes
// File: INodeUtils_8h.xml
+// File: OrderedMap_8h.xml
+
+
// File: SampleLabelHandler_8cpp.xml
@@ -18950,6 +18843,12 @@ global helper function for comparison of axes
// File: FormFactorCone6_8h.xml
+// File: FormFactorCosineRipple_8cpp.xml
+
+
+// File: FormFactorCosineRipple_8h.xml
+
+
// File: FormFactorCuboctahedron_8cpp.xml
@@ -19046,16 +18945,10 @@ global helper function for comparison of axes
// File: FormFactorPyramid_8h.xml
-// File: FormFactorRipple1_8cpp.xml
-
-
-// File: FormFactorRipple1_8h.xml
+// File: FormFactorSawtoothRipple_8cpp.xml
-// File: FormFactorRipple2_8cpp.xml
-
-
-// File: FormFactorRipple2_8h.xml
+// File: FormFactorSawtoothRipple_8h.xml
// File: FormFactorTetrahedron_8cpp.xml
@@ -19088,22 +18981,10 @@ global helper function for comparison of axes
// File: FormFactorTruncatedSpheroid_8h.xml
-// File: ProfileBar_8cpp.xml
-
-
-// File: ProfileBar_8h.xml
-
-
-// File: ProfileRipple1_8cpp.xml
-
+// File: IProfileRipple_8cpp.xml
-// File: ProfileRipple1_8h.xml
-
-// File: ProfileRipple2_8cpp.xml
-
-
-// File: ProfileRipple2_8h.xml
+// File: IProfileRipple_8h.xml
// File: Ripples_8cpp.xml
@@ -19187,30 +19068,12 @@ global helper function for comparison of axes
// File: AngularSpecScan_8h.xml
-// File: ArrayUtils_8cpp.xml
-
-
-// File: ArrayUtils_8h.xml
-
-
-// File: AxisNames_8cpp.xml
-
-
-// File: AxisNames_8h.xml
-
-
// File: ChiSquaredModule_8cpp.xml
// File: ChiSquaredModule_8h.xml
-// File: CumulativeValue_8cpp.xml
-
-
-// File: CumulativeValue_8h.xml
-
-
// File: FourierTransform_8cpp.xml
@@ -19265,6 +19128,24 @@ global helper function for comparison of axes
// File: VarianceFunctions_8h.xml
+// File: ArrayUtils_8cpp.xml
+
+
+// File: ArrayUtils_8h.xml
+
+
+// File: AxisNames_8cpp.xml
+
+
+// File: AxisNames_8h.xml
+
+
+// File: CumulativeValue_8cpp.xml
+
+
+// File: CumulativeValue_8h.xml
+
+
// File: Histogram1D_8cpp.xml
@@ -19289,12 +19170,6 @@ global helper function for comparison of axes
// File: IIntensityFunction_8h.xml
-// File: IIntensityNormalizer_8cpp.xml
-
-
-// File: IIntensityNormalizer_8h.xml
-
-
// File: IntensityDataFunctions_8cpp.xml
@@ -19334,18 +19209,6 @@ make Swappable
// File: SimpleUnitConverters_8h.xml
-// File: SimulationArea_8cpp.xml
-
-
-// File: SimulationArea_8h.xml
-
-
-// File: SimulationAreaIterator_8cpp.xml
-
-
-// File: SimulationAreaIterator_8h.xml
-
-
// File: UnitConverter1D_8cpp.xml
@@ -19367,9 +19230,6 @@ make Swappable
// File: Lattice_8h.xml
-// File: Lattice1DParameters_8h.xml
-
-
// File: Lattice2D_8cpp.xml
@@ -19468,11 +19328,6 @@ magnetization:
magnetization (in A/m)
";
-%feature("docstring") CreateAveragedMaterial "Material CreateAveragedMaterial(const Material &layer_mat, const std::vector< HomogeneousRegion > ®ions)
-
-Creates averaged material. Square refractive index of returned material is arithmetic mean over regions and layer_mat. Magnetization (if present) is averaged linearly.
-";
-
// File: MaterialFactoryFuncs_8h.xml
%feature("docstring") HomogeneousMaterial "BA_CORE_API_ Material HomogeneousMaterial()
@@ -19509,11 +19364,6 @@ magnetization:
magnetization (in A/m)
";
-%feature("docstring") CreateAveragedMaterial "BA_CORE_API_ Material CreateAveragedMaterial(const Material &layer_mat, const std::vector< HomogeneousRegion > ®ions)
-
-Creates averaged material. Square refractive index of returned material is arithmetic mean over regions and layer_mat. Magnetization (if present) is averaged linearly.
-";
-
// File: MaterialUtils_8cpp.xml
%feature("docstring") Unit_Matrix "const Eigen::Matrix2cd Unit_Matrix(Eigen::Matrix2cd::Identity())
@@ -19577,9 +19427,6 @@ Creates averaged material. Square refractive index of returned material is arith
// File: IInterferenceFunctionStrategy_8h.xml
-// File: ILayerRTCoefficients_8h.xml
-
-
// File: IMultiLayerBuilder_8cpp.xml
@@ -19625,68 +19472,22 @@ Creates averaged material. Square refractive index of returned material is arith
// File: LayerRoughness_8h.xml
-// File: LayoutStrategyBuilder_8cpp.xml
-
-
-// File: LayoutStrategyBuilder_8h.xml
-
-
// File: MatrixFresnelMap_8cpp.xml
// File: MatrixFresnelMap_8h.xml
-// File: MatrixRTCoefficients_8cpp.xml
-
-
-// File: MatrixRTCoefficients_8h.xml
-
-
-// File: MatrixRTCoefficients__v2_8cpp.xml
-
-
-// File: MatrixRTCoefficients__v2_8h.xml
-
-
// File: MultiLayer_8cpp.xml
// File: MultiLayer_8h.xml
-// File: MultiLayerFuncs_8cpp.xml
-%feature("docstring") MaterialProfile "std::vector<complex_t> MaterialProfile(const MultiLayer &multilayer, int n_points, double z_min, double z_max)
-
-Calculate average material profile for given multilayer.
-";
-
-%feature("docstring") DefaultMaterialProfileLimits "std::pair<double, double> DefaultMaterialProfileLimits(const MultiLayer &multilayer)
-
-Get default z limits for generating a material profile.
-";
-
-%feature("docstring") GenerateZValues "std::vector<double> GenerateZValues(int n_points, double z_min, double z_max)
-
-Generate z values (equidistant) for use in MaterialProfile.
-";
-
-
-// File: MultiLayerFuncs_8h.xml
-%feature("docstring") MaterialProfile "BA_CORE_API_ std::vector<complex_t> MaterialProfile(const MultiLayer &multilayer, int n_points, double z_min, double z_max)
-
-Calculate average material profile for given multilayer.
-";
-
-%feature("docstring") DefaultMaterialProfileLimits "BA_CORE_API_ std::pair<double, double> DefaultMaterialProfileLimits(const MultiLayer &multilayer)
-
-Get default z limits for generating a material profile.
-";
+// File: MultiLayerUtils_8cpp.xml
-%feature("docstring") GenerateZValues "BA_CORE_API_ std::vector<double> GenerateZValues(int n_points, double z_min, double z_max)
-Generate z values (equidistant) for use in MaterialProfile.
-";
+// File: MultiLayerUtils_8h.xml
// File: RoughnessModels_8cpp.xml
@@ -19713,7 +19514,16 @@ Generate z values (equidistant) for use in MaterialProfile.
// File: ScalarFresnelMap_8h.xml
-// File: ScalarRTCoefficients_8h.xml
+// File: Slice_8cpp.xml
+
+
+// File: Slice_8h.xml
+
+
+// File: SlicedFormFactorList_8cpp.xml
+
+
+// File: SlicedFormFactorList_8h.xml
// File: SpecularMagneticOldStrategy_8cpp.xml
@@ -19746,10 +19556,10 @@ Generate z values (equidistant) for use in MaterialProfile.
// File: SpecularScalarTanhStrategy_8h.xml
-// File: SpecularStrategyBuilder_8cpp.xml
+// File: SpecularSimulationElement_8cpp.xml
-// File: SpecularStrategyBuilder_8h.xml
+// File: SpecularSimulationElement_8h.xml
// File: SSCAHelper_8cpp.xml
@@ -19777,9 +19587,13 @@ Generate z values (equidistant) for use in MaterialProfile.
// File: INode_8cpp.xml
+%feature("docstring") nodeMetaUnion "NodeMeta nodeMetaUnion(const std::vector< ParaMeta > &base, const NodeMeta &other)
+";
// File: INode_8h.xml
+%feature("docstring") nodeMetaUnion "NodeMeta nodeMetaUnion(const std::vector< ParaMeta > &base, const NodeMeta &other)
+";
// File: INodeVisitor_8cpp.xml
@@ -19876,9 +19690,6 @@ Generate z values (equidistant) for use in MaterialProfile.
// File: Unit_8h.xml
-// File: Units_8h.xml
-
-
// File: Crystal_8cpp.xml
@@ -19903,7 +19714,18 @@ Generate z values (equidistant) for use in MaterialProfile.
// File: FormFactorWeighted_8h.xml
+// File: HomogeneousRegion_8cpp.xml
+%feature("docstring") CreateAveragedMaterial "Material CreateAveragedMaterial(const Material &layer_mat, const std::vector< HomogeneousRegion > ®ions)
+
+Creates averaged material. Square refractive index of returned material is arithmetic mean over regions and layer_mat. Magnetization (if present) is averaged linearly.
+";
+
+
// File: HomogeneousRegion_8h.xml
+%feature("docstring") CreateAveragedMaterial "BA_CORE_API_ Material CreateAveragedMaterial(const Material &layer_mat, const std::vector< HomogeneousRegion > ®ions)
+
+Creates averaged material. Square refractive index of returned material is arithmetic mean over regions and layer_mat. Magnetization (if present) is averaged linearly.
+";
// File: IAbstractParticle_8cpp.xml
@@ -19951,15 +19773,6 @@ Generate z values (equidistant) for use in MaterialProfile.
// File: ParticleDistribution_8h.xml
-// File: SlicedFormFactorList_8cpp.xml
-
-
-// File: SlicedFormFactorList_8h.xml
-
-
-// File: SlicedParticle_8cpp.xml
-
-
// File: SlicedParticle_8h.xml
@@ -19984,6 +19797,24 @@ Generate z values (equidistant) for use in MaterialProfile.
// File: PythonFormatting_8h.xml
+// File: ILayerRTCoefficients_8h.xml
+
+
+// File: MatrixRTCoefficients_8cpp.xml
+
+
+// File: MatrixRTCoefficients_8h.xml
+
+
+// File: MatrixRTCoefficients__v2_8cpp.xml
+
+
+// File: MatrixRTCoefficients__v2_8h.xml
+
+
+// File: ScalarRTCoefficients_8h.xml
+
+
// File: FormFactorDecoratorMaterial_8cpp.xml
@@ -20033,9 +19864,6 @@ Generate z values (equidistant) for use in MaterialProfile.
Returns concatenated rotation (first right, then left).
";
-%feature("docstring") IsZRotation "bool IsZRotation(const IRotation &rot)
-";
-
// File: Rotations_8h.xml
%feature("docstring") createProduct "BA_CORE_API_ IRotation* createProduct(const IRotation &left, const IRotation &right)
@@ -20043,9 +19871,6 @@ Returns concatenated rotation (first right, then left).
Returns concatenated rotation (first right, then left).
";
-%feature("docstring") IsZRotation "bool IsZRotation(const IRotation &rot)
-";
-
// File: ZLimits_8cpp.xml
%feature("docstring") MinLimit "OneSidedLimit MinLimit(const OneSidedLimit &left, const OneSidedLimit &right)
@@ -20127,12 +19952,6 @@ Generate vertices of centered ellipse with given semi-axes at height z.
// File: TruncatedEllipsoid_8h.xml
-// File: Convert_8cpp.xml
-
-
-// File: Convert_8h.xml
-
-
// File: DepthProbeSimulation_8cpp.xml
@@ -20169,12 +19988,24 @@ Generate vertices of centered ellipse with given semi-axes at height z.
// File: Simulation2D_8h.xml
+// File: SimulationFactory_8cpp.xml
+
+
+// File: SimulationFactory_8h.xml
+
+
// File: SpecularSimulation_8cpp.xml
// File: SpecularSimulation_8h.xml
+// File: StandardSimulations_8cpp.xml
+
+
+// File: StandardSimulations_8h.xml
+
+
// File: UnitConverterUtils_8cpp.xml
@@ -20199,36 +20030,12 @@ Generate vertices of centered ellipse with given semi-axes at height z.
// File: SimulationElement_8h.xml
-// File: SpecularSimulationElement_8cpp.xml
-
-
-// File: SpecularSimulationElement_8h.xml
-
-
-// File: FormFactorDebyeBueche_8cpp.xml
-
-
-// File: FormFactorDebyeBueche_8h.xml
-
-
// File: FormFactorGauss_8cpp.xml
// File: FormFactorGauss_8h.xml
-// File: FormFactorLorentz_8cpp.xml
-
-
-// File: FormFactorLorentz_8h.xml
-
-
-// File: FormFactorOrnsteinZernike_8cpp.xml
-
-
-// File: FormFactorOrnsteinZernike_8h.xml
-
-
// File: FormFactorSphereGaussianRadius_8cpp.xml
@@ -20408,12 +20215,6 @@ Generate vertices of centered ellipse with given semi-axes at height z.
// File: SampleComponents_8h.xml
-// File: SimulationFactory_8cpp.xml
-
-
-// File: SimulationFactory_8h.xml
-
-
// File: SizeDistributionModelsBuilder_8cpp.xml
@@ -20432,12 +20233,6 @@ Generate vertices of centered ellipse with given semi-axes at height z.
// File: SlicedParticleBuilder_8h.xml
-// File: StandardSimulations_8cpp.xml
-
-
-// File: StandardSimulations_8h.xml
-
-
// File: ThickAbsorptiveSampleBuilder_8cpp.xml
@@ -20487,10 +20282,13 @@ Template function to create an integrator object
// File: MathFunctions_8h.xml
-// File: OrderedMap_8h.xml
+// File: Precomputed_8h.xml
-// File: Precomputed_8h.xml
+// File: PyFmt_8cpp.xml
+
+
+// File: PyFmt_8h.xml
// File: PyObject_8h.xml
@@ -20525,6 +20323,12 @@ Creates a vector<double> as a wavevector with given wavelength and angles. Speci
// File: EigenCore_8h.xml
+// File: SomeFormFactors_8cpp.xml
+
+
+// File: SomeFormFactors_8h.xml
+
+
// File: Transform3D_8cpp.xml
@@ -20561,6 +20365,9 @@ Creates a vector<double> as a wavevector with given wavelength and angles. Speci
// File: dir_c6310732a22f63c0c2fc5595561e68f1.xml
+// File: dir_fa96dd1f1e0fa8c53ad7561c23a2a056.xml
+
+
// File: dir_44f78a63fb6824b6161080fb024dfdfe.xml
@@ -20606,6 +20413,9 @@ Creates a vector<double> as a wavevector with given wavelength and angles. Speci
// File: dir_437a42df1810106c8392af0ca05a14b2.xml
+// File: dir_8e60847f0ac26e3d8a13e8a06357123f.xml
+
+
// File: dir_6babb1605c026604526d064f820d612b.xml
diff --git a/auto/Wrap/libBornAgainCore.py b/auto/Wrap/libBornAgainCore.py
index 0cf0c748d5d..6bc0f1e2b0d 100644
--- a/auto/Wrap/libBornAgainCore.py
+++ b/auto/Wrap/libBornAgainCore.py
@@ -2499,7 +2499,7 @@ class kvector_t(object):
r"""
- Forked from CLHEP/Geometry by E. Chernyaev Evgueni.Tcherniaev@cern.ch, then reworked beyond recongnition. Removed split of point and vector semantics. Transforms are relegated to a separate class Transform3D. Three-dimensional vector template, for use with integer, double, or complex components.
+ Forked from CLHEP/Geometry by E. Chernyaev Evgueni.Tcherniaev@cern.ch, then reworked beyond recognition. Removed split of point and vector semantics. Transforms are relegated to a separate class Transform3D. Three-dimensional vector template, for use with integer, double, or complex components.
C++ includes: BasicVector3D.h
@@ -2918,7 +2918,7 @@ class cvector_t(object):
r"""
- Forked from CLHEP/Geometry by E. Chernyaev Evgueni.Tcherniaev@cern.ch, then reworked beyond recongnition. Removed split of point and vector semantics. Transforms are relegated to a separate class Transform3D. Three-dimensional vector template, for use with integer, double, or complex components.
+ Forked from CLHEP/Geometry by E. Chernyaev Evgueni.Tcherniaev@cern.ch, then reworked beyond recognition. Removed split of point and vector semantics. Transforms are relegated to a separate class Transform3D. Three-dimensional vector template, for use with integer, double, or complex components.
C++ includes: BasicVector3D.h
@@ -6107,7 +6107,14 @@ def IParameterized_ZComponentName(base_name):
return _libBornAgainCore.IParameterized_ZComponentName(base_name)
class ParaMeta(object):
- r"""Proxy of C++ ParaMeta class."""
+ r"""
+
+
+ Metadata of one model parameter.
+
+ C++ includes: INode.h
+
+ """
thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
__repr__ = _swig_repr
@@ -6119,7 +6126,15 @@ class ParaMeta(object):
vDefault = property(_libBornAgainCore.ParaMeta_vDefault_get, _libBornAgainCore.ParaMeta_vDefault_set, doc=r"""vDefault : double""")
def __init__(self):
- r"""__init__(ParaMeta self) -> ParaMeta"""
+ r"""
+ __init__(ParaMeta self) -> ParaMeta
+
+
+ Metadata of one model parameter.
+
+ C++ includes: INode.h
+
+ """
_libBornAgainCore.ParaMeta_swiginit(self, _libBornAgainCore.new_ParaMeta())
__swig_destroy__ = _libBornAgainCore.delete_ParaMeta
@@ -6128,7 +6143,14 @@ _libBornAgainCore.ParaMeta_swigregister(ParaMeta)
INF = cvar.INF
class NodeMeta(object):
- r"""Proxy of C++ NodeMeta class."""
+ r"""
+
+
+ Metadata of one model node.
+
+ C++ includes: INode.h
+
+ """
thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
__repr__ = _swig_repr
@@ -6137,7 +6159,15 @@ class NodeMeta(object):
paraMeta = property(_libBornAgainCore.NodeMeta_paraMeta_get, _libBornAgainCore.NodeMeta_paraMeta_set, doc=r"""paraMeta : std::vector<(ParaMeta,std::allocator<(ParaMeta)>)>""")
def __init__(self):
- r"""__init__(NodeMeta self) -> NodeMeta"""
+ r"""
+ __init__(NodeMeta self) -> NodeMeta
+
+
+ Metadata of one model node.
+
+ C++ includes: INode.h
+
+ """
_libBornAgainCore.NodeMeta_swiginit(self, _libBornAgainCore.new_NodeMeta())
__swig_destroy__ = _libBornAgainCore.delete_NodeMeta
@@ -6146,7 +6176,11 @@ _libBornAgainCore.NodeMeta_swigregister(NodeMeta)
def nodeMetaUnion(base, other):
- r"""nodeMetaUnion(std::vector< ParaMeta,std::allocator< ParaMeta > > const & base, NodeMeta other) -> NodeMeta"""
+ r"""
+ nodeMetaUnion(std::vector< ParaMeta,std::allocator< ParaMeta > > const & base, NodeMeta other) -> NodeMeta
+ NodeMeta nodeMetaUnion(const std::vector< ParaMeta > &base, const NodeMeta &other)
+
+ """
return _libBornAgainCore.nodeMetaUnion(base, other)
class INode(IParameterized):
r"""
@@ -6165,7 +6199,7 @@ class INode(IParameterized):
r"""
__init__(INode self) -> INode
__init__(INode self, NodeMeta meta, vdouble1d_t PValues) -> INode
- INode::INode(const INode *parent, const std::vector< const char * > PName, const std::vector< const char * > PUnit, const std::vector< double > PMin, const std::vector< double > PMax, const std::vector< double > PDefault, std::vector< double > P)
+ INode::INode(const NodeMeta &meta, const std::vector< double > &PValues)
"""
if self.__class__ == INode:
@@ -6696,7 +6730,7 @@ class DistributionGate(IDistribution1D):
__init__(DistributionGate self, vdouble1d_t P) -> DistributionGate
__init__(DistributionGate self, double min, double max) -> DistributionGate
__init__(DistributionGate self) -> DistributionGate
- DistributionGate::DistributionGate(double min, double max)
+ DistributionGate::DistributionGate()
"""
_libBornAgainCore.DistributionGate_swiginit(self, _libBornAgainCore.new_DistributionGate(*args))
@@ -6797,7 +6831,7 @@ class DistributionLorentz(IDistribution1D):
__init__(DistributionLorentz self, vdouble1d_t P) -> DistributionLorentz
__init__(DistributionLorentz self, double mean, double hwhm) -> DistributionLorentz
__init__(DistributionLorentz self) -> DistributionLorentz
- DistributionLorentz::DistributionLorentz(double mean, double hwhm)
+ DistributionLorentz::DistributionLorentz()
"""
_libBornAgainCore.DistributionLorentz_swiginit(self, _libBornAgainCore.new_DistributionLorentz(*args))
@@ -6890,7 +6924,7 @@ class DistributionGaussian(IDistribution1D):
__init__(DistributionGaussian self, vdouble1d_t P) -> DistributionGaussian
__init__(DistributionGaussian self, double mean, double std_dev) -> DistributionGaussian
__init__(DistributionGaussian self) -> DistributionGaussian
- DistributionGaussian::DistributionGaussian(double mean, double std_dev)
+ DistributionGaussian::DistributionGaussian()
"""
_libBornAgainCore.DistributionGaussian_swiginit(self, _libBornAgainCore.new_DistributionGaussian(*args))
@@ -6982,7 +7016,7 @@ class DistributionLogNormal(IDistribution1D):
r"""
__init__(DistributionLogNormal self, vdouble1d_t P) -> DistributionLogNormal
__init__(DistributionLogNormal self, double median, double scale_param) -> DistributionLogNormal
- DistributionLogNormal::DistributionLogNormal(double median, double scale_param)
+ DistributionLogNormal::DistributionLogNormal()=delete
"""
_libBornAgainCore.DistributionLogNormal_swiginit(self, _libBornAgainCore.new_DistributionLogNormal(*args))
@@ -7093,7 +7127,7 @@ class DistributionCosine(IDistribution1D):
__init__(DistributionCosine self, vdouble1d_t P) -> DistributionCosine
__init__(DistributionCosine self, double mean, double sigma) -> DistributionCosine
__init__(DistributionCosine self) -> DistributionCosine
- DistributionCosine::DistributionCosine(double mean, double sigma)
+ DistributionCosine::DistributionCosine()
"""
_libBornAgainCore.DistributionCosine_swiginit(self, _libBornAgainCore.new_DistributionCosine(*args))
@@ -7186,7 +7220,7 @@ class DistributionTrapezoid(IDistribution1D):
__init__(DistributionTrapezoid self, vdouble1d_t P) -> DistributionTrapezoid
__init__(DistributionTrapezoid self, double center, double left, double middle, double right) -> DistributionTrapezoid
__init__(DistributionTrapezoid self) -> DistributionTrapezoid
- DistributionTrapezoid::DistributionTrapezoid(double center, double left_width, double middle_width, double right_width)
+ DistributionTrapezoid::DistributionTrapezoid()
"""
_libBornAgainCore.DistributionTrapezoid_swiginit(self, _libBornAgainCore.new_DistributionTrapezoid(*args))
@@ -7957,7 +7991,7 @@ class ISample(ICloneable, INode):
r"""
__init__(ISample self) -> ISample
__init__(ISample self, NodeMeta meta, vdouble1d_t PValues) -> ISample
- ISample::ISample(const INode *parent, const std::vector< const char * > PName, const std::vector< const char * > PUnit, const std::vector< double > PMin, const std::vector< double > PMax, const std::vector< double > PDefault, std::vector< double > P)
+ ISample::ISample(const NodeMeta &meta, const std::vector< double > &PValues)
"""
if self.__class__ == ISample:
@@ -8025,7 +8059,7 @@ class IFormFactor(ISample):
r"""
__init__(IFormFactor self) -> IFormFactor
__init__(IFormFactor self, NodeMeta meta, vdouble1d_t PValues) -> IFormFactor
- IFormFactor::IFormFactor(const INode *parent, const std::vector< const char * > PName, const std::vector< const char * > PUnit, const std::vector< double > PMin, const std::vector< double > PMax, const std::vector< double > PDefault, std::vector< double > P)
+ IFormFactor::IFormFactor(const NodeMeta &meta, const std::vector< double > &PValues)
"""
if self.__class__ == IFormFactor:
@@ -8157,7 +8191,7 @@ class IFormFactorBorn(IFormFactor):
r"""
__init__(IFormFactorBorn self) -> IFormFactorBorn
__init__(IFormFactorBorn self, NodeMeta meta, vdouble1d_t PValues) -> IFormFactorBorn
- IFormFactorBorn::IFormFactorBorn(const INode *parent, const std::vector< const char * > PName, const std::vector< const char * > PUnit, const std::vector< double > PMin, const std::vector< double > PMax, const std::vector< double > PDefault, std::vector< double > P)
+ IFormFactorBorn::IFormFactorBorn(const NodeMeta &meta, const std::vector< double > &PValues)
"""
if self.__class__ == IFormFactorBorn:
@@ -8395,8 +8429,6 @@ class IRotation(ICloneable, INode):
clone(IRotation self) -> IRotation
virtual IRotation* IRotation::clone() const =0
- Returns a clone of this ISample object.
-
"""
return _libBornAgainCore.IRotation_clone(self)
@@ -8421,7 +8453,11 @@ class IRotation(ICloneable, INode):
return _libBornAgainCore.IRotation_getTransform3D(self)
def transformed(self, v):
- r"""transformed(IRotation self, kvector_t v) -> kvector_t"""
+ r"""
+ transformed(IRotation self, kvector_t v) -> kvector_t
+ kvector_t IRotation::transformed(const kvector_t &v) const
+
+ """
return _libBornAgainCore.IRotation_transformed(self, v)
def isIdentity(self):
@@ -8435,7 +8471,11 @@ class IRotation(ICloneable, INode):
return _libBornAgainCore.IRotation_isIdentity(self)
def zInvariant(self):
- r"""zInvariant(IRotation self) -> bool"""
+ r"""
+ zInvariant(IRotation self) -> bool
+ bool IRotation::zInvariant() const
+
+ """
return _libBornAgainCore.IRotation_zInvariant(self)
__swig_destroy__ = _libBornAgainCore.delete_IRotation
@@ -8476,7 +8516,7 @@ class IdentityRotation(IRotation):
def __init__(self):
r"""
__init__(IdentityRotation self) -> IdentityRotation
- IdentityRotation::IdentityRotation()=default
+ IdentityRotation::IdentityRotation()
"""
_libBornAgainCore.IdentityRotation_swiginit(self, _libBornAgainCore.new_IdentityRotation())
@@ -8486,8 +8526,6 @@ class IdentityRotation(IRotation):
clone(IdentityRotation self) -> IdentityRotation
IdentityRotation* IdentityRotation::clone() const
- Returns a clone of this ISample object.
-
"""
return _libBornAgainCore.IdentityRotation_clone(self)
@@ -8554,14 +8592,6 @@ class RotationX(IRotation):
__init__(RotationX self, double angle) -> RotationX
RotationX::RotationX(double angle)
- Constructor of rotation around x-axis
-
- Parameters:
- -----------
-
- angle:
- rotation angle around x-axis in radians
-
"""
_libBornAgainCore.RotationX_swiginit(self, _libBornAgainCore.new_RotationX(*args))
@@ -8570,8 +8600,6 @@ class RotationX(IRotation):
clone(RotationX self) -> RotationX
RotationX* RotationX::clone() const
- Returns a clone of this ISample object.
-
"""
return _libBornAgainCore.RotationX_clone(self)
@@ -8636,14 +8664,6 @@ class RotationY(IRotation):
__init__(RotationY self, double angle) -> RotationY
RotationY::RotationY(double angle)
- Constructor of rotation around y-axis
-
- Parameters:
- -----------
-
- angle:
- rotation angle around y-axis in radians
-
"""
_libBornAgainCore.RotationY_swiginit(self, _libBornAgainCore.new_RotationY(*args))
@@ -8652,8 +8672,6 @@ class RotationY(IRotation):
clone(RotationY self) -> RotationY
RotationY* RotationY::clone() const
- Returns a clone of this ISample object.
-
"""
return _libBornAgainCore.RotationY_clone(self)
@@ -8716,15 +8734,7 @@ class RotationZ(IRotation):
r"""
__init__(RotationZ self, vdouble1d_t P) -> RotationZ
__init__(RotationZ self, double angle) -> RotationZ
- RotationZ::RotationZ(double angle=0.0)
-
- Constructor of rotation around z-axis
-
- Parameters:
- -----------
-
- angle:
- rotation angle around z-axis in radians
+ RotationZ::RotationZ(double angle)
"""
_libBornAgainCore.RotationZ_swiginit(self, _libBornAgainCore.new_RotationZ(*args))
@@ -8734,8 +8744,6 @@ class RotationZ(IRotation):
clone(RotationZ self) -> RotationZ
RotationZ* RotationZ::clone() const
- Returns a clone of this ISample object.
-
"""
return _libBornAgainCore.RotationZ_clone(self)
@@ -8800,20 +8808,6 @@ class RotationEuler(IRotation):
__init__(RotationEuler self, double alpha, double beta, double gamma) -> RotationEuler
RotationEuler::RotationEuler(double alpha, double beta, double gamma)
- Constructor of Euler rotation (sequence of three rotations following Euler angles notation z-x'-z').
-
- Parameters:
- -----------
-
- alpha:
- first Euler angle in radians
-
- beta:
- second Euler angle in radians
-
- gamma:
- third Euler angle in radians
-
"""
_libBornAgainCore.RotationEuler_swiginit(self, _libBornAgainCore.new_RotationEuler(*args))
@@ -8822,8 +8816,6 @@ class RotationEuler(IRotation):
clone(RotationEuler self) -> RotationEuler
RotationEuler* RotationEuler::clone() const
- Returns a clone of this ISample object.
-
"""
return _libBornAgainCore.RotationEuler_clone(self)
@@ -10227,7 +10219,7 @@ class IFTDecayFunction1D(ICloneable, INode):
Interface for a one-dimensional decay function, with evaluate(q) returning the Fourier transform, normalized to $\\int dq\\; {\\rm evaluate}(q) = 1$.
- C++ includes: FTDecayFunctions.h
+ C++ includes: FTDecay1D.h
"""
@@ -10271,7 +10263,7 @@ class FTDecayFunction1DCauchy(IFTDecayFunction1D):
One-dimensional Cauchy decay function in reciprocal space; corresponds to exp(-|x|/decay_length) in real space.
- C++ includes: FTDecayFunctions.h
+ C++ includes: FTDecay1D.h
"""
@@ -10323,7 +10315,7 @@ class FTDecayFunction1DGauss(IFTDecayFunction1D):
One-dimensional Gauss decay function in reciprocal space; corresponds to exp[-x^2/(2*decay_length^2)] in real space.
- C++ includes: FTDecayFunctions.h
+ C++ includes: FTDecay1D.h
"""
@@ -10375,7 +10367,7 @@ class FTDecayFunction1DTriangle(IFTDecayFunction1D):
One-dimensional triangle decay function in reciprocal space; corresponds to 1-|x|/decay_length if |x|<decay_length (and 0 otherwise) in real space.
- C++ includes: FTDecayFunctions.h
+ C++ includes: FTDecay1D.h
"""
@@ -10427,7 +10419,7 @@ class FTDecayFunction1DVoigt(IFTDecayFunction1D):
One-dimensional pseudo-Voigt decay function in reciprocal space; corresponds to eta*Gauss + (1-eta)*Cauchy.
- C++ includes: FTDecayFunctions.h
+ C++ includes: FTDecay1D.h
"""
@@ -10440,17 +10432,6 @@ class FTDecayFunction1DVoigt(IFTDecayFunction1D):
__init__(FTDecayFunction1DVoigt self, double decay_length, double eta) -> FTDecayFunction1DVoigt
FTDecayFunction1DVoigt::FTDecayFunction1DVoigt(double decay_length, double eta)
- Constructor of pseudo-Voigt decay function.
-
- Parameters:
- -----------
-
- decay_length:
- half-width of the distribution in nanometers
-
- eta:
- parameter [0,1] to balance between Cauchy (eta=0.0) and Gauss (eta=1.0)
-
"""
_libBornAgainCore.FTDecayFunction1DVoigt_swiginit(self, _libBornAgainCore.new_FTDecayFunction1DVoigt(*args))
@@ -10498,7 +10479,7 @@ class IFTDecayFunction2D(ICloneable, INode):
Interface for two-dimensional decay function in reciprocal space.
- C++ includes: FTDecayFunctions.h
+ C++ includes: FTDecay2D.h
"""
@@ -10578,7 +10559,7 @@ class FTDecayFunction2DCauchy(IFTDecayFunction2D):
Two-dimensional Cauchy decay function in reciprocal space; corresponds to exp(-r) in real space, with $r=\\sqrt{(\\frac{x}{\\omega_x})^2 + (\\frac{y}{\\omega_y})^2}$.
- C++ includes: FTDecayFunctions.h
+ C++ includes: FTDecay2D.h
"""
@@ -10589,7 +10570,7 @@ class FTDecayFunction2DCauchy(IFTDecayFunction2D):
r"""
__init__(FTDecayFunction2DCauchy self, vdouble1d_t P) -> FTDecayFunction2DCauchy
__init__(FTDecayFunction2DCauchy self, double decay_length_x, double decay_length_y, double gamma) -> FTDecayFunction2DCauchy
- FTDecayFunction2DCauchy::FTDecayFunction2DCauchy(double decay_length_x, double decay_length_y, double gamma=0)
+ FTDecayFunction2DCauchy::FTDecayFunction2DCauchy(double decay_length_x, double decay_length_y, double gamma)
"""
_libBornAgainCore.FTDecayFunction2DCauchy_swiginit(self, _libBornAgainCore.new_FTDecayFunction2DCauchy(*args))
@@ -10632,7 +10613,7 @@ class FTDecayFunction2DGauss(IFTDecayFunction2D):
Two-dimensional Gauss decay function in reciprocal space; corresponds to exp(-r^2/2) in real space, with $r=\\sqrt{(\\frac{x}{\\omega_x})^2 + (\\frac{y}{\\omega_y})^2}$.
- C++ includes: FTDecayFunctions.h
+ C++ includes: FTDecay2D.h
"""
@@ -10643,7 +10624,7 @@ class FTDecayFunction2DGauss(IFTDecayFunction2D):
r"""
__init__(FTDecayFunction2DGauss self, vdouble1d_t P) -> FTDecayFunction2DGauss
__init__(FTDecayFunction2DGauss self, double decay_length_x, double decay_length_y, double gamma) -> FTDecayFunction2DGauss
- FTDecayFunction2DGauss::FTDecayFunction2DGauss(double decay_length_x, double decay_length_y, double gamma=0)
+ FTDecayFunction2DGauss::FTDecayFunction2DGauss(double decay_length_x, double decay_length_y, double gamma)
"""
_libBornAgainCore.FTDecayFunction2DGauss_swiginit(self, _libBornAgainCore.new_FTDecayFunction2DGauss(*args))
@@ -10686,7 +10667,7 @@ class FTDecayFunction2DVoigt(IFTDecayFunction2D):
Two-dimensional pseudo-Voigt decay function in reciprocal space; corresponds to eta*Gauss + (1-eta)*Cauchy.
- C++ includes: FTDecayFunctions.h
+ C++ includes: FTDecay2D.h
"""
@@ -10697,24 +10678,7 @@ class FTDecayFunction2DVoigt(IFTDecayFunction2D):
r"""
__init__(FTDecayFunction2DVoigt self, vdouble1d_t P) -> FTDecayFunction2DVoigt
__init__(FTDecayFunction2DVoigt self, double decay_length_x, double decay_length_y, double gamma, double eta) -> FTDecayFunction2DVoigt
- FTDecayFunction2DVoigt::FTDecayFunction2DVoigt(double decay_length_x, double decay_length_y, double eta, double gamma=0)
-
- Constructor of two-dimensional pseudo-Voigt decay function in reciprocal space.
-
- Parameters:
- -----------
-
- decay_length_x:
- the decay length in nanometers along x-axis of the distribution
-
- decay_length_y:
- the decay length in nanometers along y-axis of the distribution
-
- eta:
- parameter [0,1] to balance between Cauchy (eta=0.0) and Gauss (eta=1.0)
-
- gamma:
- distribution orientation with respect to the first lattice vector in radians
+ FTDecayFunction2DVoigt::FTDecayFunction2DVoigt(double decay_length_x, double decay_length_y, double gamma, double eta)
"""
_libBornAgainCore.FTDecayFunction2DVoigt_swiginit(self, _libBornAgainCore.new_FTDecayFunction2DVoigt(*args))
@@ -11154,17 +11118,6 @@ class FTDistribution1DVoigt(IFTDistribution1D):
__init__(FTDistribution1DVoigt self, double omega, double eta) -> FTDistribution1DVoigt
FTDistribution1DVoigt::FTDistribution1DVoigt(double omega, double eta)
- Constructor of one-dimensional pseudo-Voigt probability distribution.
-
- Parameters:
- -----------
-
- omega:
- half-width of the distribution in nanometers
-
- eta:
- parameter [0,1] to balance between Cauchy (eta=0.0) and Gauss (eta=1.0)
-
"""
_libBornAgainCore.FTDistribution1DVoigt_swiginit(self, _libBornAgainCore.new_FTDistribution1DVoigt(*args))
@@ -11271,6 +11224,8 @@ class IFTDistribution2D(ICloneable, INode):
delta(IFTDistribution2D self) -> double
double IFTDistribution2D::delta() const
+ Angle in direct space between X- and Y-axis of distribution.
+
"""
return _libBornAgainCore.IFTDistribution2D_delta(self)
@@ -11305,7 +11260,7 @@ class FTDistribution2DCauchy(IFTDistribution2D):
r"""
__init__(FTDistribution2DCauchy self, vdouble1d_t P) -> FTDistribution2DCauchy
__init__(FTDistribution2DCauchy self, double omega_x, double omega_y, double gamma) -> FTDistribution2DCauchy
- FTDistribution2DCauchy::FTDistribution2DCauchy(double omega_x, double omega_y, double gamma=0)
+ FTDistribution2DCauchy::FTDistribution2DCauchy(double omega_x, double omega_y, double gamma)
"""
_libBornAgainCore.FTDistribution2DCauchy_swiginit(self, _libBornAgainCore.new_FTDistribution2DCauchy(*args))
@@ -11359,7 +11314,7 @@ class FTDistribution2DGauss(IFTDistribution2D):
r"""
__init__(FTDistribution2DGauss self, vdouble1d_t P) -> FTDistribution2DGauss
__init__(FTDistribution2DGauss self, double omega_x, double omega_y, double gamma) -> FTDistribution2DGauss
- FTDistribution2DGauss::FTDistribution2DGauss(double omega_x, double omega_y, double gamma=0)
+ FTDistribution2DGauss::FTDistribution2DGauss(double omega_x, double omega_y, double gamma)
"""
_libBornAgainCore.FTDistribution2DGauss_swiginit(self, _libBornAgainCore.new_FTDistribution2DGauss(*args))
@@ -11413,7 +11368,7 @@ class FTDistribution2DGate(IFTDistribution2D):
r"""
__init__(FTDistribution2DGate self, vdouble1d_t P) -> FTDistribution2DGate
__init__(FTDistribution2DGate self, double omega_x, double omega_y, double gamma) -> FTDistribution2DGate
- FTDistribution2DGate::FTDistribution2DGate(double omega_x, double omega_y, double gamma=0)
+ FTDistribution2DGate::FTDistribution2DGate(double omega_x, double omega_y, double gamma)
"""
_libBornAgainCore.FTDistribution2DGate_swiginit(self, _libBornAgainCore.new_FTDistribution2DGate(*args))
@@ -11467,7 +11422,7 @@ class FTDistribution2DCone(IFTDistribution2D):
r"""
__init__(FTDistribution2DCone self, vdouble1d_t P) -> FTDistribution2DCone
__init__(FTDistribution2DCone self, double omega_x, double omega_y, double gamma) -> FTDistribution2DCone
- FTDistribution2DCone::FTDistribution2DCone(double omega_x, double omega_y, double gamma=0)
+ FTDistribution2DCone::FTDistribution2DCone(double omega_x, double omega_y, double gamma)
"""
_libBornAgainCore.FTDistribution2DCone_swiginit(self, _libBornAgainCore.new_FTDistribution2DCone(*args))
@@ -11521,24 +11476,7 @@ class FTDistribution2DVoigt(IFTDistribution2D):
r"""
__init__(FTDistribution2DVoigt self, vdouble1d_t P) -> FTDistribution2DVoigt
__init__(FTDistribution2DVoigt self, double omega_x, double omega_y, double gamma, double eta) -> FTDistribution2DVoigt
- FTDistribution2DVoigt::FTDistribution2DVoigt(double omega_x, double omega_y, double eta, double gamma=0)
-
- Constructor of two-dimensional pseudo-Voigt probability distribution.
-
- Parameters:
- -----------
-
- omega_x:
- half-width of the distribution along its x-axis in nanometers
-
- omega_y:
- half-width of the distribution along its y-axis in nanometers
-
- eta:
- parameter [0,1] to balance between Cauchy (eta=0.0) and Gauss (eta=1.0)
-
- gamma:
- angle in direct space between first lattice vector and x-axis of the distribution in radians
+ FTDistribution2DVoigt::FTDistribution2DVoigt(double omega_x, double omega_y, double gamma, double eta)
"""
_libBornAgainCore.FTDistribution2DVoigt_swiginit(self, _libBornAgainCore.new_FTDistribution2DVoigt(*args))
@@ -11802,7 +11740,7 @@ class IsotropicLorentzPeakShape(IPeakShape):
r"""
- Class that implements an isotropic Lorentzian peak shape of a Bragg peak.
+ An isotropic Lorentzian peak shape of a Bragg peak.
C++ includes: IPeakShape.h
@@ -11857,7 +11795,7 @@ class GaussFisherPeakShape(IPeakShape):
r"""
- Class that implements a peak shape that is Gaussian in the radial direction and uses the von Mises-Fisher distribution in the angular direction.
+ A peak shape that is Gaussian in the radial direction and uses the Mises-Fisher distribution in the angular direction.
C++ includes: IPeakShape.h
@@ -11922,7 +11860,7 @@ class LorentzFisherPeakShape(IPeakShape):
r"""
- Class that implements a peak shape that is Lorentzian in the radial direction and uses the von Mises-Fisher distribution in the angular direction.
+ A peak shape that is Lorentzian in the radial direction and uses the Mises-Fisher distribution in the angular direction.
C++ includes: IPeakShape.h
@@ -11984,20 +11922,31 @@ class LorentzFisherPeakShape(IPeakShape):
_libBornAgainCore.LorentzFisherPeakShape_swigregister(LorentzFisherPeakShape)
class MisesFisherGaussPeakShape(IPeakShape):
- r"""Proxy of C++ MisesFisherGaussPeakShape class."""
+ r"""
+
+
+ A peak shape that is Gaussian in the radial direction and a convolution of a Mises-Fisher distribution with a Mises distribution on the two-sphere.
+
+ C++ includes: IPeakShape.h
+
+ """
thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
__repr__ = _swig_repr
def __init__(self, max_intensity, radial_size, zenith, kappa_1, kappa_2):
- r"""__init__(MisesFisherGaussPeakShape self, double max_intensity, double radial_size, kvector_t zenith, double kappa_1, double kappa_2) -> MisesFisherGaussPeakShape"""
+ r"""
+ __init__(MisesFisherGaussPeakShape self, double max_intensity, double radial_size, kvector_t zenith, double kappa_1, double kappa_2) -> MisesFisherGaussPeakShape
+ MisesFisherGaussPeakShape::MisesFisherGaussPeakShape(double max_intensity, double radial_size, kvector_t zenith, double kappa_1, double kappa_2)
+
+ """
_libBornAgainCore.MisesFisherGaussPeakShape_swiginit(self, _libBornAgainCore.new_MisesFisherGaussPeakShape(max_intensity, radial_size, zenith, kappa_1, kappa_2))
__swig_destroy__ = _libBornAgainCore.delete_MisesFisherGaussPeakShape
def clone(self):
r"""
clone(MisesFisherGaussPeakShape self) -> MisesFisherGaussPeakShape
- virtual IPeakShape* IPeakShape::clone() const =0
+ MisesFisherGaussPeakShape * MisesFisherGaussPeakShape::clone() const override
Returns a clone of this ISample object.
@@ -12007,7 +11956,7 @@ class MisesFisherGaussPeakShape(IPeakShape):
def accept(self, visitor):
r"""
accept(MisesFisherGaussPeakShape self, INodeVisitor visitor)
- virtual void INode::accept(INodeVisitor *visitor) const =0
+ void MisesFisherGaussPeakShape::accept(INodeVisitor *visitor) const override
Calls the INodeVisitor's visit method.
@@ -12017,7 +11966,7 @@ class MisesFisherGaussPeakShape(IPeakShape):
def evaluate(self, q, q_lattice_point):
r"""
evaluate(MisesFisherGaussPeakShape self, kvector_t q, kvector_t q_lattice_point) -> double
- virtual double IPeakShape::evaluate(const kvector_t q, const kvector_t q_lattice_point) const =0
+ double MisesFisherGaussPeakShape::evaluate(const kvector_t q, const kvector_t q_lattice_point) const override
Evaluates the peak shape at q from a reciprocal lattice point at q_lattice_point.
@@ -12027,7 +11976,7 @@ class MisesFisherGaussPeakShape(IPeakShape):
def angularDisorder(self):
r"""
angularDisorder(MisesFisherGaussPeakShape self) -> bool
- virtual bool IPeakShape::angularDisorder() const
+ bool MisesFisherGaussPeakShape::angularDisorder() const override
Indicates if the peak shape encodes angular disorder, in which case all peaks in a spherical shell are needed
@@ -12038,20 +11987,31 @@ class MisesFisherGaussPeakShape(IPeakShape):
_libBornAgainCore.MisesFisherGaussPeakShape_swigregister(MisesFisherGaussPeakShape)
class MisesGaussPeakShape(IPeakShape):
- r"""Proxy of C++ MisesGaussPeakShape class."""
+ r"""
+
+
+ A peak shape that is a convolution of a Mises-Fisher distribution with a 3d Gaussian.
+
+ C++ includes: IPeakShape.h
+
+ """
thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
__repr__ = _swig_repr
def __init__(self, max_intensity, radial_size, zenith, kappa):
- r"""__init__(MisesGaussPeakShape self, double max_intensity, double radial_size, kvector_t zenith, double kappa) -> MisesGaussPeakShape"""
+ r"""
+ __init__(MisesGaussPeakShape self, double max_intensity, double radial_size, kvector_t zenith, double kappa) -> MisesGaussPeakShape
+ MisesGaussPeakShape::MisesGaussPeakShape(double max_intensity, double radial_size, kvector_t zenith, double kappa)
+
+ """
_libBornAgainCore.MisesGaussPeakShape_swiginit(self, _libBornAgainCore.new_MisesGaussPeakShape(max_intensity, radial_size, zenith, kappa))
__swig_destroy__ = _libBornAgainCore.delete_MisesGaussPeakShape
def clone(self):
r"""
clone(MisesGaussPeakShape self) -> MisesGaussPeakShape
- virtual IPeakShape* IPeakShape::clone() const =0
+ MisesGaussPeakShape * MisesGaussPeakShape::clone() const override
Returns a clone of this ISample object.
@@ -12061,7 +12021,7 @@ class MisesGaussPeakShape(IPeakShape):
def accept(self, visitor):
r"""
accept(MisesGaussPeakShape self, INodeVisitor visitor)
- virtual void INode::accept(INodeVisitor *visitor) const =0
+ void MisesGaussPeakShape::accept(INodeVisitor *visitor) const override
Calls the INodeVisitor's visit method.
@@ -12071,7 +12031,7 @@ class MisesGaussPeakShape(IPeakShape):
def evaluate(self, q, q_lattice_point):
r"""
evaluate(MisesGaussPeakShape self, kvector_t q, kvector_t q_lattice_point) -> double
- virtual double IPeakShape::evaluate(const kvector_t q, const kvector_t q_lattice_point) const =0
+ double MisesGaussPeakShape::evaluate(const kvector_t q, const kvector_t q_lattice_point) const override
Evaluates the peak shape at q from a reciprocal lattice point at q_lattice_point.
@@ -12081,7 +12041,7 @@ class MisesGaussPeakShape(IPeakShape):
def angularDisorder(self):
r"""
angularDisorder(MisesGaussPeakShape self) -> bool
- virtual bool IPeakShape::angularDisorder() const
+ bool MisesGaussPeakShape::angularDisorder() const override
Indicates if the peak shape encodes angular disorder, in which case all peaks in a spherical shell are needed
@@ -12108,7 +12068,7 @@ class IInterferenceFunction(ISample):
r"""
__init__(IInterferenceFunction self, NodeMeta meta, vdouble1d_t PValues) -> IInterferenceFunction
__init__(IInterferenceFunction self, double position_var) -> IInterferenceFunction
- IInterferenceFunction::IInterferenceFunction(const IInterferenceFunction &other)
+ IInterferenceFunction::IInterferenceFunction(double position_var)
"""
if self.__class__ == IInterferenceFunction:
@@ -12269,11 +12229,19 @@ class InterferenceFunction1DLattice(IInterferenceFunction):
return _libBornAgainCore.InterferenceFunction1DLattice_setDecayFunction(self, decay)
def getLength(self):
- r"""getLength(InterferenceFunction1DLattice self) -> double"""
+ r"""
+ getLength(InterferenceFunction1DLattice self) -> double
+ double InterferenceFunction1DLattice::getLength() const
+
+ """
return _libBornAgainCore.InterferenceFunction1DLattice_getLength(self)
def getXi(self):
- r"""getXi(InterferenceFunction1DLattice self) -> double"""
+ r"""
+ getXi(InterferenceFunction1DLattice self) -> double
+ double InterferenceFunction1DLattice::getXi() const
+
+ """
return _libBornAgainCore.InterferenceFunction1DLattice_getXi(self)
def getChildren(self):
@@ -12306,24 +12274,7 @@ class InterferenceFunction2DLattice(IInterferenceFunction):
r"""
__init__(InterferenceFunction2DLattice self, double length_1, double length_2, double alpha, double xi) -> InterferenceFunction2DLattice
__init__(InterferenceFunction2DLattice self, Lattice2D lattice) -> InterferenceFunction2DLattice
- InterferenceFunction2DLattice::InterferenceFunction2DLattice(double length_1, double length_2, double alpha, double xi=0.0)
-
- Constructor of two-dimensional interference function.
-
- Parameters:
- -----------
-
- length_1:
- length of the first basis vector in nanometers
-
- length_2:
- length of the second basis vector in nanometers
-
- alpha:
- angle between the basis vectors in radians
-
- xi:
- rotation of the lattice with respect to the x-axis (beam direction) in radians
+ InterferenceFunction2DLattice::InterferenceFunction2DLattice(const Lattice2D &lattice)
"""
_libBornAgainCore.InterferenceFunction2DLattice_swiginit(self, _libBornAgainCore.new_InterferenceFunction2DLattice(*args))
@@ -12457,7 +12408,7 @@ class InterferenceFunction2DParaCrystal(IInterferenceFunction):
r"""
__init__(InterferenceFunction2DParaCrystal self, Lattice2D lattice, double damping_length, double domain_size_1, double domain_size_2) -> InterferenceFunction2DParaCrystal
__init__(InterferenceFunction2DParaCrystal self, double length_1, double length_2, double alpha, double xi, double damping_length) -> InterferenceFunction2DParaCrystal
- InterferenceFunction2DParaCrystal::InterferenceFunction2DParaCrystal(double length_1, double length_2, double alpha, double xi=0.0, double damping_length=0.0)
+ InterferenceFunction2DParaCrystal::InterferenceFunction2DParaCrystal(double length_1, double length_2, double alpha, double xi, double damping_length)
Constructor of interference function of two-dimensional paracrystal.
@@ -13186,7 +13137,7 @@ class InterferenceFunctionHardDisk(IInterferenceFunction):
def __init__(self, radius, density, position_var=0):
r"""
__init__(InterferenceFunctionHardDisk self, double radius, double density, double position_var=0) -> InterferenceFunctionHardDisk
- InterferenceFunctionHardDisk::InterferenceFunctionHardDisk(double radius, double density)
+ InterferenceFunctionHardDisk::InterferenceFunctionHardDisk(double radius, double density, double position_var=0)
"""
_libBornAgainCore.InterferenceFunctionHardDisk_swiginit(self, _libBornAgainCore.new_InterferenceFunctionHardDisk(radius, density, position_var))
@@ -13302,7 +13253,7 @@ class InterferenceFunctionRadialParaCrystal(IInterferenceFunction):
def __init__(self, peak_distance, damping_length):
r"""
__init__(InterferenceFunctionRadialParaCrystal self, double peak_distance, double damping_length) -> InterferenceFunctionRadialParaCrystal
- InterferenceFunctionRadialParaCrystal::InterferenceFunctionRadialParaCrystal(double peak_distance, double damping_length=0.0)
+ InterferenceFunctionRadialParaCrystal::InterferenceFunctionRadialParaCrystal(double peak_distance, double damping_length)
Constructor of interference function of radial paracrystal.
@@ -14305,21 +14256,7 @@ class LayerRoughness(ISample):
r"""
__init__(LayerRoughness self, double sigma, double hurstParameter, double lateralCorrLength) -> LayerRoughness
__init__(LayerRoughness self) -> LayerRoughness
- LayerRoughness::LayerRoughness(double sigma, double hurstParameter, double lateralCorrLength)
-
- Constructor of layer roughness.
-
- Parameters:
- -----------
-
- sigma:
- rms of the roughness in nanometers
-
- hurstParameter:
- hurst parameter which describes how jagged the interface, dimensionless [0.0, 1.0], where 0.0 gives more spikes, 1.0 more smoothness
-
- lateralCorrLength:
- lateral correlation length of the roughness in nanometers
+ LayerRoughness::LayerRoughness()
"""
_libBornAgainCore.LayerRoughness_swiginit(self, _libBornAgainCore.new_LayerRoughness(*args))
@@ -15081,7 +15018,14 @@ class FormFactorPolygonalSurface(IFormFactorBorn):
_libBornAgainCore.FormFactorPolygonalSurface_swigregister(FormFactorPolygonalSurface)
class IProfileRipple(IFormFactorBorn):
- r"""Proxy of C++ IProfileRipple class."""
+ r"""
+
+
+ Base class for form factors with a cosine ripple profile in the yz plane.
+
+ C++ includes: IProfileRipple.h
+
+ """
thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
@@ -15090,21 +15034,33 @@ class IProfileRipple(IFormFactorBorn):
__repr__ = _swig_repr
def getLength(self):
- r"""getLength(IProfileRipple self) -> double"""
+ r"""
+ getLength(IProfileRipple self) -> double
+ double IProfileRipple::getLength() const
+
+ """
return _libBornAgainCore.IProfileRipple_getLength(self)
def getHeight(self):
- r"""getHeight(IProfileRipple self) -> double"""
+ r"""
+ getHeight(IProfileRipple self) -> double
+ double IProfileRipple::getHeight() const
+
+ """
return _libBornAgainCore.IProfileRipple_getHeight(self)
def getWidth(self):
- r"""getWidth(IProfileRipple self) -> double"""
+ r"""
+ getWidth(IProfileRipple self) -> double
+ double IProfileRipple::getWidth() const
+
+ """
return _libBornAgainCore.IProfileRipple_getWidth(self)
def radialExtension(self):
r"""
radialExtension(IProfileRipple self) -> double
- virtual double IFormFactor::radialExtension() const =0
+ double IProfileRipple::radialExtension() const override final
Returns the (approximate in some cases) radial size of the particle of this form factor's shape. This is used for SSCA calculations
@@ -15114,7 +15070,7 @@ class IProfileRipple(IFormFactorBorn):
def evaluate_for_q(self, q):
r"""
evaluate_for_q(IProfileRipple self, cvector_t q) -> complex_t
- virtual complex_t IFormFactorBorn::evaluate_for_q(cvector_t q) const =0
+ complex_t IProfileRipple::evaluate_for_q(cvector_t q) const override final
Returns scattering amplitude for complex scattering wavevector q=k_i-k_f. This method is public only for convenience of plotting form factors in Python.
@@ -15126,7 +15082,14 @@ class IProfileRipple(IFormFactorBorn):
_libBornAgainCore.IProfileRipple_swigregister(IProfileRipple)
class IProfileRectangularRipple(IProfileRipple):
- r"""Proxy of C++ IProfileRectangularRipple class."""
+ r"""
+
+
+ Base class for form factors with a rectangular ripple (bar) profile in the yz plane.
+
+ C++ includes: IProfileRipple.h
+
+ """
thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
@@ -15139,7 +15102,14 @@ class IProfileRectangularRipple(IProfileRipple):
_libBornAgainCore.IProfileRectangularRipple_swigregister(IProfileRectangularRipple)
class ICosineRipple(IProfileRipple):
- r"""Proxy of C++ ICosineRipple class."""
+ r"""
+
+
+ Base class for form factors with a cosine ripple profile in the yz plane.
+
+ C++ includes: IProfileRipple.h
+
+ """
thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
@@ -15152,7 +15122,14 @@ class ICosineRipple(IProfileRipple):
_libBornAgainCore.ICosineRipple_swigregister(ICosineRipple)
class ISawtoothRipple(IProfileRipple):
- r"""Proxy of C++ ISawtoothRipple class."""
+ r"""
+
+
+ Base class for form factors with a triangular ripple profile in the yz plane.
+
+ C++ includes: IProfileRipple.h
+
+ """
thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
@@ -15161,7 +15138,11 @@ class ISawtoothRipple(IProfileRipple):
__repr__ = _swig_repr
def getAsymmetry(self):
- r"""getAsymmetry(ISawtoothRipple self) -> double"""
+ r"""
+ getAsymmetry(ISawtoothRipple self) -> double
+ double ISawtoothRipple::getAsymmetry() const
+
+ """
return _libBornAgainCore.ISawtoothRipple_getAsymmetry(self)
__swig_destroy__ = _libBornAgainCore.delete_ISawtoothRipple
@@ -15187,23 +15168,6 @@ class FormFactorAnisoPyramid(FormFactorPolyhedron):
__init__(FormFactorAnisoPyramid self, double length, double width, double height, double alpha) -> FormFactorAnisoPyramid
FormFactorAnisoPyramid::FormFactorAnisoPyramid(double length, double width, double height, double alpha)
- Constructor of a truncated pyramid with a rectangular base.
-
- Parameters:
- -----------
-
- length:
- length of the rectangular base in nm
-
- width:
- width of the rectangular base in nm
-
- height:
- height of pyramid in nm
-
- alpha:
- dihedral angle in radians between base and facet
-
"""
_libBornAgainCore.FormFactorAnisoPyramid_swiginit(self, _libBornAgainCore.new_FormFactorAnisoPyramid(*args))
@@ -15282,20 +15246,6 @@ class FormFactorBox(FormFactorPolygonalPrism):
__init__(FormFactorBox self, double length, double width, double height) -> FormFactorBox
FormFactorBox::FormFactorBox(double length, double width, double height)
- Constructor of a rectangular cuboid.
-
- Parameters:
- -----------
-
- length:
- length of the base in nanometers
-
- width:
- width of the base in nanometers
-
- height:
- height of the box in nanometers
-
"""
_libBornAgainCore.FormFactorBox_swiginit(self, _libBornAgainCore.new_FormFactorBox(*args))
@@ -15388,17 +15338,6 @@ class FormFactorCantellatedCube(FormFactorPolyhedron):
__init__(FormFactorCantellatedCube self, double length, double removed_length) -> FormFactorCantellatedCube
FormFactorCantellatedCube::FormFactorCantellatedCube(double length, double removed_length)
- Constructor of a truncated cube.
-
- Parameters:
- -----------
-
- length:
- length of the full cube's edge in nanometers
-
- removed_length:
- removed length from each edge of the cube in nanometers
-
"""
_libBornAgainCore.FormFactorCantellatedCube_swiginit(self, _libBornAgainCore.new_FormFactorCantellatedCube(*args))
@@ -15461,20 +15400,6 @@ class FormFactorCone(IFormFactorBorn):
__init__(FormFactorCone self, double radius, double height, double alpha) -> FormFactorCone
FormFactorCone::FormFactorCone(double radius, double height, double alpha)
- Constructor of a truncated cone with circular base.
-
- Parameters:
- -----------
-
- radius:
- radius of the base in nanometers
-
- height:
- height of the cone in nanometers
-
- alpha:
- angle between the base and the side surface in radians
-
"""
_libBornAgainCore.FormFactorCone_swiginit(self, _libBornAgainCore.new_FormFactorCone(*args))
@@ -15565,20 +15490,6 @@ class FormFactorCone6(FormFactorPolyhedron):
__init__(FormFactorCone6 self, double base_edge, double height, double alpha) -> FormFactorCone6
FormFactorCone6::FormFactorCone6(double base_edge, double height, double alpha)
- Constructor of a truncated pyramid, based on a regular hexagon
-
- Parameters:
- -----------
-
- base_edge:
- Edge of the regular hexagonal base in nanometers
-
- height:
- height of a truncated pyramid in nanometers
-
- alpha:
- dihedral angle in radians between base and facet
-
"""
_libBornAgainCore.FormFactorCone6_swiginit(self, _libBornAgainCore.new_FormFactorCone6(*args))
@@ -15631,7 +15542,14 @@ class FormFactorCone6(FormFactorPolyhedron):
_libBornAgainCore.FormFactorCone6_swigregister(FormFactorCone6)
class FormFactorCosineRippleBox(ICosineRipple):
- r"""Proxy of C++ FormFactorCosineRippleBox class."""
+ r"""
+
+
+ The form factor for a cosine ripple, with box profile in elongation direction.
+
+ C++ includes: FormFactorCosineRipple.h
+
+ """
thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
__repr__ = _swig_repr
@@ -15640,13 +15558,15 @@ class FormFactorCosineRippleBox(ICosineRipple):
r"""
__init__(FormFactorCosineRippleBox self, vdouble1d_t P) -> FormFactorCosineRippleBox
__init__(FormFactorCosineRippleBox self, double length, double width, double height) -> FormFactorCosineRippleBox
+ FormFactorCosineRippleBox::FormFactorCosineRippleBox(double length, double width, double height)
+
"""
_libBornAgainCore.FormFactorCosineRippleBox_swiginit(self, _libBornAgainCore.new_FormFactorCosineRippleBox(*args))
def clone(self):
r"""
clone(FormFactorCosineRippleBox self) -> FormFactorCosineRippleBox
- IFormFactorBorn* IFormFactorBorn::clone() const override=0
+ FormFactorCosineRippleBox * FormFactorCosineRippleBox::clone() const override final
Returns a clone of this ISample object.
@@ -15656,7 +15576,7 @@ class FormFactorCosineRippleBox(ICosineRipple):
def accept(self, visitor):
r"""
accept(FormFactorCosineRippleBox self, INodeVisitor visitor)
- virtual void INode::accept(INodeVisitor *visitor) const =0
+ void FormFactorCosineRippleBox::accept(INodeVisitor *visitor) const override final
Calls the INodeVisitor's visit method.
@@ -15668,7 +15588,14 @@ class FormFactorCosineRippleBox(ICosineRipple):
_libBornAgainCore.FormFactorCosineRippleBox_swigregister(FormFactorCosineRippleBox)
class FormFactorCosineRippleGauss(ICosineRipple):
- r"""Proxy of C++ FormFactorCosineRippleGauss class."""
+ r"""
+
+
+ The form factor for a cosine ripple, with Gaussian profile in elongation direction.
+
+ C++ includes: FormFactorCosineRipple.h
+
+ """
thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
__repr__ = _swig_repr
@@ -15677,13 +15604,15 @@ class FormFactorCosineRippleGauss(ICosineRipple):
r"""
__init__(FormFactorCosineRippleGauss self, vdouble1d_t P) -> FormFactorCosineRippleGauss
__init__(FormFactorCosineRippleGauss self, double length, double width, double height) -> FormFactorCosineRippleGauss
+ FormFactorCosineRippleGauss::FormFactorCosineRippleGauss(double length, double width, double height)
+
"""
_libBornAgainCore.FormFactorCosineRippleGauss_swiginit(self, _libBornAgainCore.new_FormFactorCosineRippleGauss(*args))
def clone(self):
r"""
clone(FormFactorCosineRippleGauss self) -> FormFactorCosineRippleGauss
- IFormFactorBorn* IFormFactorBorn::clone() const override=0
+ FormFactorCosineRippleGauss * FormFactorCosineRippleGauss::clone() const override final
Returns a clone of this ISample object.
@@ -15693,7 +15622,7 @@ class FormFactorCosineRippleGauss(ICosineRipple):
def accept(self, visitor):
r"""
accept(FormFactorCosineRippleGauss self, INodeVisitor visitor)
- virtual void INode::accept(INodeVisitor *visitor) const =0
+ void FormFactorCosineRippleGauss::accept(INodeVisitor *visitor) const override final
Calls the INodeVisitor's visit method.
@@ -15705,7 +15634,14 @@ class FormFactorCosineRippleGauss(ICosineRipple):
_libBornAgainCore.FormFactorCosineRippleGauss_swigregister(FormFactorCosineRippleGauss)
class FormFactorCosineRippleLorentz(ICosineRipple):
- r"""Proxy of C++ FormFactorCosineRippleLorentz class."""
+ r"""
+
+
+ The form factor for a cosine ripple, with Lorentz form factor in elongation direction.
+
+ C++ includes: FormFactorCosineRipple.h
+
+ """
thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
__repr__ = _swig_repr
@@ -15714,13 +15650,15 @@ class FormFactorCosineRippleLorentz(ICosineRipple):
r"""
__init__(FormFactorCosineRippleLorentz self, vdouble1d_t P) -> FormFactorCosineRippleLorentz
__init__(FormFactorCosineRippleLorentz self, double length, double width, double height) -> FormFactorCosineRippleLorentz
+ FormFactorCosineRippleLorentz::FormFactorCosineRippleLorentz(double length, double width, double height)
+
"""
_libBornAgainCore.FormFactorCosineRippleLorentz_swiginit(self, _libBornAgainCore.new_FormFactorCosineRippleLorentz(*args))
def clone(self):
r"""
clone(FormFactorCosineRippleLorentz self) -> FormFactorCosineRippleLorentz
- IFormFactorBorn* IFormFactorBorn::clone() const override=0
+ FormFactorCosineRippleLorentz * FormFactorCosineRippleLorentz::clone() const override final
Returns a clone of this ISample object.
@@ -15730,7 +15668,7 @@ class FormFactorCosineRippleLorentz(ICosineRipple):
def accept(self, visitor):
r"""
accept(FormFactorCosineRippleLorentz self, INodeVisitor visitor)
- virtual void INode::accept(INodeVisitor *visitor) const =0
+ void FormFactorCosineRippleLorentz::accept(INodeVisitor *visitor) const override final
Calls the INodeVisitor's visit method.
@@ -15760,23 +15698,6 @@ class FormFactorCuboctahedron(FormFactorPolyhedron):
__init__(FormFactorCuboctahedron self, double length, double height, double height_ratio, double alpha) -> FormFactorCuboctahedron
FormFactorCuboctahedron::FormFactorCuboctahedron(double length, double height, double height_ratio, double alpha)
- Constructor of cuboctahedron (compound of two truncated pyramids with a common square base and opposite orientations).
-
- Parameters:
- -----------
-
- length:
- side length of the common square base in nanometers
-
- height:
- height of the lower pyramid in nanometers
-
- height_ratio:
- ratio of heights of top to bottom pyramids
-
- alpha:
- dihedral angle in radians between base and facet
-
"""
_libBornAgainCore.FormFactorCuboctahedron_swiginit(self, _libBornAgainCore.new_FormFactorCuboctahedron(*args))
@@ -15855,17 +15776,6 @@ class FormFactorCylinder(IFormFactorBorn):
__init__(FormFactorCylinder self, double radius, double height) -> FormFactorCylinder
FormFactorCylinder::FormFactorCylinder(double radius, double height)
- Constructor of a cylinder with a circular base.
-
- Parameters:
- -----------
-
- radius:
- radius of the circular base in nanometers
-
- height:
- height of the cylinder in nanometers
-
"""
_libBornAgainCore.FormFactorCylinder_swiginit(self, _libBornAgainCore.new_FormFactorCylinder(*args))
@@ -15948,22 +15858,6 @@ class FormFactorDodecahedron(FormFactorPolyhedron):
__init__(FormFactorDodecahedron self, double edge) -> FormFactorDodecahedron
FormFactorDodecahedron::FormFactorDodecahedron(double edge)
- Constructs a regular dodecahedron.
-
- Parameters:
- -----------
-
- edge:
- length
-
- Constructor of a dodecahedron.
-
- Parameters:
- -----------
-
- edge:
- length of the edge in nanometers
-
"""
_libBornAgainCore.FormFactorDodecahedron_swiginit(self, _libBornAgainCore.new_FormFactorDodecahedron(*args))
@@ -16018,14 +15912,6 @@ class FormFactorDot(IFormFactorBorn):
__init__(FormFactorDot self, double radius) -> FormFactorDot
FormFactorDot::FormFactorDot(double radius)
- Constructor.
-
- Parameters:
- -----------
-
- rscat:
- radius of a sphere with same forward scattering power, in nanometers
-
"""
_libBornAgainCore.FormFactorDot_swiginit(self, _libBornAgainCore.new_FormFactorDot(*args))
@@ -16120,20 +16006,6 @@ class FormFactorEllipsoidalCylinder(IFormFactorBorn):
__init__(FormFactorEllipsoidalCylinder self, double radius_x, double radius_y, double height) -> FormFactorEllipsoidalCylinder
FormFactorEllipsoidalCylinder::FormFactorEllipsoidalCylinder(double radius_x, double radius_y, double height)
- Constructor of a cylinder with an ellipse cross section.
-
- Parameters:
- -----------
-
- radius_x:
- radius of the ellipse base in the x-direction, in nanometers
-
- radius_y:
- radius of the ellipse base in the y-direction, in nanometers
-
- height:
- height of the ellipsoidal cylinder in nanometers
-
"""
_libBornAgainCore.FormFactorEllipsoidalCylinder_swiginit(self, _libBornAgainCore.new_FormFactorEllipsoidalCylinder(*args))
@@ -16224,14 +16096,6 @@ class FormFactorFullSphere(IFormFactorBorn):
__init__(FormFactorFullSphere self, double radius, bool position_at_center=False) -> FormFactorFullSphere
FormFactorFullSphere::FormFactorFullSphere(double radius, bool position_at_center=false)
- Constructor of a full sphere.
-
- Parameters:
- -----------
-
- radius:
- radius of the sphere in nanometers
-
"""
_libBornAgainCore.FormFactorFullSphere_swiginit(self, _libBornAgainCore.new_FormFactorFullSphere(*args))
@@ -16326,17 +16190,6 @@ class FormFactorFullSpheroid(IFormFactorBorn):
__init__(FormFactorFullSpheroid self, double radius, double height) -> FormFactorFullSpheroid
FormFactorFullSpheroid::FormFactorFullSpheroid(double radius, double height)
- Constructor of full spheroid.
-
- Parameters:
- -----------
-
- radius:
- radius of the circular cross section in nanometers
-
- height:
- height of the full spheroid in nanometers
-
"""
_libBornAgainCore.FormFactorFullSpheroid_swiginit(self, _libBornAgainCore.new_FormFactorFullSpheroid(*args))
@@ -16419,20 +16272,6 @@ class FormFactorHemiEllipsoid(IFormFactorBorn):
__init__(FormFactorHemiEllipsoid self, double radius_x, double radius_y, double height) -> FormFactorHemiEllipsoid
FormFactorHemiEllipsoid::FormFactorHemiEllipsoid(double radius_x, double radius_y, double height)
- Constructor of horizontally oriented ellipsoid, truncated at the central plane.
-
- Parameters:
- -----------
-
- radius_x:
- radius of the ellipse base in the x-direction, in nanometers
-
- radius_y:
- radius of the ellipse base in the y-direction, in nanometers
-
- height:
- height of the hemi ellipsoid in nanometers
-
"""
_libBornAgainCore.FormFactorHemiEllipsoid_swiginit(self, _libBornAgainCore.new_FormFactorHemiEllipsoid(*args))
__swig_destroy__ = _libBornAgainCore.delete_FormFactorHemiEllipsoid
@@ -16589,14 +16428,6 @@ class FormFactorIcosahedron(FormFactorPolyhedron):
__init__(FormFactorIcosahedron self, double edge) -> FormFactorIcosahedron
FormFactorIcosahedron::FormFactorIcosahedron(double edge)
- Constructor of a icosahedron.
-
- Parameters:
- -----------
-
- edge:
- length of the edge in nanometers
-
"""
_libBornAgainCore.FormFactorIcosahedron_swiginit(self, _libBornAgainCore.new_FormFactorIcosahedron(*args))
@@ -16651,20 +16482,6 @@ class FormFactorLongBoxGauss(IFormFactorBorn):
__init__(FormFactorLongBoxGauss self, double length, double width, double height) -> FormFactorLongBoxGauss
FormFactorLongBoxGauss::FormFactorLongBoxGauss(double length, double width, double height)
- Box constructor.
-
- Parameters:
- -----------
-
- length:
- of Box's base
-
- width:
- of Box's base
-
- height:
- of Box
-
"""
_libBornAgainCore.FormFactorLongBoxGauss_swiginit(self, _libBornAgainCore.new_FormFactorLongBoxGauss(*args))
@@ -16755,20 +16572,6 @@ class FormFactorLongBoxLorentz(IFormFactorBorn):
__init__(FormFactorLongBoxLorentz self, double length, double width, double height) -> FormFactorLongBoxLorentz
FormFactorLongBoxLorentz::FormFactorLongBoxLorentz(double length, double width, double height)
- Box constructor.
-
- Parameters:
- -----------
-
- length:
- of Box's base
-
- width:
- of Box's base
-
- height:
- of Box
-
"""
_libBornAgainCore.FormFactorLongBoxLorentz_swiginit(self, _libBornAgainCore.new_FormFactorLongBoxLorentz(*args))
@@ -16859,17 +16662,6 @@ class FormFactorPrism3(FormFactorPolygonalPrism):
__init__(FormFactorPrism3 self, double base_edge, double height) -> FormFactorPrism3
FormFactorPrism3::FormFactorPrism3(double base_edge, double height)
- Constructor of a prism with an equilaterial triangle base.
-
- Parameters:
- -----------
-
- base_edge:
- length of the base edge in nanometers
-
- height:
- height in nanometers
-
"""
_libBornAgainCore.FormFactorPrism3_swiginit(self, _libBornAgainCore.new_FormFactorPrism3(*args))
@@ -16924,17 +16716,6 @@ class FormFactorPrism6(FormFactorPolygonalPrism):
__init__(FormFactorPrism6 self, double base_edge, double height) -> FormFactorPrism6
FormFactorPrism6::FormFactorPrism6(double base_edge, double height)
- Constructor of a prism with a regular hexagonal base.
-
- Parameters:
- -----------
-
- base_edge:
- length of the hexagonal base in nanometers
-
- height:
- height in nanometers
-
"""
_libBornAgainCore.FormFactorPrism6_swiginit(self, _libBornAgainCore.new_FormFactorPrism6(*args))
@@ -16989,20 +16770,6 @@ class FormFactorPyramid(FormFactorPolyhedron):
__init__(FormFactorPyramid self, double base_edge, double height, double alpha) -> FormFactorPyramid
FormFactorPyramid::FormFactorPyramid(double base_edge, double height, double alpha)
- Constructor of a truncated pyramid with a square base
-
- Parameters:
- -----------
-
- base_edge:
- length of the square base in nanometers
-
- height:
- height of the pyramid in nanometers
-
- alpha:
- dihedral angle between the base and a side face in radians
-
"""
_libBornAgainCore.FormFactorPyramid_swiginit(self, _libBornAgainCore.new_FormFactorPyramid(*args))
@@ -17055,7 +16822,14 @@ class FormFactorPyramid(FormFactorPolyhedron):
_libBornAgainCore.FormFactorPyramid_swigregister(FormFactorPyramid)
class FormFactorSawtoothRippleBox(ISawtoothRipple):
- r"""Proxy of C++ FormFactorSawtoothRippleBox class."""
+ r"""
+
+
+ The form factor for a cosine ripple, with box profile in elongation direction.
+
+ C++ includes: FormFactorSawtoothRipple.h
+
+ """
thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
__repr__ = _swig_repr
@@ -17064,13 +16838,15 @@ class FormFactorSawtoothRippleBox(ISawtoothRipple):
r"""
__init__(FormFactorSawtoothRippleBox self, vdouble1d_t P) -> FormFactorSawtoothRippleBox
__init__(FormFactorSawtoothRippleBox self, double length, double width, double height, double asymmetry) -> FormFactorSawtoothRippleBox
+ FormFactorSawtoothRippleBox::FormFactorSawtoothRippleBox(double length, double width, double height, double asymmetry)
+
"""
_libBornAgainCore.FormFactorSawtoothRippleBox_swiginit(self, _libBornAgainCore.new_FormFactorSawtoothRippleBox(*args))
def clone(self):
r"""
clone(FormFactorSawtoothRippleBox self) -> FormFactorSawtoothRippleBox
- IFormFactorBorn* IFormFactorBorn::clone() const override=0
+ FormFactorSawtoothRippleBox * FormFactorSawtoothRippleBox::clone() const override final
Returns a clone of this ISample object.
@@ -17080,7 +16856,7 @@ class FormFactorSawtoothRippleBox(ISawtoothRipple):
def accept(self, visitor):
r"""
accept(FormFactorSawtoothRippleBox self, INodeVisitor visitor)
- virtual void INode::accept(INodeVisitor *visitor) const =0
+ void FormFactorSawtoothRippleBox::accept(INodeVisitor *visitor) const override final
Calls the INodeVisitor's visit method.
@@ -17092,7 +16868,14 @@ class FormFactorSawtoothRippleBox(ISawtoothRipple):
_libBornAgainCore.FormFactorSawtoothRippleBox_swigregister(FormFactorSawtoothRippleBox)
class FormFactorSawtoothRippleGauss(ISawtoothRipple):
- r"""Proxy of C++ FormFactorSawtoothRippleGauss class."""
+ r"""
+
+
+ The form factor for a cosine ripple, with Gaussian profile in elongation direction.
+
+ C++ includes: FormFactorSawtoothRipple.h
+
+ """
thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
__repr__ = _swig_repr
@@ -17101,13 +16884,15 @@ class FormFactorSawtoothRippleGauss(ISawtoothRipple):
r"""
__init__(FormFactorSawtoothRippleGauss self, vdouble1d_t P) -> FormFactorSawtoothRippleGauss
__init__(FormFactorSawtoothRippleGauss self, double length, double width, double height, double asymmetry) -> FormFactorSawtoothRippleGauss
+ FormFactorSawtoothRippleGauss::FormFactorSawtoothRippleGauss(double length, double width, double height, double asymmetry)
+
"""
_libBornAgainCore.FormFactorSawtoothRippleGauss_swiginit(self, _libBornAgainCore.new_FormFactorSawtoothRippleGauss(*args))
def clone(self):
r"""
clone(FormFactorSawtoothRippleGauss self) -> FormFactorSawtoothRippleGauss
- IFormFactorBorn* IFormFactorBorn::clone() const override=0
+ FormFactorSawtoothRippleGauss * FormFactorSawtoothRippleGauss::clone() const override final
Returns a clone of this ISample object.
@@ -17117,7 +16902,7 @@ class FormFactorSawtoothRippleGauss(ISawtoothRipple):
def accept(self, visitor):
r"""
accept(FormFactorSawtoothRippleGauss self, INodeVisitor visitor)
- virtual void INode::accept(INodeVisitor *visitor) const =0
+ void FormFactorSawtoothRippleGauss::accept(INodeVisitor *visitor) const override final
Calls the INodeVisitor's visit method.
@@ -17129,7 +16914,14 @@ class FormFactorSawtoothRippleGauss(ISawtoothRipple):
_libBornAgainCore.FormFactorSawtoothRippleGauss_swigregister(FormFactorSawtoothRippleGauss)
class FormFactorSawtoothRippleLorentz(ISawtoothRipple):
- r"""Proxy of C++ FormFactorSawtoothRippleLorentz class."""
+ r"""
+
+
+ The form factor for a cosine ripple, with Lorentz form factor in elongation direction.
+
+ C++ includes: FormFactorSawtoothRipple.h
+
+ """
thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
__repr__ = _swig_repr
@@ -17138,13 +16930,15 @@ class FormFactorSawtoothRippleLorentz(ISawtoothRipple):
r"""
__init__(FormFactorSawtoothRippleLorentz self, vdouble1d_t P) -> FormFactorSawtoothRippleLorentz
__init__(FormFactorSawtoothRippleLorentz self, double length, double width, double height, double asymmetry) -> FormFactorSawtoothRippleLorentz
+ FormFactorSawtoothRippleLorentz::FormFactorSawtoothRippleLorentz(double length, double width, double height, double asymmetry)
+
"""
_libBornAgainCore.FormFactorSawtoothRippleLorentz_swiginit(self, _libBornAgainCore.new_FormFactorSawtoothRippleLorentz(*args))
def clone(self):
r"""
clone(FormFactorSawtoothRippleLorentz self) -> FormFactorSawtoothRippleLorentz
- IFormFactorBorn* IFormFactorBorn::clone() const override=0
+ FormFactorSawtoothRippleLorentz * FormFactorSawtoothRippleLorentz::clone() const override final
Returns a clone of this ISample object.
@@ -17154,7 +16948,7 @@ class FormFactorSawtoothRippleLorentz(ISawtoothRipple):
def accept(self, visitor):
r"""
accept(FormFactorSawtoothRippleLorentz self, INodeVisitor visitor)
- virtual void INode::accept(INodeVisitor *visitor) const =0
+ void FormFactorSawtoothRippleLorentz::accept(INodeVisitor *visitor) const override final
Calls the INodeVisitor's visit method.
@@ -17184,20 +16978,6 @@ class FormFactorTetrahedron(FormFactorPolyhedron):
__init__(FormFactorTetrahedron self, double base_edge, double height, double alpha) -> FormFactorTetrahedron
FormFactorTetrahedron::FormFactorTetrahedron(double base_edge, double height, double alpha)
- Constructor of a truncated tethrahedron.
-
- Parameters:
- -----------
-
- base_edge:
- length of one edge of the equilateral triangular base in nanometers
-
- height:
- height of the tetrahedron in nanometers
-
- alpha:
- dihedral angle in radians between base and facet
-
"""
_libBornAgainCore.FormFactorTetrahedron_swiginit(self, _libBornAgainCore.new_FormFactorTetrahedron(*args))
@@ -17268,17 +17048,6 @@ class FormFactorTruncatedCube(FormFactorPolyhedron):
__init__(FormFactorTruncatedCube self, double length, double removed_length) -> FormFactorTruncatedCube
FormFactorTruncatedCube::FormFactorTruncatedCube(double length, double removed_length)
- Constructor of a truncated cube.
-
- Parameters:
- -----------
-
- length:
- length of the full cube's edge in nanometers
-
- removed_length:
- removed length from each edge of the cube in nanometers
-
"""
_libBornAgainCore.FormFactorTruncatedCube_swiginit(self, _libBornAgainCore.new_FormFactorTruncatedCube(*args))
@@ -17339,21 +17108,7 @@ class FormFactorTruncatedSphere(IFormFactorBorn):
r"""
__init__(FormFactorTruncatedSphere self, vdouble1d_t P) -> FormFactorTruncatedSphere
__init__(FormFactorTruncatedSphere self, double radius, double height, double dh) -> FormFactorTruncatedSphere
- FormFactorTruncatedSphere::FormFactorTruncatedSphere(double radius, double height, double dh=0.0)
-
- Constructor of a spherical dome.
-
- Parameters:
- -----------
-
- radius:
- radius of the truncated sphere in nanometers
-
- height:
- height of the truncated sphere in nanometers
-
- dh:
- length of cup truncated from the top
+ FormFactorTruncatedSphere::FormFactorTruncatedSphere(double radius, double height, double dh)
"""
_libBornAgainCore.FormFactorTruncatedSphere_swiginit(self, _libBornAgainCore.new_FormFactorTruncatedSphere(*args))
@@ -17443,24 +17198,7 @@ class FormFactorTruncatedSpheroid(IFormFactorBorn):
r"""
__init__(FormFactorTruncatedSpheroid self, vdouble1d_t P) -> FormFactorTruncatedSpheroid
__init__(FormFactorTruncatedSpheroid self, double radius, double height, double height_flattening, double dh) -> FormFactorTruncatedSpheroid
- FormFactorTruncatedSpheroid::FormFactorTruncatedSpheroid(double radius, double height, double height_flattening, double dh=0.0)
-
- Constructor of a spheroidal dome.
-
- Parameters:
- -----------
-
- radius:
- radius of the truncated spheroid in nanometers
-
- height:
- height of the truncated spheroid in nanometers
-
- height_flattening:
- ratio of the height of the corresponding full spheroid to its diameter
-
- dh:
- length of cup truncated from the top
+ FormFactorTruncatedSpheroid::FormFactorTruncatedSpheroid(double radius, double height, double height_flattening, double dh)
"""
_libBornAgainCore.FormFactorTruncatedSpheroid_swiginit(self, _libBornAgainCore.new_FormFactorTruncatedSpheroid(*args))
@@ -17542,7 +17280,14 @@ class FormFactorTruncatedSpheroid(IFormFactorBorn):
_libBornAgainCore.FormFactorTruncatedSpheroid_swigregister(FormFactorTruncatedSpheroid)
class FormFactorGaussSphere(IFormFactorBorn):
- r"""Proxy of C++ FormFactorGaussSphere class."""
+ r"""
+
+
+ The form factor of a Gaussian sphere.
+
+ C++ includes: FormFactorGauss.h
+
+ """
thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
__repr__ = _swig_repr
@@ -17551,13 +17296,15 @@ class FormFactorGaussSphere(IFormFactorBorn):
r"""
__init__(FormFactorGaussSphere self, vdouble1d_t P) -> FormFactorGaussSphere
__init__(FormFactorGaussSphere self, double mean_radius) -> FormFactorGaussSphere
+ FormFactorGaussSphere::FormFactorGaussSphere(double mean_radius)
+
"""
_libBornAgainCore.FormFactorGaussSphere_swiginit(self, _libBornAgainCore.new_FormFactorGaussSphere(*args))
def clone(self):
r"""
clone(FormFactorGaussSphere self) -> FormFactorGaussSphere
- IFormFactorBorn* IFormFactorBorn::clone() const override=0
+ FormFactorGaussSphere* FormFactorGaussSphere::clone() const override final
Returns a clone of this ISample object.
@@ -17567,7 +17314,7 @@ class FormFactorGaussSphere(IFormFactorBorn):
def accept(self, visitor):
r"""
accept(FormFactorGaussSphere self, INodeVisitor visitor)
- virtual void INode::accept(INodeVisitor *visitor) const =0
+ void FormFactorGaussSphere::accept(INodeVisitor *visitor) const override final
Calls the INodeVisitor's visit method.
@@ -17575,13 +17322,17 @@ class FormFactorGaussSphere(IFormFactorBorn):
return _libBornAgainCore.FormFactorGaussSphere_accept(self, visitor)
def getMeanRadius(self):
- r"""getMeanRadius(FormFactorGaussSphere self) -> double"""
+ r"""
+ getMeanRadius(FormFactorGaussSphere self) -> double
+ double FormFactorGaussSphere::getMeanRadius() const
+
+ """
return _libBornAgainCore.FormFactorGaussSphere_getMeanRadius(self)
def radialExtension(self):
r"""
radialExtension(FormFactorGaussSphere self) -> double
- virtual double IFormFactor::radialExtension() const =0
+ double FormFactorGaussSphere::radialExtension() const override final
Returns the (approximate in some cases) radial size of the particle of this form factor's shape. This is used for SSCA calculations
@@ -17591,7 +17342,7 @@ class FormFactorGaussSphere(IFormFactorBorn):
def evaluate_for_q(self, q):
r"""
evaluate_for_q(FormFactorGaussSphere self, cvector_t q) -> complex_t
- virtual complex_t IFormFactorBorn::evaluate_for_q(cvector_t q) const =0
+ complex_t FormFactorGaussSphere::evaluate_for_q(cvector_t q) const override final
Returns scattering amplitude for complex scattering wavevector q=k_i-k_f. This method is public only for convenience of plotting form factors in Python.
@@ -17693,7 +17444,7 @@ class FormFactorSphereLogNormalRadius(IFormFactorBorn):
def clone(self):
r"""
clone(FormFactorSphereLogNormalRadius self) -> FormFactorSphereLogNormalRadius
- FormFactorSphereLogNormalRadius* FormFactorSphereLogNormalRadius::clone() const override final
+ FormFactorSphereLogNormalRadius * FormFactorSphereLogNormalRadius::clone() const override final
Returns a clone of this ISample object.
@@ -17985,7 +17736,24 @@ class Simulation(ICloneable, INode):
return _libBornAgainCore.Simulation_getChildren(self)
def convertData(self, data, put_masked_areas_to_zero=True):
- r"""convertData(Simulation self, IntensityData data, bool put_masked_areas_to_zero=True) -> SimulationResult"""
+ r"""
+ convertData(Simulation self, IntensityData data, bool put_masked_areas_to_zero=True) -> SimulationResult
+ SimulationResult Simulation::convertData(const OutputData< double > &data, bool put_masked_areas_to_zero=true)
+
+ Convert user data to SimulationResult object for later drawing in various axes units. User data will be cropped to the ROI defined in the simulation, amplitudes in areas corresponding to the masked areas of the detector will be set to zero.
+
+ Parameters:
+ -----------
+
+ simulation:
+ Simulation object with possible ROI and masks defined.
+
+ data:
+ User data with amplitudes with the shape of data matching the detector.
+
+ SimulationResult object.
+
+ """
return _libBornAgainCore.Simulation_convertData(self, data, put_masked_areas_to_zero)
def setSampleBuilder(self, ptr):
@@ -22110,7 +21878,7 @@ class Lattice2D(ICloneable, INode):
def clone(self):
r"""
clone(Lattice2D self) -> Lattice2D
- Lattice2D* Lattice2D::clone() const =0
+ virtual Lattice2D* Lattice2D::clone() const =0
"""
return _libBornAgainCore.Lattice2D_clone(self)
@@ -22184,7 +21952,7 @@ class BasicLattice(Lattice2D):
def __init__(self, length1, length2, angle, xi):
r"""
__init__(BasicLattice self, double length1, double length2, double angle, double xi) -> BasicLattice
- BasicLattice::BasicLattice(double length1, double length2, double angle, double rotation_angle=0.0)
+ BasicLattice::BasicLattice(double length1, double length2, double angle, double xi)
"""
_libBornAgainCore.BasicLattice_swiginit(self, _libBornAgainCore.new_BasicLattice(length1, length2, angle, xi))
@@ -22252,7 +22020,7 @@ class SquareLattice(Lattice2D):
def __init__(self, length, xi=0.0):
r"""
__init__(SquareLattice self, double length, double xi=0.0) -> SquareLattice
- SquareLattice::SquareLattice(double length, double rotation_angle=0.0)
+ SquareLattice::SquareLattice(double length, double xi=0.0)
"""
_libBornAgainCore.SquareLattice_swiginit(self, _libBornAgainCore.new_SquareLattice(length, xi))
@@ -22320,7 +22088,7 @@ class HexagonalLattice(Lattice2D):
def __init__(self, length, xi):
r"""
__init__(HexagonalLattice self, double length, double xi) -> HexagonalLattice
- HexagonalLattice::HexagonalLattice(double length, double rotation_angle=0.0)
+ HexagonalLattice::HexagonalLattice(double length, double xi)
"""
_libBornAgainCore.HexagonalLattice_swiginit(self, _libBornAgainCore.new_HexagonalLattice(length, xi))
@@ -22536,7 +22304,11 @@ class Material(object):
return _libBornAgainCore.Material_scalarSubtrSLD(self, wavevectors)
def rotatedMaterial(self, transform):
- r"""rotatedMaterial(Material self, Transform3D const & transform) -> Material"""
+ r"""
+ rotatedMaterial(Material self, Transform3D const & transform) -> Material
+ Material Material::rotatedMaterial(const Transform3D &transform) const
+
+ """
return _libBornAgainCore.Material_rotatedMaterial(self, transform)
__swig_destroy__ = _libBornAgainCore.delete_Material
diff --git a/auto/Wrap/libBornAgainCore_wrap.cpp b/auto/Wrap/libBornAgainCore_wrap.cpp
index c65e2a55c3d..d7eec6dc15d 100644
--- a/auto/Wrap/libBornAgainCore_wrap.cpp
+++ b/auto/Wrap/libBornAgainCore_wrap.cpp
@@ -124270,7 +124270,7 @@ static PyMethodDef SwigMethods[] = {
{ "FixedBinAxis_swiginit", FixedBinAxis_swiginit, METH_VARARGS, NULL},
{ "delete_ICloneable", _wrap_delete_ICloneable, METH_O, "\n"
"delete_ICloneable(ICloneable self)\n"
- "ICloneable::~ICloneable()\n"
+ "virtual ICloneable::~ICloneable()=default\n"
"\n"
""},
{ "ICloneable_clone", _wrap_ICloneable_clone, METH_O, "\n"
@@ -124835,7 +124835,15 @@ static PyMethodDef SwigMethods[] = {
{ "ParaMeta_vMax_get", _wrap_ParaMeta_vMax_get, METH_O, "ParaMeta_vMax_get(ParaMeta self) -> double"},
{ "ParaMeta_vDefault_set", _wrap_ParaMeta_vDefault_set, METH_VARARGS, "ParaMeta_vDefault_set(ParaMeta self, double vDefault)"},
{ "ParaMeta_vDefault_get", _wrap_ParaMeta_vDefault_get, METH_O, "ParaMeta_vDefault_get(ParaMeta self) -> double"},
- { "new_ParaMeta", _wrap_new_ParaMeta, METH_NOARGS, "new_ParaMeta() -> ParaMeta"},
+ { "new_ParaMeta", _wrap_new_ParaMeta, METH_NOARGS, "\n"
+ "new_ParaMeta() -> ParaMeta\n"
+ "\n"
+ "\n"
+ "Metadata of one model parameter.\n"
+ "\n"
+ "C++ includes: INode.h\n"
+ "\n"
+ ""},
{ "delete_ParaMeta", _wrap_delete_ParaMeta, METH_O, "delete_ParaMeta(ParaMeta self)"},
{ "ParaMeta_swigregister", ParaMeta_swigregister, METH_O, NULL},
{ "ParaMeta_swiginit", ParaMeta_swiginit, METH_VARARGS, NULL},
@@ -124845,15 +124853,27 @@ static PyMethodDef SwigMethods[] = {
{ "NodeMeta_tooltip_get", _wrap_NodeMeta_tooltip_get, METH_O, "NodeMeta_tooltip_get(NodeMeta self) -> std::string const &"},
{ "NodeMeta_paraMeta_set", _wrap_NodeMeta_paraMeta_set, METH_VARARGS, "NodeMeta_paraMeta_set(NodeMeta self, std::vector< ParaMeta,std::allocator< ParaMeta > > * paraMeta)"},
{ "NodeMeta_paraMeta_get", _wrap_NodeMeta_paraMeta_get, METH_O, "NodeMeta_paraMeta_get(NodeMeta self) -> std::vector< ParaMeta,std::allocator< ParaMeta > > *"},
- { "new_NodeMeta", _wrap_new_NodeMeta, METH_NOARGS, "new_NodeMeta() -> NodeMeta"},
+ { "new_NodeMeta", _wrap_new_NodeMeta, METH_NOARGS, "\n"
+ "new_NodeMeta() -> NodeMeta\n"
+ "\n"
+ "\n"
+ "Metadata of one model node.\n"
+ "\n"
+ "C++ includes: INode.h\n"
+ "\n"
+ ""},
{ "delete_NodeMeta", _wrap_delete_NodeMeta, METH_O, "delete_NodeMeta(NodeMeta self)"},
{ "NodeMeta_swigregister", NodeMeta_swigregister, METH_O, NULL},
{ "NodeMeta_swiginit", NodeMeta_swiginit, METH_VARARGS, NULL},
- { "nodeMetaUnion", _wrap_nodeMetaUnion, METH_VARARGS, "nodeMetaUnion(std::vector< ParaMeta,std::allocator< ParaMeta > > const & base, NodeMeta other) -> NodeMeta"},
+ { "nodeMetaUnion", _wrap_nodeMetaUnion, METH_VARARGS, "\n"
+ "nodeMetaUnion(std::vector< ParaMeta,std::allocator< ParaMeta > > const & base, NodeMeta other) -> NodeMeta\n"
+ "NodeMeta nodeMetaUnion(const std::vector< ParaMeta > &base, const NodeMeta &other)\n"
+ "\n"
+ ""},
{ "new_INode", _wrap_new_INode, METH_VARARGS, "\n"
"INode()\n"
"new_INode(PyObject * _self, NodeMeta meta, vdouble1d_t PValues) -> INode\n"
- "INode::INode(const INode *parent, const std::vector< const char * > PName, const std::vector< const char * > PUnit, const std::vector< double > PMin, const std::vector< double > PMax, const std::vector< double > PDefault, std::vector< double > P)\n"
+ "INode::INode(const NodeMeta &meta, const std::vector< double > &PValues)\n"
"\n"
""},
{ "delete_INode", _wrap_delete_INode, METH_O, "\n"
@@ -125213,17 +125233,13 @@ static PyMethodDef SwigMethods[] = {
"Sets distribution units. \n"
"\n"
""},
- { "delete_IDistribution1D", _wrap_delete_IDistribution1D, METH_O, "\n"
- "delete_IDistribution1D(IDistribution1D self)\n"
- "virtual IDistribution1D::~IDistribution1D()\n"
- "\n"
- ""},
+ { "delete_IDistribution1D", _wrap_delete_IDistribution1D, METH_O, "delete_IDistribution1D(IDistribution1D self)"},
{ "IDistribution1D_swigregister", IDistribution1D_swigregister, METH_O, NULL},
{ "new_DistributionGate", _wrap_new_DistributionGate, METH_VARARGS, "\n"
"DistributionGate(vdouble1d_t P)\n"
"DistributionGate(double min, double max)\n"
"new_DistributionGate() -> DistributionGate\n"
- "DistributionGate::DistributionGate(double min, double max)\n"
+ "DistributionGate::DistributionGate()\n"
"\n"
""},
{ "DistributionGate_clone", _wrap_DistributionGate_clone, METH_O, "\n"
@@ -125276,18 +125292,14 @@ static PyMethodDef SwigMethods[] = {
"Calls the INodeVisitor's visit method. \n"
"\n"
""},
- { "delete_DistributionGate", _wrap_delete_DistributionGate, METH_O, "\n"
- "delete_DistributionGate(DistributionGate self)\n"
- "virtual DistributionGate::~DistributionGate()\n"
- "\n"
- ""},
+ { "delete_DistributionGate", _wrap_delete_DistributionGate, METH_O, "delete_DistributionGate(DistributionGate self)"},
{ "DistributionGate_swigregister", DistributionGate_swigregister, METH_O, NULL},
{ "DistributionGate_swiginit", DistributionGate_swiginit, METH_VARARGS, NULL},
{ "new_DistributionLorentz", _wrap_new_DistributionLorentz, METH_VARARGS, "\n"
"DistributionLorentz(vdouble1d_t P)\n"
"DistributionLorentz(double mean, double hwhm)\n"
"new_DistributionLorentz() -> DistributionLorentz\n"
- "DistributionLorentz::DistributionLorentz(double mean, double hwhm)\n"
+ "DistributionLorentz::DistributionLorentz()\n"
"\n"
""},
{ "DistributionLorentz_clone", _wrap_DistributionLorentz_clone, METH_O, "\n"
@@ -125335,18 +125347,14 @@ static PyMethodDef SwigMethods[] = {
"Calls the INodeVisitor's visit method. \n"
"\n"
""},
- { "delete_DistributionLorentz", _wrap_delete_DistributionLorentz, METH_O, "\n"
- "delete_DistributionLorentz(DistributionLorentz self)\n"
- "virtual DistributionLorentz::~DistributionLorentz()\n"
- "\n"
- ""},
+ { "delete_DistributionLorentz", _wrap_delete_DistributionLorentz, METH_O, "delete_DistributionLorentz(DistributionLorentz self)"},
{ "DistributionLorentz_swigregister", DistributionLorentz_swigregister, METH_O, NULL},
{ "DistributionLorentz_swiginit", DistributionLorentz_swiginit, METH_VARARGS, NULL},
{ "new_DistributionGaussian", _wrap_new_DistributionGaussian, METH_VARARGS, "\n"
"DistributionGaussian(vdouble1d_t P)\n"
"DistributionGaussian(double mean, double std_dev)\n"
"new_DistributionGaussian() -> DistributionGaussian\n"
- "DistributionGaussian::DistributionGaussian(double mean, double std_dev)\n"
+ "DistributionGaussian::DistributionGaussian()\n"
"\n"
""},
{ "DistributionGaussian_clone", _wrap_DistributionGaussian_clone, METH_O, "\n"
@@ -125394,17 +125402,13 @@ static PyMethodDef SwigMethods[] = {
"Calls the INodeVisitor's visit method. \n"
"\n"
""},
- { "delete_DistributionGaussian", _wrap_delete_DistributionGaussian, METH_O, "\n"
- "delete_DistributionGaussian(DistributionGaussian self)\n"
- "virtual DistributionGaussian::~DistributionGaussian()\n"
- "\n"
- ""},
+ { "delete_DistributionGaussian", _wrap_delete_DistributionGaussian, METH_O, "delete_DistributionGaussian(DistributionGaussian self)"},
{ "DistributionGaussian_swigregister", DistributionGaussian_swigregister, METH_O, NULL},
{ "DistributionGaussian_swiginit", DistributionGaussian_swiginit, METH_VARARGS, NULL},
{ "new_DistributionLogNormal", _wrap_new_DistributionLogNormal, METH_VARARGS, "\n"
"DistributionLogNormal(vdouble1d_t P)\n"
"new_DistributionLogNormal(double median, double scale_param) -> DistributionLogNormal\n"
- "DistributionLogNormal::DistributionLogNormal(double median, double scale_param)\n"
+ "DistributionLogNormal::DistributionLogNormal()=delete\n"
"\n"
""},
{ "DistributionLogNormal_clone", _wrap_DistributionLogNormal_clone, METH_O, "\n"
@@ -125464,18 +125468,14 @@ static PyMethodDef SwigMethods[] = {
"Sets distribution units. \n"
"\n"
""},
- { "delete_DistributionLogNormal", _wrap_delete_DistributionLogNormal, METH_O, "\n"
- "delete_DistributionLogNormal(DistributionLogNormal self)\n"
- "virtual DistributionLogNormal::~DistributionLogNormal()\n"
- "\n"
- ""},
+ { "delete_DistributionLogNormal", _wrap_delete_DistributionLogNormal, METH_O, "delete_DistributionLogNormal(DistributionLogNormal self)"},
{ "DistributionLogNormal_swigregister", DistributionLogNormal_swigregister, METH_O, NULL},
{ "DistributionLogNormal_swiginit", DistributionLogNormal_swiginit, METH_VARARGS, NULL},
{ "new_DistributionCosine", _wrap_new_DistributionCosine, METH_VARARGS, "\n"
"DistributionCosine(vdouble1d_t P)\n"
"DistributionCosine(double mean, double sigma)\n"
"new_DistributionCosine() -> DistributionCosine\n"
- "DistributionCosine::DistributionCosine(double mean, double sigma)\n"
+ "DistributionCosine::DistributionCosine()\n"
"\n"
""},
{ "DistributionCosine_clone", _wrap_DistributionCosine_clone, METH_O, "\n"
@@ -125523,18 +125523,14 @@ static PyMethodDef SwigMethods[] = {
"Calls the INodeVisitor's visit method. \n"
"\n"
""},
- { "delete_DistributionCosine", _wrap_delete_DistributionCosine, METH_O, "\n"
- "delete_DistributionCosine(DistributionCosine self)\n"
- "virtual DistributionCosine::~DistributionCosine()\n"
- "\n"
- ""},
+ { "delete_DistributionCosine", _wrap_delete_DistributionCosine, METH_O, "delete_DistributionCosine(DistributionCosine self)"},
{ "DistributionCosine_swigregister", DistributionCosine_swigregister, METH_O, NULL},
{ "DistributionCosine_swiginit", DistributionCosine_swiginit, METH_VARARGS, NULL},
{ "new_DistributionTrapezoid", _wrap_new_DistributionTrapezoid, METH_VARARGS, "\n"
"DistributionTrapezoid(vdouble1d_t P)\n"
"DistributionTrapezoid(double center, double left, double middle, double right)\n"
"new_DistributionTrapezoid() -> DistributionTrapezoid\n"
- "DistributionTrapezoid::DistributionTrapezoid(double center, double left_width, double middle_width, double right_width)\n"
+ "DistributionTrapezoid::DistributionTrapezoid()\n"
"\n"
""},
{ "DistributionTrapezoid_clone", _wrap_DistributionTrapezoid_clone, METH_O, "\n"
@@ -125592,11 +125588,7 @@ static PyMethodDef SwigMethods[] = {
"Calls the INodeVisitor's visit method. \n"
"\n"
""},
- { "delete_DistributionTrapezoid", _wrap_delete_DistributionTrapezoid, METH_O, "\n"
- "delete_DistributionTrapezoid(DistributionTrapezoid self)\n"
- "virtual DistributionTrapezoid::~DistributionTrapezoid()\n"
- "\n"
- ""},
+ { "delete_DistributionTrapezoid", _wrap_delete_DistributionTrapezoid, METH_O, "delete_DistributionTrapezoid(DistributionTrapezoid self)"},
{ "DistributionTrapezoid_swigregister", DistributionTrapezoid_swigregister, METH_O, NULL},
{ "DistributionTrapezoid_swiginit", DistributionTrapezoid_swiginit, METH_VARARGS, NULL},
{ "new_ParameterDistribution", _wrap_new_ParameterDistribution, METH_VARARGS, "\n"
@@ -126005,7 +125997,7 @@ static PyMethodDef SwigMethods[] = {
{ "new_ISample", _wrap_new_ISample, METH_VARARGS, "\n"
"ISample()\n"
"new_ISample(PyObject * _self, NodeMeta meta, vdouble1d_t PValues) -> ISample\n"
- "ISample::ISample(const INode *parent, const std::vector< const char * > PName, const std::vector< const char * > PUnit, const std::vector< double > PMin, const std::vector< double > PMax, const std::vector< double > PDefault, std::vector< double > P)\n"
+ "ISample::ISample(const NodeMeta &meta, const std::vector< double > &PValues)\n"
"\n"
""},
{ "ISample_clone", _wrap_ISample_clone, METH_O, "\n"
@@ -126036,7 +126028,7 @@ static PyMethodDef SwigMethods[] = {
{ "new_IFormFactor", _wrap_new_IFormFactor, METH_VARARGS, "\n"
"IFormFactor()\n"
"new_IFormFactor(PyObject * _self, NodeMeta meta, vdouble1d_t PValues) -> IFormFactor\n"
- "IFormFactor::IFormFactor(const INode *parent, const std::vector< const char * > PName, const std::vector< const char * > PUnit, const std::vector< double > PMin, const std::vector< double > PMax, const std::vector< double > PDefault, std::vector< double > P)\n"
+ "IFormFactor::IFormFactor(const NodeMeta &meta, const std::vector< double > &PValues)\n"
"\n"
""},
{ "delete_IFormFactor", _wrap_delete_IFormFactor, METH_O, "\n"
@@ -126113,7 +126105,7 @@ static PyMethodDef SwigMethods[] = {
{ "new_IFormFactorBorn", _wrap_new_IFormFactorBorn, METH_VARARGS, "\n"
"IFormFactorBorn()\n"
"new_IFormFactorBorn(PyObject * _self, NodeMeta meta, vdouble1d_t PValues) -> IFormFactorBorn\n"
- "IFormFactorBorn::IFormFactorBorn(const INode *parent, const std::vector< const char * > PName, const std::vector< const char * > PUnit, const std::vector< double > PMin, const std::vector< double > PMax, const std::vector< double > PDefault, std::vector< double > P)\n"
+ "IFormFactorBorn::IFormFactorBorn(const NodeMeta &meta, const std::vector< double > &PValues)\n"
"\n"
""},
{ "IFormFactorBorn_clone", _wrap_IFormFactorBorn_clone, METH_O, "\n"
@@ -126241,8 +126233,6 @@ static PyMethodDef SwigMethods[] = {
"IRotation_clone(IRotation self) -> IRotation\n"
"virtual IRotation* IRotation::clone() const =0\n"
"\n"
- "Returns a clone of this ISample object. \n"
- "\n"
""},
{ "IRotation_createInverse", _wrap_IRotation_createInverse, METH_O, "\n"
"IRotation_createInverse(IRotation self) -> IRotation\n"
@@ -126258,7 +126248,11 @@ static PyMethodDef SwigMethods[] = {
"Returns transformation. \n"
"\n"
""},
- { "IRotation_transformed", _wrap_IRotation_transformed, METH_VARARGS, "IRotation_transformed(IRotation self, kvector_t v) -> kvector_t"},
+ { "IRotation_transformed", _wrap_IRotation_transformed, METH_VARARGS, "\n"
+ "IRotation_transformed(IRotation self, kvector_t v) -> kvector_t\n"
+ "kvector_t IRotation::transformed(const kvector_t &v) const\n"
+ "\n"
+ ""},
{ "IRotation_isIdentity", _wrap_IRotation_isIdentity, METH_O, "\n"
"IRotation_isIdentity(IRotation self) -> bool\n"
"bool IRotation::isIdentity() const\n"
@@ -126266,12 +126260,12 @@ static PyMethodDef SwigMethods[] = {
"Returns true if rotation matrix is identity matrix (no rotations) \n"
"\n"
""},
- { "IRotation_zInvariant", _wrap_IRotation_zInvariant, METH_O, "IRotation_zInvariant(IRotation self) -> bool"},
- { "delete_IRotation", _wrap_delete_IRotation, METH_O, "\n"
- "delete_IRotation(IRotation self)\n"
- "virtual IRotation::~IRotation()\n"
+ { "IRotation_zInvariant", _wrap_IRotation_zInvariant, METH_O, "\n"
+ "IRotation_zInvariant(IRotation self) -> bool\n"
+ "bool IRotation::zInvariant() const\n"
"\n"
""},
+ { "delete_IRotation", _wrap_delete_IRotation, METH_O, "delete_IRotation(IRotation self)"},
{ "IRotation_swigregister", IRotation_swigregister, METH_O, NULL},
{ "createProduct", _wrap_createProduct, METH_VARARGS, "\n"
"createProduct(IRotation left, IRotation right) -> IRotation\n"
@@ -126282,15 +126276,13 @@ static PyMethodDef SwigMethods[] = {
""},
{ "new_IdentityRotation", _wrap_new_IdentityRotation, METH_NOARGS, "\n"
"new_IdentityRotation() -> IdentityRotation\n"
- "IdentityRotation::IdentityRotation()=default\n"
+ "IdentityRotation::IdentityRotation()\n"
"\n"
""},
{ "IdentityRotation_clone", _wrap_IdentityRotation_clone, METH_O, "\n"
"IdentityRotation_clone(IdentityRotation self) -> IdentityRotation\n"
"IdentityRotation* IdentityRotation::clone() const\n"
"\n"
- "Returns a clone of this ISample object. \n"
- "\n"
""},
{ "IdentityRotation_createInverse", _wrap_IdentityRotation_createInverse, METH_O, "\n"
"IdentityRotation_createInverse(IdentityRotation self) -> IdentityRotation\n"
@@ -126328,21 +126320,11 @@ static PyMethodDef SwigMethods[] = {
"new_RotationX(double angle) -> RotationX\n"
"RotationX::RotationX(double angle)\n"
"\n"
- "Constructor of rotation around x-axis\n"
- "\n"
- "Parameters:\n"
- "-----------\n"
- "\n"
- "angle: \n"
- "rotation angle around x-axis in radians \n"
- "\n"
""},
{ "RotationX_clone", _wrap_RotationX_clone, METH_O, "\n"
"RotationX_clone(RotationX self) -> RotationX\n"
"RotationX* RotationX::clone() const\n"
"\n"
- "Returns a clone of this ISample object. \n"
- "\n"
""},
{ "RotationX_createInverse", _wrap_RotationX_createInverse, METH_O, "\n"
"RotationX_createInverse(RotationX self) -> RotationX\n"
@@ -126378,21 +126360,11 @@ static PyMethodDef SwigMethods[] = {
"new_RotationY(double angle) -> RotationY\n"
"RotationY::RotationY(double angle)\n"
"\n"
- "Constructor of rotation around y-axis\n"
- "\n"
- "Parameters:\n"
- "-----------\n"
- "\n"
- "angle: \n"
- "rotation angle around y-axis in radians \n"
- "\n"
""},
{ "RotationY_clone", _wrap_RotationY_clone, METH_O, "\n"
"RotationY_clone(RotationY self) -> RotationY\n"
"RotationY* RotationY::clone() const\n"
"\n"
- "Returns a clone of this ISample object. \n"
- "\n"
""},
{ "RotationY_createInverse", _wrap_RotationY_createInverse, METH_O, "\n"
"RotationY_createInverse(RotationY self) -> RotationY\n"
@@ -126426,23 +126398,13 @@ static PyMethodDef SwigMethods[] = {
{ "new_RotationZ", _wrap_new_RotationZ, METH_VARARGS, "\n"
"RotationZ(vdouble1d_t P)\n"
"new_RotationZ(double angle) -> RotationZ\n"
- "RotationZ::RotationZ(double angle=0.0)\n"
- "\n"
- "Constructor of rotation around z-axis\n"
- "\n"
- "Parameters:\n"
- "-----------\n"
- "\n"
- "angle: \n"
- "rotation angle around z-axis in radians \n"
+ "RotationZ::RotationZ(double angle)\n"
"\n"
""},
{ "RotationZ_clone", _wrap_RotationZ_clone, METH_O, "\n"
"RotationZ_clone(RotationZ self) -> RotationZ\n"
"RotationZ* RotationZ::clone() const\n"
"\n"
- "Returns a clone of this ISample object. \n"
- "\n"
""},
{ "RotationZ_createInverse", _wrap_RotationZ_createInverse, METH_O, "\n"
"RotationZ_createInverse(RotationZ self) -> RotationZ\n"
@@ -126478,27 +126440,11 @@ static PyMethodDef SwigMethods[] = {
"new_RotationEuler(double alpha, double beta, double gamma) -> RotationEuler\n"
"RotationEuler::RotationEuler(double alpha, double beta, double gamma)\n"
"\n"
- "Constructor of Euler rotation (sequence of three rotations following Euler angles notation z-x'-z').\n"
- "\n"
- "Parameters:\n"
- "-----------\n"
- "\n"
- "alpha: \n"
- "first Euler angle in radians\n"
- "\n"
- "beta: \n"
- "second Euler angle in radians\n"
- "\n"
- "gamma: \n"
- "third Euler angle in radians \n"
- "\n"
""},
{ "RotationEuler_clone", _wrap_RotationEuler_clone, METH_O, "\n"
"RotationEuler_clone(RotationEuler self) -> RotationEuler\n"
"RotationEuler* RotationEuler::clone() const\n"
"\n"
- "Returns a clone of this ISample object. \n"
- "\n"
""},
{ "RotationEuler_createInverse", _wrap_RotationEuler_createInverse, METH_O, "\n"
"RotationEuler_createInverse(RotationEuler self) -> IRotation\n"
@@ -126799,7 +126745,7 @@ static PyMethodDef SwigMethods[] = {
{ "FormFactorWeighted_swiginit", FormFactorWeighted_swiginit, METH_VARARGS, NULL},
{ "delete_IAbstractParticle", _wrap_delete_IAbstractParticle, METH_O, "\n"
"delete_IAbstractParticle(IAbstractParticle self)\n"
- "IAbstractParticle::~IAbstractParticle()\n"
+ "virtual IAbstractParticle::~IAbstractParticle()=default\n"
"\n"
""},
{ "IAbstractParticle_clone", _wrap_IAbstractParticle_clone, METH_O, "\n"
@@ -127434,17 +127380,6 @@ static PyMethodDef SwigMethods[] = {
"new_FTDecayFunction1DVoigt(double decay_length, double eta) -> FTDecayFunction1DVoigt\n"
"FTDecayFunction1DVoigt::FTDecayFunction1DVoigt(double decay_length, double eta)\n"
"\n"
- "Constructor of pseudo-Voigt decay function.\n"
- "\n"
- "Parameters:\n"
- "-----------\n"
- "\n"
- "decay_length: \n"
- "half-width of the distribution in nanometers\n"
- "\n"
- "eta: \n"
- "parameter [0,1] to balance between Cauchy (eta=0.0) and Gauss (eta=1.0) \n"
- "\n"
""},
{ "FTDecayFunction1DVoigt_clone", _wrap_FTDecayFunction1DVoigt_clone, METH_O, "\n"
"FTDecayFunction1DVoigt_clone(FTDecayFunction1DVoigt self) -> FTDecayFunction1DVoigt\n"
@@ -127518,7 +127453,7 @@ static PyMethodDef SwigMethods[] = {
{ "new_FTDecayFunction2DCauchy", _wrap_new_FTDecayFunction2DCauchy, METH_VARARGS, "\n"
"FTDecayFunction2DCauchy(vdouble1d_t P)\n"
"new_FTDecayFunction2DCauchy(double decay_length_x, double decay_length_y, double gamma) -> FTDecayFunction2DCauchy\n"
- "FTDecayFunction2DCauchy::FTDecayFunction2DCauchy(double decay_length_x, double decay_length_y, double gamma=0)\n"
+ "FTDecayFunction2DCauchy::FTDecayFunction2DCauchy(double decay_length_x, double decay_length_y, double gamma)\n"
"\n"
""},
{ "FTDecayFunction2DCauchy_clone", _wrap_FTDecayFunction2DCauchy_clone, METH_O, "\n"
@@ -127546,7 +127481,7 @@ static PyMethodDef SwigMethods[] = {
{ "new_FTDecayFunction2DGauss", _wrap_new_FTDecayFunction2DGauss, METH_VARARGS, "\n"
"FTDecayFunction2DGauss(vdouble1d_t P)\n"
"new_FTDecayFunction2DGauss(double decay_length_x, double decay_length_y, double gamma) -> FTDecayFunction2DGauss\n"
- "FTDecayFunction2DGauss::FTDecayFunction2DGauss(double decay_length_x, double decay_length_y, double gamma=0)\n"
+ "FTDecayFunction2DGauss::FTDecayFunction2DGauss(double decay_length_x, double decay_length_y, double gamma)\n"
"\n"
""},
{ "FTDecayFunction2DGauss_clone", _wrap_FTDecayFunction2DGauss_clone, METH_O, "\n"
@@ -127574,24 +127509,7 @@ static PyMethodDef SwigMethods[] = {
{ "new_FTDecayFunction2DVoigt", _wrap_new_FTDecayFunction2DVoigt, METH_VARARGS, "\n"
"FTDecayFunction2DVoigt(vdouble1d_t P)\n"
"new_FTDecayFunction2DVoigt(double decay_length_x, double decay_length_y, double gamma, double eta) -> FTDecayFunction2DVoigt\n"
- "FTDecayFunction2DVoigt::FTDecayFunction2DVoigt(double decay_length_x, double decay_length_y, double eta, double gamma=0)\n"
- "\n"
- "Constructor of two-dimensional pseudo-Voigt decay function in reciprocal space.\n"
- "\n"
- "Parameters:\n"
- "-----------\n"
- "\n"
- "decay_length_x: \n"
- "the decay length in nanometers along x-axis of the distribution\n"
- "\n"
- "decay_length_y: \n"
- "the decay length in nanometers along y-axis of the distribution\n"
- "\n"
- "eta: \n"
- "parameter [0,1] to balance between Cauchy (eta=0.0) and Gauss (eta=1.0)\n"
- "\n"
- "gamma: \n"
- "distribution orientation with respect to the first lattice vector in radians \n"
+ "FTDecayFunction2DVoigt::FTDecayFunction2DVoigt(double decay_length_x, double decay_length_y, double gamma, double eta)\n"
"\n"
""},
{ "FTDecayFunction2DVoigt_clone", _wrap_FTDecayFunction2DVoigt_clone, METH_O, "\n"
@@ -127645,11 +127563,7 @@ static PyMethodDef SwigMethods[] = {
"Returns the negative of the second order derivative in q space around q=0. \n"
"\n"
""},
- { "delete_IFTDistribution1D", _wrap_delete_IFTDistribution1D, METH_O, "\n"
- "delete_IFTDistribution1D(IFTDistribution1D self)\n"
- "IFTDistribution1D::~IFTDistribution1D()\n"
- "\n"
- ""},
+ { "delete_IFTDistribution1D", _wrap_delete_IFTDistribution1D, METH_O, "delete_IFTDistribution1D(IFTDistribution1D self)"},
{ "IFTDistribution1D_swigregister", IFTDistribution1D_swigregister, METH_O, NULL},
{ "new_FTDistribution1DCauchy", _wrap_new_FTDistribution1DCauchy, METH_VARARGS, "\n"
"FTDistribution1DCauchy(vdouble1d_t P)\n"
@@ -127831,17 +127745,6 @@ static PyMethodDef SwigMethods[] = {
"new_FTDistribution1DVoigt(double omega, double eta) -> FTDistribution1DVoigt\n"
"FTDistribution1DVoigt::FTDistribution1DVoigt(double omega, double eta)\n"
"\n"
- "Constructor of one-dimensional pseudo-Voigt probability distribution.\n"
- "\n"
- "Parameters:\n"
- "-----------\n"
- "\n"
- "omega: \n"
- "half-width of the distribution in nanometers\n"
- "\n"
- "eta: \n"
- "parameter [0,1] to balance between Cauchy (eta=0.0) and Gauss (eta=1.0) \n"
- "\n"
""},
{ "FTDistribution1DVoigt_clone", _wrap_FTDistribution1DVoigt_clone, METH_O, "\n"
"FTDistribution1DVoigt_clone(FTDistribution1DVoigt self) -> FTDistribution1DVoigt\n"
@@ -127901,6 +127804,8 @@ static PyMethodDef SwigMethods[] = {
"IFTDistribution2D_delta(IFTDistribution2D self) -> double\n"
"double IFTDistribution2D::delta() const\n"
"\n"
+ "Angle in direct space between X- and Y-axis of distribution. \n"
+ "\n"
""},
{ "IFTDistribution2D_evaluate", _wrap_IFTDistribution2D_evaluate, METH_VARARGS, "\n"
"IFTDistribution2D_evaluate(IFTDistribution2D self, double qx, double qy) -> double\n"
@@ -127914,7 +127819,7 @@ static PyMethodDef SwigMethods[] = {
{ "new_FTDistribution2DCauchy", _wrap_new_FTDistribution2DCauchy, METH_VARARGS, "\n"
"FTDistribution2DCauchy(vdouble1d_t P)\n"
"new_FTDistribution2DCauchy(double omega_x, double omega_y, double gamma) -> FTDistribution2DCauchy\n"
- "FTDistribution2DCauchy::FTDistribution2DCauchy(double omega_x, double omega_y, double gamma=0)\n"
+ "FTDistribution2DCauchy::FTDistribution2DCauchy(double omega_x, double omega_y, double gamma)\n"
"\n"
""},
{ "FTDistribution2DCauchy_clone", _wrap_FTDistribution2DCauchy_clone, METH_O, "\n"
@@ -127942,7 +127847,7 @@ static PyMethodDef SwigMethods[] = {
{ "new_FTDistribution2DGauss", _wrap_new_FTDistribution2DGauss, METH_VARARGS, "\n"
"FTDistribution2DGauss(vdouble1d_t P)\n"
"new_FTDistribution2DGauss(double omega_x, double omega_y, double gamma) -> FTDistribution2DGauss\n"
- "FTDistribution2DGauss::FTDistribution2DGauss(double omega_x, double omega_y, double gamma=0)\n"
+ "FTDistribution2DGauss::FTDistribution2DGauss(double omega_x, double omega_y, double gamma)\n"
"\n"
""},
{ "FTDistribution2DGauss_clone", _wrap_FTDistribution2DGauss_clone, METH_O, "\n"
@@ -127970,7 +127875,7 @@ static PyMethodDef SwigMethods[] = {
{ "new_FTDistribution2DGate", _wrap_new_FTDistribution2DGate, METH_VARARGS, "\n"
"FTDistribution2DGate(vdouble1d_t P)\n"
"new_FTDistribution2DGate(double omega_x, double omega_y, double gamma) -> FTDistribution2DGate\n"
- "FTDistribution2DGate::FTDistribution2DGate(double omega_x, double omega_y, double gamma=0)\n"
+ "FTDistribution2DGate::FTDistribution2DGate(double omega_x, double omega_y, double gamma)\n"
"\n"
""},
{ "FTDistribution2DGate_clone", _wrap_FTDistribution2DGate_clone, METH_O, "\n"
@@ -127998,7 +127903,7 @@ static PyMethodDef SwigMethods[] = {
{ "new_FTDistribution2DCone", _wrap_new_FTDistribution2DCone, METH_VARARGS, "\n"
"FTDistribution2DCone(vdouble1d_t P)\n"
"new_FTDistribution2DCone(double omega_x, double omega_y, double gamma) -> FTDistribution2DCone\n"
- "FTDistribution2DCone::FTDistribution2DCone(double omega_x, double omega_y, double gamma=0)\n"
+ "FTDistribution2DCone::FTDistribution2DCone(double omega_x, double omega_y, double gamma)\n"
"\n"
""},
{ "FTDistribution2DCone_clone", _wrap_FTDistribution2DCone_clone, METH_O, "\n"
@@ -128026,24 +127931,7 @@ static PyMethodDef SwigMethods[] = {
{ "new_FTDistribution2DVoigt", _wrap_new_FTDistribution2DVoigt, METH_VARARGS, "\n"
"FTDistribution2DVoigt(vdouble1d_t P)\n"
"new_FTDistribution2DVoigt(double omega_x, double omega_y, double gamma, double eta) -> FTDistribution2DVoigt\n"
- "FTDistribution2DVoigt::FTDistribution2DVoigt(double omega_x, double omega_y, double eta, double gamma=0)\n"
- "\n"
- "Constructor of two-dimensional pseudo-Voigt probability distribution.\n"
- "\n"
- "Parameters:\n"
- "-----------\n"
- "\n"
- "omega_x: \n"
- "half-width of the distribution along its x-axis in nanometers\n"
- "\n"
- "omega_y: \n"
- "half-width of the distribution along its y-axis in nanometers\n"
- "\n"
- "eta: \n"
- "parameter [0,1] to balance between Cauchy (eta=0.0) and Gauss (eta=1.0)\n"
- "\n"
- "gamma: \n"
- "angle in direct space between first lattice vector and x-axis of the distribution in radians \n"
+ "FTDistribution2DVoigt::FTDistribution2DVoigt(double omega_x, double omega_y, double gamma, double eta)\n"
"\n"
""},
{ "FTDistribution2DVoigt_clone", _wrap_FTDistribution2DVoigt_clone, METH_O, "\n"
@@ -128315,64 +128203,80 @@ static PyMethodDef SwigMethods[] = {
""},
{ "LorentzFisherPeakShape_swigregister", LorentzFisherPeakShape_swigregister, METH_O, NULL},
{ "LorentzFisherPeakShape_swiginit", LorentzFisherPeakShape_swiginit, METH_VARARGS, NULL},
- { "new_MisesFisherGaussPeakShape", _wrap_new_MisesFisherGaussPeakShape, METH_VARARGS, "new_MisesFisherGaussPeakShape(double max_intensity, double radial_size, kvector_t zenith, double kappa_1, double kappa_2) -> MisesFisherGaussPeakShape"},
- { "delete_MisesFisherGaussPeakShape", _wrap_delete_MisesFisherGaussPeakShape, METH_O, "delete_MisesFisherGaussPeakShape(MisesFisherGaussPeakShape self)"},
+ { "new_MisesFisherGaussPeakShape", _wrap_new_MisesFisherGaussPeakShape, METH_VARARGS, "\n"
+ "new_MisesFisherGaussPeakShape(double max_intensity, double radial_size, kvector_t zenith, double kappa_1, double kappa_2) -> MisesFisherGaussPeakShape\n"
+ "MisesFisherGaussPeakShape::MisesFisherGaussPeakShape(double max_intensity, double radial_size, kvector_t zenith, double kappa_1, double kappa_2)\n"
+ "\n"
+ ""},
+ { "delete_MisesFisherGaussPeakShape", _wrap_delete_MisesFisherGaussPeakShape, METH_O, "\n"
+ "delete_MisesFisherGaussPeakShape(MisesFisherGaussPeakShape self)\n"
+ "MisesFisherGaussPeakShape::~MisesFisherGaussPeakShape() override\n"
+ "\n"
+ ""},
{ "MisesFisherGaussPeakShape_clone", _wrap_MisesFisherGaussPeakShape_clone, METH_O, "\n"
"MisesFisherGaussPeakShape_clone(MisesFisherGaussPeakShape self) -> MisesFisherGaussPeakShape\n"
- "virtual IPeakShape* IPeakShape::clone() const =0\n"
+ "MisesFisherGaussPeakShape * MisesFisherGaussPeakShape::clone() const override\n"
"\n"
"Returns a clone of this ISample object. \n"
"\n"
""},
{ "MisesFisherGaussPeakShape_accept", _wrap_MisesFisherGaussPeakShape_accept, METH_VARARGS, "\n"
"MisesFisherGaussPeakShape_accept(MisesFisherGaussPeakShape self, INodeVisitor visitor)\n"
- "virtual void INode::accept(INodeVisitor *visitor) const =0\n"
+ "void MisesFisherGaussPeakShape::accept(INodeVisitor *visitor) const override\n"
"\n"
"Calls the INodeVisitor's visit method. \n"
"\n"
""},
{ "MisesFisherGaussPeakShape_evaluate", _wrap_MisesFisherGaussPeakShape_evaluate, METH_VARARGS, "\n"
"MisesFisherGaussPeakShape_evaluate(MisesFisherGaussPeakShape self, kvector_t q, kvector_t q_lattice_point) -> double\n"
- "virtual double IPeakShape::evaluate(const kvector_t q, const kvector_t q_lattice_point) const =0\n"
+ "double MisesFisherGaussPeakShape::evaluate(const kvector_t q, const kvector_t q_lattice_point) const override\n"
"\n"
"Evaluates the peak shape at q from a reciprocal lattice point at q_lattice_point. \n"
"\n"
""},
{ "MisesFisherGaussPeakShape_angularDisorder", _wrap_MisesFisherGaussPeakShape_angularDisorder, METH_O, "\n"
"MisesFisherGaussPeakShape_angularDisorder(MisesFisherGaussPeakShape self) -> bool\n"
- "virtual bool IPeakShape::angularDisorder() const\n"
+ "bool MisesFisherGaussPeakShape::angularDisorder() const override\n"
"\n"
"Indicates if the peak shape encodes angular disorder, in which case all peaks in a spherical shell are needed \n"
"\n"
""},
{ "MisesFisherGaussPeakShape_swigregister", MisesFisherGaussPeakShape_swigregister, METH_O, NULL},
{ "MisesFisherGaussPeakShape_swiginit", MisesFisherGaussPeakShape_swiginit, METH_VARARGS, NULL},
- { "new_MisesGaussPeakShape", _wrap_new_MisesGaussPeakShape, METH_VARARGS, "new_MisesGaussPeakShape(double max_intensity, double radial_size, kvector_t zenith, double kappa) -> MisesGaussPeakShape"},
- { "delete_MisesGaussPeakShape", _wrap_delete_MisesGaussPeakShape, METH_O, "delete_MisesGaussPeakShape(MisesGaussPeakShape self)"},
+ { "new_MisesGaussPeakShape", _wrap_new_MisesGaussPeakShape, METH_VARARGS, "\n"
+ "new_MisesGaussPeakShape(double max_intensity, double radial_size, kvector_t zenith, double kappa) -> MisesGaussPeakShape\n"
+ "MisesGaussPeakShape::MisesGaussPeakShape(double max_intensity, double radial_size, kvector_t zenith, double kappa)\n"
+ "\n"
+ ""},
+ { "delete_MisesGaussPeakShape", _wrap_delete_MisesGaussPeakShape, METH_O, "\n"
+ "delete_MisesGaussPeakShape(MisesGaussPeakShape self)\n"
+ "MisesGaussPeakShape::~MisesGaussPeakShape() override\n"
+ "\n"
+ ""},
{ "MisesGaussPeakShape_clone", _wrap_MisesGaussPeakShape_clone, METH_O, "\n"
"MisesGaussPeakShape_clone(MisesGaussPeakShape self) -> MisesGaussPeakShape\n"
- "virtual IPeakShape* IPeakShape::clone() const =0\n"
+ "MisesGaussPeakShape * MisesGaussPeakShape::clone() const override\n"
"\n"
"Returns a clone of this ISample object. \n"
"\n"
""},
{ "MisesGaussPeakShape_accept", _wrap_MisesGaussPeakShape_accept, METH_VARARGS, "\n"
"MisesGaussPeakShape_accept(MisesGaussPeakShape self, INodeVisitor visitor)\n"
- "virtual void INode::accept(INodeVisitor *visitor) const =0\n"
+ "void MisesGaussPeakShape::accept(INodeVisitor *visitor) const override\n"
"\n"
"Calls the INodeVisitor's visit method. \n"
"\n"
""},
{ "MisesGaussPeakShape_evaluate", _wrap_MisesGaussPeakShape_evaluate, METH_VARARGS, "\n"
"MisesGaussPeakShape_evaluate(MisesGaussPeakShape self, kvector_t q, kvector_t q_lattice_point) -> double\n"
- "virtual double IPeakShape::evaluate(const kvector_t q, const kvector_t q_lattice_point) const =0\n"
+ "double MisesGaussPeakShape::evaluate(const kvector_t q, const kvector_t q_lattice_point) const override\n"
"\n"
"Evaluates the peak shape at q from a reciprocal lattice point at q_lattice_point. \n"
"\n"
""},
{ "MisesGaussPeakShape_angularDisorder", _wrap_MisesGaussPeakShape_angularDisorder, METH_O, "\n"
"MisesGaussPeakShape_angularDisorder(MisesGaussPeakShape self) -> bool\n"
- "virtual bool IPeakShape::angularDisorder() const\n"
+ "bool MisesGaussPeakShape::angularDisorder() const override\n"
"\n"
"Indicates if the peak shape encodes angular disorder, in which case all peaks in a spherical shell are needed \n"
"\n"
@@ -128382,7 +128286,7 @@ static PyMethodDef SwigMethods[] = {
{ "new_IInterferenceFunction", _wrap_new_IInterferenceFunction, METH_VARARGS, "\n"
"IInterferenceFunction(NodeMeta meta, vdouble1d_t PValues)\n"
"new_IInterferenceFunction(PyObject * _self, double position_var) -> IInterferenceFunction\n"
- "IInterferenceFunction::IInterferenceFunction(const IInterferenceFunction &other)\n"
+ "IInterferenceFunction::IInterferenceFunction(double position_var)\n"
"\n"
""},
{ "IInterferenceFunction_clone", _wrap_IInterferenceFunction_clone, METH_O, "\n"
@@ -128435,11 +128339,7 @@ static PyMethodDef SwigMethods[] = {
"\n"
""},
{ "IInterferenceFunction_iff_without_dw", _wrap_IInterferenceFunction_iff_without_dw, METH_VARARGS, "IInterferenceFunction_iff_without_dw(IInterferenceFunction self, kvector_t q) -> double"},
- { "delete_IInterferenceFunction", _wrap_delete_IInterferenceFunction, METH_O, "\n"
- "delete_IInterferenceFunction(IInterferenceFunction self)\n"
- "IInterferenceFunction::~IInterferenceFunction()\n"
- "\n"
- ""},
+ { "delete_IInterferenceFunction", _wrap_delete_IInterferenceFunction, METH_O, "delete_IInterferenceFunction(IInterferenceFunction self)"},
{ "disown_IInterferenceFunction", _wrap_disown_IInterferenceFunction, METH_O, NULL},
{ "IInterferenceFunction_swigregister", IInterferenceFunction_swigregister, METH_O, NULL},
{ "IInterferenceFunction_swiginit", IInterferenceFunction_swiginit, METH_VARARGS, NULL},
@@ -128491,8 +128391,16 @@ static PyMethodDef SwigMethods[] = {
"one-dimensional decay function in reciprocal space \n"
"\n"
""},
- { "InterferenceFunction1DLattice_getLength", _wrap_InterferenceFunction1DLattice_getLength, METH_O, "InterferenceFunction1DLattice_getLength(InterferenceFunction1DLattice self) -> double"},
- { "InterferenceFunction1DLattice_getXi", _wrap_InterferenceFunction1DLattice_getXi, METH_O, "InterferenceFunction1DLattice_getXi(InterferenceFunction1DLattice self) -> double"},
+ { "InterferenceFunction1DLattice_getLength", _wrap_InterferenceFunction1DLattice_getLength, METH_O, "\n"
+ "InterferenceFunction1DLattice_getLength(InterferenceFunction1DLattice self) -> double\n"
+ "double InterferenceFunction1DLattice::getLength() const\n"
+ "\n"
+ ""},
+ { "InterferenceFunction1DLattice_getXi", _wrap_InterferenceFunction1DLattice_getXi, METH_O, "\n"
+ "InterferenceFunction1DLattice_getXi(InterferenceFunction1DLattice self) -> double\n"
+ "double InterferenceFunction1DLattice::getXi() const\n"
+ "\n"
+ ""},
{ "InterferenceFunction1DLattice_getChildren", _wrap_InterferenceFunction1DLattice_getChildren, METH_O, "\n"
"InterferenceFunction1DLattice_getChildren(InterferenceFunction1DLattice self) -> swig_dummy_type_const_inode_vector\n"
"std::vector< const INode * > InterferenceFunction1DLattice::getChildren() const override final\n"
@@ -128505,24 +128413,7 @@ static PyMethodDef SwigMethods[] = {
{ "new_InterferenceFunction2DLattice", _wrap_new_InterferenceFunction2DLattice, METH_VARARGS, "\n"
"InterferenceFunction2DLattice(double length_1, double length_2, double alpha, double xi)\n"
"new_InterferenceFunction2DLattice(Lattice2D lattice) -> InterferenceFunction2DLattice\n"
- "InterferenceFunction2DLattice::InterferenceFunction2DLattice(double length_1, double length_2, double alpha, double xi=0.0)\n"
- "\n"
- "Constructor of two-dimensional interference function.\n"
- "\n"
- "Parameters:\n"
- "-----------\n"
- "\n"
- "length_1: \n"
- "length of the first basis vector in nanometers\n"
- "\n"
- "length_2: \n"
- "length of the second basis vector in nanometers\n"
- "\n"
- "alpha: \n"
- "angle between the basis vectors in radians\n"
- "\n"
- "xi: \n"
- "rotation of the lattice with respect to the x-axis (beam direction) in radians \n"
+ "InterferenceFunction2DLattice::InterferenceFunction2DLattice(const Lattice2D &lattice)\n"
"\n"
""},
{ "delete_InterferenceFunction2DLattice", _wrap_delete_InterferenceFunction2DLattice, METH_O, "\n"
@@ -128600,7 +128491,7 @@ static PyMethodDef SwigMethods[] = {
{ "new_InterferenceFunction2DParaCrystal", _wrap_new_InterferenceFunction2DParaCrystal, METH_VARARGS, "\n"
"InterferenceFunction2DParaCrystal(Lattice2D lattice, double damping_length, double domain_size_1, double domain_size_2)\n"
"new_InterferenceFunction2DParaCrystal(double length_1, double length_2, double alpha, double xi, double damping_length) -> InterferenceFunction2DParaCrystal\n"
- "InterferenceFunction2DParaCrystal::InterferenceFunction2DParaCrystal(double length_1, double length_2, double alpha, double xi=0.0, double damping_length=0.0)\n"
+ "InterferenceFunction2DParaCrystal::InterferenceFunction2DParaCrystal(double length_1, double length_2, double alpha, double xi, double damping_length)\n"
"\n"
"Constructor of interference function of two-dimensional paracrystal.\n"
"\n"
@@ -129067,12 +128958,12 @@ static PyMethodDef SwigMethods[] = {
{ "InterferenceFunctionFinite3DLattice_swiginit", InterferenceFunctionFinite3DLattice_swiginit, METH_VARARGS, NULL},
{ "new_InterferenceFunctionHardDisk", _wrap_new_InterferenceFunctionHardDisk, METH_VARARGS, "\n"
"InterferenceFunctionHardDisk(double radius, double density, double position_var=0)\n"
- "InterferenceFunctionHardDisk::InterferenceFunctionHardDisk(double radius, double density)\n"
+ "InterferenceFunctionHardDisk::InterferenceFunctionHardDisk(double radius, double density, double position_var=0)\n"
"\n"
""},
{ "delete_InterferenceFunctionHardDisk", _wrap_delete_InterferenceFunctionHardDisk, METH_O, "\n"
"delete_InterferenceFunctionHardDisk(InterferenceFunctionHardDisk self)\n"
- "InterferenceFunctionHardDisk::~InterferenceFunctionHardDisk() final\n"
+ "InterferenceFunctionHardDisk::~InterferenceFunctionHardDisk() final=default\n"
"\n"
""},
{ "InterferenceFunctionHardDisk_clone", _wrap_InterferenceFunctionHardDisk_clone, METH_O, "\n"
@@ -129132,7 +129023,7 @@ static PyMethodDef SwigMethods[] = {
{ "InterferenceFunctionNone_swiginit", InterferenceFunctionNone_swiginit, METH_VARARGS, NULL},
{ "new_InterferenceFunctionRadialParaCrystal", _wrap_new_InterferenceFunctionRadialParaCrystal, METH_VARARGS, "\n"
"new_InterferenceFunctionRadialParaCrystal(double peak_distance, double damping_length) -> InterferenceFunctionRadialParaCrystal\n"
- "InterferenceFunctionRadialParaCrystal::InterferenceFunctionRadialParaCrystal(double peak_distance, double damping_length=0.0)\n"
+ "InterferenceFunctionRadialParaCrystal::InterferenceFunctionRadialParaCrystal(double peak_distance, double damping_length)\n"
"\n"
"Constructor of interference function of radial paracrystal.\n"
"\n"
@@ -129756,21 +129647,7 @@ static PyMethodDef SwigMethods[] = {
{ "new_LayerRoughness", _wrap_new_LayerRoughness, METH_VARARGS, "\n"
"LayerRoughness(double sigma, double hurstParameter, double lateralCorrLength)\n"
"new_LayerRoughness() -> LayerRoughness\n"
- "LayerRoughness::LayerRoughness(double sigma, double hurstParameter, double lateralCorrLength)\n"
- "\n"
- "Constructor of layer roughness.\n"
- "\n"
- "Parameters:\n"
- "-----------\n"
- "\n"
- "sigma: \n"
- "rms of the roughness in nanometers\n"
- "\n"
- "hurstParameter: \n"
- "hurst parameter which describes how jagged the interface, dimensionless [0.0, 1.0], where 0.0 gives more spikes, 1.0 more smoothness\n"
- "\n"
- "lateralCorrLength: \n"
- "lateral correlation length of the roughness in nanometers \n"
+ "LayerRoughness::LayerRoughness()\n"
"\n"
""},
{ "LayerRoughness_clone", _wrap_LayerRoughness_clone, METH_O, "\n"
@@ -130211,19 +130088,31 @@ static PyMethodDef SwigMethods[] = {
""},
{ "delete_FormFactorPolygonalSurface", _wrap_delete_FormFactorPolygonalSurface, METH_O, "delete_FormFactorPolygonalSurface(FormFactorPolygonalSurface self)"},
{ "FormFactorPolygonalSurface_swigregister", FormFactorPolygonalSurface_swigregister, METH_O, NULL},
- { "IProfileRipple_getLength", _wrap_IProfileRipple_getLength, METH_O, "IProfileRipple_getLength(IProfileRipple self) -> double"},
- { "IProfileRipple_getHeight", _wrap_IProfileRipple_getHeight, METH_O, "IProfileRipple_getHeight(IProfileRipple self) -> double"},
- { "IProfileRipple_getWidth", _wrap_IProfileRipple_getWidth, METH_O, "IProfileRipple_getWidth(IProfileRipple self) -> double"},
+ { "IProfileRipple_getLength", _wrap_IProfileRipple_getLength, METH_O, "\n"
+ "IProfileRipple_getLength(IProfileRipple self) -> double\n"
+ "double IProfileRipple::getLength() const\n"
+ "\n"
+ ""},
+ { "IProfileRipple_getHeight", _wrap_IProfileRipple_getHeight, METH_O, "\n"
+ "IProfileRipple_getHeight(IProfileRipple self) -> double\n"
+ "double IProfileRipple::getHeight() const\n"
+ "\n"
+ ""},
+ { "IProfileRipple_getWidth", _wrap_IProfileRipple_getWidth, METH_O, "\n"
+ "IProfileRipple_getWidth(IProfileRipple self) -> double\n"
+ "double IProfileRipple::getWidth() const\n"
+ "\n"
+ ""},
{ "IProfileRipple_radialExtension", _wrap_IProfileRipple_radialExtension, METH_O, "\n"
"IProfileRipple_radialExtension(IProfileRipple self) -> double\n"
- "virtual double IFormFactor::radialExtension() const =0\n"
+ "double IProfileRipple::radialExtension() const override final\n"
"\n"
"Returns the (approximate in some cases) radial size of the particle of this form factor's shape. This is used for SSCA calculations \n"
"\n"
""},
{ "IProfileRipple_evaluate_for_q", _wrap_IProfileRipple_evaluate_for_q, METH_VARARGS, "\n"
"IProfileRipple_evaluate_for_q(IProfileRipple self, cvector_t q) -> complex_t\n"
- "virtual complex_t IFormFactorBorn::evaluate_for_q(cvector_t q) const =0\n"
+ "complex_t IProfileRipple::evaluate_for_q(cvector_t q) const override final\n"
"\n"
"Returns scattering amplitude for complex scattering wavevector q=k_i-k_f. This method is public only for convenience of plotting form factors in Python. \n"
"\n"
@@ -130234,7 +130123,11 @@ static PyMethodDef SwigMethods[] = {
{ "IProfileRectangularRipple_swigregister", IProfileRectangularRipple_swigregister, METH_O, NULL},
{ "delete_ICosineRipple", _wrap_delete_ICosineRipple, METH_O, "delete_ICosineRipple(ICosineRipple self)"},
{ "ICosineRipple_swigregister", ICosineRipple_swigregister, METH_O, NULL},
- { "ISawtoothRipple_getAsymmetry", _wrap_ISawtoothRipple_getAsymmetry, METH_O, "ISawtoothRipple_getAsymmetry(ISawtoothRipple self) -> double"},
+ { "ISawtoothRipple_getAsymmetry", _wrap_ISawtoothRipple_getAsymmetry, METH_O, "\n"
+ "ISawtoothRipple_getAsymmetry(ISawtoothRipple self) -> double\n"
+ "double ISawtoothRipple::getAsymmetry() const\n"
+ "\n"
+ ""},
{ "delete_ISawtoothRipple", _wrap_delete_ISawtoothRipple, METH_O, "delete_ISawtoothRipple(ISawtoothRipple self)"},
{ "ISawtoothRipple_swigregister", ISawtoothRipple_swigregister, METH_O, NULL},
{ "new_FormFactorAnisoPyramid", _wrap_new_FormFactorAnisoPyramid, METH_VARARGS, "\n"
@@ -130242,23 +130135,6 @@ static PyMethodDef SwigMethods[] = {
"new_FormFactorAnisoPyramid(double length, double width, double height, double alpha) -> FormFactorAnisoPyramid\n"
"FormFactorAnisoPyramid::FormFactorAnisoPyramid(double length, double width, double height, double alpha)\n"
"\n"
- "Constructor of a truncated pyramid with a rectangular base.\n"
- "\n"
- "Parameters:\n"
- "-----------\n"
- "\n"
- "length: \n"
- "length of the rectangular base in nm\n"
- "\n"
- "width: \n"
- "width of the rectangular base in nm\n"
- "\n"
- "height: \n"
- "height of pyramid in nm\n"
- "\n"
- "alpha: \n"
- "dihedral angle in radians between base and facet \n"
- "\n"
""},
{ "FormFactorAnisoPyramid_clone", _wrap_FormFactorAnisoPyramid_clone, METH_O, "\n"
"FormFactorAnisoPyramid_clone(FormFactorAnisoPyramid self) -> FormFactorAnisoPyramid\n"
@@ -130302,20 +130178,6 @@ static PyMethodDef SwigMethods[] = {
"new_FormFactorBox(double length, double width, double height) -> FormFactorBox\n"
"FormFactorBox::FormFactorBox(double length, double width, double height)\n"
"\n"
- "Constructor of a rectangular cuboid.\n"
- "\n"
- "Parameters:\n"
- "-----------\n"
- "\n"
- "length: \n"
- "length of the base in nanometers\n"
- "\n"
- "width: \n"
- "width of the base in nanometers\n"
- "\n"
- "height: \n"
- "height of the box in nanometers \n"
- "\n"
""},
{ "FormFactorBox_clone", _wrap_FormFactorBox_clone, METH_O, "\n"
"FormFactorBox_clone(FormFactorBox self) -> FormFactorBox\n"
@@ -130370,17 +130232,6 @@ static PyMethodDef SwigMethods[] = {
"new_FormFactorCantellatedCube(double length, double removed_length) -> FormFactorCantellatedCube\n"
"FormFactorCantellatedCube::FormFactorCantellatedCube(double length, double removed_length)\n"
"\n"
- "Constructor of a truncated cube.\n"
- "\n"
- "Parameters:\n"
- "-----------\n"
- "\n"
- "length: \n"
- "length of the full cube's edge in nanometers\n"
- "\n"
- "removed_length: \n"
- "removed length from each edge of the cube in nanometers \n"
- "\n"
""},
{ "FormFactorCantellatedCube_clone", _wrap_FormFactorCantellatedCube_clone, METH_O, "\n"
"FormFactorCantellatedCube_clone(FormFactorCantellatedCube self) -> FormFactorCantellatedCube\n"
@@ -130414,20 +130265,6 @@ static PyMethodDef SwigMethods[] = {
"new_FormFactorCone(double radius, double height, double alpha) -> FormFactorCone\n"
"FormFactorCone::FormFactorCone(double radius, double height, double alpha)\n"
"\n"
- "Constructor of a truncated cone with circular base.\n"
- "\n"
- "Parameters:\n"
- "-----------\n"
- "\n"
- "radius: \n"
- "radius of the base in nanometers\n"
- "\n"
- "height: \n"
- "height of the cone in nanometers\n"
- "\n"
- "alpha: \n"
- "angle between the base and the side surface in radians \n"
- "\n"
""},
{ "FormFactorCone_clone", _wrap_FormFactorCone_clone, METH_O, "\n"
"FormFactorCone_clone(FormFactorCone self) -> FormFactorCone\n"
@@ -130480,20 +130317,6 @@ static PyMethodDef SwigMethods[] = {
"new_FormFactorCone6(double base_edge, double height, double alpha) -> FormFactorCone6\n"
"FormFactorCone6::FormFactorCone6(double base_edge, double height, double alpha)\n"
"\n"
- "Constructor of a truncated pyramid, based on a regular hexagon\n"
- "\n"
- "Parameters:\n"
- "-----------\n"
- "\n"
- "base_edge: \n"
- "Edge of the regular hexagonal base in nanometers\n"
- "\n"
- "height: \n"
- "height of a truncated pyramid in nanometers\n"
- "\n"
- "alpha: \n"
- "dihedral angle in radians between base and facet \n"
- "\n"
""},
{ "FormFactorCone6_clone", _wrap_FormFactorCone6_clone, METH_O, "\n"
"FormFactorCone6_clone(FormFactorCone6 self) -> FormFactorCone6\n"
@@ -130530,17 +130353,19 @@ static PyMethodDef SwigMethods[] = {
{ "new_FormFactorCosineRippleBox", _wrap_new_FormFactorCosineRippleBox, METH_VARARGS, "\n"
"FormFactorCosineRippleBox(vdouble1d_t P)\n"
"new_FormFactorCosineRippleBox(double length, double width, double height) -> FormFactorCosineRippleBox\n"
+ "FormFactorCosineRippleBox::FormFactorCosineRippleBox(double length, double width, double height)\n"
+ "\n"
""},
{ "FormFactorCosineRippleBox_clone", _wrap_FormFactorCosineRippleBox_clone, METH_O, "\n"
"FormFactorCosineRippleBox_clone(FormFactorCosineRippleBox self) -> FormFactorCosineRippleBox\n"
- "IFormFactorBorn* IFormFactorBorn::clone() const override=0\n"
+ "FormFactorCosineRippleBox * FormFactorCosineRippleBox::clone() const override final\n"
"\n"
"Returns a clone of this ISample object. \n"
"\n"
""},
{ "FormFactorCosineRippleBox_accept", _wrap_FormFactorCosineRippleBox_accept, METH_VARARGS, "\n"
"FormFactorCosineRippleBox_accept(FormFactorCosineRippleBox self, INodeVisitor visitor)\n"
- "virtual void INode::accept(INodeVisitor *visitor) const =0\n"
+ "void FormFactorCosineRippleBox::accept(INodeVisitor *visitor) const override final\n"
"\n"
"Calls the INodeVisitor's visit method. \n"
"\n"
@@ -130551,17 +130376,19 @@ static PyMethodDef SwigMethods[] = {
{ "new_FormFactorCosineRippleGauss", _wrap_new_FormFactorCosineRippleGauss, METH_VARARGS, "\n"
"FormFactorCosineRippleGauss(vdouble1d_t P)\n"
"new_FormFactorCosineRippleGauss(double length, double width, double height) -> FormFactorCosineRippleGauss\n"
+ "FormFactorCosineRippleGauss::FormFactorCosineRippleGauss(double length, double width, double height)\n"
+ "\n"
""},
{ "FormFactorCosineRippleGauss_clone", _wrap_FormFactorCosineRippleGauss_clone, METH_O, "\n"
"FormFactorCosineRippleGauss_clone(FormFactorCosineRippleGauss self) -> FormFactorCosineRippleGauss\n"
- "IFormFactorBorn* IFormFactorBorn::clone() const override=0\n"
+ "FormFactorCosineRippleGauss * FormFactorCosineRippleGauss::clone() const override final\n"
"\n"
"Returns a clone of this ISample object. \n"
"\n"
""},
{ "FormFactorCosineRippleGauss_accept", _wrap_FormFactorCosineRippleGauss_accept, METH_VARARGS, "\n"
"FormFactorCosineRippleGauss_accept(FormFactorCosineRippleGauss self, INodeVisitor visitor)\n"
- "virtual void INode::accept(INodeVisitor *visitor) const =0\n"
+ "void FormFactorCosineRippleGauss::accept(INodeVisitor *visitor) const override final\n"
"\n"
"Calls the INodeVisitor's visit method. \n"
"\n"
@@ -130572,17 +130399,19 @@ static PyMethodDef SwigMethods[] = {
{ "new_FormFactorCosineRippleLorentz", _wrap_new_FormFactorCosineRippleLorentz, METH_VARARGS, "\n"
"FormFactorCosineRippleLorentz(vdouble1d_t P)\n"
"new_FormFactorCosineRippleLorentz(double length, double width, double height) -> FormFactorCosineRippleLorentz\n"
+ "FormFactorCosineRippleLorentz::FormFactorCosineRippleLorentz(double length, double width, double height)\n"
+ "\n"
""},
{ "FormFactorCosineRippleLorentz_clone", _wrap_FormFactorCosineRippleLorentz_clone, METH_O, "\n"
"FormFactorCosineRippleLorentz_clone(FormFactorCosineRippleLorentz self) -> FormFactorCosineRippleLorentz\n"
- "IFormFactorBorn* IFormFactorBorn::clone() const override=0\n"
+ "FormFactorCosineRippleLorentz * FormFactorCosineRippleLorentz::clone() const override final\n"
"\n"
"Returns a clone of this ISample object. \n"
"\n"
""},
{ "FormFactorCosineRippleLorentz_accept", _wrap_FormFactorCosineRippleLorentz_accept, METH_VARARGS, "\n"
"FormFactorCosineRippleLorentz_accept(FormFactorCosineRippleLorentz self, INodeVisitor visitor)\n"
- "virtual void INode::accept(INodeVisitor *visitor) const =0\n"
+ "void FormFactorCosineRippleLorentz::accept(INodeVisitor *visitor) const override final\n"
"\n"
"Calls the INodeVisitor's visit method. \n"
"\n"
@@ -130595,23 +130424,6 @@ static PyMethodDef SwigMethods[] = {
"new_FormFactorCuboctahedron(double length, double height, double height_ratio, double alpha) -> FormFactorCuboctahedron\n"
"FormFactorCuboctahedron::FormFactorCuboctahedron(double length, double height, double height_ratio, double alpha)\n"
"\n"
- "Constructor of cuboctahedron (compound of two truncated pyramids with a common square base and opposite orientations).\n"
- "\n"
- "Parameters:\n"
- "-----------\n"
- "\n"
- "length: \n"
- "side length of the common square base in nanometers\n"
- "\n"
- "height: \n"
- "height of the lower pyramid in nanometers\n"
- "\n"
- "height_ratio: \n"
- "ratio of heights of top to bottom pyramids\n"
- "\n"
- "alpha: \n"
- "dihedral angle in radians between base and facet \n"
- "\n"
""},
{ "FormFactorCuboctahedron_clone", _wrap_FormFactorCuboctahedron_clone, METH_O, "\n"
"FormFactorCuboctahedron_clone(FormFactorCuboctahedron self) -> FormFactorCuboctahedron\n"
@@ -130655,17 +130467,6 @@ static PyMethodDef SwigMethods[] = {
"new_FormFactorCylinder(double radius, double height) -> FormFactorCylinder\n"
"FormFactorCylinder::FormFactorCylinder(double radius, double height)\n"
"\n"
- "Constructor of a cylinder with a circular base.\n"
- "\n"
- "Parameters:\n"
- "-----------\n"
- "\n"
- "radius: \n"
- "radius of the circular base in nanometers\n"
- "\n"
- "height: \n"
- "height of the cylinder in nanometers \n"
- "\n"
""},
{ "FormFactorCylinder_clone", _wrap_FormFactorCylinder_clone, METH_O, "\n"
"FormFactorCylinder_clone(FormFactorCylinder self) -> FormFactorCylinder\n"
@@ -130713,22 +130514,6 @@ static PyMethodDef SwigMethods[] = {
"new_FormFactorDodecahedron(double edge) -> FormFactorDodecahedron\n"
"FormFactorDodecahedron::FormFactorDodecahedron(double edge)\n"
"\n"
- "Constructs a regular dodecahedron.\n"
- "\n"
- "Parameters:\n"
- "-----------\n"
- "\n"
- "edge: \n"
- "length\n"
- "\n"
- "Constructor of a dodecahedron.\n"
- "\n"
- "Parameters:\n"
- "-----------\n"
- "\n"
- "edge: \n"
- "length of the edge in nanometers \n"
- "\n"
""},
{ "FormFactorDodecahedron_clone", _wrap_FormFactorDodecahedron_clone, METH_O, "\n"
"FormFactorDodecahedron_clone(FormFactorDodecahedron self) -> FormFactorDodecahedron\n"
@@ -130757,14 +130542,6 @@ static PyMethodDef SwigMethods[] = {
"new_FormFactorDot(double radius) -> FormFactorDot\n"
"FormFactorDot::FormFactorDot(double radius)\n"
"\n"
- "Constructor.\n"
- "\n"
- "Parameters:\n"
- "-----------\n"
- "\n"
- "rscat: \n"
- "radius of a sphere with same forward scattering power, in nanometers \n"
- "\n"
""},
{ "FormFactorDot_clone", _wrap_FormFactorDot_clone, METH_O, "\n"
"FormFactorDot_clone(FormFactorDot self) -> FormFactorDot\n"
@@ -130821,20 +130598,6 @@ static PyMethodDef SwigMethods[] = {
"new_FormFactorEllipsoidalCylinder(double radius_x, double radius_y, double height) -> FormFactorEllipsoidalCylinder\n"
"FormFactorEllipsoidalCylinder::FormFactorEllipsoidalCylinder(double radius_x, double radius_y, double height)\n"
"\n"
- "Constructor of a cylinder with an ellipse cross section.\n"
- "\n"
- "Parameters:\n"
- "-----------\n"
- "\n"
- "radius_x: \n"
- "radius of the ellipse base in the x-direction, in nanometers\n"
- "\n"
- "radius_y: \n"
- "radius of the ellipse base in the y-direction, in nanometers\n"
- "\n"
- "height: \n"
- "height of the ellipsoidal cylinder in nanometers \n"
- "\n"
""},
{ "FormFactorEllipsoidalCylinder_clone", _wrap_FormFactorEllipsoidalCylinder_clone, METH_O, "\n"
"FormFactorEllipsoidalCylinder_clone(FormFactorEllipsoidalCylinder self) -> FormFactorEllipsoidalCylinder\n"
@@ -130887,14 +130650,6 @@ static PyMethodDef SwigMethods[] = {
"FormFactorFullSphere(double radius, bool position_at_center=False)\n"
"FormFactorFullSphere::FormFactorFullSphere(double radius, bool position_at_center=false)\n"
"\n"
- "Constructor of a full sphere.\n"
- "\n"
- "Parameters:\n"
- "-----------\n"
- "\n"
- "radius: \n"
- "radius of the sphere in nanometers \n"
- "\n"
""},
{ "FormFactorFullSphere_clone", _wrap_FormFactorFullSphere_clone, METH_O, "\n"
"FormFactorFullSphere_clone(FormFactorFullSphere self) -> FormFactorFullSphere\n"
@@ -130951,17 +130706,6 @@ static PyMethodDef SwigMethods[] = {
"new_FormFactorFullSpheroid(double radius, double height) -> FormFactorFullSpheroid\n"
"FormFactorFullSpheroid::FormFactorFullSpheroid(double radius, double height)\n"
"\n"
- "Constructor of full spheroid.\n"
- "\n"
- "Parameters:\n"
- "-----------\n"
- "\n"
- "radius: \n"
- "radius of the circular cross section in nanometers\n"
- "\n"
- "height: \n"
- "height of the full spheroid in nanometers \n"
- "\n"
""},
{ "FormFactorFullSpheroid_clone", _wrap_FormFactorFullSpheroid_clone, METH_O, "\n"
"FormFactorFullSpheroid_clone(FormFactorFullSpheroid self) -> FormFactorFullSpheroid\n"
@@ -131009,20 +130753,6 @@ static PyMethodDef SwigMethods[] = {
"new_FormFactorHemiEllipsoid(double radius_x, double radius_y, double height) -> FormFactorHemiEllipsoid\n"
"FormFactorHemiEllipsoid::FormFactorHemiEllipsoid(double radius_x, double radius_y, double height)\n"
"\n"
- "Constructor of horizontally oriented ellipsoid, truncated at the central plane.\n"
- "\n"
- "Parameters:\n"
- "-----------\n"
- "\n"
- "radius_x: \n"
- "radius of the ellipse base in the x-direction, in nanometers\n"
- "\n"
- "radius_y: \n"
- "radius of the ellipse base in the y-direction, in nanometers\n"
- "\n"
- "height: \n"
- "height of the hemi ellipsoid in nanometers \n"
- "\n"
""},
{ "delete_FormFactorHemiEllipsoid", _wrap_delete_FormFactorHemiEllipsoid, METH_O, "\n"
"delete_FormFactorHemiEllipsoid(FormFactorHemiEllipsoid self)\n"
@@ -131116,14 +130846,6 @@ static PyMethodDef SwigMethods[] = {
"new_FormFactorIcosahedron(double edge) -> FormFactorIcosahedron\n"
"FormFactorIcosahedron::FormFactorIcosahedron(double edge)\n"
"\n"
- "Constructor of a icosahedron.\n"
- "\n"
- "Parameters:\n"
- "-----------\n"
- "\n"
- "edge: \n"
- "length of the edge in nanometers \n"
- "\n"
""},
{ "FormFactorIcosahedron_clone", _wrap_FormFactorIcosahedron_clone, METH_O, "\n"
"FormFactorIcosahedron_clone(FormFactorIcosahedron self) -> FormFactorIcosahedron\n"
@@ -131152,20 +130874,6 @@ static PyMethodDef SwigMethods[] = {
"new_FormFactorLongBoxGauss(double length, double width, double height) -> FormFactorLongBoxGauss\n"
"FormFactorLongBoxGauss::FormFactorLongBoxGauss(double length, double width, double height)\n"
"\n"
- "Box constructor.\n"
- "\n"
- "Parameters:\n"
- "-----------\n"
- "\n"
- "length: \n"
- "of Box's base\n"
- "\n"
- "width: \n"
- "of Box's base\n"
- "\n"
- "height: \n"
- "of Box\n"
- "\n"
""},
{ "FormFactorLongBoxGauss_clone", _wrap_FormFactorLongBoxGauss_clone, METH_O, "\n"
"FormFactorLongBoxGauss_clone(FormFactorLongBoxGauss self) -> FormFactorLongBoxGauss\n"
@@ -131218,20 +130926,6 @@ static PyMethodDef SwigMethods[] = {
"new_FormFactorLongBoxLorentz(double length, double width, double height) -> FormFactorLongBoxLorentz\n"
"FormFactorLongBoxLorentz::FormFactorLongBoxLorentz(double length, double width, double height)\n"
"\n"
- "Box constructor.\n"
- "\n"
- "Parameters:\n"
- "-----------\n"
- "\n"
- "length: \n"
- "of Box's base\n"
- "\n"
- "width: \n"
- "of Box's base\n"
- "\n"
- "height: \n"
- "of Box\n"
- "\n"
""},
{ "FormFactorLongBoxLorentz_clone", _wrap_FormFactorLongBoxLorentz_clone, METH_O, "\n"
"FormFactorLongBoxLorentz_clone(FormFactorLongBoxLorentz self) -> FormFactorLongBoxLorentz\n"
@@ -131284,17 +130978,6 @@ static PyMethodDef SwigMethods[] = {
"new_FormFactorPrism3(double base_edge, double height) -> FormFactorPrism3\n"
"FormFactorPrism3::FormFactorPrism3(double base_edge, double height)\n"
"\n"
- "Constructor of a prism with an equilaterial triangle base.\n"
- "\n"
- "Parameters:\n"
- "-----------\n"
- "\n"
- "base_edge: \n"
- "length of the base edge in nanometers\n"
- "\n"
- "height: \n"
- "height in nanometers \n"
- "\n"
""},
{ "FormFactorPrism3_clone", _wrap_FormFactorPrism3_clone, METH_O, "\n"
"FormFactorPrism3_clone(FormFactorPrism3 self) -> FormFactorPrism3\n"
@@ -131323,17 +131006,6 @@ static PyMethodDef SwigMethods[] = {
"new_FormFactorPrism6(double base_edge, double height) -> FormFactorPrism6\n"
"FormFactorPrism6::FormFactorPrism6(double base_edge, double height)\n"
"\n"
- "Constructor of a prism with a regular hexagonal base.\n"
- "\n"
- "Parameters:\n"
- "-----------\n"
- "\n"
- "base_edge: \n"
- "length of the hexagonal base in nanometers\n"
- "\n"
- "height: \n"
- "height in nanometers \n"
- "\n"
""},
{ "FormFactorPrism6_clone", _wrap_FormFactorPrism6_clone, METH_O, "\n"
"FormFactorPrism6_clone(FormFactorPrism6 self) -> FormFactorPrism6\n"
@@ -131362,20 +131034,6 @@ static PyMethodDef SwigMethods[] = {
"new_FormFactorPyramid(double base_edge, double height, double alpha) -> FormFactorPyramid\n"
"FormFactorPyramid::FormFactorPyramid(double base_edge, double height, double alpha)\n"
"\n"
- "Constructor of a truncated pyramid with a square base\n"
- "\n"
- "Parameters:\n"
- "-----------\n"
- "\n"
- "base_edge: \n"
- "length of the square base in nanometers\n"
- "\n"
- "height: \n"
- "height of the pyramid in nanometers\n"
- "\n"
- "alpha: \n"
- "dihedral angle between the base and a side face in radians \n"
- "\n"
""},
{ "FormFactorPyramid_clone", _wrap_FormFactorPyramid_clone, METH_O, "\n"
"FormFactorPyramid_clone(FormFactorPyramid self) -> FormFactorPyramid\n"
@@ -131412,17 +131070,19 @@ static PyMethodDef SwigMethods[] = {
{ "new_FormFactorSawtoothRippleBox", _wrap_new_FormFactorSawtoothRippleBox, METH_VARARGS, "\n"
"FormFactorSawtoothRippleBox(vdouble1d_t P)\n"
"new_FormFactorSawtoothRippleBox(double length, double width, double height, double asymmetry) -> FormFactorSawtoothRippleBox\n"
+ "FormFactorSawtoothRippleBox::FormFactorSawtoothRippleBox(double length, double width, double height, double asymmetry)\n"
+ "\n"
""},
{ "FormFactorSawtoothRippleBox_clone", _wrap_FormFactorSawtoothRippleBox_clone, METH_O, "\n"
"FormFactorSawtoothRippleBox_clone(FormFactorSawtoothRippleBox self) -> FormFactorSawtoothRippleBox\n"
- "IFormFactorBorn* IFormFactorBorn::clone() const override=0\n"
+ "FormFactorSawtoothRippleBox * FormFactorSawtoothRippleBox::clone() const override final\n"
"\n"
"Returns a clone of this ISample object. \n"
"\n"
""},
{ "FormFactorSawtoothRippleBox_accept", _wrap_FormFactorSawtoothRippleBox_accept, METH_VARARGS, "\n"
"FormFactorSawtoothRippleBox_accept(FormFactorSawtoothRippleBox self, INodeVisitor visitor)\n"
- "virtual void INode::accept(INodeVisitor *visitor) const =0\n"
+ "void FormFactorSawtoothRippleBox::accept(INodeVisitor *visitor) const override final\n"
"\n"
"Calls the INodeVisitor's visit method. \n"
"\n"
@@ -131433,17 +131093,19 @@ static PyMethodDef SwigMethods[] = {
{ "new_FormFactorSawtoothRippleGauss", _wrap_new_FormFactorSawtoothRippleGauss, METH_VARARGS, "\n"
"FormFactorSawtoothRippleGauss(vdouble1d_t P)\n"
"new_FormFactorSawtoothRippleGauss(double length, double width, double height, double asymmetry) -> FormFactorSawtoothRippleGauss\n"
+ "FormFactorSawtoothRippleGauss::FormFactorSawtoothRippleGauss(double length, double width, double height, double asymmetry)\n"
+ "\n"
""},
{ "FormFactorSawtoothRippleGauss_clone", _wrap_FormFactorSawtoothRippleGauss_clone, METH_O, "\n"
"FormFactorSawtoothRippleGauss_clone(FormFactorSawtoothRippleGauss self) -> FormFactorSawtoothRippleGauss\n"
- "IFormFactorBorn* IFormFactorBorn::clone() const override=0\n"
+ "FormFactorSawtoothRippleGauss * FormFactorSawtoothRippleGauss::clone() const override final\n"
"\n"
"Returns a clone of this ISample object. \n"
"\n"
""},
{ "FormFactorSawtoothRippleGauss_accept", _wrap_FormFactorSawtoothRippleGauss_accept, METH_VARARGS, "\n"
"FormFactorSawtoothRippleGauss_accept(FormFactorSawtoothRippleGauss self, INodeVisitor visitor)\n"
- "virtual void INode::accept(INodeVisitor *visitor) const =0\n"
+ "void FormFactorSawtoothRippleGauss::accept(INodeVisitor *visitor) const override final\n"
"\n"
"Calls the INodeVisitor's visit method. \n"
"\n"
@@ -131454,17 +131116,19 @@ static PyMethodDef SwigMethods[] = {
{ "new_FormFactorSawtoothRippleLorentz", _wrap_new_FormFactorSawtoothRippleLorentz, METH_VARARGS, "\n"
"FormFactorSawtoothRippleLorentz(vdouble1d_t P)\n"
"new_FormFactorSawtoothRippleLorentz(double length, double width, double height, double asymmetry) -> FormFactorSawtoothRippleLorentz\n"
+ "FormFactorSawtoothRippleLorentz::FormFactorSawtoothRippleLorentz(double length, double width, double height, double asymmetry)\n"
+ "\n"
""},
{ "FormFactorSawtoothRippleLorentz_clone", _wrap_FormFactorSawtoothRippleLorentz_clone, METH_O, "\n"
"FormFactorSawtoothRippleLorentz_clone(FormFactorSawtoothRippleLorentz self) -> FormFactorSawtoothRippleLorentz\n"
- "IFormFactorBorn* IFormFactorBorn::clone() const override=0\n"
+ "FormFactorSawtoothRippleLorentz * FormFactorSawtoothRippleLorentz::clone() const override final\n"
"\n"
"Returns a clone of this ISample object. \n"
"\n"
""},
{ "FormFactorSawtoothRippleLorentz_accept", _wrap_FormFactorSawtoothRippleLorentz_accept, METH_VARARGS, "\n"
"FormFactorSawtoothRippleLorentz_accept(FormFactorSawtoothRippleLorentz self, INodeVisitor visitor)\n"
- "virtual void INode::accept(INodeVisitor *visitor) const =0\n"
+ "void FormFactorSawtoothRippleLorentz::accept(INodeVisitor *visitor) const override final\n"
"\n"
"Calls the INodeVisitor's visit method. \n"
"\n"
@@ -131477,20 +131141,6 @@ static PyMethodDef SwigMethods[] = {
"new_FormFactorTetrahedron(double base_edge, double height, double alpha) -> FormFactorTetrahedron\n"
"FormFactorTetrahedron::FormFactorTetrahedron(double base_edge, double height, double alpha)\n"
"\n"
- "Constructor of a truncated tethrahedron.\n"
- "\n"
- "Parameters:\n"
- "-----------\n"
- "\n"
- "base_edge: \n"
- "length of one edge of the equilateral triangular base in nanometers\n"
- "\n"
- "height: \n"
- "height of the tetrahedron in nanometers\n"
- "\n"
- "alpha: \n"
- "dihedral angle in radians between base and facet \n"
- "\n"
""},
{ "FormFactorTetrahedron_clone", _wrap_FormFactorTetrahedron_clone, METH_O, "\n"
"FormFactorTetrahedron_clone(FormFactorTetrahedron self) -> FormFactorTetrahedron\n"
@@ -131529,17 +131179,6 @@ static PyMethodDef SwigMethods[] = {
"new_FormFactorTruncatedCube(double length, double removed_length) -> FormFactorTruncatedCube\n"
"FormFactorTruncatedCube::FormFactorTruncatedCube(double length, double removed_length)\n"
"\n"
- "Constructor of a truncated cube.\n"
- "\n"
- "Parameters:\n"
- "-----------\n"
- "\n"
- "length: \n"
- "length of the full cube's edge in nanometers\n"
- "\n"
- "removed_length: \n"
- "removed length from each edge of the cube in nanometers \n"
- "\n"
""},
{ "FormFactorTruncatedCube_clone", _wrap_FormFactorTruncatedCube_clone, METH_O, "\n"
"FormFactorTruncatedCube_clone(FormFactorTruncatedCube self) -> FormFactorTruncatedCube\n"
@@ -131571,21 +131210,7 @@ static PyMethodDef SwigMethods[] = {
{ "new_FormFactorTruncatedSphere", _wrap_new_FormFactorTruncatedSphere, METH_VARARGS, "\n"
"FormFactorTruncatedSphere(vdouble1d_t P)\n"
"new_FormFactorTruncatedSphere(double radius, double height, double dh) -> FormFactorTruncatedSphere\n"
- "FormFactorTruncatedSphere::FormFactorTruncatedSphere(double radius, double height, double dh=0.0)\n"
- "\n"
- "Constructor of a spherical dome.\n"
- "\n"
- "Parameters:\n"
- "-----------\n"
- "\n"
- "radius: \n"
- "radius of the truncated sphere in nanometers\n"
- "\n"
- "height: \n"
- "height of the truncated sphere in nanometers\n"
- "\n"
- "dh: \n"
- "length of cup truncated from the top \n"
+ "FormFactorTruncatedSphere::FormFactorTruncatedSphere(double radius, double height, double dh)\n"
"\n"
""},
{ "FormFactorTruncatedSphere_clone", _wrap_FormFactorTruncatedSphere_clone, METH_O, "\n"
@@ -131637,24 +131262,7 @@ static PyMethodDef SwigMethods[] = {
{ "new_FormFactorTruncatedSpheroid", _wrap_new_FormFactorTruncatedSpheroid, METH_VARARGS, "\n"
"FormFactorTruncatedSpheroid(vdouble1d_t P)\n"
"new_FormFactorTruncatedSpheroid(double radius, double height, double height_flattening, double dh) -> FormFactorTruncatedSpheroid\n"
- "FormFactorTruncatedSpheroid::FormFactorTruncatedSpheroid(double radius, double height, double height_flattening, double dh=0.0)\n"
- "\n"
- "Constructor of a spheroidal dome.\n"
- "\n"
- "Parameters:\n"
- "-----------\n"
- "\n"
- "radius: \n"
- "radius of the truncated spheroid in nanometers\n"
- "\n"
- "height: \n"
- "height of the truncated spheroid in nanometers\n"
- "\n"
- "height_flattening: \n"
- "ratio of the height of the corresponding full spheroid to its diameter\n"
- "\n"
- "dh: \n"
- "length of cup truncated from the top \n"
+ "FormFactorTruncatedSpheroid::FormFactorTruncatedSpheroid(double radius, double height, double height_flattening, double dh)\n"
"\n"
""},
{ "FormFactorTruncatedSpheroid_clone", _wrap_FormFactorTruncatedSpheroid_clone, METH_O, "\n"
@@ -131711,32 +131319,38 @@ static PyMethodDef SwigMethods[] = {
{ "new_FormFactorGaussSphere", _wrap_new_FormFactorGaussSphere, METH_VARARGS, "\n"
"FormFactorGaussSphere(vdouble1d_t P)\n"
"new_FormFactorGaussSphere(double mean_radius) -> FormFactorGaussSphere\n"
+ "FormFactorGaussSphere::FormFactorGaussSphere(double mean_radius)\n"
+ "\n"
""},
{ "FormFactorGaussSphere_clone", _wrap_FormFactorGaussSphere_clone, METH_O, "\n"
"FormFactorGaussSphere_clone(FormFactorGaussSphere self) -> FormFactorGaussSphere\n"
- "IFormFactorBorn* IFormFactorBorn::clone() const override=0\n"
+ "FormFactorGaussSphere* FormFactorGaussSphere::clone() const override final\n"
"\n"
"Returns a clone of this ISample object. \n"
"\n"
""},
{ "FormFactorGaussSphere_accept", _wrap_FormFactorGaussSphere_accept, METH_VARARGS, "\n"
"FormFactorGaussSphere_accept(FormFactorGaussSphere self, INodeVisitor visitor)\n"
- "virtual void INode::accept(INodeVisitor *visitor) const =0\n"
+ "void FormFactorGaussSphere::accept(INodeVisitor *visitor) const override final\n"
"\n"
"Calls the INodeVisitor's visit method. \n"
"\n"
""},
- { "FormFactorGaussSphere_getMeanRadius", _wrap_FormFactorGaussSphere_getMeanRadius, METH_O, "FormFactorGaussSphere_getMeanRadius(FormFactorGaussSphere self) -> double"},
+ { "FormFactorGaussSphere_getMeanRadius", _wrap_FormFactorGaussSphere_getMeanRadius, METH_O, "\n"
+ "FormFactorGaussSphere_getMeanRadius(FormFactorGaussSphere self) -> double\n"
+ "double FormFactorGaussSphere::getMeanRadius() const\n"
+ "\n"
+ ""},
{ "FormFactorGaussSphere_radialExtension", _wrap_FormFactorGaussSphere_radialExtension, METH_O, "\n"
"FormFactorGaussSphere_radialExtension(FormFactorGaussSphere self) -> double\n"
- "virtual double IFormFactor::radialExtension() const =0\n"
+ "double FormFactorGaussSphere::radialExtension() const override final\n"
"\n"
"Returns the (approximate in some cases) radial size of the particle of this form factor's shape. This is used for SSCA calculations \n"
"\n"
""},
{ "FormFactorGaussSphere_evaluate_for_q", _wrap_FormFactorGaussSphere_evaluate_for_q, METH_VARARGS, "\n"
"FormFactorGaussSphere_evaluate_for_q(FormFactorGaussSphere self, cvector_t q) -> complex_t\n"
- "virtual complex_t IFormFactorBorn::evaluate_for_q(cvector_t q) const =0\n"
+ "complex_t FormFactorGaussSphere::evaluate_for_q(cvector_t q) const override final\n"
"\n"
"Returns scattering amplitude for complex scattering wavevector q=k_i-k_f. This method is public only for convenience of plotting form factors in Python. \n"
"\n"
@@ -131789,7 +131403,7 @@ static PyMethodDef SwigMethods[] = {
""},
{ "FormFactorSphereLogNormalRadius_clone", _wrap_FormFactorSphereLogNormalRadius_clone, METH_O, "\n"
"FormFactorSphereLogNormalRadius_clone(FormFactorSphereLogNormalRadius self) -> FormFactorSphereLogNormalRadius\n"
- "FormFactorSphereLogNormalRadius* FormFactorSphereLogNormalRadius::clone() const override final\n"
+ "FormFactorSphereLogNormalRadius * FormFactorSphereLogNormalRadius::clone() const override final\n"
"\n"
"Returns a clone of this ISample object. \n"
"\n"
@@ -131978,7 +131592,24 @@ static PyMethodDef SwigMethods[] = {
"Returns a vector of children (const). \n"
"\n"
""},
- { "Simulation_convertData", _wrap_Simulation_convertData, METH_VARARGS, "Simulation_convertData(Simulation self, IntensityData data, bool put_masked_areas_to_zero=True) -> SimulationResult"},
+ { "Simulation_convertData", _wrap_Simulation_convertData, METH_VARARGS, "\n"
+ "Simulation_convertData(Simulation self, IntensityData data, bool put_masked_areas_to_zero=True) -> SimulationResult\n"
+ "SimulationResult Simulation::convertData(const OutputData< double > &data, bool put_masked_areas_to_zero=true)\n"
+ "\n"
+ "Convert user data to SimulationResult object for later drawing in various axes units. User data will be cropped to the ROI defined in the simulation, amplitudes in areas corresponding to the masked areas of the detector will be set to zero.\n"
+ "\n"
+ "Parameters:\n"
+ "-----------\n"
+ "\n"
+ "simulation: \n"
+ " Simulation object with possible ROI and masks defined.\n"
+ "\n"
+ "data: \n"
+ "User data with amplitudes with the shape of data matching the detector.\n"
+ "\n"
+ "SimulationResult object. \n"
+ "\n"
+ ""},
{ "Simulation_swigregister", Simulation_swigregister, METH_O, NULL},
{ "delete_Simulation2D", _wrap_delete_Simulation2D, METH_O, "\n"
"delete_Simulation2D(Simulation2D self)\n"
@@ -132365,11 +131996,7 @@ static PyMethodDef SwigMethods[] = {
"double ConstantBackground::addBackGround(double intensity) const override final\n"
"\n"
""},
- { "delete_ConstantBackground", _wrap_delete_ConstantBackground, METH_O, "\n"
- "delete_ConstantBackground(ConstantBackground self)\n"
- "ConstantBackground::~ConstantBackground()\n"
- "\n"
- ""},
+ { "delete_ConstantBackground", _wrap_delete_ConstantBackground, METH_O, "delete_ConstantBackground(ConstantBackground self)"},
{ "ConstantBackground_swigregister", ConstantBackground_swigregister, METH_O, NULL},
{ "ConstantBackground_swiginit", ConstantBackground_swiginit, METH_VARARGS, NULL},
{ "new_PoissonNoiseBackground", _wrap_new_PoissonNoiseBackground, METH_NOARGS, "\n"
@@ -132394,11 +132021,7 @@ static PyMethodDef SwigMethods[] = {
"double PoissonNoiseBackground::addBackGround(double intensity) const override final\n"
"\n"
""},
- { "delete_PoissonNoiseBackground", _wrap_delete_PoissonNoiseBackground, METH_O, "\n"
- "delete_PoissonNoiseBackground(PoissonNoiseBackground self)\n"
- "PoissonNoiseBackground::~PoissonNoiseBackground()\n"
- "\n"
- ""},
+ { "delete_PoissonNoiseBackground", _wrap_delete_PoissonNoiseBackground, METH_O, "delete_PoissonNoiseBackground(PoissonNoiseBackground self)"},
{ "PoissonNoiseBackground_swigregister", PoissonNoiseBackground_swigregister, METH_O, NULL},
{ "PoissonNoiseBackground_swiginit", PoissonNoiseBackground_swiginit, METH_VARARGS, NULL},
{ "MaterialProfile_cpp", _wrap_MaterialProfile_cpp, METH_VARARGS, "\n"
@@ -134412,7 +134035,7 @@ static PyMethodDef SwigMethods[] = {
{ "Lattice_swiginit", Lattice_swiginit, METH_VARARGS, NULL},
{ "Lattice2D_clone", _wrap_Lattice2D_clone, METH_O, "\n"
"Lattice2D_clone(Lattice2D self) -> Lattice2D\n"
- "Lattice2D* Lattice2D::clone() const =0\n"
+ "virtual Lattice2D* Lattice2D::clone() const =0\n"
"\n"
""},
{ "Lattice2D_length1", _wrap_Lattice2D_length1, METH_O, "\n"
@@ -134454,7 +134077,7 @@ static PyMethodDef SwigMethods[] = {
{ "Lattice2D_swigregister", Lattice2D_swigregister, METH_O, NULL},
{ "new_BasicLattice", _wrap_new_BasicLattice, METH_VARARGS, "\n"
"new_BasicLattice(double length1, double length2, double angle, double xi) -> BasicLattice\n"
- "BasicLattice::BasicLattice(double length1, double length2, double angle, double rotation_angle=0.0)\n"
+ "BasicLattice::BasicLattice(double length1, double length2, double angle, double xi)\n"
"\n"
""},
{ "BasicLattice_clone", _wrap_BasicLattice_clone, METH_O, "\n"
@@ -134494,7 +134117,7 @@ static PyMethodDef SwigMethods[] = {
{ "BasicLattice_swiginit", BasicLattice_swiginit, METH_VARARGS, NULL},
{ "new_SquareLattice", _wrap_new_SquareLattice, METH_VARARGS, "\n"
"SquareLattice(double length, double xi=0.0)\n"
- "SquareLattice::SquareLattice(double length, double rotation_angle=0.0)\n"
+ "SquareLattice::SquareLattice(double length, double xi=0.0)\n"
"\n"
""},
{ "SquareLattice_clone", _wrap_SquareLattice_clone, METH_O, "\n"
@@ -134534,7 +134157,7 @@ static PyMethodDef SwigMethods[] = {
{ "SquareLattice_swiginit", SquareLattice_swiginit, METH_VARARGS, NULL},
{ "new_HexagonalLattice", _wrap_new_HexagonalLattice, METH_VARARGS, "\n"
"new_HexagonalLattice(double length, double xi) -> HexagonalLattice\n"
- "HexagonalLattice::HexagonalLattice(double length, double rotation_angle=0.0)\n"
+ "HexagonalLattice::HexagonalLattice(double length, double xi)\n"
"\n"
""},
{ "HexagonalLattice_clone", _wrap_HexagonalLattice_clone, METH_O, "\n"
@@ -134670,7 +134293,11 @@ static PyMethodDef SwigMethods[] = {
"Returns ( $ \\\\pi/\\\\lambda^2 $ - sld), sld (in $nm^{-2}$) being the scattering length density \n"
"\n"
""},
- { "Material_rotatedMaterial", _wrap_Material_rotatedMaterial, METH_VARARGS, "Material_rotatedMaterial(Material self, Transform3D const & transform) -> Material"},
+ { "Material_rotatedMaterial", _wrap_Material_rotatedMaterial, METH_VARARGS, "\n"
+ "Material_rotatedMaterial(Material self, Transform3D const & transform) -> Material\n"
+ "Material Material::rotatedMaterial(const Transform3D &transform) const\n"
+ "\n"
+ ""},
{ "delete_Material", _wrap_delete_Material, METH_O, "delete_Material(Material self)"},
{ "Material_swigregister", Material_swigregister, METH_O, NULL},
{ "Material_swiginit", Material_swiginit, METH_VARARGS, NULL},
--
GitLab