syned package

Subpackages

• syned.beamline package
  • Subpackages
    • syned.beamline.optical_elements package
      • Subpackages
      • Module contents
  • Submodules
  • syned.beamline.beamline module
    • Beamline
      • Beamline.append_beamline_element()
      • Beamline.duplicate()
      • Beamline.get_beamline_element_at()
      • Beamline.get_beamline_elements()
      • Beamline.get_beamline_elements_number()
      • Beamline.get_light_source()
      • Beamline.set_light_source()
      • Beamline.to_dictionary()
  • syned.beamline.beamline_element module
    • BeamlineElement
      • BeamlineElement.get_coordinates()
      • BeamlineElement.get_optical_element()
      • BeamlineElement.set_coordinates()
      • BeamlineElement.set_optical_element()
  • syned.beamline.element_coordinates module
    • ElementCoordinates
      • ElementCoordinates.angle_azimuthal()
      • ElementCoordinates.angle_radial()
      • ElementCoordinates.angle_radial_out()
      • ElementCoordinates.get_angles()
      • ElementCoordinates.get_p_and_q()
      • ElementCoordinates.get_positions()
      • ElementCoordinates.p()
      • ElementCoordinates.q()
      • ElementCoordinates.set_angles()
      • ElementCoordinates.set_p_and_q()
      • ElementCoordinates.set_positions()
  • syned.beamline.optical_element module
    • OpticalElement
      • OpticalElement.get_boundary_shape()
      • OpticalElement.get_name()
  • syned.beamline.optical_element_with_surface_shape module
    • OpticalElementsWithMultipleShapes
      • OpticalElementsWithMultipleShapes.get_surface_shape()
      • OpticalElementsWithMultipleShapes.set_surface_shape()
    • OpticalElementsWithSurfaceShape
      • OpticalElementsWithSurfaceShape.get_surface_shape()
      • OpticalElementsWithSurfaceShape.set_surface_shape()
  • syned.beamline.shape module
    • BoundaryShape
      • BoundaryShape.get_boundaries()
    • Circle
      • Circle.get_boundaries()
      • Circle.get_center()
      • Circle.get_radius()
      • Circle.set_boundaries()
    • Conic
      • Conic.get_conic_coefficients()
    • Convexity
      • Convexity.DOWNWARD
      • Convexity.NONE
      • Convexity.UPWARD
    • Cylinder
      • Cylinder.get_cylinder_direction()
    • Direction
      • Direction.SAGITTAL
      • Direction.TANGENTIAL
    • DoubleCircle
      • DoubleCircle.set_boundaries()
    • DoubleEllipse
      • DoubleEllipse.set_boundaries()
    • DoubleRectangle
      • DoubleRectangle.set_boundaries()
    • Ellipse
      • Ellipse.get_axis()
      • Ellipse.get_boundaries()
    • Ellipsoid
      • Ellipsoid.create_ellipsoid_from_axes()
      • Ellipsoid.create_ellipsoid_from_p_q()
      • Ellipsoid.get_a()
      • Ellipsoid.get_angle_pole_from_origin()
      • Ellipsoid.get_axes()
      • Ellipsoid.get_axis_from_p_q()
      • Ellipsoid.get_b()
      • Ellipsoid.get_c()
      • Ellipsoid.get_eccentricity()
      • Ellipsoid.get_grazing_angle()
      • Ellipsoid.get_mirror_center()
      • Ellipsoid.get_p_focus()
      • Ellipsoid.get_p_q()
      • Ellipsoid.get_p_q_from_axis()
      • Ellipsoid.get_q_focus()
      • Ellipsoid.initialize_from_p_q()
      • Ellipsoid.initialize_from_shadow_parameters()
    • EllipticalCylinder
      • EllipticalCylinder.create_elliptical_cylinder_from_axes()
      • EllipticalCylinder.create_elliptical_cylinder_from_p_q()
      • EllipticalCylinder.get_p_q()
      • EllipticalCylinder.initialize_from_p_q()
    • HyperbolicCylinder
      • HyperbolicCylinder.create_hyperbolic_cylinder_from_axes()
      • HyperbolicCylinder.create_hyperbolic_cylinder_from_p_q()
      • HyperbolicCylinder.get_p_q()
      • HyperbolicCylinder.initialize_from_p_q()
    • Hyperboloid
      • Hyperboloid.create_hyperboloid_from_axes()
      • Hyperboloid.create_hyperboloid_from_p_q()
      • Hyperboloid.get_a()
      • Hyperboloid.get_axes()
      • Hyperboloid.get_axis_from_p_q()
      • Hyperboloid.get_b()
      • Hyperboloid.get_c()
      • Hyperboloid.get_eccentricity()
      • Hyperboloid.get_grazing_angle()
      • Hyperboloid.get_mirror_center()
      • Hyperboloid.get_p_focus()
      • Hyperboloid.get_p_q()
      • Hyperboloid.get_p_q_from_axis()
      • Hyperboloid.get_q_focus()
      • Hyperboloid.initialize_from_p_q()
    • MultiplePatch
      • MultiplePatch.append_circle()
      • MultiplePatch.append_ellipse()
      • MultiplePatch.append_patch()
      • MultiplePatch.append_polygon()
      • MultiplePatch.append_rectangle()
      • MultiplePatch.get_boundaries()
      • MultiplePatch.get_name_of_patch()
      • MultiplePatch.get_number_of_patches()
      • MultiplePatch.get_patch()
      • MultiplePatch.get_patches()
      • MultiplePatch.reset()
      • MultiplePatch.to_dictionary()
    • NumericalMesh
      • NumericalMesh.has_surface_data()
      • NumericalMesh.has_surface_data_file()
    • ParabolicCylinder
      • ParabolicCylinder.create_parabolic_cylinder_from_p_q()
      • ParabolicCylinder.create_parabolic_cylinder_from_parabola_parameter()
      • ParabolicCylinder.initialize_from_p_q()
    • Paraboloid
      • Paraboloid.create_paraboloid_from_p_q()
      • Paraboloid.create_paraboloid_from_parabola_parameter()
      • Paraboloid.get_at_infinity()
      • Paraboloid.get_grazing_angle()
      • Paraboloid.get_parabola_parameter()
      • Paraboloid.get_parabola_parameter_from_p_q()
      • Paraboloid.get_pole_to_focus()
      • Paraboloid.initialize_from_p_q()
    • Plane
    • Polygon
      • Polygon.check_inside()
      • Polygon.check_inside_one_point()
      • Polygon.check_inside_vector()
      • Polygon.check_outside()
      • Polygon.get_boundaries()
      • Polygon.get_number_of_vertices()
      • Polygon.get_polygon()
      • Polygon.set_boundaries()
    • Rectangle
      • Rectangle.get_boundaries()
      • Rectangle.set_boundaries()
      • Rectangle.set_width_and_length()
    • Shape
    • Side
      • Side.IMAGE
      • Side.SOURCE
    • Sphere
      • Sphere.create_sphere_from_p_q()
      • Sphere.create_sphere_from_radius()
      • Sphere.get_radius()
      • Sphere.get_radius_from_p_q()
      • Sphere.initialize_from_p_q()
    • SphericalCylinder
      • SphericalCylinder.create_spherical_cylinder_from_p_q()
      • SphericalCylinder.create_spherical_cylinder_from_radius()
      • SphericalCylinder.get_radius_from_p_q_sagittal()
      • SphericalCylinder.initialize_from_p_q()
    • SurfaceShape
      • SurfaceShape.get_convexity()
    • Toroid
      • Toroid.create_toroid_from_p_q()
      • Toroid.create_toroid_from_radii()
      • Toroid.get_maj_radius()
      • Toroid.get_min_radius()
      • Toroid.get_radii()
      • Toroid.initialize_from_p_q()
    • TwoEllipses
      • TwoEllipses.get_axis()
      • TwoEllipses.get_boundaries()
  • Module contents
