syned.beamline.optical_elements.gratings package

Submodules

syned.beamline.optical_elements.gratings.grating module

class syned.beamline.optical_elements.gratings.grating.Grating(name='Undefined', surface_shape=<syned.beamline.shape.SurfaceShape object>, boundary_shape=<syned.beamline.shape.BoundaryShape object>, ruling=800000.0)[source]

Bases: OpticalElementsWithSurfaceShape

Constructor.

Parameters:

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

  • surface_shape (instance of SurfaceShape, optional) – The geometry of the crystal surface. 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().

  • ruling (float, optional) – The grating ruling in lines/m.

class syned.beamline.optical_elements.gratings.grating.GratingBlaze(name='Undefined', surface_shape=<syned.beamline.shape.SurfaceShape object>, boundary_shape=<syned.beamline.shape.BoundaryShape object>, ruling=800000.0, ruling_coeff_linear=0.0, ruling_coeff_quadratic=0.0, ruling_coeff_cubic=0.0, ruling_coeff_quartic=0.0, coating=None, coating_thickness=None, blaze_angle=0.0, antiblaze_angle=90.0)[source]

Bases: GratingVLS

Constructor.

Parameters:

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

  • surface_shape (instance of SurfaceShape, optional) – The geometry of the crystal surface. 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().

  • ruling (float, optional) – The grating ruling polinomial coefficient of 0th order [lines/m].

  • ruling_coeff_linear (float, optional) – The grating ruling polinomial coefficient of 1th order [lines/m^2].

  • ruling_coeff_quadratic (float, optional) – The grating ruling polinomial coefficient of 2th order [lines/m^3].

  • ruling_coeff_cubic (float, optional) – The grating ruling polinomial coefficient of 3th order [lines/m^4].

  • ruling_coeff_quartic (float, optional) – The grating ruling polinomial coefficient of 4th order [lines/m^5].

  • coating (str, optional) – The grating coating material.

  • coating_thickness (float, optional) – The grating coating thickness in m.

  • blaze_angle (float, optional) – The blaze angle in rad.

  • antiblaze_angle (float, optional) – The anti-blaze angle in rad.

get_apex_angle()[source]
class syned.beamline.optical_elements.gratings.grating.GratingLamellar(name='Undefined', surface_shape=<syned.beamline.shape.SurfaceShape object>, boundary_shape=<syned.beamline.shape.BoundaryShape object>, ruling=800000.0, ruling_coeff_linear=0.0, ruling_coeff_quadratic=0.0, ruling_coeff_cubic=0.0, coating=None, coating_thickness=None, height=1e-06, ratio_valley_to_period=0.5)[source]

Bases: GratingVLS

Constructor.

Parameters:

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

  • surface_shape (instance of SurfaceShape, optional) – The geometry of the crystal surface. 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().

  • ruling (float, optional) – The grating ruling polinomial coefficient of 0th order [lines/m].

  • ruling_coeff_linear (float, optional) – The grating ruling polinomial coefficient of 1th order [lines/m^2].

  • ruling_coeff_quadratic (float, optional) – The grating ruling polinomial coefficient of 2th order [lines/m^3].

  • ruling_coeff_cubic (float, optional) – The grating ruling polinomial coefficient of 3th order [lines/m^4].

  • ruling_coeff_quartic (float, optional) – The grating ruling polinomial coefficient of 4th order [lines/m^5].

  • coating (str, optional) – The grating coating material.

  • coating_thickness (float, optional) – The grating coating thickness in m.

  • height (str, optional) – The height of the grating lamella in m.

  • ratio_valley_to_period (float, optional) – The grating ration valley to period.

class syned.beamline.optical_elements.gratings.grating.GratingVLS(name='Undefined', surface_shape=<syned.beamline.shape.SurfaceShape object>, boundary_shape=<syned.beamline.shape.BoundaryShape object>, ruling=800000.0, ruling_coeff_linear=0.0, ruling_coeff_quadratic=0.0, ruling_coeff_cubic=0.0, ruling_coeff_quartic=0.0, coating=None, coating_thickness=None)[source]

Bases: Grating

Constructor.

Parameters:

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

  • surface_shape (instance of SurfaceShape, optional) – The geometry of the optical element surface. 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().

  • ruling (float, optional) – The grating ruling polinomial coefficient of 0th order [lines/m].

  • ruling_coeff_linear (float, optional) – The grating ruling polinomial coefficient of 1th order [lines/m^2].

  • ruling_coeff_quadratic (float, optional) – The grating ruling polinomial coefficient of 2th order [lines/m^3].

  • ruling_coeff_cubic (float, optional) – The grating ruling polinomial coefficient of 3th order [lines/m^4].

  • ruling_coeff_quartic (float, optional) – The grating ruling polinomial coefficient of 4th order [lines/m^5].

  • coating (str, optional) – The grating coating material.

  • coating_thickness (float, optional) – The grating coating thickness in m.

Module contents