:py:mod:`aces.display`
======================

.. py:module:: aces.display


Submodules
----------
.. toctree::
   :titlesonly:
   :maxdepth: 1

   ant_beam_pol_summary/index.rst


Package Contents
----------------


Functions
~~~~~~~~~

.. autoapisummary::

   aces.display.make_summary_plot



.. py:function:: make_summary_plot(obj, r_method, r_parameters, frq_select=None, **kwargs)

   Makes a graphical summary of some beam-specific quantity across the whole array. The routine needs to
   use a single scalar quantity for each of two polarisations (XX, YY) for each beam, for each antenna.
   The input object must be of a subclass of BeamSet, and may hold a spectrum of quantities.  This spectrum is
   reduced to a single scalar by the passed method 'r_method' with parameters 'r_parameters'.

   :param obj:     Object derived from BeamSet
   :param r_method: method to reduce a spectrum of values to a single scalarL r_method(spectrum, r_parameters)
   :param r_parameters: parameters of r_method
   :param frq_select: lower and upper limits of scalar values to be colour-coded
   :param kwargs:

   :return: