hikari.utility.artists
======================

.. py:module:: hikari.utility.artists


Attributes
----------

.. autoapisummary::

   hikari.utility.artists.artist_factory


Exceptions
----------

.. autoapisummary::

   hikari.utility.artists.ArtistError


Classes
-------

.. autoapisummary::

   hikari.utility.artists.ArtistFactory
   hikari.utility.artists.Artist
   hikari.utility.artists.AngularHeatmapArtist
   hikari.utility.artists.GnuplotArtist
   hikari.utility.artists.MatplotlibArtist
   hikari.utility.artists.GnuplotAngularHeatmapArtist
   hikari.utility.artists.MatplotlibAngularHeatmapArtist


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

.. py:exception:: ArtistError(message)

   Bases: :py:obj:`Exception`


   Exception raised when a problem with plotting in hikari occurs.


.. py:class:: ArtistFactory

   A factory method for creating artists.


   .. py:attribute:: _artists


   .. py:method:: register(name, artist)


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


.. py:class:: Artist

   Base class used for plotting matplotlib and gnuplot plots


   .. py:method:: _assert_is_iterable(iterable, length=0)
      :staticmethod:



   .. py:method:: plot(path)
      :abstractmethod:



.. py:class:: AngularHeatmapArtist

   Bases: :py:obj:`Artist`, :py:obj:`abc.ABC`


   Base class used for plotting angular heatmaps


   .. py:attribute:: HEAT_EXTENSION
      :value: '.lst'



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



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



   .. py:attribute:: _x_axis
      :value: ()



   .. py:attribute:: _y_axis
      :value: ()



   .. py:attribute:: _z_axis
      :value: ()



   .. py:attribute:: _focus
      :value: ()



   .. py:attribute:: _heat_limits
      :value: ()



   .. py:attribute:: _polar_limits
      :value: ()



   .. py:attribute:: _azimuth_limits
      :value: ()



   .. py:property:: x_axis


   .. py:property:: y_axis


   .. py:property:: z_axis


   .. py:property:: heat_limits


   .. py:property:: focus


   .. py:property:: polar_limits


   .. py:property:: azimuth_limits


.. py:class:: GnuplotArtist

   Bases: :py:obj:`abc.ABC`


   Base class used for plotting gnuplot plots


   .. py:attribute:: GNUPLOT_EXTENSION
      :value: '.gnu'



   .. py:attribute:: _heat_palette


   .. py:property:: heat_palette


.. py:class:: MatplotlibArtist

   Bases: :py:obj:`abc.ABC`


   Base class used for plotting matplotlib plots


   .. py:attribute:: _heat_palette


   .. py:property:: heat_palette


.. py:class:: GnuplotAngularHeatmapArtist

   Bases: :py:obj:`GnuplotArtist`, :py:obj:`AngularHeatmapArtist`


   Base class used for plotting gnuplot angular heatmaps


   .. py:attribute:: template


   .. py:property:: focus_string


   .. py:method:: plot(path)


.. py:class:: MatplotlibAngularHeatmapArtist

   Bases: :py:obj:`MatplotlibArtist`, :py:obj:`AngularHeatmapArtist`


   Base class used for plotting matplotlib angular heatmaps


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



   .. py:method:: plot(path)


.. py:data:: artist_factory