diff --git a/Core/Algorithms/GISASSimulation.cpp b/Core/Algorithms/GISASSimulation.cpp
index 5020049b733a02f8d2c66b05b9540128ff6066ac..90f16c3ffe3cffbd9c9ed2fb27c330af11443dfb 100644
--- a/Core/Algorithms/GISASSimulation.cpp
+++ b/Core/Algorithms/GISASSimulation.cpp
@@ -119,9 +119,9 @@ void GISASSimulation::setDetectorParameters(const OutputData<double >& output_da
m_intensity_map.setAllTo(0.);
}
-void GISASSimulation::setDetectorParameters(const IHistogram& hisotgram)
+void GISASSimulation::setDetectorParameters(const IHistogram& histogram)
{
- const std::unique_ptr<OutputData<double> > data(hisotgram.createOutputData());
+ const std::unique_ptr<OutputData<double> > data(histogram.createOutputData());
setDetectorParameters(*data);
}
diff --git a/Core/Algorithms/SpecularSimulation.cpp b/Core/Algorithms/SpecularSimulation.cpp
index 27e5db5386d43bd7218fd7d2f28a2d53fea9d7f7..a1e7a8f51ff2dec32a0a658d67c9241681fb95f7 100644
--- a/Core/Algorithms/SpecularSimulation.cpp
+++ b/Core/Algorithms/SpecularSimulation.cpp
@@ -98,15 +98,12 @@ void SpecularSimulation::prepareSimulation()
{
updateSample();
- if (!m_alpha_i_axis || m_alpha_i_axis->getSize() < 1) {
+ if (!m_alpha_i_axis || m_alpha_i_axis->getSize() < 1)
throw ClassInitializationException("SpecularSimulation::checkSimulation() "
"-> Error. Incoming alpha range not configured.");
- }
- if (m_lambda <= 0.0) {
+ if (m_lambda <= 0.0)
throw ClassInitializationException("SpecularSimulation::checkSimulation() "
"-> Error. Incoming wavelength <= 0.");
- }
-
if (!m_sample)
throw ClassInitializationException(
"SpecularSimulation::checkSimulation() -> Error. No sample set");
@@ -114,16 +111,6 @@ void SpecularSimulation::prepareSimulation()
updateCoefficientDataAxes();
}
-// OutputData<double> *SpecularSimulation::getEvanescentWaveIntensity() const
-//{
-// if(m_ewave_intensity.getAllocatedSize() == 1)
-// throw ClassInitializationException("SpecularSimulation::getEvanescentWaveIntensity() ->
-// Error. No evanescent wave calculations have been performed. Set corresponding axis with
-// Simulation::setEvanescentWaveAxis.");
-
-// return m_ewave_intensity.clone();
-//}
-
void SpecularSimulation::runSimulation()
{
prepareSimulation();
@@ -265,50 +252,6 @@ void SpecularSimulation::collectRTCoefficientsMatrix(const MultiLayer * /*multil
"SpecularSimulation::collectRTCoefficientsMatrix() -> Error. Not implemented.");
}
-// void SpecularSimulation::calculateEvanescentWaveIntensity()
-//{
-// if(!m_z_axis) return;
-
-// MultiLayer *multilayer = dynamic_cast<MultiLayer *>(m_sample);
-// const IAxis *alpha_axis = m_ewave_intensity.getAxis(0);
-// const IAxis *z_axis = m_ewave_intensity.getAxis(1);
-
-// OutputData<double>::iterator it = m_ewave_intensity.begin();
-// while (it != m_ewave_intensity.end()) {
-// std::vector<int> indices =
-// m_ewave_intensity.toCoordinates(it.getIndex());
-
-// size_t alpha_index = indices[0];
-// size_t z_index = indices[1];
-
-//// double alpha_axis_value = (*alpha_axis)[alpha_index];
-// double z_axis_value = (*z_axis)[z_index];
-
-// int i_layer = multilayer->zToLayerIndex(z_axis_value);
-
-// double depth = multilayer->getLayerThickness(i_layer) -
-// (z_axis_value-multilayer->getLayerBottomZ(i_layer));
-
-//// std::cout << "alpha_axis_value:" << alpha_axis_value << " z_axis_value:" << z_axis_value
-///<< " i_layer:" << i_layer << " depth:" << depth<< std::endl;
-
-// LayerRTCoefficients_t rtcoeff = getLayerRTCoefficients(alpha_index, i_layer);
-
-//// complex_t cvalue = rtcoeff->getScalarT()*std::exp(rtcoeff->getScalarKz()*depth) +
-///rtcoeff->getScalarR()*std::exp(rtcoeff->getScalarKz()*depth);
-//// complex_t cvalue =
-///rtcoeff->getScalarT()*std::exp(std::imag(rtcoeff->getScalarKz())*depth) +
-///rtcoeff->getScalarR()*std::exp(std::imag(rtcoeff->getScalarKz())*depth);
-//// *it = std::abs(cvalue);
-// double value = 1.0 +
-// std::abs(rtcoeff->getScalarT())*
-// std::exp(std::imag(rtcoeff->getScalarKz())*depth*Units::angstrom);
-// *it = value;
-// ++it;
-// }
-
-//}
-
void SpecularSimulation::checkCoefficients(size_t i_layer) const
{
if (m_data.getAllocatedSize() == 1 || m_data[0].size() == 0)
diff --git a/Core/FormFactors/FormFactorCone6.cpp b/Core/FormFactors/FormFactorCone6.cpp
index 4e8915db93c5a2cad1806d60ccde257a4e41d66d..d963232b565631df0f4a89a89b28632ee78c8490 100644
--- a/Core/FormFactors/FormFactorCone6.cpp
+++ b/Core/FormFactors/FormFactorCone6.cpp
@@ -30,9 +30,9 @@ const FormFactorPolyhedron::Topology FormFactorCone6::topology = {
}, false };
//! Cone6 constructor
-//! @param base_edge of hexagonal base (different from R in IsGisaxs)
+//! @param base_edge of hexagonal base
//! @param height of Cone6
-//! @param angle in radians between base and facet
+//! @param alpha dihedral angle in radians between base and facet
FormFactorCone6::FormFactorCone6(double base_edge, double height, double alpha)
: FormFactorPolyhedron()
, m_base_edge(base_edge)
diff --git a/Core/FormFactors/FormFactorLongRipple2Gauss.cpp b/Core/FormFactors/FormFactorLongRipple2Gauss.cpp
index 2348b0ccaf6bd716c786855231366299df08e25f..b4b9e176465d9aa31174e7464f66295aca0bccc2 100644
--- a/Core/FormFactors/FormFactorLongRipple2Gauss.cpp
+++ b/Core/FormFactors/FormFactorLongRipple2Gauss.cpp
@@ -23,11 +23,11 @@
using namespace BornAgain;
FormFactorLongRipple2Gauss::FormFactorLongRipple2Gauss(
- double length, double width, double height, double asymetry)
+ double length, double width, double height, double asymmetry)
: m_width(width)
, m_height(height)
, m_length(length)
- , m_d(asymetry)
+ , m_d(asymmetry)
{
setName(FFLongRipple2GaussType);
check_initialization();
diff --git a/Core/FormFactors/FormFactorLongRipple2Gauss.h b/Core/FormFactors/FormFactorLongRipple2Gauss.h
index fb95e95dd252308690d7da4c5829fea4f7ba2955..fb67bc735c11a35bf2a4426e8ba6b2f2cff9de48 100644
--- a/Core/FormFactors/FormFactorLongRipple2Gauss.h
+++ b/Core/FormFactors/FormFactorLongRipple2Gauss.h
@@ -30,7 +30,7 @@ public:
//! @param width of triangular cross section
//! @param height of triangular cross section
//! @param asymmetry length of triangular cross section
- FormFactorLongRipple2Gauss(double length, double width, double height, double asymetry);
+ FormFactorLongRipple2Gauss(double length, double width, double height, double asymmetry);
virtual ~FormFactorLongRipple2Gauss() { }
diff --git a/Core/FormFactors/FormFactorLongRipple2Lorentz.h b/Core/FormFactors/FormFactorLongRipple2Lorentz.h
index 6ceb92cd4a4a5bcdfba2f43d1bb22c595c095a6f..bc04d74da6ed6515e27436931c963590e95b1361 100644
--- a/Core/FormFactors/FormFactorLongRipple2Lorentz.h
+++ b/Core/FormFactors/FormFactorLongRipple2Lorentz.h
@@ -30,7 +30,7 @@ public:
//! @param width of triangular cross section
//! @param height of triangular cross section
//! @param asymmetry length of triangular cross section
- FormFactorLongRipple2Lorentz(double length, double width, double height, double asymetry);
+ FormFactorLongRipple2Lorentz(double length, double width, double height, double asymmetry);
virtual ~FormFactorLongRipple2Lorentz() { }
diff --git a/Core/FormFactors/FormFactorPolyhedron.h b/Core/FormFactors/FormFactorPolyhedron.h
index ef52beb2a8b6ea659a8189cecf4e6bd7b5b8b71f..7ce67ef9da4425379ace83724e916070f03d5934 100644
--- a/Core/FormFactors/FormFactorPolyhedron.h
+++ b/Core/FormFactors/FormFactorPolyhedron.h
@@ -2,7 +2,7 @@
//
// BornAgain: simulate and fit scattering at grazing incidence
//
-//! @file FormFactors/src/FormFactorPolyhedron.h
+//! @file FormFactors/FormFactorPolyhedron.h
//! @brief Declares class FormFactorPolyhedron, FormFactorPrism, and auxiliary classes.
//!
//! @homepage http://www.bornagainproject.org
diff --git a/Core/FormFactors/FormFactorRipple2.h b/Core/FormFactors/FormFactorRipple2.h
index 31a59e8f6fd8eb493df770c88ce32e2e20aeb591..46dd331fead1418ea1b4e6ce8251bffeeb69a7fe 100644
--- a/Core/FormFactors/FormFactorRipple2.h
+++ b/Core/FormFactors/FormFactorRipple2.h
@@ -30,7 +30,7 @@ public:
//! @param width of triangular cross section
//! @param height of triangular cross section
//! @param asymmetry length of triangular cross section
- FormFactorRipple2(double length, double width, double height, double asymetry);
+ FormFactorRipple2(double length, double width, double height, double asymmetry);
virtual ~FormFactorRipple2() { }
diff --git a/Core/FormFactors/FormFactorTetrahedron.cpp b/Core/FormFactors/FormFactorTetrahedron.cpp
index 37d8be26fb3bb730240054b0c8a1045293ed80be..672ce42c63452207a419e700bb899d4c1bd5b39e 100644
--- a/Core/FormFactors/FormFactorTetrahedron.cpp
+++ b/Core/FormFactors/FormFactorTetrahedron.cpp
@@ -31,7 +31,7 @@ const FormFactorPolyhedron::Topology FormFactorTetrahedron::topology = {
//! @brief Tetrahedron constructor
//! @param base_edge of a side of Tetrahedron's base
//! @param height of Tetrahedron
-//! @param angle in radians between base and facet
+//! @param alpha dihedral angle in radians between base and facet
FormFactorTetrahedron::FormFactorTetrahedron(double base_edge, double height, double alpha)
: FormFactorPolyhedron()
diff --git a/Core/Samples/InterferenceFunctionRadialParaCrystal.h b/Core/Samples/InterferenceFunctionRadialParaCrystal.h
index 848f5c3e32cfd193f94918107fa809533111affa..95ecb6813527b0866a8994ec291344ef2fbabc85 100644
--- a/Core/Samples/InterferenceFunctionRadialParaCrystal.h
+++ b/Core/Samples/InterferenceFunctionRadialParaCrystal.h
@@ -13,8 +13,8 @@
//
// ************************************************************************** //
-#ifndef INTERFERENCEFUNCTIONRADIALPARACRYSTAL_H_
-#define INTERFERENCEFUNCTIONRADIALPARACRYSTAL_H_
+#ifndef INTERFERENCEFUNCTIONRADIALPARACRYSTAL_H
+#define INTERFERENCEFUNCTIONRADIALPARACRYSTAL_H
#include "IInterferenceFunction.h"
#include "FTDistributions.h"
@@ -29,18 +29,11 @@
class BA_CORE_API_ InterferenceFunctionRadialParaCrystal : public IInterferenceFunction
{
public:
-
- //! @brief constructor of radial paracrystal interference function
- //! @param peak_distance The distance to the first neighbor peak.
- //! @param width Width parameter in the pair correlation function.
- //! @param m_corr_length Correlation length of paracrystal.
- InterferenceFunctionRadialParaCrystal(
- double peak_distance, double damping_length=0.0);
-
+ InterferenceFunctionRadialParaCrystal(double peak_distance, double damping_length=0.0);
virtual ~InterferenceFunctionRadialParaCrystal() {}
- virtual InterferenceFunctionRadialParaCrystal *clone() const;
+ virtual InterferenceFunctionRadialParaCrystal* clone() const;
- virtual void accept(ISampleVisitor *visitor) const;
+ virtual void accept(ISampleVisitor* visitor) const;
//! @brief Sets size of coherence domain
//! @param size: size in lattice direction
@@ -62,13 +55,11 @@ public:
//TODO: replace these with strategy pattern for different algorithms
complex_t FTPDF(double qpar) const;
- //! Sets the Fourier transformed probability distribution of the
- //! nearest particle
+ //! Sets the Fourier transformed probability distribution of the nearest particle
void setProbabilityDistribution(const IFTDistribution1D& pdf);
- //! Gets the Fourier transformed probability distribution of the
- //! nearest particle
- const IFTDistribution1D *getProbabilityDistribution() const;
+ //! Gets the Fourier transformed probability distribution of the nearest particle
+ const IFTDistribution1D* getProbabilityDistribution() const;
double getPeakDistance() const;
@@ -87,4 +78,4 @@ private:
virtual void init_parameters();
};
-#endif /* INTERFERENCEFUNCTIONRADIALPARACRYSTAL_H_ */
+#endif // INTERFERENCEFUNCTIONRADIALPARACRYSTAL_H
diff --git a/Core/StandardSamples/ParaCrystalBuilder.h b/Core/StandardSamples/ParaCrystalBuilder.h
index 940d02addcb7d4c7f6780bd73eb9c7cdc417b075..8bae31723b9bfeb560f8c2ef9d5894131fbdf572 100644
--- a/Core/StandardSamples/ParaCrystalBuilder.h
+++ b/Core/StandardSamples/ParaCrystalBuilder.h
@@ -90,10 +90,10 @@ public:
virtual ISample* buildSample() const;
};
-
-//! @class IsGISAXS08BBuilder TODO remove it completely
+//! @class IsGISAXS08BBuilder
//! @ingroup standard_samples
//! @brief Builds sample: 2D paracrystal lattice with isotropic pdfs (IsGISAXS example #8)
+// TODO remove it completely (why? why not yet done?)
class BA_CORE_API_ IsGISAXS08BBuilder : public ISampleBuilder
{
@@ -102,7 +102,4 @@ public:
virtual ISample* buildSample() const;
};
-
-
-
#endif // PARACRYSTALBUILDER_H
diff --git a/Core/Tools/IHistogram.cpp b/Core/Tools/IHistogram.cpp
index e762f91468ea905e0fbe5f5c7b7bd16290e40ad6..2ba71a930851a3568a33972cbdf7c896ec8361fa 100644
--- a/Core/Tools/IHistogram.cpp
+++ b/Core/Tools/IHistogram.cpp
@@ -25,7 +25,6 @@
IHistogram::IHistogram()
{
-
}
IHistogram::IHistogram(const IHistogram &other)
@@ -55,13 +54,13 @@ size_t IHistogram::getTotalNumberOfBins() const
return m_data.getAllocatedSize();
}
-const IAxis *IHistogram::getXaxis() const
+const IAxis* IHistogram::getXaxis() const
{
check_x_axis();
return m_data.getAxis(0);
}
-const IAxis *IHistogram::getYaxis() const
+const IAxis* IHistogram::getYaxis() const
{
check_y_axis();
return m_data.getAxis(1);
@@ -208,9 +207,7 @@ double IHistogram::getMinimum() const
size_t IHistogram::getMinimumBinIndex() const
{
- OutputData<CumulativeValue>::const_iterator it =
- std::min_element(m_data.begin(), m_data.end());
- return std::distance(m_data.begin(), it);
+ return std::distance(m_data.begin(), std::min_element(m_data.begin(), m_data.end()) );
}
void IHistogram::scale(double value)
@@ -229,18 +226,20 @@ double IHistogram::integral() const
return result;
}
-PyObject *IHistogram::getArray(DataType dataType) const
+#ifdef BORNAGAIN_PYTHON
+PyObject* IHistogram::getArray(DataType dataType) const
{
const std::unique_ptr<OutputData<double> > data(createOutputData(dataType));
return data->getArray();
}
+#endif // BORNAGAIN_PYTHON
void IHistogram::reset()
{
m_data.setAllTo(CumulativeValue());
}
-IHistogram *IHistogram::createHistogram(const OutputData<double> &source)
+IHistogram* IHistogram::createHistogram(const OutputData<double> &source)
{
if(source.getRank() == 1) {
return new Histogram1D(source);
@@ -255,7 +254,7 @@ IHistogram *IHistogram::createHistogram(const OutputData<double> &source)
}
}
-IHistogram *IHistogram::createFrom(const std::string &filename)
+IHistogram* IHistogram::createFrom(const std::string &filename)
{
return IntensityDataIOFactory::readIntensityData(filename);
}
@@ -340,9 +339,9 @@ void IHistogram::copyContentFrom(const IHistogram &other)
}
//! creates new OutputData with histogram's shape and put there values corresponding to DataType
-OutputData<double> *IHistogram::createOutputData(IHistogram::DataType dataType) const
+OutputData<double>* IHistogram::createOutputData(IHistogram::DataType dataType) const
{
- OutputData<double> *result = new OutputData<double>;
+ OutputData<double>* result = new OutputData<double>;
result->copyShapeFrom(m_data);
for(size_t i=0; i<getTotalNumberOfBins(); ++i) {
(*result)[i] = getBinData(i, dataType);
@@ -373,14 +372,14 @@ const IHistogram &IHistogram::operator+=(const IHistogram &right)
return *this;
}
-IHistogram *IHistogram::relativeDifferenceHistogram(const IHistogram &rhs)
+IHistogram* IHistogram::relativeDifferenceHistogram(const IHistogram &rhs)
{
if(!hasSameDimensions(rhs)) {
throw LogicErrorException("IHistogram::relativeDifferenceHistogram() -> Error. "
"Histograms have different dimensions");
}
- IHistogram *result = this->clone();
+ IHistogram* result = this->clone();
result->reset();
for(size_t i=0; i<getTotalNumberOfBins(); ++i) {
diff --git a/Core/Tools/IntegratorComplex.h b/Core/Tools/IntegratorComplex.h
index c5754154a3f9cfdc60c3727b1b901ecf8b6ed28a..1a28440237a22d709b917482891ceba2ddf24921 100644
--- a/Core/Tools/IntegratorComplex.h
+++ b/Core/Tools/IntegratorComplex.h
@@ -56,7 +56,7 @@ private:
template <class T>
using P_integrator_complex = std::unique_ptr<IntegratorComplex<T>>;
-//! @fn make_integrator_comples
+//! @fn make_integrator_complex
//! @ingroup tools_internal
//! @brief Template function to create an integrator object
template <class T>
diff --git a/Wrap/swig/DoxyfileSwig.in b/Wrap/swig/DoxyfileSwig.in
index ec52afa6d033f69579f078491fbf999eb86eedbc..dcdf84ed1c4d9ab7bbf89f45b09af60360e0c1d5 100644
--- a/Wrap/swig/DoxyfileSwig.in
+++ b/Wrap/swig/DoxyfileSwig.in
@@ -1188,5 +1188,7 @@ PERL_PATH = /usr/bin/perl
# Configuration options related to the dot tool
#---------------------------------------------------------------------------
+DOT_GRAPH_MAX_NODES = 400
+
# If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram
# (in HTML and LaTeX) for classes with base or super classes.
diff --git a/auto/Wrap/doxygen_core.i b/auto/Wrap/doxygen_core.i
index e69931253642700c3225e99ae910a7203a4ca75c..a9f8decff31b466c1e3790a33266385c9451f820 100644
--- a/auto/Wrap/doxygen_core.i
+++ b/auto/Wrap/doxygen_core.i
@@ -1731,8 +1731,8 @@ of other side of Pyramid's rectangular base
height:
of Pyramid
-dihedralangle:
-in radians between base and facet
+alpha:
+dihedral angle in radians between base and facet
";
%feature("docstring") FormFactorAnisoPyramid::clone "FormFactorAnisoPyramid * FormFactorAnisoPyramid::clone() const final
@@ -1904,13 +1904,13 @@ Parameters:
-----------
base_edge:
-of hexagonal base (different from R in IsGisaxs)
+of hexagonal base
height:
of Cone6
-angle:
-in radians between base and facet
+alpha:
+dihedral angle in radians between base and facet
";
%feature("docstring") FormFactorCone6::clone "FormFactorCone6 * FormFactorCone6::clone() const
@@ -1969,30 +1969,12 @@ Returns the (approximate in some cases) radial size of the particle of this form
%feature("docstring") FormFactorCrystal::evaluate "complex_t FormFactorCrystal::evaluate(const WavevectorInfo &wavevectors) const
-Returns scattering amplitude for complex wavevector bin
-
-Parameters:
------------
-
-k_i:
-incoming wavevector
-
-k_f_bin:
-outgoing wavevector bin
+Returns scattering amplitude for complex wavevector bin.
";
%feature("docstring") FormFactorCrystal::evaluatePol "Eigen::Matrix2cd FormFactorCrystal::evaluatePol(const WavevectorInfo &wavevectors) const
-Returns scattering amplitude for matrix interactions
-
-Parameters:
------------
-
-k_i:
-incoming wavevector
-
-k_f_bin:
-outgoing wavevector bin
+Returns scattering amplitude for matrix interactions.
";
%feature("docstring") FormFactorCrystal::evaluate_for_q "complex_t FormFactorCrystal::evaluate_for_q(const cvector_t q) const
@@ -2146,16 +2128,7 @@ Calls the ISampleVisitor's visit method.
%feature("docstring") FormFactorDecoratorDebyeWaller::evaluate "complex_t FormFactorDecoratorDebyeWaller::evaluate(const WavevectorInfo &wavevectors) const
-Returns scattering amplitude for complex wavevector bin
-
-Parameters:
------------
-
-k_i:
-incoming wavevector
-
-k_f_bin:
-outgoing wavevector bin
+Returns scattering amplitude for complex wavevector bin.
";
@@ -2264,30 +2237,12 @@ Returns the (approximate in some cases) radial size of the particle of this form
%feature("docstring") FormFactorDecoratorMultiPositionFactor::evaluate "complex_t FormFactorDecoratorMultiPositionFactor::evaluate(const WavevectorInfo &wavevectors) const
-Returns scattering amplitude for complex wavevector bin
-
-Parameters:
------------
-
-k_i:
-incoming wavevector
-
-k_f_bin:
-outgoing wavevector bin
+Returns scattering amplitude for complex wavevector bin.
";
%feature("docstring") FormFactorDecoratorMultiPositionFactor::evaluatePol "Eigen::Matrix2cd FormFactorDecoratorMultiPositionFactor::evaluatePol(const WavevectorInfo &wavevectors) const
-Returns scattering amplitude for matrix interactions
-
-Parameters:
------------
-
-k_i:
-incoming wavevector
-
-k_f_bin:
-outgoing wavevector bin
+Returns scattering amplitude for matrix interactions.
";
@@ -2317,30 +2272,12 @@ Calls the ISampleVisitor's visit method.
%feature("docstring") FormFactorDecoratorPositionFactor::evaluate "complex_t FormFactorDecoratorPositionFactor::evaluate(const WavevectorInfo &wavevectors) const
-Returns scattering amplitude for complex wavevector bin
-
-Parameters:
------------
-
-k_i:
-incoming wavevector
-
-k_f_bin:
-outgoing wavevector bin
+Returns scattering amplitude for complex wavevector bin.
";
%feature("docstring") FormFactorDecoratorPositionFactor::evaluatePol "Eigen::Matrix2cd FormFactorDecoratorPositionFactor::evaluatePol(const WavevectorInfo &wavevectors) const
-Returns scattering amplitude for matrix interactions
-
-Parameters:
------------
-
-k_i:
-incoming wavevector
-
-k_f_bin:
-outgoing wavevector bin
+Returns scattering amplitude for matrix interactions.
";
@@ -2369,16 +2306,7 @@ Calls the ISampleVisitor's visit method.
%feature("docstring") FormFactorDecoratorRotation::evaluate "complex_t FormFactorDecoratorRotation::evaluate(const WavevectorInfo &wavevectors) const
-Returns scattering amplitude for complex wavevector bin
-
-Parameters:
------------
-
-k_i:
-incoming wavevector
-
-k_f_bin:
-outgoing wavevector bin
+Returns scattering amplitude for complex wavevector bin.
";
@@ -2446,16 +2374,7 @@ Sets reflection/transmission info for scalar DWBA simulation.
%feature("docstring") FormFactorDWBA::evaluate "complex_t FormFactorDWBA::evaluate(const WavevectorInfo &wavevectors) const
-Returns scattering amplitude for complex wavevector bin
-
-Parameters:
------------
-
-k_i:
-incoming wavevector
-
-k_f_bin:
-outgoing wavevector bin
+Returns scattering amplitude for complex wavevector bin.
";
@@ -3075,7 +2994,7 @@ The formfactor for a triangular ripple.
C++ includes: FormFactorLongRipple2Gauss.h
";
-%feature("docstring") FormFactorLongRipple2Gauss::FormFactorLongRipple2Gauss "FormFactorLongRipple2Gauss::FormFactorLongRipple2Gauss(double length, double width, double height, double asymetry)
+%feature("docstring") FormFactorLongRipple2Gauss::FormFactorLongRipple2Gauss "FormFactorLongRipple2Gauss::FormFactorLongRipple2Gauss(double length, double width, double height, double asymmetry)
FormFactorLongRipple2Gauss constructor.
@@ -3139,7 +3058,7 @@ The formfactor for a triangular ripple.
C++ includes: FormFactorLongRipple2Lorentz.h
";
-%feature("docstring") FormFactorLongRipple2Lorentz::FormFactorLongRipple2Lorentz "FormFactorLongRipple2Lorentz::FormFactorLongRipple2Lorentz(double length, double width, double height, double asymetry)
+%feature("docstring") FormFactorLongRipple2Lorentz::FormFactorLongRipple2Lorentz "FormFactorLongRipple2Lorentz::FormFactorLongRipple2Lorentz(double length, double width, double height, double asymmetry)
FormFactorLongRipple2Lorentz constructor.
@@ -3534,7 +3453,7 @@ The formfactor for a triangular ripple.
C++ includes: FormFactorRipple2.h
";
-%feature("docstring") FormFactorRipple2::FormFactorRipple2 "FormFactorRipple2::FormFactorRipple2(double length, double width, double height, double asymetry)
+%feature("docstring") FormFactorRipple2::FormFactorRipple2 "FormFactorRipple2::FormFactorRipple2(double length, double width, double height, double asymmetry)
Ripple2 constructor.
@@ -3734,8 +3653,8 @@ of a side of Tetrahedron's base
height:
of Tetrahedron
-angle:
-in radians between base and facet
+alpha:
+dihedral angle in radians between base and facet
";
%feature("docstring") FormFactorTetrahedron::clone "FormFactorTetrahedron * FormFactorTetrahedron::clone() const
@@ -3761,23 +3680,12 @@ Calls the ISampleVisitor's visit method.
// File: classFormFactorTriangle.xml
%feature("docstring") FormFactorTriangle "
-The formfactor of an equilateral triangle, for testing purposes.
+The formfactor of a planar equilateral triangle, for testing purposes.
C++ includes: FormFactorTriangle.h
";
%feature("docstring") FormFactorTriangle::FormFactorTriangle "FormFactorTriangle::FormFactorTriangle(const double base_edge)
-
-Triangle constructor.
-
-Parameters:
------------
-
-base_edge:
-of hexagonal base
-
-height:
-of Triangle
";
%feature("docstring") FormFactorTriangle::clone "FormFactorTriangle * FormFactorTriangle::clone() const
@@ -3795,20 +3703,14 @@ Calls the ISampleVisitor's visit method.
// File: classFormFactorTrivial.xml
-%feature("docstring") FormFactorTrivial "";
-
-%feature("docstring") FormFactorTrivial::FormFactorTrivial "FormFactorTrivial::FormFactorTrivial()
+%feature("docstring") FormFactorTrivial "
-Cylinder constructor.
-
-Parameters:
------------
+A uniform formfactor F(q)=1, for development purposes.
-radius:
-of Cylinder's base
+C++ includes: FormFactorTrivial.h
+";
-height:
-of Cylinder
+%feature("docstring") FormFactorTrivial::FormFactorTrivial "FormFactorTrivial::FormFactorTrivial()
";
%feature("docstring") FormFactorTrivial::clone "FormFactorTrivial * FormFactorTrivial::clone() const
@@ -3851,11 +3753,11 @@ C++ includes: FormFactorTruncatedCube.h
Parameters:
-----------
-side:
-length of the full cube
+length:
+of the full cube
-side:
-length of the trirectangular tetrahedron removed from each vertex of the cube
+removed_length:
+as removed from each edge of the cube
";
%feature("docstring") FormFactorTruncatedCube::clone "FormFactorTruncatedCube * FormFactorTruncatedCube::clone() const final
@@ -3928,20 +3830,6 @@ C++ includes: FormFactorTruncatedSpheroid.h
";
%feature("docstring") FormFactorTruncatedSpheroid::FormFactorTruncatedSpheroid "FormFactorTruncatedSpheroid::FormFactorTruncatedSpheroid(double radius, double height, double height_flattening)
-
-TruncatedSpheroid constructor.
-
-Parameters:
------------
-
-radius:
-of Truncated Spheroid
-
-height:
-of Truncated Spheroid
-
-flattening:
-parameter in vertical direction (full height: 2 x flattening x radius)
";
%feature("docstring") FormFactorTruncatedSpheroid::~FormFactorTruncatedSpheroid "FormFactorTruncatedSpheroid::~FormFactorTruncatedSpheroid()
@@ -4019,16 +3907,7 @@ Passes the refractive index of the ambient material in which this particle is em
%feature("docstring") FormFactorWeighted::evaluate "complex_t FormFactorWeighted::evaluate(const WavevectorInfo &wavevectors) const
-Returns scattering amplitude for complex wavevector bin
-
-Parameters:
------------
-
-k_i:
-incoming wavevector
-
-k_f_bin:
-outgoing wavevector bin
+Returns scattering amplitude for complex wavevector bin.
";
%feature("docstring") FormFactorWeighted::evaluatePol "Eigen::Matrix2cd FormFactorWeighted::evaluatePol(const WavevectorInfo &wavevectors) const
@@ -5447,7 +5326,10 @@ Parameters:
-----------
shape:
-The shape of mask (Rectangle, Polygon, Line, Ellipse) The value of mask
+The shape of mask (Rectangle, Polygon, Line, Ellipse)
+
+mask_value:
+The value of mask
";
%feature("docstring") IDetector2D::maskAll "void IDetector2D::maskAll()
@@ -5681,30 +5563,12 @@ Passes the refractive index of the ambient material in which this particle is em
%feature("docstring") IFormFactor::evaluate "virtual complex_t IFormFactor::evaluate(const WavevectorInfo &wavevectors) const =0
-Returns scattering amplitude for complex wavevector bin
-
-Parameters:
------------
-
-k_i:
-incoming wavevector
-
-k_f_bin:
-outgoing wavevector bin
+Returns scattering amplitude for complex wavevector bin.
";
%feature("docstring") IFormFactor::evaluatePol "Eigen::Matrix2cd IFormFactor::evaluatePol(const WavevectorInfo &wavevectors) const
-Returns scattering amplitude for matrix interactions
-
-Parameters:
------------
-
-k_i:
-incoming wavevector
-
-k_f_bin:
-outgoing wavevector bin
+Returns scattering amplitude for matrix interactions.
";
%feature("docstring") IFormFactor::getVolume "double IFormFactor::getVolume() const
@@ -5749,30 +5613,12 @@ Calls the ISampleVisitor's visit method.
%feature("docstring") IFormFactorBorn::evaluate "complex_t IFormFactorBorn::evaluate(const WavevectorInfo &wavevectors) const
-Returns scattering amplitude for complex wavevector bin
-
-Parameters:
------------
-
-k_i:
-incoming wavevector
-
-k_f_bin:
-outgoing wavevector bin
+Returns scattering amplitude for complex wavevector bin.
";
%feature("docstring") IFormFactorBorn::evaluatePol "Eigen::Matrix2cd IFormFactorBorn::evaluatePol(const WavevectorInfo &wavevectors) const
-Returns scattering amplitude for matrix interactions
-
-Parameters:
------------
-
-k_i:
-incoming wavevector
-
-k_f_bin:
-outgoing wavevector bin
+Returns scattering amplitude for matrix interactions.
";
%feature("docstring") IFormFactorBorn::evaluate_for_q "virtual complex_t IFormFactorBorn::evaluate_for_q(const cvector_t q) const =0
@@ -7198,20 +7044,6 @@ C++ includes: InterferenceFunctionRadialParaCrystal.h
";
%feature("docstring") InterferenceFunctionRadialParaCrystal::InterferenceFunctionRadialParaCrystal "InterferenceFunctionRadialParaCrystal::InterferenceFunctionRadialParaCrystal(double peak_distance, double damping_length=0.0)
-
-constructor of radial paracrystal interference function
-
-Parameters:
------------
-
-peak_distance:
-The distance to the first neighbor peak.
-
-width:
-Width parameter in the pair correlation function.
-
-m_corr_length:
-Correlation length of paracrystal.
";
%feature("docstring") InterferenceFunctionRadialParaCrystal::~InterferenceFunctionRadialParaCrystal "virtual InterferenceFunctionRadialParaCrystal::~InterferenceFunctionRadialParaCrystal()
@@ -7273,12 +7105,12 @@ Evaluates the interference function for a given wavevector transfer (only the re
%feature("docstring") InterferenceFunctionRadialParaCrystal::setProbabilityDistribution "void InterferenceFunctionRadialParaCrystal::setProbabilityDistribution(const IFTDistribution1D &pdf)
-Sets the Fourier transformed probability distribution of the nearest particle
+Sets the Fourier transformed probability distribution of the nearest particle.
";
%feature("docstring") InterferenceFunctionRadialParaCrystal::getProbabilityDistribution "const IFTDistribution1D * InterferenceFunctionRadialParaCrystal::getProbabilityDistribution() const
-Gets the Fourier transformed probability distribution of the nearest particle
+Gets the Fourier transformed probability distribution of the nearest particle.
";
%feature("docstring") InterferenceFunctionRadialParaCrystal::getPeakDistance "double InterferenceFunctionRadialParaCrystal::getPeakDistance() const
@@ -7970,7 +7802,7 @@ C++ includes: ISelectionRule.h
Builds sample: 2D paracrystal lattice with isotropic pdfs (IsGISAXS example #8)
-it completely
+C++ includes: ParaCrystalBuilder.h
";
%feature("docstring") IsGISAXS08BBuilder::IsGISAXS08BBuilder "IsGISAXS08BBuilder::IsGISAXS08BBuilder()
@@ -9795,7 +9627,7 @@ multiply every item of this output data by value
%feature("docstring") OutputData::setAxisSizes "void OutputData< T >::setAxisSizes(size_t rank, int *n_dims)
-Adds <rank> axes with indicated sizes.
+Adds 'rank' axes with indicated sizes.
";
%feature("docstring") OutputData::setRawDataVector "void OutputData< T >::setRawDataVector(const std::vector< T > &data_vector)
diff --git a/auto/Wrap/libBornAgainCore.py b/auto/Wrap/libBornAgainCore.py
index 4aa7d3321961573b4622ca0cc0cd31e09ffbdff7..8ea06f119024ae7ecc6d6bb1ef77511050baf141 100644
--- a/auto/Wrap/libBornAgainCore.py
+++ b/auto/Wrap/libBornAgainCore.py
@@ -7617,16 +7617,7 @@ class IFormFactor(ISample):
virtual complex_t IFormFactor::evaluate(const WavevectorInfo &wavevectors) const =0
- Returns scattering amplitude for complex wavevector bin
-
- Parameters:
- -----------
-
- k_i:
- incoming wavevector
-
- k_f_bin:
- outgoing wavevector bin
+ Returns scattering amplitude for complex wavevector bin.
"""
return _libBornAgainCore.IFormFactor_evaluate(self, wavevectors)
@@ -7956,16 +7947,7 @@ class IFormFactorBorn(IFormFactor):
complex_t IFormFactorBorn::evaluate(const WavevectorInfo &wavevectors) const
- Returns scattering amplitude for complex wavevector bin
-
- Parameters:
- -----------
-
- k_i:
- incoming wavevector
-
- k_f_bin:
- outgoing wavevector bin
+ Returns scattering amplitude for complex wavevector bin.
"""
return _libBornAgainCore.IFormFactorBorn_evaluate(self, wavevectors)
@@ -8614,8 +8596,8 @@ class FormFactorAnisoPyramid(FormFactorPolyhedron):
height:
of Pyramid
- dihedralangle:
- in radians between base and facet
+ alpha:
+ dihedral angle in radians between base and facet
"""
this = _libBornAgainCore.new_FormFactorAnisoPyramid(length, width, height, alpha)
@@ -8989,13 +8971,13 @@ class FormFactorCone6(FormFactorPolyhedron):
-----------
base_edge:
- of hexagonal base (different from R in IsGisaxs)
+ of hexagonal base
height:
of Cone6
- angle:
- in radians between base and facet
+ alpha:
+ dihedral angle in radians between base and facet
"""
this = _libBornAgainCore.new_FormFactorCone6(base_edge, height, alpha)
@@ -9150,16 +9132,7 @@ class FormFactorCrystal(IFormFactorBorn):
complex_t FormFactorCrystal::evaluate(const WavevectorInfo &wavevectors) const
- Returns scattering amplitude for complex wavevector bin
-
- Parameters:
- -----------
-
- k_i:
- incoming wavevector
-
- k_f_bin:
- outgoing wavevector bin
+ Returns scattering amplitude for complex wavevector bin.
"""
return _libBornAgainCore.FormFactorCrystal_evaluate(self, wavevectors)
@@ -9480,16 +9453,7 @@ class FormFactorDecoratorDebyeWaller(IFormFactorDecorator):
complex_t FormFactorDecoratorDebyeWaller::evaluate(const WavevectorInfo &wavevectors) const
- Returns scattering amplitude for complex wavevector bin
-
- Parameters:
- -----------
-
- k_i:
- incoming wavevector
-
- k_f_bin:
- outgoing wavevector bin
+ Returns scattering amplitude for complex wavevector bin.
"""
return _libBornAgainCore.FormFactorDecoratorDebyeWaller_evaluate(self, wavevectors)
@@ -10766,11 +10730,11 @@ class FormFactorLongRipple2Gauss(IFormFactorBorn):
__getattr__ = lambda self, name: _swig_getattr(self, FormFactorLongRipple2Gauss, name)
__repr__ = _swig_repr
- def __init__(self, length, width, height, asymetry):
+ def __init__(self, length, width, height, asymmetry):
"""
- __init__(FormFactorLongRipple2Gauss self, double length, double width, double height, double asymetry) -> FormFactorLongRipple2Gauss
+ __init__(FormFactorLongRipple2Gauss self, double length, double width, double height, double asymmetry) -> FormFactorLongRipple2Gauss
- FormFactorLongRipple2Gauss::FormFactorLongRipple2Gauss(double length, double width, double height, double asymetry)
+ FormFactorLongRipple2Gauss::FormFactorLongRipple2Gauss(double length, double width, double height, double asymmetry)
FormFactorLongRipple2Gauss constructor.
@@ -10790,7 +10754,7 @@ class FormFactorLongRipple2Gauss(IFormFactorBorn):
length of triangular cross section
"""
- this = _libBornAgainCore.new_FormFactorLongRipple2Gauss(length, width, height, asymetry)
+ this = _libBornAgainCore.new_FormFactorLongRipple2Gauss(length, width, height, asymmetry)
try:
self.this.append(this)
except:
@@ -10907,11 +10871,11 @@ class FormFactorLongRipple2Lorentz(IFormFactorBorn):
__getattr__ = lambda self, name: _swig_getattr(self, FormFactorLongRipple2Lorentz, name)
__repr__ = _swig_repr
- def __init__(self, length, width, height, asymetry):
+ def __init__(self, length, width, height, asymmetry):
"""
- __init__(FormFactorLongRipple2Lorentz self, double length, double width, double height, double asymetry) -> FormFactorLongRipple2Lorentz
+ __init__(FormFactorLongRipple2Lorentz self, double length, double width, double height, double asymmetry) -> FormFactorLongRipple2Lorentz
- FormFactorLongRipple2Lorentz::FormFactorLongRipple2Lorentz(double length, double width, double height, double asymetry)
+ FormFactorLongRipple2Lorentz::FormFactorLongRipple2Lorentz(double length, double width, double height, double asymmetry)
FormFactorLongRipple2Lorentz constructor.
@@ -10931,7 +10895,7 @@ class FormFactorLongRipple2Lorentz(IFormFactorBorn):
length of triangular cross section
"""
- this = _libBornAgainCore.new_FormFactorLongRipple2Lorentz(length, width, height, asymetry)
+ this = _libBornAgainCore.new_FormFactorLongRipple2Lorentz(length, width, height, asymmetry)
try:
self.this.append(this)
except:
@@ -11557,11 +11521,11 @@ class FormFactorRipple2(IFormFactorBorn):
__getattr__ = lambda self, name: _swig_getattr(self, FormFactorRipple2, name)
__repr__ = _swig_repr
- def __init__(self, length, width, height, asymetry):
+ def __init__(self, length, width, height, asymmetry):
"""
- __init__(FormFactorRipple2 self, double length, double width, double height, double asymetry) -> FormFactorRipple2
+ __init__(FormFactorRipple2 self, double length, double width, double height, double asymmetry) -> FormFactorRipple2
- FormFactorRipple2::FormFactorRipple2(double length, double width, double height, double asymetry)
+ FormFactorRipple2::FormFactorRipple2(double length, double width, double height, double asymmetry)
Ripple2 constructor.
@@ -11581,7 +11545,7 @@ class FormFactorRipple2(IFormFactorBorn):
length of triangular cross section
"""
- this = _libBornAgainCore.new_FormFactorRipple2(length, width, height, asymetry)
+ this = _libBornAgainCore.new_FormFactorRipple2(length, width, height, asymmetry)
try:
self.this.append(this)
except:
@@ -11985,8 +11949,8 @@ class FormFactorTetrahedron(FormFactorPolyhedron):
height:
of Tetrahedron
- angle:
- in radians between base and facet
+ alpha:
+ dihedral angle in radians between base and facet
"""
this = _libBornAgainCore.new_FormFactorTetrahedron(base_edge, height, alpha)
@@ -12054,7 +12018,14 @@ FormFactorTetrahedron_swigregister = _libBornAgainCore.FormFactorTetrahedron_swi
FormFactorTetrahedron_swigregister(FormFactorTetrahedron)
class FormFactorTrivial(IFormFactorBorn):
- """Proxy of C++ FormFactorTrivial class"""
+ """
+
+
+ A uniform formfactor F(q)=1, for development purposes.
+
+ C++ includes: FormFactorTrivial.h
+
+ """
__swig_setmethods__ = {}
for _s in [IFormFactorBorn]:
__swig_setmethods__.update(getattr(_s, '__swig_setmethods__', {}))
@@ -12071,17 +12042,6 @@ class FormFactorTrivial(IFormFactorBorn):
FormFactorTrivial::FormFactorTrivial()
- Cylinder constructor.
-
- Parameters:
- -----------
-
- radius:
- of Cylinder's base
-
- height:
- of Cylinder
-
"""
this = _libBornAgainCore.new_FormFactorTrivial()
try:
@@ -12175,11 +12135,11 @@ class FormFactorTruncatedCube(FormFactorPolyhedron):
Parameters:
-----------
- side:
- length of the full cube
+ length:
+ of the full cube
- side:
- length of the trirectangular tetrahedron removed from each vertex of the cube
+ removed_length:
+ as removed from each edge of the cube
"""
this = _libBornAgainCore.new_FormFactorTruncatedCube(length, removed_length)
@@ -12354,20 +12314,6 @@ class FormFactorTruncatedSpheroid(IFormFactorBorn):
FormFactorTruncatedSpheroid::FormFactorTruncatedSpheroid(double radius, double height, double height_flattening)
- TruncatedSpheroid constructor.
-
- Parameters:
- -----------
-
- radius:
- of Truncated Spheroid
-
- height:
- of Truncated Spheroid
-
- flattening:
- parameter in vertical direction (full height: 2 x flattening x radius)
-
"""
this = _libBornAgainCore.new_FormFactorTruncatedSpheroid(radius, height, height_flattening)
try:
@@ -12552,16 +12498,7 @@ class FormFactorWeighted(IFormFactor):
complex_t FormFactorWeighted::evaluate(const WavevectorInfo &wavevectors) const
- Returns scattering amplitude for complex wavevector bin
-
- Parameters:
- -----------
-
- k_i:
- incoming wavevector
-
- k_f_bin:
- outgoing wavevector bin
+ Returns scattering amplitude for complex wavevector bin.
"""
return _libBornAgainCore.FormFactorWeighted_evaluate(self, wavevectors)
@@ -14509,7 +14446,10 @@ class IDetector2D(IParameterized):
-----------
shape:
- The shape of mask (Rectangle, Polygon, Line, Ellipse) The value of mask
+ The shape of mask (Rectangle, Polygon, Line, Ellipse)
+
+ mask_value:
+ The value of mask
"""
return _libBornAgainCore.IDetector2D_addMask(self, shape, mask_value)
@@ -16538,20 +16478,6 @@ class InterferenceFunctionRadialParaCrystal(IInterferenceFunction):
InterferenceFunctionRadialParaCrystal::InterferenceFunctionRadialParaCrystal(double peak_distance, double damping_length=0.0)
- constructor of radial paracrystal interference function
-
- Parameters:
- -----------
-
- peak_distance:
- The distance to the first neighbor peak.
-
- width:
- Width parameter in the pair correlation function.
-
- m_corr_length:
- Correlation length of paracrystal.
-
"""
this = _libBornAgainCore.new_InterferenceFunctionRadialParaCrystal(peak_distance, damping_length)
try:
@@ -16677,7 +16603,7 @@ class InterferenceFunctionRadialParaCrystal(IInterferenceFunction):
void InterferenceFunctionRadialParaCrystal::setProbabilityDistribution(const IFTDistribution1D &pdf)
- Sets the Fourier transformed probability distribution of the nearest particle
+ Sets the Fourier transformed probability distribution of the nearest particle.
"""
return _libBornAgainCore.InterferenceFunctionRadialParaCrystal_setProbabilityDistribution(self, pdf)
@@ -16689,7 +16615,7 @@ class InterferenceFunctionRadialParaCrystal(IInterferenceFunction):
const IFTDistribution1D * InterferenceFunctionRadialParaCrystal::getProbabilityDistribution() const
- Gets the Fourier transformed probability distribution of the nearest particle
+ Gets the Fourier transformed probability distribution of the nearest particle.
"""
return _libBornAgainCore.InterferenceFunctionRadialParaCrystal_getProbabilityDistribution(self)
@@ -19830,7 +19756,7 @@ class IntensityData(_object):
void OutputData< T >::setAxisSizes(size_t rank, int *n_dims)
- Adds <rank> axes with indicated sizes.
+ Adds 'rank' axes with indicated sizes.
"""
return _libBornAgainCore.IntensityData_setAxisSizes(self, rank, n_dims)
diff --git a/auto/Wrap/libBornAgainCore_wrap.cpp b/auto/Wrap/libBornAgainCore_wrap.cpp
index 4337ebd3ea388e14514d5bde6e054eb795659c03..76191e7e3aa20ed99f19df6f167625a3534b06b3 100644
--- a/auto/Wrap/libBornAgainCore_wrap.cpp
+++ b/auto/Wrap/libBornAgainCore_wrap.cpp
@@ -93108,16 +93108,7 @@ static PyMethodDef SwigMethods[] = {
"\n"
"virtual complex_t IFormFactor::evaluate(const WavevectorInfo &wavevectors) const =0\n"
"\n"
- "Returns scattering amplitude for complex wavevector bin\n"
- "\n"
- "Parameters:\n"
- "-----------\n"
- "\n"
- "k_i: \n"
- "incoming wavevector\n"
- "\n"
- "k_f_bin: \n"
- "outgoing wavevector bin \n"
+ "Returns scattering amplitude for complex wavevector bin. \n"
"\n"
""},
{ (char *)"IFormFactor_getVolume", _wrap_IFormFactor_getVolume, METH_VARARGS, (char *)"\n"
@@ -93242,16 +93233,7 @@ static PyMethodDef SwigMethods[] = {
"\n"
"complex_t IFormFactorBorn::evaluate(const WavevectorInfo &wavevectors) const\n"
"\n"
- "Returns scattering amplitude for complex wavevector bin\n"
- "\n"
- "Parameters:\n"
- "-----------\n"
- "\n"
- "k_i: \n"
- "incoming wavevector\n"
- "\n"
- "k_f_bin: \n"
- "outgoing wavevector bin \n"
+ "Returns scattering amplitude for complex wavevector bin. \n"
"\n"
""},
{ (char *)"IFormFactorBorn_evaluate_for_q", _wrap_IFormFactorBorn_evaluate_for_q, METH_VARARGS, (char *)"\n"
@@ -93579,8 +93561,8 @@ static PyMethodDef SwigMethods[] = {
"height: \n"
"of Pyramid\n"
"\n"
- "dihedralangle: \n"
- "in radians between base and facet \n"
+ "alpha: \n"
+ "dihedral angle in radians between base and facet \n"
"\n"
""},
{ (char *)"FormFactorAnisoPyramid_clone", _wrap_FormFactorAnisoPyramid_clone, METH_VARARGS, (char *)"\n"
@@ -93797,13 +93779,13 @@ static PyMethodDef SwigMethods[] = {
"-----------\n"
"\n"
"base_edge: \n"
- "of hexagonal base (different from R in IsGisaxs)\n"
+ "of hexagonal base\n"
"\n"
"height: \n"
"of Cone6\n"
"\n"
- "angle: \n"
- "in radians between base and facet \n"
+ "alpha: \n"
+ "dihedral angle in radians between base and facet \n"
"\n"
""},
{ (char *)"FormFactorCone6_clone", _wrap_FormFactorCone6_clone, METH_VARARGS, (char *)"\n"
@@ -93891,16 +93873,7 @@ static PyMethodDef SwigMethods[] = {
"\n"
"complex_t FormFactorCrystal::evaluate(const WavevectorInfo &wavevectors) const\n"
"\n"
- "Returns scattering amplitude for complex wavevector bin\n"
- "\n"
- "Parameters:\n"
- "-----------\n"
- "\n"
- "k_i: \n"
- "incoming wavevector\n"
- "\n"
- "k_f_bin: \n"
- "outgoing wavevector bin \n"
+ "Returns scattering amplitude for complex wavevector bin. \n"
"\n"
""},
{ (char *)"FormFactorCrystal_evaluate_for_q", _wrap_FormFactorCrystal_evaluate_for_q, METH_VARARGS, (char *)"\n"
@@ -94087,16 +94060,7 @@ static PyMethodDef SwigMethods[] = {
"\n"
"complex_t FormFactorDecoratorDebyeWaller::evaluate(const WavevectorInfo &wavevectors) const\n"
"\n"
- "Returns scattering amplitude for complex wavevector bin\n"
- "\n"
- "Parameters:\n"
- "-----------\n"
- "\n"
- "k_i: \n"
- "incoming wavevector\n"
- "\n"
- "k_f_bin: \n"
- "outgoing wavevector bin \n"
+ "Returns scattering amplitude for complex wavevector bin. \n"
"\n"
""},
{ (char *)"FormFactorDecoratorDebyeWaller_swigregister", FormFactorDecoratorDebyeWaller_swigregister, METH_VARARGS, NULL},
@@ -94834,9 +94798,9 @@ static PyMethodDef SwigMethods[] = {
""},
{ (char *)"FormFactorLongRipple1Lorentz_swigregister", FormFactorLongRipple1Lorentz_swigregister, METH_VARARGS, NULL},
{ (char *)"new_FormFactorLongRipple2Gauss", _wrap_new_FormFactorLongRipple2Gauss, METH_VARARGS, (char *)"\n"
- "new_FormFactorLongRipple2Gauss(double length, double width, double height, double asymetry) -> FormFactorLongRipple2Gauss\n"
+ "new_FormFactorLongRipple2Gauss(double length, double width, double height, double asymmetry) -> FormFactorLongRipple2Gauss\n"
"\n"
- "FormFactorLongRipple2Gauss::FormFactorLongRipple2Gauss(double length, double width, double height, double asymetry)\n"
+ "FormFactorLongRipple2Gauss::FormFactorLongRipple2Gauss(double length, double width, double height, double asymmetry)\n"
"\n"
"FormFactorLongRipple2Gauss constructor.\n"
"\n"
@@ -94920,9 +94884,9 @@ static PyMethodDef SwigMethods[] = {
""},
{ (char *)"FormFactorLongRipple2Gauss_swigregister", FormFactorLongRipple2Gauss_swigregister, METH_VARARGS, NULL},
{ (char *)"new_FormFactorLongRipple2Lorentz", _wrap_new_FormFactorLongRipple2Lorentz, METH_VARARGS, (char *)"\n"
- "new_FormFactorLongRipple2Lorentz(double length, double width, double height, double asymetry) -> FormFactorLongRipple2Lorentz\n"
+ "new_FormFactorLongRipple2Lorentz(double length, double width, double height, double asymmetry) -> FormFactorLongRipple2Lorentz\n"
"\n"
- "FormFactorLongRipple2Lorentz::FormFactorLongRipple2Lorentz(double length, double width, double height, double asymetry)\n"
+ "FormFactorLongRipple2Lorentz::FormFactorLongRipple2Lorentz(double length, double width, double height, double asymmetry)\n"
"\n"
"FormFactorLongRipple2Lorentz constructor.\n"
"\n"
@@ -95284,9 +95248,9 @@ static PyMethodDef SwigMethods[] = {
""},
{ (char *)"FormFactorRipple1_swigregister", FormFactorRipple1_swigregister, METH_VARARGS, NULL},
{ (char *)"new_FormFactorRipple2", _wrap_new_FormFactorRipple2, METH_VARARGS, (char *)"\n"
- "new_FormFactorRipple2(double length, double width, double height, double asymetry) -> FormFactorRipple2\n"
+ "new_FormFactorRipple2(double length, double width, double height, double asymmetry) -> FormFactorRipple2\n"
"\n"
- "FormFactorRipple2::FormFactorRipple2(double length, double width, double height, double asymetry)\n"
+ "FormFactorRipple2::FormFactorRipple2(double length, double width, double height, double asymmetry)\n"
"\n"
"Ripple2 constructor.\n"
"\n"
@@ -95538,8 +95502,8 @@ static PyMethodDef SwigMethods[] = {
"height: \n"
"of Tetrahedron\n"
"\n"
- "angle: \n"
- "in radians between base and facet \n"
+ "alpha: \n"
+ "dihedral angle in radians between base and facet \n"
"\n"
""},
{ (char *)"FormFactorTetrahedron_clone", _wrap_FormFactorTetrahedron_clone, METH_VARARGS, (char *)"\n"
@@ -95583,17 +95547,6 @@ static PyMethodDef SwigMethods[] = {
"\n"
"FormFactorTrivial::FormFactorTrivial()\n"
"\n"
- "Cylinder constructor.\n"
- "\n"
- "Parameters:\n"
- "-----------\n"
- "\n"
- "radius: \n"
- "of Cylinder's base\n"
- "\n"
- "height: \n"
- "of Cylinder \n"
- "\n"
""},
{ (char *)"FormFactorTrivial_clone", _wrap_FormFactorTrivial_clone, METH_VARARGS, (char *)"\n"
"FormFactorTrivial_clone(FormFactorTrivial self) -> FormFactorTrivial\n"
@@ -95643,11 +95596,11 @@ static PyMethodDef SwigMethods[] = {
"Parameters:\n"
"-----------\n"
"\n"
- "side: \n"
- "length of the full cube\n"
+ "length: \n"
+ "of the full cube\n"
"\n"
- "side: \n"
- "length of the trirectangular tetrahedron removed from each vertex of the cube \n"
+ "removed_length: \n"
+ "as removed from each edge of the cube \n"
"\n"
""},
{ (char *)"FormFactorTruncatedCube_clone", _wrap_FormFactorTruncatedCube_clone, METH_VARARGS, (char *)"\n"
@@ -95739,20 +95692,6 @@ static PyMethodDef SwigMethods[] = {
"\n"
"FormFactorTruncatedSpheroid::FormFactorTruncatedSpheroid(double radius, double height, double height_flattening)\n"
"\n"
- "TruncatedSpheroid constructor.\n"
- "\n"
- "Parameters:\n"
- "-----------\n"
- "\n"
- "radius: \n"
- "of Truncated Spheroid\n"
- "\n"
- "height: \n"
- "of Truncated Spheroid\n"
- "\n"
- "flattening: \n"
- "parameter in vertical direction (full height: 2 x flattening x radius) \n"
- "\n"
""},
{ (char *)"delete_FormFactorTruncatedSpheroid", _wrap_delete_FormFactorTruncatedSpheroid, METH_VARARGS, (char *)"\n"
"delete_FormFactorTruncatedSpheroid(FormFactorTruncatedSpheroid self)\n"
@@ -95867,16 +95806,7 @@ static PyMethodDef SwigMethods[] = {
"\n"
"complex_t FormFactorWeighted::evaluate(const WavevectorInfo &wavevectors) const\n"
"\n"
- "Returns scattering amplitude for complex wavevector bin\n"
- "\n"
- "Parameters:\n"
- "-----------\n"
- "\n"
- "k_i: \n"
- "incoming wavevector\n"
- "\n"
- "k_f_bin: \n"
- "outgoing wavevector bin \n"
+ "Returns scattering amplitude for complex wavevector bin. \n"
"\n"
""},
{ (char *)"FormFactorWeighted_swigregister", FormFactorWeighted_swigregister, METH_VARARGS, NULL},
@@ -97070,7 +97000,10 @@ static PyMethodDef SwigMethods[] = {
"-----------\n"
"\n"
"shape: \n"
- "The shape of mask (Rectangle, Polygon, Line, Ellipse) The value of mask \n"
+ "The shape of mask (Rectangle, Polygon, Line, Ellipse)\n"
+ "\n"
+ "mask_value: \n"
+ "The value of mask \n"
"\n"
""},
{ (char *)"IDetector2D_maskAll", _wrap_IDetector2D_maskAll, METH_VARARGS, (char *)"\n"
@@ -98143,20 +98076,6 @@ static PyMethodDef SwigMethods[] = {
"\n"
"InterferenceFunctionRadialParaCrystal::InterferenceFunctionRadialParaCrystal(double peak_distance, double damping_length=0.0)\n"
"\n"
- "constructor of radial paracrystal interference function\n"
- "\n"
- "Parameters:\n"
- "-----------\n"
- "\n"
- "peak_distance: \n"
- "The distance to the first neighbor peak.\n"
- "\n"
- "width: \n"
- "Width parameter in the pair correlation function.\n"
- "\n"
- "m_corr_length: \n"
- "Correlation length of paracrystal. \n"
- "\n"
""},
{ (char *)"delete_InterferenceFunctionRadialParaCrystal", _wrap_delete_InterferenceFunctionRadialParaCrystal, METH_VARARGS, (char *)"\n"
"delete_InterferenceFunctionRadialParaCrystal(InterferenceFunctionRadialParaCrystal self)\n"
@@ -98247,7 +98166,7 @@ static PyMethodDef SwigMethods[] = {
"\n"
"void InterferenceFunctionRadialParaCrystal::setProbabilityDistribution(const IFTDistribution1D &pdf)\n"
"\n"
- "Sets the Fourier transformed probability distribution of the nearest particle \n"
+ "Sets the Fourier transformed probability distribution of the nearest particle. \n"
"\n"
""},
{ (char *)"InterferenceFunctionRadialParaCrystal_getProbabilityDistribution", _wrap_InterferenceFunctionRadialParaCrystal_getProbabilityDistribution, METH_VARARGS, (char *)"\n"
@@ -98255,7 +98174,7 @@ static PyMethodDef SwigMethods[] = {
"\n"
"const IFTDistribution1D * InterferenceFunctionRadialParaCrystal::getProbabilityDistribution() const\n"
"\n"
- "Gets the Fourier transformed probability distribution of the nearest particle \n"
+ "Gets the Fourier transformed probability distribution of the nearest particle. \n"
"\n"
""},
{ (char *)"InterferenceFunctionRadialParaCrystal_getPeakDistance", _wrap_InterferenceFunctionRadialParaCrystal_getPeakDistance, METH_VARARGS, (char *)"\n"
@@ -100068,7 +99987,7 @@ static PyMethodDef SwigMethods[] = {
"\n"
"void OutputData< T >::setAxisSizes(size_t rank, int *n_dims)\n"
"\n"
- "Adds <rank> axes with indicated sizes. \n"
+ "Adds 'rank' axes with indicated sizes. \n"
"\n"
""},
{ (char *)"IntensityData_setRawDataVector", _wrap_IntensityData_setRawDataVector, METH_VARARGS, (char *)"\n"