:mod:`ocelot.rad.undulator_params`
==================================

.. py:module:: ocelot.rad.undulator_params

.. autoapi-nested-parse::

   simple functions to estimate radiation properties.

   Sergey Tomin.



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

Classes
~~~~~~~

.. autoapisummary::

   ocelot.rad.undulator_params.ID_radiation
   ocelot.rad.undulator_params.UndulatorParameters



Functions
~~~~~~~~~

.. autoapisummary::

   ocelot.rad.undulator_params.lambda2eV
   ocelot.rad.undulator_params.eV2lambda
   ocelot.rad.undulator_params.Ephoton2K
   ocelot.rad.undulator_params.K2Ephoton
   ocelot.rad.undulator_params.K2Lambda
   ocelot.rad.undulator_params.field2K
   ocelot.rad.undulator_params.K2field
   ocelot.rad.undulator_params.field2Ephoton
   ocelot.rad.undulator_params.Ephoton2field
   ocelot.rad.undulator_params.lambda2Ebeam
   ocelot.rad.undulator_params.print_rad_props


.. function:: lambda2eV(Lambda)


.. function:: eV2lambda(Ephoton)


.. function:: Ephoton2K(Eph, lu=0.04, Eeb=14)


.. function:: K2Ephoton(K, lu=0.04, E=14)


.. function:: K2Lambda(K, lu=0.04, E=14)


.. function:: field2K(field, lu=0.04)

   function to translate magnetic field in [T] to K parameter
   :param field: in [T]
   :param lu: undulator period in [m]
   :return: K


.. function:: K2field(K, lu=0.04)


.. function:: field2Ephoton(field, lu=0.04, E=14)


.. function:: Ephoton2field(energy, lu=0.04, Eeb=14)


.. function:: lambda2Ebeam(Lambda=1.04e-08, lu=0.0272, K=1.2392)


.. py:class:: ID_radiation(beam, undulator)

   .. method:: f_n(self, nharm, K)


   .. method:: flux(self, current, K, nharm, energy, L, lperiod)


   .. method:: eff_sizes(self, K)


   .. method:: Flux(self, K, nharm=1)


   .. method:: Flux_tot(self, K, nharm)


   .. method:: Brightness(self, K, nharm)



.. function:: print_rad_props(beam, K, lu, L, distance)

   Simple function to estimate radiation properties and print them

   :param beam: Beam
   :param K: undulator deflection parameter
   :param lu: undulator period in [m]
   :param L: undulator length in [m]
   :param distance: distance to the screen im [m]
   :return:


.. py:class:: UndulatorParameters(und=None, el_E=1.0)

   .. method:: recalculate(self)


   .. method:: computeRadiationAnalytical(self, z0, theta, phi, dwRel=0.1, npoints=100)


   .. method:: get_k(self, E)


   .. method:: printParameters(self)