Directtools Python module.rst

.. _Directtools Python module:

==================
:mod:`directtools`
==================

:literal:`directtools` is a Python module for quickly plotting standardized :math:`S(Q,E)` color fill plots as well as line profiles (cuts) in constant :math:`Q` and :math:`E`. The module also provides a few utility functions for inspecting the :math:`S(Q,E)` workspace.

Reference
=========

.. autoclass:: directtools.SampleLogs
   :members: __init__

.. automodule:: directtools
   :members: nanminmax, plotprofiles, plotconstE, plotconstQ, plotSofQW, subplots,
             validQ, wsreport

.. categories:: Techniques