:py:mod:`aces.holography.plot_summary`
======================================

.. py:module:: aces.holography.plot_summary


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


Functions
~~~~~~~~~

.. autoapisummary::

   aces.holography.plot_summary.arg_init
   aces.holography.plot_summary.linmos
   aces.holography.plot_summary.beam_mosaic
   aces.holography.plot_summary.key_axis
   aces.holography.plot_summary.get_target
   aces.holography.plot_summary.get_ms_size
   aces.holography.plot_summary.plot_beampos_errors
   aces.holography.plot_summary.plot_valid_summary
   aces.holography.plot_summary.plot_footprint_sensitivity
   aces.holography.plot_summary.plot_footprint_leakage
   aces.holography.plot_summary.cli
   aces.holography.plot_summary.main



Attributes
~~~~~~~~~~

.. autoapisummary::

   aces.holography.plot_summary.log
   aces.holography.plot_summary.aces_cfg
   aces.holography.plot_summary.fp_factory
   aces.holography.plot_summary.explanation


.. py:data:: log

   

.. py:data:: aces_cfg

   

.. py:data:: fp_factory

   

.. py:data:: explanation
   :value: ' Fill this'

   

.. py:function:: arg_init()


.. py:function:: linmos(beams, beams_i, cutoff=0.1)


.. py:function:: beam_mosaic(beams)


.. py:function:: key_axis(fig, dx, dy, wd, ht)

   Returns a new axis whose position is given relative to the plotted area as recorded in fig.subplotpars.
   This is used after a call to plt.subplots or equivalent. The returned axis is convenient for placing keys
   or explanations related to the plotted data.
   :param fig: Parent figure
   :param dx: Left position  of new axis relative to that of plotted area
   :param dy: Bottom position  of new axis relative to the TOP of plotted area
   :param wd: Width of new axis
   :param ht: Height of new axis
   :return: new axis


.. py:function:: get_target(sbid)


.. py:function:: get_ms_size(fig, ax, size)

   Returns a marker size corresponding to the current axis scale and requested size.
   It is assumed that the axis aspect ratio is 1.0, and the scaling is computed using the x world and
   display coordinates.  If the aspect ratio is not 1.0, the marker will be scaled correctly in the horizontal
   direction only.
   :param fig: Current matplotlib figure
   :param ax: Current matplotlib axis
   :param size: Required size of marker in "world" coordinates
   :return: Marker size


.. py:function:: plot_beampos_errors(mapset, remove_mean, channel, tt=False, plot_file_name=None)

   :param mapset: Mapset object holding beam position offsets
   :param remove_mean: If True, subtract vector mean of beam errors before plotting
   :param channel:
   :param tt:
   :param plot_file_name: Output file name


.. py:function:: plot_valid_summary(mapset, plot_file_name=None)


.. py:function:: plot_footprint_sensitivity(mapset, plot_file_name=None)


.. py:function:: plot_footprint_leakage(mapset, plot_file_name=None)


.. py:function:: cli()

   Plot three summary files from holography data:
   1. valid_data from <sbid>_Holo_stokes.hdf5
   2. beam position errors from <sbid>_Holo_beam_shifts.hdf5
   3. Sensitivity of footprint over array-wide mean from <sbid>_Holo_mean_interp.hdf5
   :return:


.. py:function:: main(sbid, holo_dir='.')