enge

zgoubidoo.fieldmaps.fieldmap.enge(s: Union[float, numpy.array], ce_0: float = 0.0, ce_1: float = 1.0, ce_2: float = 0.0, ce_3: float = 0.0, ce_4: float = 0.0, ce_5: float = 0.0, cs_0: float = 0.0, cs_1: float = 1.0, cs_2: float = 0.0, cs_3: float = 0.0, cs_4: float = 0.0, cs_5: float = 0.0, lam_e: float = 1.0, lam_s: float = 1.0, offset_e: float = - 1.0, offset_s: float = 1.0, amplitude: float = 1.0, field_offset: float = 0.0) → Union[float, numpy.array][source]

Enge function for the modelling of fringe fields.

Parameters

  • s – the coordinate (can be a numpy array)

  • ce_0 – zero-th order coefficient for the entrance fringe

  • ce_1 – first order coefficient for the entrance fringe (usually set to 1)

  • ce_2 – second order coefficent for the entrance fringe

  • ce_3 – third order coefficient for the entrance fringe

  • ce_4 – fourth order coefficient for the entrance fringe

  • ce_5 – fifth order coefficient for the entrance fringe

  • cs_0 – zero-th order coefficient for the exit fringe

  • cs_1 – first order coefficient for the exit fringe (usually set to 1)

  • cs_2 – second order coefficient for the exit fringe

  • cs_3 – third order coefficient for the exit fringe

  • cs_4 – fourth order coefficient for the exit fringe

  • cs_5 – fifth order coefficient for the exit fringe

  • lam_e – characteristic length of the entrance fringe

  • lam_s – characteristic length of the exit fringe

  • offset_e – offset for the positionning of the entrance fall-off

  • offset_s – offset for the positionning of the exit fall-off

  • amplitude – field amplitude (not necesserally equal to the maximum)

  • field_offset – field offset

Returns

the value of the Enge function at coordinate s.