:py:mod:`aces.misc.image_stats`
===============================

.. py:module:: aces.misc.image_stats


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


Functions
~~~~~~~~~

.. autoapisummary::

   aces.misc.image_stats.fit_func2
   aces.misc.image_stats.err_func2
   aces.misc.image_stats.fit_g
   aces.misc.image_stats.find_mode
   aces.misc.image_stats.shrink_mask
   aces.misc.image_stats.get_beam_offsets
   aces.misc.image_stats.do_statistics
   aces.misc.image_stats.image_cell_statistic



Attributes
~~~~~~~~~~

.. autoapisummary::

   aces.misc.image_stats.__author__
   aces.misc.image_stats.funcs


.. py:data:: __author__
   :value: 'Dave McConnell <david.mcconnell@csiro.au>'

   

.. py:function:: fit_func2(p, x)


.. py:function:: err_func2(p, x, y)


.. py:data:: funcs

   

.. py:function:: fit_g(x, y, p0, fkey='gau')

   :param x: independent coordinate (bin centres)
   :param y: histogram frequencies
   :param p0: initial guess fit params
   :param fkey: Selects function to fit


.. py:function:: find_mode(data, parameters, diag_plot=False)

   Estimates and returns the mode of those input data that lie within the limits set by the parameters.
   The mode is determined by fitting a guassian function to the peak of the histogram of the logarithms of
   the values.

   :param data: np.array of real values
   :param parameters: dictionary giving the data value bounds
   :param diag_plot: used for debugging histogram analysis
   :return:


.. py:function:: shrink_mask(data, n=25)


.. py:function:: get_beam_offsets(fp_name, fp_pitch, fp_ang)


.. py:function:: do_statistics(y, incr, do_mask=True)

   :param y: image masked array
   :param incr: pixel increment in radians
   :param do_mask: if True, expand mask (shrink unmasked area)


.. py:function:: image_cell_statistic(in_file, out_dir, cellsize=100, statistic='rms', do_mask=True, replace_old=True)

   Compute some statistic over square cells in an image
   :param in_file: input image as fits file
   :param cellsize: cell size in pixels
   :param statistic: what statistic to compute.
   :param do_mask: Modify masked portion image to eliminate annoying edge effects, particularly in rms.
   :param replace_old: If True, replace previous statistics image.
   :return: