:mod:`ocelot.rad.fel`
=====================

.. py:module:: ocelot.rad.fel


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

Classes
~~~~~~~

.. autoapisummary::

   ocelot.rad.fel.FelParameters
   ocelot.rad.fel.FelParametersArray



Functions
~~~~~~~~~

.. autoapisummary::

   ocelot.rad.fel.calculateFelParameters
   ocelot.rad.fel.beam2fel
   ocelot.rad.fel.printFelParameters


.. data:: _logger
   

   

.. py:class:: FelParameters

   .. method:: eval(self, method='mxie')


   .. method:: beta_opt(self, method='mxie', apply=False, **kwargs)


   .. method:: log(self, type='debug')


   .. method:: P(self, z=None)

      returns sase power at distance z
      unfinished


   .. method:: E(self, z=None)


   .. method:: tcoh(self, z=None)


   .. method:: P_sat(self)


   .. method:: phen0(self)
      :property:


   .. method:: phenh(self)
      :property:


   .. method:: spectrogram(self, z=None)


   .. method:: spectrum(self, z=None)



.. py:class:: FelParametersArray

   Bases: :class:`ocelot.rad.fel.FelParameters`

   .. method:: idx(self)
      :property:



.. function:: calculateFelParameters(input, array=False, method='mxie')


.. function:: beam2fel(beam, lu, K_peak, iwityp=0, method='mxie', hn=1, qf=0)

   tmp function to estimate fel parameters slice-wise
   hn = harmonic number
   qf = account for quantum fluctuations


.. function:: printFelParameters(p)