File: DistributionItems.cpp

package info (click to toggle)
bornagain 23.0-4
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 103,936 kB
  • sloc: cpp: 423,131; python: 40,997; javascript: 11,167; awk: 630; sh: 318; ruby: 173; xml: 130; makefile: 51; ansic: 24
file content (375 lines) | stat: -rw-r--r-- 12,130 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      GUI/Model/Beam/DistributionItems.cpp
//! @brief     Implements class DistributionItem and several subclasses.
//!
//! @homepage  http://www.bornagainproject.org
//! @license   GNU General Public License v3 or higher (see COPYING)
//! @copyright Forschungszentrum Jülich GmbH 2022
//! @authors   Scientific Computing Group at MLZ (see CITATION, AUTHORS)
//
//  ************************************************************************************************

#include "GUI/Model/Beam/DistributionItems.h"
#include "GUI/Model/Util/UtilXML.h"
#include "Param/Distrib/Distributions.h"

namespace {
namespace Tag {

const QString BaseData("BaseData");
const QString Center("Center");
const QString Halfwidth("Halfwidth");
const QString HWHM("HWHM");
const QString LeftWidth("LeftWidth");
const QString Maximum("Maximum");
const QString Mean("Mean");
const QString Median("Median");
const QString MiddleWidth("MiddleWidth");
const QString Minimum("Minimum");
const QString NumberOfSamples("NumberOfSamples");
const QString RelSamplingWidth("RelSamplingWidth");
const QString RightWidth("RightWidth");
const QString ScaleParameter("ScaleParameter");
const QString Sigma("Sigma");
const QString StandardDeviation("StandardDeviation");

} // namespace Tag
} // namespace


DistributionItem::DistributionItem()
{
    m_rel_sampling_width.init("Rel. sampling width", "", "", 2.0, 3, RealLimits::nonnegative(),
                              "relSamplingWidth");
}

void DistributionItem::writeTo(QXmlStreamWriter* w) const
{
    XML::writeTaggedValue(w, Tag::NumberOfSamples, m_number_of_samples);

    // relative sampling width
    m_rel_sampling_width.writeTo2(w, Tag::RelSamplingWidth);
}

void DistributionItem::readFrom(QXmlStreamReader* r)
{
    while (r->readNextStartElement()) {
        QString tag = r->name().toString();
        if (tag == Tag::NumberOfSamples)
            m_number_of_samples = XML::readTaggedUInt(r, tag);
        else if (tag == Tag::RelSamplingWidth)
            m_rel_sampling_width.readFrom2(r, tag);
        else
            r->skipCurrentElement();
    }
}

// --------------------------------------------------------------------------------------------- //

SymmetricDistributionItem::SymmetricDistributionItem(double mean, int decimals,
                                                     const QString& meanLabel)
{
    m_mean.init(meanLabel, "", "", mean, decimals, RealLimits::limitless(), "mean");
}

const QString& SymmetricDistributionItem::units()
{
    return m_mean.units();
}

void SymmetricDistributionItem::setUnits(const QString& units)
{
    m_mean.setUnits(units);
}

void SymmetricDistributionItem::writeTo(QXmlStreamWriter* w) const
{
    XML::writeBaseElement<DistributionItem>(w, XML::Tag::BaseData, this);

    // mean
    m_mean.writeTo2(w, Tag::Mean);
}

void SymmetricDistributionItem::readFrom(QXmlStreamReader* r)
{
    while (r->readNextStartElement()) {
        QString tag = r->name().toString();
        if (tag == Tag::BaseData)
            XML::readBaseElement<DistributionItem>(r, tag, this);
        else if (tag == Tag::Mean)
            m_mean.readFrom2(r, tag);
        else
            r->skipCurrentElement();
    }
}

// --------------------------------------------------------------------------------------------- //

DistributionDeltaItem::DistributionDeltaItem()
    : SymmetricDistributionItem(0., 3, "Value")
{
}

std::unique_ptr<IDistribution1D> DistributionDeltaItem::createDistribution(double) const
{
    return {};
}

DoubleProperties DistributionDeltaItem::distributionValues(bool withMean)
{
    return withMean ? DoubleProperties{&m_mean} : DoubleProperties{};
}

// --------------------------------------------------------------------------------------------- //

