Package API

This page lists main classes in this package.

syned classes.

main

syned Base class

syned_object

beamline

syned.beamline A beamline is made by a light_source and one or several beamline_element

syned.beamline.beamline

Represents a beamline.

light source

Light source = Electron beam + magnetic structure

syned.storage_ring.light_source Electron beam + magnetic structure

syned.storage_ring.light_source
syned.storage_ring.empty_light_source Empty light source

syned.storage_ring.empty_light_source

Base class for LighSource, which contains:

eletron beam

Electron beam

syned.storage_ring.electron_beam Electron beam

syned.storage_ring.electron_beam

Base class for electron beams.

magnetic structures

Magnetic structures

syned.storage_ring.magnetic_structures Magnetic structures

`syned.storage_ring.magnetic_structure`
`syned.storage_ring.magnetic_structures.bending_magnet`	Base class for a Bending Magnet
`syned.storage_ring.magnetic_structures.insertion_device`	Base class for all insertion devices: wiggler, undulator
`syned.storage_ring.magnetic_structures.undulator`	Implement an undulator with vertical and horizontal magnetic fields.
`syned.storage_ring.magnetic_structures.wiggler`

beamline element

syned.beamline.beamline_element A beamline element is made by an optical_element and the element_coordinates

syned.beamline.beamline_element

Base class for all beamline elements.

syned.beamline.optical_element optical element

`syned.beamline.optical_element`	Base class for an optical element.
`syned.beamline.optical_element_with_surface_shape`	Base classes for optical elements with shape(s).

syned.beamline.element_coordinates element coordinates

syned.beamline.element_coordinates

Position coordinates of a beamline component.

optical elements

syned.beamline.optical_elements Optical elements

syned.beamline.optical_elements.ideal_elements ideal_element, screen, ideal_lens

`syned.beamline.optical_elements.ideal_elements.ideal_element`
`syned.beamline.optical_elements.ideal_elements.screen`
`syned.beamline.optical_elements.ideal_elements.ideal_lens`
`syned.beamline.optical_elements.ideal_elements.ideal_fzp`

syned.beamline.optical_elements.absorbers absorber, beam_stopper, filter, holed_filter, slit

`syned.beamline.optical_elements.absorbers.absorber`
`syned.beamline.optical_elements.absorbers.beam_stopper`
`syned.beamline.optical_elements.absorbers.filter`
`syned.beamline.optical_elements.absorbers.holed_filter`
`syned.beamline.optical_elements.absorbers.slit`

syned.beamline.optical_elements.crystals crystals

syned.beamline.optical_elements.crystals.crystal

syned.beamline.optical_elements.gratings gratings

syned.beamline.optical_elements.gratings.grating

syned.beamline.optical_elements.mirrors mirrors

syned.beamline.optical_elements.mirrors.mirror

syned.beamline.optical_elements.multilayers multilayer

syned.beamline.optical_elements.multilayers.multilayer

syned.beamline.optical_elements.refractors interface, lens, crl

`syned.beamline.optical_elements.refractors.interface`
`syned.beamline.optical_elements.refractors.lens`
`syned.beamline.optical_elements.refractors.crl`

geometrical shapes

syned.beamline.shape Utilities for defining geometrical surface shapes and boundary shapes

syned.beamline.shape.Shape Base class

syned.beamline.shape.Shape()

Constructor.

syned.beamline.shape.SurfaceShape Surface shape classes

`syned.beamline.shape.SurfaceShape`([convexity])	Constructor.
`syned.beamline.shape.Cylinder`([...])	Defines that a surface shape is cylindrical in one direction.
`syned.beamline.shape.Conic`([conic_coefficients])	Defines a conic surface shape expresses via the 10 conic coeffcients.
`syned.beamline.shape.Plane`()	Defines a plane surface shape.
`syned.beamline.shape.Sphere`([radius, convexity])	Defines an spherical surface.
`syned.beamline.shape.SphericalCylinder`([...])	Constructor.
`syned.beamline.shape.Ellipsoid`([min_axis, ...])	Constructor.
`syned.beamline.shape.EllipticalCylinder`([...])	Constructor.
`syned.beamline.shape.Hyperboloid`([min_axis, ...])	Constructor.
`syned.beamline.shape.HyperbolicCylinder`([...])	Constructor.
`syned.beamline.shape.Paraboloid`([...])	Constructor.
`syned.beamline.shape.ParabolicCylinder`([...])	Constructor.
`syned.beamline.shape.Toroid`([min_radius, ...])	Creator.
`syned.beamline.shape.NumericalMesh`([xx, yy, ...])	Implements an optical surface from a numerical mesh.

syned.beamline.shape.BoundaryShape Boundary shape classes

`syned.beamline.shape.BoundaryShape`()	Constructor.
`syned.beamline.shape.Rectangle`([x_left, ...])	Constructor.
`syned.beamline.shape.Ellipse`([a_axis_min, ...])	Constructor.
`syned.beamline.shape.Circle`([radius, ...])	Constructor.
`syned.beamline.shape.Polygon`([x, y])	Constructor.
`syned.beamline.shape.DoubleRectangle`([...])	Constructor.
`syned.beamline.shape.DoubleEllipse`([...])	Constructor.
`syned.beamline.shape.DoubleCircle`([radius1, ...])	Constructor.
`syned.beamline.shape.MultiplePatch`([patch_list])	Constructor.
`syned.beamline.shape.TwoEllipses`([...])	Constructor.

Others

syned.beamline.shape.Convexity()

syned.beamline.shape.Direction()

syned.beamline.shape.Side()