diff --git a/Core/Aggregate/InterferenceFunction1DLattice.cpp b/Core/Aggregate/InterferenceFunction1DLattice.cpp index c6305ee8201037d6b283a8b3d16ff61872020727..93a23d9417de622a11a81762abae2fadd77566e7 100644 --- a/Core/Aggregate/InterferenceFunction1DLattice.cpp +++ b/Core/Aggregate/InterferenceFunction1DLattice.cpp @@ -48,7 +48,7 @@ InterferenceFunction1DLattice* InterferenceFunction1DLattice::clone() const } //! Sets one-dimensional decay function. -//! @param decay One-dimensional decay function in reciprocal space +//! @param decay: one-dimensional decay function in reciprocal space void InterferenceFunction1DLattice::setDecayFunction(const IFTDecayFunction1D& decay) { m_decay.reset(decay.clone()); diff --git a/Core/Aggregate/InterferenceFunction1DLattice.h b/Core/Aggregate/InterferenceFunction1DLattice.h index 4079382ed07354cd10fb978c501fda3ad9b40b72..4d40abb330abc63082a7c875ae90190aaa37b767 100644 --- a/Core/Aggregate/InterferenceFunction1DLattice.h +++ b/Core/Aggregate/InterferenceFunction1DLattice.h @@ -38,7 +38,7 @@ public: Lattice1DParameters getLatticeParameters() const { return m_lattice_params; } - const IFTDecayFunction1D* getDecayFunction() const { return m_decay.get(); } + const IFTDecayFunction1D* decayFunction() const { return m_decay.get(); } double evaluate(const kvector_t q) const final; diff --git a/Core/Aggregate/InterferenceFunction2DLattice.cpp b/Core/Aggregate/InterferenceFunction2DLattice.cpp index 5e0c826a425459dcb297b7a95b36466c4bbcfb2e..8c9109c032f45aca45c5b5cc989763ae3f56b471 100644 --- a/Core/Aggregate/InterferenceFunction2DLattice.cpp +++ b/Core/Aggregate/InterferenceFunction2DLattice.cpp @@ -27,16 +27,17 @@ InterferenceFunction2DLattice::InterferenceFunction2DLattice(const Lattice2D& la setLattice(lattice); } -//! @param length_1 Lattice length 1 -//! @param length_2 Lattice length 2 -//! @param angle angle between lattice vectors -//! @param xi rotation of lattice with respect to x-axis -InterferenceFunction2DLattice::InterferenceFunction2DLattice( - double length_1, double length_2, double angle, double xi) +//! Constructor of two-dimensional interference function. +//! @param length_1: length of first lattice vector +//! @param length_2: length of second lattice vector +//! @param alpha: angle between lattice vectors in radians +//! @param xi: rotation of lattice with respect to x-axis in radians +InterferenceFunction2DLattice::InterferenceFunction2DLattice(double length_1, double length_2, + double alpha, double xi) : m_na(0), m_nb(0) { setName(BornAgain::InterferenceFunction2DLatticeType); - setLattice(BasicLattice(length_1, length_2, angle, xi)); + setLattice(BasicLattice(length_1, length_2, alpha, xi)); } InterferenceFunction2DLattice::~InterferenceFunction2DLattice() @@ -48,30 +49,38 @@ InterferenceFunction2DLattice* InterferenceFunction2DLattice::clone() const return new InterferenceFunction2DLattice(*this); } +//! Creates square lattice. +//! @param lattice_length: length of first and second lattice vectors +//! @param xi: rotation of lattice with respect to x-axis in radians InterferenceFunction2DLattice* InterferenceFunction2DLattice::createSquare( double lattice_length, double xi) { return new InterferenceFunction2DLattice(SquareLattice(lattice_length, xi)); } +//! Creates hexagonal lattice. +//! @param lattice_length: length of first and second lattice vectors +//! @param xi: rotation of lattice with respect to x-axis in radians InterferenceFunction2DLattice* InterferenceFunction2DLattice::createHexagonal( double lattice_length, double xi) { return new InterferenceFunction2DLattice(HexagonalLattice(lattice_length, xi)); } -void InterferenceFunction2DLattice::setDecayFunction(const IFTDecayFunction2D &pdf) +//! Sets two-dimensional decay function. +//! @param decay: two-dimensional decay function in reciprocal space +void InterferenceFunction2DLattice::setDecayFunction(const IFTDecayFunction2D& decay) { - mp_pdf.reset(pdf.clone()); - registerChild(mp_pdf.get()); + m_decay.reset(decay.clone()); + registerChild(m_decay.get()); initialize_calc_factors(); } double InterferenceFunction2DLattice::evaluate(const kvector_t q) const { - if (!mp_pdf) + if (!m_decay) throw Exceptions::NullPointerException("InterferenceFunction2DLattice::evaluate" - " -> Error! No probability distribution function defined."); + " -> Error! No decay function defined."); double result = 0.0; double qxr = q.x(); double qyr = q.y(); @@ -104,7 +113,7 @@ double InterferenceFunction2DLattice::getParticleDensity() const std::vector<const INode*> InterferenceFunction2DLattice::getChildren() const { - return std::vector<const INode*>() << mp_pdf << m_lattice; + return std::vector<const INode*>() << m_decay << m_lattice; } void InterferenceFunction2DLattice::onChange() @@ -121,8 +130,8 @@ InterferenceFunction2DLattice::InterferenceFunction2DLattice( if(other.m_lattice) setLattice(*other.m_lattice); - if(other.mp_pdf) - setDecayFunction(*other.mp_pdf); + if(other.m_decay) + setDecayFunction(*other.m_decay); } void InterferenceFunction2DLattice::setLattice(const Lattice2D& lattice) @@ -134,15 +143,15 @@ void InterferenceFunction2DLattice::setLattice(const Lattice2D& lattice) double InterferenceFunction2DLattice::interferenceAtOneRecLatticePoint(double qx, double qy) const { - if (!mp_pdf) + if (!m_decay) throw Exceptions::NullPointerException( "InterferenceFunction2DLattice::interferenceAtOneRecLatticePoint" - " -> Error! No probability distribution function defined."); + " -> Error! No decay function defined."); double qp1, qp2; - double gamma = m_lattice->rotationAngle() + mp_pdf->getGamma(); - double delta = mp_pdf->getDelta(); + double gamma = m_lattice->rotationAngle() + m_decay->getGamma(); + double delta = m_decay->getDelta(); transformToPrincipalAxes(qx, qy, gamma, delta, qp1, qp2); - return mp_pdf->evaluate(qp1, qp2); + return m_decay->evaluate(qp1, qp2); } void InterferenceFunction2DLattice::transformToPrincipalAxes( @@ -177,18 +186,18 @@ void InterferenceFunction2DLattice::initialize_rec_vectors() void InterferenceFunction2DLattice::initialize_calc_factors() { - if (!mp_pdf) + if (!m_decay) throw Exceptions::NullPointerException( "InterferenceFunction2DLattice::initialize_calc_factors" " -> Error! No probability distribution function defined."); - double coherence_length_x = mp_pdf->getDecayLengthX(); - double coherence_length_y = mp_pdf->getDecayLengthY(); + double coherence_length_x = m_decay->getDecayLengthX(); + double coherence_length_y = m_decay->getDecayLengthY(); // number of reciprocal lattice points to use double qa_max(0.0), qb_max(0.0); - mp_pdf->transformToStarBasis(nmax / coherence_length_x, nmax / coherence_length_y, + m_decay->transformToStarBasis(nmax / coherence_length_x, nmax / coherence_length_y, m_lattice->latticeAngle(), m_lattice->length1(), m_lattice->length2(), qa_max, qb_max); m_na = std::lround(std::abs(qa_max)); diff --git a/Core/Aggregate/InterferenceFunction2DLattice.h b/Core/Aggregate/InterferenceFunction2DLattice.h index aa6b2833674b3abd9264c18f7fceb2ef9447aeae..ab3221a6d88f8a36f3a46d9ea97e486bc393b417 100644 --- a/Core/Aggregate/InterferenceFunction2DLattice.h +++ b/Core/Aggregate/InterferenceFunction2DLattice.h @@ -27,7 +27,7 @@ class BA_CORE_API_ InterferenceFunction2DLattice : public IInterferenceFunction { public: InterferenceFunction2DLattice(const Lattice2D& lattice); - InterferenceFunction2DLattice(double length_1, double length_2, double angle, double xi=0.0); + InterferenceFunction2DLattice(double length_1, double length_2, double alpha, double xi=0.0); ~InterferenceFunction2DLattice() final; InterferenceFunction2DLattice* clone() const final; @@ -37,9 +37,9 @@ public: static InterferenceFunction2DLattice* createSquare(double lattice_length, double xi = 0.0); static InterferenceFunction2DLattice* createHexagonal(double lattice_length, double xi = 0.0); - void setDecayFunction(const IFTDecayFunction2D& pdf); + void setDecayFunction(const IFTDecayFunction2D& decay); - const IFTDecayFunction2D* getDecayFunction() const { return mp_pdf.get(); } + const IFTDecayFunction2D* decayFunction() const { return m_decay.get(); } double evaluate(const kvector_t q) const final; @@ -74,7 +74,7 @@ private: //! Initializes factors needed in each calculation void initialize_calc_factors(); - std::unique_ptr<IFTDecayFunction2D> mp_pdf; + std::unique_ptr<IFTDecayFunction2D> m_decay; std::unique_ptr<Lattice2D> m_lattice; Lattice2D::ReciprocalBases m_sbase; static const int nmax = 20; //!< maximum value for qx*Lambdax and qy*lambday diff --git a/Core/Export/ExportToPython.cpp b/Core/Export/ExportToPython.cpp index dacabd843b958a8f93a09156dc93d1d4e02224e6..e06bb05fc0177abe127ea9095f38e2515ab74a2a 100644 --- a/Core/Export/ExportToPython.cpp +++ b/Core/Export/ExportToPython.cpp @@ -374,7 +374,7 @@ std::string ExportToPython::defineInterferenceFunctions() const << printNm(latticeParameters.m_length) << ", " << printDegrees(latticeParameters.m_xi) << ")\n"; - const IFTDecayFunction1D* pdf = oneDLattice->getDecayFunction(); + const IFTDecayFunction1D* pdf = oneDLattice->decayFunction(); if (pdf->decayLength() != 0.0) result << indent() << it->second << "_pdf = ba." << pdf->getName() @@ -414,7 +414,7 @@ std::string ExportToPython::defineInterferenceFunctions() const << printDegrees(lattice.latticeAngle()) << ", " << printDegrees(lattice.rotationAngle()) << ")\n"; - const IFTDecayFunction2D* pdf = twoDLattice->getDecayFunction(); + const IFTDecayFunction2D* pdf = twoDLattice->decayFunction(); result << indent() << it->second << "_pdf = ba." << pdf->getName() << "(" << argumentList(pdf) << ")\n" diff --git a/GUI/coregui/Models/TransformFromDomain.cpp b/GUI/coregui/Models/TransformFromDomain.cpp index 87467d4c4439a2afecb9655406676d588d66322a..b3f894685a55e94c3aa715eb5e4843029b8423af 100644 --- a/GUI/coregui/Models/TransformFromDomain.cpp +++ b/GUI/coregui/Models/TransformFromDomain.cpp @@ -118,7 +118,7 @@ void TransformFromDomain::setItemFromSample(SessionItem* item, item->setItemValue(InterferenceFunction1DLatticeItem::P_ROTATION_ANGLE, Units::rad2deg(lattice_params.m_xi)); - const IFTDecayFunction1D* pdf = sample->getDecayFunction(); + const IFTDecayFunction1D* pdf = sample->decayFunction(); QString group_name = InterferenceFunction1DLatticeItem::P_DECAY_FUNCTION; SetDecayFunction1D(item, pdf, group_name); } @@ -128,7 +128,7 @@ void TransformFromDomain::setItemFromSample(SessionItem* item, { set2DLatticeParameters(item, sample->lattice()); - const IFTDecayFunction2D* p_pdf = sample->getDecayFunction(); + const IFTDecayFunction2D* p_pdf = sample->decayFunction(); QString group_name = InterferenceFunction2DLatticeItem::P_DECAY_FUNCTION; SetDecayFunction2D(item, p_pdf, group_name); } diff --git a/auto/Wrap/libBornAgainCore.py b/auto/Wrap/libBornAgainCore.py index 99840206b8b0f950a559afeb328bcd142a89b3cb..6448d52f147578873a715f6e693aa089e93f3496 100644 --- a/auto/Wrap/libBornAgainCore.py +++ b/auto/Wrap/libBornAgainCore.py @@ -19950,14 +19950,9 @@ class InterferenceFunction1DLattice(IInterferenceFunction): return _libBornAgainCore.InterferenceFunction1DLattice_getLatticeParameters(self) - def getDecayFunction(self): - """ - getDecayFunction(InterferenceFunction1DLattice self) -> IFTDecayFunction1D - - const IFTDecayFunction1D* InterferenceFunction1DLattice::getDecayFunction() const - - """ - return _libBornAgainCore.InterferenceFunction1DLattice_getDecayFunction(self) + def decayFunction(self): + """decayFunction(InterferenceFunction1DLattice self) -> IFTDecayFunction1D""" + return _libBornAgainCore.InterferenceFunction1DLattice_decayFunction(self) def evaluate(self, q): @@ -20187,8 +20182,8 @@ class InterferenceFunction2DLattice(IInterferenceFunction): def __init__(self, *args): """ __init__(InterferenceFunction2DLattice self, Lattice2D lattice) -> InterferenceFunction2DLattice - __init__(InterferenceFunction2DLattice self, double length_1, double length_2, double angle, double xi=0.0) -> InterferenceFunction2DLattice - __init__(InterferenceFunction2DLattice self, double length_1, double length_2, double angle) -> InterferenceFunction2DLattice + __init__(InterferenceFunction2DLattice self, double length_1, double length_2, double alpha, double xi=0.0) -> InterferenceFunction2DLattice + __init__(InterferenceFunction2DLattice self, double length_1, double length_2, double alpha) -> InterferenceFunction2DLattice InterferenceFunction2DLattice::InterferenceFunction2DLattice(double length_1, double length_2, double angle, double xi=0.0) @@ -20262,24 +20257,19 @@ class InterferenceFunction2DLattice(IInterferenceFunction): createHexagonal = staticmethod(createHexagonal) __swig_getmethods__["createHexagonal"] = lambda x: createHexagonal - def setDecayFunction(self, pdf): + def setDecayFunction(self, decay): """ - setDecayFunction(InterferenceFunction2DLattice self, IFTDecayFunction2D pdf) + setDecayFunction(InterferenceFunction2DLattice self, IFTDecayFunction2D decay) void InterferenceFunction2DLattice::setDecayFunction(const IFTDecayFunction2D &pdf) """ - return _libBornAgainCore.InterferenceFunction2DLattice_setDecayFunction(self, pdf) + return _libBornAgainCore.InterferenceFunction2DLattice_setDecayFunction(self, decay) - def getDecayFunction(self): - """ - getDecayFunction(InterferenceFunction2DLattice self) -> IFTDecayFunction2D - - const IFTDecayFunction2D* InterferenceFunction2DLattice::getDecayFunction() const - - """ - return _libBornAgainCore.InterferenceFunction2DLattice_getDecayFunction(self) + def decayFunction(self): + """decayFunction(InterferenceFunction2DLattice self) -> IFTDecayFunction2D""" + return _libBornAgainCore.InterferenceFunction2DLattice_decayFunction(self) def evaluate(self, q): diff --git a/auto/Wrap/libBornAgainCore_wrap.cpp b/auto/Wrap/libBornAgainCore_wrap.cpp index db120ee891c99229d2081eecef1d7f2b9b72762b..0dfdfddbe1c483e58810864367225d30308643b3 100644 --- a/auto/Wrap/libBornAgainCore_wrap.cpp +++ b/auto/Wrap/libBornAgainCore_wrap.cpp @@ -87965,7 +87965,7 @@ fail: } -SWIGINTERN PyObject *_wrap_InterferenceFunction1DLattice_getDecayFunction(PyObject *SWIGUNUSEDPARM(self), PyObject *args) { +SWIGINTERN PyObject *_wrap_InterferenceFunction1DLattice_decayFunction(PyObject *SWIGUNUSEDPARM(self), PyObject *args) { PyObject *resultobj = 0; InterferenceFunction1DLattice *arg1 = (InterferenceFunction1DLattice *) 0 ; void *argp1 = 0 ; @@ -87973,13 +87973,13 @@ SWIGINTERN PyObject *_wrap_InterferenceFunction1DLattice_getDecayFunction(PyObje PyObject * obj0 = 0 ; IFTDecayFunction1D *result = 0 ; - if (!PyArg_ParseTuple(args,(char *)"O:InterferenceFunction1DLattice_getDecayFunction",&obj0)) SWIG_fail; + if (!PyArg_ParseTuple(args,(char *)"O:InterferenceFunction1DLattice_decayFunction",&obj0)) SWIG_fail; res1 = SWIG_ConvertPtr(obj0, &argp1,SWIGTYPE_p_InterferenceFunction1DLattice, 0 | 0 ); if (!SWIG_IsOK(res1)) { - SWIG_exception_fail(SWIG_ArgError(res1), "in method '" "InterferenceFunction1DLattice_getDecayFunction" "', argument " "1"" of type '" "InterferenceFunction1DLattice const *""'"); + SWIG_exception_fail(SWIG_ArgError(res1), "in method '" "InterferenceFunction1DLattice_decayFunction" "', argument " "1"" of type '" "InterferenceFunction1DLattice const *""'"); } arg1 = reinterpret_cast< InterferenceFunction1DLattice * >(argp1); - result = (IFTDecayFunction1D *)((InterferenceFunction1DLattice const *)arg1)->getDecayFunction(); + result = (IFTDecayFunction1D *)((InterferenceFunction1DLattice const *)arg1)->decayFunction(); resultobj = SWIG_NewPointerObj(SWIG_as_voidptr(result), SWIGTYPE_p_IFTDecayFunction1D, 0 | 0 ); return resultobj; fail: @@ -89034,7 +89034,7 @@ fail: } -SWIGINTERN PyObject *_wrap_InterferenceFunction2DLattice_getDecayFunction(PyObject *SWIGUNUSEDPARM(self), PyObject *args) { +SWIGINTERN PyObject *_wrap_InterferenceFunction2DLattice_decayFunction(PyObject *SWIGUNUSEDPARM(self), PyObject *args) { PyObject *resultobj = 0; InterferenceFunction2DLattice *arg1 = (InterferenceFunction2DLattice *) 0 ; void *argp1 = 0 ; @@ -89042,13 +89042,13 @@ SWIGINTERN PyObject *_wrap_InterferenceFunction2DLattice_getDecayFunction(PyObje PyObject * obj0 = 0 ; IFTDecayFunction2D *result = 0 ; - if (!PyArg_ParseTuple(args,(char *)"O:InterferenceFunction2DLattice_getDecayFunction",&obj0)) SWIG_fail; + if (!PyArg_ParseTuple(args,(char *)"O:InterferenceFunction2DLattice_decayFunction",&obj0)) SWIG_fail; res1 = SWIG_ConvertPtr(obj0, &argp1,SWIGTYPE_p_InterferenceFunction2DLattice, 0 | 0 ); if (!SWIG_IsOK(res1)) { - SWIG_exception_fail(SWIG_ArgError(res1), "in method '" "InterferenceFunction2DLattice_getDecayFunction" "', argument " "1"" of type '" "InterferenceFunction2DLattice const *""'"); + SWIG_exception_fail(SWIG_ArgError(res1), "in method '" "InterferenceFunction2DLattice_decayFunction" "', argument " "1"" of type '" "InterferenceFunction2DLattice const *""'"); } arg1 = reinterpret_cast< InterferenceFunction2DLattice * >(argp1); - result = (IFTDecayFunction2D *)((InterferenceFunction2DLattice const *)arg1)->getDecayFunction(); + result = (IFTDecayFunction2D *)((InterferenceFunction2DLattice const *)arg1)->decayFunction(); resultobj = SWIG_NewPointerObj(SWIG_as_voidptr(result), SWIGTYPE_p_IFTDecayFunction2D, 0 | 0 ); return resultobj; fail: @@ -119318,12 +119318,7 @@ static PyMethodDef SwigMethods[] = { "Lattice1DParameters InterferenceFunction1DLattice::getLatticeParameters() const \n" "\n" ""}, - { (char *)"InterferenceFunction1DLattice_getDecayFunction", _wrap_InterferenceFunction1DLattice_getDecayFunction, METH_VARARGS, (char *)"\n" - "InterferenceFunction1DLattice_getDecayFunction(InterferenceFunction1DLattice self) -> IFTDecayFunction1D\n" - "\n" - "const IFTDecayFunction1D* InterferenceFunction1DLattice::getDecayFunction() const \n" - "\n" - ""}, + { (char *)"InterferenceFunction1DLattice_decayFunction", _wrap_InterferenceFunction1DLattice_decayFunction, METH_VARARGS, (char *)"InterferenceFunction1DLattice_decayFunction(InterferenceFunction1DLattice self) -> IFTDecayFunction1D"}, { (char *)"InterferenceFunction1DLattice_evaluate", _wrap_InterferenceFunction1DLattice_evaluate, METH_VARARGS, (char *)"\n" "InterferenceFunction1DLattice_evaluate(InterferenceFunction1DLattice self, kvector_t q) -> double\n" "\n" @@ -119440,8 +119435,8 @@ static PyMethodDef SwigMethods[] = { { (char *)"InterferenceFunctionRadialParaCrystal_swigregister", InterferenceFunctionRadialParaCrystal_swigregister, METH_VARARGS, NULL}, { (char *)"new_InterferenceFunction2DLattice", _wrap_new_InterferenceFunction2DLattice, METH_VARARGS, (char *)"\n" "InterferenceFunction2DLattice(Lattice2D lattice)\n" - "InterferenceFunction2DLattice(double length_1, double length_2, double angle, double xi=0.0)\n" - "new_InterferenceFunction2DLattice(double length_1, double length_2, double angle) -> InterferenceFunction2DLattice\n" + "InterferenceFunction2DLattice(double length_1, double length_2, double alpha, double xi=0.0)\n" + "new_InterferenceFunction2DLattice(double length_1, double length_2, double alpha) -> InterferenceFunction2DLattice\n" "\n" "InterferenceFunction2DLattice::InterferenceFunction2DLattice(double length_1, double length_2, double angle, double xi=0.0)\n" "\n" @@ -119492,17 +119487,12 @@ static PyMethodDef SwigMethods[] = { "InterferenceFunction2DLattice_createHexagonal(double lattice_length) -> InterferenceFunction2DLattice\n" ""}, { (char *)"InterferenceFunction2DLattice_setDecayFunction", _wrap_InterferenceFunction2DLattice_setDecayFunction, METH_VARARGS, (char *)"\n" - "InterferenceFunction2DLattice_setDecayFunction(InterferenceFunction2DLattice self, IFTDecayFunction2D pdf)\n" + "InterferenceFunction2DLattice_setDecayFunction(InterferenceFunction2DLattice self, IFTDecayFunction2D decay)\n" "\n" "void InterferenceFunction2DLattice::setDecayFunction(const IFTDecayFunction2D &pdf)\n" "\n" ""}, - { (char *)"InterferenceFunction2DLattice_getDecayFunction", _wrap_InterferenceFunction2DLattice_getDecayFunction, METH_VARARGS, (char *)"\n" - "InterferenceFunction2DLattice_getDecayFunction(InterferenceFunction2DLattice self) -> IFTDecayFunction2D\n" - "\n" - "const IFTDecayFunction2D* InterferenceFunction2DLattice::getDecayFunction() const \n" - "\n" - ""}, + { (char *)"InterferenceFunction2DLattice_decayFunction", _wrap_InterferenceFunction2DLattice_decayFunction, METH_VARARGS, (char *)"InterferenceFunction2DLattice_decayFunction(InterferenceFunction2DLattice self) -> IFTDecayFunction2D"}, { (char *)"InterferenceFunction2DLattice_evaluate", _wrap_InterferenceFunction2DLattice_evaluate, METH_VARARGS, (char *)"\n" "InterferenceFunction2DLattice_evaluate(InterferenceFunction2DLattice self, kvector_t q) -> double\n" "\n"