hikari.scripts.angular_explorer
===============================

.. py:module:: hikari.scripts.angular_explorer

.. autoapi-nested-parse::

   This file contains tools for making property maps visualised on sphere



Attributes
----------

.. autoapisummary::

   hikari.scripts.angular_explorer.angular_property_explorer_factory


Classes
-------

.. autoapisummary::

   hikari.scripts.angular_explorer.AngularPropertyExplorerFactory
   hikari.scripts.angular_explorer.AngularPropertyExplorer
   hikari.scripts.angular_explorer.AngularPotencyExplorer
   hikari.scripts.angular_explorer.AngularR1Explorer


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

.. py:class:: AngularPropertyExplorerFactory

   A factory method for creating angular property explorers.


   .. py:attribute:: _explorers


   .. py:method:: register(prop, explorer)


   .. py:method:: create(prop, **kwargs)


.. py:class:: AngularPropertyExplorer

   An abstract base class for objects handling analysing parameters as
   a function of crystal orientation in a Diamond Anvil Cell.
   In order to generate a map of desired property,
   the following methods must be executed in order:

   - set_path
   - set_sample
   - set_output
   - explore


   .. py:attribute:: hkl_is_read_not_generated
      :type:  bool


   .. py:attribute:: property_name
      :type:  str


   .. py:attribute:: property_theoretical_limits
      :type:  hikari.utility.Interval


   .. py:attribute:: GNUPLOT_INPUT_EXTENSION
      :value: '.gnu'



   .. py:attribute:: GNUPLOT_OUTPUT_EXTENSION
      :value: '.pnG'



   .. py:attribute:: HISTOGRAM_EXTENSION
      :value: '.his'



   .. py:attribute:: HKL_EXTENSION
      :value: '.hkl'



   .. py:attribute:: LISTING_EXTENSION
      :value: '.lst'



   .. py:attribute:: MATPLOTLIB_EXTENSION
      :value: '.png'



   .. py:attribute:: MESH_EXTENSION
      :value: '.dat'



   .. py:attribute:: POLAR_LIMIT_DICT


   .. py:attribute:: AZIMUTH_LIMIT_DICT


   .. py:attribute:: _path
      :value: ''



   .. py:attribute:: _sg


   .. py:attribute:: _pg


   .. py:attribute:: _lg


   .. py:attribute:: _th_limits


   .. py:attribute:: _ph_limits


   .. py:attribute:: axis
      :value: ''



   .. py:attribute:: hkl_frame


   .. py:attribute:: opening_angle
      :value: 0.0



   .. py:attribute:: orientation
      :value: None



   .. py:attribute:: resolution
      :value: 0.0



   .. py:attribute:: fix_scale
      :value: False



   .. py:attribute:: histogram
      :value: False



   .. py:attribute:: output_quality
      :value: 1



   .. py:attribute:: data_dict


   .. py:method:: set_up(a, b, c, al, be, ga, space_group, wavelength, axis, opening_angle, orientation, resolution, path, fix_scale, histogram, output_quality)


   .. py:method:: explore()
      :abstractmethod:


      Main interface method which, apart from the setters, is run within
      the script itself and generates data and figures using class methods



   .. py:property:: prop_limits


   .. py:method:: write_hist_file()


   .. py:method:: _make_hkl_frame()

      Make ball or axis of hkl which will be cut in further steps



   .. py:method:: _read_hkl_frame(hkl_format)

      Read reflections of hkl which will be cut in further steps



   .. py:property:: th_limits

      Interval range of polar angle where property will be calculated


   .. py:property:: ph_limits

      Interval range of azimuth angle where property will be calculated


   .. py:method:: _draw_map(artist, extension)


   .. py:method:: draw_matplotlib_map()


   .. py:method:: draw_gnuplot_map()


   .. py:property:: angle_res


   .. py:property:: path

      Provides path = directory + stem to the workspace. They are common to
      all input and output files, the extensions are specified as class var.


   .. py:property:: sg


   .. py:property:: pg


   .. py:property:: lg


   .. py:property:: focus_cartesian


   .. py:property:: focus_spherical_closest


   .. py:property:: prop_at_focus_closest


   .. py:property:: th_range


   .. py:property:: ph_range


   .. py:property:: th_comb


   .. py:property:: ph_comb


   .. py:property:: th_mesh


   .. py:property:: ph_mesh


   .. py:method:: orientation_weights(th, ph)

      Calculate how much each point should contribute to distribution



   .. py:property:: descriptive_statistics_string


   .. py:property:: prop_at_focus_string


.. py:class:: AngularPotencyExplorer

   Bases: :py:obj:`AngularPropertyExplorer`


   An abstract base class for objects handling analysing parameters as
   a function of crystal orientation in a Diamond Anvil Cell.
   In order to generate a map of desired property,
   the following methods must be executed in order:

   - set_path
   - set_sample
   - set_output
   - explore


   .. py:attribute:: hkl_is_read_not_generated
      :value: False



   .. py:attribute:: property_name
      :value: 'potency'



   .. py:attribute:: property_theoretical_limits


   .. py:method:: explore()

      Main interface method which, apart from the setters, is run within
      the script itself and generates data and figures using class methods



.. py:class:: AngularR1Explorer

   Bases: :py:obj:`AngularPropertyExplorer`


   An abstract base class for objects handling analysing parameters as
   a function of crystal orientation in a Diamond Anvil Cell.
   In order to generate a map of desired property,
   the following methods must be executed in order:

   - set_path
   - set_sample
   - set_output
   - explore


   .. py:attribute:: hkl_is_read_not_generated
      :value: True



   .. py:attribute:: property_name
      :value: 'R1'



   .. py:attribute:: property_theoretical_limits


   .. py:method:: explore()

      Main interface method which, apart from the setters, is run within
      the script itself and generates data and figures using class methods



.. py:data:: angular_property_explorer_factory