syned.beamline.optical_elements.refractors package

Submodules

syned.beamline.optical_elements.refractors.crl module

class syned.beamline.optical_elements.refractors.crl.CRL(name='Undefined', n_lens=1, surface_shape1=None, surface_shape2=None, boundary_shape=None, material='', thickness=0.0, piling_thickness=0.0)[source]

Bases: Lens

Defines a Compound refractive lens (CRL). It is composed by a number (n_lens) of identical lenses.

Constructor.

Parameters:

  • name (str, optional) – The name of the optical element.

  • n_lens (int, optional) – The number of (identical) lenses.

  • surface_shape1 (instance of SurfaceShape, optional) – The geometry of the lens surface 1. if None, it is initialized to SurfaceShape().

  • surface_shape2 (instance of SurfaceShape, optional) – The geometry of the lens surface 2. if None, it is initialized to SurfaceShape().

  • boundary_shape (instance of BoundaryShape, optional) – The geometry of the slit aperture. if None, it is initialized to BoundaryShape().

  • material (str) – A string defining the material within the two surfaces.

  • thickness (float) – The distance between the two surfaces at the center of the lens in m.

  • piling_thickness (float, optional) – The piling distance in m, or spatial periodicity in the stack. In other words, the distance from the lens1-surface1 to the lens2-surface1.

get_n_lens()[source]

Returns the number of lenses.

Return type:

int

get_piling_thickness()[source]

Returns the piling thickness.

Return type:

float

syned.beamline.optical_elements.refractors.interface module

class syned.beamline.optical_elements.refractors.interface.Interface(name='Undefined', surface_shape=<syned.beamline.shape.SurfaceShape object>, boundary_shape=None, material_object=None, material_image=None)[source]

Bases: OpticalElementsWithSurfaceShape

get_material_image()[source]

Returns the material of side 2 (image).

Return type:

str

get_material_object()[source]

Returns the material of side 1 (object).

Return type:

str

syned.beamline.optical_elements.refractors.lens module

class syned.beamline.optical_elements.refractors.lens.Lens(name='Undefined', surface_shape1=None, surface_shape2=None, boundary_shape=None, material='', thickness=0.0)[source]

Bases: OpticalElementsWithMultipleShapes

get_boundary_shape()[source]

Returns the boundary shape.

Return type:

instance of BoundaryShape

get_material()[source]

Returns the lens material.

Return type:

str

get_surface_shape1()[source]

Returns the shape of surface 1.

Return type:

instance of SurfaceShape

get_surface_shape2()[source]

Returns the shape of surface 2.

Return type:

instance of SurfaceShape

get_thickness()[source]

Returns the lens thickness in m.

Return type:

float

Module contents