:py:mod:`binning`
=================

.. py:module:: binning

.. autodoc2-docstring:: binning
   :allowtitles:

Module Contents
---------------

Functions
~~~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`fix_delta_q_geometry <binning.fix_delta_q_geometry>`
     - .. autodoc2-docstring:: binning.fix_delta_q_geometry
          :summary:
   * - :py:obj:`fix_intensity_geometry <binning.fix_intensity_geometry>`
     - .. autodoc2-docstring:: binning.fix_intensity_geometry
          :summary:
   * - :py:obj:`finite_diff_grid <binning.finite_diff_grid>`
     - .. autodoc2-docstring:: binning.finite_diff_grid
          :summary:
   * - :py:obj:`finite_diff_shape <binning.finite_diff_shape>`
     - .. autodoc2-docstring:: binning.finite_diff_shape
          :summary:
   * - :py:obj:`typecheckdict <binning.typecheckdict>`
     - .. autodoc2-docstring:: binning.typecheckdict
          :summary:
   * - :py:obj:`weighted_bin_3d <binning.weighted_bin_3d>`
     - .. autodoc2-docstring:: binning.weighted_bin_3d
          :summary:
   * - :py:obj:`weighted_bin_1d <binning.weighted_bin_1d>`
     - .. autodoc2-docstring:: binning.weighted_bin_1d
          :summary:

API
~~~

.. py:function:: fix_delta_q_geometry(arr: numpy.ndarray) -> numpy.ndarray
   :canonical: binning.fix_delta_q_geometry

   .. autodoc2-docstring:: binning.fix_delta_q_geometry

.. py:function:: fix_intensity_geometry(arr: numpy.ndarray) -> numpy.ndarray
   :canonical: binning.fix_intensity_geometry

   .. autodoc2-docstring:: binning.fix_intensity_geometry

.. py:function:: finite_diff_grid(start: numpy.ndarray, stop: numpy.ndarray, step: numpy.ndarray)
   :canonical: binning.finite_diff_grid

   .. autodoc2-docstring:: binning.finite_diff_grid

.. py:function:: finite_diff_shape(start: numpy.ndarray, stop: numpy.ndarray, step: numpy.ndarray)
   :canonical: binning.finite_diff_shape

   .. autodoc2-docstring:: binning.finite_diff_shape

.. py:function:: typecheckdict(float_dict, type)
   :canonical: binning.typecheckdict

   .. autodoc2-docstring:: binning.typecheckdict

.. py:function:: weighted_bin_3d(coords: numpy.ndarray, weights: numpy.ndarray, out: numpy.ndarray, count: numpy.ndarray, start: numpy.ndarray, stop: numpy.ndarray, step: numpy.ndarray, min_intensity=None) -> numpy.ndarray
   :canonical: binning.weighted_bin_3d

   .. autodoc2-docstring:: binning.weighted_bin_3d

.. py:function:: weighted_bin_1d(coords: numpy.ndarray, weights: numpy.ndarray, out: numpy.ndarray, count: numpy.ndarray, start: float, stop: float, step: float)
   :canonical: binning.weighted_bin_1d

   .. autodoc2-docstring:: binning.weighted_bin_1d