DistributionGateItem::DistributionGateItem()
{
    m_center.init("Center", "", "", 0.0, 3, RealLimits::limitless(), "");
    m_halfwidth.init("Half width", "", "", 1.0, 3, RealLimits::nonnegative(), "");
}

std::unique_ptr<IDistribution1D> DistributionGateItem::createDistribution(double scale) const
{
    return std::make_unique<DistributionGate>(scale * (m_center.dVal() - m_halfwidth.dVal()),
                                              scale * (m_center.dVal() + m_halfwidth.dVal()),
                                              m_number_of_samples);
}

const QString& DistributionGateItem::units()
{
    return m_center.units();
}

void DistributionGateItem::setUnits(const QString& units)
{
    m_center.setUnits(units);
    m_halfwidth.setUnits(units);
}

void DistributionGateItem::writeTo(QXmlStreamWriter* w) const
{
    XML::writeBaseElement<DistributionItem>(w, XML::Tag::BaseData, this);
    m_center.writeTo2(w, Tag::Center);
    m_halfwidth.writeTo2(w, Tag::Halfwidth);
}

void DistributionGateItem::readFrom(QXmlStreamReader* r)
{
    while (r->readNextStartElement()) {
        QString tag = r->name().toString();
        if (tag == Tag::BaseData)
            XML::readBaseElement<DistributionItem>(r, tag, this);
        else if (tag == Tag::Center)
            m_center.readFrom2(r, tag);
        else if (tag == Tag::Halfwidth)
            m_halfwidth.readFrom2(r, tag);
        else
            r->skipCurrentElement();
    }
}

DoubleProperties DistributionGateItem::distributionValues(bool withMean)
{
    return withMean ? DoubleProperties{&m_center, &m_halfwidth} : DoubleProperties{&m_halfwidth};
}

// --------------------------------------------------------------------------------------------- //

DistributionLorentzItem::DistributionLorentzItem()
    : SymmetricDistributionItem(0)
{
    m_hwhm.init("HWHM", "", "", 1.0, 3, RealLimits::nonnegative(), "hwhm");
}

std::unique_ptr<IDistribution1D> DistributionLorentzItem::createDistribution(double scale) const
{
    return std::make_unique<DistributionLorentz>(scale * m_mean.dVal(), scale * m_hwhm.dVal(),
                                                 m_number_of_samples, m_rel_sampling_width.dVal());
}

void DistributionLorentzItem::setUnits(const QString& units)
{
    SymmetricDistributionItem::setUnits(units);
    m_hwhm.setUnits(units);
}

void DistributionLorentzItem::writeTo(QXmlStreamWriter* w) const
{
    XML::writeBaseElement<SymmetricDistributionItem>(w, XML::Tag::BaseData, this);

    // half width at half maximum
    m_hwhm.writeTo2(w, Tag::HWHM);
}

void DistributionLorentzItem::readFrom(QXmlStreamReader* r)
{
    while (r->readNextStartElement()) {
        QString tag = r->name().toString();
        if (tag == Tag::BaseData)
            XML::readBaseElement<SymmetricDistributionItem>(r, tag, this);
        else if (tag == Tag::HWHM)
            m_hwhm.readFrom2(r, tag);
        else
            r->skipCurrentElement();
    }
}

DoubleProperties DistributionLorentzItem::distributionValues(bool withMean)
{
    return withMean ? DoubleProperties{&m_mean, &m_hwhm, &m_rel_sampling_width}
                    : DoubleProperties{&m_hwhm, &m_rel_sampling_width};
}

// --------------------------------------------------------------------------------------------- //

DistributionGaussianItem::DistributionGaussianItem()
    : SymmetricDistributionItem(0)
{
    m_standard_deviation.init("StdDev", "", "", 1.0, 3, RealLimits::nonnegative(), "stdDev");
}

std::unique_ptr<IDistribution1D> DistributionGaussianItem::createDistribution(double scale) const
{
    return std::make_unique<DistributionGaussian>(scale * m_mean.dVal(),
                                                  scale * m_standard_deviation.dVal(),
                                                  m_number_of_samples, m_rel_sampling_width.dVal());
}

void DistributionGaussianItem::setUnits(const QString& units)
{
    SymmetricDistributionItem::setUnits(units);
    m_standard_deviation.setUnits(units);
}

void DistributionGaussianItem::writeTo(QXmlStreamWriter* w) const
{
    XML::writeBaseElement<SymmetricDistributionItem>(w, XML::Tag::BaseData, this);

    // standard deviation
    m_standard_deviation.writeTo2(w, Tag::StandardDeviation);
}

