diff --git a/Core/HardParticle/FormFactorAnisoPyramid.cpp b/Core/HardParticle/FormFactorAnisoPyramid.cpp
index cd84facee9410cbefc9700a4a7585eddf9bc87f9..d58def351b6cbb78afb126113583ea25be9759c5 100644
--- a/Core/HardParticle/FormFactorAnisoPyramid.cpp
+++ b/Core/HardParticle/FormFactorAnisoPyramid.cpp
@@ -25,18 +25,13 @@ const PolyhedralTopology FormFactorAnisoPyramid::topology = {{{{3, 2, 1, 0}, tru
{{4, 5, 6, 7}, true}},
false};
-//! Constructor of a truncated pyramid with a rectangular base.
-//! @param length: length of the rectangular base in nm
-//! @param width: width of the rectangular base in nm
-//! @param height: height of pyramid in nm
-//! @param alpha: dihedral angle in radians between base and facet
FormFactorAnisoPyramid::FormFactorAnisoPyramid(const std::vector<double> P)
: IFormFactorPolyhedron({"AnisoPyramid",
- "class_tooltip",
- {{"Length", "nm", "para_tooltip", 0, +INF, 0},
- {"Width", "nm", "para_tooltip", 0, +INF, 0},
- {"Height", "nm", "para_tooltip", 0, +INF, 0},
- {"Alpha", "rad", "para_tooltip", 0., M_PI_2, 0}}},
+ "frsutum with rectangular base",
+ {{"Length", "nm", "side length of base in x direction", 0, +INF, 0},
+ {"Width", "nm", "side length of base in y direction", 0, +INF, 0},
+ {"Height", "nm", "height", 0, +INF, 0},
+ {"Alpha", "rad", "angle between base and any side face", 0., M_PI_2, 0}}},
P),
m_length(m_P[0]), m_width(m_P[1]), m_height(m_P[2]), m_alpha(m_P[3])
{
diff --git a/Core/HardParticle/FormFactorBox.cpp b/Core/HardParticle/FormFactorBox.cpp
index 53256e6b4a2dfe47c7056703c3c2640a34d3c628..0c49deb39bc1edb47075608ea39cbdc90f165dc2 100644
--- a/Core/HardParticle/FormFactorBox.cpp
+++ b/Core/HardParticle/FormFactorBox.cpp
@@ -15,16 +15,12 @@
#include "Core/HardParticle/FormFactorBox.h"
#include "Core/Tools/MathFunctions.h"
-//! Constructor of a rectangular cuboid.
-//! @param length: length of the base in nanometers
-//! @param width: width of the base in nanometers
-//! @param height: height of the box in nanometers
FormFactorBox::FormFactorBox(const std::vector<double> P)
: IFormFactorPrism({"Box",
- "class_tooltip",
- {{"Length", "nm", "para_tooltip", 0, +INF, 0},
- {"Width", "nm", "para_tooltip", 0, +INF, 0},
- {"Height", "nm", "para_tooltip", 0, +INF, 0}}},
+ "rectangular cuboid",
+ {{"Length", "nm", "side length in x direction", 0, +INF, 0},
+ {"Width", "nm", "side length in y direction", 0, +INF, 0},
+ {"Height", "nm", "side length in z direction", 0, +INF, 0}}},
P),
m_length(m_P[0]), m_width(m_P[1]), m_height(m_P[2])
{
diff --git a/Core/HardParticle/FormFactorCantellatedCube.cpp b/Core/HardParticle/FormFactorCantellatedCube.cpp
index 6d6e8fcce71e1d967c937fd336142615c3eb0f34..0fc790209db2dbbd1a5555ec1c9c873fca781204 100644
--- a/Core/HardParticle/FormFactorCantellatedCube.cpp
+++ b/Core/HardParticle/FormFactorCantellatedCube.cpp
@@ -46,14 +46,11 @@ const PolyhedralTopology FormFactorCantellatedCube::topology = {
},
true};
-//! Constructor of a truncated cube.
-//! @param length: length of the full cube's edge in nanometers
-//! @param removed_length: removed length from each edge of the cube in nanometers
FormFactorCantellatedCube::FormFactorCantellatedCube(const std::vector<double> P)
: IFormFactorPolyhedron({"CantellatedCube",
- "class_tooltip",
- {{"Length", "nm", "para_tooltip", 0, +INF, 0},
- {"RemovedLength", "nm", "para_tooltip", 0, +INF, 0}}},
+ "a cube with truncated edges and vertices,
+ {{"Length", "nm", "length of untruncated edge", 0, +INF, 0},
+ {"RemovedLength", "nm", "side length of the trirectangular tetrahedron removed one corner", 0, +INF, 0}}},
P),
m_length(m_P[0]), m_removed_length(m_P[1])
{
diff --git a/Core/HardParticle/FormFactorCone.cpp b/Core/HardParticle/FormFactorCone.cpp
index 0c03df1fa4f166663d8649dcd9a7655132a44b6a..7d60ec6e7f10db0e1becc2f008806e7db2dc13f0 100644
--- a/Core/HardParticle/FormFactorCone.cpp
+++ b/Core/HardParticle/FormFactorCone.cpp
@@ -20,16 +20,12 @@
#include "Core/Tools/MathFunctions.h"
#include <limits>
-//! Constructor of a truncated cone with circular base.
-//! @param radius: radius of the base in nanometers
-//! @param height: height of the cone in nanometers
-//! @param alpha: angle between the base and the side surface in radians
FormFactorCone::FormFactorCone(const std::vector<double> P)
: IFormFactorBorn({"Cone",
- "class_tooltip",
- {{"Radius", "nm", "para_tooltip", 0, +INF, 0},
- {"Height", "nm", "para_tooltip", 0, +INF, 0},
- {"Alpha", "rad", "para_tooltip", 0., M_PI_2, 0}}},
+ "frustum with circular base",
+ {{"Radius", "nm", "radius of base", 0, +INF, 0},
+ {"Height", "nm", "height", 0, +INF, 0},
+ {"Alpha", "rad", "angle between base and side", 0., M_PI_2, 0}}},
P),
m_radius(m_P[0]), m_height(m_P[1]), m_alpha(m_P[2])
{
diff --git a/Core/HardParticle/FormFactorCone6.cpp b/Core/HardParticle/FormFactorCone6.cpp
index 00fe80883cf98bfba9dec708b36532905723250d..32c61dad0ea2bf538f6797b86bdf0ada58030402 100644
--- a/Core/HardParticle/FormFactorCone6.cpp
+++ b/Core/HardParticle/FormFactorCone6.cpp
@@ -27,16 +27,12 @@ const PolyhedralTopology FormFactorCone6::topology = {{{{5, 4, 3, 2, 1, 0}, true
{{6, 7, 8, 9, 10, 11}, true}},
false};
-//! Constructor of a truncated pyramid, based on a regular hexagon
-//! @param base_edge: Edge of the regular hexagonal base in nanometers
-//! @param height: height of a truncated pyramid in nanometers
-//! @param alpha: dihedral angle in radians between base and facet
FormFactorCone6::FormFactorCone6(const std::vector<double> P)
: IFormFactorPolyhedron({"Cone6",
- "class_tooltip",
- {{"BaseEdge", "nm", "para_tooltip", 0, +INF, 0},
- {"Height", "nm", "para_tooltip", 0, +INF, 0},
- {"Alpha", "rad", "para_tooltip", 0., M_PI_2, 0}}},
+ "frustum with regular hexagonal base",
+ {{"BaseEdge", "nm", "base edge length", 0, +INF, 0},
+ {"Height", "nm", "height", 0, +INF, 0},
+ {"Alpha", "rad", "angle between base and a side face", 0., M_PI_2, 0}}},
P),
m_base_edge(m_P[0]), m_height(m_P[1]), m_alpha(m_P[2])
{
diff --git a/Core/HardParticle/FormFactorCuboctahedron.cpp b/Core/HardParticle/FormFactorCuboctahedron.cpp
index f45ba0ee9f4f4b04cc13bc355f8f1b2b4035c57d..f6310f934dd3b44a1d86e3e15af2ffb7a2b99b93 100644
--- a/Core/HardParticle/FormFactorCuboctahedron.cpp
+++ b/Core/HardParticle/FormFactorCuboctahedron.cpp
@@ -30,19 +30,13 @@ const PolyhedralTopology FormFactorCuboctahedron::topology = {{{{3, 2, 1, 0}, tr
{{8, 9, 10, 11}, true}},
false};
-//! Constructor of cuboctahedron (compound of two truncated pyramids with a common square base
-//! and opposite orientations).
-//! @param length: side length of the common square base in nanometers
-//! @param height: height of the lower pyramid in nanometers
-//! @param height_ratio: ratio of heights of top to bottom pyramids
-//! @param alpha: dihedral angle in radians between base and facet
FormFactorCuboctahedron::FormFactorCuboctahedron(const std::vector<double> P)
: IFormFactorPolyhedron({"Cuboctahedron",
- "class_tooltip",
- {{"Length", "nm", "para_tooltip", 0, +INF, 0},
- {"Height", "nm", "para_tooltip", 0, +INF, 0},
- {"HeightRatio", "nm", "para_tooltip", 0, +INF, 0},
- {"Alpha", "rad", "para_tooltip", 0., M_PI_2, 0}}},
+ "truncated quadratic bipyramid",
+ {{"Length", "nm", "edge length of base square (common face of both pyramids)", 0, +INF, 0},
+ {"Height", "nm", "height of the lower pyramid", 0, +INF, 0},
+ {"HeightRatio", "nm", "height ratio of upper to lower pyramid", 0, +INF, 0},
+ {"Alpha", "rad", "angle between the base and a side face", 0., M_PI_2, 0}}},
P),
m_length(m_P[0]), m_height(m_P[1]), m_height_ratio(m_P[2]), m_alpha(m_P[3])
{
diff --git a/Core/HardParticle/FormFactorCylinder.cpp b/Core/HardParticle/FormFactorCylinder.cpp
index 9ceead80f11de0bdcba5f92afc17feb5235374cd..e1040e35bcee5d6d59bee502965da1c350b979a5 100644
--- a/Core/HardParticle/FormFactorCylinder.cpp
+++ b/Core/HardParticle/FormFactorCylinder.cpp
@@ -17,14 +17,11 @@
#include "Core/Shapes/DoubleEllipse.h"
#include "Core/Tools/MathFunctions.h"
-//! Constructor of a cylinder with a circular base.
-//! @param radius: radius of the circular base in nanometers
-//! @param height: height of the cylinder in nanometers
FormFactorCylinder::FormFactorCylinder(const std::vector<double> P)
: IFormFactorBorn({"Cylinder",
- "class_tooltip",
- {{"Radius", "nm", "para_tooltip", 0, +INF, 0},
- {"Height", "nm", "para_tooltip", 0, +INF, 0}}},
+ "circular cylinder",
+ {{"Radius", "nm", "radius of base", 0, +INF, 0},
+ {"Height", "nm", "height", 0, +INF, 0}}},
P),
m_radius(m_P[0]), m_height(m_P[1])
{
diff --git a/Core/HardParticle/FormFactorDodecahedron.cpp b/Core/HardParticle/FormFactorDodecahedron.cpp
index df8a23115068a888483f488baec5ab1f573c706e..b250d1e0084664659e68ea084fb431bfd12badd4 100644
--- a/Core/HardParticle/FormFactorDodecahedron.cpp
+++ b/Core/HardParticle/FormFactorDodecahedron.cpp
@@ -32,11 +32,9 @@ const PolyhedralTopology FormFactorDodecahedron::topology = {{// bottom:
{{15, 16, 17, 18, 19}, false}},
true};
-//! Constructor of a dodecahedron.
-//! @param edge: length of the edge in nanometers
FormFactorDodecahedron::FormFactorDodecahedron(const std::vector<double> P)
: IFormFactorPolyhedron(
- {"Dodecahedron", "class_tooltip", {{"Edge", "nm", "para_tooltip", 0, +INF, 0}}}, P),
+ {"Dodecahedron", "regular dodecahedron", {{"Edge", "nm", "edge length", 0, +INF, 0}}}, P),
m_edge(m_P[0])
{
onChange();
diff --git a/Core/HardParticle/FormFactorDodecahedron.h b/Core/HardParticle/FormFactorDodecahedron.h
index 040aa8e98cc841e06e3c74abe448baa3066a3d41..c48c028b0d358f880a3c0c48dc2ae5b7acc12c43 100644
--- a/Core/HardParticle/FormFactorDodecahedron.h
+++ b/Core/HardParticle/FormFactorDodecahedron.h
@@ -23,8 +23,6 @@
class FormFactorDodecahedron : public IFormFactorPolyhedron
{
public:
- //! @brief Constructs a regular dodecahedron
- //! @param edge length
FormFactorDodecahedron(const std::vector<double> P);
FormFactorDodecahedron(double edge);
diff --git a/Core/HardParticle/FormFactorDot.cpp b/Core/HardParticle/FormFactorDot.cpp
index eeb1a40a34b5d4a3b3cc669e20d630e300aa9f03..b6933df904bedc64e831c1c4689a5a829a25ca3c 100644
--- a/Core/HardParticle/FormFactorDot.cpp
+++ b/Core/HardParticle/FormFactorDot.cpp
@@ -14,10 +14,9 @@
#include "Core/HardParticle/FormFactorDot.h"
-//! Constructor.
-//! @param rscat: radius of a sphere with same forward scattering power, in nanometers
FormFactorDot::FormFactorDot(const std::vector<double> P)
- : IFormFactorBorn({"Dot", "class_tooltip", {{"Radius", "nm", "para_tooltip", 0, +INF, 0}}}, P),
+ : IFormFactorBorn({"Dot", "dot, with scattering power of a sphere of given radius",
+ {{"Radius", "nm", "radius of sphere that defines scattering power", 0, +INF, 0}}}, P),
m_radius(m_P[0])
{
onChange();
diff --git a/Core/HardParticle/FormFactorEllipsoidalCylinder.cpp b/Core/HardParticle/FormFactorEllipsoidalCylinder.cpp
index cded89c4ee5d8e442d4cd6f6bb6661015210a0fd..fb9a376561864c227600abe550edf4cdc35d12d8 100644
--- a/Core/HardParticle/FormFactorEllipsoidalCylinder.cpp
+++ b/Core/HardParticle/FormFactorEllipsoidalCylinder.cpp
@@ -17,16 +17,12 @@
#include "Core/Shapes/DoubleEllipse.h"
#include "Core/Tools/MathFunctions.h"
-//! Constructor of a cylinder with an ellipse cross section.
-//! @param radius_x: radius of the ellipse base in the x-direction, in nanometers
-//! @param radius_y: radius of the ellipse base in the y-direction, in nanometers
-//! @param height: height of the ellipsoidal cylinder in nanometers
FormFactorEllipsoidalCylinder::FormFactorEllipsoidalCylinder(const std::vector<double> P)
: IFormFactorBorn({"EllipsoidalCylinder",
- "class_tooltip",
- {{"RadiusX", "nm", "para_tooltip", 0, +INF, 0},
- {"RadiusY", "nm", "para_tooltip", 0, +INF, 0},
- {"Height", "nm", "para_tooltip", 0, +INF, 0}}},
+ "elliptical cylinder",
+ {{"RadiusX", "nm", "radius in x direction", 0, +INF, 0},
+ {"RadiusY", "nm", "radius in y direction", 0, +INF, 0},
+ {"Height", "nm", "height", 0, +INF, 0}}},
P),
m_radius_x(m_P[0]), m_radius_y(m_P[1]), m_height(m_P[2])
{
diff --git a/Core/HardParticle/FormFactorFullSphere.cpp b/Core/HardParticle/FormFactorFullSphere.cpp
index 789d758d22c2559f4e9ae77b79b37fa609f3e283..4c941726dd6a4b04bd2a2e1cb282f14615fcb21c 100644
--- a/Core/HardParticle/FormFactorFullSphere.cpp
+++ b/Core/HardParticle/FormFactorFullSphere.cpp
@@ -19,11 +19,9 @@
#include "Core/Scattering/Rotations.h"
#include "Core/Vector/SomeFormFactors.h"
-//! Constructor of a full sphere.
-//! @param radius: radius of the sphere in nanometers
FormFactorFullSphere::FormFactorFullSphere(const std::vector<double> P, bool position_at_center)
: IFormFactorBorn(
- {"FullSphere", "class_tooltip", {{"Radius", "nm", "para_tooltip", 0, +INF, 0}}}, P),
+ {"FullSphere", "sphere", {{"Radius", "nm", "radius", 0, +INF, 0}}}, P),
m_radius(m_P[0]), m_position_at_center(position_at_center)
{
onChange();
diff --git a/Core/HardParticle/FormFactorFullSpheroid.cpp b/Core/HardParticle/FormFactorFullSpheroid.cpp
index e6dc0f48adc21516971a605ddae18067c8574f80..6bcb7e5a66a4fae61931553c4cb98ae70ad3c412 100644
--- a/Core/HardParticle/FormFactorFullSpheroid.cpp
+++ b/Core/HardParticle/FormFactorFullSpheroid.cpp
@@ -19,14 +19,11 @@
#include "Core/Tools/MathFunctions.h"
#include <limits>
-//! Constructor of full spheroid.
-//! @param radius: radius of the circular cross section in nanometers
-//! @param height: height of the full spheroid in nanometers
FormFactorFullSpheroid::FormFactorFullSpheroid(const std::vector<double> P)
: IFormFactorBorn({"FullSpheroid",
- "class_tooltip",
- {{"Radius", "nm", "para_tooltip", 0, +INF, 0},
- {"Height", "nm", "para_tooltip", 0, +INF, 0}}},
+ "ellipsoid of revolution",
+ {{"Radius", "nm", "revolution radius", 0, +INF, 0},
+ {"Height", "nm", "height = twice the radius in non-revolution direction", 0, +INF, 0}}},
P),
m_radius(m_P[0]), m_height(m_P[1])
{
diff --git a/Core/HardParticle/FormFactorHemiEllipsoid.cpp b/Core/HardParticle/FormFactorHemiEllipsoid.cpp
index 1cac04558eba94df068c22de8fb2002e3dabe7b2..35f9c1abc3a4f004f19d8081f514fcf51a9dc8a3 100644
--- a/Core/HardParticle/FormFactorHemiEllipsoid.cpp
+++ b/Core/HardParticle/FormFactorHemiEllipsoid.cpp
@@ -19,16 +19,12 @@
#include "Core/Tools/MathFunctions.h"
#include <limits>
-//! Constructor of horizontally oriented ellipsoid, truncated at the central plane.
-//! @param radius_x: radius of the ellipse base in the x-direction, in nanometers
-//! @param radius_y: radius of the ellipse base in the y-direction, in nanometers
-//! @param height: height of the hemi ellipsoid in nanometers
FormFactorHemiEllipsoid::FormFactorHemiEllipsoid(const std::vector<double> P)
: IFormFactorBorn({"HemiEllipsoid",
- "class_tooltip",
- {{"RadiusX", "nm", "para_tooltip", 0, +INF, 0},
- {"RadiusY", "nm", "para_tooltip", 0, +INF, 0},
- {"Height", "nm", "para_tooltip", 0, +INF, 0}}},
+ "actually a spheroid, truncated at central xy plane",
+ {{"RadiusX", "nm", "radius in x direction", 0, +INF, 0},
+ {"RadiusY", "nm", "radius in y direction", 0, +INF, 0},
+ {"Height", "nm", "height = radius in z direction", 0, +INF, 0}}},
P),
m_radius_x(m_P[0]), m_radius_y(m_P[1]), m_height(m_P[2])
{
diff --git a/Core/HardParticle/FormFactorIcosahedron.cpp b/Core/HardParticle/FormFactorIcosahedron.cpp
index cc7df3aad810d759cca3d45be1f3131669fa9171..bc0975a926536a6e1ec634e2deb5100bcdd76f58 100644
--- a/Core/HardParticle/FormFactorIcosahedron.cpp
+++ b/Core/HardParticle/FormFactorIcosahedron.cpp
@@ -42,11 +42,9 @@ const PolyhedralTopology FormFactorIcosahedron::topology = {{// bottom:
{{9, 11, 10}, false}},
true};
-//! Constructor of a icosahedron.
-//! @param edge: length of the edge in nanometers
FormFactorIcosahedron::FormFactorIcosahedron(const std::vector<double> P)
: IFormFactorPolyhedron(
- {"Icosahedron", "class_tooltip", {{"Edge", "nm", "para_tooltip", 0, +INF, 0}}}, P),
+ {"Icosahedron", "regular icosahedron", {{"Edge", "nm", "edge length", 0, +INF, 0}}}, P),
m_edge(m_P[0])
{
onChange();
diff --git a/Core/HardParticle/FormFactorLongBoxGauss.h b/Core/HardParticle/FormFactorLongBoxGauss.h
index 1a3a516234853b2b9abf409d0655ab016e7a95b3..5767f562495e5cc77fd1f90b7ebde3fc2840cc6e 100644
--- a/Core/HardParticle/FormFactorLongBoxGauss.h
+++ b/Core/HardParticle/FormFactorLongBoxGauss.h
@@ -23,10 +23,6 @@
class FormFactorLongBoxGauss : public IFormFactorBorn
{
public:
- //! @brief Box constructor
- //! @param length of Box's base
- //! @param width of Box's base
- //! @param height of Box
FormFactorLongBoxGauss(const std::vector<double> P);
FormFactorLongBoxGauss(double length, double width, double height);
diff --git a/Core/HardParticle/FormFactorLongBoxLorentz.h b/Core/HardParticle/FormFactorLongBoxLorentz.h
index 90eb44699cbfdaa3060939bb89cfe7ca117314f2..ba352def93ec484cf6789aef1d3cdd7860557b66 100644
--- a/Core/HardParticle/FormFactorLongBoxLorentz.h
+++ b/Core/HardParticle/FormFactorLongBoxLorentz.h
@@ -23,10 +23,6 @@
class FormFactorLongBoxLorentz : public IFormFactorBorn
{
public:
- //! @brief Box constructor
- //! @param length of Box's base
- //! @param width of Box's base
- //! @param height of Box
FormFactorLongBoxLorentz(const std::vector<double> P);
FormFactorLongBoxLorentz(double length, double width, double height);
diff --git a/Core/HardParticle/FormFactorPrism3.cpp b/Core/HardParticle/FormFactorPrism3.cpp
index 13c2aec0ecca0bc265717dd723a57c39ceca8424..64ef456eb2f11207977ced4c189892fb0bc75ba1 100644
--- a/Core/HardParticle/FormFactorPrism3.cpp
+++ b/Core/HardParticle/FormFactorPrism3.cpp
@@ -15,14 +15,11 @@
#include "Core/HardParticle/FormFactorPrism3.h"
#include <iostream>
-//! Constructor of a prism with an equilaterial triangle base.
-//! @param base_edge: length of the base edge in nanometers
-//! @param height: height in nanometers
FormFactorPrism3::FormFactorPrism3(const std::vector<double> P)
: IFormFactorPrism({"Prism3",
- "class_tooltip",
- {{"BaseEdge", "nm", "para_tooltip", 0, +INF, 0},
- {"Height", "nm", "para_tooltip", 0, +INF, 0}}},
+ "prism with regular trigonal base",
+ {{"BaseEdge", "nm", "edge length of trigonal base", 0, +INF, 0},
+ {"Height", "nm", "height", 0, +INF, 0}}},
P),
m_base_edge(m_P[0]), m_height(m_P[1])
{
diff --git a/Core/HardParticle/FormFactorPrism6.cpp b/Core/HardParticle/FormFactorPrism6.cpp
index eb5625dfd1c2fadf0a09f349f2c1410bc8303e3a..6c2919d28e6fbf1f123eb37b18d9432c02415075 100644
--- a/Core/HardParticle/FormFactorPrism6.cpp
+++ b/Core/HardParticle/FormFactorPrism6.cpp
@@ -14,14 +14,11 @@
#include "Core/HardParticle/FormFactorPrism6.h"
-//! Constructor of a prism with a regular hexagonal base.
-//! @param base_edge: length of the hexagonal base in nanometers
-//! @param height: height in nanometers
FormFactorPrism6::FormFactorPrism6(const std::vector<double> P)
: IFormFactorPrism({"Prism6",
- "class_tooltip",
- {{"BaseEdge", "nm", "para_tooltip", 0, +INF, 0},
- {"Height", "nm", "para_tooltip", 0, +INF, 0}}},
+ "prism with regular hexagonal base",
+ {{"BaseEdge", "nm", "edge length of hexagonal base", 0, +INF, 0},
+ {"Height", "nm", "height", 0, +INF, 0}}},
P),
m_base_edge(m_P[0]), m_height(m_P[1])
{
diff --git a/Core/HardParticle/FormFactorPyramid.cpp b/Core/HardParticle/FormFactorPyramid.cpp
index 5c3f107a2e1736e60f486c1fdea14180faa2fdab..77770048588f8d015a5bd759f9e4bcc21ec3e409 100644
--- a/Core/HardParticle/FormFactorPyramid.cpp
+++ b/Core/HardParticle/FormFactorPyramid.cpp
@@ -27,16 +27,12 @@ const PolyhedralTopology FormFactorPyramid::topology = {{
},
false};
-//! Constructor of a truncated pyramid with a square base
-//! @param base_edge: length of the square base in nanometers
-//! @param height: height of the pyramid in nanometers
-//! @param alpha: dihedral angle between the base and a side face in radians
FormFactorPyramid::FormFactorPyramid(const std::vector<double> P)
: IFormFactorPolyhedron({"Pyramid",
- "class_tooltip",
- {{"BaseEdge", "nm", "para_tooltip", 0, +INF, 0},
- {"Height", "nm", "para_tooltip", 0, +INF, 0},
- {"Alpha", "rad", "para_tooltip", 0., M_PI, 0}}},
+ "frustum with quadratic base",
+ {{"BaseEdge", "nm", "base edge length", 0, +INF, 0},
+ {"Height", "nm", "height", 0, +INF, 0},
+ {"Alpha", "rad", "angle between base and a side face", 0., M_PI, 0}}},
P),
m_base_edge(m_P[0]), m_height(m_P[1]), m_alpha(m_P[2])
{
diff --git a/Core/HardParticle/FormFactorTetrahedron.cpp b/Core/HardParticle/FormFactorTetrahedron.cpp
index 86573f2e6ea3cb10be0c634c6ee14d03167a21b4..fdc669075740c82aeeedcbf3654c90bde0dedeae 100644
--- a/Core/HardParticle/FormFactorTetrahedron.cpp
+++ b/Core/HardParticle/FormFactorTetrahedron.cpp
@@ -24,16 +24,12 @@ const PolyhedralTopology FormFactorTetrahedron::topology = {{{{2, 1, 0}, false},
{{3, 4, 5}, false}},
false};
-//! Constructor of a truncated tethrahedron.
-//! @param base_edge: length of one edge of the equilateral triangular base in nanometers
-//! @param height: height of the tetrahedron in nanometers
-//! @param alpha: dihedral angle in radians between base and facet
FormFactorTetrahedron::FormFactorTetrahedron(const std::vector<double> P)
: IFormFactorPolyhedron({"Tetrahedron",
- "class_tooltip",
- {{"BaseEdge", "nm", "para_tooltip", 0, +INF, 0},
- {"Height", "nm", "para_tooltip", 0, +INF, 0},
- {"Alpha", "rad", "para_tooltip", 0., M_PI_2, 0}}},
+ "actually, not a tetrahedron, but a trigonal frustum",
+ {{"BaseEdge", "nm", "edge of base triangle", 0, +INF, 0},
+ {"Height", "nm", "height of frustum", 0, +INF, 0},
+ {"Alpha", "rad", "angle between base and a side face", 0., M_PI_2, 0}}},
P),
m_base_edge(m_P[0]), m_height(m_P[1]), m_alpha(m_P[2])
{
diff --git a/Core/HardParticle/FormFactorTruncatedCube.cpp b/Core/HardParticle/FormFactorTruncatedCube.cpp
index 1888018c6317fad6577a4ea661f1409c7f3be2a5..63f954cec90f3df4d0cf72eb4ce240cefaabb80c 100644
--- a/Core/HardParticle/FormFactorTruncatedCube.cpp
+++ b/Core/HardParticle/FormFactorTruncatedCube.cpp
@@ -32,14 +32,11 @@ const PolyhedralTopology FormFactorTruncatedCube::topology = {
{{12, 15, 16, 22, 21, 18, 19, 13}, true}},
true};
-//! Constructor of a truncated cube.
-//! @param length: length of the full cube's edge in nanometers
-//! @param removed_length: removed length from each edge of the cube in nanometers
FormFactorTruncatedCube::FormFactorTruncatedCube(const std::vector<double> P)
: IFormFactorPolyhedron({"TruncatedCube",
"class_tooltip",
- {{"Length", "nm", "para_tooltip", 0, +INF, 0},
- {"RemovedLength", "nm", "para_tooltip", 0, +INF, 0}}},
+ {{"Length", "nm", "untruncated edge length", 0, +INF, 0},
+ {"RemovedLength", "nm", "edge length removed from one corner", 0, +INF, 0}}},
P),
m_length(m_P[0]), m_removed_length(m_P[1])
{
diff --git a/Core/HardParticle/FormFactorTruncatedSphere.cpp b/Core/HardParticle/FormFactorTruncatedSphere.cpp
index 4f3f8312c426b4b7ed6e395284766d6f7ec02bfd..7543f72c8d354e998e184efb41f9199421076242 100644
--- a/Core/HardParticle/FormFactorTruncatedSphere.cpp
+++ b/Core/HardParticle/FormFactorTruncatedSphere.cpp
@@ -21,16 +21,12 @@
#include "Fit/Tools/RealLimits.h"
#include <limits>
-//! Constructor of a spherical dome.
-//! @param radius: radius of the truncated sphere in nanometers
-//! @param height: height of the truncated sphere in nanometers
-//! @param dh: length of cup truncated from the top
FormFactorTruncatedSphere::FormFactorTruncatedSphere(const std::vector<double> P)
: IFormFactorBorn({"TruncatedSphere",
"class_tooltip",
- {{"Radius", "nm", "para_tooltip", 0, +INF, 0},
- {"Height", "nm", "para_tooltip", 0, +INF, 0},
- {"DeltaHeight", "nm", "para_tooltip", 0, +INF, 0}}},
+ {{"Radius", "nm", "radius", 0, +INF, 0},
+ {"Height", "nm", "height before removal of cap", 0, +INF, 0},
+ {"DeltaHeight", "nm", "height of removed cap", 0, +INF, 0}}},
P),
m_radius(m_P[0]), m_height(m_P[1]), m_dh(m_P[2])
{
diff --git a/Core/HardParticle/FormFactorTruncatedSpheroid.cpp b/Core/HardParticle/FormFactorTruncatedSpheroid.cpp
index dcaaabfdb59596de08a197fdcb52d54e2a7af264..f6c4f547dd093539c53d366321318e5e41bf602a 100644
--- a/Core/HardParticle/FormFactorTruncatedSpheroid.cpp
+++ b/Core/HardParticle/FormFactorTruncatedSpheroid.cpp
@@ -20,18 +20,13 @@
#include "Core/Tools/MathFunctions.h"
#include <limits>
-//! Constructor of a spheroidal dome.
-//! @param radius: radius of the truncated spheroid in nanometers
-//! @param height: height of the truncated spheroid in nanometers
-//! @param height_flattening: ratio of the height of the corresponding full spheroid to its diameter
-//! @param dh: length of cup truncated from the top
FormFactorTruncatedSpheroid::FormFactorTruncatedSpheroid(const std::vector<double> P)
: IFormFactorBorn({"TruncatedSpheroid",
"class_tooltip",
- {{"Radius", "nm", "para_tooltip", 0, +INF, 0},
- {"Height", "nm", "para_tooltip", 0, +INF, 0},
- {"HeightFlattening", "", "para_tooltip", 0, +INF, 0},
- {"DeltaHeight", "nm", "para_tooltip", 0, +INF, 0}}},
+ {{"Radius", "nm", "horizontal radius", 0, +INF, 0},
+ {"Height", "nm", "height before removal of cap", 0, +INF, 0},
+ {"HeightFlattening", "", "ratio of vertical to horizontal radius", 0, +INF, 0},
+ {"DeltaHeight", "nm", "height of removed cap", 0, +INF, 0}}},
P),
m_radius(m_P[0]), m_height(m_P[1]), m_height_flattening(m_P[2]), m_dh(m_P[3])
{
diff --git a/Core/Scattering/Rotations.cpp b/Core/Scattering/Rotations.cpp
index fb499db3e0c13fcb671ffbe54cd33f103b583696..e9a0a5db57fa2a0fb3173799716e117f66eb8fa1 100644
--- a/Core/Scattering/Rotations.cpp
+++ b/Core/Scattering/Rotations.cpp
@@ -99,7 +99,6 @@ Transform3D IdentityRotation::getTransform3D() const
// ************************************************************************** //
//! Constructor of rotation around x-axis
-//! @param angle: rotation angle around x-axis in radians
RotationX::RotationX(const std::vector<double> P)
: IRotation(
{"XRotation", "class_tooltip", {{"Angle", "rad", "Angle around x axis", -INF, +INF, 0}}},
@@ -120,7 +119,6 @@ Transform3D RotationX::getTransform3D() const
// ************************************************************************** //
//! Constructor of rotation around y-axis
-//! @param angle: rotation angle around y-axis in radians
RotationY::RotationY(const std::vector<double> P)
: IRotation(
{"YRotation", "class_tooltip", {{"Angle", "rad", "Angle around y axis", -INF, +INF, 0}}},
@@ -143,7 +141,6 @@ Transform3D RotationY::getTransform3D() const
// --- RotationZ --------------------------------------------------------------
//! Constructor of rotation around z-axis
-//! @param angle: rotation angle around z-axis in radians
RotationZ::RotationZ(const std::vector<double> P)
: IRotation(
{"ZRotation", "class_tooltip", {{"Angle", "rad", "Angle around z axis", -INF, +INF, 0}}},
diff --git a/Core/Simulation/Simulation.cpp b/Core/Simulation/Simulation.cpp
index c8c3360ed7d8d4b6bccc1557e8235c6263a37665..1e7dcbe5305200f998cfb7a3c49a958568e694d4 100644
--- a/Core/Simulation/Simulation.cpp
+++ b/Core/Simulation/Simulation.cpp
@@ -301,9 +301,6 @@ void Simulation::runSingleSimulation(size_t batch_start, size_t batch_size, doub
//! 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.
-//! @param simulation: Simulation object with possible ROI and masks defined.
-//! @param data: User data with amplitudes with the shape of data matching the detector.
-//! @return SimulationResult object.
SimulationResult Simulation::convertData(const OutputData<double>& data,
bool put_masked_areas_to_zero)