Ctrl+K

pysrw.lib.srwlib.SRWLMagFldC

pysrw.lib.srwlib.SRWLMagFldC#

class pysrw.lib.srwlib.SRWLMagFldC(_arMagFld=None, _arXc=None, _arYc=None, _arZc=None, _arVx=None, _arVy=None, _arVz=None, _arAng=None)[source]#

Bases: SRWLMagFld

Magnetic Field: Container

__init__(_arMagFld=None, _arXc=None, _arYc=None, _arZc=None, _arVx=None, _arVy=None, _arVz=None, _arAng=None)[source]#
Parameters:

  • _arMagFld – magnetic field structures array

  • _arXc – horizontal center positions of magnetic field elements in arMagFld array [m]

  • _arYc – vertical center positions of magnetic field elements in arMagFld array [m]

  • _arZc – longitudinal center positions of magnetic field elements in arMagFld array [m]

  • _arVx – horizontal components of axis vectors of magnetic field elements in arMagFld array [rad]

  • _arVy – vertical components of axis vectors of magnetic field elements in arMagFld array [rad]

  • _arVz – longitudinal components of axis vectors of magnetic field elements in arMagFld array [rad]

  • _arAng – rotation angles of magnetic field elements about their axes [rad]

Methods

__init__([_arMagFld, _arXc, _arYc, _arZc, ...])

param _arMagFld:

magnetic field structures array

add(_mag[, _xc, _yc, _zc, _vx, _vy, _vz, _ang])

Adds magnetic element to container :param _mag: magnetic element (or array of elements) to be added :param _xc: horizontal center position (or array of center positions) of magnetic field element to be added [m] :param _yc: vertical center positions (or array of center positions) of magnetic field element to be added [m] :param _zc: longitudinal center positions (or array of center positions) of magnetic field element to be added [m] :param _vx: horizontal component of axis vectors of magnetic field element to be added [rad] :param _vy: vertical component of axis vectors of magnetic field element to be added [rad] :param _vz: longitudinal components of axis vector of magnetic field element to be added [rad] :param _ang: rotation angle about axis [rad]

allocate(_nElem)

add(_mag, _xc=None, _yc=None, _zc=None, _vx=None, _vy=None, _vz=None, _ang=None)[source]#

Adds magnetic element to container :param _mag: magnetic element (or array of elements) to be added :param _xc: horizontal center position (or array of center positions) of magnetic field element to be added [m] :param _yc: vertical center positions (or array of center positions) of magnetic field element to be added [m] :param _zc: longitudinal center positions (or array of center positions) of magnetic field element to be added [m] :param _vx: horizontal component of axis vectors of magnetic field element to be added [rad] :param _vy: vertical component of axis vectors of magnetic field element to be added [rad] :param _vz: longitudinal components of axis vector of magnetic field element to be added [rad] :param _ang: rotation angle about axis [rad]

Contents