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

.. py:module:: aces.display.ant_beam_pol_summary


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


Functions
~~~~~~~~~

.. autoapisummary::

   aces.display.ant_beam_pol_summary.dual_half_circle
   aces.display.ant_beam_pol_summary.bsect
   aces.display.ant_beam_pol_summary.get_footprint_pa_zero
   aces.display.ant_beam_pol_summary.get_stats_strings
   aces.display.ant_beam_pol_summary.make_summary_plot



.. py:function:: dual_half_circle(center, radius, angle=0, ax=None, colors=('w', 'k'), **kwargs)

   Add two half circles to the axes *ax* (or the current axes) with the
   specified facecolors *colors* rotated at *angle* (in degrees).


.. py:function:: bsect(x, z)

   Find position in array x of value z; assumes x sorted in increasing order.
   Uses the bisection method to find j such that x[j] <= z < x[j+1]

   :param x: array with values in increasing order
   :param z: value to locate
   :return: j such that x[j] <= z < x[j+1]


.. py:function:: get_footprint_pa_zero(name, pitch)


.. py:function:: get_stats_strings(data_in)


.. 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: