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

.. py:module:: aces.beamset.surfacegaussian

.. autoapi-nested-parse::

   Example use of BeamSet and subclasses BeamModel.

   Copyright (C) CSIRO 2017



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

Classes
~~~~~~~

.. autoapisummary::

   aces.beamset.surfacegaussian.SurfaceGaussian



Functions
~~~~~~~~~

.. autoapisummary::

   aces.beamset.surfacegaussian.guess_params



Attributes
~~~~~~~~~~

.. autoapisummary::

   aces.beamset.surfacegaussian.GAUSS_WID_FACT


.. py:data:: GAUSS_WID_FACT

   

.. py:function:: guess_params(bmap)


.. py:class:: SurfaceGaussian(params=[])

   Bases: :py:obj:`aces.beamset.model.Model`

   .. py:attribute:: PARAM_NAMES
      :value: ['baseHeight', 'amplitude', 'xPos', 'yPos', 'xWidth', 'yWidth', 'rotation', 'residual_rms']

      

   .. py:attribute:: NUM_PARAMS

      

   .. py:attribute:: FUNCTION_NAME
      :value: '2D gaussian'

      

   .. py:attribute:: SHORT_NAME
      :value: 'gauss2D'

      

   .. py:method:: fit(bmap)


   .. py:method:: _fill_attributes()


   .. py:method:: get_residual_rms()


   .. py:method:: evaluate(xw, yw)


   .. py:method:: get_locus50(arg)


   .. py:method:: _locus50(phi)


   .. py:method:: get_world_params()


   .. py:method:: get_index_params()


   .. py:method:: _world_to_indexPar(wp)


   .. py:method:: _index_to_worldPar(ip)