syned.beamline.shape.MultiplePatch

class syned.beamline.shape.MultiplePatch(patch_list=None)[source]

Constructor.

Parameters:

patch_list (list) – A list of patches (each one can be a Circle, Rectangle, Polygon, etc.)

__init__(patch_list=None)[source]

Methods

__init__([patch_list])

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_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.