• syned.storage_ring package
  • Subpackages
    • syned.storage_ring.magnetic_structures package
      • Submodules
      • syned.storage_ring.magnetic_structures.bending_magnet module
      • syned.storage_ring.magnetic_structures.insertion_device module
      • syned.storage_ring.magnetic_structures.undulator module
      • syned.storage_ring.magnetic_structures.wiggler module
      • Module contents
  • Submodules
  • syned.storage_ring.electron_beam module
    • ElectronBeam
      • ElectronBeam.current()
      • ElectronBeam.electron_speed()
      • ElectronBeam.emittance()
      • ElectronBeam.energy()
      • ElectronBeam.gamma()
      • ElectronBeam.get_dispersion_all()
      • ElectronBeam.get_dispersion_horizontal()
      • ElectronBeam.get_dispersion_vertical()
      • ElectronBeam.get_moments_all()
      • ElectronBeam.get_moments_horizontal()
      • ElectronBeam.get_moments_vertical()
      • ElectronBeam.get_sigmas_all()
      • ElectronBeam.get_sigmas_horizontal()
      • ElectronBeam.get_sigmas_vertical()
      • ElectronBeam.get_twiss_all()
      • ElectronBeam.get_twiss_horizontal()
      • ElectronBeam.get_twiss_no_dispersion_all()
      • ElectronBeam.get_twiss_no_dispersion_horizontal()
      • ElectronBeam.get_twiss_no_dispersion_vertical()
      • ElectronBeam.get_twiss_vertical()
      • ElectronBeam.has_dispersion()
      • ElectronBeam.initialize_as_pencil_beam()
      • ElectronBeam.lorentz_factor()
      • ElectronBeam.set_dispersion_all()
      • ElectronBeam.set_dispersion_horizontal()
      • ElectronBeam.set_dispersion_vertical()
      • ElectronBeam.set_energy_from_gamma()
      • ElectronBeam.set_moments_all()
      • ElectronBeam.set_moments_horizontal()
      • ElectronBeam.set_moments_vertical()
      • ElectronBeam.set_sigmas_all()
      • ElectronBeam.set_sigmas_horizontal()
      • ElectronBeam.set_sigmas_vertical()
      • ElectronBeam.set_twiss_all()
      • ElectronBeam.set_twiss_horizontal()
      • ElectronBeam.set_twiss_vertical()
  • syned.storage_ring.empty_light_source module
    • EmptyLightSource
      • EmptyLightSource.get_name()
  • syned.storage_ring.light_source module
    • LightSource
      • LightSource.get_electron_beam()
      • LightSource.get_magnetic_structure()
      • LightSource.get_name()
  • syned.storage_ring.magnetic_structure module
    • MagneticStructure
  • Module contents
