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
|
# coding: utf-8
# /*##########################################################################
#
# Copyright (c) 2016-2017 European Synchrotron Radiation Facility
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
#
# ###########################################################################*/
"""Utilities for writing tests.
- :func:`temp_dir` provides a with context to create/delete a temporary
directory.
"""
__authors__ = ["T. Vincent"]
__license__ = "MIT"
__date__ = "17/01/2018"
import sys
import contextlib
import os
import numpy
import shutil
import tempfile
from ..resources import ExternalResources
utilstest = ExternalResources(project="silx",
url_base="http://www.silx.org/pub/silx/",
env_key="SILX_DATA",
timeout=60)
"This is the instance to be used. Singleton-like feature provided by module"
class _TestOptions(object):
def __init__(self):
self.WITH_QT_TEST = True
"""Qt tests are included"""
self.WITH_QT_TEST_REASON = ""
"""Reason for Qt tests are disabled if any"""
self.WITH_OPENCL_TEST = True
"""OpenCL tests are included"""
self.WITH_GL_TEST = True
"""OpenGL tests are included"""
self.WITH_GL_TEST_REASON = ""
"""Reason for OpenGL tests are disabled if any"""
self.TEST_LOW_MEM = False
"""Skip tests using too much memory"""
def configure(self, parsed_options):
"""Configure the TestOptions class from the command line arguments and the
environment variables
"""
if not parsed_options.gui:
self.WITH_QT_TEST = False
self.WITH_QT_TEST_REASON = "Skipped by command line"
elif os.environ.get('WITH_QT_TEST', 'True') == 'False':
self.WITH_QT_TEST = False
self.WITH_QT_TEST_REASON = "Skipped by WITH_QT_TEST env var"
elif sys.platform.startswith('linux') and not os.environ.get('DISPLAY', ''):
self.WITH_QT_TEST = False
self.WITH_QT_TEST_REASON = "DISPLAY env variable not set"
if not parsed_options.opencl or os.environ.get('SILX_OPENCL', 'True') == 'False':
self.WITH_OPENCL_TEST = False
# That's an easy way to skip OpenCL tests
# It disable the use of OpenCL on the full silx project
os.environ['SILX_OPENCL'] = "False"
if not parsed_options.opengl:
self.WITH_GL_TEST = False
self.WITH_GL_TEST_REASON = "Skipped by command line"
elif os.environ.get('WITH_GL_TEST', 'True') == 'False':
self.WITH_GL_TEST = False
self.WITH_GL_TEST_REASON = "Skipped by WITH_GL_TEST env var"
if parsed_options.low_mem or os.environ.get('SILX_TEST_LOW_MEM', 'True') == 'False':
self.TEST_LOW_MEM = True
if self.WITH_QT_TEST:
from silx.gui import qt
if sys.platform == "win32" and qt.qVersion() == "5.9.2":
self.SKIP_TEST_FOR_ISSUE_936 = True
def add_parser_argument(self, parser):
"""Add extrat arguments to the test argument parser
:param ArgumentParser parser: An argument parser
"""
parser.add_argument("-x", "--no-gui", dest="gui", default=True,
action="store_false",
help="Disable the test of the graphical use interface")
parser.add_argument("-g", "--no-opengl", dest="opengl", default=True,
action="store_false",
help="Disable tests using OpenGL")
parser.add_argument("-o", "--no-opencl", dest="opencl", default=True,
action="store_false",
help="Disable the test of the OpenCL part")
parser.add_argument("-l", "--low-mem", dest="low_mem", default=False,
action="store_true",
help="Disable test with large memory consumption (>100Mbyte")
test_options = _TestOptions()
"""Singleton providing configuration information for all the tests"""
# Temporary directory context #################################################
@contextlib.contextmanager
def temp_dir():
"""with context providing a temporary directory.
>>> import os.path
>>> with temp_dir() as tmp:
... print(os.path.isdir(tmp)) # Use tmp directory
"""
tmp_dir = tempfile.mkdtemp()
try:
yield tmp_dir
finally:
shutil.rmtree(tmp_dir)
# Synthetic data and random noise #############################################
def add_gaussian_noise(y, stdev=1., mean=0.):
"""Add random gaussian noise to synthetic data.
:param ndarray y: Array of synthetic data
:param float mean: Mean of the gaussian distribution of noise.
:param float stdev: Standard deviation of the gaussian distribution of
noise.
:return: Array of data with noise added
"""
noise = numpy.random.normal(mean, stdev, size=y.size)
noise.shape = y.shape
return y + noise
def add_poisson_noise(y):
"""Add random noise from a poisson distribution to synthetic data.
:param ndarray y: Array of synthetic data
:return: Array of data with noise added
"""
yn = numpy.random.poisson(y)
yn.shape = y.shape
return yn
def add_relative_noise(y, max_noise=5.):
"""Add relative random noise to synthetic data. The maximum noise level
is given in percents.
An array of noise in the interval [-max_noise, max_noise] (continuous
uniform distribution) is generated, and applied to the data the
following way:
:math:`yn = y * (1. + noise / 100.)`
:param ndarray y: Array of synthetic data
:param float max_noise: Maximum percentage of noise
:return: Array of data with noise added
"""
noise = max_noise * (2 * numpy.random.random(size=y.size) - 1)
noise.shape = y.shape
return y * (1. + noise / 100.)
|
