syned.beamline.shape.DoubleEllipse

class syned.beamline.shape.DoubleEllipse(a_axis_min1=-0.01, a_axis_max1=0.0, b_axis_min1=-0.02, b_axis_max1=0.0, a_axis_min2=-0.01, a_axis_max2=0.01, b_axis_min2=-0.001, b_axis_max2=0.02)[source]

Constructor.

Parameters:

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

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

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

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

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

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

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

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

__init__(a_axis_min1=-0.01, a_axis_max1=0.0, b_axis_min1=-0.02, b_axis_max1=0.0, a_axis_min2=-0.01, a_axis_max2=0.01, b_axis_min2=-0.001, b_axis_max2=0.02)[source]

Methods

__init__([a_axis_min1, a_axis_max1, ...])

append_circle(radius[, x_center, y_center])

Appends a circle.

append_ellipse(a_axis_min, a_axis_max, ...)

Appends an ellipse.

append_patch([patch])

Append a patch.

append_polygon(x, y)

Appends a polygon.

append_rectangle([x_left, x_right, ...])

Appends a rectangle.

duplicate()

Returns a copy of the SYNED object instance.

from_hex_tring(hex_string)

get_boundaries()

Returns a list with the concatenated boundaries of the sotred patches.

get_name_of_patch(index)

Returns the name of the patch with a given index.

get_number_of_patches()

Returns the number of stored patches.

get_patch(index)

Returns the patch corresponding to a given index.

get_patches()

Returns a list with the patches.

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.

reset()

Removes all existing patches.

set_boundaries([a_axis_min1, a_axis_max1, ...])

Sets the coordinates of the ellipses.

set_value_from_key_name(key, value)

Sets a value using its key value.

to_dictionary()

Gets the dictionary with the multiple patch parameters.

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.