• syned.util package
  • Submodules
  • syned.util.json_tools module
    • get_exec_commands_for_package()
    • load_from_json_dictionary_recurrent()
    • load_from_json_file()
    • load_from_json_text()
    • load_from_json_url()
  • Module contents
    • deprecated()
• syned.widget package
  • Submodules
  • syned.widget.widget_decorator module
    • WidgetDecorator
      • WidgetDecorator.append_syned_input_data()
      • WidgetDecorator.receive_syned_data()
      • WidgetDecorator.syned_input_data()
  • Module contents

Submodules

syned.syned_object module

class syned.syned_object.SynedObject

Bases: object

duplicate()

Returns a copy of the SYNED object instance.

Returns:

A copy of the object instance.

Return type:

SynedObject instance

classmethod from_hex_tring(hex_string)

get_value_from_key_name(key)

Gets a value using its key value.

Parameters:

key (str) – The key for the value to retrieve.

info()

Get text info of recurrent SYNED objects.

Return type:

str

info_recurrent(fd, prefix='    ')

Get text info of recurrent SYNED objects.

Parameters:

• fd (dict) – The dictionary with SYNED data.

• prefix (str, optional) – Prefix to indent recursive items.

Return type:

str

keys()

Returns the keys of the supporting doctionary. :returns: A list of keys. :rtype: list

set_value_from_key_name(key, value)

Sets a value using its key value.

Parameters:

• key (str) – The key for the value to modify.

• value – The new value

to_dictionary()

Returns a dictionary with the object fields.

Some dictionary keys may contain SYNED instances. Use to_full_dictionary to recurrently expand these objects in their basic ingredients.

Returns:

A dictionary with the data.

Return type:

dict

to_full_dictionary()

Returns a dictionary with the object fields, including other syned objects embedded or list of elements.

The “full” means that the SYNED instances found are recurrently expanded in their basic ingredients.

Return type:

dict

to_hex_tring()

to_json(file_name=None)

Writes a json file with the SYNED object data.

Parameters:

file_name (str) – The file name

Returns:

JSON formatted str. The result of json.dumps()

Return type:

str

Module contents