syned.beamline.shape.Toroid

class syned.beamline.shape.Toroid(min_radius=0.0, maj_radius=0.0)[source]

Creator.

Parameters:

  • min_radius (float, optional) – The toroid minor radius

  • maj_radius (float, optional) – The toroid major radius. Note that this is the “optical” major radius at the farest surface from the center of the toroid. Indeed, it corresponds to the “toroid major radius” plus the min_radius.

__init__(min_radius=0.0, maj_radius=0.0)[source]

Methods

__init__([min_radius, maj_radius])

create_toroid_from_p_q([p, q, grazing_angle])

returns a Toroid from factory parameters.

create_toroid_from_radii([min_radius, ...])

returns a Toroid from main parameters (radii).

duplicate()

Returns a copy of the SYNED object instance.

from_hex_tring(hex_string)

get_convexity()

Gets the convexity flag.

get_maj_radius()

Returns the major (optical) radius.

get_min_radius()

Returns the minor radius.

get_radii()

Returns the radii.

get_value_from_key_name(key)

Gets a value using its key value.

info()

Get text info of recurrent SYNED objects.

info_recurrent(fd[, prefix])

Get text info of recurrent SYNED objects.

initialize_from_p_q([p, q, grazing_angle])

Sets the parameters calculated from the factory parameters.

keys()

Returns the keys of the supporting doctionary.

set_value_from_key_name(key, value)

Sets a value using its key value.

to_dictionary()

Returns a dictionary with the object fields.

to_full_dictionary()

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

to_hex_tring()

to_json([file_name])

Writes a json file with the SYNED object data.