File: test_pattern.py

package info (click to toggle)
python-xypattern 1.1.2-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 348 kB
  • sloc: python: 1,050; makefile: 4
file content (468 lines) | stat: -rw-r--r-- 14,371 bytes parent folder | download
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
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
# -*- coding: utf-8 -*-
# Dioptas - GUI program for fast processing of 2D X-ray diffraction data
# Principal author: Clemens Prescher (clemens.prescher@gmail.com)
# Copyright (C) 2014-2019 GSECARS, University of Chicago, USA
# Copyright (C) 2015-2018 Institute for Geology and Mineralogy, University of Cologne, Germany
# Copyright (C) 2019-2020 DESY, Hamburg, Germany
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
import os
import numpy as np
import pytest
from pytest import approx
from xypattern.auto_background import SmoothBrucknerBackground

from xypattern.pattern import BkgNotInRangeError
from xypattern import Pattern

from .test_util import generate_peak_pattern, gaussian

unittest_path = os.path.dirname(__file__)
data_path = os.path.join(unittest_path, "data")


def test_loading_chi_file():
    pattern = Pattern()
    x, y = pattern.data

    pattern.load(os.path.join(data_path, "pattern_001.chi"))
    new_x, new_y = pattern.data

    assert len(x) != len(new_x)
    assert len(y) != len(new_y)
    assert pattern.name == "pattern_001"
    assert pattern.filename == os.path.join(data_path, "pattern_001.chi")


def test_loading_invalid_file():
    pattern = Pattern()
    with pytest.raises(ValueError):
        pattern.load(os.path.join(data_path, "wrong_file_format.txt"))


def test_loading_from_file_chi():
    pattern = Pattern.from_file(os.path.join(data_path, "pattern_001.chi"))
    assert len(pattern.x) == 75
    assert len(pattern.y) == 75
    assert pattern.name == "pattern_001"
    assert pattern.filename == os.path.join(data_path, "pattern_001.chi")


def test_loading_from_file_invalid():
    with pytest.raises(ValueError):
        Pattern.from_file(os.path.join(data_path, "wrong_file_format.txt"))


def test_saving_a_dat_file(tmp_path):
    x = np.linspace(-5, 5, 100)
    y = x**2
    pattern = Pattern(x, y)
    filename = os.path.join(tmp_path, "test.dat")
    pattern.save(filename)

    pattern2 = Pattern()
    pattern2.load(filename)

    pattern2_x, pattern2_y = pattern2.data
    assert pattern2_x == pytest.approx(x)
    assert pattern2_y == pytest.approx(y)


def test_saving_a_chi_file(tmp_path):
    x = np.linspace(-5, 5, 100)
    y = x**2
    pattern = Pattern(x, y)
    filename = os.path.join(tmp_path, "test.chi")
    pattern.save(filename)

    pattern2 = Pattern()
    pattern2.load(filename)

    pattern2_x, pattern2_y = pattern2.data
    assert pattern2_x == pytest.approx(x)
    assert pattern2_y == pytest.approx(y)

    with open(filename) as f:
        lines = f.readlines()
        assert lines[0].endswith("test.chi\n")
        assert lines[1] == "2th_deg\n"
        assert lines[3].endswith(f"{len(pattern2_x)}\n")


def test_saving_a_fxye_file(tmp_path):
    x = np.linspace(-5, 5, 100)
    y = x**2
    pattern = Pattern(x, y)
    filename = os.path.join(tmp_path, "test.fxye")
    pattern.save(filename)


def test_saving_a_chi_file_with_background(tmp_path):
    x = np.linspace(-5, 5, 100)
    y = x**2

    pattern = Pattern(x, y)
    pattern.background_pattern = Pattern(x, x)
    filename = os.path.join(tmp_path, "test.chi")
    pattern.save(filename, subtract_background=True)

    assert os.path.exists(filename)
    pattern_saved = Pattern.from_file(filename)
    assert pattern_saved.background_pattern is None
    assert pattern_saved.x == pytest.approx(x)
    assert pattern_saved.y == pytest.approx(y - x)


