:py:mod:`aces.beamset.beambase`
===============================

.. py:module:: aces.beamset.beambase

.. autoapi-nested-parse::

   Defines classes for holding beam maps and models for ASKAP

   Copyright (C) CSIRO 2017



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

Classes
~~~~~~~

.. autoapisummary::

   aces.beamset.beambase.BeamBase
   aces.beamset.beambase.BeamFormed
   aces.beamset.beambase.BeamSinglePorts



Functions
~~~~~~~~~

.. autoapisummary::

   aces.beamset.beambase.get_port_positions



.. py:class:: BeamBase(num_beams=0, offsets_rect=None)

   Bases: :py:obj:`object`

   A base class for holding and providing information about beams.
   The subclasses in mind are BeamFormed and BeamSingleports. 
      
   :param int num_beams: number of beams
   :param offsets_rect: rectangular offsets in l,m about antenna boresight
   :type offsets_rect: :class:`numpy.ndarray` of dimension (num_beams, 2)

   .. py:method:: get_num_beams()


   .. py:method:: get_beam_offset(beam)



.. py:function:: get_port_positions()


.. py:class:: BeamFormed(fp_name, fp_pitch, fp_angle=0.0, beamforming_pa=0.0)

   Bases: :py:obj:`BeamBase`

   Provides beam information, given the footprint specification


.. py:class:: BeamSinglePorts(port_numbers)

   Bases: :py:obj:`BeamBase`

   Provides beam information for single port beams
   Mounting and geometry errors can be incorporated.