Metadata-Version: 2.0
Name: dtgui
Version: 1.1.2
Summary: GUI baseline-subtraction using the dual-tree complex wavelet transform
Home-page: http://www.physics.mcgill.ca/siwicklab/software.html
Author: Laurent P. René de Cotret
Author-email: laurent.renedecotret@mail.mcgill.ca
License: MIT
Download-URL: http://github.com/LaurentRDC/dtgui
Description-Content-Type: UNKNOWN
Keywords: dtgui
Platform: UNKNOWN
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Visualization
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Requires-Dist: numpy (>=1.12)
Requires-Dist: pyqtgraph (>=0.10)
Requires-Dist: scikit-ued (>=0.4.9)
Requires-Dist: pyqt5
Requires-Dist: pywavelets (>=0.5.2)
Requires-Dist: qdarkstyle (>=2.3.1)

dtgui
=====

.. image:: https://img.shields.io/pypi/v/dtgui.svg
    :target: https://pypi.python.org/pypi/dtgui
    :alt: PyPI Version

dtgui is a graphical user interface for interactively testing a baseline-removal algorithm based on the dual-tree complex wavelet transform
published in the following article:

    .. [#] L. P. René de Cotret and B. J. Siwick, A general method for baseline-removal in ultrafast 
           electron powder diffraction data using the dual-tree complex wavelet transform, Struct. Dyn. 4 (2017) DOI: 10.1063/1.4972518.

The underlying function is `documented in its original package <http://scikit-ued.readthedocs.io/en/release/functions/skued.baseline_dt.html#skued.baseline_dt>`_.

Installation
------------

Other than the pip-installable requirements, dtgui requires PyQt5 to be installed.

Usage
-----

Once installed, the GUI can be started using the following command:

    python -m dtgui

The data fed to dtgui should be comma-separated values files (.csv). The first column is expected to be the abscissa values,
while the second column should be the ordinates.

Support / Report Issues
-----------------------

All support requests and issue reports should be
`filed on Github as an issue <https://github.com/LaurentRDC/dtgui/issues>`_.

License
-------

dtgui is made available under the MIT License. For more details, see `LICENSE.txt <https://github.com/LaurentRDC/dtgui/blob/master/LICENSE.txt>`_.


