summaryrefslogtreecommitdiff
path: root/src/silx/_config.py
diff options
context:
space:
mode:
Diffstat (limited to 'src/silx/_config.py')
-rw-r--r--src/silx/_config.py148
1 files changed, 148 insertions, 0 deletions
diff --git a/src/silx/_config.py b/src/silx/_config.py
new file mode 100644
index 0000000..fb0e409
--- /dev/null
+++ b/src/silx/_config.py
@@ -0,0 +1,148 @@
+#!/usr/bin/env python
+# coding: utf-8
+# /*##########################################################################
+#
+# Copyright (c) 2017-2019 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.
+#
+# ###########################################################################*/
+"""This module contains library wide configuration.
+"""
+
+__authors__ = ["V. Valls"]
+__license__ = "MIT"
+__date__ = "09/11/2018"
+
+
+class Config(object):
+ """
+ Class containing shared global configuration for the silx library.
+
+ .. versionadded:: 0.8
+ """
+
+ DEFAULT_PLOT_BACKEND = "matplotlib", "opengl"
+ """Default plot backend.
+
+ It will be used as default backend for all the next created PlotWidget.
+
+ This attribute can be set with:
+
+ - 'matplotlib' (default) or 'mpl'
+ - 'opengl', 'gl'
+ - 'none'
+ - A :class:`silx.gui.plot.backend.BackendBase.BackendBase` class
+ - A callable returning backend class or binding name
+
+ If multiple backends are provided, the first available one is used.
+
+ .. versionadded:: 0.8
+ """
+
+ DEFAULT_COLORMAP_NAME = 'gray'
+ """Default LUT for the plot widgets.
+
+ The available list of names are available in the module
+ :module:`silx.gui.colors`.
+
+ .. versionadded:: 0.8
+ """
+
+ DEFAULT_PLOT_IMAGE_Y_AXIS_ORIENTATION = 'upward'
+ """Default Y-axis orientation for plot widget displaying images.
+
+ This attribute can be set with:
+
+ - 'upward' (default), which set the origin to the bottom with an upward
+ orientation.
+ - 'downward', which set the origin to the top with a backward orientation.
+
+ It will have an influence on:
+
+ - :class:`silx.gui.plot.StackWidget`
+ - :class:`silx.gui.plot.ComplexImageView`
+ - :class:`silx.gui.plot.Plot2D`
+ - :class:`silx.gui.plot.ImageView`
+
+ .. versionadded:: 0.8
+ """
+
+ DEFAULT_PLOT_CURVE_COLORS = ['#000000', # black
+ '#0000ff', # blue
+ '#ff0000', # red
+ '#00ff00', # green
+ '#ff66ff', # pink
+ '#ffff00', # yellow
+ '#a52a2a', # brown
+ '#00ffff', # cyan
+ '#ff00ff', # magenta
+ '#ff9900', # orange
+ '#6600ff', # violet
+ '#a0a0a4', # grey
+ '#000080', # darkBlue
+ '#800000', # darkRed
+ '#008000', # darkGreen
+ '#008080', # darkCyan
+ '#800080', # darkMagenta
+ '#808000', # darkYellow
+ '#660000'] # darkBrown
+ """Default list of colors for plot widget displaying curves.
+
+ It will have an influence on:
+
+ - :class:`silx.gui.plot.PlotWidget`
+
+ .. versionadded:: 0.9
+ """
+
+ DEFAULT_PLOT_CURVE_SYMBOL_MODE = False
+ """Whether to display curves with markers or not by default in PlotWidget.
+
+ It will have an influence on PlotWidget curve items.
+
+ .. versionadded:: 0.10
+ """
+
+ DEFAULT_PLOT_SYMBOL = 'o'
+ """Default marker of the item.
+
+ It will have an influence on PlotWidget items
+
+ Supported symbols:
+
+ - 'o', 'Circle'
+ - 'd', 'Diamond'
+ - 's', 'Square'
+ - '+', 'Plus'
+ - 'x', 'Cross'
+ - '.', 'Point'
+ - ',', 'Pixel'
+ - '', 'None'
+
+ .. versionadded:: 0.10
+ """
+
+ DEFAULT_PLOT_SYMBOL_SIZE = 6.0
+ """Default marker size of the item.
+
+ It will have an influence on PlotWidget items
+
+ .. versionadded:: 0.10
+ """