void DistributionGaussianItem::readFrom(QXmlStreamReader* r)
{
    while (r->readNextStartElement()) {
        QString tag = r->name().toString();
        if (tag == Tag::BaseData)
            XML::readBaseElement<SymmetricDistributionItem>(r, tag, this);
        else if (tag == Tag::StandardDeviation)
            m_standard_deviation.readFrom2(r, tag);
        else
            r->skipCurrentElement();
    }
}

DoubleProperties DistributionGaussianItem::distributionValues(bool withMean)
{
    return withMean ? DoubleProperties{&m_mean, &m_standard_deviation, &m_rel_sampling_width}
                    : DoubleProperties{&m_standard_deviation, &m_rel_sampling_width};
}

// --------------------------------------------------------------------------------------------- //

DistributionLogNormalItem::DistributionLogNormalItem()
{
    m_median.init("Median", "", "", 1.0, "median");
    m_scale_parameter.init("ScaleParameter", "", "", 0.5, 3, RealLimits::positive(), "scalePar");
}

std::unique_ptr<IDistribution1D> DistributionLogNormalItem::createDistribution(double scale) const
{
    return std::make_unique<DistributionLogNormal>(scale * m_median.dVal(),
                                                   m_scale_parameter.dVal(), m_number_of_samples,
                                                   m_rel_sampling_width.dVal());
}

const QString& DistributionLogNormalItem::units()
{
    return m_median.units();
}

void DistributionLogNormalItem::setUnits(const QString& units)
{
    m_median.setUnits(units);
}

void DistributionLogNormalItem::writeTo(QXmlStreamWriter* w) const
{
    XML::writeBaseElement<DistributionItem>(w, XML::Tag::BaseData, this);

    // median
    m_median.writeTo2(w, Tag::Median);

    // scale parameter
    m_scale_parameter.writeTo2(w, Tag::ScaleParameter);
}

void DistributionLogNormalItem::readFrom(QXmlStreamReader* r)
{
    while (r->readNextStartElement()) {
        QString tag = r->name().toString();
        if (tag == Tag::BaseData)
            XML::readBaseElement<DistributionItem>(r, tag, this);
        else if (tag == Tag::Median)
            m_median.readFrom2(r, tag);
        else if (tag == Tag::ScaleParameter)
            m_scale_parameter.readFrom2(r, tag);
        else
            r->skipCurrentElement();
    }
}

DoubleProperties DistributionLogNormalItem::distributionValues(bool withMean)
{
    return withMean ? DoubleProperties{&m_median, &m_scale_parameter, &m_rel_sampling_width}
                    : DoubleProperties{&m_scale_parameter, &m_rel_sampling_width};
}

// --------------------------------------------------------------------------------------------- //

DistributionCosineItem::DistributionCosineItem()
    : SymmetricDistributionItem(0)
{
    m_hwhm.init("HWHM", "", "", 1.0, 3, RealLimits::nonnegative(), "hwhm");
}

std::unique_ptr<IDistribution1D> DistributionCosineItem::createDistribution(double scale) const
{
    return std::make_unique<DistributionCosine>(scale * m_mean.dVal(), scale * m_hwhm.dVal(),
                                                m_number_of_samples);
}

void DistributionCosineItem::setUnits(const QString& units)
{
    SymmetricDistributionItem::setUnits(units);
    m_hwhm.setUnits(units);
}

void DistributionCosineItem::writeTo(QXmlStreamWriter* w) const
{
    XML::writeBaseElement<SymmetricDistributionItem>(w, XML::Tag::BaseData, this);

    // sigma
    m_hwhm.writeTo2(w, Tag::Sigma);
}

void DistributionCosineItem::readFrom(QXmlStreamReader* r)
{
    while (r->readNextStartElement()) {
        QString tag = r->name().toString();
        if (tag == Tag::BaseData)
            XML::readBaseElement<SymmetricDistributionItem>(r, tag, this);
        else if (tag == Tag::Sigma)
            m_hwhm.readFrom2(r, tag);
        else
            r->skipCurrentElement();
    }
}

DoubleProperties DistributionCosineItem::distributionValues(bool withMean)
{
    return withMean ? DoubleProperties{&m_mean, &m_hwhm} : DoubleProperties{&m_hwhm};
}