def test_saving_a_chi_file_with_auto_bkg(tmp_path):
    x = np.linspace(-5, 5, 100)
    y = x**2

    pattern = Pattern(x, y)
    pattern.auto_bkg = SmoothBrucknerBackground()
    filename = os.path.join(tmp_path, "test.chi")
    pattern.save(filename, subtract_background=True)

    assert os.path.exists(filename)
    pattern_saved = Pattern.from_file(filename)
    assert pattern_saved.background_pattern is None
    assert pattern_saved.x == pytest.approx(x)
    assert pattern_saved.y == pytest.approx(y - pattern.auto_background_pattern.y)


def test_saving_a_chi_file_with_auto_bkg_and_subtract_background_false(tmp_path):
    x = np.linspace(-5, 5, 100)
    y = x**2

    pattern = Pattern(x, y)
    pattern.auto_bkg = SmoothBrucknerBackground()
    filename = os.path.join(tmp_path, "test.chi")
    pattern.save(filename, subtract_background=False)

    assert os.path.exists(filename)
    pattern_saved = Pattern.from_file(filename)
    assert pattern_saved.background_pattern is None
    assert pattern_saved.x == pytest.approx(x)
    assert pattern_saved.y == pytest.approx(y)


def test_plus_and_minus_operators():
    x = np.linspace(0, 10, 100)
    pattern1 = Pattern(x, np.sin(x))
    pattern2 = Pattern(x, np.sin(x))

    pattern3 = pattern1 + pattern2
    assert np.array_equal(pattern3.y, np.sin(x) * 2)
    assert np.array_equal(pattern2._original_y, np.sin(x) * 1)
    assert np.array_equal(pattern1._original_y, np.sin(x) * 1)

    pattern3 = pattern1 + pattern1
    assert np.array_equal(pattern3.y, np.sin(x) * 2)
    assert np.array_equal(pattern1._original_y, np.sin(x) * 1)
    assert np.array_equal(pattern1._original_y, np.sin(x) * 1)

    pattern3 = pattern2 - pattern1
    assert np.array_equal(pattern3.y, np.sin(x) * 0)
    assert np.array_equal(pattern2._original_y, np.sin(x) * 1)
    assert np.array_equal(pattern1._original_y, np.sin(x) * 1)

    pattern3 = pattern1 - pattern1
    assert np.array_equal(pattern3.y, np.sin(x) * 0)
    assert np.array_equal(pattern1._original_y, np.sin(x) * 1)
    assert np.array_equal(pattern1._original_y, np.sin(x) * 1)


def test_plus_and_minus_operators_with_different_shapes():
    x = np.linspace(0, 10, 1000)
    x2 = np.linspace(0, 12, 1300)
    pattern1 = Pattern(x, np.sin(x))
    pattern2 = Pattern(x2, np.sin(x2))
    pattern3 = pattern1 + pattern2

    assert pattern3.x == approx(pattern1._original_x)
    assert pattern3.y == approx(pattern1._original_y * 2, abs=1e-4)

    pattern3 = pattern1 + pattern1
    assert pattern3.y == approx(np.sin(x) * 2, abs=1e-4)

    pattern3 = pattern1 - pattern2
    assert pattern3.y == approx(np.sin(x) * 0, abs=1e-4)

    pattern3 = pattern1 - pattern1
    assert pattern3.y == approx(np.sin(x) * 0, abs=1e-4)


def test_multiply_with_scalar_operator():
    x = np.linspace(0, 10, 100)
    pattern = 2 * Pattern(x, np.sin(x))
    assert np.array_equal(pattern.y, np.sin(x) * 2)


def test_using_background_pattern():
    x = np.linspace(-5, 5, 100)
    pattern_y = x**2
    bkg_y = x

    spec = Pattern(x, pattern_y)
    background_pattern = Pattern(x, bkg_y)

    spec.background_pattern = background_pattern
    new_x, new_y = spec.data

    assert np.array_equal(new_x, x)
    assert np.array_equal(new_y, pattern_y - bkg_y)


