:py:mod:`aces.obsplan.config`
=============================

.. py:module:: aces.obsplan.config


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

Classes
~~~~~~~

.. autoapisummary::

   aces.obsplan.config.ACESConfig



Functions
~~~~~~~~~

.. autoapisummary::

   aces.obsplan.config.get_footprint
   aces.obsplan.config.get_footprint_pa_zero



Attributes
~~~~~~~~~~

.. autoapisummary::

   aces.obsplan.config.logger


.. py:data:: logger

   

.. py:class:: ACESConfig(clear_footprint_cache=False)

   Bases: :py:obj:`object`


.. py:function:: get_footprint(sb: Union[int, aces.askapdata.schedblock.SchedulingBlock]) -> askap.footprint.Footprint

   Obtain the footprint layout for a given observation

   Args:
       sb (Union[int,SchedulingBlock]): Information of the schedule block that corresponds to an observation. If int, an instance of SchedularBlock is created. 

   Returns:
       Footprint: A layout of the footprint of an observation


.. py:function:: get_footprint_pa_zero(name: str, pitch: float) -> askap.footprint.Footprint

   Returns  a footprint instance based on a footprint name, with 
   a user provided pitch angle. No care or facility is given to tie it
   to a particular schedule block / SBID. 

   Args:
       name (str): Name of the footprint to use
       pitch (float): Rotation of the PAF (in degrees)

   Returns:
       Footprint: Instance of PAF footprint layout