syned.beamline.shape.Ellipse

class syned.beamline.shape.Ellipse(a_axis_min=-1e-05, a_axis_max=1e-05, b_axis_min=-5e-06, b_axis_max=5e-06)[source]

Constructor.

Parameters:

  • a_axis_min (float, optional) – The coordinate (signed) of the minimum (left) along the major axis.

  • a_axis_max (float, optional) – The coordinate (signed) of the maximum (right) along the major axis.

  • b_axis_min (float, optional) – The coordinate (signed) of the minimum (left) along the minor axis.

  • b_axis_max (float, optional) – The coordinate (signed) of the maximum (right) along the minor axis.

__init__(a_axis_min=-1e-05, a_axis_max=1e-05, b_axis_min=-5e-06, b_axis_max=5e-06)[source]

Methods

__init__([a_axis_min, a_axis_max, ...])

duplicate()

Returns a copy of the SYNED object instance.

from_hex_tring(hex_string)

get_axis()

Returns the length of the ellipse axes.

get_boundaries()

Returns the coordinates of the ellipse.

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.

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.