:py:mod:`image`
===============

.. py:module:: image

.. autodoc2-docstring:: image
   :allowtitles:

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

Classes
~~~~~~~

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

   * - :py:obj:`Image <image.Image>`
     - .. autodoc2-docstring:: image.Image
          :summary:

Functions
~~~~~~~~~

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

   * - :py:obj:`get_coordchange_matrix <image.get_coordchange_matrix>`
     - .. autodoc2-docstring:: image.get_coordchange_matrix
          :summary:
   * - :py:obj:`correct_transmission <image.correct_transmission>`
     - .. autodoc2-docstring:: image.correct_transmission
          :summary:
   * - :py:obj:`correct_counttime <image.correct_counttime>`
     - .. autodoc2-docstring:: image.correct_counttime
          :summary:
   * - :py:obj:`get_norm_value <image.get_norm_value>`
     - .. autodoc2-docstring:: image.get_norm_value
          :summary:
   * - :py:obj:`do_mask_eiger <image.do_mask_eiger>`
     - .. autodoc2-docstring:: image.do_mask_eiger
          :summary:
   * - :py:obj:`do_edfmask <image.do_edfmask>`
     - .. autodoc2-docstring:: image.do_edfmask
          :summary:
   * - :py:obj:`do_mask_pixels <image.do_mask_pixels>`
     - .. autodoc2-docstring:: image.do_mask_pixels
          :summary:
   * - :py:obj:`do_mask_regions <image.do_mask_regions>`
     - .. autodoc2-docstring:: image.do_mask_regions
          :summary:
   * - :py:obj:`norm_kout_array <image.norm_kout_array>`
     - .. autodoc2-docstring:: image.norm_kout_array
          :summary:

Data
~~~~

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

   * - :py:obj:`logger <image.logger>`
     - .. autodoc2-docstring:: image.logger
          :summary:

API
~~~

.. py:data:: logger
   :canonical: image.logger
   :value: 'getLogger(...)'

   .. autodoc2-docstring:: image.logger

.. py:function:: get_coordchange_matrix(oop)
   :canonical: image.get_coordchange_matrix

   .. autodoc2-docstring:: image.get_coordchange_matrix

.. py:function:: correct_transmission(transmission_array, data_array, index)
   :canonical: image.correct_transmission

   .. autodoc2-docstring:: image.correct_transmission

.. py:function:: correct_counttime(count_time_array, data_array, index)
   :canonical: image.correct_counttime

   .. autodoc2-docstring:: image.correct_counttime

.. py:function:: get_norm_value(values, index)
   :canonical: image.get_norm_value

   .. autodoc2-docstring:: image.get_norm_value

.. py:function:: do_mask_eiger(data_arr)
   :canonical: image.do_mask_eiger

   .. autodoc2-docstring:: image.do_mask_eiger

.. py:function:: do_edfmask(edfmask, data_arr)
   :canonical: image.do_edfmask

   .. autodoc2-docstring:: image.do_edfmask

.. py:function:: do_mask_pixels(mask_pixels, data_arr)
   :canonical: image.do_mask_pixels

   .. autodoc2-docstring:: image.do_mask_pixels

.. py:function:: do_mask_regions(mask_regions, data_arr)
   :canonical: image.do_mask_regions

   .. autodoc2-docstring:: image.do_mask_regions

.. py:function:: norm_kout_array(k_out_array, i, j)
   :canonical: image.norm_kout_array

   .. autodoc2-docstring:: image.norm_kout_array

.. py:class:: Image(metadata: fast_rsm.rsm_metadata.RSMMetadata, index: int, load_image=True, pyfai_calculation=False)
   :canonical: image.Image

   .. autodoc2-docstring:: image.Image

   .. rubric:: Initialization

   .. autodoc2-docstring:: image.Image.__init__

   .. py:method:: _correct_img_axes()
      :canonical: image.Image._correct_img_axes

      .. autodoc2-docstring:: image.Image._correct_img_axes

   .. py:method:: get_detector_values(frame)
      :canonical: image.Image.get_detector_values

      .. autodoc2-docstring:: image.Image.get_detector_values

   .. py:method:: get_vert_hor_values(frame)
      :canonical: image.Image.get_vert_hor_values

      .. autodoc2-docstring:: image.Image.get_vert_hor_values

   .. py:method:: apply_corrections(frame, lorentz_correction, pol_correction, incident_beam_arr, k_out_array)
      :canonical: image.Image.apply_corrections

      .. autodoc2-docstring:: image.Image.apply_corrections

   .. py:method:: generate_mask(min_intensity: typing.Union[float, int]) -> numpy.ndarray
      :canonical: image.Image.generate_mask

      .. autodoc2-docstring:: image.Image.generate_mask

   .. py:method:: add_processing_step(function) -> None
      :canonical: image.Image.add_processing_step

      .. autodoc2-docstring:: image.Image.add_processing_step

   .. py:property:: data
      :canonical: image.Image.data

      .. autodoc2-docstring:: image.Image.data

   .. py:method:: q_vectors(frame: diffraction_utils.Frame, spherical_bragg_vec: numpy.array, oop='y', indices: tuple = None, lorentz_correction: bool = False, pol_correction: bool = True) -> numpy.ndarray
      :canonical: image.Image.q_vectors

      .. autodoc2-docstring:: image.Image.q_vectors

   .. py:method:: q_vector_array(frame: diffraction_utils.Frame, spherical_bragg_vec: numpy.array, oop='y', lorentz_correction: bool = False, pol_correction: bool = True) -> numpy.ndarray
      :canonical: image.Image.q_vector_array

      .. autodoc2-docstring:: image.Image.q_vector_array