def test_using_background_pattern_with_different_spacing():
    x = np.linspace(-5, 5, 100)
    pattern_y = x**2
    x_bkg = np.linspace(-5, 5, 99)
    bkg_y = x_bkg

    spec = Pattern(x, pattern_y)
    background_pattern = Pattern(x_bkg, bkg_y)

    spec.background_pattern = background_pattern
    new_x, new_y = spec.data

    assert np.array_equal(new_x, x)
    assert np.array_equal(new_y, pattern_y - x)


def test_changing_the_background_pattern_parameters():
    x = np.linspace(-5, 5, 100)
    pattern_y = x**2
    bkg_y = x

    spec = Pattern(x, pattern_y)
    background_pattern = Pattern(x, bkg_y)

    spec.background_pattern = background_pattern
    new_x, new_y = spec.data

    assert np.array_equal(new_x, x)
    assert np.array_equal(new_y, pattern_y - bkg_y)

    background_pattern.offset = 100
    new_x, new_y = spec.data
    assert np.array_equal(background_pattern.y, bkg_y + 100)
    assert np.array_equal(background_pattern.data[1], bkg_y + 100)
    assert np.array_equal(new_y, pattern_y - (bkg_y + 100))


def test_changing_the_background_pattern_to_new_background():
    x = np.linspace(-5, 5, 100)
    pattern_y = x**2
    bkg_y = x

    pattern = Pattern(x, pattern_y)
    background_pattern = Pattern(x, bkg_y)

    pattern.background_pattern = background_pattern
    assert len(background_pattern.changed.listeners) == 1

    background_pattern2 = Pattern(x, bkg_y + 100)
    pattern.background_pattern = background_pattern2
    assert len(background_pattern.changed.listeners) == 0
    assert len(background_pattern2.changed.listeners) == 1

    pattern.background_pattern = None
    assert len(background_pattern.changed.listeners) == 0
    assert len(background_pattern2.changed.listeners) == 0


def test_background_out_of_range_throws_error():
    x1 = np.linspace(0, 10)
    x2 = np.linspace(-10, -1)

    spec = Pattern(x1, x1)
    background_pattern = Pattern(x2, x2)

    with pytest.raises(BkgNotInRangeError):
        spec.background_pattern = background_pattern


def test_automatic_background_subtraction():
    pattern, y_bkg = generate_peak_pattern(with_bkg=True)
    without_bkg_y = pattern.y - y_bkg

    pattern.auto_bkg = SmoothBrucknerBackground(2, 50, 50)

    _, y_spec = pattern.data
    assert y_spec == approx(without_bkg_y, abs=1e-4)


def test_automatic_background_subtraction_with_roi():
    pattern = generate_peak_pattern()
    roi = [1, 23]
    pattern.auto_bkg_roi = roi
    pattern.auto_bkg = SmoothBrucknerBackground(2, 50, 50)

    x_spec, _ = pattern.data

    assert x_spec[0] > roi[0]
    assert x_spec[-1] < roi[1]


def test_setting_new_data():
    spec = Pattern()
    x = np.linspace(0, 10)
    y = np.sin(x)
    spec.data = x, y

    new_x, new_y = spec.data
    assert np.array_equal(new_x, x)
    assert np.array_equal(new_y, y)


def test_using_len():
    x = np.linspace(0, 10, 234)
    y = x**2
    spec = Pattern(x, y)

    assert len(spec) == 234


def test_scaling():
    x = np.linspace(0, 10, 100)
    pattern = Pattern(x, np.sin(x))
    pattern.scaling = 2
    assert np.array_equal(pattern.y, np.sin(x) * 2)


def test_multiply_operator():
    x = np.linspace(0, 10, 100)
    pattern = 2 * Pattern(x, np.sin(x))

    assert np.array_equal(pattern._original_y, np.sin(x) * 2)


def test_equality_operator():
    x = np.linspace(0, 10, 100)
    pattern1 = Pattern(x, np.sin(x))
    pattern2 = Pattern(x, np.sin(2 * x))

    assert pattern1 == pattern1
    assert pattern1 != pattern2


def test_binning():
    x = np.linspace(2.8, 10.8, 100)
    pattern = Pattern(x, np.sin(x))
    binned_pattern = pattern.rebin(1)
    assert np.sum(binned_pattern.y), np.sum(pattern.y)


