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

.. py:module:: aces.holography.holo_filenames

.. autoapi-nested-parse::

   Utility for generating names for holography and ASKAP primary beam files 



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


Functions
~~~~~~~~~

.. autoapisummary::

   aces.holography.holo_filenames.make_file_name
   aces.holography.holo_filenames.make_file_name_template
   aces.holography.holo_filenames.find_holo_file



.. py:function:: make_file_name(obj, kind)

   Returns a file name according to metadata and the label provided in kind
   :param obj: MapSet object holding holography beam data
   :param kind: str


.. py:function:: make_file_name_template(pol='????', fp_name='*', fp_pitch=0, frq_centre=0, sbid=-1, kind='.*')

   Returns a file name according to arguments and the label provided in kind. Parameters not
   provided result in wild-card sections in the file name
   :param pol: str Polarization desriptor 'xxyy' or 'iquv'
   :param fp_name: str Footprint name
   :param fp_pitch: int beam pitch in arcminutes
   :param frq_centre: int Centre frequency in integer MHz.
   :param sbid: int Scheduling block ident.
   :param kind: str


.. py:function:: find_holo_file(holo_dir, pol='????', fp_name='*', fp_pitch=0, frq_centre=0, sbid=-1, kind='*')

   Returns a file name according to arguments and the label provided in kind. Parameters not
   provided result in wild-card sections in the file name, and the disk is searched for a matching file.
   :param holo_dir: str Name of directory holding files
   :param pol: str Polarization desriptor 'xxyy' or 'iquv'
   :param fp_name: str Footprint name
   :param fp_pitch: int beam pitch in arcminutes
   :param frq_centre: int Centre frequency in integer MHz.
   :param sbid: int Scheduling block ident.
   :param kind: str