:py:mod:`beam_pointing`
=======================

.. py:module:: beam_pointing

.. autoapi-nested-parse::

   Analysis of holography beam maps to infer pointing errors, etc..

   Copyright (C) CSIRO 2021



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

Classes
~~~~~~~

.. autoapisummary::

   beam_pointing.BeamModel



Functions
~~~~~~~~~

.. autoapisummary::

   beam_pointing.arg_init
   beam_pointing.get_shift
   beam_pointing.make_ref
   beam_pointing.get_beampos_errors
   beam_pointing.get_beampos_errs
   beam_pointing.save_shifts
   beam_pointing.plot_beampos_errors
   beam_pointing.main



Attributes
~~~~~~~~~~

.. autoapisummary::

   beam_pointing.aces_cfg
   beam_pointing.fp_factory
   beam_pointing.EXPLANATION
   beam_pointing.HELPSTART


.. py:data:: aces_cfg

   

.. py:data:: fp_factory

   

.. py:data:: EXPLANATION
   :value: 'The beam_pointing process ....\n'

   

.. py:data:: HELPSTART
   :value: 'The ...\n'

   

.. py:function:: arg_init()

   Define the interpretation of command line arguments.
       


.. py:function:: get_shift(obj, ref_im, target_im, frac=0.25)

   Compute the shift of target_im relative to ref_im.
   Use Fourier shift theorem
   param: obj (MapSet)
   param: ref_im (ndarray) Reference image ndim=2
   param: target_im (ndarray) Target image
   param: frac (float) Mask transform values < ampMax * frac in phase fit.


.. py:class:: BeamModel(pickle_file)

   Bases: :py:obj:`object`

   .. py:attribute:: delta_x
      :value: 0.6

      

   .. py:attribute:: edge
      :value: 4.2

      

   .. py:attribute:: centre
      :value: 7.0

      

   .. py:method:: get(pixoff, freq)



.. py:function:: make_ref(obj, beam, chan)


.. py:function:: get_beampos_errors(obj, bmodel, chan)


.. py:function:: get_beampos_errs(obj, bmodel)


.. py:function:: save_shifts(obj, shifts, resids, amps, holo_dir, sbid)


.. py:function:: plot_beampos_errors(beam_pos, beam_pos_errs, remove_mean, plot_file_name=None, **kw)


.. py:function:: main()