wofryimpl.beamline.optical_elements.util.s4_conic

S4Conic — conic-section optical surface (sphere, ellipsoid, paraboloid, hyperboloid, plane) for wofryimpl mirrors.

Classes

S4Conic([ccc])

class wofryimpl.beamline.optical_elements.util.s4_conic.S4Conic(ccc=array([0., 0., 0., 0., 0., 0., 0., 0., 0., 0.]))

apply_crystal_diffraction_bragg_symmetric_on_beam(newbeam)

apply_grating_diffraction_on_beam(newbeam, ruling=[0.0], order=0, f_ruling=0)

apply_refraction_on_beam(newbeam, refraction_index_object, refraction_index_image)

apply_specular_reflection_on_beam(newbeam)

classmethod calculate_ellipsoid_parameters_from_focal_distances(ssour, simag, theta_grazing, verbose=True)

calculate_intercept(XIN, VIN, keep=0)

choose_solution(TPAR1, TPAR2, reference_distance=10.0)

duplicate()

get_coefficients()

get_normal(x2)

height(y=0, x=0, return_solution=0)

Compute the surface height z for given transverse coordinates.

Parameters:

• y (float or array_like) – Coordinate along the tangential (length) axis [m]. Must be homogeneous with x (both scalars, both vectors, or one scalar and the other a vector).

• x (float or array_like) – Coordinate along the sagittal (width) axis [m].

• return_solution (int, optional) –

  Which root of the conic equation to return:

  • 0 (default) — the root closest to zero at the pole.

  • 1 — first root (positive sign).

  • 2 — second root (negative sign).

Returns:

Surface height z(x, y) [m].

Return type:

float or numpy.ndarray

info()

Return a human-readable summary of the conic coefficients.

Returns:

Multi-line string showing the ten conic equation coefficients.

Return type:

str

classmethod initialize_as_ellipsoid_from_focal_distances(p, q, theta1, cylindrical=0, cylangle=0.0, switch_convexity=0)

classmethod initialize_as_hyperboloid_from_focal_distances(p, q, theta1, cylindrical=0, cylangle=0.0, switch_convexity=0)

classmethod initialize_as_paraboloid_from_focal_distances(p, q, theta1, cylindrical=0, cylangle=0.0, switch_convexity=0)

classmethod initialize_as_plane()

classmethod initialize_as_sphere_from_curvature_radius(radius, cylindrical=0, cylangle=0.0, switch_convexity=0)

classmethod initialize_as_sphere_from_focal_distances(p, q, theta1, cylindrical=0, cylangle=0.0, switch_convexity=0)

classmethod initialize_from_coefficients(ccc)

rotation_surface_conic(alpha, axis)

rotation_surface_conic_x(alpha)

rotation_surface_conic_y(alpha)

rotation_surface_conic_z(alpha)

set_coefficients(ccc)

set_cylindrical(CIL_ANG)

set_ellipsoid_from_external_parameters(AXMAJ, AXMIN, ELL_THE)

set_ellipsoid_from_focal_distances(ssour, simag, theta_grazing, verbose=True)

set_hyperboloid_from_focal_distances(SSOUR, SIMAG, theta_grazing, verbose=True)

set_paraboloid_from_focal_distances(SSOUR, SIMAG, theta_grazing, infinity_location='', verbose=True)

set_sphere_from_curvature_radius(rmirr)

set_sphere_from_focal_distances(ssour, simag, theta_grazing, verbose=True)

surface_height(x, y, return_solution=0)

switch_convexity()

translation_surface_conic(x0, axis='x')

translation_surface_conic_x(x0)

translation_surface_conic_y(y0)

translation_surface_conic_z(z0)

vector_reflection(v1, normal)

z_vs_xy(x, y)