def test_extend_to():
    x = np.arange(2.8, 10, 0.2)

    pattern = Pattern(x, x - 2)
    extended_pattern = pattern.extend_to(0, 0)

    assert np.sum(extended_pattern.limit(0, 2.7).y) == approx(0)
    assert extended_pattern.x[0] == approx(0)

    pos_extended_pattern = pattern.extend_to(20, 5)

    assert np.mean(pos_extended_pattern.limit(10.1, 21).y) == 5
    assert pos_extended_pattern.x[-1] == approx(20)


def test_to_dict():
    pattern = Pattern(np.arange(10), np.arange(10))
    pattern.name = "test"
    pattern.scaling = 3
    pattern.smoothing = 2
    pattern._background_pattern = Pattern(np.arange(10), np.arange(10))
    pattern_json = pattern.to_dict()
    assert pattern_json["x"] == list(pattern._original_x)
    assert pattern_json["y"] == list(pattern._original_y)
    assert pattern_json["name"] == pattern.name
    assert pattern_json["scaling"] == pattern.scaling
    assert pattern_json["smoothing"] == pattern.smoothing
    assert pattern_json["bkg_pattern"] == pattern._background_pattern.to_dict()


def test_from_dict():
    pattern1 = Pattern(np.arange(10), np.arange(10))
    pattern1.name = "test"
    pattern1.scaling = 3
    pattern1.smoothing = 2
    pattern1.background_pattern = Pattern(np.arange(10), np.arange(10))
    pattern_json = pattern1.to_dict()

    pattern2 = Pattern.from_dict(pattern_json)
    assert np.array_equal(pattern1.x, pattern2.x)
    assert np.array_equal(pattern1.y, pattern2.y)
    assert pattern1.name == pattern2.name
    assert pattern1.scaling == pattern2.scaling
    assert pattern1.smoothing == pattern2.smoothing
    assert np.array_equal(
        pattern1._background_pattern.x, pattern2._background_pattern.x
    )
    assert np.array_equal(
        pattern1._background_pattern.y, pattern2._background_pattern.y
    )


def test_str_representation():
    pattern = Pattern(np.arange(10), np.arange(10), name="test")
    assert str(pattern) == "Pattern 'test' with 10 points"


def test_delete_range():
    pattern = Pattern(np.arange(11), np.arange(11), name="test")
    pattern = pattern.delete_range([2.3, 7.9])
    assert np.array_equal(pattern.x, np.array([0, 1, 2, 8, 9, 10]))
    assert np.array_equal(pattern.y, np.array([0, 1, 2, 8, 9, 10]))


def test_delete_ranges():
    pattern = Pattern(np.arange(31), np.arange(31), name="test")
    pattern = pattern.delete_ranges([[4.4, 13.3]])
    assert np.array_equal(pattern.x, np.concatenate((np.arange(5), np.arange(14, 31))))

    pattern = pattern.delete_ranges(
        [[3.9, 13.6], [4.5, 14.4], [21.5, 24.9], [27.1, 29.5]]
    )
    assert np.array_equal(
        pattern.x,
        np.concatenate(
            (np.arange(4), np.arange(15, 22), np.arange(25, 28), np.array([30]))
        ),
    )


def test_transform_x():
    x = np.linspace(0, 10, 100)
    pattern = Pattern(x, np.sin(x))
    pattern.transform_x(lambda x: x + 2)
    assert np.array_equal(pattern.x, x + 2)


def test_transform_x_with_pattern_bkg():
    x = np.linspace(0, 10, 100)
    pattern = Pattern(x, np.sin(x))
    pattern.background_pattern = Pattern(x, np.cos(x))
    pattern.transform_x(lambda x: x + 2)

    assert np.array_equal(pattern.x, x + 2)
    assert np.array_equal(pattern.background_pattern.x, x + 2)


def test_transform_x_with_auto_bkg():
    x = np.linspace(0, 10, 100)
    pattern = Pattern(x, np.sin(x))
    pattern.auto_bkg = SmoothBrucknerBackground()
    pattern.transform_x(lambda x: x + 2)
    assert np.array_equal(pattern.x, x + 2)